316860aae0df50a6a119e651111f055185a5093f
[exim.git] / doc / doc-docbook / spec.xfpt
1
2 . /////////////////////////////////////////////////////////////////////////////
3 . This is the primary source of the Exim Manual. It is an xfpt document that is
4 . converted into DocBook XML for subsequent conversion into printable and online
5 . formats. The markup used herein is "standard" xfpt markup, with some extras.
6 . The markup is summarized in a file called Markup.txt.
7 .
8 . WARNING: When you use the .new macro, make sure it appears *before* any
9 . adjacent index items; otherwise you get an empty "paragraph" which causes
10 . unwanted vertical space.
11 . /////////////////////////////////////////////////////////////////////////////
12
13 .include stdflags
14 .include stdmacs
15
16 . /////////////////////////////////////////////////////////////////////////////
17 . This outputs the standard DocBook boilerplate.
18 . /////////////////////////////////////////////////////////////////////////////
19
20 .docbook
21
22 . /////////////////////////////////////////////////////////////////////////////
23 . These lines are processing instructions for the Simple DocBook Processor that
24 . Philip Hazel has developed as a less cumbersome way of making PostScript and
25 . PDFs than using xmlto and fop. They will be ignored by all other XML
26 . processors.
27 . /////////////////////////////////////////////////////////////////////////////
28
29 .literal xml
30 <?sdop
31   foot_right_recto="&chaptertitle; (&chapternumber;)"
32   foot_right_verso="&chaptertitle; (&chapternumber;)"
33   toc_chapter_blanks="yes,yes"
34   table_warn_overflow="overprint"
35 ?>
36 .literal off
37
38 . /////////////////////////////////////////////////////////////////////////////
39 . This generates the outermost <book> element that wraps the entire document.
40 . /////////////////////////////////////////////////////////////////////////////
41
42 .book
43
44 . /////////////////////////////////////////////////////////////////////////////
45 . These definitions set some parameters and save some typing.
46 . Update the Copyright year (only) when changing content.
47 . /////////////////////////////////////////////////////////////////////////////
48
49 .set previousversion "4.97"
50 .include ./local_params
51
52 .set ACL "access control lists (ACLs)"
53 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
54
55 .set drivernamemax "64"
56
57 .macro copyyear
58 2023
59 .endmacro
60
61 . /////////////////////////////////////////////////////////////////////////////
62 . Additional xfpt markup used by this document, over and above the default
63 . provided in the xfpt library.
64 . /////////////////////////////////////////////////////////////////////////////
65
66 . --- Override the &$ flag to automatically insert a $ with the variable name.
67
68 .flag &$  $&   "<varname>$"  "</varname>"
69
70 . --- Short flags for daggers in option headings. They will always be inside
71 . --- an italic string, but we want the daggers to be in Roman.
72
73 .flag &!!      "</emphasis>&dagger;<emphasis>"
74 .flag &!?      "</emphasis>&Dagger;<emphasis>"
75
76 . --- A macro for an Exim option definition heading, generating a one-line
77 . --- table with four columns. For cases when the option name is given with
78 . --- a space, so that it can be split, a fifth argument is used for the
79 . --- index entry.
80 . --- Also one for multiple option def headings be grouped in a single
81 . --- table (but without the split capability).
82
83 .macro otable
84 .itable all 0 0 4 8* left 6* center 6* center 6* right
85 .endmacro
86
87 .macro orow
88 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
89 .endmacro
90
91 .macro option
92 .arg 5
93 .oindex "&%$5%&"
94 .endarg
95 .arg -5
96 .oindex "&%$1%&"
97 .endarg
98 .otable
99 .orow "$1" "$2" "$3" "$4"
100 .endtable
101 .endmacro
102
103 .macro options
104 .eacharg
105 .oindex "&%$+1%&"
106 .endeach 4
107 .otable
108 .eacharg
109 .orow "$+1" "$+2" "$+3" "$+4"
110 .endeach 4
111 .endtable
112 .endmacro
113
114 . --- A macro for the common 2-column tables. The width of the first column
115 . --- is suitable for the many tables at the start of the main options chapter;
116 . --- a small number of other 2-column tables override it.
117
118 .macro table2 196pt 254pt
119 .itable none 0 0 2 $1 left $2 left
120 .endmacro
121
122
123 . --- A macro for a plain variable, including the .vitem and .vindex
124 .macro var
125 .vitem $1
126 .vindex $1
127 .endmacro
128
129 . --- A macro for a "tainted" marker, done as a one-element table
130 .macro tmark
131 .itable none 0 0 1 10pt left
132 .row &'Tainted'&
133 .endtable
134 .endmacro
135
136 . --- A macro for a tainted variable, adding a taint-marker
137 .macro tvar
138 .var $1
139 .tmark
140 .endmacro
141
142 . --- A macro for a cmdline option, including a .oindex
143 . --- 1st arg is the option name, undecorated (we do that here).
144 . --- 2nd arg, optional, text (decorated as needed) to be appended to the name
145 .macro cmdopt
146 .vitem  &%$1%&$=2+&~$2+
147 .oindex &%$1%&
148 .endmacro
149
150 . --- A macro that generates .row, but puts &I; at the start of the first
151 . --- argument, thus indenting it. Assume a minimum of two arguments, and
152 . --- allow up to four arguments, which is as many as we'll ever need.
153
154 .macro irow
155 .arg 4
156 .row "&I;$1" "$2" "$3" "$4"
157 .endarg
158 .arg -4
159 .arg 3
160 .row "&I;$1" "$2" "$3"
161 .endarg
162 .arg -3
163 .row "&I;$1" "$2"
164 .endarg
165 .endarg
166 .endmacro
167
168 . --- Macros for option, variable, and concept index entries. For a "range"
169 . --- style of entry, use .scindex for the start and .ecindex for the end. The
170 . --- first argument of .scindex and the only argument of .ecindex must be the
171 . --- ID that ties them together.
172 . --- The index entry points to the most-recent chapter head, section or subsection
173 . --- head, or list-item.
174
175 .macro cindex
176 &<indexterm role="concept">&
177 &<primary>&$1&</primary>&
178 .arg 2
179 &<secondary>&$2&</secondary>&
180 .endarg
181 &</indexterm>&
182 .endmacro
183
184 .macro scindex
185 &<indexterm role="concept" id="$1" class="startofrange">&
186 &<primary>&$2&</primary>&
187 .arg 3
188 &<secondary>&$3&</secondary>&
189 .endarg
190 &</indexterm>&
191 .endmacro
192
193 .macro ecindex
194 &<indexterm role="concept" startref="$1" class="endofrange"/>&
195 .endmacro
196
197 .macro oindex
198 &<indexterm role="option">&
199 &<primary>&$1&</primary>&
200 .arg 2
201 &<secondary>&$2&</secondary>&
202 .endarg
203 &</indexterm>&
204 .endmacro
205
206 . --- The index entry points to the most-recent chapter head, section or subsection
207 . --- head, or varlist item.
208
209 .macro vindex
210 &<indexterm role="variable">&
211 &<primary>&$1&</primary>&
212 .arg 2
213 &<secondary>&$2&</secondary>&
214 .endarg
215 &</indexterm>&
216 .endmacro
217
218 .macro index
219 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
220 .endmacro
221
222
223 . use this for a concept-index entry for a header line
224 .macro chindex
225 .cindex "&'$1'& header line"
226 .cindex "header lines" $1
227 .endmacro
228 . ////////////////////////////////////////////////////////////////////////////
229
230
231 . ////////////////////////////////////////////////////////////////////////////
232 . The <bookinfo> element is removed from the XML before processing for ASCII
233 . output formats.
234 . ////////////////////////////////////////////////////////////////////////////
235
236 .literal xml
237 <bookinfo>
238 <title>Specification of the Exim Mail Transfer Agent</title>
239 <titleabbrev>The Exim MTA</titleabbrev>
240 <date>
241 .fulldate
242 </date>
243 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
244 <authorinitials>EM</authorinitials>
245 <revhistory><revision>
246 .versiondatexml
247   <authorinitials>EM</authorinitials>
248 </revision></revhistory>
249 <copyright><year>
250 .copyyear
251            </year><holder>The Exim Maintainers</holder></copyright>
252 </bookinfo>
253 .literal off
254
255
256 . /////////////////////////////////////////////////////////////////////////////
257 . These implement index entries of the form "x, see y" and "x, see also y".
258 . However, the DocBook DTD doesn't allow <indexterm> entries
259 . at the top level, so we have to put the .chapter directive first.
260 . /////////////////////////////////////////////////////////////////////////////
261
262 .chapter "Introduction" "CHID1"
263
264 .macro seeother
265 .literal xml
266 <indexterm role="$2">
267   <primary>$3</primary>
268 .arg 5
269   <secondary>$5</secondary>
270 .endarg
271   <$1><emphasis>$4</emphasis></$1>
272 </indexterm>
273 .literal off
274 .endmacro
275
276 . NB: for the 4-arg variant the ordering is awkward
277 .macro see
278 .seeother see "$1" "$2" "$3" "$4"
279 .endmacro
280 .macro seealso
281 .seeother seealso "$1" "$2" "$3" "$4"
282 .endmacro
283
284 .see     variable "<emphasis>$1</emphasis>, <emphasis>$2</emphasis>, etc." "numerical variables"
285 .see     concept address        rewriting                       rewriting
286 .see     concept "Bounce Address Tag Validation"        BATV
287 .see     concept "Client SMTP Authorization"            CSA
288 .see     concept "CR character" "carriage return"
289 .see     concept CRL            "certificate revocation list"
290 .seealso concept de-tainting    "tainted data"
291 .see     concept delivery       "bounce message"                "failure report"
292 .see     concept dialup         "intermittently connected hosts"
293 .see     concept exiscan        "content scanning"
294 .see     concept fallover       fallback
295 .see     concept filter         "Sieve filter"                  Sieve
296 .see     concept headers        "header lines"
297 .see     concept ident          "RFC 1413"
298 .see     concept "LF character" "linefeed"
299 .seealso concept maximum        limit
300 .see     concept monitor        "Exim monitor"
301 .see     concept "no_<emphasis>xxx</emphasis>"          "entry for xxx"
302 .see     concept NUL            "binary zero"
303 .see     concept "passwd file"  "/etc/passwd"
304 .see     concept "process id"   pid
305 .see     concept RBL            "DNS list"
306 .see     concept redirection    "address redirection"
307 .see     concept "return path"  "envelope sender"
308 .see     concept scanning       "content scanning"
309 .see     concept SSL            TLS
310 .see     concept string         expansion expansion
311 .see     concept "top bit"      "8-bit characters"
312 .see     concept variables      "expansion, variables"
313 .see     concept "zero, binary" "binary zero"
314
315
316 . /////////////////////////////////////////////////////////////////////////////
317 . This is the real start of the first chapter. See the comment above as to why
318 . we can't have the .chapter line here.
319 . chapter "Introduction"
320 . /////////////////////////////////////////////////////////////////////////////
321
322 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
323 Unix-like operating systems. It was designed on the assumption that it would be
324 run on hosts that are permanently connected to the Internet. However, it can be
325 used on intermittently connected hosts with suitable configuration adjustments.
326
327 Configuration files currently exist for the following operating systems: AIX,
328 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
329 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
330 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
331 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
332 Some of these operating systems are no longer current and cannot easily be
333 tested, so the configuration files may no longer work in practice.
334
335 There are also configuration files for compiling Exim in the Cygwin environment
336 that can be installed on systems running Windows. However, this document does
337 not contain any information about running Exim in the Cygwin environment.
338
339 The terms and conditions for the use and distribution of Exim are contained in
340 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
341 Public Licence, a copy of which may be found in the file &_LICENCE_&.
342
343 The use, supply, or promotion of Exim for the purpose of sending bulk,
344 unsolicited electronic mail is incompatible with the basic aims of Exim,
345 which revolve around the free provision of a service that enhances the quality
346 of personal communications. The author of Exim regards indiscriminate
347 mass-mailing as an antisocial, irresponsible abuse of the Internet.
348
349 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
350 experience of running and working on the Smail 3 code, I could never have
351 contemplated starting to write a new MTA. Many of the ideas and user interfaces
352 were originally taken from Smail 3, though the actual code of Exim is entirely
353 new, and has developed far beyond the initial concept.
354
355 Many people, both in Cambridge and around the world, have contributed to the
356 development and the testing of Exim, and to porting it to various operating
357 systems. I am grateful to them all. The distribution now contains a file called
358 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
359 contributors.
360
361
362 .section "Exim documentation" "SECID1"
363 . Keep this example change bar when updating the documentation!
364
365 .new
366 .cindex "documentation"
367 This edition of the Exim specification applies to version &version() of Exim.
368 Substantive changes from the &previousversion; edition are marked in some
369 renditions of this document; this paragraph is so marked if the rendition is
370 capable of showing a change indicator.
371 .wen
372
373 This document is very much a reference manual; it is not a tutorial. The reader
374 is expected to have some familiarity with the SMTP mail transfer protocol and
375 with general Unix system administration. Although there are some discussions
376 and examples in places, the information is mostly organized in a way that makes
377 it easy to look up, rather than in a natural order for sequential reading.
378 Furthermore, this manual aims to cover every aspect of Exim in detail, including
379 a number of rarely-used, special-purpose features that are unlikely to be of
380 very wide interest.
381
382 .cindex "books about Exim"
383 An &"easier"& discussion of Exim which provides more in-depth explanatory,
384 introductory, and tutorial material can be found in a book entitled &'The Exim
385 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
386 (&url(https://www.uit.co.uk/exim-book/)).
387
388 The book also contains a chapter that gives a general introduction to SMTP and
389 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
390 with the latest release of Exim. (Note that the earlier book about Exim,
391 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
392
393 .cindex "Debian" "information sources"
394 If you are using a Debian distribution of Exim, you will find information about
395 Debian-specific features in the file
396 &_/usr/share/doc/exim4-base/README.Debian_&.
397 The command &(man update-exim.conf)& is another source of Debian-specific
398 information.
399
400 .cindex "&_doc/NewStuff_&"
401 .cindex "&_doc/ChangeLog_&"
402 .cindex "change log"
403 As Exim develops, there may be features in newer versions that have not
404 yet made it into this document, which is updated only when the most significant
405 digit of the fractional part of the version number changes. Specifications of
406 new features that are not yet in this manual are placed in the file
407 &_doc/NewStuff_& in the Exim distribution.
408
409 Some features may be classified as &"experimental"&. These may change
410 incompatibly while they are developing, or even be withdrawn. For this reason,
411 they are not documented in this manual. Information about experimental features
412 can be found in the file &_doc/experimental.txt_&.
413
414 All changes to Exim (whether new features, bug fixes, or other kinds of
415 change) are noted briefly in the file called &_doc/ChangeLog_&.
416
417 .cindex "&_doc/spec.txt_&"
418 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
419 that it can easily be searched with a text editor. Other files in the &_doc_&
420 directory are:
421
422 .table2 100pt
423 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
424 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
425 .row &_exim.8_&              "a man page of Exim's command line options"
426 .row &_experimental.txt_&    "documentation of experimental features"
427 .row &_filter.txt_&          "specification of the filter language"
428 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
429 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
430 .row &_openssl.txt_&         "installing a current OpenSSL release"
431 .endtable
432
433 The main specification and the specification of the filtering language are also
434 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
435 &<<SECTavail>>& below tells you how to get hold of these.
436
437
438
439 .section "FTP site and websites" "SECID2"
440 .cindex "website"
441 .cindex "FTP site"
442 The primary site for Exim source distributions is the &%exim.org%& FTP site,
443 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
444 website, are hosted at the University of Cambridge.
445
446 .cindex "wiki"
447 .cindex "FAQ"
448 As well as Exim distribution tar files, the Exim website contains a number of
449 differently formatted versions of the documentation. A recent addition to the
450 online information is the Exim wiki (&url(https://wiki.exim.org)),
451 which contains what used to be a separate FAQ, as well as various other
452 examples, tips, and know-how that have been contributed by Exim users.
453 The wiki site should always redirect to the correct place, which is currently
454 provided by GitHub, and is open to editing by anyone with a GitHub account.
455
456 .cindex Bugzilla
457 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
458 this to report bugs, and also to add items to the wish list. Please search
459 first to check that you are not duplicating a previous entry.
460 Please do not ask for configuration help in the bug-tracker.
461
462
463 .section "Mailing lists" "SECID3"
464 .cindex "mailing lists" "for Exim users"
465 The following Exim mailing lists exist:
466
467 .table2 140pt
468 .row &'exim-announce@lists.exim.org'&   "Moderated, low volume announcements list"
469 .row &'exim-users@lists.exim.org'&      "General discussion list"
470 .row &'exim-users-de@lists.exim.org'&   "General discussion list in German language"
471 .row &'exim-dev@lists.exim.org'&        "Discussion of bugs, enhancements, etc."
472 .row &'exim-cvs@lists.exim.org'&        "Automated commit messages from the VCS"
473 .endtable
474
475 You can subscribe to these lists, change your existing subscriptions, and view
476 or search the archives via the mailing lists link on the Exim home page.
477 .cindex "Debian" "mailing list for"
478 If you are using a Debian distribution of Exim, you may wish to subscribe to
479 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
480 via this web page:
481 .display
482 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
483 .endd
484 Please ask Debian-specific questions on that list and not on the general Exim
485 lists.
486
487 .section "Bug reports" "SECID5"
488 .cindex "bug reports"
489 .cindex "reporting bugs"
490 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
491 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
492 whether some behaviour is a bug or not, the best thing to do is to post a
493 message to the &'exim-dev'& mailing list and have it discussed.
494
495
496
497 .section "Where to find the Exim distribution" "SECTavail"
498 .cindex "FTP site"
499 .cindex "HTTPS download site"
500 .cindex "distribution" "FTP site"
501 .cindex "distribution" "https site"
502 The master distribution site for the Exim distribution is
503 .display
504 &url(https://downloads.exim.org/)
505 .endd
506 The service is available over HTTPS, HTTP and FTP.
507 We encourage people to migrate to HTTPS.
508
509 The content served at &url(https://downloads.exim.org/) is identical to the
510 content served at &url(https://ftp.exim.org/pub/exim) and
511 &url(ftp://ftp.exim.org/pub/exim).
512
513 If accessing via a hostname containing &'ftp'&, then the file references that
514 follow are relative to the &_exim_& directories at these sites.
515 If accessing via the hostname &'downloads'& then the subdirectories described
516 here are top-level directories.
517
518 There are now quite a number of independent mirror sites around
519 the world. Those that I know about are listed in the file called &_Mirrors_&.
520
521 Within the top exim directory there are subdirectories called &_exim3_& (for
522 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
523 distributions), and &_Testing_& for testing versions. In the &_exim4_&
524 subdirectory, the current release can always be found in files called
525 .display
526 &_exim-n.nn.tar.xz_&
527 &_exim-n.nn.tar.gz_&
528 &_exim-n.nn.tar.bz2_&
529 .endd
530 where &'n.nn'& is the highest such version number in the directory. The three
531 files contain identical data; the only difference is the type of compression.
532 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
533 most portable to old systems.
534
535 .cindex "distribution" "signing details"
536 .cindex "distribution" "public key"
537 .cindex "public key for signed distribution"
538 The distributions will be PGP signed by an individual key of the Release
539 Coordinator.  This key will have a uid containing an email address in the
540 &'exim.org'& domain and will have signatures from other people, including
541 other Exim maintainers.  We expect that the key will be in the "strong set" of
542 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
543 PGP keys, a version of which can be found in the release directory in the file
544 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
545 such as &'pool.sks-keyservers.net'&.
546
547 At the time of the last update, releases were being made by Jeremy Harris and signed
548 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
549 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
550 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
551
552 The signatures for the tar bundles are in:
553 .display
554 &_exim-n.nn.tar.xz.asc_&
555 &_exim-n.nn.tar.gz.asc_&
556 &_exim-n.nn.tar.bz2.asc_&
557 .endd
558 For each released version, the log of changes is made available in a
559 separate file in the directory &_ChangeLogs_& so that it is possible to
560 find out what has changed without having to download the entire distribution.
561
562 .cindex "documentation" "available formats"
563 The main distribution contains ASCII versions of this specification and other
564 documentation; other formats of the documents are available in separate files
565 inside the &_exim4_& directory of the FTP site:
566 .display
567 &_exim-html-n.nn.tar.gz_&
568 &_exim-pdf-n.nn.tar.gz_&
569 &_exim-postscript-n.nn.tar.gz_&
570 &_exim-texinfo-n.nn.tar.gz_&
571 .endd
572 These tar files contain only the &_doc_& directory, not the complete
573 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
574
575
576 .section "Limitations" "SECID6"
577 .ilist
578 .cindex "limitations of Exim"
579 .cindex "bang paths" "not handled by Exim"
580 Exim is designed for use as an Internet MTA, and therefore handles addresses in
581 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
582 simple two-component bang paths can be converted by a straightforward rewriting
583 configuration. This restriction does not prevent Exim from being interfaced to
584 UUCP as a transport mechanism, provided that domain addresses are used.
585 .next
586 .cindex "domainless addresses"
587 .cindex "address" "without domain"
588 Exim insists that every address it handles has a domain attached. For incoming
589 local messages, domainless addresses are automatically qualified with a
590 configured domain value. Configuration options specify from which remote
591 systems unqualified addresses are acceptable. These are then qualified on
592 arrival.
593 .next
594 .cindex "transport" "external"
595 .cindex "external transports"
596 The only external transport mechanisms that are currently implemented are SMTP
597 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
598 transport is available, and there are facilities for writing messages to files
599 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
600 to send messages to other transport mechanisms such as UUCP, provided they can
601 handle domain-style addresses. Batched SMTP input is also catered for.
602 .next
603 Exim is not designed for storing mail for dial-in hosts. When the volumes of
604 such mail are large, it is better to get the messages &"delivered"& into files
605 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
606 other means.
607 .next
608 Although Exim does have basic facilities for scanning incoming messages, these
609 are not comprehensive enough to do full virus or spam scanning. Such operations
610 are best carried out using additional specialized software packages. If you
611 compile Exim with the content-scanning extension, straightforward interfaces to
612 a number of common scanners are provided.
613 .endlist
614
615
616 .section "Runtime configuration" "SECID7"
617 Exim's runtime configuration is held in a single text file that is divided
618 into a number of sections. The entries in this file consist of keywords and
619 values, in the style of Smail 3 configuration files. A default configuration
620 file which is suitable for simple online installations is provided in the
621 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
622
623
624 .section "Calling interface" "SECID8"
625 .cindex "Sendmail compatibility" "command line interface"
626 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
627 can be a straight replacement for &_/usr/lib/sendmail_& or
628 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
629 about Sendmail in order to run Exim. For actions other than sending messages,
630 Sendmail-compatible options also exist, but those that produce output (for
631 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
632 format. There are also some additional options that are compatible with Smail
633 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
634 documents all Exim's command line options. This information is automatically
635 made into the man page that forms part of the Exim distribution.
636
637 Control of messages in the queue can be done via certain privileged command
638 line options. There is also an optional monitor program called &'eximon'&,
639 which displays current information in an X window, and which contains a menu
640 interface to Exim's command line administration options.
641
642
643
644 .section "Terminology" "SECID9"
645 .cindex "terminology definitions"
646 .cindex "body of message" "definition of"
647 The &'body'& of a message is the actual data that the sender wants to transmit.
648 It is the last part of a message and is separated from the &'header'& (see
649 below) by a blank line.
650
651 .cindex "bounce message" "definition of"
652 When a message cannot be delivered, it is normally returned to the sender in a
653 delivery failure message or a &"non-delivery report"& (NDR). The term
654 &'bounce'& is commonly used for this action, and the error reports are often
655 called &'bounce messages'&. This is a convenient shorthand for &"delivery
656 failure error report"&. Such messages have an empty sender address in the
657 message's &'envelope'& (see below) to ensure that they cannot themselves give
658 rise to further bounce messages.
659
660 The term &'default'& appears frequently in this manual. It is used to qualify a
661 value which is used in the absence of any setting in the configuration. It may
662 also qualify an action which is taken unless a configuration setting specifies
663 otherwise.
664
665 The term &'defer'& is used when the delivery of a message to a specific
666 destination cannot immediately take place for some reason (a remote host may be
667 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
668 until a later time.
669
670 The word &'domain'& is sometimes used to mean all but the first component of a
671 host's name. It is &'not'& used in that sense here, where it normally refers to
672 the part of an email address following the @ sign.
673
674 .cindex "envelope, definition of"
675 .cindex "sender" "definition of"
676 A message in transit has an associated &'envelope'&, as well as a header and a
677 body. The envelope contains a sender address (to which bounce messages should
678 be delivered), and any number of recipient addresses. References to the
679 sender or the recipients of a message usually mean the addresses in the
680 envelope. An MTA uses these addresses for delivery, and for returning bounce
681 messages, not the addresses that appear in the header lines.
682
683 .cindex "message" "header, definition of"
684 .cindex "header section" "definition of"
685 The &'header'& of a message is the first part of a message's text, consisting
686 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
687 &'Subject:'&, etc. Long header lines can be split over several text lines by
688 indenting the continuations. The header is separated from the body by a blank
689 line.
690
691 .cindex "local part" "definition of"
692 .cindex "domain" "definition of"
693 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
694 part of an email address that precedes the @ sign. The part that follows the
695 @ sign is called the &'domain'& or &'mail domain'&.
696
697 .cindex "local delivery" "definition of"
698 .cindex "remote delivery, definition of"
699 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
700 delivery to a file or a pipe on the local host from delivery by SMTP over
701 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
702 host it is running on are &'remote'&.
703
704 .cindex "return path" "definition of"
705 &'Return path'& is another name that is used for the sender address in a
706 message's envelope.
707
708 .cindex "queue" "definition of"
709 The term &'queue'& is used to refer to the set of messages awaiting delivery
710 because this term is in widespread use in the context of MTAs. However, in
711 Exim's case, the reality is more like a pool than a queue, because there is
712 normally no ordering of waiting messages.
713
714 .cindex "queue runner" "definition of"
715 The term &'queue runner'& is used to describe a process that scans the queue
716 and attempts to deliver those messages whose retry times have come. This term
717 is used by other MTAs and also relates to the command &%runq%&, but in Exim
718 the waiting messages are normally processed in an unpredictable order.
719
720 .cindex "spool directory" "definition of"
721 The term &'spool directory'& is used for a directory in which Exim keeps the
722 messages in its queue &-- that is, those that it is in the process of
723 delivering. This should not be confused with the directory in which local
724 mailboxes are stored, which is called a &"spool directory"& by some people. In
725 the Exim documentation, &"spool"& is always used in the first sense.
726
727
728
729
730
731
732 . ////////////////////////////////////////////////////////////////////////////
733 . ////////////////////////////////////////////////////////////////////////////
734
735 .chapter "Incorporated code" "CHID2"
736 .cindex "incorporated code"
737 .cindex "regular expressions" "library"
738 .cindex "PCRE2"
739 .cindex "OpenDMARC"
740 A number of pieces of external code are included in the Exim distribution.
741
742 .ilist
743 Regular expressions are supported in the main Exim program and in the
744 Exim monitor using the freely-distributable PCRE2 library, copyright
745 &copy; University of Cambridge. The source to PCRE2 is not longer shipped with
746 Exim, so you will need to use the version of PCRE2 shipped with your system,
747 or obtain and install the full version of the library from
748 &url(https://github.com/PhilipHazel/pcre2/releases).
749 .next
750 .cindex "cdb" "acknowledgment"
751 Support for the cdb (Constant DataBase) lookup method is provided by code
752 contributed by Nigel Metheringham of (at the time he contributed it) Planet
753 Online Ltd. The implementation is completely contained within the code of Exim.
754 It does not link against an external cdb library. The code contains the
755 following statements:
756
757 .blockquote
758 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
759
760 This program is free software; you can redistribute it and/or modify it under
761 the terms of the GNU General Public License as published by the Free Software
762 Foundation; either version 2 of the License, or (at your option) any later
763 version.
764 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
765 the spec and sample code for cdb can be obtained from
766 &url(https://cr.yp.to/cdb.html). This implementation borrows
767 some code from Dan Bernstein's implementation (which has no license
768 restrictions applied to it).
769 .endblockquote
770 .next
771 .cindex "SPA authentication"
772 .cindex "Samba project"
773 .cindex "Microsoft Secure Password Authentication"
774 Client support for Microsoft's &'Secure Password Authentication'& is provided
775 by code contributed by Marc Prud'hommeaux. Server support was contributed by
776 Tom Kistner. This includes code taken from the Samba project, which is released
777 under the Gnu GPL.
778 .next
779 .cindex "Cyrus"
780 .cindex "&'pwcheck'& daemon"
781 .cindex "&'pwauthd'& daemon"
782 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
783 by code taken from the Cyrus-SASL library and adapted by Alexander S.
784 Sabourenkov. The permission notice appears below, in accordance with the
785 conditions expressed therein.
786
787 .blockquote
788 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
789
790 Redistribution and use in source and binary forms, with or without
791 modification, are permitted provided that the following conditions
792 are met:
793
794 .olist
795 Redistributions of source code must retain the above copyright
796 notice, this list of conditions and the following disclaimer.
797 .next
798 Redistributions in binary form must reproduce the above copyright
799 notice, this list of conditions and the following disclaimer in
800 the documentation and/or other materials provided with the
801 distribution.
802 .next
803 The name &"Carnegie Mellon University"& must not be used to
804 endorse or promote products derived from this software without
805 prior written permission. For permission or any other legal
806 details, please contact
807 .display
808               Office of Technology Transfer
809               Carnegie Mellon University
810               5000 Forbes Avenue
811               Pittsburgh, PA  15213-3890
812               (412) 268-4387, fax: (412) 268-7395
813               tech-transfer@andrew.cmu.edu
814 .endd
815 .next
816 Redistributions of any form whatsoever must retain the following
817 acknowledgment:
818
819 &"This product includes software developed by Computing Services
820 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
821
822 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
823 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
824 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
825 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
826 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
827 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
828 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
829 .endlist
830 .endblockquote
831
832 .next
833 .cindex "Exim monitor" "acknowledgment"
834 .cindex "X-windows"
835 .cindex "Athena"
836 The Exim Monitor program, which is an X-Window application, includes
837 modified versions of the Athena StripChart and TextPop widgets.
838 This code is copyright by DEC and MIT, and their permission notice appears
839 below, in accordance with the conditions expressed therein.
840
841 .blockquote
842 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
843 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
844
845 All Rights Reserved
846
847 Permission to use, copy, modify, and distribute this software and its
848 documentation for any purpose and without fee is hereby granted,
849 provided that the above copyright notice appear in all copies and that
850 both that copyright notice and this permission notice appear in
851 supporting documentation, and that the names of Digital or MIT not be
852 used in advertising or publicity pertaining to distribution of the
853 software without specific, written prior permission.
854
855 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
856 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
857 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
858 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
859 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
860 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
861 SOFTWARE.
862 .endblockquote
863
864 .next
865 .cindex "opendmarc" "acknowledgment"
866 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
867 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
868 derived code are indicated in the respective source files. The full OpenDMARC
869 license is provided in the LICENSE.opendmarc file contained in the distributed
870 source code.
871
872 .next
873 Many people have contributed code fragments, some large, some small, that were
874 not covered by any specific license requirements. It is assumed that the
875 contributors are happy to see their code incorporated into Exim under the GPL.
876 .endlist
877
878
879
880
881
882 . ////////////////////////////////////////////////////////////////////////////
883 . ////////////////////////////////////////////////////////////////////////////
884
885 .chapter "How Exim receives and delivers mail" "CHID11" &&&
886          "Receiving and delivering mail"
887
888
889 .section "Overall philosophy" "SECID10"
890 .cindex "design philosophy"
891 Exim is designed to work efficiently on systems that are permanently connected
892 to the Internet and are handling a general mix of mail. In such circumstances,
893 most messages can be delivered immediately. Consequently, Exim does not
894 maintain independent queues of messages for specific domains or hosts, though
895 it does try to send several messages in a single SMTP connection after a host
896 has been down, and it also maintains per-host retry information.
897
898
899 .section "Policy control" "SECID11"
900 .cindex "policy control" "overview"
901 Policy controls are now an important feature of MTAs that are connected to the
902 Internet. Perhaps their most important job is to stop MTAs from being abused as
903 &"open relays"& by misguided individuals who send out vast amounts of
904 unsolicited junk and want to disguise its source. Exim provides flexible
905 facilities for specifying policy controls on incoming mail:
906
907 .ilist
908 .cindex "&ACL;" "introduction"
909 Exim 4 (unlike previous versions of Exim) implements policy controls on
910 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
911 series of statements that may either grant or deny access. ACLs can be used at
912 several places in the SMTP dialogue while receiving a message from a remote
913 host. However, the most common places are after each RCPT command, and at the
914 very end of the message. The sysadmin can specify conditions for accepting or
915 rejecting individual recipients or the entire message, respectively, at these
916 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
917 error code.
918 .next
919 An ACL is also available for locally generated, non-SMTP messages. In this
920 case, the only available actions are to accept or deny the entire message.
921 .next
922 When Exim is compiled with the content-scanning extension, facilities are
923 provided in the ACL mechanism for passing the message to external virus and/or
924 spam scanning software. The result of such a scan is passed back to the ACL,
925 which can then use it to decide what to do with the message.
926 .next
927 When a message has been received, either from a remote host or from the local
928 host, but before the final acknowledgment has been sent, a locally supplied C
929 function called &[local_scan()]& can be run to inspect the message and decide
930 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
931 is accepted, the list of recipients can be modified by the function.
932 .next
933 Using the &[local_scan()]& mechanism is another way of calling external scanner
934 software. The &%SA-Exim%& add-on package works this way. It does not require
935 Exim to be compiled with the content-scanning extension.
936 .next
937 After a message has been accepted, a further checking mechanism is available in
938 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
939 runs at the start of every delivery process.
940 .endlist
941
942
943
944 .section "User filters" "SECID12"
945 .cindex "filter" "introduction"
946 .cindex "Sieve filter"
947 In a conventional Exim configuration, users are able to run private filters by
948 setting up appropriate &_.forward_& files in their home directories. See
949 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
950 configuration needed to support this, and the separate document entitled
951 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
952 of filtering are available:
953
954 .ilist
955 Sieve filters are written in the standard filtering language that is defined
956 by RFC 3028.
957 .next
958 Exim filters are written in a syntax that is unique to Exim, but which is more
959 powerful than Sieve, which it pre-dates.
960 .endlist
961
962 User filters are run as part of the routing process, described below.
963
964
965
966 .section "Message identification" "SECTmessiden"
967 .cindex "message ids" "details of format"
968 .cindex "format" "of message id"
969 .cindex "id of message"
970 .cindex "base62"
971 .cindex "base36"
972 .cindex "Darwin"
973 .cindex "Cygwin"
974 .cindex "exim_msgdate"
975 Every message handled by Exim is given a &'message id'& which is 23
976 characters long. It is divided into three parts, separated by hyphens, for
977 example &`16VDhn-000000001bo-D342`&. Each part is a sequence of letters and digits,
978 normally encoding numbers in base 62. However, in the Darwin operating
979 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
980 (avoiding the use of lower case letters) is used instead, because the message
981 id is used to construct filenames, and the names of files in those systems are
982 not always case-sensitive.
983
984 .cindex "pid (process id)" "re-use of"
985 The detail of the contents of the message id have changed as Exim has evolved.
986 Earlier versions relied on the operating system not re-using a process id (pid)
987 within one second. On modern operating systems, this assumption can no longer
988 be made, so the algorithm had to be changed. To retain backward compatibility,
989 the format of the message id was retained, which is why the following rules are
990 somewhat eccentric:
991
992 .ilist
993 The first six characters of the message id are the time at which the message
994 started to be received, to a granularity of one second. That is, this field
995 contains the number of seconds since the start of the epoch (the normal Unix
996 way of representing the date and time of day).
997 .next
998 After the first hyphen, the next
999 eleven
1000 characters are the id of the process that received the message.
1001 .next
1002 There are two different possibilities for the final four characters:
1003 .olist
1004 .oindex "&%localhost_number%&"
1005 If &%localhost_number%& is not set, this value is the fractional part of the
1006 time of reception, normally in units of
1007 microseconds.
1008 but for systems
1009 that must use base 36 instead of base 62 (because of case-insensitive file
1010 systems), the units are
1011 2 us.
1012 .next
1013 If &%localhost_number%& is set, it is multiplied by
1014 500000 (250000) and added to
1015 the fractional part of the time, which in this case is in units of 2 us (4 us).
1016 .endlist
1017 .endlist
1018
1019 After a message has been received, Exim waits for the clock to tick at the
1020 appropriate resolution before proceeding, so that if another message is
1021 received by the same process, or by another process with the same (re-used)
1022 pid, it is guaranteed that the time will be different. In most cases, the clock
1023 will already have ticked while the message was being received.
1024
1025 The exim_msgdate utility (see section &<<SECTexim_msgdate>>&) can be
1026 used to display the date, and optionally the process id, of an Exim
1027 Message ID.
1028
1029
1030 .section "Receiving mail" "SECID13"
1031 .cindex "receiving mail"
1032 .cindex "message" "reception"
1033 The only way Exim can receive mail from another host is using SMTP over
1034 TCP/IP, in which case the sender and recipient addresses are transferred using
1035 SMTP commands. However, from a locally running process (such as a user's MUA),
1036 there are several possibilities:
1037
1038 .ilist
1039 If the process runs Exim with the &%-bm%& option, the message is read
1040 non-interactively (usually via a pipe), with the recipients taken from the
1041 command line, or from the body of the message if &%-t%& is also used.
1042 .next
1043 If the process runs Exim with the &%-bS%& option, the message is also read
1044 non-interactively, but in this case the recipients are listed at the start of
1045 the message in a series of SMTP RCPT commands, terminated by a DATA
1046 command. This is called &"batch SMTP"& format,
1047 but it isn't really SMTP. The SMTP commands are just another way of passing
1048 envelope addresses in a non-interactive submission.
1049 .next
1050 If the process runs Exim with the &%-bs%& option, the message is read
1051 interactively, using the SMTP protocol. A two-way pipe is normally used for
1052 passing data between the local process and the Exim process.
1053 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1054 example, the ACLs for SMTP commands are used for this form of submission.
1055 .next
1056 A local process may also make a TCP/IP call to the host's loopback address
1057 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1058 does not treat the loopback address specially. It treats all such connections
1059 in the same way as connections from other hosts.
1060 .endlist
1061
1062
1063 .cindex "message sender, constructed by Exim"
1064 .cindex "sender" "constructed by Exim"
1065 In the three cases that do not involve TCP/IP, the sender address is
1066 constructed from the login name of the user that called Exim and a default
1067 qualification domain (which can be set by the &%qualify_domain%& configuration
1068 option). For local or batch SMTP, a sender address that is passed using the
1069 SMTP MAIL command is ignored. However, the system administrator may allow
1070 certain users (&"trusted users"&) to specify a different sender addresses
1071 unconditionally, or all users to specify certain forms of different sender
1072 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1073 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1074 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1075 users to change sender addresses.
1076
1077 Messages received by either of the non-interactive mechanisms are subject to
1078 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1079 (either over TCP/IP or interacting with a local process) can be checked by a
1080 number of ACLs that operate at different times during the SMTP session. Either
1081 individual recipients or the entire message can be rejected if local policy
1082 requirements are not met. The &[local_scan()]& function (see chapter
1083 &<<CHAPlocalscan>>&) is run for all incoming messages.
1084
1085 Exim can be configured not to start a delivery process when a message is
1086 received; this can be unconditional, or depend on the number of incoming SMTP
1087 connections or the system load. In these situations, new messages wait on the
1088 queue until a queue runner process picks them up. However, in standard
1089 configurations under normal conditions, delivery is started as soon as a
1090 message is received.
1091
1092
1093
1094
1095
1096 .section "Handling an incoming message" "SECID14"
1097 .cindex "spool directory" "files that hold a message"
1098 .cindex "file" "how a message is held"
1099 When Exim accepts a message, it writes two files in its spool directory. The
1100 first contains the envelope information, the current status of the message, and
1101 the header lines, and the second contains the body of the message. The names of
1102 the two spool files consist of the message id, followed by &`-H`& for the
1103 file containing the envelope and header, and &`-D`& for the data file.
1104
1105 .cindex "spool directory" "&_input_& sub-directory"
1106 By default, all these message files are held in a single directory called
1107 &_input_& inside the general Exim spool directory. Some operating systems do
1108 not perform very well if the number of files in a directory gets large; to
1109 improve performance in such cases, the &%split_spool_directory%& option can be
1110 used. This causes Exim to split up the input files into 62 sub-directories
1111 whose names are single letters or digits. When this is done, the queue is
1112 processed one sub-directory at a time instead of all at once, which can improve
1113 overall performance even when there are not enough files in each directory to
1114 affect file system performance.
1115
1116 The envelope information consists of the address of the message's sender and
1117 the addresses of the recipients. This information is entirely separate from
1118 any addresses contained in the header lines. The status of the message includes
1119 a list of recipients who have already received the message. The format of the
1120 first spool file is described in chapter &<<CHAPspool>>&.
1121
1122 .cindex "rewriting" "addresses"
1123 Address rewriting that is specified in the rewrite section of the configuration
1124 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1125 both in the header lines and the envelope, at the time the message is accepted.
1126 If during the course of delivery additional addresses are generated (for
1127 example, via aliasing), these new addresses are rewritten as soon as they are
1128 generated. At the time a message is actually delivered (transported) further
1129 rewriting can take place; because this is a transport option, it can be
1130 different for different forms of delivery. It is also possible to specify the
1131 addition or removal of certain header lines at the time the message is
1132 delivered (see chapters &<<CHAProutergeneric>>& and
1133 &<<CHAPtransportgeneric>>&).
1134
1135
1136
1137 .section "Life of a message" "SECID15"
1138 .cindex "message" "life of"
1139 .cindex "message" "frozen"
1140 A message remains in the spool directory until it is completely delivered to
1141 its recipients or to an error address, or until it is deleted by an
1142 administrator or by the user who originally created it. In cases when delivery
1143 cannot proceed &-- for example when a message can neither be delivered to its
1144 recipients nor returned to its sender, the message is marked &"frozen"& on the
1145 spool, and no more deliveries are attempted.
1146
1147 .cindex "frozen messages" "thawing"
1148 .cindex "message" "thawing frozen"
1149 An administrator can &"thaw"& such messages when the problem has been
1150 corrected, and can also freeze individual messages by hand if necessary. In
1151 addition, an administrator can force a delivery error, causing a bounce message
1152 to be sent.
1153
1154 .oindex "&%timeout_frozen_after%&"
1155 .oindex "&%ignore_bounce_errors_after%&"
1156 There are options called &%ignore_bounce_errors_after%& and
1157 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1158 The first applies only to frozen bounces, the second to all frozen messages.
1159
1160 .cindex "message" "log file for"
1161 .cindex "log" "file for each message"
1162 While Exim is working on a message, it writes information about each delivery
1163 attempt to its main log file. This includes successful, unsuccessful, and
1164 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1165 lines are also written to a separate &'message log'& file for each message.
1166 These logs are solely for the benefit of the administrator and are normally
1167 deleted along with the spool files when processing of a message is complete.
1168 The use of individual message logs can be disabled by setting
1169 &%no_message_logs%&; this might give an improvement in performance on very busy
1170 systems.
1171
1172 .cindex "journal file"
1173 .cindex "file" "journal"
1174 All the information Exim itself needs to set up a delivery is kept in the first
1175 spool file, along with the header lines. When a successful delivery occurs, the
1176 address is immediately written at the end of a journal file, whose name is the
1177 message id followed by &`-J`&. At the end of a delivery run, if there are some
1178 addresses left to be tried again later, the first spool file (the &`-H`& file)
1179 is updated to indicate which these are, and the journal file is then deleted.
1180 Updating the spool file is done by writing a new file and renaming it, to
1181 minimize the possibility of data loss.
1182
1183 Should the system or Exim crash after a successful delivery but before
1184 the spool file has been updated, the journal is left lying around. The next
1185 time Exim attempts to deliver the message, it reads the journal file and
1186 updates the spool file before proceeding. This minimizes the chances of double
1187 deliveries caused by crashes.
1188
1189
1190
1191 .section "Processing an address for delivery" "SECTprocaddress"
1192 .cindex "drivers" "definition of"
1193 .cindex "router" "definition of"
1194 .cindex "transport" "definition of"
1195 The main delivery processing elements of Exim are called &'routers'& and
1196 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1197 number of them is provided in the source distribution, and compile-time options
1198 specify which ones are included in the binary. Runtime options specify which
1199 ones are actually used for delivering messages.
1200
1201 .cindex "drivers" "instance definition"
1202 Each driver that is specified in the runtime configuration is an &'instance'&
1203 of that particular driver type. Multiple instances are allowed; for example,
1204 you can set up several different &(smtp)& transports, each with different
1205 option values that might specify different ports or different timeouts. Each
1206 instance has its own identifying name. In what follows we will normally use the
1207 instance name when discussing one particular instance (that is, one specific
1208 configuration of the driver), and the generic driver name when discussing
1209 the driver's features in general.
1210
1211 A &'router'& is a driver that operates on an address, either determining how
1212 its delivery should happen, by assigning it to a specific transport, or
1213 converting the address into one or more new addresses (for example, via an
1214 alias file). A router may also explicitly choose to fail an address, causing it
1215 to be bounced.
1216
1217 A &'transport'& is a driver that transmits a copy of the message from Exim's
1218 spool to some destination. There are two kinds of transport: for a &'local'&
1219 transport, the destination is a file or a pipe on the local host, whereas for a
1220 &'remote'& transport the destination is some other host. A message is passed
1221 to a specific transport as a result of successful routing. If a message has
1222 several recipients, it may be passed to a number of different transports.
1223
1224 .cindex "preconditions" "definition of"
1225 An address is processed by passing it to each configured router instance in
1226 turn, subject to certain preconditions, until a router accepts the address or
1227 specifies that it should be bounced. We will describe this process in more
1228 detail shortly. First, as a simple example, we consider how each recipient
1229 address in a message is processed in a small configuration of three routers.
1230
1231 To make this a more concrete example, it is described in terms of some actual
1232 routers, but remember, this is only an example. You can configure Exim's
1233 routers in many different ways, and there may be any number of routers in a
1234 configuration.
1235
1236 The first router that is specified in a configuration is often one that handles
1237 addresses in domains that are not recognized specifically by the local host.
1238 Typically these are addresses for arbitrary domains on the Internet. A precondition
1239 is set up which looks for the special domains known to the host (for example,
1240 its own domain name), and the router is run for addresses that do &'not'&
1241 match. Typically, this is a router that looks up domains in the DNS in order to
1242 find the hosts to which this address routes. If it succeeds, the address is
1243 assigned to a suitable SMTP transport; if it does not succeed, the router is
1244 configured to fail the address.
1245
1246 The second router is reached only when the domain is recognized as one that
1247 &"belongs"& to the local host. This router does redirection &-- also known as
1248 aliasing and forwarding. When it generates one or more new addresses from the
1249 original, each of them is routed independently from the start. Otherwise, the
1250 router may cause an address to fail, or it may simply decline to handle the
1251 address, in which case the address is passed to the next router.
1252
1253 The final router in many configurations is one that checks to see if the
1254 address belongs to a local mailbox. The precondition may involve a check to
1255 see if the local part is the name of a login account, or it may look up the
1256 local part in a file or a database. If its preconditions are not met, or if
1257 the router declines, we have reached the end of the routers. When this happens,
1258 the address is bounced.
1259
1260
1261
1262 .section "Processing an address for verification" "SECID16"
1263 .cindex "router" "for verification"
1264 .cindex "verifying address" "overview"
1265 As well as being used to decide how to deliver to an address, Exim's routers
1266 are also used for &'address verification'&. Verification can be requested as
1267 one of the checks to be performed in an ACL for incoming messages, on both
1268 sender and recipient addresses, and it can be tested using the &%-bv%& and
1269 &%-bvs%& command line options.
1270
1271 When an address is being verified, the routers are run in &"verify mode"&. This
1272 does not affect the way the routers work, but it is a state that can be
1273 detected. By this means, a router can be skipped or made to behave differently
1274 when verifying. A common example is a configuration in which the first router
1275 sends all messages to a message-scanning program unless they have been
1276 previously scanned. Thus, the first router accepts all addresses without any
1277 checking, making it useless for verifying. Normally, the &%no_verify%& option
1278 would be set for such a router, causing it to be skipped in verify mode.
1279
1280
1281
1282
1283 .section "Running an individual router" "SECTrunindrou"
1284 .cindex "router" "running details"
1285 .cindex "preconditions" "checking"
1286 .cindex "router" "result of running"
1287 As explained in the example above, a number of preconditions are checked before
1288 running a router. If any are not met, the router is skipped, and the address is
1289 passed to the next router. When all the preconditions on a router &'are'& met,
1290 the router is run. What happens next depends on the outcome, which is one of
1291 the following:
1292
1293 .ilist
1294 &'accept'&: The router accepts the address, and either assigns it to a
1295 transport or generates one or more &"child"& addresses. Processing the
1296 original address ceases
1297 .oindex "&%unseen%&"
1298 unless the &%unseen%& option is set on the router. This option
1299 can be used to set up multiple deliveries with different routing (for example,
1300 for keeping archive copies of messages). When &%unseen%& is set, the address is
1301 passed to the next router. Normally, however, an &'accept'& return marks the
1302 end of routing.
1303
1304 Any child addresses generated by the router are processed independently,
1305 starting with the first router by default. It is possible to change this by
1306 setting the &%redirect_router%& option to specify which router to start at for
1307 child addresses. Unlike &%pass_router%& (see below) the router specified by
1308 &%redirect_router%& may be anywhere in the router configuration.
1309 .next
1310 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1311 requests that the address be passed to another router. By default, the address
1312 is passed to the next router, but this can be changed by setting the
1313 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1314 must be below the current router (to avoid loops).
1315 .next
1316 &'decline'&: The router declines to accept the address because it does not
1317 recognize it at all. By default, the address is passed to the next router, but
1318 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1319 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1320 &'decline'& into &'fail'&.
1321 .next
1322 &'fail'&: The router determines that the address should fail, and queues it for
1323 the generation of a bounce message. There is no further processing of the
1324 original address unless &%unseen%& is set on the router.
1325 .next
1326 &'defer'&: The router cannot handle the address at the present time. (A
1327 database may be offline, or a DNS lookup may have timed out.) No further
1328 processing of the address happens in this delivery attempt. It is tried again
1329 next time the message is considered for delivery.
1330 .next
1331 &'error'&: There is some error in the router (for example, a syntax error in
1332 its configuration). The action is as for defer.
1333 .endlist
1334
1335 If an address reaches the end of the routers without having been accepted by
1336 any of them, it is bounced as unrouteable. The default error message in this
1337 situation is &"unrouteable address"&, but you can set your own message by
1338 making use of the &%cannot_route_message%& option. This can be set for any
1339 router; the value from the last router that &"saw"& the address is used.
1340
1341 Sometimes while routing you want to fail a delivery when some conditions are
1342 met but others are not, instead of passing the address on for further routing.
1343 You can do this by having a second router that explicitly fails the delivery
1344 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1345 facility for this purpose.
1346
1347
1348 .section "Duplicate addresses" "SECID17"
1349 .cindex "case of local parts"
1350 .cindex "address duplicate, discarding"
1351 .cindex "duplicate addresses"
1352 Once routing is complete, Exim scans the addresses that are assigned to local
1353 and remote transports and discards any duplicates that it finds. During this
1354 check, local parts are treated case-sensitively. This happens only when
1355 actually delivering a message; when testing routers with &%-bt%&, all the
1356 routed addresses are shown.
1357
1358
1359
1360 .section "Router preconditions" "SECTrouprecon"
1361 .cindex "router" "preconditions, order of processing"
1362 .cindex "preconditions" "order of processing"
1363 The preconditions that are tested for each router are listed below, in the
1364 order in which they are tested. The individual configuration options are
1365 described in more detail in chapter &<<CHAProutergeneric>>&.
1366
1367 .olist
1368 .cindex affix "router precondition"
1369 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1370 the local parts handled by the router may or must have certain prefixes and/or
1371 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1372 skipped. These conditions are tested first. When an affix is present, it is
1373 removed from the local part before further processing, including the evaluation
1374 of any other conditions.
1375 .next
1376 Routers can be designated for use only when not verifying an address, that is,
1377 only when routing it for delivery (or testing its delivery routing). If the
1378 &%verify%& option is set false, the router is skipped when Exim is verifying an
1379 address.
1380 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1381 &%verify_recipient%&, which independently control the use of the router for
1382 sender and recipient verification. You can set these options directly if
1383 you want a router to be used for only one type of verification.
1384 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1385 .next
1386 If the &%address_test%& option is set false, the router is skipped when Exim is
1387 run with the &%-bt%& option to test an address routing. This can be helpful
1388 when the first router sends all new messages to a scanner of some sort; it
1389 makes it possible to use &%-bt%& to test subsequent delivery routing without
1390 having to simulate the effect of the scanner.
1391 .next
1392 Routers can be designated for use only when verifying an address, as
1393 opposed to routing it for delivery. The &%verify_only%& option controls this.
1394 Again, cutthrough delivery counts as a verification.
1395 .next
1396 Individual routers can be explicitly skipped when running the routers to
1397 check an address given in the SMTP EXPN command (see the &%expn%& option).
1398
1399 .next
1400 If the &%domains%& option is set, the domain of the address must be in the set
1401 of domains that it defines.
1402 .cindex "tainted data" "de-tainting"
1403 .cindex "de-tainting" "using router domains option"
1404 A match verifies the variable &$domain$& (which carries tainted data)
1405 and assigns an untainted value to the &$domain_data$& variable.
1406 Such an untainted value is often needed in the transport.
1407 For specifics of the matching operation and the resulting untainted value,
1408 refer to section &<<SECTdomainlist>>&.
1409
1410 When an untainted value is wanted, use this option
1411 rather than the generic &%condition%& option.
1412
1413 .next
1414 .vindex "&$local_part_prefix$&"
1415 .vindex "&$local_part_prefix_v$&"
1416 .vindex "&$local_part$&"
1417 .vindex "&$local_part_suffix$&"
1418 .vindex "&$local_part_suffix_v$&"
1419 .cindex affix "router precondition"
1420 If the &%local_parts%& option is set, the local part of the address must be in
1421 the set of local parts that it defines.
1422 A match verifies the variable &$local_part$& (which carries tainted data)
1423 and assigns an untainted value to the &$local_part_data$& variable.
1424 Such an untainted value is often needed in the transport.
1425 For specifics of the matching operation and the resulting untainted value,
1426 refer to section &<<SECTlocparlis>>&.
1427
1428 When an untainted value is wanted, use this option
1429 rather than the generic &%condition%& option.
1430
1431 If &%local_part_prefix%& or
1432 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1433 part before this check. If you want to do precondition tests on local parts
1434 that include affixes, you can do so by using a &%condition%& option (see below)
1435 that uses the variables &$local_part$&, &$local_part_prefix$&,
1436 &$local_part_prefix_v$&, &$local_part_suffix$&
1437 and &$local_part_suffix_v$& as necessary.
1438
1439 .next
1440 .vindex "&$local_user_uid$&"
1441 .vindex "&$local_user_gid$&"
1442 .vindex "&$home$&"
1443 If the &%check_local_user%& option is set, the local part must be the name of
1444 an account on the local host. If this check succeeds, the uid and gid of the
1445 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1446 user's home directory is placed in &$home$&; these values can be used in the
1447 remaining preconditions.
1448
1449 .next
1450 If the &%router_home_directory%& option is set, it is expanded at this point,
1451 because it overrides the value of &$home$&. If this expansion were left till
1452 later, the value of &$home$& as set by &%check_local_user%& would be used in
1453 subsequent tests. Having two different values of &$home$& in the same router
1454 could lead to confusion.
1455
1456 .next
1457 If the &%senders%& option is set, the envelope sender address must be in the
1458 set of addresses that it defines.
1459
1460 .next
1461 If the &%require_files%& option is set, the existence or non-existence of
1462 specified files is tested.
1463
1464 .next
1465 .cindex "customizing" "precondition"
1466 If the &%condition%& option is set, it is evaluated and tested. This option
1467 uses an expanded string to allow you to set up your own custom preconditions.
1468 Expanded strings are described in chapter &<<CHAPexpand>>&.
1469
1470 Note that while using
1471 this option for address matching technically works,
1472 it does not set any de-tainted values.
1473 Such values are often needed, either for router-specific options or
1474 for transport options.
1475 Using the &%domains%& and &%local_parts%& options is usually the most
1476 convenient way to obtain them.
1477 .endlist
1478
1479
1480 Note that &%require_files%& comes near the end of the list, so you cannot use
1481 it to check for the existence of a file in which to lookup up a domain, local
1482 part, or sender. However, as these options are all expanded, you can use the
1483 &%exists%& expansion condition to make such tests within each condition. The
1484 &%require_files%& option is intended for checking files that the router may be
1485 going to use internally, or which are needed by a specific transport (for
1486 example, &_.procmailrc_&).
1487
1488
1489
1490 .section "Delivery in detail" "SECID18"
1491 .cindex "delivery" "in detail"
1492 When a message is to be delivered, the sequence of events is as follows:
1493
1494 .olist
1495 If a system-wide filter file is specified, the message is passed to it. The
1496 filter may add recipients to the message, replace the recipients, discard the
1497 message, cause a new message to be generated, or cause the message delivery to
1498 fail. The format of the system filter file is the same as for Exim user filter
1499 files, described in the separate document entitled &'Exim's interfaces to mail
1500 filtering'&.
1501 .cindex "Sieve filter" "not available for system filter"
1502 (&*Note*&: Sieve cannot be used for system filter files.)
1503
1504 Some additional features are available in system filters &-- see chapter
1505 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1506 filter only once per delivery attempt, however many recipients it has. However,
1507 if there are several delivery attempts because one or more addresses could not
1508 be immediately delivered, the system filter is run each time. The filter
1509 condition &%first_delivery%& can be used to detect the first run of the system
1510 filter.
1511 .next
1512 Each recipient address is offered to each configured router, in turn, subject to
1513 its preconditions, until one is able to handle it. If no router can handle the
1514 address, that is, if they all decline, the address is failed. Because routers
1515 can be targeted at particular domains, several locally handled domains can be
1516 processed entirely independently of each other.
1517 .next
1518 .cindex "routing" "loops in"
1519 .cindex "loop" "while routing"
1520 A router that accepts an address may assign it to a local or a remote
1521 transport. However, the transport is not run at this time. Instead, the address
1522 is placed on a list for the particular transport, which will be run later.
1523 Alternatively, the router may generate one or more new addresses (typically
1524 from alias, forward, or filter files). New addresses are fed back into this
1525 process from the top, but in order to avoid loops, a router ignores any address
1526 which has an identically-named ancestor that was processed by itself.
1527 .next
1528 When all the routing has been done, addresses that have been successfully
1529 handled are passed to their assigned transports. When local transports are
1530 doing real local deliveries, they handle only one address at a time, but if a
1531 local transport is being used as a pseudo-remote transport (for example, to
1532 collect batched SMTP messages for transmission by some other means) multiple
1533 addresses can be handled. Remote transports can always handle more than one
1534 address at a time, but can be configured not to do so, or to restrict multiple
1535 addresses to the same domain.
1536 .next
1537 Each local delivery to a file or a pipe runs in a separate process under a
1538 non-privileged uid, and these deliveries are run one at a time. Remote
1539 deliveries also run in separate processes, normally under a uid that is private
1540 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1541 run in parallel. The maximum number of simultaneous remote deliveries for any
1542 one message is set by the &%remote_max_parallel%& option.
1543 The order in which deliveries are done is not defined, except that all local
1544 deliveries happen before any remote deliveries.
1545 .next
1546 .cindex "queue runner"
1547 When it encounters a local delivery during a queue run, Exim checks its retry
1548 database to see if there has been a previous temporary delivery failure for the
1549 address before running the local transport. If there was a previous failure,
1550 Exim does not attempt a new delivery until the retry time for the address is
1551 reached. However, this happens only for delivery attempts that are part of a
1552 queue run. Local deliveries are always attempted when delivery immediately
1553 follows message reception, even if retry times are set for them. This makes for
1554 better behaviour if one particular message is causing problems (for example,
1555 causing quota overflow, or provoking an error in a filter file).
1556 .next
1557 .cindex "delivery" "retry in remote transports"
1558 Remote transports do their own retry handling, since an address may be
1559 deliverable to one of a number of hosts, each of which may have a different
1560 retry time. If there have been previous temporary failures and no host has
1561 reached its retry time, no delivery is attempted, whether in a queue run or
1562 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1563 .next
1564 If there were any permanent errors, a bounce message is returned to an
1565 appropriate address (the sender in the common case), with details of the error
1566 for each failing address. Exim can be configured to send copies of bounce
1567 messages to other addresses.
1568 .next
1569 .cindex "delivery" "deferral"
1570 If one or more addresses suffered a temporary failure, the message is left on
1571 the queue, to be tried again later. Delivery of these addresses is said to be
1572 &'deferred'&.
1573 .next
1574 When all the recipient addresses have either been delivered or bounced,
1575 handling of the message is complete. The spool files and message log are
1576 deleted, though the message log can optionally be preserved if required.
1577 .endlist
1578
1579
1580
1581
1582 .section "Retry mechanism" "SECID19"
1583 .cindex "delivery" "retry mechanism"
1584 .cindex "retry" "description of mechanism"
1585 .cindex "queue runner"
1586 Exim's mechanism for retrying messages that fail to get delivered at the first
1587 attempt is the queue runner process. You must either run an Exim daemon that
1588 uses the &%-q%& option with a time interval to start queue runners at regular
1589 intervals or use some other means (such as &'cron'&) to start them. If you do
1590 not arrange for queue runners to be run, messages that fail temporarily at the
1591 first attempt will remain in your queue forever. A queue runner process works
1592 its way through the queue, one message at a time, trying each delivery that has
1593 passed its retry time.
1594 You can run several queue runners at once.
1595
1596 Exim uses a set of configured rules to determine when next to retry the failing
1597 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1598 should give up trying to deliver to the address, at which point it generates a
1599 bounce message. If no retry rules are set for a particular host, address, and
1600 error combination, no retries are attempted, and temporary errors are treated
1601 as permanent.
1602
1603
1604
1605 .subsection "Temporary delivery failure" SECID20
1606 .cindex "delivery" "temporary failure"
1607 There are many reasons why a message may not be immediately deliverable to a
1608 particular address. Failure to connect to a remote machine (because it, or the
1609 connection to it, is down) is one of the most common. Temporary failures may be
1610 detected during routing as well as during the transport stage of delivery.
1611 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1612 is on a file system where the user is over quota. Exim can be configured to
1613 impose its own quotas on local mailboxes; where system quotas are set they will
1614 also apply.
1615
1616 If a host is unreachable for a period of time, a number of messages may be
1617 waiting for it by the time it recovers, and sending them in a single SMTP
1618 connection is clearly beneficial. Whenever a delivery to a remote host is
1619 deferred,
1620 .cindex "hints database" "deferred deliveries"
1621 Exim makes a note in its hints database, and whenever a successful
1622 SMTP delivery has happened, it looks to see if any other messages are waiting
1623 for the same host. If any are found, they are sent over the same SMTP
1624 connection, subject to a configuration limit as to the maximum number in any
1625 one connection.
1626
1627
1628
1629 .subsection "Permanent delivery failure" SECID21
1630 .cindex "delivery" "permanent failure"
1631 .cindex "bounce message" "when generated"
1632 When a message cannot be delivered to some or all of its intended recipients, a
1633 bounce message is generated. Temporary delivery failures turn into permanent
1634 errors when their timeout expires. All the addresses that fail in a given
1635 delivery attempt are listed in a single message. If the original message has
1636 many recipients, it is possible for some addresses to fail in one delivery
1637 attempt and others to fail subsequently, giving rise to more than one bounce
1638 message. The wording of bounce messages can be customized by the administrator.
1639 See chapter &<<CHAPemsgcust>>& for details.
1640
1641 .cindex "&'X-Failed-Recipients:'& header line"
1642 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1643 failed addresses, for the benefit of programs that try to analyse such messages
1644 automatically.
1645
1646 .cindex "bounce message" "recipient of"
1647 A bounce message is normally sent to the sender of the original message, as
1648 obtained from the message's envelope. For incoming SMTP messages, this is the
1649 address given in the MAIL command. However, when an address is expanded via a
1650 forward or alias file, an alternative address can be specified for delivery
1651 failures of the generated addresses. For a mailing list expansion (see section
1652 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1653 of the list.
1654
1655
1656
1657 .subsection "Failures to deliver bounce messages" SECID22
1658 .cindex "bounce message" "failure to deliver"
1659 If a bounce message (either locally generated or received from a remote host)
1660 itself suffers a permanent delivery failure, the message is left in the queue,
1661 but it is frozen, awaiting the attention of an administrator. There are options
1662 that can be used to make Exim discard such failed messages, or to keep them
1663 for only a short time (see &%timeout_frozen_after%& and
1664 &%ignore_bounce_errors_after%&).
1665
1666
1667
1668
1669
1670 . ////////////////////////////////////////////////////////////////////////////
1671 . ////////////////////////////////////////////////////////////////////////////
1672
1673 .chapter "Building and installing Exim" "CHID3"
1674 .scindex IIDbuex "building Exim"
1675
1676 .section "Unpacking" "SECID23"
1677 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1678 creates a directory with the name of the current release (for example,
1679 &_exim-&version()_&) into which the following files are placed:
1680
1681 .table2 140pt
1682 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1683 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1684   documented"
1685 .irow &_LICENCE_&         "the GNU General Public Licence"
1686 .irow &_Makefile_&        "top-level make file"
1687 .irow &_NOTICE_&          "conditions for the use of Exim"
1688 .irow &_README_&          "list of files, directories and simple build &&&
1689   instructions"
1690 .endtable
1691
1692 Other files whose names begin with &_README_& may also be present. The
1693 following subdirectories are created:
1694
1695 .table2 140pt
1696 .irow &_Local_&           "an empty directory for local configuration files"
1697 .irow &_OS_&              "OS-specific files"
1698 .irow &_doc_&             "documentation files"
1699 .irow &_exim_monitor_&    "source files for the Exim monitor"
1700 .irow &_scripts_&         "scripts used in the build process"
1701 .irow &_src_&             "remaining source files"
1702 .irow &_util_&            "independent utilities"
1703 .endtable
1704
1705 The main utility programs are contained in the &_src_& directory and are built
1706 with the Exim binary. The &_util_& directory contains a few optional scripts
1707 that may be useful to some sites.
1708
1709
1710 .section "Multiple machine architectures and operating systems" "SECID24"
1711 .cindex "building Exim" "multiple OS/architectures"
1712 The building process for Exim is arranged to make it easy to build binaries for
1713 a number of different architectures and operating systems from the same set of
1714 source files. Compilation does not take place in the &_src_& directory.
1715 Instead, a &'build directory'& is created for each architecture and operating
1716 system.
1717 .cindex "symbolic link" "to build directory"
1718 Symbolic links to the sources are installed in this directory, which is where
1719 the actual building takes place. In most cases, Exim can discover the machine
1720 architecture and operating system for itself, but the defaults can be
1721 overridden if necessary.
1722 .cindex compiler requirements
1723 .cindex compiler version
1724 A C99-capable compiler will be required for the build.
1725
1726
1727 .section "PCRE2 library" "SECTpcre"
1728 .cindex "PCRE2 library"
1729 Exim no longer has an embedded regular-expression library as the vast majority of
1730 modern systems include PCRE2 as a system library, although you may need to
1731 install the PCRE2 package or the PCRE2 development package for your operating
1732 system. If your system has a normal PCRE2 installation the Exim build
1733 process will need no further configuration. If the library or the
1734 headers are in an unusual location you will need to either set the PCRE2_LIBS
1735 and INCLUDE directives appropriately,
1736 or set PCRE2_CONFIG=yes to use the installed &(pcre-config)& command.
1737 If your operating system has no
1738 PCRE2 support then you will need to obtain and build the current PCRE2
1739 from &url(https://github.com/PhilipHazel/pcre2/releases).
1740 More information on PCRE2 is available at &url(https://www.pcre.org/).
1741
1742 .section "DBM libraries" "SECTdb"
1743 .cindex "DBM libraries" "discussion of"
1744 .cindex "hints database" "DBM files used for"
1745 Even if you do not use any DBM files in your configuration, Exim still needs a
1746 DBM library in order to operate, because it uses indexed files for its hints
1747 databases. Unfortunately, there are a number of DBM libraries in existence, and
1748 different operating systems often have different ones installed.
1749
1750 .cindex "Solaris" "DBM library for"
1751 .cindex "IRIX, DBM library for"
1752 .cindex "BSD, DBM library for"
1753 .cindex "Linux, DBM library for"
1754 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1755 Linux distribution, the DBM configuration should happen automatically, and you
1756 may be able to ignore this section. Otherwise, you may have to learn more than
1757 you would like about DBM libraries from what follows.
1758
1759 .cindex "&'ndbm'& DBM library"
1760 Licensed versions of Unix normally contain a library of DBM functions operating
1761 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1762 versions of Unix seem to vary in what they contain as standard. In particular,
1763 some early versions of Linux have no default DBM library, and different
1764 distributors have chosen to bundle different libraries with their packaged
1765 versions. However, the more recent releases seem to have standardized on the
1766 Berkeley DB library.
1767
1768 Different DBM libraries have different conventions for naming the files they
1769 use. When a program opens a file called &_dbmfile_&, there are several
1770 possibilities:
1771
1772 .olist
1773 A traditional &'ndbm'& implementation, such as that supplied as part of
1774 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1775 .next
1776 .cindex "&'gdbm'& DBM library"
1777 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1778 compatibility interface it makes two different hard links to it with names
1779 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1780 filename is used unmodified.
1781 .next
1782 .cindex "Berkeley DB library"
1783 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1784 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1785 programmer exactly the same as the traditional &'ndbm'& implementation.
1786 .next
1787 If the Berkeley package is used in its native mode, it operates on a single
1788 file called &_dbmfile_&; the programmer's interface is somewhat different to
1789 the traditional &'ndbm'& interface.
1790 .next
1791 To complicate things further, there are several very different versions of the
1792 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1793 2.&'x'& and 3.&'x'& were current for a while,
1794 but the latest versions when Exim last revamped support were numbered 5.&'x'&.
1795 Maintenance of some of the earlier releases has ceased,
1796 and Exim no longer supports versions before 3.&'x'&.
1797 All versions of Berkeley DB could be obtained from
1798 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1799 page with far newer versions listed.
1800 It is probably wise to plan to move your storage configurations away from
1801 Berkeley DB format, as today there are smaller and simpler alternatives more
1802 suited to Exim's usage model.
1803 .next
1804 .cindex "&'tdb'& DBM library"
1805 Yet another DBM library, called &'tdb'&, is available from
1806 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1807 operates on a single file.
1808 .endlist
1809
1810 .cindex "USE_DB"
1811 .cindex "DBM libraries" "configuration for building"
1812 Exim and its utilities can be compiled to use any of these interfaces. In order
1813 to use any version of the Berkeley DB package in native mode, you must set
1814 USE_DB in an appropriate configuration file (typically
1815 &_Local/Makefile_&). For example:
1816 .code
1817 USE_DB=yes
1818 .endd
1819 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1820 error is diagnosed if you set more than one of these.
1821 You can set USE_NDBM if needed to override an operating system default.
1822
1823 At the lowest level, the build-time configuration sets none of these options,
1824 thereby assuming an interface of type (1). However, some operating system
1825 configuration files (for example, those for the BSD operating systems and
1826 Linux) assume type (4) by setting USE_DB as their default, and the
1827 configuration files for Cygwin set USE_GDBM. Anything you set in
1828 &_Local/Makefile_&, however, overrides these system defaults.
1829
1830 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1831 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1832 in one of these lines:
1833 .code
1834 DBMLIB = -ldb
1835 DBMLIB = -ltdb
1836 DBMLIB = -lgdbm -lgdbm_compat
1837 .endd
1838 The last of those was for a Linux having GDBM provide emulated NDBM facilities.
1839 Settings like that will work if the DBM library is installed in the standard
1840 place. Sometimes it is not, and the library's header file may also not be in
1841 the default path. You may need to set INCLUDE to specify where the header
1842 file is, and to specify the path to the library more fully in DBMLIB, as in
1843 this example:
1844 .code
1845 INCLUDE=-I/usr/local/include/db-4.1
1846 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1847 .endd
1848 There is further detailed discussion about the various DBM libraries in the
1849 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1850
1851
1852
1853 .section "Pre-building configuration" "SECID25"
1854 .cindex "building Exim" "pre-building configuration"
1855 .cindex "configuration for building Exim"
1856 .cindex "&_Local/Makefile_&"
1857 .cindex "&_src/EDITME_&"
1858 Before building Exim, a local configuration file that specifies options
1859 independent of any operating system has to be created with the name
1860 &_Local/Makefile_&. A template for this file is supplied as the file
1861 &_src/EDITME_&, and it contains full descriptions of all the option settings
1862 therein. These descriptions are therefore not repeated here. If you are
1863 building Exim for the first time, the simplest thing to do is to copy
1864 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1865
1866 There are three settings that you must supply, because Exim will not build
1867 without them. They are the location of the runtime configuration file
1868 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1869 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1870 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1871 a colon-separated list of filenames; Exim uses the first of them that exists.
1872
1873 There are a few other parameters that can be specified either at build time or
1874 at runtime, to enable the same binary to be used on a number of different
1875 machines. However, if the locations of Exim's spool directory and log file
1876 directory (if not within the spool directory) are fixed, it is recommended that
1877 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1878 detected early in Exim's execution (such as a malformed configuration file) can
1879 be logged.
1880
1881 .cindex "content scanning" "specifying at build time"
1882 Exim's interfaces for calling virus and spam scanning software directly from
1883 access control lists are not compiled by default. If you want to include these
1884 facilities, you need to set
1885 .code
1886 WITH_CONTENT_SCAN=yes
1887 .endd
1888 in your &_Local/Makefile_&. For details of the facilities themselves, see
1889 chapter &<<CHAPexiscan>>&.
1890
1891
1892 .cindex "&_Local/eximon.conf_&"
1893 .cindex "&_exim_monitor/EDITME_&"
1894 If you are going to build the Exim monitor, a similar configuration process is
1895 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1896 your installation and saved under the name &_Local/eximon.conf_&. If you are
1897 happy with the default settings described in &_exim_monitor/EDITME_&,
1898 &_Local/eximon.conf_& can be empty, but it must exist.
1899
1900 This is all the configuration that is needed in straightforward cases for known
1901 operating systems. However, the building process is set up so that it is easy
1902 to override options that are set by default or by operating-system-specific
1903 configuration files, for example, to change the C compiler, which
1904 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1905 do this.
1906
1907
1908
1909 .section "Support for iconv()" "SECID26"
1910 .cindex "&[iconv()]& support"
1911 .cindex "RFC 2047"
1912 The contents of header lines in messages may be encoded according to the rules
1913 described RFC 2047. This makes it possible to transmit characters that are not
1914 in the ASCII character set, and to label them as being in a particular
1915 character set. When Exim is inspecting header lines by means of the &%$h_%&
1916 mechanism, it decodes them, and translates them into a specified character set
1917 (default is set at build time). The translation is possible only if the operating system
1918 supports the &[iconv()]& function.
1919
1920 However, some of the operating systems that supply &[iconv()]& do not support
1921 very many conversions. The GNU &%libiconv%& library (available from
1922 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1923 systems to remedy this deficiency, as well as on systems that do not supply
1924 &[iconv()]& at all. After installing &%libiconv%&, you should add
1925 .code
1926 HAVE_ICONV=yes
1927 .endd
1928 to your &_Local/Makefile_& and rebuild Exim.
1929
1930
1931
1932 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1933 .cindex "TLS" "including support for TLS"
1934 .cindex "encryption" "including support for"
1935 .cindex "OpenSSL" "building Exim with"
1936 .cindex "GnuTLS" "building Exim with"
1937 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1938 command as per RFC 2487. It can also support clients that expect to
1939 start a TLS session immediately on connection to a non-standard port (see the
1940 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1941 line option).
1942
1943 If you want to build Exim with TLS support, you must first install either the
1944 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1945 implementing SSL.
1946
1947 If you do not want TLS support you should set
1948 .code
1949 DISABLE_TLS=yes
1950 .endd
1951 in &_Local/Makefile_&.
1952
1953 If OpenSSL is installed, you should set
1954 .code
1955 USE_OPENSL=yes
1956 TLS_LIBS=-lssl -lcrypto
1957 .endd
1958 in &_Local/Makefile_&. You may also need to specify the locations of the
1959 OpenSSL library and include files. For example:
1960 .code
1961 USE_OPENSSL=yes
1962 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1963 TLS_INCLUDE=-I/usr/local/openssl/include/
1964 .endd
1965 .cindex "pkg-config" "OpenSSL"
1966 If you have &'pkg-config'& available, then instead you can just use:
1967 .code
1968 USE_OPENSSL=yes
1969 USE_OPENSSL_PC=openssl
1970 .endd
1971 .cindex "USE_GNUTLS"
1972 If GnuTLS is installed, you should set
1973 .code
1974 USE_GNUTLS=yes
1975 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1976 .endd
1977 in &_Local/Makefile_&, and again you may need to specify the locations of the
1978 library and include files. For example:
1979 .code
1980 USE_GNUTLS=yes
1981 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1982 TLS_INCLUDE=-I/usr/gnu/include
1983 .endd
1984 .cindex "pkg-config" "GnuTLS"
1985 If you have &'pkg-config'& available, then instead you can just use:
1986 .code
1987 USE_GNUTLS=yes
1988 USE_GNUTLS_PC=gnutls
1989 .endd
1990
1991 You do not need to set TLS_INCLUDE if the relevant directory is already
1992 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1993 given in chapter &<<CHAPTLS>>&.
1994
1995
1996
1997
1998 .section "Use of tcpwrappers" "SECID27"
1999
2000 .cindex "tcpwrappers, building Exim to support"
2001 .cindex "USE_TCP_WRAPPERS"
2002 .cindex "TCP_WRAPPERS_DAEMON_NAME"
2003 .cindex "tcp_wrappers_daemon_name"
2004 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
2005 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
2006 alternative to Exim's own checking facilities for installations that are
2007 already making use of &'tcpwrappers'& for other purposes. To do this, you
2008 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
2009 &_tcpd.h_& to be available at compile time, and also ensure that the library
2010 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
2011 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
2012 you might have
2013 .code
2014 USE_TCP_WRAPPERS=yes
2015 CFLAGS=-O -I/usr/local/include
2016 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2017 .endd
2018 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2019 files is &"exim"&. For example, the line
2020 .code
2021 exim : LOCAL  192.168.1.  .friendly.domain.example
2022 .endd
2023 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2024 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2025 All other connections are denied. The daemon name used by &'tcpwrappers'&
2026 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2027 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2028 configure file. Consult the &'tcpwrappers'& documentation for
2029 further details.
2030
2031
2032 .section "Including support for IPv6" "SECID28"
2033 .cindex "IPv6" "including support for"
2034 Exim contains code for use on systems that have IPv6 support. Setting
2035 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2036 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2037 where the IPv6 support is not fully integrated into the normal include and
2038 library files.
2039
2040 Two different types of DNS record for handling IPv6 addresses have been
2041 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2042 currently seen as the mainstream. Another record type called A6 was proposed
2043 as better than AAAA because it had more flexibility. However, it was felt to be
2044 over-complex, and its status was reduced to &"experimental"&.
2045 Exim used to
2046 have a compile option for including A6 record support but this has now been
2047 withdrawn.
2048
2049
2050
2051 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2052 .cindex "lookup modules"
2053 .cindex "dynamic modules"
2054 .cindex ".so building"
2055 On some platforms, Exim supports not compiling all lookup types directly into
2056 the main binary, instead putting some into external modules which can be loaded
2057 on demand.
2058 This permits packagers to build Exim with support for lookups with extensive
2059 library dependencies without requiring all users to install all of those
2060 dependencies.
2061 Most, but not all, lookup types can be built this way.
2062
2063 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2064 installed; Exim will only load modules from that directory, as a security
2065 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2066 for your OS; see &_OS/Makefile-Linux_& for an example.
2067 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2068 see &_src/EDITME_& for details.
2069
2070 Then, for each module to be loaded dynamically, define the relevant
2071 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2072 For example, this will build in lsearch but load sqlite and mysql support
2073 on demand:
2074 .code
2075 LOOKUP_LSEARCH=yes
2076 LOOKUP_SQLITE=2
2077 LOOKUP_MYSQL=2
2078 .endd
2079
2080
2081 .section "The building process" "SECID29"
2082 .cindex "build directory"
2083 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2084 created, run &'make'& at the top level. It determines the architecture and
2085 operating system types, and creates a build directory if one does not exist.
2086 For example, on a Sun system running Solaris 8, the directory
2087 &_build-SunOS5-5.8-sparc_& is created.
2088 .cindex "symbolic link" "to source files"
2089 Symbolic links to relevant source files are installed in the build directory.
2090
2091 If this is the first time &'make'& has been run, it calls a script that builds
2092 a make file inside the build directory, using the configuration files from the
2093 &_Local_& directory. The new make file is then passed to another instance of
2094 &'make'&. This does the real work, building a number of utility scripts, and
2095 then compiling and linking the binaries for the Exim monitor (if configured), a
2096 number of utility programs, and finally Exim itself. The command &`make
2097 makefile`& can be used to force a rebuild of the make file in the build
2098 directory, should this ever be necessary.
2099
2100 If you have problems building Exim, check for any comments there may be in the
2101 &_README_& file concerning your operating system, and also take a look at the
2102 FAQ, where some common problems are covered.
2103
2104
2105
2106 .section 'Output from &"make"&' "SECID283"
2107 The output produced by the &'make'& process for compile lines is often very
2108 unreadable, because these lines can be very long. For this reason, the normal
2109 output is suppressed by default, and instead output similar to that which
2110 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2111 each module that is being compiled or linked. However, it is still possible to
2112 get the full output, by calling &'make'& like this:
2113 .code
2114 FULLECHO='' make -e
2115 .endd
2116 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2117 command reflection in &'make'&. When you ask for the full output, it is
2118 given in addition to the short output.
2119
2120
2121
2122 .section "Overriding build-time options for Exim" "SECToverride"
2123 .cindex "build-time options, overriding"
2124 The main make file that is created at the beginning of the building process
2125 consists of the concatenation of a number of files which set configuration
2126 values, followed by a fixed set of &'make'& instructions. If a value is set
2127 more than once, the last setting overrides any previous ones. This provides a
2128 convenient way of overriding defaults. The files that are concatenated are, in
2129 order:
2130 .display
2131 &_OS/Makefile-Default_&
2132 &_OS/Makefile-_&<&'ostype'&>
2133 &_Local/Makefile_&
2134 &_Local/Makefile-_&<&'ostype'&>
2135 &_Local/Makefile-_&<&'archtype'&>
2136 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2137 &_OS/Makefile-Base_&
2138 .endd
2139 .cindex "&_Local/Makefile_&"
2140 .cindex "building Exim" "operating system type"
2141 .cindex "building Exim" "architecture type"
2142 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2143 architecture type. &_Local/Makefile_& is required to exist, and the building
2144 process fails if it is absent. The other three &_Local_& files are optional,
2145 and are often not needed.
2146
2147 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2148 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2149 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2150 values are used, thereby providing a means of forcing particular settings.
2151 Otherwise, the scripts try to get values from the &%uname%& command. If this
2152 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2153 of &'ad hoc'& transformations are then applied, to produce the standard names
2154 that Exim expects. You can run these scripts directly from the shell in order
2155 to find out what values are being used on your system.
2156
2157
2158 &_OS/Makefile-Default_& contains comments about the variables that are set
2159 therein. Some (but not all) are mentioned below. If there is something that
2160 needs changing, review the contents of this file and the contents of the make
2161 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2162 default values are.
2163
2164
2165 .cindex "building Exim" "overriding default settings"
2166 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2167 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2168 need to change the original files. Instead, you should make the changes by
2169 putting the new values in an appropriate &_Local_& file. For example,
2170 .cindex "Tru64-Unix build-time settings"
2171 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2172 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2173 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2174 called with the option &%-std1%&, to make it recognize some of the features of
2175 Standard C that Exim uses. (Most other compilers recognize Standard C by
2176 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2177 containing the lines
2178 .code
2179 CC=cc
2180 CFLAGS=-std1
2181 .endd
2182 If you are compiling for just one operating system, it may be easier to put
2183 these lines directly into &_Local/Makefile_&.
2184
2185 Keeping all your local configuration settings separate from the distributed
2186 files makes it easy to transfer them to new versions of Exim simply by copying
2187 the contents of the &_Local_& directory.
2188
2189
2190 .cindex "NIS lookup type" "including support for"
2191 .cindex "NIS+ lookup type" "including support for"
2192 .cindex "LDAP" "including support for"
2193 .cindex "lookup" "inclusion in binary"
2194 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2195 lookup, but not all systems have these components installed, so the default is
2196 not to include the relevant code in the binary. All the different kinds of file
2197 and database lookup that Exim supports are implemented as separate code modules
2198 which are included only if the relevant compile-time options are set. In the
2199 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2200 .code
2201 LOOKUP_LDAP=yes
2202 LOOKUP_NIS=yes
2203 LOOKUP_NISPLUS=yes
2204 .endd
2205 and similar settings apply to the other lookup types. They are all listed in
2206 &_src/EDITME_&. In many cases the relevant include files and interface
2207 libraries need to be installed before compiling Exim.
2208 .cindex "cdb" "including support for"
2209 However, there are some optional lookup types (such as cdb) for which
2210 the code is entirely contained within Exim, and no external include
2211 files or libraries are required. When a lookup type is not included in the
2212 binary, attempts to configure Exim to use it cause runtime configuration
2213 errors.
2214
2215 .cindex "pkg-config" "lookups"
2216 .cindex "pkg-config" "authenticators"
2217 Many systems now use a tool called &'pkg-config'& to encapsulate information
2218 about how to compile against a library; Exim has some initial support for
2219 being able to use pkg-config for lookups and authenticators.  For any given
2220 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2221 variable with the &`_PC`& suffix in the name and assign as the value the
2222 name of the package to be queried.  The results of querying via the
2223 &'pkg-config'& command will be added to the appropriate Makefile variables
2224 with &`+=`& directives, so your version of &'make'& will need to support that
2225 syntax.  For instance:
2226 .code
2227 LOOKUP_SQLITE=yes
2228 LOOKUP_SQLITE_PC=sqlite3
2229 AUTH_GSASL=yes
2230 AUTH_GSASL_PC=libgsasl
2231 AUTH_HEIMDAL_GSSAPI=yes
2232 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2233 .endd
2234
2235 .cindex "Perl" "including support for"
2236 Exim can be linked with an embedded Perl interpreter, allowing Perl
2237 subroutines to be called during string expansion. To enable this facility,
2238 .code
2239 EXIM_PERL=perl.o
2240 .endd
2241 must be defined in &_Local/Makefile_&. Details of this facility are given in
2242 chapter &<<CHAPperl>>&.
2243
2244 .cindex "X11 libraries, location of"
2245 The location of the X11 libraries is something that varies a lot between
2246 operating systems, and there may be different versions of X11 to cope
2247 with. Exim itself makes no use of X11, but if you are compiling the Exim
2248 monitor, the X11 libraries must be available.
2249 The following three variables are set in &_OS/Makefile-Default_&:
2250 .code
2251 X11=/usr/X11R6
2252 XINCLUDE=-I$(X11)/include
2253 XLFLAGS=-L$(X11)/lib
2254 .endd
2255 These are overridden in some of the operating-system configuration files. For
2256 example, in &_OS/Makefile-SunOS5_& there is
2257 .code
2258 X11=/usr/openwin
2259 XINCLUDE=-I$(X11)/include
2260 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2261 .endd
2262 If you need to override the default setting for your operating system, place a
2263 definition of all three of these variables into your
2264 &_Local/Makefile-<ostype>_& file.
2265
2266 .cindex "EXTRALIBS"
2267 If you need to add any extra libraries to the link steps, these can be put in a
2268 variable called EXTRALIBS, which appears in all the link commands, but by
2269 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2270 command for linking the main Exim binary, and not for any associated utilities.
2271
2272 .cindex "DBM libraries" "configuration for building"
2273 There is also DBMLIB, which appears in the link commands for binaries that
2274 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2275 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2276 binary, and which can be used, for example, to include additional X11
2277 libraries.
2278
2279 .cindex "configuration file" "editing"
2280 The make file copes with rebuilding Exim correctly if any of the configuration
2281 files are edited. However, if an optional configuration file is deleted, it is
2282 necessary to touch the associated non-optional file (that is,
2283 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2284
2285
2286 .section "OS-specific header files" "SECID30"
2287 .cindex "&_os.h_&"
2288 .cindex "building Exim" "OS-specific C header files"
2289 The &_OS_& directory contains a number of files with names of the form
2290 &_os.h-<ostype>_&. These are system-specific C header files that should not
2291 normally need to be changed. There is a list of macro settings that are
2292 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2293 are porting Exim to a new operating system.
2294
2295
2296
2297 .section "Overriding build-time options for the monitor" "SECID31"
2298 .cindex "building Eximon"
2299 A similar process is used for overriding things when building the Exim monitor,
2300 where the files that are involved are
2301 .display
2302 &_OS/eximon.conf-Default_&
2303 &_OS/eximon.conf-_&<&'ostype'&>
2304 &_Local/eximon.conf_&
2305 &_Local/eximon.conf-_&<&'ostype'&>
2306 &_Local/eximon.conf-_&<&'archtype'&>
2307 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2308 .endd
2309 .cindex "&_Local/eximon.conf_&"
2310 As with Exim itself, the final three files need not exist, and in this case the
2311 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2312 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2313 variables of the same name, preceded by EXIMON_. For example, setting
2314 EXIMON_LOG_DEPTH in the environment overrides the value of
2315 LOG_DEPTH at runtime.
2316 .ecindex IIDbuex
2317
2318
2319 .section "Installing Exim binaries and scripts" "SECID32"
2320 .cindex "installing Exim"
2321 .cindex "BIN_DIRECTORY"
2322 The command &`make install`& runs the &(exim_install)& script with no
2323 arguments. The script copies binaries and utility scripts into the directory
2324 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2325 .cindex "setuid" "installing Exim with"
2326 The install script copies files only if they are newer than the files they are
2327 going to replace. The Exim binary is required to be owned by root and have the
2328 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2329 install`& as root so that it can set up the Exim binary in this way. However, in
2330 some special situations (for example, if a host is doing no local deliveries)
2331 it may be possible to run Exim without making the binary setuid root (see
2332 chapter &<<CHAPsecurity>>& for details).
2333
2334 .cindex "CONFIGURE_FILE"
2335 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2336 in &_Local/Makefile_&. If this names a single file, and the file does not
2337 exist, the default configuration file &_src/configure.default_& is copied there
2338 by the installation script. If a runtime configuration file already exists, it
2339 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2340 alternative files, no default is installed.
2341
2342 .cindex "system aliases file"
2343 .cindex "&_/etc/aliases_&"
2344 One change is made to the default configuration file when it is installed: the
2345 default configuration contains a router that references a system aliases file.
2346 The path to this file is set to the value specified by
2347 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2348 If the system aliases file does not exist, the installation script creates it,
2349 and outputs a comment to the user.
2350
2351 The created file contains no aliases, but it does contain comments about the
2352 aliases a site should normally have. Mail aliases have traditionally been
2353 kept in &_/etc/aliases_&. However, some operating systems are now using
2354 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2355 Exim's configuration if necessary.
2356
2357 The default configuration uses the local host's name as the only local domain,
2358 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2359 running as the local user. System aliases and &_.forward_& files in users' home
2360 directories are supported, but no NIS or NIS+ support is configured. Domains
2361 other than the name of the local host are routed using the DNS, with delivery
2362 over SMTP.
2363
2364 It is possible to install Exim for special purposes (such as building a binary
2365 distribution) in a private part of the file system. You can do this by a
2366 command such as
2367 .code
2368 make DESTDIR=/some/directory/ install
2369 .endd
2370 This has the effect of pre-pending the specified directory to all the file
2371 paths, except the name of the system aliases file that appears in the default
2372 configuration. (If a default alias file is created, its name &'is'& modified.)
2373 For backwards compatibility, ROOT is used if DESTDIR is not set,
2374 but this usage is deprecated.
2375
2376 .cindex "installing Exim" "what is not installed"
2377 Running &'make install'& does not copy the Exim 4 conversion script
2378 &'convert4r4'&. You will probably run this only once if you are
2379 upgrading from Exim 3. None of the documentation files in the &_doc_&
2380 directory are copied, except for the info files when you have set
2381 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2382
2383 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2384 to their names. The Exim binary itself, however, is handled differently. It is
2385 installed under a name that includes the version number and the compile number,
2386 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2387 called &_exim_& to point to the binary. If you are updating a previous version
2388 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2389 from the directory (as seen by other processes).
2390
2391 .cindex "installing Exim" "testing the script"
2392 If you want to see what the &'make install'& will do before running it for
2393 real, you can pass the &%-n%& option to the installation script by this
2394 command:
2395 .code
2396 make INSTALL_ARG=-n install
2397 .endd
2398 The contents of the variable INSTALL_ARG are passed to the installation
2399 script. You do not need to be root to run this test. Alternatively, you can run
2400 the installation script directly, but this must be from within the build
2401 directory. For example, from the top-level Exim directory you could use this
2402 command:
2403 .code
2404 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2405 .endd
2406 .cindex "installing Exim" "install script options"
2407 There are two other options that can be supplied to the installation script.
2408
2409 .ilist
2410 &%-no_chown%& bypasses the call to change the owner of the installed binary
2411 to root, and the call to make it a setuid binary.
2412 .next
2413 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2414 installed binary.
2415 .endlist
2416
2417 INSTALL_ARG can be used to pass these options to the script. For example:
2418 .code
2419 make INSTALL_ARG=-no_symlink install
2420 .endd
2421 The installation script can also be given arguments specifying which files are
2422 to be copied. For example, to install just the Exim binary, and nothing else,
2423 without creating the symbolic link, you could use:
2424 .code
2425 make INSTALL_ARG='-no_symlink exim' install
2426 .endd
2427
2428
2429
2430 .section "Installing info documentation" "SECTinsinfdoc"
2431 .cindex "installing Exim" "&'info'& documentation"
2432 Not all systems use the GNU &'info'& system for documentation, and for this
2433 reason, the Texinfo source of Exim's documentation is not included in the main
2434 distribution. Instead it is available separately from the FTP site (see section
2435 &<<SECTavail>>&).
2436
2437 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2438 source of the documentation is found in the source tree, running &`make
2439 install`& automatically builds the info files and installs them.
2440
2441
2442
2443 .section "Setting up the spool directory" "SECID33"
2444 .cindex "spool directory" "creating"
2445 When it starts up, Exim tries to create its spool directory if it does not
2446 exist. The Exim uid and gid are used for the owner and group of the spool
2447 directory. Sub-directories are automatically created in the spool directory as
2448 necessary.
2449
2450
2451
2452
2453 .section "Testing" "SECID34"
2454 .cindex "testing" "installation"
2455 Having installed Exim, you can check that the runtime configuration file is
2456 syntactically valid by running the following command, which assumes that the
2457 Exim binary directory is within your PATH environment variable:
2458 .code
2459 exim -bV
2460 .endd
2461 If there are any errors in the configuration file, Exim outputs error messages.
2462 Otherwise it outputs the version number and build date,
2463 the DBM library that is being used, and information about which drivers and
2464 other optional code modules are included in the binary.
2465 Some simple routing tests can be done by using the address testing option. For
2466 example,
2467 .display
2468 &`exim -bt`& <&'local username'&>
2469 .endd
2470 should verify that it recognizes a local mailbox, and
2471 .display
2472 &`exim -bt`& <&'remote address'&>
2473 .endd
2474 a remote one. Then try getting it to deliver mail, both locally and remotely.
2475 This can be done by passing messages directly to Exim, without going through a
2476 user agent. For example:
2477 .code
2478 exim -v postmaster@your.domain.example
2479 From: user@your.domain.example
2480 To: postmaster@your.domain.example
2481 Subject: Testing Exim
2482
2483 This is a test message.
2484 ^D
2485 .endd
2486 The &%-v%& option causes Exim to output some verification of what it is doing.
2487 In this case you should see copies of three log lines, one for the message's
2488 arrival, one for its delivery, and one containing &"Completed"&.
2489
2490 .cindex "delivery" "problems with"
2491 If you encounter problems, look at Exim's log files (&'mainlog'& and
2492 &'paniclog'&) to see if there is any relevant information there. Another source
2493 of information is running Exim with debugging turned on, by specifying the
2494 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2495 with debugging turned on by a command of the form
2496 .display
2497 &`exim -d -M`& <&'exim-message-id'&>
2498 .endd
2499 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2500 produces rather a lot of output, but you can cut this down to specific areas.
2501 For example, if you use &%-d-all+route%& only the debugging information
2502 relevant to routing is included. (See the &%-d%& option in chapter
2503 &<<CHAPcommandline>>& for more details.)
2504
2505 .cindex '&"sticky"& bit'
2506 .cindex "lock files"
2507 One specific problem that has shown up on some sites is the inability to do
2508 local deliveries into a shared mailbox directory, because it does not have the
2509 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2510 writing to a mailbox file, and if it cannot create the lock file, the delivery
2511 is deferred. You can get round this either by setting the &"sticky bit"& on the
2512 directory, or by setting a specific group for local deliveries and allowing
2513 that group to create files in the directory (see the comments above the
2514 &(local_delivery)& transport in the default configuration file). Another
2515 approach is to configure Exim not to use lock files, but just to rely on
2516 &[fcntl()]& locking instead. However, you should do this only if all user
2517 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2518 see chapter &<<CHAPappendfile>>&.
2519
2520 One thing that cannot be tested on a system that is already running an MTA is
2521 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2522 &%-oX%& option can be used to run an Exim daemon that listens on some other
2523 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2524 &'exim_checkaccess'& utility can be used to check out policy controls on
2525 incoming SMTP mail.
2526
2527 Testing a new version on a system that is already running Exim can most easily
2528 be done by building a binary with a different CONFIGURE_FILE setting. From
2529 within the runtime configuration, all other file and directory names
2530 that Exim uses can be altered, in order to keep it entirely clear of the
2531 production version.
2532
2533
2534 .section "Replacing another MTA with Exim" "SECID35"
2535 .cindex "replacing another MTA"
2536 Building and installing Exim for the first time does not of itself put it in
2537 general use. The name by which the system's MTA is called by mail user agents
2538 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2539 operating system), and it is necessary to make this name point to the &'exim'&
2540 binary in order to get the user agents to pass messages to Exim. This is
2541 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2542 or &_/usr/lib/sendmail_&
2543 .cindex "symbolic link" "to &'exim'& binary"
2544 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2545 privilege and executable status from the old MTA. It is then necessary to stop
2546 and restart the mailer daemon, if one is running.
2547
2548 .cindex "FreeBSD, MTA indirection"
2549 .cindex "&_/etc/mail/mailer.conf_&"
2550 Some operating systems have introduced alternative ways of switching MTAs. For
2551 example, if you are running FreeBSD, you need to edit the file
2552 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2553 described. A typical example of the contents of this file for running Exim is
2554 as follows:
2555 .code
2556 sendmail            /usr/exim/bin/exim
2557 send-mail           /usr/exim/bin/exim
2558 mailq               /usr/exim/bin/exim -bp
2559 newaliases          /usr/bin/true
2560 .endd
2561 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2562 your Exim installation is &"live"&. Check it by sending a message from your
2563 favourite user agent.
2564
2565 You should consider what to tell your users about the change of MTA. Exim may
2566 have different capabilities to what was previously running, and there are
2567 various operational differences such as the text of messages produced by
2568 command line options and in bounce messages. If you allow your users to make
2569 use of Exim's filtering capabilities, you should make the document entitled
2570 &'Exim's interface to mail filtering'& available to them.
2571
2572
2573
2574 .section "Running the daemon" SECTdaemonLaunch
2575 The most common command line for launching the Exim daemon looks like
2576 .code
2577 exim -bd -q5m
2578 .endd
2579 This starts a daemon which
2580 .ilist
2581 listens for incoming smtp connections, launching handler processes for
2582 each new one
2583 .next
2584 starts a queue-runner process every five minutes, to inspect queued messages
2585 and run delivery attempts on any that have arrived at their retry time
2586 .endlist
2587 Should a queue run take longer than the time between queue-runner starts,
2588 they will run in parallel.
2589 Numbers of jobs of the various types are subject to policy controls
2590 defined in the configuration.
2591
2592
2593 .section "Upgrading Exim" "SECID36"
2594 .cindex "upgrading Exim"
2595 If you are already running Exim on your host, building and installing a new
2596 version automatically makes it available to MUAs, or any other programs that
2597 call the MTA directly. However, if you are running an Exim daemon, you do need
2598 .cindex restart "on HUP signal"
2599 .cindex signal "HUP, to restart"
2600 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2601 new binary. You do not need to stop processing mail in order to install a new
2602 version of Exim. The install script does not modify an existing runtime
2603 configuration file.
2604
2605
2606
2607
2608 .section "Stopping the Exim daemon on Solaris" "SECID37"
2609 .cindex "Solaris" "stopping Exim on"
2610 The standard command for stopping the mailer daemon on Solaris is
2611 .code
2612 /etc/init.d/sendmail stop
2613 .endd
2614 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2615 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2616 for the text &"sendmail"&; this is not present because the actual program name
2617 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2618 solution is to replace the line that finds the process id with something like
2619 .code
2620 pid=`cat /var/spool/exim/exim-daemon.pid`
2621 .endd
2622 to obtain the daemon's pid directly from the file that Exim saves it in.
2623
2624 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2625 still be received from local processes, and if automatic delivery is configured
2626 (the normal case), deliveries will still occur.
2627
2628
2629
2630
2631 . ////////////////////////////////////////////////////////////////////////////
2632 . ////////////////////////////////////////////////////////////////////////////
2633
2634 .chapter "The Exim command line" "CHAPcommandline"
2635 .scindex IIDclo1 "command line" "options"
2636 .scindex IIDclo2 "options" "command line"
2637 Exim's command line takes the standard Unix form of a sequence of options,
2638 each starting with a hyphen character, followed by a number of arguments. The
2639 options are compatible with the main options of Sendmail, and there are also
2640 some additional options, some of which are compatible with Smail 3. Certain
2641 combinations of options do not make sense, and provoke an error if used.
2642 The form of the arguments depends on which options are set.
2643
2644
2645 .section "Setting options by program name" "SECID38"
2646 .cindex "&'mailq'&"
2647 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2648 were present before any other options.
2649 The &%-bp%& option requests a listing of the contents of the mail queue on the
2650 standard output.
2651 This feature is for compatibility with some systems that contain a command of
2652 that name in one of the standard libraries, symbolically linked to
2653 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2654
2655 .cindex "&'rsmtp'&"
2656 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2657 were present before any other options, for compatibility with Smail. The
2658 &%-bS%& option is used for reading in a number of messages in batched SMTP
2659 format.
2660
2661 .cindex "&'rmail'&"
2662 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2663 &%-oee%& options were present before any other options, for compatibility with
2664 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2665
2666 .cindex "&'runq'&"
2667 .cindex "queue runner"
2668 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2669 were present before any other options, for compatibility with Smail. The &%-q%&
2670 option causes a single queue runner process to be started.
2671
2672 .cindex "&'newaliases'&"
2673 .cindex "alias file" "building"
2674 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2675 If Exim is called under the name &'newaliases'& it behaves as if the option
2676 &%-bi%& were present before any other options, for compatibility with Sendmail.
2677 This option is used for rebuilding Sendmail's alias file. Exim does not have
2678 the concept of a single alias file, but can be configured to run a given
2679 command if called with the &%-bi%& option.
2680
2681
2682 .section "Trusted and admin users" "SECTtrustedadmin"
2683 Some Exim options are available only to &'trusted users'& and others are
2684 available only to &'admin users'&. In the description below, the phrases &"Exim
2685 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2686 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2687 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2688
2689 .ilist
2690 .cindex "trusted users" "definition of"
2691 .cindex "user" "trusted definition of"
2692 The trusted users are root, the Exim user, any user listed in the
2693 &%trusted_users%& configuration option, and any user whose current group or any
2694 supplementary group is one of those listed in the &%trusted_groups%&
2695 configuration option. Note that the Exim group is not automatically trusted.
2696
2697 .cindex '&"From"& line'
2698 .cindex "envelope from"
2699 .cindex "envelope sender"
2700 Trusted users are always permitted to use the &%-f%& option or a leading
2701 &"From&~"& line to specify the envelope sender of a message that is passed to
2702 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2703 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2704 users to set envelope senders.
2705
2706 .chindex From:
2707 .chindex Sender:
2708 For a trusted user, there is never any check on the contents of the &'From:'&
2709 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2710 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2711
2712 Trusted users may also specify a host name, host address, interface address,
2713 protocol name, ident value, and authentication data when submitting a message
2714 locally. Thus, they are able to insert messages into Exim's queue locally that
2715 have the characteristics of messages received from a remote host. Untrusted
2716 users may in some circumstances use &%-f%&, but can never set the other values
2717 that are available to trusted users.
2718 .next
2719 .cindex "user" "admin definition of"
2720 .cindex "admin user" "definition of"
2721 The admin users are root, the Exim user, and any user that is a member of the
2722 Exim group or of any group listed in the &%admin_groups%& configuration option.
2723 The current group does not have to be one of these groups.
2724
2725 Admin users are permitted to list the queue, and to carry out certain
2726 operations on messages, for example, to force delivery failures. It is also
2727 necessary to be an admin user in order to see the full information provided by
2728 the Exim monitor, and full debugging output.
2729
2730 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2731 Exim to attempt delivery of messages on its queue is restricted to admin users.
2732 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2733 option false (that is, specifying &%no_prod_requires_admin%&).
2734
2735 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2736 is restricted to admin users unless &%queue_list_requires_admin%& is set
2737 false.
2738 .endlist
2739
2740
2741 &*Warning*&: If you configure your system so that admin users are able to
2742 edit Exim's configuration file, you are giving those users an easy way of
2743 getting root. There is further discussion of this issue at the start of chapter
2744 &<<CHAPconf>>&.
2745
2746
2747
2748
2749 .section "Command line options" "SECID39"
2750 Exim's command line options are described in alphabetical order below. If none
2751 of the options that specifies a specific action (such as starting the daemon or
2752 a queue runner, or testing an address, or receiving a message in a specific
2753 format, or listing the queue) are present, and there is at least one argument
2754 on the command line, &%-bm%& (accept a local message on the standard input,
2755 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2756 outputs a brief message about itself and exits.
2757
2758 . ////////////////////////////////////////////////////////////////////////////
2759 . Insert a stylized XML comment here, to identify the start of the command line
2760 . options. This is for the benefit of the Perl script that automatically
2761 . creates a man page for the options.
2762 . ////////////////////////////////////////////////////////////////////////////
2763
2764 .literal xml
2765 <!-- === Start of command line options === -->
2766 .literal off
2767
2768
2769 .vlist
2770 .cmdopt "--" "--"
2771 .cindex "options" "command line; terminating"
2772 This is a pseudo-option whose only purpose is to terminate the options and
2773 therefore to cause subsequent command line items to be treated as arguments
2774 rather than options, even if they begin with hyphens.
2775
2776 .cmdopt --help
2777 This option causes Exim to output a few sentences stating what it is.
2778 The same output is generated if the Exim binary is called with no options and
2779 no arguments.
2780
2781 .cmdopt --version
2782 This option is an alias for &%-bV%& and causes version information to be
2783 displayed.
2784
2785 .vitem &%-Ac%& &&&
2786        &%-Am%&
2787 .oindex "&%-Ac%&"
2788 .oindex "&%-Am%&"
2789 These options are used by Sendmail for selecting configuration files and are
2790 ignored by Exim.
2791
2792 .cmdopt -B <&'type'&>
2793 .oindex "&%-B%&"
2794 .cindex "8-bit characters"
2795 .cindex "Sendmail compatibility" "8-bit characters"
2796 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2797 clean; it ignores this option.
2798
2799 .cmdopt -bd
2800 .cindex "daemon"
2801 .cindex "SMTP" "listener"
2802 .cindex "queue runner"
2803 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2804 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2805 that the daemon should also initiate periodic queue runs.
2806
2807 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2808 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2809 disconnect from the controlling terminal. When running this way, it can be
2810 stopped by pressing ctrl-C.
2811
2812 By default, Exim listens for incoming connections to the standard SMTP port on
2813 all the host's running interfaces. However, it is possible to listen on other
2814 ports, on multiple ports, and only on specific interfaces. Chapter
2815 &<<CHAPinterfaces>>& contains a description of the options that control this.
2816
2817 When a listening daemon
2818 .cindex "daemon" "process id (pid)"
2819 .cindex "pid (process id)" "of daemon"
2820 is started without the use of &%-oX%& (that is, without overriding the normal
2821 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2822 in Exim's spool directory. This location can be overridden by setting
2823 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2824 running as root.
2825
2826 When &%-oX%& is used on the command line to start a listening daemon, the
2827 process id is not written to the normal pid file path. However, &%-oP%& can be
2828 used to specify a path on the command line if a pid file is required.
2829
2830 The SIGHUP signal
2831 .cindex "SIGHUP"
2832 .cindex restart "on HUP signal"
2833 .cindex signal "HUP, to restart"
2834 .cindex "daemon" "restarting"
2835 .cindex signal "to reload configuration"
2836 .cindex daemon "reload configuration"
2837 .cindex reload configuration
2838 can be used to cause the daemon to re-execute itself. This should be done
2839 whenever Exim's configuration file, or any file that is incorporated into it by
2840 means of the &%.include%& facility, is changed, and also whenever a new version
2841 of Exim is installed. It is not necessary to do this when other files that are
2842 referenced from the configuration (for example, alias files) are changed,
2843 because these are reread each time they are used.
2844
2845 Either a SIGTERM or a SIGINT signal should be used to cause the daemon
2846 to cleanly shut down.
2847 Subprocesses handling recceiving or delivering messages,
2848 or for scanning the queue,
2849 will not be affected by the termination of the daemon process.
2850
2851 .cmdopt -bdf
2852 This option has the same effect as &%-bd%& except that it never disconnects
2853 from the controlling terminal, even when no debugging is specified.
2854
2855 .cmdopt -be
2856 .cindex "testing" "string expansion"
2857 .cindex "expansion" "testing"
2858 Run Exim in expansion testing mode. Exim discards its root privilege, to
2859 prevent ordinary users from using this mode to read otherwise inaccessible
2860 files. If no arguments are given, Exim runs interactively, prompting for lines
2861 of data. Otherwise, it processes each argument in turn.
2862
2863 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2864 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2865 used without command line arguments. If successful, it uses the &[readline()]&
2866 function, which provides extensive line-editing facilities, for reading the
2867 test data. A line history is supported.
2868
2869 Long expansion expressions can be split over several lines by using backslash
2870 continuations. As in Exim's runtime configuration, white space at the start of
2871 continuation lines is ignored. Each argument or data line is passed through the
2872 string expansion mechanism, and the result is output. Variable values from the
2873 configuration file (for example, &$qualify_domain$&) are available, but no
2874 message-specific values (such as &$message_exim_id$&) are set, because no message
2875 is being processed (but see &%-bem%& and &%-Mset%&).
2876
2877 &*Note*&: If you use this mechanism to test lookups, and you change the data
2878 files or databases you are using, you must exit and restart Exim before trying
2879 the same lookup again. Otherwise, because each Exim process caches the results
2880 of lookups, you will just get the same result as before.
2881
2882 Macro processing is done on lines before string-expansion: new macros can be
2883 defined and macros will be expanded.
2884 Because macros in the config file are often used for secrets, those are only
2885 available to admin users.
2886
2887 The word &"set"& at the start of a line, followed by a single space,
2888 is recognised specially as defining a value for a variable.
2889 The syntax is otherwise the same as the ACL modifier &"set ="&.
2890
2891 .cmdopt -bem <&'filename'&>
2892 .cindex "testing" "string expansion"
2893 .cindex "expansion" "testing"
2894 This option operates like &%-be%& except that it must be followed by the name
2895 of a file. For example:
2896 .code
2897 exim -bem /tmp/testmessage
2898 .endd
2899 The file is read as a message (as if receiving a locally-submitted non-SMTP
2900 message) before any of the test expansions are done. Thus, message-specific
2901 variables such as &$message_size$& and &$header_from:$& are available. However,
2902 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2903 recipients are read from the headers in the normal way, and are shown in the
2904 &$recipients$& variable. Note that recipients cannot be given on the command
2905 line, because further arguments are taken as strings to expand (just like
2906 &%-be%&).
2907
2908 .cmdopt -bF <&'filename'&>
2909 .cindex "system filter" "testing"
2910 .cindex "testing" "system filter"
2911 This option is the same as &%-bf%& except that it assumes that the filter being
2912 tested is a system filter. The additional commands that are available only in
2913 system filters are recognized.
2914
2915 .cmdopt -bf <&'filename'&>
2916 .cindex "filter" "testing"
2917 .cindex "testing" "filter file"
2918 .cindex "forward file" "testing"
2919 .cindex "testing" "forward file"
2920 .cindex "Sieve filter" "testing"
2921 This option runs Exim in user filter testing mode; the file is the filter file
2922 to be tested, and a test message must be supplied on the standard input. If
2923 there are no message-dependent tests in the filter, an empty file can be
2924 supplied.
2925
2926 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2927 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2928 filter and a user filter in the same run. For example:
2929 .code
2930 exim -bF /system/filter -bf /user/filter </test/message
2931 .endd
2932 This is helpful when the system filter adds header lines or sets filter
2933 variables that are used by the user filter.
2934
2935 If the test filter file does not begin with one of the special lines
2936 .code
2937 # Exim filter
2938 # Sieve filter
2939 .endd
2940 it is taken to be a normal &_.forward_& file, and is tested for validity under
2941 that interpretation. See sections &<<SECTitenonfilred>>& to
2942 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2943 redirection lists.
2944
2945 The result of an Exim command that uses &%-bf%&, provided no errors are
2946 detected, is a list of the actions that Exim would try to take if presented
2947 with the message for real. More details of filter testing are given in the
2948 separate document entitled &'Exim's interfaces to mail filtering'&.
2949
2950 When testing a filter file,
2951 .cindex "&""From""& line"
2952 .cindex "envelope from"
2953 .cindex "envelope sender"
2954 .oindex "&%-f%&" "for filter testing"
2955 the envelope sender can be set by the &%-f%& option,
2956 or by a &"From&~"& line at the start of the test message. Various parameters
2957 that would normally be taken from the envelope recipient address of the message
2958 can be set by means of additional command line options (see the next four
2959 options).
2960
2961 .cmdopt -bfd <&'domain'&>
2962 .vindex "&$qualify_domain$&"
2963 This sets the domain of the recipient address when a filter file is being
2964 tested by means of the &%-bf%& option. The default is the value of
2965 &$qualify_domain$&.
2966
2967 .cmdopt -bfl <&'local&~part'&>
2968 This sets the local part of the recipient address when a filter file is being
2969 tested by means of the &%-bf%& option. The default is the username of the
2970 process that calls Exim. A local part should be specified with any prefix or
2971 suffix stripped, because that is how it appears to the filter when a message is
2972 actually being delivered.
2973
2974 .cmdopt -bfp <&'prefix'&>
2975 .cindex affix "filter testing"
2976 This sets the prefix of the local part of the recipient address when a filter
2977 file is being tested by means of the &%-bf%& option. The default is an empty
2978 prefix.
2979
2980 .cmdopt -bfs <&'suffix'&>
2981 .cindex affix "filter testing"
2982 This sets the suffix of the local part of the recipient address when a filter
2983 file is being tested by means of the &%-bf%& option. The default is an empty
2984 suffix.
2985
2986 .cmdopt -bh <&'IP&~address'&>
2987 .cindex "testing" "incoming SMTP"
2988 .cindex "SMTP" "testing incoming"
2989 .cindex "testing" "relay control"
2990 .cindex "relaying" "testing configuration"
2991 .cindex "policy control" "testing"
2992 .cindex "debugging" "&%-bh%& option"
2993 This option runs a fake SMTP session as if from the given IP address, using the
2994 standard input and output. The IP address may include a port number at the end,
2995 after a full stop. For example:
2996 .code
2997 exim -bh 10.9.8.7.1234
2998 exim -bh fe80::a00:20ff:fe86:a061.5678
2999 .endd
3000 When an IPv6 address is given, it is converted into canonical form. In the case
3001 of the second example above, the value of &$sender_host_address$& after
3002 conversion to the canonical form is
3003 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
3004
3005 Comments as to what is going on are written to the standard error file. These
3006 include lines beginning with &"LOG"& for anything that would have been logged.
3007 This facility is provided for testing configuration options for incoming
3008 messages, to make sure they implement the required policy. For example, you can
3009 test your relay controls using &%-bh%&.
3010
3011 &*Warning 1*&:
3012 .cindex "RFC 1413"
3013 You can test features of the configuration that rely on ident (RFC 1413)
3014 information by using the &%-oMt%& option. However, Exim cannot actually perform
3015 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3016 connection.
3017
3018 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3019 are also skipped when testing using &%-bh%&. If you want these callouts to
3020 occur, use &%-bhc%& instead.
3021
3022 Messages supplied during the testing session are discarded, and nothing is
3023 written to any of the real log files. There may be pauses when DNS (and other)
3024 lookups are taking place, and of course these may time out. The &%-oMi%& option
3025 can be used to specify a specific IP interface and port if this is important,
3026 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3027 session were authenticated.
3028
3029 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3030 output just states whether a given recipient address from a given host is
3031 acceptable or not. See section &<<SECTcheckaccess>>&.
3032
3033 Features such as authentication and encryption, where the client input is not
3034 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3035 specialized SMTP test program such as
3036 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3037
3038 .cmdopt -bhc <&'IP&~address'&>
3039 This option operates in the same way as &%-bh%&, except that address
3040 verification callouts are performed if required. This includes consulting and
3041 updating the callout cache database.
3042
3043 .cmdopt -bi
3044 .cindex "alias file" "building"
3045 .cindex "building alias file"
3046 .cindex "Sendmail compatibility" "&%-bi%& option"
3047 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3048 Exim does not have the concept of a single alias file, and so it cannot mimic
3049 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3050 tend to appear in various scripts such as NIS make files, so the option must be
3051 recognized.
3052
3053 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3054 configuration option is run, under the uid and gid of the caller of Exim. If
3055 the &%-oA%& option is used, its value is passed to the command as an argument.
3056 The command set by &%bi_command%& may not contain arguments. The command can
3057 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3058 if this is required. If the &%bi_command%& option is not set, calling Exim with
3059 &%-bi%& is a no-op.
3060
3061 . // Keep :help first, then the rest in alphabetical order
3062 .cmdopt -bI:help
3063 .cindex "querying exim information"
3064 We shall provide various options starting &`-bI:`& for querying Exim for
3065 information.  The output of many of these will be intended for machine
3066 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3067 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3068 options shall cause Exim to exit after producing the requested output.
3069
3070 .cmdopt -bI:dscp
3071 .cindex "DSCP" "values"
3072 This option causes Exim to emit an alphabetically sorted list of all
3073 recognised DSCP names.
3074
3075 .cmdopt -bI:sieve
3076 .cindex "Sieve filter" "capabilities"
3077 This option causes Exim to emit an alphabetically sorted list of all supported
3078 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3079 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3080 &`SIEVE`& capability response line.  As the precise list may depend upon
3081 compile-time build options, which this option will adapt to, this is the only
3082 way to guarantee a correct response.
3083
3084 .cmdopt -bm
3085 .cindex "local message reception"
3086 This option runs an Exim receiving process that accepts an incoming,
3087 locally-generated message on the standard input. The recipients are given as the
3088 command arguments (except when &%-t%& is also present &-- see below). Each
3089 argument can be a comma-separated list of RFC 2822 addresses. This is the
3090 default option for selecting the overall action of an Exim call; it is assumed
3091 if no other conflicting option is present.
3092
3093 If any addresses in the message are unqualified (have no domain), they are
3094 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3095 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3096 suppressing this for special cases.
3097
3098 Policy checks on the contents of local messages can be enforced by means of
3099 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3100
3101 .cindex "return code" "for &%-bm%&"
3102 The return code is zero if the message is successfully accepted. Otherwise, the
3103 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3104
3105 The format
3106 .cindex "message" "format"
3107 .cindex "format" "message"
3108 .cindex "&""From""& line"
3109 .cindex "UUCP" "&""From""& line"
3110 .cindex "Sendmail compatibility" "&""From""& line"
3111 of the message must be as defined in RFC 2822, except that, for
3112 compatibility with Sendmail and Smail, a line in one of the forms
3113 .code
3114 From sender Fri Jan  5 12:55 GMT 1997
3115 From sender Fri, 5 Jan 97 12:55:01
3116 .endd
3117 (with the weekday optional, and possibly with additional text after the date)
3118 is permitted to appear at the start of the message. There appears to be no
3119 authoritative specification of the format of this line. Exim recognizes it by
3120 matching against the regular expression defined by the &%uucp_from_pattern%&
3121 option, which can be changed if necessary.
3122
3123 .oindex "&%-f%&" "overriding &""From""& line"
3124 The specified sender is treated as if it were given as the argument to the
3125 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3126 preference to the address taken from the message. The caller of Exim must be a
3127 trusted user for the sender of a message to be set in this way.
3128
3129 .cmdopt -bmalware <&'filename'&>
3130 .cindex "testing", "malware"
3131 .cindex "malware scan test"
3132 This debugging option causes Exim to scan the given file or directory
3133 (depending on the used scanner interface),
3134 using the malware scanning framework.  The option of &%av_scanner%& influences
3135 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3136 the expansion should have defaults which apply to this invocation.  ACLs are
3137 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3138 will never be populated and &%-bmalware%& will fail.
3139
3140 Exim will have changed working directory before resolving the filename, so
3141 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3142 user when it tries to open the file, rather than as the invoking user.
3143 This option requires admin privileges.
3144
3145 The &%-bmalware%& option will not be extended to be more generally useful,
3146 there are better tools for file-scanning.  This option exists to help
3147 administrators verify their Exim and AV scanner configuration.
3148
3149 .cmdopt -bnq
3150 .cindex "address qualification, suppressing"
3151 By default, Exim automatically qualifies unqualified addresses (those
3152 without domains) that appear in messages that are submitted locally (that
3153 is, not over TCP/IP). This qualification applies both to addresses in
3154 envelopes, and addresses in header lines. Sender addresses are qualified using
3155 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3156 defaults to the value of &%qualify_domain%&).
3157
3158 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3159 being used to re-submit messages that originally came from remote hosts after
3160 content scanning, you probably do not want to qualify unqualified addresses in
3161 header lines. (Such lines will be present only if you have not enabled a header
3162 syntax check in the appropriate ACL.)
3163
3164 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3165 messages that originate on the local host. When this is used, unqualified
3166 addresses in the envelope provoke errors (causing message rejection) and
3167 unqualified addresses in header lines are left alone.
3168
3169
3170 .cmdopt -bP
3171 .cindex "configuration options" "extracting"
3172 .cindex "options" "configuration &-- extracting"
3173 If this option is given with no arguments, it causes the values of all Exim's
3174 main configuration options to be written to the standard output. The values
3175 of one or more specific options can be requested by giving their names as
3176 arguments, for example:
3177 .code
3178 exim -bP qualify_domain hold_domains
3179 .endd
3180 .cindex "hiding configuration option values"
3181 .cindex "configuration options" "hiding value of"
3182 .cindex "options" "hiding value of"
3183 However, any option setting that is preceded by the word &"hide"& in the
3184 configuration file is not shown in full, except to an admin user. For other
3185 users, the output is as in this example:
3186 .code
3187 mysql_servers = <value not displayable>
3188 .endd
3189 If &%config%& is given as an argument, the config is
3190 output, as it was parsed, any include file resolved, any comment removed.
3191
3192 If &%config_file%& is given as an argument, the name of the runtime
3193 configuration file is output. (&%configure_file%& works too, for
3194 backward compatibility.)
3195 If a list of configuration files was supplied, the value that is output here
3196 is the name of the file that was actually used.
3197
3198 .cindex "options" "hiding name of"
3199 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3200 name will not be output.
3201
3202 .cindex "daemon" "process id (pid)"
3203 .cindex "pid (process id)" "of daemon"
3204 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3205 directories where log files and daemon pid files are written are output,
3206 respectively. If these values are unset, log files are written in a
3207 sub-directory of the spool directory called &%log%&, and the pid file is
3208 written directly into the spool directory.
3209
3210 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3211 .code
3212 exim -bP +local_domains
3213 .endd
3214 it searches for a matching named list of any type (domain, host, address, or
3215 local part) and outputs what it finds.
3216
3217 .cindex "options" "router &-- extracting"
3218 .cindex "options" "transport &-- extracting"
3219 .cindex "options" "authenticator &-- extracting"
3220 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3221 followed by the name of an appropriate driver instance, the option settings for
3222 that driver are output. For example:
3223 .code
3224 exim -bP transport local_delivery
3225 .endd
3226 The generic driver options are output first, followed by the driver's private
3227 options. A list of the names of drivers of a particular type can be obtained by
3228 using one of the words &%router_list%&, &%transport_list%&, or
3229 &%authenticator_list%&, and a complete list of all drivers with their option
3230 settings can be obtained by using &%routers%&, &%transports%&, or
3231 &%authenticators%&.
3232
3233 .cindex "environment"
3234 If &%environment%& is given as an argument, the set of environment
3235 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3236 variables.
3237
3238 .cindex "options" "macro &-- extracting"
3239 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3240 are available, similarly to the drivers.  Because macros are sometimes used
3241 for storing passwords, this option is restricted.
3242 The output format is one item per line.
3243 For the "-bP macro <name>" form, if no such macro is found
3244 the exit status will be nonzero.
3245
3246 .cmdopt -bp
3247 .cindex "queue" "listing messages in"
3248 .cindex "listing" "messages in the queue"
3249 This option requests a listing of the contents of the mail queue on the
3250 standard output. If the &%-bp%& option is followed by a list of message ids,
3251 just those messages are listed. By default, this option can be used only by an
3252 admin user. However, the &%queue_list_requires_admin%& option can be set false
3253 to allow any user to see the queue.
3254
3255 Each message in the queue is displayed as in the following example:
3256 .code
3257 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3258           red.king@looking-glass.fict.example
3259           <other addresses>
3260 .endd
3261 .cindex "message" "size in queue listing"
3262 .cindex "size" "of message"
3263 The first line contains the length of time the message has been in the queue
3264 (in this case 25 minutes), the size of the message (2.9K), the unique local
3265 identifier for the message, and the message sender, as contained in the
3266 envelope. For bounce messages, the sender address is empty, and appears as
3267 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3268 the default sender address, the user's login name is shown in parentheses
3269 before the sender address.
3270
3271 .cindex "frozen messages" "in queue listing"
3272 If the message is frozen (attempts to deliver it are suspended) then the text
3273 &"*** frozen ***"& is displayed at the end of this line.
3274
3275 The recipients of the message (taken from the envelope, not the headers) are
3276 displayed on subsequent lines. Those addresses to which the message has already
3277 been delivered are marked with the letter D. If an original address gets
3278 expanded into several addresses via an alias or forward file, the original is
3279 displayed with a D only when deliveries for all of its child addresses are
3280 complete.
3281
3282
3283 .cmdopt -bpa
3284 This option operates like &%-bp%&, but in addition it shows delivered addresses
3285 that were generated from the original top level address(es) in each message by
3286 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3287 of just &"D"&.
3288
3289
3290 .cmdopt -bpc
3291 .cindex "queue" "count of messages on"
3292 This option counts the number of messages in the queue, and writes the total
3293 to the standard output. It is restricted to admin users, unless
3294 &%queue_list_requires_admin%& is set false.
3295
3296
3297 .cmdopt -bpi
3298 .cindex queue "list of message IDs"
3299 This option operates like &%-bp%&, but only outputs message ids
3300 (one per line).
3301
3302
3303 .cmdopt -bpr
3304 This option operates like &%-bp%&, but the output is not sorted into
3305 chronological order of message arrival. This can speed it up when there are
3306 lots of messages in the queue, and is particularly useful if the output is
3307 going to be post-processed in a way that doesn't need the sorting.
3308
3309 .cmdopt -bpra
3310 This option is a combination of &%-bpr%& and &%-bpa%&.
3311
3312 .cmdopt -bpri
3313 This option is a combination of &%-bpr%& and &%-bpi%&.
3314
3315 .cmdopt -bpru
3316 This option is a combination of &%-bpr%& and &%-bpu%&.
3317
3318
3319 .cmdopt -bpu
3320 This option operates like &%-bp%& but shows only undelivered top-level
3321 addresses for each message displayed. Addresses generated by aliasing or
3322 forwarding are not shown, unless the message was deferred after processing by a
3323 router with the &%one_time%& option set.
3324
3325
3326 .cmdopt -brt
3327 .cindex "testing" "retry configuration"
3328 .cindex "retry" "configuration testing"
3329 This option is for testing retry rules, and it must be followed by up to three
3330 arguments. It causes Exim to look for a retry rule that matches the values
3331 and to write it to the standard output. For example:
3332 .code
3333 exim -brt bach.comp.mus.example
3334 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3335 .endd
3336 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3337 argument, which is required, can be a complete address in the form
3338 &'local_part@domain'&, or it can be just a domain name. If the second argument
3339 contains a dot, it is interpreted as an optional second domain name; if no
3340 retry rule is found for the first argument, the second is tried. This ties in
3341 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3342 rule is found that matches the host, one that matches the mail domain is
3343 sought. Finally, an argument that is the name of a specific delivery error, as
3344 used in setting up retry rules, can be given. For example:
3345 .code
3346 exim -brt haydn.comp.mus.example quota_3d
3347 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3348 .endd
3349
3350 .cmdopt -brw
3351 .cindex "testing" "rewriting"
3352 .cindex "rewriting" "testing"
3353 This option is for testing address rewriting rules, and it must be followed by
3354 a single argument, consisting of either a local part without a domain, or a
3355 complete address with a fully qualified domain. Exim outputs how this address
3356 would be rewritten for each possible place it might appear. See chapter
3357 &<<CHAPrewrite>>& for further details.
3358
3359 .cmdopt -bS
3360 .cindex "SMTP" "batched incoming"
3361 .cindex "batched SMTP input"
3362 This option is used for batched SMTP input, which is an alternative interface
3363 for non-interactive local message submission. A number of messages can be
3364 submitted in a single run. However, despite its name, this is not really SMTP
3365 input. Exim reads each message's envelope from SMTP commands on the standard
3366 input, but generates no responses. If the caller is trusted, or
3367 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3368 believed; otherwise the sender is always the caller of Exim.
3369
3370 The message itself is read from the standard input, in SMTP format (leading
3371 dots doubled), terminated by a line containing just a single dot. An error is
3372 provoked if the terminating dot is missing. A further message may then follow.
3373
3374 As for other local message submissions, the contents of incoming batch SMTP
3375 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3376 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3377 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3378
3379 Some other SMTP commands are recognized in the input. HELO and EHLO act
3380 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3381 QUIT quits, ignoring the rest of the standard input.
3382
3383 .cindex "return code" "for &%-bS%&"
3384 If any error is encountered, reports are written to the standard output and
3385 error streams, and Exim gives up immediately. The return code is 0 if no error
3386 was detected; it is 1 if one or more messages were accepted before the error
3387 was detected; otherwise it is 2.
3388
3389 More details of input using batched SMTP are given in section
3390 &<<SECTincomingbatchedSMTP>>&.
3391
3392 .cmdopt -bs
3393 .cindex "SMTP" "local input"
3394 .cindex "local SMTP input"
3395 This option causes Exim to accept one or more messages by reading SMTP commands
3396 on the standard input, and producing SMTP replies on the standard output. SMTP
3397 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3398 Some user agents use this interface as a way of passing locally-generated
3399 messages to the MTA.
3400
3401 In
3402 .cindex "sender" "source of"
3403 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3404 set, the senders of messages are taken from the SMTP MAIL commands.
3405 Otherwise the content of these commands is ignored and the sender is set up as
3406 the calling user. Unqualified addresses are automatically qualified using
3407 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3408 &%-bnq%& option is used.
3409
3410 .cindex "inetd"
3411 The
3412 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3413 using a listening daemon. Exim can distinguish the two cases by checking
3414 whether the standard input is a TCP/IP socket. When Exim is called from
3415 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3416 above concerning senders and qualification do not apply. In this situation,
3417 Exim behaves in exactly the same way as it does when receiving a message via
3418 the listening daemon.
3419
3420 .cmdopt -bt
3421 .cindex "testing" "addresses"
3422 .cindex "address" "testing"
3423 This option runs Exim in address testing mode, in which each argument is taken
3424 as a recipient address to be tested for deliverability. The results are
3425 written to the standard output. If a test fails, and the caller is not an admin
3426 user, no details of the failure are output, because these might contain
3427 sensitive information such as usernames and passwords for database lookups.
3428
3429 If no arguments are given, Exim runs in an interactive manner, prompting with a
3430 right angle bracket for addresses to be tested.
3431
3432 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3433 &[readline()]& function, because it is running as &'root'& and there are
3434 security issues.
3435
3436 Each address is handled as if it were the recipient address of a message
3437 (compare the &%-bv%& option). It is passed to the routers and the result is
3438 written to the standard output. However, any router that has
3439 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3440 genuine routing tests if your first router passes everything to a scanner
3441 program.
3442
3443 .cindex "return code" "for &%-bt%&"
3444 The return code is 2 if any address failed outright; it is 1 if no address
3445 failed outright but at least one could not be resolved for some reason. Return
3446 code 0 is given only when all addresses succeed.
3447
3448 .cindex "duplicate addresses"
3449 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3450 addresses after routing is complete, so that only one delivery takes place.
3451 This does not happen when testing with &%-bt%&; the full results of routing are
3452 always shown.
3453
3454 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3455 routers in the configuration makes any tests on the sender address of a
3456 message,
3457 .oindex "&%-f%&" "for address testing"
3458 you can use the &%-f%& option to set an appropriate sender when running
3459 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3460 default qualifying domain. However, if you have set up (for example) routers
3461 whose behaviour depends on the contents of an incoming message, you cannot test
3462 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3463 doing such tests.
3464
3465 .cmdopt -bV
3466 .cindex "version number of Exim"
3467 This option causes Exim to write the current version number, compilation
3468 number, and compilation date of the &'exim'& binary to the standard output.
3469 It also lists the DBM library that is being used, the optional modules (such as
3470 specific lookup types), the drivers that are included in the binary, and the
3471 name of the runtime configuration file that is in use.
3472
3473 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3474 configuration file. However, this is a static check only. It cannot check
3475 values that are to be expanded. For example, although a misspelt ACL verb is
3476 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3477 alone to discover (for example) all the typos in the configuration; some
3478 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3479 dynamic testing facilities.
3480
3481 .cmdopt -bv
3482 .cindex "verifying address" "using &%-bv%&"
3483 .cindex "address" "verification"
3484 This option runs Exim in address verification mode, in which each argument is
3485 taken as a recipient address to be verified by the routers. (This does
3486 not involve any verification callouts). During normal operation, verification
3487 happens mostly as a consequence processing a &%verify%& condition in an ACL
3488 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3489 including callouts, see the &%-bh%& and &%-bhc%& options.
3490
3491 If verification fails, and the caller is not an admin user, no details of the
3492 failure are output, because these might contain sensitive information such as
3493 usernames and passwords for database lookups.
3494
3495 If no arguments are given, Exim runs in an interactive manner, prompting with a
3496 right angle bracket for addresses to be verified.
3497
3498 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3499 &[readline()]& function, because it is running as &'exim'& and there are
3500 security issues.
3501
3502 Verification differs from address testing (the &%-bt%& option) in that routers
3503 that have &%no_verify%& set are skipped, and if the address is accepted by a
3504 router that has &%fail_verify%& set, verification fails. The address is
3505 verified as a recipient if &%-bv%& is used; to test verification for a sender
3506 address, &%-bvs%& should be used.
3507
3508 If the &%-v%& option is not set, the output consists of a single line for each
3509 address, stating whether it was verified or not, and giving a reason in the
3510 latter case. Without &%-v%&, generating more than one address by redirection
3511 causes verification to end successfully, without considering the generated
3512 addresses. However, if just one address is generated, processing continues,
3513 and the generated address must verify successfully for the overall verification
3514 to succeed.
3515
3516 When &%-v%& is set, more details are given of how the address has been handled,
3517 and in the case of address redirection, all the generated addresses are also
3518 considered. Verification may succeed for some and fail for others.
3519
3520 The
3521 .cindex "return code" "for &%-bv%&"
3522 return code is 2 if any address failed outright; it is 1 if no address
3523 failed outright but at least one could not be resolved for some reason. Return
3524 code 0 is given only when all addresses succeed.
3525
3526 If any of the routers in the configuration makes any tests on the sender
3527 address of a message, you should use the &%-f%& option to set an appropriate
3528 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3529 calling user at the default qualifying domain.
3530
3531 .cmdopt -bvs
3532 This option acts like &%-bv%&, but verifies the address as a sender rather
3533 than a recipient address. This affects any rewriting and qualification that
3534 might happen.
3535
3536 .cmdopt -bw
3537 .cindex "daemon"
3538 .cindex "inetd"
3539 .cindex "inetd" "wait mode"
3540 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3541 similarly to the &%-bd%& option.  All port specifications on the command-line
3542 and in the configuration file are ignored.  Queue-running may not be specified.
3543
3544 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3545 listening for connections.  This permits the system to start up and have
3546 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3547 each port only when the first connection is received.
3548
3549 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3550 which the daemon will exit, which should cause inetd to listen once more.
3551
3552 .cmdopt -C <&'filelist'&>
3553 .cindex "configuration file" "alternate"
3554 .cindex "CONFIGURE_FILE"
3555 .cindex "alternate configuration file"
3556 This option causes Exim to find the runtime configuration file from the given
3557 list instead of from the list specified by the CONFIGURE_FILE
3558 compile-time setting. Usually, the list will consist of just a single filename,
3559 but it can be a colon-separated list of names. In this case, the first
3560 file that exists is used. Failure to open an existing file stops Exim from
3561 proceeding any further along the list, and an error is generated.
3562
3563 When this option is used by a caller other than root, and the list is different
3564 from the compiled-in list, Exim gives up its root privilege immediately, and
3565 runs with the real and effective uid and gid set to those of the caller.
3566 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3567 file contains a list of full pathnames, one per line, for configuration files
3568 which are trusted. Root privilege is retained for any configuration file so
3569 listed, as long as the caller is the Exim user (or the user specified in the
3570 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3571 not writeable by inappropriate users or groups.
3572
3573 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3574 configuration using &%-C%& right through message reception and delivery,
3575 even if the caller is root. The reception works, but by that time, Exim is
3576 running as the Exim user, so when it re-executes to regain privilege for the
3577 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3578 test reception and delivery using two separate commands (one to put a message
3579 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3580
3581 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3582 prefix string with which any file named in a &%-C%& command line option
3583 must start. In addition, the filename must not contain the sequence &`/../`&.
3584 However, if the value of the &%-C%& option is identical to the value of
3585 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3586 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3587 unset, any filename can be used with &%-C%&.
3588
3589 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3590 to a directory to which only root has access. This prevents someone who has
3591 broken into the Exim account from running a privileged Exim with an arbitrary
3592 configuration file.
3593
3594 The &%-C%& facility is useful for ensuring that configuration files are
3595 syntactically correct, but cannot be used for test deliveries, unless the
3596 caller is privileged, or unless it is an exotic configuration that does not
3597 require privilege. No check is made on the owner or group of the files
3598 specified by this option.
3599
3600
3601 .vitem &%-D%&<&'macro'&>=<&'value'&>
3602 .oindex "&%-D%&"
3603 .cindex "macro" "setting on command line"
3604 This option can be used to override macro definitions in the configuration file
3605 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3606 unprivileged caller, it causes Exim to give up its root privilege.
3607 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3608 completely disabled, and its use causes an immediate error exit.
3609
3610 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3611 colon-separated list of macros which are considered safe and, if &%-D%& only
3612 supplies macros from this list, and the values are acceptable, then Exim will
3613 not give up root privilege if the caller is root, the Exim run-time user, or
3614 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3615 to be removed in the future.  Acceptable values for the macros satisfy the
3616 regexp: &`^[A-Za-z0-9_/.-]*$`&
3617
3618 The entire option (including equals sign if present) must all be within one
3619 command line item. &%-D%& can be used to set the value of a macro to the empty
3620 string, in which case the equals sign is optional. These two commands are
3621 synonymous:
3622 .code
3623 exim -DABC  ...
3624 exim -DABC= ...
3625 .endd
3626 To include spaces in a macro definition item, quotes must be used. If you use
3627 quotes, spaces are permitted around the macro name and the equals sign. For
3628 example:
3629 .code
3630 exim '-D ABC = something' ...
3631 .endd
3632 &%-D%& may be repeated up to 10 times on a command line.
3633 Only macro names up to 22 letters long can be set.
3634
3635
3636 .vitem &%-d%&<&'debug&~options'&>
3637 .oindex "&%-d%&"
3638 .cindex "debugging" "list of selectors"
3639 .cindex "debugging" "&%-d%& option"
3640 This option causes debugging information to be written to the standard
3641 error stream. It is restricted to admin users because debugging output may show
3642 database queries that contain password information. Also, the details of users'
3643 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3644 writes an error message to the standard error stream and exits with a non-zero
3645 return code.
3646
3647 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3648 standard debugging data is output. This can be reduced, or increased to include
3649 some more rarely needed information, by directly following &%-d%& with a string
3650 made up of names preceded by plus or minus characters. These add or remove sets
3651 of debugging data, respectively. For example, &%-d+filter%& adds filter
3652 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3653 no spaces are allowed in the debug setting. The available debugging categories
3654 are:
3655 .itable none 0 0 2 20* left 80* left
3656 .irow acl            "ACL interpretation"
3657 .irow auth           "authenticators"
3658 .irow deliver        "general delivery logic"
3659 .irow dns            "DNS lookups (see also resolver)"
3660 .irow dnsbl          "DNS black list (aka RBL) code"
3661 .irow exec           "arguments for &[execv()]& calls"
3662 .irow expand         "detailed debugging for string expansions"
3663 .irow filter         "filter handling"
3664 .irow hints_lookup   "hints data lookups"
3665 .irow host_lookup    "all types of name-to-IP address handling"
3666 .irow ident          "ident lookup"
3667 .irow interface      "lists of local interfaces"
3668 .irow lists          "matching things in lists"
3669 .irow load           "system load checks"
3670 .irow local_scan     "can be used by &[local_scan()]& (see chapter &&&
3671                     &<<CHAPlocalscan>>&)"
3672 .irow lookup         "general lookup code and all lookups"
3673 .irow memory         "memory handling"
3674 .irow noutf8         "modifier: avoid UTF-8 line-drawing"
3675 .irow pid            "modifier: add pid to debug output lines"
3676 .irow process_info   "setting info for the process log"
3677 .irow queue_run      "queue runs"
3678 .irow receive        "general message reception logic"
3679 .irow resolver       "turn on the DNS resolver's debugging output"
3680 .irow retry          "retry handling"
3681 .irow rewrite        "address rewriting""
3682 .irow route          "address routing"
3683 .irow timestamp      "modifier: add timestamp to debug output lines"
3684 .irow tls            "TLS logic"
3685 .irow transport      "transports"
3686 .irow uid            "changes of uid/gid and looking up uid/gid"
3687 .irow verify         "address verification logic"
3688 .irow all            "almost all of the above (see below), and also &%-v%&"
3689 .endtable
3690 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3691 for &`-all`&. The reason for this is that &`+all`& is something that people
3692 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3693 is included, an awful lot of output that is very rarely of interest is
3694 generated, so it now has to be explicitly requested. However, &`-all`& does
3695 turn everything off.
3696
3697 .cindex "resolver, debugging output"
3698 .cindex "DNS resolver, debugging output"
3699 The &`resolver`& option produces output only if the DNS resolver was compiled
3700 with DEBUG enabled. This is not the case in some operating systems. Also,
3701 unfortunately, debugging output from the DNS resolver is written to stdout
3702 rather than stderr.
3703
3704 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3705 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3706 However, the &`pid`& selector is forced when debugging is turned on for a
3707 daemon, which then passes it on to any re-executed Exims. Exim also
3708 automatically adds the pid to debug lines when several remote deliveries are
3709 run in parallel.
3710
3711 The &`timestamp`& selector causes the current time to be inserted at the start
3712 of all debug output lines. This can be useful when trying to track down delays
3713 in processing.
3714
3715 .cindex debugging "UTF-8 in"
3716 .cindex UTF-8 "in debug output"
3717 The &`noutf8`& selector disables the use of
3718 UTF-8 line-drawing characters to group related information.
3719 When disabled. ascii-art is used instead.
3720 Using the &`+all`& option does not set this modifier,
3721
3722 If the &%debug_print%& option is set in any driver, it produces output whenever
3723 any debugging is selected, or if &%-v%& is used.
3724
3725 .vitem &%-dd%&<&'debug&~options'&>
3726 .oindex "&%-dd%&"
3727 This option behaves exactly like &%-d%& except when used on a command that
3728 starts a daemon process. In that case, debugging is turned off for the
3729 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3730 behaviour of the daemon without creating as much output as full debugging does.
3731
3732 .cmdopt -dropcr
3733 This is an obsolete option that is now a no-op. It used to affect the way Exim
3734 handled CR and LF characters in incoming messages. What happens now is
3735 described in section &<<SECTlineendings>>&.
3736
3737 .cmdopt -E
3738 .cindex "bounce message" "generating"
3739 This option specifies that an incoming message is a locally-generated delivery
3740 failure report. It is used internally by Exim when handling delivery failures
3741 and is not intended for external use. Its only effect is to stop Exim
3742 generating certain messages to the postmaster, as otherwise message cascades
3743 could occur in some situations. As part of the same option, a message id may
3744 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3745 new message contains the id, following &"R="&, as a cross-reference.
3746
3747 .vitem &%-e%&&'x'&
3748 .oindex "&%-e%&&'x'&"
3749 There are a number of Sendmail options starting with &%-oe%& which seem to be
3750 called by various programs without the leading &%o%& in the option. For
3751 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3752 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3753
3754 .cmdopt -F <&'string'&>
3755 .cindex "sender" "name"
3756 .cindex "name" "of sender"
3757 This option sets the sender's full name for use when a locally-generated
3758 message is being accepted. In the absence of this option, the user's &'gecos'&
3759 entry from the password data is used. As users are generally permitted to alter
3760 their &'gecos'& entries, no security considerations are involved. White space
3761 between &%-F%& and the <&'string'&> is optional.
3762
3763 .cmdopt -f <&'address'&>
3764 .cindex "sender" "address"
3765 .cindex "address" "sender"
3766 .cindex "trusted users"
3767 .cindex "envelope from"
3768 .cindex "envelope sender"
3769 .cindex "user" "trusted"
3770 This option sets the address of the envelope sender of a locally-generated
3771 message (also known as the return path). The option can normally be used only
3772 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3773 users to use it.
3774
3775 Processes running as root or the Exim user are always trusted. Other
3776 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3777 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3778 of a local message is set to the caller's login name at the default qualify
3779 domain.
3780
3781 There is one exception to the restriction on the use of &%-f%&: an empty sender
3782 can be specified by any user, trusted or not, to create a message that can
3783 never provoke a bounce. An empty sender can be specified either as an empty
3784 string, or as a pair of angle brackets with nothing between them, as in these
3785 examples of shell commands:
3786 .code
3787 exim -f '<>' user@domain
3788 exim -f "" user@domain
3789 .endd
3790 In addition, the use of &%-f%& is not restricted when testing a filter file
3791 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3792 &%-bv%& options.
3793
3794 Allowing untrusted users to change the sender address does not of itself make
3795 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3796 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3797 though this can be overridden by setting &%no_local_from_check%&.
3798
3799 White
3800 .cindex "&""From""& line"
3801 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3802 given as two arguments or one combined argument). The sender of a
3803 locally-generated message can also be set (when permitted) by an initial
3804 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3805 if &%-f%& is also present, it overrides &"From&~"&.
3806
3807 .cmdopt -G
3808 .cindex "submission fixups, suppressing (command-line)"
3809 This option is equivalent to an ACL applying:
3810 .code
3811 control = suppress_local_fixups
3812 .endd
3813 for every message received.  Note that Sendmail will complain about such
3814 bad formatting, where Exim silently just does not fix it up.  This may change
3815 in future.
3816
3817 As this affects audit information, the caller must be a trusted user to use
3818 this option.
3819
3820 .cmdopt -h <&'number'&>
3821 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3822 This option is accepted for compatibility with Sendmail, but has no effect. (In
3823 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3824 headers.)
3825
3826 .cmdopt -i
3827 .cindex "Solaris" "&'mail'& command"
3828 .cindex "dot" "in incoming non-SMTP message"
3829 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3830 line by itself should not terminate an incoming, non-SMTP message.
3831 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3832 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3833 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3834 by its &'mailx'& command.
3835
3836 .cmdopt -L <&'tag'&>
3837 .cindex "syslog" "process name; set with flag"
3838 This option is equivalent to setting &%syslog_processname%& in the config
3839 file and setting &%log_file_path%& to &`syslog`&.
3840 Its use is restricted to administrators.  The configuration file has to be
3841 read and parsed, to determine access rights, before this is set and takes
3842 effect, so early configuration file errors will not honour this flag.
3843
3844 The tag should not be longer than 32 characters.
3845
3846 .cmdopt -M <&'message&~id'&>&~<&'message&~id'&>&~...
3847 .cindex "forcing delivery"
3848 .cindex "delivery" "forcing attempt"
3849 .cindex "frozen messages" "forcing delivery"
3850 This option requests Exim to run a delivery attempt on each message in turn. If
3851 any of the messages are frozen, they are automatically thawed before the
3852 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3853 and &%hold_domains%& are ignored.
3854
3855 Retry
3856 .cindex "hints database" "overriding retry hints"
3857 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3858 the normal retry time has not yet been reached. This option requires the caller
3859 to be an admin user. However, there is an option called &%prod_requires_admin%&
3860 which can be set false to relax this restriction (and also the same requirement
3861 for the &%-q%&, &%-R%&, and &%-S%& options).
3862
3863 The deliveries happen synchronously, that is, the original Exim process does
3864 not terminate until all the delivery attempts have finished. No output is
3865 produced unless there is a serious error. If you want to see what is happening,
3866 use the &%-v%& option as well, or inspect Exim's main log.
3867
3868 .cmdopt -Mar <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3869 .cindex "message" "adding recipients"
3870 .cindex "recipient" "adding"
3871 This option requests Exim to add the addresses to the list of recipients of the
3872 message (&"ar"& for &"add recipients"&). The first argument must be a message
3873 id, and the remaining ones must be email addresses. However, if the message is
3874 active (in the middle of a delivery attempt), it is not altered. This option
3875 can be used only by an admin user.
3876
3877 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3878         &~<&'host&~IP'&>&&&
3879         &~<&'sequence&~number'&>&&&
3880         &~<&'message&~id'&>"
3881 .oindex "&%-MC%&"
3882 .cindex "SMTP" "passed connection"
3883 .cindex "SMTP" "multiple deliveries"
3884 .cindex "multiple SMTP deliveries"
3885 This option is not intended for use by external callers. It is used internally
3886 by Exim to invoke another instance of itself to deliver a waiting message using
3887 an existing SMTP connection, which is passed as the standard input. Details are
3888 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3889 must be root or the Exim user in order to use it.
3890
3891 .cmdopt -MCA
3892 This option is not intended for use by external callers. It is used internally
3893 by Exim in conjunction with the &%-MC%& option. It signifies that the
3894 connection to the remote host has been authenticated.
3895
3896 .cmdopt -MCD
3897 This option is not intended for use by external callers. It is used internally
3898 by Exim in conjunction with the &%-MC%& option. It signifies that the
3899 remote host supports the ESMTP &_DSN_& extension.
3900
3901 .cmdopt -MCd
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-d%& option
3904 to pass on an information string on the purpose of the process.
3905
3906 .cmdopt -MCG <&'queue&~name'&>
3907 This option is not intended for use by external callers. It is used internally
3908 by Exim in conjunction with the &%-MC%& option. It signifies that an
3909 alternate queue is used, named by the following argument.
3910
3911 .cmdopt -MCK
3912 This option is not intended for use by external callers. It is used internally
3913 by Exim in conjunction with the &%-MC%& option. It signifies that a
3914 remote host supports the ESMTP &_CHUNKING_& extension.
3915
3916 .cmdopt -MCL
3917 This option is not intended for use by external callers. It is used internally
3918 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3919 which Exim is connected advertised limits on numbers of mails, recipients or
3920 recipient domains.
3921 The limits are given by the following three arguments.
3922
3923 .cmdopt -MCP
3924 This option is not intended for use by external callers. It is used internally
3925 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3926 which Exim is connected supports pipelining.
3927
3928 .cmdopt -MCp
3929 This option is not intended for use by external callers. It is used internally
3930 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3931 t a remote server is via a SOCKS proxy, using addresses and ports given by
3932 the following four arguments.
3933
3934 .cmdopt -MCQ <&'process&~id'&>&~<&'pipe&~fd'&>
3935 This option is not intended for use by external callers. It is used internally
3936 by Exim in conjunction with the &%-MC%& option when the original delivery was
3937 started by a queue runner. It passes on the process id of the queue runner,
3938 together with the file descriptor number of an open pipe. Closure of the pipe
3939 signals the final completion of the sequence of processes that are passing
3940 messages through the same SMTP connection.
3941
3942 .cmdopt -MCq <&'recipient&~address'&>&~<&'size'&>
3943 This option is not intended for use by external callers. It is used internally
3944 by Exim to implement quota checking for local users.
3945
3946 .cmdopt -MCS
3947 This option is not intended for use by external callers. It is used internally
3948 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3949 ESMTP SIZE option should be used on messages delivered down the existing
3950 connection.
3951
3952 .cmdopt -MCT
3953 This option is not intended for use by external callers. It is used internally
3954 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3955 host to which Exim is connected supports TLS encryption.
3956
3957 .vitem &%-MCr%&&~<&'SNI'&> &&&
3958        &%-MCs%&&~<&'SNI'&>
3959 .oindex "&%-MCs%&"
3960 .oindex "&%-MCr%&"
3961 These options are not intended for use by external callers. It is used internally
3962 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3963 a TLS Server Name Indication was sent as part of the channel establishment.
3964 The argument gives the SNI string.
3965 The "r" variant indicates a DANE-verified connection.
3966
3967 .cmdopt -MCt <&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3968 This option is not intended for use by external callers. It is used internally
3969 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3970 connection is being proxied by a parent process for handling TLS encryption.
3971 The arguments give the local address and port being proxied, and the TLS cipher.
3972
3973 .cmdopt -Mc <&'message&~id'&>&~<&'message&~id'&>&~...
3974 .cindex "hints database" "not overridden by &%-Mc%&"
3975 .cindex "delivery" "manually started &-- not forced"
3976 This option requests Exim to run a delivery attempt on each message, in turn,
3977 but unlike the &%-M%& option, it does check for retry hints, and respects any
3978 that are found. This option is not very useful to external callers. It is
3979 provided mainly for internal use by Exim when it needs to re-invoke itself in
3980 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3981 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3982 respects retry times and other options such as &%hold_domains%& that are
3983 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3984 If you want to run a specific delivery as if in a queue run, you should use
3985 &%-q%& with a message id argument. A distinction between queue run deliveries
3986 and other deliveries is made in one or two places.
3987
3988 .cmdopt -Mes <&'message&~id'&>&~<&'address'&>
3989 .cindex "message" "changing sender"
3990 .cindex "sender" "changing"
3991 This option requests Exim to change the sender address in the message to the
3992 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3993 &"edit sender"&). There must be exactly two arguments. The first argument must
3994 be a message id, and the second one an email address. However, if the message
3995 is active (in the middle of a delivery attempt), its status is not altered.
3996 This option can be used only by an admin user.
3997
3998 .cmdopt -Mf <&'message&~id'&>&~<&'message&~id'&>&~...
3999 .cindex "freezing messages"
4000 .cindex "message" "manually freezing"
4001 This option requests Exim to mark each listed message as &"frozen"&. This
4002 prevents any delivery attempts taking place until the message is &"thawed"&,
4003 either manually or as a result of the &%auto_thaw%& configuration option.
4004 However, if any of the messages are active (in the middle of a delivery
4005 attempt), their status is not altered. This option can be used only by an admin
4006 user.
4007
4008 .cmdopt -Mg <&'message&~id'&>&~<&'message&~id'&>&~...
4009 .cindex "giving up on messages"
4010 .cindex "message" "abandoning delivery attempts"
4011 .cindex "delivery" "abandoning further attempts"
4012 This option requests Exim to give up trying to deliver the listed messages,
4013 including any that are frozen. However, if any of the messages are active,
4014 their status is not altered. For non-bounce messages, a delivery error message
4015 is sent to the sender.
4016 Bounce messages are just discarded. This option can be used only by an admin
4017 user.
4018
4019 .cmdopt -MG <&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4020 .cindex queue named
4021 .cindex "named queues" "moving messages"
4022 .cindex "queue" "moving messages"
4023 This option requests that each listed message be moved from its current
4024 queue to the given named queue.
4025 The destination queue name argument is required, but can be an empty
4026 string to define the default queue.
4027 If the messages are not currently located in the default queue,
4028 a &%-qG<name>%& option will be required to define the source queue.
4029
4030 .cmdopt -Mmad <&'message&~id'&>&~<&'message&~id'&>&~...
4031 .cindex "delivery" "cancelling all"
4032 This option requests Exim to mark all the recipient addresses in the messages
4033 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4034 message is active (in the middle of a delivery attempt), its status is not
4035 altered. This option can be used only by an admin user.
4036
4037 .cmdopt -Mmd <&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4038 .cindex "delivery" "cancelling by address"
4039 .cindex "recipient" "removing"
4040 .cindex "removing recipients"
4041 This option requests Exim to mark the given addresses as already delivered
4042 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4043 the remaining ones must be email addresses. These are matched to recipient
4044 addresses in the message in a case-sensitive manner. If the message is active
4045 (in the middle of a delivery attempt), its status is not altered. This option
4046 can be used only by an admin user.
4047
4048 .cmdopt -Mrm <&'message&~id'&>&~<&'message&~id'&>&~...
4049 .cindex "removing messages"
4050 .cindex "abandoning mail"
4051 .cindex "message" "manually discarding"
4052 This option requests Exim to remove the given messages from the queue. No
4053 bounce messages are sent; each message is simply forgotten. However, if any of
4054 the messages are active, their status is not altered. This option can be used
4055 only by an admin user or by the user who originally caused the message to be
4056 placed in the queue.
4057
4058 . .new
4059 . .vitem &%-MS%&
4060 . .oindex "&%-MS%&"
4061 . .cindex REQUIRETLS
4062 . This option is used to request REQUIRETLS processing on the message.
4063 . It is used internally by Exim in conjunction with -E when generating
4064 . a bounce message.
4065 . .wen
4066
4067 .cmdopt -Mset <&'message&~id'&>
4068 .cindex "testing" "string expansion"
4069 .cindex "expansion" "testing"
4070 This option is useful only in conjunction with &%-be%& (that is, when testing
4071 string expansions). Exim loads the given message from its spool before doing
4072 the test expansions, thus setting message-specific variables such as
4073 &$message_size$& and the header variables. The &$recipients$& variable is made
4074 available. This feature is provided to make it easier to test expansions that
4075 make use of these variables. However, this option can be used only by an admin
4076 user. See also &%-bem%&.
4077
4078 .cmdopt -Mt <&'message&~id'&>&~<&'message&~id'&>&~...
4079 .cindex "thawing messages"
4080 .cindex "unfreezing messages"
4081 .cindex "frozen messages" "thawing"
4082 .cindex "message" "thawing frozen"
4083 This option requests Exim to &"thaw"& any of the listed messages that are
4084 &"frozen"&, so that delivery attempts can resume. However, if any of the
4085 messages are active, their status is not altered. This option can be used only
4086 by an admin user.
4087
4088 .cmdopt -Mvb <&'message&~id'&>
4089 .cindex "listing" "message body"
4090 .cindex "message" "listing body of"
4091 This option causes the contents of the message body (-D) spool file to be
4092 written to the standard output. This option can be used only by an admin user.
4093
4094 .cmdopt -Mvc <&'message&~id'&>
4095 .cindex "message" "listing in RFC 2822 format"
4096 .cindex "listing" "message in RFC 2822 format"
4097 This option causes a copy of the complete message (header lines plus body) to
4098 be written to the standard output in RFC 2822 format. This option can be used
4099 only by an admin user.
4100
4101 .cmdopt -Mvh <&'message&~id'&>
4102 .cindex "listing" "message headers"
4103 .cindex "header lines" "listing"
4104 .cindex "message" "listing header lines"
4105 This option causes the contents of the message headers (-H) spool file to be
4106 written to the standard output. This option can be used only by an admin user.
4107
4108 .cmdopt -Mvl <&'message&~id'&>
4109 .cindex "listing" "message log"
4110 .cindex "message" "listing message log"
4111 This option causes the contents of the message log spool file to be written to
4112 the standard output. This option can be used only by an admin user.
4113
4114 .cmdopt -m
4115 This is a synonym for &%-om%& that is accepted by Sendmail
4116 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4117 p. 1M-258), so Exim treats it that way too.
4118
4119 .cmdopt -N
4120 .cindex "debugging" "&%-N%& option"
4121 .cindex "debugging" "suppressing delivery"
4122 This is a debugging option that inhibits delivery of a message at the transport
4123 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4124 it just doesn't actually transport the message, but instead behaves as if it
4125 had successfully done so. However, it does not make any updates to the retry
4126 database, and the log entries for deliveries are flagged with &"*>"& rather
4127 than &"=>"&.
4128
4129 Because &%-N%& discards any message to which it applies, only root or the Exim
4130 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4131 words, an ordinary user can use it only when supplying an incoming message to
4132 which it will apply. Although transportation never fails when &%-N%& is set, an
4133 address may be deferred because of a configuration problem on a transport, or a
4134 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4135 the message, and applies to any subsequent delivery attempts that may happen
4136 for that message.
4137
4138 .cmdopt -n
4139 This option is interpreted by Sendmail to mean &"no aliasing"&.
4140 For normal modes of operation, it is ignored by Exim.
4141 When combined with &%-bP%& it makes the output more terse (suppresses
4142 option names, environment values and config pretty printing).
4143
4144 .cmdopt -O <&'data'&>
4145 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4146 Exim.
4147
4148 .cmdopt -oA <&'file&~name'&>
4149 .cindex "Sendmail compatibility" "&%-oA%& option"
4150 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4151 alternative alias filename. Exim handles &%-bi%& differently; see the
4152 description above.
4153
4154 .cmdopt -oB <&'n'&>
4155 .cindex "SMTP" "passed connection"
4156 .cindex "SMTP" "multiple deliveries"
4157 .cindex "multiple SMTP deliveries"
4158 This is a debugging option which limits the maximum number of messages that can
4159 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4160 transport. If <&'n'&> is omitted, the limit is set to 1.
4161
4162 .cmdopt -odb
4163 .cindex "background delivery"
4164 .cindex "delivery" "in the background"
4165 This option applies to all modes in which Exim accepts incoming messages,
4166 including the listening daemon. It requests &"background"& delivery of such
4167 messages, which means that the accepting process automatically starts a
4168 delivery process for each message received, but does not wait for the delivery
4169 processes to finish.
4170
4171 When all the messages have been received, the reception process exits,
4172 leaving the delivery processes to finish in their own time. The standard output
4173 and error streams are closed at the start of each delivery process.
4174 This is the default action if none of the &%-od%& options are present.
4175
4176 If one of the queueing options in the configuration file
4177 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4178 overrides it if &%queue_only_override%& is set true, which is the default
4179 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4180
4181 .cmdopt -odf
4182 .cindex "foreground delivery"
4183 .cindex "delivery" "in the foreground"
4184 This option requests &"foreground"& (synchronous) delivery when Exim has
4185 accepted a locally-generated message. (For the daemon it is exactly the same as
4186 &%-odb%&.) A delivery process is automatically started to deliver the message,
4187 and Exim waits for it to complete before proceeding.
4188
4189 The original Exim reception process does not finish until the delivery
4190 process for the final message has ended. The standard error stream is left open
4191 during deliveries.
4192
4193 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4194 false and one of the queueing options in the configuration file is in effect.
4195
4196 If there is a temporary delivery error during foreground delivery, the
4197 message is left in the queue for later delivery, and the original reception
4198 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4199 restricted configuration that never queues messages.
4200
4201
4202 .cmdopt -odi
4203 This option is synonymous with &%-odf%&. It is provided for compatibility with
4204 Sendmail.
4205
4206 .cmdopt -odq
4207 .cindex "non-immediate delivery"
4208 .cindex "delivery" "suppressing immediate"
4209 .cindex "queueing incoming messages"
4210 This option applies to all modes in which Exim accepts incoming messages,
4211 including the listening daemon. It specifies that the accepting process should
4212 not automatically start a delivery process for each message received. Messages
4213 are placed in the queue, and remain there until a subsequent queue runner
4214 process encounters them. There are several configuration options (such as
4215 &%queue_only%&) that can be used to queue incoming messages under certain
4216 conditions. This option overrides all of them and also &%-odqs%&. It always
4217 forces queueing.
4218
4219 .cmdopt -odqs
4220 .cindex "SMTP" "delaying delivery"
4221 .cindex "first pass routing"
4222 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4223 However, like &%-odb%& and &%-odi%&, this option has no effect if
4224 &%queue_only_override%& is false and one of the queueing options in the
4225 configuration file is in effect.
4226
4227 When &%-odqs%& does operate, a delivery process is started for each incoming
4228 message, in the background by default, but in the foreground if &%-odi%& is
4229 also present. The recipient addresses are routed, and local deliveries are done
4230 in the normal way. However, if any SMTP deliveries are required, they are not
4231 done at this time, so the message remains in the queue until a subsequent queue
4232 runner process encounters it. Because routing was done, Exim knows which
4233 messages are waiting for which hosts, and so a number of messages for the same
4234 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4235 configuration option has the same effect for specific domains. See also the
4236 &%-qq%& option.
4237
4238 .cmdopt -oee
4239 .cindex "error" "reporting"
4240 If an error is detected while a non-SMTP message is being received (for
4241 example, a malformed address), the error is reported to the sender in a mail
4242 message.
4243
4244 .cindex "return code" "for &%-oee%&"
4245 Provided
4246 this error message is successfully sent, the Exim receiving process
4247 exits with a return code of zero. If not, the return code is 2 if the problem
4248 is that the original message has no recipients, or 1 for any other error.
4249 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4250
4251 .cmdopt -oem
4252 .cindex "error" "reporting"
4253 .cindex "return code" "for &%-oem%&"
4254 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4255 return code, whether or not the error message was successfully sent.
4256 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4257
4258 .cmdopt -oep
4259 .cindex "error" "reporting"
4260 If an error is detected while a non-SMTP message is being received, the
4261 error is reported by writing a message to the standard error file (stderr).
4262 .cindex "return code" "for &%-oep%&"
4263 The return code is 1 for all errors.
4264
4265 .cmdopt -oeq
4266 .cindex "error" "reporting"
4267 This option is supported for compatibility with Sendmail, but has the same
4268 effect as &%-oep%&.
4269
4270 .cmdopt -oew
4271 .cindex "error" "reporting"
4272 This option is supported for compatibility with Sendmail, but has the same
4273 effect as &%-oem%&.
4274
4275 .cmdopt -oi
4276 .cindex "dot" "in incoming non-SMTP message"
4277 This option, which has the same effect as &%-i%&, specifies that a dot on a
4278 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4279 single dot does terminate, though Exim does no special processing for other
4280 lines that start with a dot. This option is set by default if Exim is called as
4281 &'rmail'&. See also &%-ti%&.
4282
4283 .cmdopt -oitrue
4284 This option is treated as synonymous with &%-oi%&.
4285
4286 .cmdopt -oMa <&'host&~address'&>
4287 .cindex "sender" "host address, specifying for local message"
4288 A number of options starting with &%-oM%& can be used to set values associated
4289 with remote hosts on locally-submitted messages (that is, messages not received
4290 over TCP/IP). These options can be used by any caller in conjunction with the
4291 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4292 other circumstances, they are ignored unless the caller is trusted.
4293
4294 The &%-oMa%& option sets the sender host address. This may include a port
4295 number at the end, after a full stop (period). For example:
4296 .code
4297 exim -bs -oMa 10.9.8.7.1234
4298 .endd
4299 An alternative syntax is to enclose the IP address in square brackets,
4300 followed by a colon and the port number:
4301 .code
4302 exim -bs -oMa [10.9.8.7]:1234
4303 .endd
4304 The IP address is placed in the &$sender_host_address$& variable, and the
4305 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4306 are present on the command line, the sender host IP address is taken from
4307 whichever one is last.
4308
4309 .cmdopt -oMaa <&'name'&>
4310 .cindex "authentication" "name, specifying for local message"
4311 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4312 option sets the value of &$sender_host_authenticated$& (the authenticator
4313 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4314 This option can be used with &%-bh%& and &%-bs%& to set up an
4315 authenticated SMTP session without actually using the SMTP AUTH command.
4316
4317 .cmdopt -oMai <&'string'&>
4318 .cindex "authentication" "id, specifying for local message"
4319 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4320 option sets the value of &$authenticated_id$& (the id that was authenticated).
4321 This overrides the default value (the caller's login id, except with &%-bh%&,
4322 where there is no default) for messages from local sources. See chapter
4323 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4324
4325 .cmdopt -oMas <&'address'&>
4326 .cindex "authentication" "sender, specifying for local message"
4327 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4328 option sets the authenticated sender value in &$authenticated_sender$&. It
4329 overrides the sender address that is created from the caller's login id for
4330 messages from local sources, except when &%-bh%& is used, when there is no
4331 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4332 specified on a MAIL command overrides this value. See chapter
4333 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4334
4335 .cmdopt -oMi <&'interface&~address'&>
4336 .cindex "interface" "address, specifying for local message"
4337 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4338 option sets the IP interface address value. A port number may be included,
4339 using the same syntax as for &%-oMa%&. The interface address is placed in
4340 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4341
4342 .cmdopt -oMm <&'message&~reference'&>
4343 .cindex "message reference" "message reference, specifying for local message"
4344 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4345 option sets the message reference, e.g. message-id, and is logged during
4346 delivery. This is useful when some kind of audit trail is required to tie
4347 messages together. The format of the message reference is checked and will
4348 abort if the format is invalid. The option will only be accepted if exim is
4349 running in trusted mode, not as any regular user.
4350
4351 The best example of a message reference is when Exim sends a bounce message.
4352 The message reference is the message-id of the original message for which Exim
4353 is sending the bounce.
4354
4355 .cmdopt -oMr <&'protocol&~name'&>
4356 .cindex "protocol, specifying for local message"
4357 .vindex "&$received_protocol$&"
4358 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4359 option sets the received protocol value that is stored in
4360 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4361 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4362 SMTP protocol names (see the description of &$received_protocol$& in section
4363 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4364 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4365 be set by &%-oMr%&. Repeated use of this option is not supported.
4366
4367 .cmdopt -oMs <&'host&~name'&>
4368 .cindex "sender" "host name, specifying for local message"
4369 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4370 option sets the sender host name in &$sender_host_name$&. When this option is
4371 present, Exim does not attempt to look up a host name from an IP address; it
4372 uses the name it is given.
4373
4374 .cmdopt -oMt <&'ident&~string'&>
4375 .cindex "sender" "ident string, specifying for local message"
4376 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4377 option sets the sender ident value in &$sender_ident$&. The default setting for
4378 local callers is the login id of the calling process, except when &%-bh%& is
4379 used, when there is no default.
4380
4381 .cmdopt -om
4382 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4383 In Sendmail, this option means &"me too"&, indicating that the sender of a
4384 message should receive a copy of the message if the sender appears in an alias
4385 expansion. Exim always does this, so the option does nothing.
4386
4387 .cmdopt -oo
4388 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4389 This option is ignored. In Sendmail it specifies &"old style headers"&,
4390 whatever that means.
4391
4392 .cmdopt -oP <&'path'&>
4393 .cindex "pid (process id)" "of daemon"
4394 .cindex "daemon" "process id (pid)"
4395 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4396 value. The option specifies the file to which the process id of the daemon is
4397 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4398 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4399 because in those cases, the normal pid file is not used.
4400
4401 .cmdopt -oPX
4402 .cindex "pid (process id)" "of daemon"
4403 .cindex "daemon" "process id (pid)"
4404 This option is not intended for general use.
4405 The daemon uses it when terminating due to a SIGTEM, possibly in
4406 combination with &%-oP%&&~<&'path'&>.
4407 It causes the pid file to be removed.
4408
4409 .cmdopt -or <&'time'&>
4410 .cindex "timeout" "for non-SMTP input"
4411 This option sets a timeout value for incoming non-SMTP messages. If it is not
4412 set, Exim will wait forever for the standard input. The value can also be set
4413 by the &%receive_timeout%& option. The format used for specifying times is
4414 described in section &<<SECTtimeformat>>&.
4415
4416 .cmdopt -os <&'time'&>
4417 .cindex "timeout" "for SMTP input"
4418 .cindex "SMTP" "input timeout"
4419 This option sets a timeout value for incoming SMTP messages. The timeout
4420 applies to each SMTP command and block of data. The value can also be set by
4421 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4422 for specifying times is described in section &<<SECTtimeformat>>&.
4423
4424 .cmdopt -ov
4425 This option has exactly the same effect as &%-v%&.
4426
4427 .cmdopt -oX <&'number&~or&~string'&>
4428 .cindex "TCP/IP" "setting listening ports"
4429 .cindex "TCP/IP" "setting listening interfaces"
4430 .cindex "port" "receiving TCP/IP"
4431 This option is relevant only when the &%-bd%& (start listening daemon) option
4432 is also given. It controls which ports and interfaces the daemon uses. Details
4433 of the syntax, and how it interacts with configuration file options, are given
4434 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4435 file is written unless &%-oP%& is also present to specify a pid filename.
4436
4437 .cmdopt -oY
4438 .cindex "daemon notifier socket"
4439 This option controls the creation of an inter-process communications endpoint
4440 by the Exim daemon.
4441 It is only relevant when the &%-bd%& (start listening daemon) option is also
4442 given.
4443 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4444 option is also present.
4445 If this option is given then the socket will not be created.  This is required
4446 if the system is running multiple daemons, in which case it should
4447 be used on all.
4448 The features supported by the socket will not be available in such cases.
4449
4450 The socket is currently used for
4451 .ilist
4452 fast ramp-up of queue runner processes
4453 .next
4454 caching compiled regexes
4455 .next
4456 obtaining a current queue size
4457 .endlist
4458
4459 .cmdopt -pd
4460 .cindex "Perl" "starting the interpreter"
4461 This option applies when an embedded Perl interpreter is linked with Exim (see
4462 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4463 option, forcing the starting of the interpreter to be delayed until it is
4464 needed.
4465
4466 .cmdopt -ps
4467 .cindex "Perl" "starting the interpreter"
4468 This option applies when an embedded Perl interpreter is linked with Exim (see
4469 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4470 option, forcing the starting of the interpreter to occur as soon as Exim is
4471 started.
4472
4473 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4474 .oindex "&%-p%&"
4475 For compatibility with Sendmail, this option is equivalent to
4476 .display
4477 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4478 .endd
4479 It sets the incoming protocol and host name (for trusted callers). The
4480 host name and its colon can be omitted when only the protocol is to be set.
4481 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4482 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4483 or &`s`& using this option (but that does not seem a real limitation).
4484 Repeated use of this option is not supported.
4485
4486 .cmdopt -q
4487 .cindex "queue runner" "starting manually"
4488 This option is normally restricted to admin users. However, there is a
4489 configuration option called &%prod_requires_admin%& which can be set false to
4490 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4491 and &%-S%& options).
4492
4493 .cindex "queue runner" "description of operation"
4494 If other commandline options do not specify an action,
4495 the &%-q%& option starts one queue runner process. This scans the queue of
4496 waiting messages, and runs a delivery process for each one in turn. It waits
4497 for each delivery process to finish before starting the next one. A delivery
4498 process may not actually do any deliveries if the retry times for the addresses
4499 have not been reached. Use &%-qf%& (see below) if you want to override this.
4500
4501 If
4502 .cindex "SMTP" "passed connection"
4503 .cindex "SMTP" "multiple deliveries"
4504 .cindex "multiple SMTP deliveries"
4505 the delivery process spawns other processes to deliver other messages down
4506 passed SMTP connections, the queue runner waits for these to finish before
4507 proceeding.
4508
4509 When all the queued messages have been considered, the original queue runner
4510 process terminates. In other words, a single pass is made over the waiting
4511 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4512 this to be repeated periodically.
4513
4514 Exim processes the waiting messages in an unpredictable order. It isn't very
4515 random, but it is likely to be different each time, which is all that matters.
4516 If one particular message screws up a remote MTA, other messages to the same
4517 MTA have a chance of getting through if they get tried first.
4518
4519 It is possible to cause the messages to be processed in lexical message id
4520 order, which is essentially the order in which they arrived, by setting the
4521 &%queue_run_in_order%& option, but this is not recommended for normal use.
4522
4523 .vitem &%-q%&<&'qflags'&>
4524 The &%-q%& option may be followed by one or more flag letters that change its
4525 behaviour. They are all optional, but if more than one is present, they must
4526 appear in the correct order. Each flag is described in a separate item below.
4527
4528 .vitem &%-qq...%&
4529 .oindex "&%-qq%&"
4530 .cindex "queue" "double scanning"
4531 .cindex "queue" "routing"
4532 .cindex "routing" "whole queue before delivery"
4533 .cindex "first pass routing"
4534 .cindex "queue runner" "two phase"
4535 An option starting with &%-qq%& requests a two-stage queue run. In the first
4536 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4537 every domain. Addresses are routed, local deliveries happen, but no remote
4538 transports are run.
4539
4540 Performance will be best if the &%queue_run_in_order%& option is false.
4541 If that is so and
4542 the &%queue_fast_ramp%& option is true
4543 and a daemon-notifier socket is available
4544 then in the first phase of the run,
4545 once a threshold number of messages are routed for a given host,
4546 a delivery process is forked in parallel with the rest of the scan.
4547
4548 .cindex "hints database" "remembering routing"
4549 The hints database that remembers which messages are waiting for specific hosts
4550 is updated, as if delivery to those hosts had been deferred.
4551
4552 After the first queue scan complete,
4553 a second, normal queue scan is done, with routing and delivery taking
4554 place as normal.
4555 Messages that are routed to the same host should mostly be
4556 delivered down a single SMTP
4557 .cindex "SMTP" "passed connection"
4558 .cindex "SMTP" "multiple deliveries"
4559 .cindex "multiple SMTP deliveries"
4560 connection because of the hints that were set up during the first queue scan.
4561
4562 Two-phase queue runs should be used on systems which, even intermittently,
4563 have a large queue (such as mailing-list operators).
4564 They may also be useful for hosts that are connected to the Internet
4565 intermittently.
4566
4567 .vitem &%-q[q]i...%&
4568 .oindex "&%-qi%&"
4569 .cindex "queue" "initial delivery"
4570 If the &'i'& flag is present, the queue runner runs delivery processes only for
4571 those messages that haven't previously been tried. (&'i'& stands for &"initial
4572 delivery"&.) This can be helpful if you are putting messages in the queue using
4573 &%-odq%& and want a queue runner just to process the new messages.
4574
4575 .vitem &%-q[q][i]f...%&
4576 .oindex "&%-qf%&"
4577 .cindex "queue" "forcing delivery"
4578 .cindex "delivery" "forcing in queue run"
4579 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4580 message, whereas without &'f'& only those non-frozen addresses that have passed
4581 their retry times are tried.
4582
4583 .vitem &%-q[q][i]ff...%&
4584 .oindex "&%-qff%&"
4585 .cindex "frozen messages" "forcing delivery"
4586 If &'ff'& is present, a delivery attempt is forced for every message, whether
4587 frozen or not.
4588
4589 .vitem &%-q[q][i][f[f]]l%&
4590 .oindex "&%-ql%&"
4591 .cindex "queue" "local deliveries only"
4592 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4593 be done. If a message requires any remote deliveries, it remains in the queue
4594 for later delivery.
4595
4596 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4597 .oindex "&%-qG%&"
4598 .cindex queue named
4599 .cindex "named queues"  "deliver from"
4600 .cindex "queue" "delivering specific messages"
4601 If the &'G'& flag and a name is present, the queue runner operates on the
4602 queue with the given name rather than the default queue.
4603 The name should not contain a &'/'& character.
4604 For a periodic queue run (see below)
4605 append to the name a slash and a time value.
4606
4607 If other commandline options specify an action, a &'-qG<name>'& option
4608 will specify a queue to operate on.
4609 For example:
4610 .code
4611 exim -bp -qGquarantine
4612 mailq -qGquarantine
4613 exim -qGoffpeak -Rf @special.domain.example
4614 .endd
4615
4616 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4617 When scanning the queue, Exim can be made to skip over messages whose ids are
4618 lexically less than a given value by following the &%-q%& option with a
4619 starting message id. For example:
4620 .code
4621 exim -q 0t5C6f-0000c8-00
4622 .endd
4623 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4624 second message id is given, messages whose ids are lexically greater than it
4625 are also skipped. If the same id is given twice, for example,
4626 .code
4627 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4628 .endd
4629 just one delivery process is started, for that message. This differs from
4630 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4631 that it counts as a delivery from a queue run. Note that the selection
4632 mechanism does not affect the order in which the messages are scanned. There
4633 are also other ways of selecting specific sets of messages for delivery in a
4634 queue run &-- see &%-R%& and &%-S%&.
4635
4636 .vitem &%-q%&<&'qflags'&><&'time'&>
4637 .cindex "queue runner" "starting periodically"
4638 .cindex "periodic queue running"
4639 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4640 starting a queue runner process at intervals specified by the given time value
4641 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4642 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4643 single daemon process handles both functions. A common way of starting up a
4644 combined daemon at system boot time is to use a command such as
4645 .code
4646 /usr/exim/bin/exim -bd -q30m
4647 .endd
4648 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4649 process every 30 minutes.
4650
4651 .cindex "named queues" "queue runners"
4652 It is possible to set up runners for multiple named queues within one daemon,
4653 For example:
4654 .code
4655 exim -qGhipri/2m -q10m -qqGmailinglist/1h
4656 .endd
4657
4658 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4659 pid file is written unless one is explicitly requested by the &%-oP%& option.
4660
4661 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4662 .oindex "&%-qR%&"
4663 This option is synonymous with &%-R%&. It is provided for Sendmail
4664 compatibility.
4665
4666 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4667 .oindex "&%-qS%&"
4668 This option is synonymous with &%-S%&.
4669
4670 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4671 .oindex "&%-R%&"
4672 .cindex "queue runner" "for specific recipients"
4673 .cindex "delivery" "to given domain"
4674 .cindex "domain" "delivery to"
4675 The <&'rsflags'&> may be empty, in which case the white space before the string
4676 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4677 which are the possible values for <&'rsflags'&>. White space is required if
4678 <&'rsflags'&> is not empty.
4679
4680 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4681 perform a single queue run, except that, when scanning the messages on the
4682 queue, Exim processes only those that have at least one undelivered recipient
4683 address containing the given string, which is checked in a case-independent
4684 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4685 regular expression; otherwise it is a literal string.
4686
4687 If you want to do periodic queue runs for messages with specific recipients,
4688 you can combine &%-R%& with &%-q%& and a time value. For example:
4689 .code
4690 exim -q25m -R @special.domain.example
4691 .endd
4692 This example does a queue run for messages with recipients in the given domain
4693 every 25 minutes. Any additional flags that are specified with &%-q%& are
4694 applied to each queue run.
4695
4696 Once a message is selected for delivery by this mechanism, all its addresses
4697 are processed. For the first selected message, Exim overrides any retry
4698 information and forces a delivery attempt for each undelivered address. This
4699 means that if delivery of any address in the first message is successful, any
4700 existing retry information is deleted, and so delivery attempts for that
4701 address in subsequently selected messages (which are processed without forcing)
4702 will run. However, if delivery of any address does not succeed, the retry
4703 information is updated, and in subsequently selected messages, the failing
4704 address will be skipped.
4705
4706 .cindex "frozen messages" "forcing delivery"
4707 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4708 all selected messages, not just the first; frozen messages are included when
4709 &'ff'& is present.
4710
4711 The &%-R%& option makes it straightforward to initiate delivery of all messages
4712 to a given domain after a host has been down for some time. When the SMTP
4713 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4714 effect is to run Exim with the &%-R%& option, but it can be configured to run
4715 an arbitrary command instead.
4716
4717 .cmdopt -r
4718 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4719
4720 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4721 .oindex "&%-S%&"
4722 .cindex "delivery" "from given sender"
4723 .cindex "queue runner" "for specific senders"
4724 This option acts like &%-R%& except that it checks the string against each
4725 message's sender instead of against the recipients. If &%-R%& is also set, both
4726 conditions must be met for a message to be selected. If either of the options
4727 has &'f'& or &'ff'& in its flags, the associated action is taken.
4728
4729 .cmdopt -Tqt <&'times'&>
4730 This is an option that is exclusively for use by the Exim testing suite. It is not
4731 recognized when Exim is run normally. It allows for the setting up of explicit
4732 &"queue times"& so that various warning/retry features can be tested.
4733
4734 .cmdopt -t
4735 .cindex "recipient" "extracting from header lines"
4736 .chindex Bcc:
4737 .chindex Cc:
4738 .chindex To:
4739 When Exim is receiving a locally-generated, non-SMTP message on its standard
4740 input, the &%-t%& option causes the recipients of the message to be obtained
4741 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4742 from the command arguments. The addresses are extracted before any rewriting
4743 takes place and the &'Bcc:'& header line, if present, is then removed.
4744
4745 .cindex "Sendmail compatibility" "&%-t%& option"
4746 If the command has any arguments, they specify addresses to which the message
4747 is &'not'& to be delivered. That is, the argument addresses are removed from
4748 the recipients list obtained from the headers. This is compatible with Smail 3
4749 and in accordance with the documented behaviour of several versions of
4750 Sendmail, as described in man pages on a number of operating systems (e.g.
4751 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4752 argument addresses to those obtained from the headers, and the O'Reilly
4753 Sendmail book documents it that way. Exim can be made to add argument addresses
4754 instead of subtracting them by setting the option
4755 &%extract_addresses_remove_arguments%& false.
4756
4757 .cindex "&%Resent-%& header lines" "with &%-t%&"
4758 If there are any &%Resent-%& header lines in the message, Exim extracts
4759 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4760 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4761 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4762 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4763
4764 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4765 message is resent several times). The RFC also specifies that they should be
4766 added at the front of the message, and separated by &'Received:'& lines. It is
4767 not at all clear how &%-t%& should operate in the present of multiple sets,
4768 nor indeed exactly what constitutes a &"set"&.
4769 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4770 are often added at the end of the header, and if a message is resent more than
4771 once, it is common for the original set of &%Resent-%& headers to be renamed as
4772 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4773
4774 .cmdopt -ti
4775 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4776 compatibility with Sendmail.
4777
4778 .cmdopt -tls-on-connect
4779 .cindex "TLS" "use without STARTTLS"
4780 .cindex "TLS" "automatic start"
4781 This option is available when Exim is compiled with TLS support. It forces all
4782 incoming SMTP connections to behave as if the incoming port is listed in the
4783 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4784 &<<CHAPTLS>>& for further details.
4785
4786
4787 .cmdopt -U
4788 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4789 Sendmail uses this option for &"initial message submission"&, and its
4790 documentation states that in future releases, it may complain about
4791 syntactically invalid messages rather than fixing them when this flag is not
4792 set. Exim ignores this option.
4793
4794 .cmdopt -v
4795 This option causes Exim to write information to the standard error stream,
4796 describing what it is doing. In particular, it shows the log lines for
4797 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4798 dialogue is shown. Some of the log lines shown may not actually be written to
4799 the log if the setting of &%log_selector%& discards them. Any relevant
4800 selectors are shown with each log line. If none are shown, the logging is
4801 unconditional.
4802
4803 .cmdopt -x
4804 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4805 National Language Support extended characters in the body of the mail item"&).
4806 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4807 this option.
4808
4809 .cmdopt -X <&'logfile'&>
4810 This option is interpreted by Sendmail to cause debug information to be sent
4811 to the named file.  It is ignored by Exim.
4812
4813 .cmdopt -z <&'log-line'&>
4814 This option writes its argument to Exim's logfile.
4815 Use is restricted to administrators; the intent is for operational notes.
4816 Quotes should be used to maintain a multi-word item as a single argument,
4817 under most shells.
4818 .endlist
4819
4820 .ecindex IIDclo1
4821 .ecindex IIDclo2
4822
4823
4824 . ////////////////////////////////////////////////////////////////////////////
4825 . Insert a stylized DocBook comment here, to identify the end of the command
4826 . line options. This is for the benefit of the Perl script that automatically
4827 . creates a man page for the options.
4828 . ////////////////////////////////////////////////////////////////////////////
4829
4830 .literal xml
4831 <!-- === End of command line options === -->
4832 .literal off
4833
4834
4835
4836
4837
4838 . ////////////////////////////////////////////////////////////////////////////
4839 . ////////////////////////////////////////////////////////////////////////////
4840
4841
4842 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4843          "The runtime configuration file"
4844
4845 .cindex "runtime configuration"
4846 .cindex "configuration file" "general description"
4847 .cindex "CONFIGURE_FILE"
4848 .cindex "configuration file" "errors in"
4849 .cindex "error" "in configuration file"
4850 .cindex "return code" "for bad configuration"
4851 Exim uses a single runtime configuration file that is read whenever an Exim
4852 binary is executed. Note that in normal operation, this happens frequently,
4853 because Exim is designed to operate in a distributed manner, without central
4854 control.
4855
4856 If a syntax error is detected while reading the configuration file, Exim
4857 writes a message on the standard error, and exits with a non-zero return code.
4858 The message is also written to the panic log. &*Note*&: Only simple syntax
4859 errors can be detected at this time. The values of any expanded options are
4860 not checked until the expansion happens, even when the expansion does not
4861 actually alter the string.
4862
4863 The name of the configuration file is compiled into the binary for security
4864 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4865 most configurations, this specifies a single file. However, it is permitted to
4866 give a colon-separated list of filenames, in which case Exim uses the first
4867 existing file in the list.
4868
4869 .cindex "EXIM_USER"
4870 .cindex "EXIM_GROUP"
4871 .cindex "CONFIGURE_OWNER"
4872 .cindex "CONFIGURE_GROUP"
4873 .cindex "configuration file" "ownership"
4874 .cindex "ownership" "configuration file"
4875 The runtime configuration file must be owned by root or by the user that is
4876 specified at compile time by the CONFIGURE_OWNER option (if set). The
4877 configuration file must not be world-writeable, or group-writeable unless its
4878 group is the root group or the one specified at compile time by the
4879 CONFIGURE_GROUP option.
4880
4881 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4882 to root, anybody who is able to edit the runtime configuration file has an
4883 easy way to run commands as root. If you specify a user or group in the
4884 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4885 who are members of that group will trivially be able to obtain root privileges.
4886
4887 Up to Exim version 4.72, the runtime configuration file was also permitted to
4888 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4889 since it offered a simple privilege escalation for any attacker who managed to
4890 compromise the Exim user account.
4891
4892 A default configuration file, which will work correctly in simple situations,
4893 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4894 defines just one filename, the installation process copies the default
4895 configuration to a new file of that name if it did not previously exist. If
4896 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4897 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4898 configuration.
4899
4900
4901
4902 .section "Using a different configuration file" "SECID40"
4903 .cindex "configuration file" "alternate"
4904 A one-off alternate configuration can be specified by the &%-C%& command line
4905 option, which may specify a single file or a list of files. However, when
4906 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4907 unless the argument for &%-C%& is identical to the built-in value from
4908 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4909 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4910 is useful mainly for checking the syntax of configuration files before
4911 installing them. No owner or group checks are done on a configuration file
4912 specified by &%-C%&, if root privilege has been dropped.
4913
4914 Even the Exim user is not trusted to specify an arbitrary configuration file
4915 with the &%-C%& option to be used with root privileges, unless that file is
4916 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4917 testing a configuration using &%-C%& right through message reception and
4918 delivery, even if the caller is root. The reception works, but by that time,
4919 Exim is running as the Exim user, so when it re-execs to regain privilege for
4920 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4921 can test reception and delivery using two separate commands (one to put a
4922 message in the queue, using &%-odq%&, and another to do the delivery, using
4923 &%-M%&).
4924
4925 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4926 prefix string with which any file named in a &%-C%& command line option must
4927 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4928 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4929 filename can be used with &%-C%&.
4930
4931 One-off changes to a configuration can be specified by the &%-D%& command line
4932 option, which defines and overrides values for macros used inside the
4933 configuration file. However, like &%-C%&, the use of this option by a
4934 non-privileged user causes Exim to discard its root privilege.
4935 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4936 completely disabled, and its use causes an immediate error exit.
4937
4938 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4939 to declare certain macro names trusted, such that root privilege will not
4940 necessarily be discarded.
4941 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4942 considered safe and, if &%-D%& only supplies macros from this list, and the
4943 values are acceptable, then Exim will not give up root privilege if the caller
4944 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4945 transition mechanism and is expected to be removed in the future.  Acceptable
4946 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4947
4948 Some sites may wish to use the same Exim binary on different machines that
4949 share a file system, but to use different configuration files on each machine.
4950 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4951 looks for a file whose name is the configuration filename followed by a dot
4952 and the machine's node name, as obtained from the &[uname()]& function. If this
4953 file does not exist, the standard name is tried. This processing occurs for
4954 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4955
4956 In some esoteric situations different versions of Exim may be run under
4957 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4958 help with this. See the comments in &_src/EDITME_& for details.
4959
4960
4961
4962 .section "Configuration file format" "SECTconffilfor"
4963 .cindex "configuration file" "format of"
4964 .cindex "format" "configuration file"
4965 Exim's configuration file is divided into a number of different parts. General
4966 option settings must always appear at the start of the file. The other parts
4967 are all optional, and may appear in any order. Each part other than the first
4968 is introduced by the word &"begin"& followed by at least one literal
4969 space, and the name of the part. The optional parts are:
4970
4971 .ilist
4972 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4973 &<<CHAPACL>>&).
4974 .next
4975 .cindex "AUTH" "configuration"
4976 &'authenticators'&: Configuration settings for the authenticator drivers. These
4977 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4978 .next
4979 &'routers'&: Configuration settings for the router drivers. Routers process
4980 addresses and determine how the message is to be delivered (see chapters
4981 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4982 .next
4983 &'transports'&: Configuration settings for the transport drivers. Transports
4984 define mechanisms for copying messages to destinations (see chapters
4985 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4986 .next
4987 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4988 If there is no retry section, or if it is empty (that is, no retry rules are
4989 defined), Exim will not retry deliveries. In this situation, temporary errors
4990 are treated the same as permanent errors. Retry rules are discussed in chapter
4991 &<<CHAPretry>>&.
4992 .next
4993 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4994 when new addresses are generated during delivery. Rewriting is discussed in
4995 chapter &<<CHAPrewrite>>&.
4996 .next
4997 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4998 want to use this feature, you must set
4999 .code
5000 LOCAL_SCAN_HAS_OPTIONS=yes
5001 .endd
5002 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5003 facility are given in chapter &<<CHAPlocalscan>>&.
5004 .endlist
5005
5006 .cindex "configuration file" "leading white space in"
5007 .cindex "configuration file" "trailing white space in"
5008 .cindex "white space" "in configuration file"
5009 Leading and trailing white space in configuration lines is always ignored.
5010
5011 Blank lines in the file, and lines starting with a # character (ignoring
5012 leading white space) are treated as comments and are ignored. &*Note*&: A
5013 # character other than at the beginning of a line is not treated specially,
5014 and does not introduce a comment.
5015
5016 Any non-comment line can be continued by ending it with a backslash. Note that
5017 the general rule for white space means that trailing white space after the
5018 backslash and leading white space at the start of continuation
5019 lines is ignored. Comment lines beginning with # (but not empty lines) may
5020 appear in the middle of a sequence of continuation lines.
5021
5022 A convenient way to create a configuration file is to start from the
5023 default, which is supplied in &_src/configure.default_&, and add, delete, or
5024 change settings as required.
5025
5026 The ACLs, retry rules, and rewriting rules have their own syntax which is
5027 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5028 respectively. The other parts of the configuration file have some syntactic
5029 items in common, and these are described below, from section &<<SECTcos>>&
5030 onwards. Before that, the inclusion, macro, and conditional facilities are
5031 described.
5032
5033
5034
5035 .section "File inclusions in the configuration file" "SECID41"
5036 .cindex "inclusions in configuration file"
5037 .cindex "configuration file" "including other files"
5038 .cindex "&`.include`& in configuration file"
5039 .cindex "&`.include_if_exists`& in configuration file"
5040 You can include other files inside Exim's runtime configuration file by
5041 using this syntax:
5042 .display
5043 &`.include`& <&'filename'&>
5044 &`.include_if_exists`& <&'filename'&>
5045 .endd
5046 on a line by itself. Double quotes round the filename are optional. If you use
5047 the first form, a configuration error occurs if the file does not exist; the
5048 second form does nothing for non-existent files.
5049 The first form allows a relative name. It is resolved relative to
5050 the directory of the including file. For the second form an absolute filename
5051 is required.
5052
5053 Includes may be nested to any depth, but remember that Exim reads its
5054 configuration file often, so it is a good idea to keep them to a minimum.
5055 If you change the contents of an included file, you must HUP the daemon,
5056 because an included file is read only when the configuration itself is read.
5057
5058 The processing of inclusions happens early, at a physical line level, so, like
5059 comment lines, an inclusion can be used in the middle of an option setting,
5060 for example:
5061 .code
5062 hosts_lookup = a.b.c \
5063                .include /some/file
5064 .endd
5065 Include processing happens after macro processing (see below). Its effect is to
5066 process the lines of the included file as if they occurred inline where the
5067 inclusion appears.
5068
5069
5070
5071 .section "Macros in the configuration file" "SECTmacrodefs"
5072 .cindex "macro" "description of"
5073 .cindex "configuration file" "macros"
5074 If a line in the main part of the configuration (that is, before the first
5075 &"begin"& line) begins with an upper case letter, it is taken as a macro
5076 definition, and must be of the form
5077 .display
5078 <&'name'&> = <&'rest of line'&>
5079 .endd
5080 The name must consist of letters, digits, and underscores, and need not all be
5081 in upper case, though that is recommended. The rest of the line, including any
5082 continuations, is the replacement text, and has leading and trailing white
5083 space removed. Quotes are not removed. The replacement text can never end with
5084 a backslash character, but this doesn't seem to be a serious limitation.
5085
5086 Macros may also be defined between router, transport, authenticator, or ACL
5087 definitions. They may not, however, be defined within an individual driver or
5088 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5089
5090 .section "Macro substitution" "SECID42"
5091 Once a macro is defined, all subsequent lines in the file (and any included
5092 files) are scanned for the macro name; if there are several macros, the line is
5093 scanned for each, in turn, in the order in which the macros are defined. The
5094 replacement text is not re-scanned for the current macro, though it is scanned
5095 for subsequently defined macros. For this reason, a macro name may not contain
5096 the name of a previously defined macro as a substring. You could, for example,
5097 define
5098 .display
5099 &`ABCD_XYZ = `&<&'something'&>
5100 &`ABCD = `&<&'something else'&>
5101 .endd
5102 but putting the definitions in the opposite order would provoke a configuration
5103 error. Macro expansion is applied to individual physical lines from the file,
5104 before checking for line continuation or file inclusion (see above). If a line
5105 consists solely of a macro name, and the expansion of the macro is empty, the
5106 line is ignored. A macro at the start of a line may turn the line into a
5107 comment line or a &`.include`& line.
5108
5109
5110 .section "Redefining macros" "SECID43"
5111 Once defined, the value of a macro can be redefined later in the configuration
5112 (or in an included file). Redefinition is specified by using &'=='& instead of
5113 &'='&. For example:
5114 .code
5115 MAC =  initial value
5116 ...
5117 MAC == updated value
5118 .endd
5119 Redefinition does not alter the order in which the macros are applied to the
5120 subsequent lines of the configuration file. It is still the same order in which
5121 the macros were originally defined. All that changes is the macro's value.
5122 Redefinition makes it possible to accumulate values. For example:
5123 .code
5124 MAC =  initial value
5125 ...
5126 MAC == MAC and something added
5127 .endd
5128 This can be helpful in situations where the configuration file is built
5129 from a number of other files.
5130
5131 .section "Overriding macro values" "SECID44"
5132 The values set for macros in the configuration file can be overridden by the
5133 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5134 used, unless called by root or the Exim user. A definition on the command line
5135 using the &%-D%& option causes all definitions and redefinitions within the
5136 file to be ignored.
5137
5138
5139
5140 .section "Example of macro usage" "SECID45"
5141 As an example of macro usage, consider a configuration where aliases are looked
5142 up in a MySQL database. It helps to keep the file less cluttered if long
5143 strings such as SQL statements are defined separately as macros, for example:
5144 .code
5145 ALIAS_QUERY = select mailbox from user where \
5146               login='${quote_mysql:$local_part}';
5147 .endd
5148 This can then be used in a &(redirect)& router setting like this:
5149 .code
5150 data = ${lookup mysql{ALIAS_QUERY}}
5151 .endd
5152 In earlier versions of Exim macros were sometimes used for domain, host, or
5153 address lists. In Exim 4 these are handled better by named lists &-- see
5154 section &<<SECTnamedlists>>&.
5155
5156
5157 .section "Builtin macros" "SECTbuiltinmacros"
5158 Exim defines some macros depending on facilities available, which may
5159 differ due to build-time definitions and from one release to another.
5160 All of these macros start with an underscore.
5161 They can be used to conditionally include parts of a configuration
5162 (see below).
5163
5164 The following classes of macros are defined:
5165 .display
5166 &` _HAVE_*                    `&  build-time defines
5167 &` _DRIVER_ROUTER_*           `&  router drivers
5168 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5169 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5170 &` _EXP_COND_*                `&  expansion conditions
5171 &` _EXP_ITEM_*                `&  expansion items
5172 &` _EXP_OP_*                  `&  expansion operators
5173 &` _EXP_VAR_*                 `&  expansion variables
5174 &` _LOG_*                     `&  log_selector values
5175 &` _OPT_MAIN_*                `&  main config options
5176 &` _OPT_ROUTERS_*             `&  generic router options
5177 &` _OPT_TRANSPORTS_*          `&  generic transport options
5178 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5179 &` _OPT_ROUTER_*_*            `&  private router options
5180 &` _OPT_TRANSPORT_*_*         `&  private transport options
5181 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5182 .endd
5183
5184 Use an &"exim -bP macros"& command to get the list of macros.
5185
5186
5187 .section "Conditional skips in the configuration file" "SECID46"
5188 .cindex "configuration file" "conditional skips"
5189 .cindex "&`.ifdef`&"
5190 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5191 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5192 portions of the configuration file. The processing happens whenever the file is
5193 read (that is, when an Exim binary starts to run).
5194
5195 The implementation is very simple. Instances of the first four directives must
5196 be followed by text that includes the names of one or macros. The condition
5197 that is tested is whether or not any macro substitution has taken place in the
5198 line. Thus:
5199 .code
5200 .ifdef AAA
5201 message_size_limit = 50M
5202 .else
5203 message_size_limit = 100M
5204 .endif
5205 .endd
5206 sets a message size limit of 50M if the macro &`AAA`& is defined
5207 (or &`A`& or &`AA`&), and 100M
5208 otherwise. If there is more than one macro named on the line, the condition
5209 is true if any of them are defined. That is, it is an &"or"& condition. To
5210 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5211
5212 Although you can use a macro expansion to generate one of these directives,
5213 it is not very useful, because the condition &"there was a macro substitution
5214 in this line"& will always be true.
5215
5216 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5217 to clarify complicated nestings.
5218
5219
5220
5221 .section "Common option syntax" "SECTcos"
5222 .cindex "common option syntax"
5223 .cindex "syntax of common options"
5224 .cindex "configuration file" "common option syntax"
5225 For the main set of options, driver options, and &[local_scan()]& options,
5226 each setting is on a line by itself, and starts with a name consisting of
5227 lower-case letters and underscores. Many options require a data value, and in
5228 these cases the name must be followed by an equals sign (with optional white
5229 space) and then the value. For example:
5230 .code
5231 qualify_domain = mydomain.example.com
5232 .endd
5233 .cindex "hiding configuration option values"
5234 .cindex "configuration options" "hiding value of"
5235 .cindex "options" "hiding value of"
5236 Some option settings may contain sensitive data, for example, passwords for
5237 accessing databases. To stop non-admin users from using the &%-bP%& command
5238 line option to read these values, you can precede the option settings with the
5239 word &"hide"&. For example:
5240 .code
5241 hide mysql_servers = localhost/users/admin/secret-password
5242 .endd
5243 For non-admin users, such options are displayed like this:
5244 .code
5245 mysql_servers = <value not displayable>
5246 .endd
5247 If &"hide"& is used on a driver option, it hides the value of that option on
5248 all instances of the same driver.
5249
5250 The following sections describe the syntax used for the different data types
5251 that are found in option settings.
5252
5253
5254 .section "Boolean options" "SECID47"
5255 .cindex "format" "boolean"
5256 .cindex "boolean configuration values"
5257 .oindex "&%no_%&&'xxx'&"
5258 .oindex "&%not_%&&'xxx'&"
5259 Options whose type is given as boolean are on/off switches. There are two
5260 different ways of specifying such options: with and without a data value. If
5261 the option name is specified on its own without data, the switch is turned on;
5262 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5263 boolean options may be followed by an equals sign and one of the words
5264 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5265 the following two settings have exactly the same effect:
5266 .code
5267 queue_only
5268 queue_only = true
5269 .endd
5270 The following two lines also have the same (opposite) effect:
5271 .code
5272 no_queue_only
5273 queue_only = false
5274 .endd
5275 You can use whichever syntax you prefer.
5276
5277
5278
5279
5280 .section "Integer values" "SECID48"
5281 .cindex "integer configuration values"
5282 .cindex "format" "integer"
5283 If an option's type is given as &"integer"&, the value can be given in decimal,
5284 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5285 number is assumed. Otherwise, it is treated as an octal number unless it starts
5286 with the characters &"0x"&, in which case the remainder is interpreted as a
5287 hexadecimal number.
5288
5289 If an integer value is followed by the letter K, it is multiplied by 1024; if
5290 it is followed by the letter M, it is multiplied by 1024x1024;
5291 if by the letter G, 1024x1024x1024.
5292 When the values
5293 of integer option settings are output, values which are an exact multiple of
5294 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5295 and M. The printing style is independent of the actual input format that was
5296 used.
5297
5298
5299 .section "Octal integer values" "SECID49"
5300 .cindex "integer format"
5301 .cindex "format" "octal integer"
5302 If an option's type is given as &"octal integer"&, its value is always
5303 interpreted as an octal number, whether or not it starts with the digit zero.
5304 Such options are always output in octal.
5305
5306
5307 .section "Fixed point numbers" "SECID50"
5308 .cindex "fixed point configuration values"
5309 .cindex "format" "fixed point"
5310 If an option's type is given as &"fixed-point"&, its value must be a decimal
5311 integer, optionally followed by a decimal point and up to three further digits.
5312
5313
5314
5315 .section "Time intervals" "SECTtimeformat"
5316 .cindex "time interval" "specifying in configuration"
5317 .cindex "format" "time interval"
5318 A time interval is specified as a sequence of numbers, each followed by one of
5319 the following letters, with no intervening white space:
5320
5321 .table2 30pt
5322 .irow &%s%& seconds
5323 .irow &%m%& minutes
5324 .irow &%h%& hours
5325 .irow &%d%& days
5326 .irow &%w%& weeks
5327 .endtable
5328
5329 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5330 intervals are output in the same format. Exim does not restrict the values; it
5331 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5332
5333
5334
5335 .section "String values" "SECTstrings"
5336 .cindex "string" "format of configuration values"
5337 .cindex "format" "string"
5338 If an option's type is specified as &"string"&, the value can be specified with
5339 or without double-quotes. If it does not start with a double-quote, the value
5340 consists of the remainder of the line plus any continuation lines, starting at
5341 the first character after any leading white space, with trailing white space
5342 removed, and with no interpretation of the characters in the string. Because
5343 Exim removes comment lines (those beginning with #) at an early stage, they can
5344 appear in the middle of a multi-line string. The following two settings are
5345 therefore equivalent:
5346 .code
5347 trusted_users = uucp:mail
5348 trusted_users = uucp:\
5349                 # This comment line is ignored
5350                 mail
5351 .endd
5352 .cindex "string" "quoted"
5353 .cindex "escape characters in quoted strings"
5354 If a string does start with a double-quote, it must end with a closing
5355 double-quote, and any backslash characters other than those used for line
5356 continuation are interpreted as escape characters, as follows:
5357
5358 .table2 100pt
5359 .irow &`\\`&                     "single backslash"
5360 .irow &`\n`&                     "newline"
5361 .irow &`\r`&                     "carriage return"
5362 .irow &`\t`&                     "tab"
5363 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5364 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5365                                    character"
5366 .endtable
5367
5368 If a backslash is followed by some other character, including a double-quote
5369 character, that character replaces the pair.
5370
5371 Quoting is necessary only if you want to make use of the backslash escapes to
5372 insert special characters, or if you need to specify a value with leading or
5373 trailing spaces. These cases are rare, so quoting is almost never needed in
5374 current versions of Exim. In versions of Exim before 3.14, quoting was required
5375 in order to continue lines, so you may come across older configuration files
5376 and examples that apparently quote unnecessarily.
5377
5378
5379 .section "Expanded strings" "SECID51"
5380 .cindex "expansion" "definition of"
5381 Some strings in the configuration file are subjected to &'string expansion'&,
5382 by which means various parts of the string may be changed according to the
5383 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5384 is as just described; in particular, the handling of backslashes in quoted
5385 strings is done as part of the input process, before expansion takes place.
5386 However, backslash is also an escape character for the expander, so any
5387 backslashes that are required for that reason must be doubled if they are
5388 within a quoted configuration string.
5389
5390
5391 .section "User and group names" "SECID52"
5392 .cindex "user name" "format of"
5393 .cindex "format" "user name"
5394 .cindex "groups" "name format"
5395 .cindex "format" "group name"
5396 User and group names are specified as strings, using the syntax described
5397 above, but the strings are interpreted specially. A user or group name must
5398 either consist entirely of digits, or be a name that can be looked up using the
5399 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5400
5401
5402 .section "List construction" "SECTlistconstruct"
5403 .cindex "list" "syntax of in configuration"
5404 .cindex "format" "list item in configuration"
5405 .cindex "string" "list, definition of"
5406 The data for some configuration options is a list of items, with colon as the
5407 default separator. Many of these options are shown with type &"string list"& in
5408 the descriptions later in this document. Others are listed as &"domain list"&,
5409 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5410 are all the same; however, those other than &"string list"& are subject to
5411 particular kinds of interpretation, as described in chapter
5412 &<<CHAPdomhosaddlists>>&.
5413
5414 In all these cases, the entire list is treated as a single string as far as the
5415 input syntax is concerned. The &%trusted_users%& setting in section
5416 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5417 in a list, it must be entered as two colons. Leading and trailing white space
5418 on each item in a list is ignored. This makes it possible to include items that
5419 start with a colon, and in particular, certain forms of IPv6 address. For
5420 example, the list
5421 .code
5422 local_interfaces = 127.0.0.1 : ::::1
5423 .endd
5424 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5425
5426 &*Note*&: Although leading and trailing white space is ignored in individual
5427 list items, it is not ignored when parsing the list. The spaces around the first
5428 colon in the example above are necessary. If they were not there, the list would
5429 be interpreted as the two items 127.0.0.1:: and 1.
5430
5431 .section "Changing list separators" "SECTlistsepchange"
5432 .cindex "list separator" "changing"
5433 .cindex "IPv6" "addresses in lists"
5434 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5435 introduced to allow the separator character to be changed. If a list begins
5436 with a left angle bracket, followed by any punctuation character, that
5437 character is used instead of colon as the list separator. For example, the list
5438 above can be rewritten to use a semicolon separator like this:
5439 .code
5440 local_interfaces = <; 127.0.0.1 ; ::1
5441 .endd
5442 This facility applies to all lists, with the exception of the list in
5443 &%log_file_path%&. It is recommended that the use of non-colon separators be
5444 confined to circumstances where they really are needed.
5445
5446 .cindex "list separator" "newline as"
5447 .cindex "newline" "as list separator"
5448 It is also possible to use newline and other control characters (those with
5449 code values less than 32, plus DEL) as separators in lists. Such separators
5450 must be provided literally at the time the list is processed. For options that
5451 are string-expanded, you can write the separator using a normal escape
5452 sequence. This will be processed by the expander before the string is
5453 interpreted as a list. For example, if a newline-separated list of domains is
5454 generated by a lookup, you can process it directly by a line such as this:
5455 .code
5456 domains = <\n ${lookup mysql{.....}}
5457 .endd
5458 This avoids having to change the list separator in such data. You are unlikely
5459 to want to use a control character as a separator in an option that is not
5460 expanded, because the value is literal text. However, it can be done by giving
5461 the value in quotes. For example:
5462 .code
5463 local_interfaces = "<\n 127.0.0.1 \n ::1"
5464 .endd
5465 Unlike printing character separators, which can be included in list items by
5466 doubling, it is not possible to include a control character as data when it is
5467 set as the separator. Two such characters in succession are interpreted as
5468 enclosing an empty list item.
5469
5470
5471
5472 .section "Empty items in lists" "SECTempitelis"
5473 .cindex "list" "empty item in"
5474 An empty item at the end of a list is always ignored. In other words, trailing
5475 separator characters are ignored. Thus, the list in
5476 .code
5477 senders = user@domain :
5478 .endd
5479 contains only a single item. If you want to include an empty string as one item
5480 in a list, it must not be the last item. For example, this list contains three
5481 items, the second of which is empty:
5482 .code
5483 senders = user1@domain : : user2@domain
5484 .endd
5485 &*Note*&: There must be white space between the two colons, as otherwise they
5486 are interpreted as representing a single colon data character (and the list
5487 would then contain just one item). If you want to specify a list that contains
5488 just one, empty item, you can do it as in this example:
5489 .code
5490 senders = :
5491 .endd
5492 In this case, the first item is empty, and the second is discarded because it
5493 is at the end of the list.
5494
5495
5496
5497
5498 .section "Format of driver configurations" "SECTfordricon"
5499 .cindex "drivers" "configuration format"
5500 There are separate parts in the configuration for defining routers, transports,
5501 and authenticators. In each part, you are defining a number of driver
5502 instances, each with its own set of options. Each driver instance is defined by
5503 a sequence of lines like this:
5504 .display
5505 <&'instance name'&>:
5506   <&'option'&>
5507   ...
5508   <&'option'&>
5509 .endd
5510 In the following example, the instance name is &(localuser)&, and it is
5511 followed by three options settings:
5512 .code
5513 localuser:
5514   driver = accept
5515   check_local_user
5516   transport = local_delivery
5517 .endd
5518 For each driver instance, you specify which Exim code module it uses &-- by the
5519 setting of the &%driver%& option &-- and (optionally) some configuration
5520 settings. For example, in the case of transports, if you want a transport to
5521 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5522 a local file you would use the &(appendfile)& driver. Each of the drivers is
5523 described in detail in its own separate chapter later in this manual.
5524
5525 You can have several routers, transports, or authenticators that are based on
5526 the same underlying driver (each must have a different instance name).
5527
5528 The order in which routers are defined is important, because addresses are
5529 passed to individual routers one by one, in order. The order in which
5530 transports are defined does not matter at all. The order in which
5531 authenticators are defined is used only when Exim, as a client, is searching
5532 them to find one that matches an authentication mechanism offered by the
5533 server.
5534
5535 .cindex "generic options"
5536 .cindex "options" "generic &-- definition of"
5537 Within a driver instance definition, there are two kinds of option: &'generic'&
5538 and &'private'&. The generic options are those that apply to all drivers of the
5539 same type (that is, all routers, all transports or all authenticators). The
5540 &%driver%& option is a generic option that must appear in every definition.
5541 .cindex "private options"
5542 The private options are special for each driver, and none need appear, because
5543 they all have default values.
5544
5545 The options may appear in any order, except that the &%driver%& option must
5546 precede any private options, since these depend on the particular driver. For
5547 this reason, it is recommended that &%driver%& always be the first option.
5548
5549 Driver instance names, which are used for reference in log entries and
5550 elsewhere, can be any sequence of letters, digits, and underscores (starting
5551 with a letter) and must be unique among drivers of the same type. A router and
5552 a transport (for example) can each have the same name, but no two router
5553 instances can have the same name. The name of a driver instance should not be
5554 confused with the name of the underlying driver module. For example, the
5555 configuration lines:
5556 .code
5557 remote_smtp:
5558   driver = smtp
5559 .endd
5560 create an instance of the &(smtp)& transport driver whose name is
5561 &(remote_smtp)&. The same driver code can be used more than once, with
5562 different instance names and different option settings each time. A second
5563 instance of the &(smtp)& transport, with different options, might be defined
5564 thus:
5565 .code
5566 special_smtp:
5567   driver = smtp
5568   port = 1234
5569   command_timeout = 10s
5570 .endd
5571 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5572 these transport instances from routers, and these names would appear in log
5573 lines.
5574
5575 Comment lines may be present in the middle of driver specifications. The full
5576 list of option settings for any particular driver instance, including all the
5577 defaulted values, can be extracted by making use of the &%-bP%& command line
5578 option.
5579
5580
5581
5582
5583
5584
5585 . ////////////////////////////////////////////////////////////////////////////
5586 . ////////////////////////////////////////////////////////////////////////////
5587
5588 .chapter "The default configuration file" "CHAPdefconfil"
5589 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5590 .cindex "default" "configuration file &""walk through""&"
5591 The default configuration file supplied with Exim as &_src/configure.default_&
5592 is sufficient for a host with simple mail requirements. As an introduction to
5593 the way Exim is configured, this chapter &"walks through"& the default
5594 configuration, giving brief explanations of the settings. Detailed descriptions
5595 of the options are given in subsequent chapters. The default configuration file
5596 itself contains extensive comments about ways you might want to modify the
5597 initial settings. However, note that there are many options that are not
5598 mentioned at all in the default configuration.
5599
5600
5601
5602 .section "Macros" "SECTdefconfmacros"
5603 All macros should be defined before any options.
5604
5605 One macro is specified, but commented out, in the default configuration:
5606 .code
5607 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5608 .endd
5609 If all off-site mail is expected to be delivered to a "smarthost", then set the
5610 hostname here and uncomment the macro.  This will affect which router is used
5611 later on.  If this is left commented out, then Exim will perform direct-to-MX
5612 deliveries using a &(dnslookup)& router.
5613
5614 In addition to macros defined here, Exim includes a number of built-in macros
5615 to enable configuration to be guarded by a binary built with support for a
5616 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5617
5618
5619 .section "Main configuration settings" "SECTdefconfmain"
5620 The main (global) configuration option settings section must always come first
5621 in the file, after the macros.
5622 The first thing you'll see in the file, after some initial comments, is the line
5623 .code
5624 # primary_hostname =
5625 .endd
5626 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5627 to know the official, fully qualified name of your host, and this is where you
5628 can specify it. However, in most cases you do not need to set this option. When
5629 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5630
5631 The first three non-comment configuration lines are as follows:
5632 .code
5633 domainlist local_domains    = @
5634 domainlist relay_to_domains =
5635 hostlist   relay_from_hosts = 127.0.0.1
5636 .endd
5637 These are not, in fact, option settings. They are definitions of two named
5638 domain lists and one named host list. Exim allows you to give names to lists of
5639 domains, hosts, and email addresses, in order to make it easier to manage the
5640 configuration file (see section &<<SECTnamedlists>>&).
5641
5642 The first line defines a domain list called &'local_domains'&; this is used
5643 later in the configuration to identify domains that are to be delivered
5644 on the local host.
5645
5646 .cindex "@ in a domain list"
5647 There is just one item in this list, the string &"@"&. This is a special form
5648 of entry which means &"the name of the local host"&. Thus, if the local host is
5649 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5650 be delivered locally. Because the local host's name is referenced indirectly,
5651 the same configuration file can be used on different hosts.
5652
5653 The second line defines a domain list called &'relay_to_domains'&, but the
5654 list itself is empty. Later in the configuration we will come to the part that
5655 controls mail relaying through the local host; it allows relaying to any
5656 domains in this list. By default, therefore, no relaying on the basis of a mail
5657 domain is permitted.
5658
5659 The third line defines a host list called &'relay_from_hosts'&. This list is
5660 used later in the configuration to permit relaying from any host or IP address
5661 that matches the list. The default contains just the IP address of the IPv4
5662 loopback interface, which means that processes on the local host are able to
5663 submit mail for relaying by sending it over TCP/IP to that interface. No other
5664 hosts are permitted to submit messages for relaying.
5665
5666 Just to be sure there's no misunderstanding: at this point in the configuration
5667 we aren't actually setting up any controls. We are just defining some domains
5668 and hosts that will be used in the controls that are specified later.
5669
5670 The next two configuration lines are genuine option settings:
5671 .code
5672 acl_smtp_rcpt = acl_check_rcpt
5673 acl_smtp_data = acl_check_data
5674 .endd
5675 These options specify &'Access Control Lists'& (ACLs) that are to be used
5676 during an incoming SMTP session for every recipient of a message (every RCPT
5677 command), and after the contents of the message have been received,
5678 respectively. The names of the lists are &'acl_check_rcpt'& and
5679 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5680 section of the configuration. The RCPT ACL controls which recipients are
5681 accepted for an incoming message &-- if a configuration does not provide an ACL
5682 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5683 contents of a message to be checked.
5684
5685 Two commented-out option settings are next:
5686 .code
5687 # av_scanner = clamd:/tmp/clamd
5688 # spamd_address = 127.0.0.1 783
5689 .endd
5690 These are example settings that can be used when Exim is compiled with the
5691 content-scanning extension. The first specifies the interface to the virus
5692 scanner, and the second specifies the interface to SpamAssassin. Further
5693 details are given in chapter &<<CHAPexiscan>>&.
5694
5695 Three more commented-out option settings follow:
5696 .code
5697 # tls_advertise_hosts = *
5698 # tls_certificate = /etc/ssl/exim.crt
5699 # tls_privatekey = /etc/ssl/exim.pem
5700 .endd
5701 These are example settings that can be used when Exim is compiled with
5702 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5703 first one specifies the list of clients that are allowed to use TLS when
5704 connecting to this server; in this case, the wildcard means all clients. The
5705 other options specify where Exim should find its TLS certificate and private
5706 key, which together prove the server's identity to any clients that connect.
5707 More details are given in chapter &<<CHAPTLS>>&.
5708
5709 Another two commented-out option settings follow:
5710 .code
5711 # daemon_smtp_ports = 25 : 465 : 587
5712 # tls_on_connect_ports = 465
5713 .endd
5714 .cindex "port" "465 and 587"
5715 .cindex "port" "for message submission"
5716 .cindex "message" "submission, ports for"
5717 .cindex "submissions protocol"
5718 .cindex "smtps protocol"
5719 .cindex "ssmtp protocol"
5720 .cindex "SMTP" "submissions protocol"
5721 .cindex "SMTP" "ssmtp protocol"
5722 .cindex "SMTP" "smtps protocol"
5723 These options provide better support for roaming users who wish to use this
5724 server for message submission. They are not much use unless you have turned on
5725 TLS (as described in the previous paragraph) and authentication (about which
5726 more in section &<<SECTdefconfauth>>&).
5727 Mail submission from mail clients (MUAs) should be separate from inbound mail
5728 to your domain (MX delivery) for various good reasons (eg, ability to impose
5729 much saner TLS protocol and ciphersuite requirements without unintended
5730 consequences).
5731 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5732 which uses STARTTLS, so this is the &"submission"& port.
5733 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5734 which should be used in preference to 587.
5735 You should also consider deploying SRV records to help clients find
5736 these ports.
5737 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5738
5739 Two more commented-out options settings follow:
5740 .code
5741 # qualify_domain =
5742 # qualify_recipient =
5743 .endd
5744 The first of these specifies a domain that Exim uses when it constructs a
5745 complete email address from a local login name. This is often needed when Exim
5746 receives a message from a local process. If you do not set &%qualify_domain%&,
5747 the value of &%primary_hostname%& is used. If you set both of these options,
5748 you can have different qualification domains for sender and recipient
5749 addresses. If you set only the first one, its value is used in both cases.
5750
5751 .cindex "domain literal" "recognizing format"
5752 The following line must be uncommented if you want Exim to recognize
5753 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5754 (an IP address within square brackets) instead of a named domain.
5755 .code
5756 # allow_domain_literals
5757 .endd
5758 The RFCs still require this form, but many people think that in the modern
5759 Internet it makes little sense to permit mail to be sent to specific hosts by
5760 quoting their IP addresses. This ancient format has been used by people who
5761 try to abuse hosts by using them for unwanted relaying. However, some
5762 people believe there are circumstances (for example, messages addressed to
5763 &'postmaster'&) where domain literals are still useful.
5764
5765 The next configuration line is a kind of trigger guard:
5766 .code
5767 never_users = root
5768 .endd
5769 It specifies that no delivery must ever be run as the root user. The normal
5770 convention is to set up &'root'& as an alias for the system administrator. This
5771 setting is a guard against slips in the configuration.
5772 The list of users specified by &%never_users%& is not, however, the complete
5773 list; the build-time configuration in &_Local/Makefile_& has an option called
5774 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5775 contents of &%never_users%& are added to this list. By default
5776 FIXED_NEVER_USERS also specifies root.
5777
5778 When a remote host connects to Exim in order to send mail, the only information
5779 Exim has about the host's identity is its IP address. The next configuration
5780 line,
5781 .code
5782 host_lookup = *
5783 .endd
5784 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5785 in order to get a host name. This improves the quality of the logging
5786 information, but if you feel it is too expensive, you can remove it entirely,
5787 or restrict the lookup to hosts on &"nearby"& networks.
5788 Note that it is not always possible to find a host name from an IP address,
5789 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5790 unreachable.
5791
5792 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5793 1413 (hence their names):
5794 .code
5795 rfc1413_hosts = *
5796 rfc1413_query_timeout = 0s
5797 .endd
5798 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5799 Few hosts offer RFC1413 service these days; calls have to be
5800 terminated by a timeout and this needlessly delays the startup
5801 of an incoming SMTP connection.
5802 If you have hosts for which you trust RFC1413 and need this
5803 information, you can change this.
5804
5805 This line enables an efficiency SMTP option.  It is negotiated by clients
5806 and not expected to cause problems but can be disabled if needed.
5807 .code
5808 prdr_enable = true
5809 .endd
5810
5811 When Exim receives messages over SMTP connections, it expects all addresses to
5812 be fully qualified with a domain, as required by the SMTP definition. However,
5813 if you are running a server to which simple clients submit messages, you may
5814 find that they send unqualified addresses. The two commented-out options:
5815 .code
5816 # sender_unqualified_hosts =
5817 # recipient_unqualified_hosts =
5818 .endd
5819 show how you can specify hosts that are permitted to send unqualified sender
5820 and recipient addresses, respectively.
5821
5822 The &%log_selector%& option is used to increase the detail of logging
5823 over the default:
5824 .code
5825 log_selector = +smtp_protocol_error +smtp_syntax_error \
5826                +tls_certificate_verified
5827 .endd
5828
5829 The &%percent_hack_domains%& option is also commented out:
5830 .code
5831 # percent_hack_domains =
5832 .endd
5833 It provides a list of domains for which the &"percent hack"& is to operate.
5834 This is an almost obsolete form of explicit email routing. If you do not know
5835 anything about it, you can safely ignore this topic.
5836
5837 The next two settings in the main part of the default configuration are
5838 concerned with messages that have been &"frozen"& on Exim's queue. When a
5839 message is frozen, Exim no longer continues to try to deliver it. Freezing
5840 occurs when a bounce message encounters a permanent failure because the sender
5841 address of the original message that caused the bounce is invalid, so the
5842 bounce cannot be delivered. This is probably the most common case, but there
5843 are also other conditions that cause freezing, and frozen messages are not
5844 always bounce messages.
5845 .code
5846 ignore_bounce_errors_after = 2d
5847 timeout_frozen_after = 7d
5848 .endd
5849 The first of these options specifies that failing bounce messages are to be
5850 discarded after 2 days in the queue. The second specifies that any frozen
5851 message (whether a bounce message or not) is to be timed out (and discarded)
5852 after a week. In this configuration, the first setting ensures that no failing
5853 bounce message ever lasts a week.
5854
5855 Exim queues it's messages in a spool directory. If you expect to have
5856 large queues, you may consider using this option. It splits the spool
5857 directory into subdirectories to avoid file system degradation from
5858 many files in a single directory, resulting in better performance.
5859 Manual manipulation of queued messages becomes more complex (though fortunately
5860 not often needed).
5861 .code
5862 # split_spool_directory = true
5863 .endd
5864
5865 In an ideal world everybody follows the standards. For non-ASCII
5866 messages RFC 2047 is a standard, allowing a maximum line length of 76
5867 characters. Exim adheres that standard and won't process messages which
5868 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5869 In particular, the Exim maintainers have had multiple reports of
5870 problems from Russian administrators of issues until they disable this
5871 check, because of some popular, yet buggy, mail composition software.
5872 .code
5873 # check_rfc2047_length = false
5874 .endd
5875
5876 If you need to be strictly RFC compliant you may wish to disable the
5877 8BITMIME advertisement. Use this, if you exchange mails with systems
5878 that are not 8-bit clean.
5879 .code
5880 # accept_8bitmime = false
5881 .endd
5882
5883 Libraries you use may depend on specific environment settings.  This
5884 imposes a security risk (e.g. PATH). There are two lists:
5885 &%keep_environment%& for the variables to import as they are, and
5886 &%add_environment%& for variables we want to set to a fixed value.
5887 Note that TZ is handled separately, by the &%timezone%& runtime
5888 option and by the TIMEZONE_DEFAULT buildtime option.
5889 .code
5890 # keep_environment = ^LDAP
5891 # add_environment = PATH=/usr/bin::/bin
5892 .endd
5893
5894
5895 .section "ACL configuration" "SECID54"
5896 .cindex "default" "ACLs"
5897 .cindex "&ACL;" "default configuration"
5898 In the default configuration, the ACL section follows the main configuration.
5899 It starts with the line
5900 .code
5901 begin acl
5902 .endd
5903 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5904 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5905 and &%acl_smtp_data%& above.
5906
5907 .cindex "RCPT" "ACL for"
5908 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5909 RCPT command specifies one of the message's recipients. The ACL statements
5910 are considered in order, until the recipient address is either accepted or
5911 rejected. The RCPT command is then accepted or rejected, according to the
5912 result of the ACL processing.
5913 .code
5914 acl_check_rcpt:
5915 .endd
5916 This line, consisting of a name terminated by a colon, marks the start of the
5917 ACL, and names it.
5918 .code
5919 accept  hosts = :
5920 .endd
5921 This ACL statement accepts the recipient if the sending host matches the list.
5922 But what does that strange list mean? It doesn't actually contain any host
5923 names or IP addresses. The presence of the colon puts an empty item in the
5924 list; Exim matches this only if the incoming message did not come from a remote
5925 host, because in that case, the remote hostname is empty. The colon is
5926 important. Without it, the list itself is empty, and can never match anything.
5927
5928 What this statement is doing is to accept unconditionally all recipients in
5929 messages that are submitted by SMTP from local processes using the standard
5930 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5931 manner.
5932 .code
5933 deny    domains       = +local_domains
5934         local_parts   = ^[.] : ^.*[@%!/|]
5935         message       = Restricted characters in address
5936
5937 deny    domains       = !+local_domains
5938         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5939         message       = Restricted characters in address
5940 .endd
5941 These statements are concerned with local parts that contain any of the
5942 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5943 Although these characters are entirely legal in local parts (in the case of
5944 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5945 in Internet mail addresses.
5946
5947 The first three have in the past been associated with explicitly routed
5948 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5949 option). Addresses containing these characters are regularly tried by spammers
5950 in an attempt to bypass relaying restrictions, and also by open relay testing
5951 programs. Unless you really need them it is safest to reject these characters
5952 at this early stage. This configuration is heavy-handed in rejecting these
5953 characters for all messages it accepts from remote hosts. This is a deliberate
5954 policy of being as safe as possible.
5955
5956 The first rule above is stricter, and is applied to messages that are addressed
5957 to one of the local domains handled by this host. This is implemented by the
5958 first condition, which restricts it to domains that are listed in the
5959 &'local_domains'& domain list. The &"+"& character is used to indicate a
5960 reference to a named list. In this configuration, there is just one domain in
5961 &'local_domains'&, but in general there may be many.
5962
5963 The second condition on the first statement uses two regular expressions to
5964 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5965 or &"|"&. If you have local accounts that include these characters, you will
5966 have to modify this rule.
5967
5968 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5969 allows them because they have been encountered in practice. (Consider the
5970 common convention of local parts constructed as
5971 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5972 the author of Exim, who has no second initial.) However, a local part starting
5973 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5974 filename (for example, for a mailing list). This is also true for local parts
5975 that contain slashes. A pipe symbol can also be troublesome if the local part
5976 is incorporated unthinkingly into a shell command line.
5977
5978 The second rule above applies to all other domains, and is less strict. This
5979 allows your own users to send outgoing messages to sites that use slashes
5980 and vertical bars in their local parts. It blocks local parts that begin
5981 with a dot, slash, or vertical bar, but allows these characters within the
5982 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5983 and &"!"& is blocked, as before. The motivation here is to prevent your users
5984 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5985 .code
5986 accept  local_parts   = postmaster
5987         domains       = +local_domains
5988 .endd
5989 This statement, which has two conditions, accepts an incoming address if the
5990 local part is &'postmaster'& and the domain is one of those listed in the
5991 &'local_domains'& domain list. The &"+"& character is used to indicate a
5992 reference to a named list. In this configuration, there is just one domain in
5993 &'local_domains'&, but in general there may be many.
5994
5995 The presence of this statement means that mail to postmaster is never blocked
5996 by any of the subsequent tests. This can be helpful while sorting out problems
5997 in cases where the subsequent tests are incorrectly denying access.
5998 .code
5999 require verify        = sender
6000 .endd
6001 This statement requires the sender address to be verified before any subsequent
6002 ACL statement can be used. If verification fails, the incoming recipient
6003 address is refused. Verification consists of trying to route the address, to
6004 see if a bounce message could be delivered to it. In the case of remote
6005 addresses, basic verification checks only the domain, but &'callouts'& can be
6006 used for more verification if required. Section &<<SECTaddressverification>>&
6007 discusses the details of address verification.
6008 .code
6009 accept  hosts         = +relay_from_hosts
6010         control       = submission
6011 .endd
6012 This statement accepts the address if the message is coming from one of the
6013 hosts that are defined as being allowed to relay through this host. Recipient
6014 verification is omitted here, because in many cases the clients are dumb MUAs
6015 that do not cope well with SMTP error responses. For the same reason, the
6016 second line specifies &"submission mode"& for messages that are accepted. This
6017 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6018 messages that are deficient in some way, for example, because they lack a
6019 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6020 probably add recipient verification here, and disable submission mode.
6021 .code
6022 accept  authenticated = *
6023         control       = submission
6024 .endd
6025 This statement accepts the address if the client host has authenticated itself.
6026 Submission mode is again specified, on the grounds that such messages are most
6027 likely to come from MUAs. The default configuration does not define any
6028 authenticators, though it does include some nearly complete commented-out
6029 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6030 fact authenticate until you complete the authenticator definitions.
6031 .code
6032 require message = relay not permitted
6033         domains = +local_domains : +relay_to_domains
6034 .endd
6035 This statement rejects the address if its domain is neither a local domain nor
6036 one of the domains for which this host is a relay.
6037 .code
6038 require verify = recipient
6039 .endd
6040 This statement requires the recipient address to be verified; if verification
6041 fails, the address is rejected.
6042 .code
6043 # deny    dnslists    = black.list.example
6044 #         message     = rejected because $sender_host_address \
6045 #                       is in a black list at $dnslist_domain\n\
6046 #                       $dnslist_text
6047 #
6048 # warn    dnslists    = black.list.example
6049 #         add_header  = X-Warning: $sender_host_address is in \
6050 #                       a black list at $dnslist_domain
6051 #         log_message = found in $dnslist_domain
6052 .endd
6053 These commented-out lines are examples of how you could configure Exim to check
6054 sending hosts against a DNS black list. The first statement rejects messages
6055 from blacklisted hosts, whereas the second just inserts a warning header
6056 line.
6057 .code
6058 # require verify = csa
6059 .endd
6060 This commented-out line is an example of how you could turn on client SMTP
6061 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6062 records.
6063 .code
6064 accept
6065 .endd
6066 The final statement in the first ACL unconditionally accepts any recipient
6067 address that has successfully passed all the previous tests.
6068 .code
6069 acl_check_data:
6070 .endd
6071 This line marks the start of the second ACL, and names it. Most of the contents
6072 of this ACL are commented out:
6073 .code
6074 # deny    malware   = *
6075 #         message   = This message contains a virus \
6076 #                     ($malware_name).
6077 .endd
6078 These lines are examples of how to arrange for messages to be scanned for
6079 viruses when Exim has been compiled with the content-scanning extension, and a
6080 suitable virus scanner is installed. If the message is found to contain a
6081 virus, it is rejected with the given custom error message.
6082 .code
6083 # warn    spam      = nobody
6084 #         message   = X-Spam_score: $spam_score\n\
6085 #                     X-Spam_score_int: $spam_score_int\n\
6086 #                     X-Spam_bar: $spam_bar\n\
6087 #                     X-Spam_report: $spam_report
6088 .endd
6089 These lines are an example of how to arrange for messages to be scanned by
6090 SpamAssassin when Exim has been compiled with the content-scanning extension,
6091 and SpamAssassin has been installed. The SpamAssassin check is run with
6092 &`nobody`& as its user parameter, and the results are added to the message as a
6093 series of extra header line. In this case, the message is not rejected,
6094 whatever the spam score.
6095 .code
6096 accept
6097 .endd
6098 This final line in the DATA ACL accepts the message unconditionally.
6099
6100
6101 .section "Router configuration" "SECID55"
6102 .cindex "default" "routers"
6103 .cindex "routers" "default"
6104 The router configuration comes next in the default configuration, introduced
6105 by the line
6106 .code
6107 begin routers
6108 .endd
6109 Routers are the modules in Exim that make decisions about where to send
6110 messages. An address is passed to each router, in turn, until it is either
6111 accepted, or failed. This means that the order in which you define the routers
6112 matters. Each router is fully described in its own chapter later in this
6113 manual. Here we give only brief overviews.
6114 .code
6115 # domain_literal:
6116 #   driver = ipliteral
6117 #   domains = !+local_domains
6118 #   transport = remote_smtp
6119 .endd
6120 .cindex "domain literal" "default router"
6121 This router is commented out because the majority of sites do not want to
6122 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6123 you uncomment this router, you also need to uncomment the setting of
6124 &%allow_domain_literals%& in the main part of the configuration.
6125
6126 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6127 macro has been defined, per
6128 .code
6129 .ifdef ROUTER_SMARTHOST
6130 smarthost:
6131 #...
6132 .else
6133 dnslookup:
6134 #...
6135 .endif
6136 .endd
6137
6138 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6139 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6140 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6141 skip these routers because of the &%domains%& option.
6142
6143 .code
6144 smarthost:
6145   driver = manualroute
6146   domains = ! +local_domains
6147   transport = smarthost_smtp
6148   route_data = ROUTER_SMARTHOST
6149   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6150   no_more
6151 .endd
6152 This router only handles mail which is not to any local domains; this is
6153 specified by the line
6154 .code
6155 domains = ! +local_domains
6156 .endd
6157 The &%domains%& option lists the domains to which this router applies, but the
6158 exclamation mark is a negation sign, so the router is used only for domains
6159 that are not in the domain list called &'local_domains'& (which was defined at
6160 the start of the configuration). The plus sign before &'local_domains'&
6161 indicates that it is referring to a named list. Addresses in other domains are
6162 passed on to the following routers.
6163
6164 The name of the router driver is &(manualroute)& because we are manually
6165 specifying how mail should be routed onwards, instead of using DNS MX.
6166 While the name of this router instance is arbitrary, the &%driver%& option must
6167 be one of the driver modules that is in the Exim binary.
6168
6169 With no pre-conditions other than &%domains%&, all mail for non-local domains
6170 will be handled by this router, and the &%no_more%& setting will ensure that no
6171 other routers will be used for messages matching the pre-conditions.  See
6172 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6173 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6174 and the macro supplies the value; the address is then queued for the
6175 &(smarthost_smtp)& transport.
6176
6177 .code
6178 dnslookup:
6179   driver = dnslookup
6180   domains = ! +local_domains
6181   transport = remote_smtp
6182   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6183   no_more
6184 .endd
6185 The &%domains%& option behaves as per smarthost, above.
6186
6187 The name of the router driver is &(dnslookup)&,
6188 and is specified by the &%driver%& option. Do not be confused by the fact that
6189 the name of this router instance is the same as the name of the driver. The
6190 instance name is arbitrary, but the name set in the &%driver%& option must be
6191 one of the driver modules that is in the Exim binary.
6192
6193 The &(dnslookup)& router routes addresses by looking up their domains in the
6194 DNS in order to obtain a list of hosts to which the address is routed. If the
6195 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6196 specified by the &%transport%& option. If the router does not find the domain
6197 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6198 the address fails and is bounced.
6199
6200 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6201 be entirely ignored. This option is present because a number of cases have been
6202 encountered where MX records in the DNS point to host names
6203 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6204 Completely ignoring these IP addresses causes Exim to fail to route the
6205 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6206 continue to try to deliver the message periodically until the address timed
6207 out.
6208 .code
6209 system_aliases:
6210   driver = redirect
6211   allow_fail
6212   allow_defer
6213   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6214 # user = exim
6215   file_transport = address_file
6216   pipe_transport = address_pipe
6217 .endd
6218 Control reaches this and subsequent routers only for addresses in the local
6219 domains. This router checks to see whether the local part is defined as an
6220 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6221 data that it looks up from that file. If no data is found for the local part,
6222 the value of the &%data%& option is empty, causing the address to be passed to
6223 the next router.
6224
6225 &_/etc/aliases_& is a conventional name for the system aliases file that is
6226 often used. That is why it is referenced by from the default configuration
6227 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6228 &_Local/Makefile_& before building Exim.
6229 .code
6230 userforward:
6231   driver = redirect
6232   check_local_user
6233 # local_part_suffix = +* : -*
6234 # local_part_suffix_optional
6235   file = $home/.forward
6236 # allow_filter
6237   no_verify
6238   no_expn
6239   check_ancestor
6240   file_transport = address_file
6241   pipe_transport = address_pipe
6242   reply_transport = address_reply
6243 .endd
6244 This is the most complicated router in the default configuration. It is another
6245 redirection router, but this time it is looking for forwarding data set up by
6246 individual users. The &%check_local_user%& setting specifies a check that the
6247 local part of the address is the login name of a local user. If it is not, the
6248 router is skipped. The two commented options that follow &%check_local_user%&,
6249 namely:
6250 .code
6251 # local_part_suffix = +* : -*
6252 # local_part_suffix_optional
6253 .endd
6254 .vindex "&$local_part_suffix$&"
6255 show how you can specify the recognition of local part suffixes. If the first
6256 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6257 by any sequence of characters, is removed from the local part and placed in the
6258 variable &$local_part_suffix$&. The second suffix option specifies that the
6259 presence of a suffix in the local part is optional. When a suffix is present,
6260 the check for a local login uses the local part with the suffix removed.
6261
6262 When a local user account is found, the file called &_.forward_& in the user's
6263 home directory is consulted. If it does not exist, or is empty, the router
6264 declines. Otherwise, the contents of &_.forward_& are interpreted as
6265 redirection data (see chapter &<<CHAPredirect>>& for more details).
6266
6267 .cindex "Sieve filter" "enabling in default router"
6268 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6269 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6270 is commented out by default), the contents of the file are interpreted as a set
6271 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6272 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6273 separate document entitled &'Exim's interfaces to mail filtering'&.
6274
6275 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6276 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6277 There are two reasons for doing this:
6278
6279 .olist
6280 Whether or not a local user has a &_.forward_& file is not really relevant when
6281 checking an address for validity; it makes sense not to waste resources doing
6282 unnecessary work.
6283 .next
6284 More importantly, when Exim is verifying addresses or handling an EXPN
6285 command during an SMTP session, it is running as the Exim user, not as root.
6286 The group is the Exim group, and no additional groups are set up.
6287 It may therefore not be possible for Exim to read users' &_.forward_& files at
6288 this time.
6289 .endlist
6290
6291 The setting of &%check_ancestor%& prevents the router from generating a new
6292 address that is the same as any previous address that was redirected. (This
6293 works round a problem concerning a bad interaction between aliasing and
6294 forwarding &-- see section &<<SECTredlocmai>>&).
6295
6296 The final three option settings specify the transports that are to be used when
6297 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6298 auto-reply, respectively. For example, if a &_.forward_& file contains
6299 .code
6300 a.nother@elsewhere.example, /home/spqr/archive
6301 .endd
6302 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6303 transport.
6304 .code
6305 localuser:
6306   driver = accept
6307   check_local_user
6308 # local_part_suffix = +* : -*
6309 # local_part_suffix_optional
6310   transport = local_delivery
6311 .endd
6312 The final router sets up delivery into local mailboxes, provided that the local
6313 part is the name of a local login, by accepting the address and assigning it to
6314 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6315 routers, so the address is bounced. The commented suffix settings fulfil the
6316 same purpose as they do for the &(userforward)& router.
6317
6318
6319 .section "Transport configuration" "SECID56"
6320 .cindex "default" "transports"
6321 .cindex "transports" "default"
6322 Transports define mechanisms for actually delivering messages. They operate
6323 only when referenced from routers, so the order in which they are defined does
6324 not matter. The transports section of the configuration starts with
6325 .code
6326 begin transports
6327 .endd
6328 Two remote transports and four local transports are defined.
6329 .code
6330 remote_smtp:
6331   driver = smtp
6332   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6333 .ifdef _HAVE_PRDR
6334   hosts_try_prdr = *
6335 .endif
6336 .endd
6337 This transport is used for delivering messages over SMTP connections.
6338 The list of remote hosts comes from the router.
6339 The &%message_size_limit%& usage is a hack to avoid sending on messages
6340 with over-long lines.
6341
6342 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6343 negotiated between client and server and not expected to cause problems
6344 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6345 use of the &%hosts_try_prdr%& configuration option.
6346
6347 The other remote transport is used when delivering to a specific smarthost
6348 with whom there must be some kind of existing relationship, instead of the
6349 usual federated system.
6350
6351 .code
6352 smarthost_smtp:
6353   driver = smtp
6354   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6355   multi_domain
6356   #
6357 .ifdef _HAVE_TLS
6358   # Comment out any of these which you have to, then file a Support
6359   # request with your smarthost provider to get things fixed:
6360   hosts_require_tls = *
6361   tls_verify_hosts = *
6362   # As long as tls_verify_hosts is enabled, this this will have no effect,
6363   # but if you have to comment it out then this will at least log whether
6364   # you succeed or not:
6365   tls_try_verify_hosts = *
6366   #
6367   # The SNI name should match the name which we'll expect to verify;
6368   # many mail systems don't use SNI and this doesn't matter, but if it does,
6369   # we need to send a name which the remote site will recognize.
6370   # This _should_ be the name which the smarthost operators specified as
6371   # the hostname for sending your mail to.
6372   tls_sni = ROUTER_SMARTHOST
6373   #
6374 .ifdef _HAVE_OPENSSL
6375   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6376 .endif
6377 .ifdef _HAVE_GNUTLS
6378   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6379 .endif
6380 .endif
6381 .ifdef _HAVE_PRDR
6382   hosts_try_prdr = *
6383 .endif
6384 .endd
6385 After the same &%message_size_limit%& hack, we then specify that this Transport
6386 can handle messages to multiple domains in one run.  The assumption here is
6387 that you're routing all non-local mail to the same place and that place is
6388 happy to take all messages from you as quickly as possible.
6389 All other options depend upon built-in macros; if Exim was built without TLS support
6390 then no other options are defined.
6391 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6392 and versions using the &%tls_require_ciphers%& option, where the value to be
6393 used depends upon the library providing TLS.
6394 Beyond that, the options adopt the stance that you should have TLS support available
6395 from your smarthost on today's Internet, so we turn on requiring TLS for the
6396 mail to be delivered, and requiring that the certificate be valid, and match
6397 the expected hostname.  The &%tls_sni%& option can be used by service providers
6398 to select an appropriate certificate to present to you and here we re-use the
6399 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6400 You want to specify the hostname which you'll expect to validate for, and that
6401 should not be subject to insecure tampering via DNS results.
6402
6403 For the &%hosts_try_prdr%& option see the previous transport.
6404
6405 All other options are defaulted.
6406 .code
6407 local_delivery:
6408   driver = appendfile
6409   file = /var/mail/$local_part_data
6410   delivery_date_add
6411   envelope_to_add
6412   return_path_add
6413 # group = mail
6414 # mode = 0660
6415 .endd
6416 This &(appendfile)& transport is used for local delivery to user mailboxes in
6417 traditional BSD mailbox format.
6418
6419 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6420 as it is provided by a potential bad actor.
6421 Instead we use &$local_part_data$&,
6422 the result of looking up &$local_part$& in the user database
6423 (done by using &%check_local_user%& in the the router).
6424
6425 By default &(appendfile)& runs under the uid and gid of the
6426 local user, which requires the sticky bit to be set on the &_/var/mail_&
6427 directory. Some systems use the alternative approach of running mail deliveries
6428 under a particular group instead of using the sticky bit. The commented options
6429 show how this can be done.
6430
6431 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6432 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6433 similarly-named options above.
6434 .code
6435 address_pipe:
6436   driver = pipe
6437   return_output
6438 .endd
6439 This transport is used for handling deliveries to pipes that are generated by
6440 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6441 option specifies that any output on stdout or stderr generated by the pipe is to
6442 be returned to the sender.
6443 .code
6444 address_file:
6445   driver = appendfile
6446   delivery_date_add
6447   envelope_to_add
6448   return_path_add
6449 .endd
6450 This transport is used for handling deliveries to files that are generated by
6451 redirection. The name of the file is not specified in this instance of
6452 &(appendfile)&, because it comes from the &(redirect)& router.
6453 .code
6454 address_reply:
6455   driver = autoreply
6456 .endd
6457 This transport is used for handling automatic replies generated by users'
6458 filter files.
6459
6460
6461
6462 .section "Default retry rule" "SECID57"
6463 .cindex "retry" "default rule"
6464 .cindex "default" "retry rule"
6465 The retry section of the configuration file contains rules which affect the way
6466 Exim retries deliveries that cannot be completed at the first attempt. It is
6467 introduced by the line
6468 .code
6469 begin retry
6470 .endd
6471 In the default configuration, there is just one rule, which applies to all
6472 errors:
6473 .code
6474 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6475 .endd
6476 This causes any temporarily failing address to be retried every 15 minutes for
6477 2 hours, then at intervals starting at one hour and increasing by a factor of
6478 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6479 is not delivered after 4 days of temporary failure, it is bounced. The time is
6480 measured from first failure, not from the time the message was received.
6481
6482 If the retry section is removed from the configuration, or is empty (that is,
6483 if no retry rules are defined), Exim will not retry deliveries. This turns
6484 temporary errors into permanent errors.
6485
6486
6487 .section "Rewriting configuration" "SECID58"
6488 The rewriting section of the configuration, introduced by
6489 .code
6490 begin rewrite
6491 .endd
6492 contains rules for rewriting addresses in messages as they arrive. There are no
6493 rewriting rules in the default configuration file.
6494
6495
6496
6497 .section "Authenticators configuration" "SECTdefconfauth"
6498 .cindex "AUTH" "configuration"
6499 The authenticators section of the configuration, introduced by
6500 .code
6501 begin authenticators
6502 .endd
6503 defines mechanisms for the use of the SMTP AUTH command. The default
6504 configuration file contains two commented-out example authenticators
6505 which support plaintext username/password authentication using the
6506 standard PLAIN mechanism and the traditional but non-standard LOGIN
6507 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6508 to support most MUA software.
6509
6510 The example PLAIN authenticator looks like this:
6511 .code
6512 #PLAIN:
6513 #  driver                  = plaintext
6514 #  server_set_id           = $auth2
6515 #  server_prompts          = :
6516 #  server_condition        = Authentication is not yet configured
6517 #  server_advertise_condition = ${if def:tls_in_cipher }
6518 .endd
6519 And the example LOGIN authenticator looks like this:
6520 .code
6521 #LOGIN:
6522 #  driver                  = plaintext
6523 #  server_set_id           = $auth1
6524 #  server_prompts          = <| Username: | Password:
6525 #  server_condition        = Authentication is not yet configured
6526 #  server_advertise_condition = ${if def:tls_in_cipher }
6527 .endd
6528
6529 The &%server_set_id%& option makes Exim remember the authenticated username
6530 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6531 &%server_prompts%& option configures the &(plaintext)& authenticator so
6532 that it implements the details of the specific authentication mechanism,
6533 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6534 when Exim offers authentication to clients; in the examples, this is only
6535 when TLS or SSL has been started, so to enable the authenticators you also
6536 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6537
6538 The &%server_condition%& setting defines how to verify that the username and
6539 password are correct. In the examples it just produces an error message.
6540 To make the authenticators work, you can use a string expansion
6541 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6542
6543 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6544 usercode and password are in different positions.
6545 Chapter &<<CHAPplaintext>>& covers both.
6546
6547 .ecindex IIDconfiwal
6548
6549
6550
6551 . ////////////////////////////////////////////////////////////////////////////
6552 . ////////////////////////////////////////////////////////////////////////////
6553
6554 .chapter "Regular expressions" "CHAPregexp"
6555
6556 .cindex "regular expressions" "library"
6557 .cindex "PCRE2"
6558 Exim supports the use of regular expressions in many of its options. It
6559 uses the PCRE2 regular expression library; this provides regular expression
6560 matching that is compatible with Perl 5. The syntax and semantics of
6561 regular expressions is discussed in
6562 online Perl manpages, in
6563 many Perl reference books, and also in
6564 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6565 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6566 . --- the http: URL here redirects to another page with the ISBN in the URL
6567 . --- where trying to use https: just redirects back to http:, so sticking
6568 . --- to the old URL for now.  2018-09-07.
6569
6570 The documentation for the syntax and semantics of the regular expressions that
6571 are supported by PCRE2 is included in the PCRE2 distribution, and no further
6572 description is included here. The PCRE2 functions are called from Exim using
6573 the default option settings (that is, with no PCRE2 options set), except that
6574 the PCRE2_CASELESS option is set when the matching is required to be
6575 case-insensitive.
6576
6577 In most cases, when a regular expression is required in an Exim configuration,
6578 it has to start with a circumflex, in order to distinguish it from plain text
6579 or an &"ends with"& wildcard. In this example of a configuration setting, the
6580 second item in the colon-separated list is a regular expression.
6581 .code
6582 domains = a.b.c : ^\\d{3} : *.y.z : ...
6583 .endd
6584 The doubling of the backslash is required because of string expansion that
6585 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6586 of this issue, and a way of avoiding the need for doubling backslashes. The
6587 regular expression that is eventually used in this example contains just one
6588 backslash. The circumflex is included in the regular expression, and has the
6589 normal effect of &"anchoring"& it to the start of the string that is being
6590 matched.
6591
6592 There are, however, two cases where a circumflex is not required for the
6593 recognition of a regular expression: these are the &%match%& condition in a
6594 string expansion, and the &%matches%& condition in an Exim filter file. In
6595 these cases, the relevant string is always treated as a regular expression; if
6596 it does not start with a circumflex, the expression is not anchored, and can
6597 match anywhere in the subject string.
6598
6599 In all cases, if you want a regular expression to match at the end of a string,
6600 you must code the $ metacharacter to indicate this. For example:
6601 .code
6602 domains = ^\\d{3}\\.example
6603 .endd
6604 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6605 You need to use:
6606 .code
6607 domains = ^\\d{3}\\.example\$
6608 .endd
6609 if you want &'example'& to be the top-level domain. The backslash before the
6610 $ is needed because string expansion also interprets dollar characters.
6611
6612
6613
6614 . ////////////////////////////////////////////////////////////////////////////
6615 . ////////////////////////////////////////////////////////////////////////////
6616
6617 .chapter "File and database lookups" "CHAPfdlookup"
6618 .scindex IIDfidalo1 "file" "lookups"
6619 .scindex IIDfidalo2 "database" "lookups"
6620 .cindex "lookup" "description of"
6621 Exim can be configured to look up data in files or databases as it processes
6622 messages. Two different kinds of syntax are used:
6623
6624 .olist
6625 A string that is to be expanded may contain explicit lookup requests. These
6626 cause parts of the string to be replaced by data that is obtained from the
6627 lookup. Lookups of this type are conditional expansion items. Different results
6628 can be defined for the cases of lookup success and failure. See chapter
6629 &<<CHAPexpand>>&, where string expansions are described in detail.
6630 The key for the lookup is &*specified*& as part of the string to be expanded.
6631 .next
6632 Lists of domains, hosts, and email addresses can contain lookup requests as a
6633 way of avoiding excessively long linear lists. In this case, the data that is
6634 returned by the lookup is often (but not always) discarded; whether the lookup
6635 succeeds or fails is what really counts. These kinds of list are described in
6636 chapter &<<CHAPdomhosaddlists>>&.
6637 Depending on the lookup type (see below)
6638 the key for the lookup may need to be &*specified*& as above
6639 or may be &*implicit*&,
6640 given by the context in which the list is being checked.
6641 .endlist
6642
6643 String expansions, lists, and lookups interact with each other in such a way
6644 that there is no order in which to describe any one of them that does not
6645 involve references to the others. Each of these three chapters makes more sense
6646 if you have read the other two first. If you are reading this for the first
6647 time, be aware that some of it will make a lot more sense after you have read
6648 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6649
6650 .section "Examples of different lookup syntax" "SECID60"
6651 It is easy to confuse the two different kinds of lookup, especially as the
6652 lists that may contain the second kind are always expanded before being
6653 processed as lists. Therefore, they may also contain lookups of the first kind.
6654 Be careful to distinguish between the following two examples:
6655 .code
6656 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6657 domains = lsearch;/some/file
6658 .endd
6659 .ilist
6660 The first uses a string expansion, the result of which must be a domain list.
6661 The key for an expansion-style lookup must be given explicitly.
6662 No strings have been specified for a successful or a failing lookup; the
6663 defaults in this case are the looked-up data and an empty string, respectively.
6664 The expansion takes place before the string is processed as a list, and the
6665 file that is searched could contain lines like this:
6666 .code
6667 192.168.3.4: domain1:domain2:...
6668 192.168.1.9: domain3:domain4:...
6669 .endd
6670 When the lookup succeeds, the result of the expansion is a list of domains (and
6671 possibly other types of item that are allowed in domain lists).
6672 .cindex "tainted data" "de-tainting"
6673 .cindex "de-tainting" "using a lookup expansion"
6674 The result of the expansion is not tainted.
6675
6676 .next
6677 In the second example, the lookup is a single item in a domain list. It causes
6678 Exim to use a lookup to see if the domain that is being processed can be found
6679 in the file.
6680 The file could contains lines like this:
6681 .code
6682 domain1:
6683 domain2:
6684 .endd
6685 Any data that follows the keys is not relevant when checking that the domain
6686 matches the list item.
6687
6688 The key for a list-style lookup is implicit, from the lookup context, if
6689 the lookup is a single-key type (see below).
6690 For query-style lookup types the query must be given explicitly.
6691 .endlist
6692
6693 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6694 Consider a file containing lines like this:
6695 .code
6696 192.168.5.6: lsearch;/another/file
6697 .endd
6698 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6699 first &%domains%& setting above generates the second setting, which therefore
6700 causes a second lookup to occur.
6701
6702 The lookup type may optionally be followed by a comma
6703 and a comma-separated list of options.
6704 Each option is a &"name=value"& pair.
6705 Whether an option is meaningful depends on the lookup type.
6706
6707 All lookups support the option &"cache=no_rd"&.
6708 If this is given then the cache that Exim manages for lookup results
6709 is not checked before doing the lookup.
6710 The result of the lookup is still written to the cache.
6711
6712 The rest of this chapter describes the different lookup types that are
6713 available. Any of them can be used in any part of the configuration where a
6714 lookup is permitted.
6715
6716
6717 .section "Lookup types" "SECID61"
6718 .cindex "lookup" "types of"
6719 .cindex "single-key lookup" "definition of"
6720 Two different types of data lookup are implemented:
6721
6722 .ilist
6723 The &'single-key'& type requires the specification of a file in which to look,
6724 and a single key to search for. The key must be a non-empty string for the
6725 lookup to succeed. The lookup type determines how the file is searched.
6726 .cindex "tainted data" "single-key lookups"
6727 The file string may not be tainted.
6728
6729 .cindex "tainted data" "de-tainting"
6730 .cindex "de-tainting" "using a single-key lookup"
6731 All single-key lookups support the option &"ret=key"&.
6732 If this is given and the lookup
6733 (either underlying implementation or cached value)
6734 returns data, the result is replaced with a non-tainted
6735 version of the lookup key.
6736
6737 .next
6738 .cindex "query-style lookup" "definition of"
6739 The &'query-style'& type accepts a generalized database query. No particular
6740 key value is assumed by Exim for query-style lookups. You can use whichever
6741 Exim variables you need to construct the database query.
6742
6743 For the string-expansion kind of lookups, the query is given in the first
6744 bracketed argument of the &${lookup ...}$& expansion.
6745 For the list-argument kind of lookup the query is given by the remainder of the
6746 list item after the first semicolon.
6747
6748 .cindex "tainted data" "quoting for lookups"
6749 If tainted data is used in the query then it should be quoted by
6750 using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator
6751 appropriate for the lookup.
6752 .endlist
6753
6754 The code for each lookup type is in a separate source file that is included in
6755 the binary of Exim only if the corresponding compile-time option is set. The
6756 default settings in &_src/EDITME_& are:
6757 .code
6758 LOOKUP_DBM=yes
6759 LOOKUP_LSEARCH=yes
6760 .endd
6761 which means that only linear searching and DBM lookups are included by default.
6762 For some types of lookup (e.g. SQL databases), you need to install appropriate
6763 libraries and header files before building Exim.
6764
6765
6766
6767
6768 .section "Single-key lookup types" "SECTsinglekeylookups"
6769 .cindex "lookup" "single-key types"
6770 .cindex "single-key lookup" "list of types"
6771 The following single-key lookup types are implemented:
6772
6773 .subsection cdb
6774 .cindex "cdb" "description of"
6775 .cindex "lookup" "cdb"
6776 .cindex "binary zero" "in lookup key"
6777 The given file is searched as a Constant DataBase file, using the key
6778 string without a terminating binary zero. The cdb format is designed for
6779 indexed files that are read frequently and never updated, except by total
6780 re-creation. As such, it is particularly suitable for large files containing
6781 aliases or other indexed data referenced by an MTA. Information about cdb and
6782 tools for building the files can be found in several places:
6783 .display
6784 &url(https://cr.yp.to/cdb.html)
6785 &url(https://www.corpit.ru/mjt/tinycdb.html)
6786 &url(https://packages.debian.org/stable/utils/freecdb)
6787 &url(https://github.com/philpennock/cdbtools) (in Go)
6788 .endd
6789 A cdb distribution is not needed in order to build Exim with cdb support,
6790 because the code for reading cdb files is included directly in Exim itself.
6791 However, no means of building or testing cdb files is provided with Exim, so
6792 you need to obtain a cdb distribution in order to do this.
6793
6794 .subsection dbm
6795 .cindex "DBM" "lookup type"
6796 .cindex "lookup" "dbm"
6797 .cindex "binary zero" "in lookup key"
6798 Calls to DBM library functions are used to extract data from the given
6799 DBM file by looking up the record with the given key. A terminating binary
6800 zero is included in the key that is passed to the DBM library. See section
6801 &<<SECTdb>>& for a discussion of DBM libraries.
6802
6803 .cindex "Berkeley DB library" "file format"
6804 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6805 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6806 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6807 the DB_UNKNOWN option. This enables it to handle any of the types of database
6808 that the library supports, and can be useful for accessing DBM files created by
6809 other applications. (For earlier DB versions, DB_HASH is always used.)
6810
6811 .subsection dbmjz
6812 .cindex "lookup" "dbmjz"
6813 .cindex "lookup" "dbm &-- embedded NULs"
6814 .cindex "sasldb2"
6815 .cindex "dbmjz lookup type"
6816 This is the same as &(dbm)&, except that the lookup key is
6817 interpreted as an Exim list; the elements of the list are joined together with
6818 ASCII NUL characters to form the lookup key.  An example usage would be to
6819 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6820 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6821 &(cram_md5)& authenticator.
6822
6823 .subsection dbmnz
6824 .cindex "lookup" "dbmnz"
6825 .cindex "lookup" "dbm &-- terminating zero"
6826 .cindex "binary zero" "in lookup key"
6827 .cindex "Courier"
6828 .cindex "&_/etc/userdbshadow.dat_&"
6829 .cindex "dbmnz lookup type"
6830 This is the same as &(dbm)&, except that a terminating binary zero
6831 is not included in the key that is passed to the DBM library. You may need this
6832 if you want to look up data in files that are created by or shared with some
6833 other application that does not use terminating zeros. For example, you need to
6834 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6835 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6836 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6837 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6838
6839 .subsection dsearch
6840 .cindex "lookup" "dsearch"
6841 .cindex "dsearch lookup type"
6842 The given file must be an absolute directory path; this is searched for an entry
6843 whose name is the key by calling the &[lstat()]& function.
6844 The key may not contain any forward slash characters.
6845 If &[lstat()]& succeeds then so does the lookup.
6846 .cindex "tainted data" "dsearch result"
6847 The result is regarded as untainted.
6848
6849 Options for the lookup can be given by appending them after the word "dsearch",
6850 separated by a comma.  Options, if present, are a comma-separated list having
6851 each element starting with a tag name and an equals.
6852
6853 Two options are supported, for the return value and for filtering match
6854 candidates.
6855 The "ret" option requests an alternate result value of
6856 the entire path for the entry. Example:
6857 .code
6858 ${lookup {passwd} dsearch,ret=full {/etc}}
6859 .endd
6860 The default result is just the requested entry.
6861 The "filter" option requests that only directory entries of a given type
6862 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6863 not matching "." or ".."). Example:
6864 .code
6865 ${lookup {passwd} dsearch,filter=file {/etc}}
6866 .endd
6867 The default matching is for any entry type, including directories
6868 and symlinks.
6869
6870 An example of how this
6871 lookup can be used to support virtual domains is given in section
6872 &<<SECTvirtualdomains>>&.
6873
6874 .subsection iplsearch
6875 .cindex "lookup" "iplsearch"
6876 .cindex "iplsearch lookup type"
6877 The given file is a text file containing keys and data. A key is
6878 terminated by a colon or white space or the end of the line. The keys in the
6879 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6880 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6881 being interpreted as a key terminator. For example:
6882 .code
6883 1.2.3.4:           data for 1.2.3.4
6884 192.168.0.0/16:    data for 192.168.0.0/16
6885 "abcd::cdab":      data for abcd::cdab
6886 "abcd:abcd::/32"   data for abcd:abcd::/32
6887 .endd
6888 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6889 file is searched linearly, using the CIDR masks where present, until a matching
6890 key is found. The first key that matches is used; there is no attempt to find a
6891 &"best"& match. Apart from the way the keys are matched, the processing for
6892 &(iplsearch)& is the same as for &(lsearch)&.
6893
6894 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6895 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6896 lookup types support only literal keys.
6897
6898 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6899 the implicit key is the host's IP address rather than its name (see section
6900 &<<SECThoslispatsikey>>&).
6901
6902 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6903 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6904 notation before executing the lookup.)
6905
6906 One option is supported, "ret=full", to request the return of the entire line
6907 rather than omitting the key portion.
6908 Note however that the key portion will have been de-quoted.
6909
6910 .subsection json
6911 .cindex lookup json
6912 .cindex json "lookup type"
6913 .cindex JSON expansions
6914 The given file is a text file with a JSON structure.
6915 An element of the structure is extracted, defined by the search key.
6916 The key is a list of subelement selectors
6917 (colon-separated by default but changeable in the usual way)
6918 which are applied in turn to select smaller and smaller portions
6919 of the JSON structure.
6920 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6921 nunbered array element is selected.
6922 Otherwise it must apply to a JSON object; the named element is selected.
6923 The final resulting element can be a simple JSON type or a JSON object
6924 or array; for the latter two a string-representation of the JSON
6925 is returned.
6926 For elements of type string, the returned value is de-quoted.
6927
6928
6929 .subsection lmdb
6930 .cindex LMDB
6931 .cindex lookup lmdb
6932 .cindex database lmdb
6933 The given file is an LMDB database.
6934 LMDB is a memory-mapped key-value store,
6935 with API modeled loosely on that of BerkeleyDB.
6936 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6937 for the feature set and operation modes.
6938
6939 Exim provides read-only access via the LMDB C library.
6940 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6941 or your operating system package repository.
6942 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6943
6944 You will need to separately create the LMDB database file,
6945 possibly using the &"mdb_load"& utility.
6946
6947
6948 .subsection lsearch
6949 .cindex "linear search"
6950 .cindex "lookup" "lsearch"
6951 .cindex "lsearch lookup type"
6952 .cindex "case sensitivity" "in lsearch lookup"
6953 The given file is a text file that is searched linearly for a
6954 line beginning with the search key, terminated by a colon or white space or the
6955 end of the line. The search is case-insensitive; that is, upper and lower case
6956 letters are treated as the same. The first occurrence of the key that is found
6957 in the file is used.
6958
6959 White space between the key and the colon is permitted. The remainder of the
6960 line, with leading and trailing white space removed, is the data. This can be
6961 continued onto subsequent lines by starting them with any amount of white
6962 space, but only a single space character is included in the data at such a
6963 junction. If the data begins with a colon, the key must be terminated by a
6964 colon, for example:
6965 .code
6966 baduser:  :fail:
6967 .endd
6968 Empty lines and lines beginning with # are ignored, even if they occur in the
6969 middle of an item. This is the traditional textual format of alias files. Note
6970 that the keys in an &(lsearch)& file are literal strings. There is no
6971 wildcarding of any kind.
6972
6973 .cindex "lookup" "lsearch &-- colons in keys"
6974 .cindex "white space" "in lsearch key"
6975 In most &(lsearch)& files, keys are not required to contain colons or #
6976 characters, or white space. However, if you need this feature, it is available.
6977 If a key begins with a doublequote character, it is terminated only by a
6978 matching quote (or end of line), and the normal escaping rules apply to its
6979 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6980 quoted keys (exactly as for unquoted keys). There is no special handling of
6981 quotes for the data part of an &(lsearch)& line.
6982
6983 .subsection nis
6984 .cindex "NIS lookup type"
6985 .cindex "lookup" "NIS"
6986 .cindex "binary zero" "in lookup key"
6987 The given file is the name of a NIS map, and a NIS lookup is done with
6988 the given key, without a terminating binary zero. There is a variant called
6989 &(nis0)& which does include the terminating binary zero in the key. This is
6990 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6991 aliases; the full map names must be used.
6992
6993 .subsection (n)wildlsearch
6994 .cindex "wildlsearch lookup type"
6995 .cindex "lookup" "wildlsearch"
6996 .cindex "nwildlsearch lookup type"
6997 .cindex "lookup" "nwildlsearch"
6998 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6999 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7000 the file may be wildcarded. The difference between these two lookup types is
7001 that for &(wildlsearch)&, each key in the file is string-expanded before being
7002 used, whereas for &(nwildlsearch)&, no expansion takes place.
7003
7004 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7005 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7006 file that are regular expressions can be made case-sensitive by the use of
7007 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7008
7009 .olist
7010 The string may begin with an asterisk to mean &"ends with"&. For example:
7011 .code
7012 *.a.b.c       data for anything.a.b.c
7013 *fish         data for anythingfish
7014 .endd
7015 .next
7016 The string may begin with a circumflex to indicate a regular expression. For
7017 example, for &(wildlsearch)&:
7018 .code
7019 ^\N\d+\.a\.b\N    data for <digits>.a.b
7020 .endd
7021 Note the use of &`\N`& to disable expansion of the contents of the regular
7022 expression. If you are using &(nwildlsearch)&, where the keys are not
7023 string-expanded, the equivalent entry is:
7024 .code
7025 ^\d+\.a\.b        data for <digits>.a.b
7026 .endd
7027 The case-insensitive flag is set at the start of compiling the regular
7028 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7029 For example, to make the entire pattern case-sensitive:
7030 .code
7031 ^(?-i)\d+\.a\.b        data for <digits>.a.b
7032 .endd
7033
7034 If the regular expression contains white space or colon characters, you must
7035 either quote it (see &(lsearch)& above), or represent these characters in other
7036 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7037 colon. This may be easier than quoting, because if you quote, you have to
7038 escape all the backslashes inside the quotes.
7039
7040 &*Note*&: It is not possible to capture substrings in a regular expression
7041 match for later use, because the results of all lookups are cached. If a lookup
7042 is repeated, the result is taken from the cache, and no actual pattern matching
7043 takes place. The values of all the numeric variables are unset after a
7044 &((n)wildlsearch)& match.
7045
7046 .next
7047 Although I cannot see it being of much use, the general matching function that
7048 is used to implement &((n)wildlsearch)& means that the string may begin with a
7049 lookup name terminated by a semicolon, and followed by lookup data. For
7050 example:
7051 .code
7052 cdb;/some/file  data for keys that match the file
7053 .endd
7054 The data that is obtained from the nested lookup is discarded.
7055 .endlist olist
7056
7057 Keys that do not match any of these patterns are interpreted literally. The
7058 continuation rules for the data are the same as for &(lsearch)&, and keys may
7059 be followed by optional colons.
7060
7061 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7062 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7063 lookup types support only literal keys.
7064
7065 .subsection spf
7066 .cindex "spf lookup type"
7067 .cindex "lookup" "spf"
7068 If Exim is built with SPF support, manual lookups can be done
7069 (as opposed to the standard ACL condition method).
7070 For details see section &<<SECSPF>>&.
7071
7072
7073 .section "Query-style lookup types" "SECTquerystylelookups"
7074 .cindex "lookup" "query-style types"
7075 .cindex "query-style lookup" "list of types"
7076 The supported query-style lookup types are listed below. Further details about
7077 many of them are given in later sections.
7078
7079 .subsection dnsdb
7080 .cindex "DNS" "as a lookup type"
7081 .cindex "lookup" "DNS"
7082 This does a DNS search for one or more records whose domain names
7083 are given in the supplied query. The resulting data is the contents of the
7084 records. See section &<<SECTdnsdb>>&.
7085
7086 .subsection ibase
7087 .cindex "InterBase lookup type"
7088 .cindex "lookup" "InterBase"
7089 This does a lookup in an InterBase database.
7090
7091 .subsection ldap
7092 .cindex "LDAP" "lookup type"
7093 .cindex "lookup" "LDAP"
7094 This does an LDAP lookup using a query in the form of a URL, and
7095 returns attributes from a single entry. There is a variant called &(ldapm)&
7096 that permits values from multiple entries to be returned. A third variant
7097 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7098 any attribute values. See section &<<SECTldap>>&.
7099
7100 .subsection mysql
7101 .cindex "MySQL" "lookup type"
7102 .cindex "lookup" "MySQL"
7103 The format of the query is an SQL statement that is passed to a
7104 MySQL database. See section &<<SECTsql>>&.
7105
7106 .subsection nisplus
7107 .cindex "NIS+ lookup type"
7108 .cindex "lookup" "NIS+"
7109 This does a NIS+ lookup using a query that can specify the name of
7110 the field to be returned. See section &<<SECTnisplus>>&.
7111
7112 .subsection oracle
7113 .cindex "Oracle" "lookup type"
7114 .cindex "lookup" "Oracle"
7115 The format of the query is an SQL statement that is passed to an
7116 Oracle database. See section &<<SECTsql>>&.
7117
7118 .subsection passwd
7119 .cindex "lookup" "passwd"
7120 .cindex "passwd lookup type"
7121 .cindex "&_/etc/passwd_&"
7122 This is a query-style lookup with queries that are just user names. The
7123 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7124 success, the result string is the same as you would get from an &(lsearch)&
7125 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7126 password value. For example:
7127 .code
7128 *:42:42:King Rat:/home/kr:/bin/bash
7129 .endd
7130
7131 .subsection pgsql
7132 .cindex "PostgreSQL lookup type"
7133 .cindex "lookup" "PostgreSQL"
7134 The format of the query is an SQL statement that is passed to a
7135 PostgreSQL database. See section &<<SECTsql>>&.
7136
7137 .subsection redis
7138 .cindex "Redis lookup type"
7139 .cindex lookup Redis
7140 The format of the query is either a simple get or simple set,
7141 passed to a Redis database. See section &<<SECTsql>>&.
7142
7143 .subsection sqlite
7144 .cindex "sqlite lookup type"
7145 .cindex "lookup" "sqlite"
7146 The format of the query is
7147 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7148
7149 .subsection testdb
7150 This is a lookup type that is used for testing Exim. It is
7151 not likely to be useful in normal operation.
7152
7153 .subsection whoson
7154 .cindex "whoson lookup type"
7155 .cindex "lookup" "whoson"
7156 &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7157 allows a server to check whether a particular (dynamically allocated) IP
7158 address is currently allocated to a known (trusted) user and, optionally, to
7159 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7160 at one time for &"POP before SMTP"& authentication, but that approach has been
7161 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7162 &"POP before SMTP"& checking using ACL statements such as
7163 .code
7164 require condition = \
7165   ${lookup whoson {$sender_host_address}{yes}{no}}
7166 .endd
7167 The query consists of a single IP address. The value returned is the name of
7168 the authenticated user, which is stored in the variable &$value$&. However, in
7169 this example, the data in &$value$& is not used; the result of the lookup is
7170 one of the fixed strings &"yes"& or &"no"&.
7171
7172
7173
7174 .section "Temporary errors in lookups" "SECID63"
7175 .cindex "lookup" "temporary error in"
7176 Lookup functions can return temporary error codes if the lookup cannot be
7177 completed. For example, an SQL or LDAP database might be unavailable. For this
7178 reason, it is not advisable to use a lookup that might do this for critical
7179 options such as a list of local domains.
7180
7181 When a lookup cannot be completed in a router or transport, delivery
7182 of the message (to the relevant address) is deferred, as for any other
7183 temporary error. In other circumstances Exim may assume the lookup has failed,
7184 or may give up altogether.
7185
7186
7187
7188 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7189 .cindex "wildcard lookups"
7190 .cindex "lookup" "default values"
7191 .cindex "lookup" "wildcard"
7192 .cindex "lookup" "* added to type"
7193 .cindex "default" "in single-key lookups"
7194 In this context, a &"default value"& is a value specified by the administrator
7195 that is to be used if a lookup fails.
7196
7197 &*Note:*& This section applies only to single-key lookups. For query-style
7198 lookups, the facilities of the query language must be used. An attempt to
7199 specify a default for a query-style lookup provokes an error.
7200
7201 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7202 and the initial lookup fails, the key &"*"& is looked up in the file to
7203 provide a default value. See also the section on partial matching below.
7204
7205 .cindex "*@ with single-key lookup"
7206 .cindex "lookup" "*@ added to type"
7207 .cindex "alias file" "per-domain default"
7208 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7209 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7210 character, a second lookup is done with everything before the last @ replaced
7211 by *. This makes it possible to provide per-domain defaults in alias files
7212 that include the domains in the keys. If the second lookup fails (or doesn't
7213 take place because there is no @ in the key), &"*"& is looked up.
7214 For example, a &(redirect)& router might contain:
7215 .code
7216 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7217 .endd
7218 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7219 looks up these keys, in this order:
7220 .code
7221 jane@eyre.example
7222 *@eyre.example
7223 *
7224 .endd
7225 The data is taken from whichever key it finds first. &*Note*&: In an
7226 &(lsearch)& file, this does not mean the first of these keys in the file. A
7227 complete scan is done for each key, and only if it is not found at all does
7228 Exim move on to try the next key.
7229
7230
7231
7232 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7233 .cindex "partial matching"
7234 .cindex "wildcard lookups"
7235 .cindex "lookup" "partial matching"
7236 .cindex "lookup" "wildcard"
7237 .cindex "asterisk" "in search type"
7238 The normal operation of a single-key lookup is to search the file for an exact
7239 match with the given key. However, in a number of situations where domains are
7240 being looked up, it is useful to be able to do partial matching. In this case,
7241 information in the file that has a key starting with &"*."& is matched by any
7242 domain that ends with the components that follow the full stop. For example, if
7243 a key in a DBM file is
7244 .code
7245 *.dates.fict.example
7246 .endd
7247 then when partial matching is enabled this is matched by (amongst others)
7248 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7249 by &'dates.fict.example'&, if that does not appear as a separate key in the
7250 file.
7251
7252 &*Note*&: Partial matching is not available for query-style lookups. It is
7253 also not available for any lookup items in address lists (see section
7254 &<<SECTaddresslist>>&).
7255
7256 Partial matching is implemented by doing a series of separate lookups using
7257 keys constructed by modifying the original subject key. This means that it can
7258 be used with any of the single-key lookup types, provided that
7259 partial matching keys
7260 beginning with a special prefix (default &"*."&) are included in the data file.
7261 Keys in the file that do not begin with the prefix are matched only by
7262 unmodified subject keys when partial matching is in use.
7263
7264 Partial matching is requested by adding the string &"partial-"& to the front of
7265 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7266 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7267 is added at the start of the subject key, and it is looked up again. If that
7268 fails, further lookups are tried with dot-separated components removed from the
7269 start of the subject key, one-by-one, and &"*."& added on the front of what
7270 remains.
7271
7272 A minimum number of two non-* components are required. This can be adjusted
7273 by including a number before the hyphen in the search type. For example,
7274 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7275 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7276 subject key is &'2250.dates.fict.example'& then the following keys are looked
7277 up when the minimum number of non-* components is two:
7278 .code
7279 2250.dates.fict.example
7280 *.2250.dates.fict.example
7281 *.dates.fict.example
7282 *.fict.example
7283 .endd
7284 As soon as one key in the sequence is successfully looked up, the lookup
7285 finishes.
7286
7287 .cindex "lookup" "partial matching &-- changing prefix"
7288 .cindex "prefix" "for partial matching"
7289 The use of &"*."& as the partial matching prefix is a default that can be
7290 changed. The motivation for this feature is to allow Exim to operate with file
7291 formats that are used by other MTAs. A different prefix can be supplied in
7292 parentheses instead of the hyphen after &"partial"&. For example:
7293 .code
7294 domains = partial(.)lsearch;/some/file
7295 .endd
7296 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7297 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7298 components is unchanged). The prefix may consist of any punctuation characters
7299 other than a closing parenthesis. It may be empty, for example:
7300 .code
7301 domains = partial1()cdb;/some/file
7302 .endd
7303 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7304 &`a.b.c`&, &`b.c`&, and &`c`&.
7305
7306 If &"partial0"& is specified, what happens at the end (when the lookup with
7307 just one non-wild component has failed, and the original key is shortened right
7308 down to the null string) depends on the prefix:
7309
7310 .ilist
7311 If the prefix has zero length, the whole lookup fails.
7312 .next
7313 If the prefix has length 1, a lookup for just the prefix is done. For
7314 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7315 .next
7316 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7317 remainder is looked up. With the default prefix, therefore, the final lookup is
7318 for &"*"& on its own.
7319 .next
7320 Otherwise, the whole prefix is looked up.
7321 .endlist
7322
7323
7324 If the search type ends in &"*"& or &"*@"& (see section
7325 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7326 this implies happens after all partial lookups have failed. If &"partial0"& is
7327 specified, adding &"*"& to the search type has no effect with the default
7328 prefix, because the &"*"& key is already included in the sequence of partial
7329 lookups. However, there might be a use for lookup types such as
7330 &"partial0(.)lsearch*"&.
7331
7332 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7333 in domain lists and the like. Partial matching works only in terms of
7334 dot-separated components; a key such as &`*fict.example`&
7335 in a database file is useless, because the asterisk in a partial matching
7336 subject key is always followed by a dot.
7337
7338 When the lookup is done from a string-expansion,
7339 the variables &$1$& and &$2$& contain the wild and non-wild parts of the key
7340 during the expansion of the replacement text.
7341 They return to their previous values at the end of the lookup item.
7342
7343
7344
7345
7346 .section "Lookup caching" "SECID64"
7347 .cindex "lookup" "caching"
7348 .cindex "caching" "lookup data"
7349 Exim caches all lookup results in order to avoid needless repetition of
7350 lookups. However, because (apart from the daemon) Exim operates as a collection
7351 of independent, short-lived processes, this caching applies only within a
7352 single Exim process. There is no inter-process lookup caching facility.
7353
7354 If an option &"cache=no_rd"& is used on the lookup then
7355 the cache is only written to, cached data is not used for the operation
7356 and a real lookup is done.
7357
7358 For single-key lookups, Exim keeps the relevant files open in case there is
7359 another lookup that needs them. In some types of configuration this can lead to
7360 many files being kept open for messages with many recipients. To avoid hitting
7361 the operating system limit on the number of simultaneously open files, Exim
7362 closes the least recently used file when it needs to open more files than its
7363 own internal limit, which can be changed via the &%lookup_open_max%& option.
7364
7365 The single-key lookup files are closed and the lookup caches are flushed at
7366 strategic points during delivery &-- for example, after all routing is
7367 complete.
7368
7369
7370
7371
7372 .section "Quoting lookup data" "SECID65"
7373 .cindex "lookup" "quoting"
7374 .cindex "quoting" "in lookups"
7375 When data from an incoming message is included in a query-style lookup, there
7376 is the possibility of special characters in the data messing up the syntax of
7377 the query. For example, a NIS+ query that contains
7378 .code
7379 [name=$local_part]
7380 .endd
7381 will be broken if the local part happens to contain a closing square bracket.
7382 For NIS+, data can be enclosed in double quotes like this:
7383 .code
7384 [name="$local_part"]
7385 .endd
7386 but this still leaves the problem of a double quote in the data. The rule for
7387 NIS+ is that double quotes must be doubled. Other lookup types have different
7388 rules, and to cope with the differing requirements, an expansion operator
7389 of the following form is provided:
7390 .code
7391 ${quote_<lookup-type>:<string>}
7392 .endd
7393 For example, the way to write the NIS+ query is
7394 .code
7395 [name="${quote_nisplus:$local_part}"]
7396 .endd
7397 .cindex "tainted data" "in lookups"
7398 &*All*& tainted data used in a query-style lookup must be quoted
7399 using a mechanism appropriate for the lookup type.
7400 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7401 operator can be used for all lookup types, but has no effect for single-key
7402 lookups, since no quoting is ever needed in their key strings.
7403
7404
7405
7406
7407 .section "More about dnsdb" "SECTdnsdb"
7408 .cindex "dnsdb lookup"
7409 .cindex "lookup" "dnsdb"
7410 .cindex "DNS" "as a lookup type"
7411 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7412 of a record type and a domain name, separated by an equals sign. For example,
7413 an expansion string could contain:
7414 .code
7415 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7416 .endd
7417 If the lookup succeeds, the result is placed in &$value$&, which in this case
7418 is used on its own as the result. If the lookup does not succeed, the
7419 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7420 &<<SECTforexpfai>>& for an explanation of what this means.
7421
7422 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7423 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7424 If no type is given, TXT is assumed.
7425
7426 For any record type, if multiple records are found, the data is returned as a
7427 concatenation, with newline as the default separator. The order, of course,
7428 depends on the DNS resolver. You can specify a different separator character
7429 between multiple records by putting a right angle-bracket followed immediately
7430 by the new separator at the start of the query. For example:
7431 .code
7432 ${lookup dnsdb{>: a=host1.example}}
7433 .endd
7434 It is permitted to specify a space as the separator character. Further
7435 white space is ignored.
7436 For lookup types that return multiple fields per record,
7437 an alternate field separator can be specified using a comma after the main
7438 separator character, followed immediately by the field separator.
7439
7440 .cindex "PTR record" "in &(dnsdb)& lookup"
7441 When the type is PTR,
7442 the data can be an IP address, written as normal; inversion and the addition of
7443 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7444 .code
7445 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7446 .endd
7447 If the data for a PTR record is not a syntactically valid IP address, it is not
7448 altered and nothing is added.
7449
7450 .cindex "MX record" "in &(dnsdb)& lookup"
7451 .cindex "SRV record" "in &(dnsdb)& lookup"
7452 For an MX lookup, both the preference value and the host name are returned for
7453 each record, separated by a space. For an SRV lookup, the priority, weight,
7454 port, and host name are returned for each record, separated by spaces.
7455 The field separator can be modified as above.
7456
7457 .cindex "TXT record" "in &(dnsdb)& lookup"
7458 .cindex "SPF record" "in &(dnsdb)& lookup"
7459 For TXT records with multiple items of data, only the first item is returned,
7460 unless a field separator is specified.
7461 To concatenate items without a separator, use a semicolon instead.
7462 For SPF records the
7463 default behaviour is to concatenate multiple items without using a separator.
7464 .code
7465 ${lookup dnsdb{>\n,: txt=a.b.example}}
7466 ${lookup dnsdb{>\n; txt=a.b.example}}
7467 ${lookup dnsdb{spf=example.org}}
7468 .endd
7469 It is permitted to specify a space as the separator character. Further
7470 white space is ignored.
7471
7472 .cindex "SOA record" "in &(dnsdb)& lookup"
7473 For an SOA lookup, while no result is obtained the lookup is redone with
7474 successively more leading components dropped from the given domain.
7475 Only the primary-nameserver field is returned unless a field separator is
7476 specified.
7477 .code
7478 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7479 .endd
7480
7481 .subsection "Dnsdb lookup modifiers" SECTdnsdb_mod
7482 .cindex "dnsdb modifiers"
7483 .cindex "modifiers" "dnsdb"
7484 .cindex "options" "dnsdb"
7485 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7486 each followed by a comma,
7487 that may appear before the record type.
7488
7489 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7490 temporary DNS error for any of them, the behaviour is controlled by
7491 a defer-option modifier.
7492 The possible keywords are
7493 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7494 With &"strict"& behaviour, any temporary DNS error causes the
7495 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7496 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7497 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7498 error causes the whole lookup to defer only if none of the other lookups
7499 succeed. The default is &"lax"&, so the following lookups are equivalent:
7500 .code
7501 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7502 ${lookup dnsdb{a=one.host.com:two.host.com}}
7503 .endd
7504 Thus, in the default case, as long as at least one of the DNS lookups
7505 yields some data, the lookup succeeds.
7506
7507 .cindex "DNSSEC" "dns lookup"
7508 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7509 The possible keywords are
7510 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7511 With &"strict"& or &"lax"& DNSSEC information is requested
7512 with the lookup.
7513 With &"strict"& a response from the DNS resolver that
7514 is not labelled as authenticated data
7515 is treated as equivalent to a temporary DNS error.
7516 The default is &"lax"&.
7517
7518 See also the &$lookup_dnssec_authenticated$& variable.
7519
7520 .cindex timeout "dns lookup"
7521 .cindex "DNS" timeout
7522 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7523 The form is &"retrans_VAL"& where VAL is an Exim time specification
7524 (e.g. &"5s"&).
7525 The default value is set by the main configuration option &%dns_retrans%&.
7526
7527 Retries for the dnsdb lookup can be controlled by a retry modifier.
7528 The form if &"retry_VAL"& where VAL is an integer.
7529 The default count is set by the main configuration option &%dns_retry%&.
7530
7531 .cindex caching "of dns lookup"
7532 .cindex TTL "of dns lookup"
7533 .cindex DNS TTL
7534 Dnsdb lookup results are cached within a single process (and its children).
7535 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7536 value of the set of returned DNS records.
7537
7538
7539 .subsection "Pseudo dnsdb record types" SECID66
7540 .cindex "MX record" "in &(dnsdb)& lookup"
7541 By default, both the preference value and the host name are returned for
7542 each MX record, separated by a space. If you want only host names, you can use
7543 the pseudo-type MXH:
7544 .code
7545 ${lookup dnsdb{mxh=a.b.example}}
7546 .endd
7547 In this case, the preference values are omitted, and just the host names are
7548 returned.
7549
7550 .cindex "name server for enclosing domain"
7551 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7552 records on the given domain, but if none are found, it removes the first
7553 component of the domain name, and tries again. This process continues until NS
7554 records are found or there are no more components left (or there is a DNS
7555 error). In other words, it may return the name servers for a top-level domain,
7556 but it never returns the root name servers. If there are no NS records for the
7557 top-level domain, the lookup fails. Consider these examples:
7558 .code
7559 ${lookup dnsdb{zns=xxx.quercite.com}}
7560 ${lookup dnsdb{zns=xxx.edu}}
7561 .endd
7562 Assuming that in each case there are no NS records for the full domain name,
7563 the first returns the name servers for &%quercite.com%&, and the second returns
7564 the name servers for &%edu%&.
7565
7566 You should be careful about how you use this lookup because, unless the
7567 top-level domain does not exist, the lookup always returns some host names. The
7568 sort of use to which this might be put is for seeing if the name servers for a
7569 given domain are on a blacklist. You can probably assume that the name servers
7570 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7571 such a list.
7572
7573 .cindex "CSA" "in &(dnsdb)& lookup"
7574 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7575 records according to the CSA rules, which are described in section
7576 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7577 not sufficient because of the extra parent domain search behaviour of CSA. The
7578 result of a successful lookup such as:
7579 .code
7580 ${lookup dnsdb {csa=$sender_helo_name}}
7581 .endd
7582 has two space-separated fields: an authorization code and a target host name.
7583 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7584 authorization required but absent, or &"?"& for unknown.
7585
7586 .cindex "A+" "in &(dnsdb)& lookup"
7587 The pseudo-type A+ performs an AAAA
7588 and then an A lookup.  All results are returned; defer processing
7589 (see below) is handled separately for each lookup.  Example:
7590 .code
7591 ${lookup dnsdb {>; a+=$sender_helo_name}}
7592 .endd
7593
7594
7595 .subsection "Multiple dnsdb lookups" SECID67
7596 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7597 However, you can specify a list of domains or IP addresses in a single
7598 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7599 the default separator, but with the ability to change this. For example:
7600 .code
7601 ${lookup dnsdb{one.domain.com:two.domain.com}}
7602 ${lookup dnsdb{a=one.host.com:two.host.com}}
7603 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7604 .endd
7605 In order to retain backwards compatibility, there is one special case: if
7606 the lookup type is PTR and no change of separator is specified, Exim looks
7607 to see if the rest of the string is precisely one IPv6 address. In this
7608 case, it does not treat it as a list.
7609
7610 The data from each lookup is concatenated, with newline separators by default,
7611 in the same way that multiple DNS records for a single item are handled. A
7612 different separator can be specified, as described above.
7613
7614
7615
7616
7617 .section "More about LDAP" "SECTldap"
7618 .cindex "LDAP" "lookup, more about"
7619 .cindex "lookup" "LDAP"
7620 .cindex "Solaris" "LDAP"
7621 The original LDAP implementation came from the University of Michigan; this has
7622 become &"Open LDAP"&, and there are now two different releases. Another
7623 implementation comes from Netscape, and Solaris 7 and subsequent releases
7624 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7625 the lookup function level, their error handling is different. For this reason
7626 it is necessary to set a compile-time variable when building Exim with LDAP, to
7627 indicate which LDAP library is in use. One of the following should appear in
7628 your &_Local/Makefile_&:
7629 .code
7630 LDAP_LIB_TYPE=UMICHIGAN
7631 LDAP_LIB_TYPE=OPENLDAP1
7632 LDAP_LIB_TYPE=OPENLDAP2
7633 LDAP_LIB_TYPE=NETSCAPE
7634 LDAP_LIB_TYPE=SOLARIS
7635 .endd
7636 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7637 same interface as the University of Michigan version.
7638
7639 There are three LDAP lookup types in Exim. These behave slightly differently in
7640 the way they handle the results of a query:
7641
7642 .ilist
7643 &(ldap)& requires the result to contain just one entry; if there are more, it
7644 gives an error.
7645 .next
7646 &(ldapdn)& also requires the result to contain just one entry, but it is the
7647 Distinguished Name that is returned rather than any attribute values.
7648 .next
7649 &(ldapm)& permits the result to contain more than one entry; the attributes
7650 from all of them are returned.
7651 .endlist
7652
7653
7654 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7655 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7656 the data returned by a successful lookup is described in the next section.
7657 First we explain how LDAP queries are coded.
7658
7659
7660 .subsection "Format of LDAP queries" SECTforldaque
7661 .cindex "LDAP" "query format"
7662 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7663 the configuration of a &(redirect)& router one might have this setting:
7664 .code
7665 data = ${lookup ldap \
7666   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7667   c=UK?mailbox?base?}}
7668 .endd
7669 .cindex "LDAP" "with TLS"
7670 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7671 secure (encrypted) LDAP connections. The second of these ensures that an
7672 encrypted TLS connection is used.
7673
7674 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7675 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7676 See the &%ldap_start_tls%& option.
7677
7678 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7679 controlled. Every part of the TLS configuration can be configured by settings in
7680 &_exim.conf_&. Depending on the version of the client libraries installed on
7681 your system, some of the initialization may have required setting options in
7682 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7683 certificates. This revealed a nuance where the current UID that exim was
7684 running as could affect which config files it read. With Exim 4.83, these
7685 methods become optional, only taking effect if not specifically set in
7686 &_exim.conf_&.
7687
7688
7689 .subsection "LDAP quoting" SECID68
7690 .cindex "LDAP" "quoting"
7691 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7692 and the second because the LDAP query is represented as a URL. Furthermore,
7693 within an LDAP query, two different kinds of quoting are required. For this
7694 reason, there are two different LDAP-specific quoting operators.
7695
7696 The &%quote_ldap%& operator is designed for use on strings that are part of
7697 filter specifications. Conceptually, it first does the following conversions on
7698 the string:
7699 .code
7700 *   =>   \2A
7701 (   =>   \28
7702 )   =>   \29
7703 \   =>   \5C
7704 .endd
7705 in accordance with RFC 2254. The resulting string is then quoted according
7706 to the rules for URLs, that is, all non-alphanumeric characters except
7707 .code
7708 ! $ ' - . _ ( ) * +
7709 .endd
7710 are converted to their hex values, preceded by a percent sign. For example:
7711 .code
7712 ${quote_ldap: a(bc)*, a<yz>; }
7713 .endd
7714 yields
7715 .code
7716 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7717 .endd
7718 Removing the URL quoting, this is (with a leading and a trailing space):
7719 .code
7720 a\28bc\29\2A, a<yz>;
7721 .endd
7722 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7723 base DN specifications in queries. Conceptually, it first converts the string
7724 by inserting a backslash in front of any of the following characters:
7725 .code
7726 , + " \ < > ;
7727 .endd
7728 It also inserts a backslash before any leading spaces or # characters, and
7729 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7730 is then quoted according to the rules for URLs. For example:
7731 .code
7732 ${quote_ldap_dn: a(bc)*, a<yz>; }
7733 .endd
7734 yields
7735 .code
7736 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7737 .endd
7738 Removing the URL quoting, this is (with a trailing space):
7739 .code
7740 \ a(bc)*\, a\<yz\>\;\
7741 .endd
7742 There are some further comments about quoting in the section on LDAP
7743 authentication below.
7744
7745
7746 .subsection "LDAP connections" SECID69
7747 .cindex "LDAP" "connections"
7748 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7749 is in use, via a Unix domain socket. The example given above does not specify
7750 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7751 by starting it with
7752 .code
7753 ldap://<hostname>:<port>/...
7754 .endd
7755 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7756 used. When no server is specified in a query, a list of default servers is
7757 taken from the &%ldap_default_servers%& configuration option. This supplies a
7758 colon-separated list of servers which are tried in turn until one successfully
7759 handles a query, or there is a serious error. Successful handling either
7760 returns the requested data, or indicates that it does not exist. Serious errors
7761 are syntactical, or multiple values when only a single value is expected.
7762 Errors which cause the next server to be tried are connection failures, bind
7763 failures, and timeouts.
7764
7765 For each server name in the list, a port number can be given. The standard way
7766 of specifying a host and port is to use a colon separator (RFC 1738). Because
7767 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7768 doubled. For example
7769 .code
7770 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7771 .endd
7772 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7773 to the LDAP library with no server name, and the library's default (normally
7774 the local host) is used.
7775
7776 If you are using the OpenLDAP library, you can connect to an LDAP server using
7777 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7778 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7779 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7780 not available.
7781
7782 For this type of connection, instead of a host name for the server, a pathname
7783 for the socket is required, and the port number is not relevant. The pathname
7784 can be specified either as an item in &%ldap_default_servers%&, or inline in
7785 the query. In the former case, you can have settings such as
7786 .code
7787 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7788 .endd
7789 When the pathname is given in the query, you have to escape the slashes as
7790 &`%2F`& to fit in with the LDAP URL syntax. For example:
7791 .code
7792 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7793 .endd
7794 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7795 a pathname, it uses the Unix domain socket code, even if the query actually
7796 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7797 socket connection. This behaviour means that you can use a setting of
7798 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7799 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7800 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7801 backup host.
7802
7803 If an explicit &`ldapi`& type is given in a query when a host name is
7804 specified, an error is diagnosed. However, if there are more items in
7805 &%ldap_default_servers%&, they are tried. In other words:
7806
7807 .ilist
7808 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7809 interface.
7810 .next
7811 Using &`ldapi`& with a host name causes an error.
7812 .endlist
7813
7814
7815 Using &`ldapi`& with no host or path in the query, and no setting of
7816 &%ldap_default_servers%&, does whatever the library does by default.
7817
7818
7819
7820 .subsection "LDAP authentication and control information" SECID70
7821 .cindex "LDAP" "authentication"
7822 The LDAP URL syntax provides no way of passing authentication and other control
7823 information to the server. To make this possible, the URL in an LDAP query may
7824 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7825 spaces. If a value contains spaces it must be enclosed in double quotes, and
7826 when double quotes are used, backslash is interpreted in the usual way inside
7827 them. The following names are recognized:
7828 .itable none 0 0 2 20* left 80* left
7829 .irow DEREFERENCE "set the dereferencing parameter"
7830 .irow NETTIME     "set a timeout for a network operation"
7831 .irow USER        "set the DN, for authenticating the LDAP bind"
7832 .irow PASS        "set the password, likewise"
7833 .irow REFERRALS   "set the referrals parameter"
7834 .irow SERVERS     "set alternate server list for this query only"
7835 .irow SIZE        "set the limit for the number of entries returned"
7836 .irow TIME        "set the maximum waiting time for a query"
7837 .endtable
7838 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7839 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7840 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7841 library from trying to follow referrals issued by the LDAP server.
7842
7843 .cindex LDAP timeout
7844 .cindex timeout "LDAP lookup"
7845 The name CONNECT is an obsolete name for NETTIME, retained for
7846 backwards compatibility. This timeout (specified as a number of seconds) is
7847 enforced from the client end for operations that can be carried out over a
7848 network. Specifically, it applies to network connections and calls to the
7849 &'ldap_result()'& function. If the value is greater than zero, it is used if
7850 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7851 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7852 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7853 Netscape SDK; for OpenLDAP no action is taken.
7854
7855 The TIME parameter (also a number of seconds) is passed to the server to
7856 set a server-side limit on the time taken to complete a search.
7857
7858 The SERVERS parameter allows you to specify an alternate list of ldap servers
7859 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7860 default list of ldap servers, and a single lookup can specify a single ldap
7861 server to use.  But when you need to do a lookup with a list of servers that is
7862 different than the default list (maybe different order, maybe a completely
7863 different set of servers), the SERVERS parameter allows you to specify this
7864 alternate list (colon-separated).
7865
7866 Here is an example of an LDAP query in an Exim lookup that uses some of these
7867 values. This is a single line, folded to fit on the page:
7868 .code
7869 ${lookup ldap
7870   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7871   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7872   {$value}fail}
7873 .endd
7874 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7875 any of the auxiliary data. Exim configuration settings that include lookups
7876 which contain password information should be preceded by &"hide"& to prevent
7877 non-admin users from using the &%-bP%& option to see their values.
7878
7879 The auxiliary data items may be given in any order. The default is no
7880 connection timeout (the system timeout is used), no user or password, no limit
7881 on the number of entries returned, and no time limit on queries.
7882
7883 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7884 removes any URL quoting that it may contain before passing it to the LDAP library.
7885 Apparently
7886 some libraries do this for themselves, but some do not. Removing the URL
7887 quoting has two advantages:
7888
7889 .ilist
7890 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7891 DNs as with DNs inside actual queries.
7892 .next
7893 It permits spaces inside USER= DNs.
7894 .endlist
7895
7896 For example, a setting such as
7897 .code
7898 USER=cn=${quote_ldap_dn:$1}
7899 .endd
7900 should work even if &$1$& contains spaces.
7901
7902 Expanded data for the PASS= value should be quoted using the &%quote%&
7903 expansion operator, rather than the LDAP quote operators. The only reason this
7904 field needs quoting is to ensure that it conforms to the Exim syntax, which
7905 does not allow unquoted spaces. For example:
7906 .code
7907 PASS=${quote:$3}
7908 .endd
7909 The LDAP authentication mechanism can be used to check passwords as part of
7910 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7911 &<<CHAPexpand>>&.
7912
7913
7914
7915 .subsection "Format of data returned by LDAP" SECID71
7916 .cindex "LDAP" "returned data formats"
7917 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7918 as a sequence of values, for example
7919 .code
7920 cn=manager,o=University of Cambridge,c=UK
7921 .endd
7922 The &(ldap)& lookup type generates an error if more than one entry matches the
7923 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7924 the result between the data from different entries. It is possible for multiple
7925 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7926 you know that whatever values are returned all came from a single entry in the
7927 directory.
7928
7929 In the common case where you specify a single attribute in your LDAP query, the
7930 result is not quoted, and does not contain the attribute name. If the attribute
7931 has multiple values, they are separated by commas. Any comma that is
7932 part of an attribute's value is doubled.
7933
7934 If you specify multiple attributes, the result contains space-separated, quoted
7935 strings, each preceded by the attribute name and an equals sign. Within the
7936 quotes, the quote character, backslash, and newline are escaped with
7937 backslashes, and commas are used to separate multiple values for the attribute.
7938 Any commas in attribute values are doubled
7939 (permitting treatment of the values as a comma-separated list).
7940 Apart from the escaping, the string within quotes takes the same form as the
7941 output when a single attribute is requested. Specifying no attributes is the
7942 same as specifying all of an entry's attributes.
7943
7944 Here are some examples of the output format. The first line of each pair is an
7945 LDAP query, and the second is the data that is returned. The attribute called
7946 &%attr1%& has two values, one of them with an embedded comma, whereas
7947 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7948 (they have SUP &%attr%& in their schema definitions).
7949
7950 .code
7951 ldap:///o=base?attr1?sub?(uid=fred)
7952 value1.1,value1,,2
7953
7954 ldap:///o=base?attr2?sub?(uid=fred)
7955 value two
7956
7957 ldap:///o=base?attr?sub?(uid=fred)
7958 value1.1,value1,,2,value two
7959
7960 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7961 attr1="value1.1,value1,,2" attr2="value two"
7962
7963 ldap:///o=base??sub?(uid=fred)
7964 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7965 .endd
7966 You can
7967 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7968 results of LDAP lookups.
7969 The &%extract%& operator in string expansions can be used to pick out
7970 individual fields from data that consists of &'key'&=&'value'& pairs.
7971 The &%listextract%& operator should be used to pick out individual values
7972 of attributes, even when only a single value is expected.
7973 The doubling of embedded commas allows you to use the returned data as a
7974 comma separated list (using the "<," syntax for changing the input list separator).
7975
7976
7977
7978
7979 .section "More about NIS+" "SECTnisplus"
7980 .cindex "NIS+ lookup type"
7981 .cindex "lookup" "NIS+"
7982 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7983 and field name. If this is given, the result of a successful query is the
7984 contents of the named field; otherwise the result consists of a concatenation
7985 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7986 values containing spaces are quoted. For example, the query
7987 .code
7988 [name=mg1456],passwd.org_dir
7989 .endd
7990 might return the string
7991 .code
7992 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7993 home=/home/mg1456 shell=/bin/bash shadow=""
7994 .endd
7995 (split over two lines here to fit on the page), whereas
7996 .code
7997 [name=mg1456],passwd.org_dir:gcos
7998 .endd
7999 would just return
8000 .code
8001 Martin Guerre
8002 .endd
8003 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8004 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8005 operator is to double any quote characters within the text.
8006
8007
8008
8009 .section "SQL lookups" "SECTsql"
8010 .cindex "SQL lookup types"
8011 .cindex "MySQL" "lookup type"
8012 .cindex "PostgreSQL lookup type"
8013 .cindex "lookup" "MySQL"
8014 .cindex "lookup" "PostgreSQL"
8015 .cindex "Oracle" "lookup type"
8016 .cindex "lookup" "Oracle"
8017 .cindex "InterBase lookup type"
8018 .cindex "lookup" "InterBase"
8019 .cindex "Redis lookup type"
8020 .cindex lookup Redis
8021 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8022 and SQLite
8023 databases. Queries for these databases contain SQL statements, so an example
8024 might be
8025 .code
8026 ${lookup mysql{select mailbox from users where id='userx'}\
8027   {$value}fail}
8028 .endd
8029 If the result of the query contains more than one field, the data for each
8030 field in the row is returned, preceded by its name, so the result of
8031 .code
8032 ${lookup pgsql{select home,name from users where id='userx'}\
8033   {$value}}
8034 .endd
8035 might be
8036 .code
8037 home=/home/userx name="Mister X"
8038 .endd
8039 Empty values and values containing spaces are double quoted, with embedded
8040 quotes escaped by a backslash. If the result of the query contains just one
8041 field, the value is passed back verbatim, without a field name, for example:
8042 .code
8043 Mister X
8044 .endd
8045 If the result of the query yields more than one row, it is all concatenated,
8046 with a newline between the data for each row.
8047
8048
8049 .subsection "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" SECID72
8050 .cindex "MySQL" "lookup type"
8051 .cindex "PostgreSQL lookup type"
8052 .cindex "lookup" "MySQL"
8053 .cindex "lookup" "PostgreSQL"
8054 .cindex "Oracle" "lookup type"
8055 .cindex "lookup" "Oracle"
8056 .cindex "InterBase lookup type"
8057 .cindex "lookup" "InterBase"
8058 .cindex "Redis lookup type"
8059 .cindex lookup Redis
8060 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8061 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8062 or &%redis_servers%&
8063 option (as appropriate) must be set to a colon-separated list of server
8064 information.
8065 .oindex &%mysql_servers%&
8066 .oindex &%pgsql_servers%&
8067 .oindex &%oracle_servers%&
8068 .oindex &%ibase_servers%&
8069 .oindex &%redis_servers%&
8070 (For MySQL and PostgreSQL, the global option need not be set if all
8071 queries contain their own server information &-- see section
8072 &<<SECTspeserque>>&.)
8073 For all but Redis
8074 each item in the list is a slash-separated list of four
8075 items: host name, database name, user name, and password. In the case of
8076 Oracle, the host name field is used for the &"service name"&, and the database
8077 name field is not used and should be empty. For example:
8078 .code
8079 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8080 .endd
8081 Because password data is sensitive, you should always precede the setting with
8082 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8083 option. Here is an example where two MySQL servers are listed:
8084 .code
8085 hide mysql_servers = localhost/users/root/secret:\
8086                      otherhost/users/root/othersecret
8087 .endd
8088 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8089 because this is a colon-separated list, the colon has to be doubled. For each
8090 query, these parameter groups are tried in order until a connection is made and
8091 a query is successfully processed. The result of a query may be that no data is
8092 found, but that is still a successful query. In other words, the list of
8093 servers provides a backup facility, not a list of different places to look.
8094
8095 For Redis the global option need not be specified if all queries contain their
8096 own server information &-- see section &<<SECTspeserque>>&.
8097 If specified, the option must be set to a colon-separated list of server
8098 information.
8099 Each item in the list is a slash-separated list of three items:
8100 host, database number, and password.
8101 .olist
8102 The host is required and may be either an IPv4 address and optional
8103 port number (separated by a colon, which needs doubling due to the
8104 higher-level list), or a Unix socket pathname enclosed in parentheses
8105 .next
8106 The database number is optional; if present that number is selected in the backend
8107 .next
8108 The password is optional; if present it is used to authenticate to the backend
8109 .endlist
8110
8111 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8112 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8113 respectively, and the characters single-quote, double-quote, and backslash
8114 itself are escaped with backslashes.
8115
8116 The &%quote_redis%& expansion operator
8117 escapes whitespace and backslash characters with a backslash.
8118
8119 .subsection "Specifying the server in the query" SECTspeserque
8120 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8121 it is possible to specify a list of servers with an individual query. This is
8122 done by appending a comma-separated option to the query type:
8123 .display
8124 &`,servers=`&&'server1:server2:server3:...'&
8125 .endd
8126 Each item in the list may take one of two forms:
8127 .olist
8128 If it contains no slashes it is assumed to be just a host name. The appropriate
8129 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8130 of the same name, and the remaining parameters (database, user, password) are
8131 taken from there.
8132 .next
8133 If it contains any slashes, it is taken as a complete parameter set.
8134 .endlist
8135 The list of servers is used in exactly the same way as the global list.
8136 Once a connection to a server has happened and a query has been
8137 successfully executed, processing of the lookup ceases.
8138
8139 This feature is intended for use in master/slave situations where updates
8140 are occurring and you want to update the master rather than a slave. If the
8141 master is in the list as a backup for reading, you might have a global setting
8142 like this:
8143 .code
8144 mysql_servers = slave1/db/name/pw:\
8145                 slave2/db/name/pw:\
8146                 master/db/name/pw
8147 .endd
8148 In an updating lookup, you could then write:
8149 .code
8150 ${lookup mysql,servers=master {UPDATE ...} }
8151 .endd
8152 That query would then be sent only to the master server. If, on the other hand,
8153 the master is not to be used for reading, and so is not present in the global
8154 option, you can still update it by a query of this form:
8155 .code
8156 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8157 .endd
8158
8159 .new
8160 A now-deprecated syntax places the servers specification before the query,
8161 semicolon separated:
8162 .code
8163 ${lookup mysql{servers=master; UPDATE ...} }
8164 .endd
8165 The new version avoids issues with tainted
8166 arguments explicitly expanded as part of the query.
8167 The entire string within the braces becomes tainted,
8168 including the server sepcification - which is not permissible.
8169 If the older sytax is used, a warning message will be logged.
8170 This syntax will be removed in a future release.
8171 .wen
8172
8173 &*Note*&: server specifications in list-style lookups are still problematic.
8174
8175
8176 .subsection "Special MySQL features" SECID73
8177 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8178 causes a connection to the server on the local host by means of a Unix domain
8179 socket. An alternate socket can be specified in parentheses.
8180 An option group name for MySQL option files can be specified in square brackets;
8181 the default value is &"exim"&.
8182 The full syntax of each item in &%mysql_servers%& is:
8183 .display
8184 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8185   <&'database'&>/<&'user'&>/<&'password'&>
8186 .endd
8187 Any of the four sub-parts of the first field can be omitted. For normal use on
8188 the local host it can be left blank or set to just &"localhost"&.
8189
8190 No database need be supplied &-- but if it is absent here, it must be given in
8191 the queries.
8192
8193 If a MySQL query is issued that does not request any data (an insert, update,
8194 or delete command), the result of the lookup is the number of rows affected.
8195
8196 &*Warning*&: This can be misleading. If an update does not actually change
8197 anything (for example, setting a field to the value it already has), the result
8198 is zero because no rows are affected.
8199
8200
8201 .subsection "Special PostgreSQL features" SECID74
8202 PostgreSQL lookups can also use Unix domain socket connections to the database.
8203 This is usually faster and costs less CPU time than a TCP/IP connection.
8204 However it can be used only if the mail server runs on the same machine as the
8205 database server. A configuration line for PostgreSQL via Unix domain sockets
8206 looks like this:
8207 .code
8208 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8209 .endd
8210 In other words, instead of supplying a host name, a path to the socket is
8211 given. The path name is enclosed in parentheses so that its slashes aren't
8212 visually confused with the delimiters for the other server parameters.
8213
8214 If a PostgreSQL query is issued that does not request any data (an insert,
8215 update, or delete command), the result of the lookup is the number of rows
8216 affected.
8217
8218 .subsection "More about SQLite" SECTsqlite
8219 .cindex "lookup" "SQLite"
8220 .cindex "sqlite lookup type"
8221 SQLite is different to the other SQL lookups because a filename is required in
8222 addition to the SQL query. An SQLite database is a single file, and there is no
8223 daemon as in the other SQL databases.
8224
8225 .oindex &%sqlite_dbfile%&
8226 There are two ways of
8227 specifying the file.
8228 The first is by using the &%sqlite_dbfile%& main option.
8229 The second, which allows separate files for each query,
8230 is to use an option appended, comma-separated, to the &"sqlite"&
8231 lookup type word.  The option is the word &"file"&, then an equals,
8232 then the filename.
8233 The filename in this case cannot contain whitespace or open-brace charachters.
8234
8235 A deprecated method is available, prefixing the query with the filename
8236 separated by white space.
8237 This means that
8238 .cindex "tainted data" "sqlite file"
8239 the query cannot use any tainted values, as that taints
8240 the entire query including the filename - resulting in a refusal to open
8241 the file.
8242
8243 In all the above cases the filename must be an absolute path.
8244
8245 Here is a lookup expansion example:
8246 .code
8247 sqlite_dbfile = /some/thing/sqlitedb
8248 ...
8249 ${lookup sqlite {select name from aliases where id='userx';}}
8250 .endd
8251 In a list, the syntax is similar. For example:
8252 .code
8253 domainlist relay_to_domains = sqlite;\
8254    select * from relays where ip='$sender_host_address';
8255 .endd
8256 The only character affected by the &%quote_sqlite%& operator is a single
8257 quote, which it doubles.
8258
8259 .cindex timeout SQLite
8260 .cindex sqlite "lookup timeout"
8261 The SQLite library handles multiple simultaneous accesses to the database
8262 internally. Multiple readers are permitted, but only one process can
8263 update at once. Attempts to access the database while it is being updated
8264 are rejected after a timeout period, during which the SQLite library
8265 waits for the lock to be released. In Exim, the default timeout is set
8266 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8267 option.
8268
8269 .subsection "More about Redis" SECTredis
8270 .cindex "lookup" "Redis"
8271 .cindex "redis lookup type"
8272 Redis is a non-SQL database. Commands are simple get and set.
8273 Examples:
8274 .code
8275 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8276 ${lookup redis{get keyname}}
8277 .endd
8278
8279 As of release 4.91, "lightweight" support for Redis Cluster is available.
8280 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8281 of which must be reachable from the running exim instance. If the cluster has
8282 master/slave replication, the list must contain all the master and slave
8283 servers.
8284
8285 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8286 immediately follow the redirection but treats the response as a DEFER, moving on
8287 to the next server in the &%redis_servers%& list until the correct server is
8288 reached.
8289
8290 .ecindex IIDfidalo1
8291 .ecindex IIDfidalo2
8292
8293
8294 . ////////////////////////////////////////////////////////////////////////////
8295 . ////////////////////////////////////////////////////////////////////////////
8296
8297 .chapter "Domain, host, address, and local part lists" &&&
8298          "CHAPdomhosaddlists" &&&
8299          "Domain, host, and address lists"
8300 .scindex IIDdohoadli "lists of domains; hosts; etc."
8301 A number of Exim configuration options contain lists of domains, hosts,
8302 email addresses, or local parts. For example, the &%hold_domains%& option
8303 contains a list of domains whose delivery is currently suspended. These lists
8304 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8305 arguments to expansion conditions such as &%match_domain%&.
8306
8307 Each item in one of these lists is a pattern to be matched against a domain,
8308 host, email address, or local part, respectively. In the sections below, the
8309 different types of pattern for each case are described, but first we cover some
8310 general facilities that apply to all four kinds of list.
8311
8312 Note that other parts of Exim use a &'string list'& which does not
8313 support all the complexity available in
8314 domain, host, address and local part lists.
8315
8316
8317
8318 .section "Results of list checking" SECTlistresults
8319 The primary result of doing a list check is a truth value.
8320 In some contexts additional information is stored
8321 about the list element that matched:
8322 .vlist
8323 .vitem hosts
8324 A &%hosts%& ACL condition
8325 will store a result in the &$host_data$& variable.
8326 .vitem local_parts
8327 A &%local_parts%& router option or &%local_parts%& ACL condition
8328 will store a result in the &$local_part_data$& variable.
8329 .vitem domains
8330 A &%domains%& router option or &%domains%& ACL condition
8331 will store a result in the &$domain_data$& variable.
8332 .vitem senders
8333 A &%senders%& router option or &%senders%& ACL condition
8334 will store a result in the &$sender_data$& variable.
8335 .vitem recipients
8336 A &%recipients%& ACL condition
8337 will store a result in the &$recipient_data$& variable.
8338 .endlist
8339
8340 The detail of the additional information depends on the
8341 type of match and is given below as the &*value*& information.
8342
8343
8344
8345
8346 .section "Expansion of lists" "SECTlistexpand"
8347 .cindex "expansion" "of lists"
8348 Each list is expanded as a single string before it is used.
8349 .cindex "tainted data" tracking
8350 &*Note*&: As a result, if any componend was tainted then the
8351 entire result string becomes tainted.
8352
8353 &'Exception: the router headers_remove option, where list-item
8354 splitting is done before string-expansion.'&
8355
8356 The result of
8357 expansion must be a list, possibly containing empty items, which is split up
8358 into separate items for matching. By default, colon is the separator character,
8359 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8360 &<<SECTempitelis>>& for details of the list syntax; the second of these
8361 discusses the way to specify empty list items.
8362
8363
8364 If the string expansion is forced to fail, Exim behaves as if the item it is
8365 testing (domain, host, address, or local part) is not in the list. Other
8366 expansion failures cause temporary errors.
8367
8368 If an item in a list is a regular expression, backslashes, dollars and possibly
8369 other special characters in the expression must be protected against
8370 misinterpretation by the string expander. The easiest way to do this is to use
8371 the &`\N`& expansion feature to indicate that the contents of the regular
8372 expression should not be expanded. For example, in an ACL you might have:
8373 .code
8374 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8375                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8376 .endd
8377 The first item is a regular expression that is protected from expansion by
8378 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8379 senders based on the receiving domain.
8380
8381
8382
8383
8384 .subsection "Negated items in lists" SECID76
8385 .cindex "list" "negation"
8386 .cindex "negation" "in lists"
8387 Items in a list may be positive or negative. Negative items are indicated by a
8388 leading exclamation mark, which may be followed by optional white space. A list
8389 defines a set of items (domains, etc). When Exim processes one of these lists,
8390 it is trying to find out whether a domain, host, address, or local part
8391 (respectively) is in the set that is defined by the list. It works like this:
8392
8393 The list is scanned from left to right. If a positive item is matched, the
8394 subject that is being checked is in the set; if a negative item is matched, the
8395 subject is not in the set. If the end of the list is reached without the
8396 subject having matched any of the patterns, it is in the set if the last item
8397 was a negative one, but not if it was a positive one. For example, the list in
8398 .code
8399 domainlist relay_to_domains = !a.b.c : *.b.c
8400 .endd
8401 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8402 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8403 list is positive. However, if the setting were
8404 .code
8405 domainlist relay_to_domains = !a.b.c
8406 .endd
8407 then all domains other than &'a.b.c'& would match because the last item in the
8408 list is negative. In other words, a list that ends with a negative item behaves
8409 as if it had an extra item &`:*`& on the end.
8410
8411 Another way of thinking about positive and negative items in lists is to read
8412 the connector as &"or"& after a positive item and as &"and"& after a negative
8413 item.
8414
8415
8416
8417 .subsection "File names in lists" SECTfilnamlis
8418 .cindex "list" "filename in"
8419 If an item in a domain, host, address, or local part list is an absolute
8420 filename (beginning with a slash character), each line of the file is read and
8421 processed as if it were an independent item in the list, except that further
8422 filenames are not allowed,
8423 and no expansion of the data from the file takes place.
8424 Empty lines in the file are ignored, and the file may also contain comment
8425 lines:
8426
8427 .ilist
8428 For domain and host lists, if a # character appears anywhere in a line of the
8429 file, it and all following characters are ignored.
8430 .next
8431 Because local parts may legitimately contain # characters, a comment in an
8432 address list or local part list file is recognized only if # is preceded by
8433 white space or the start of the line. For example:
8434 .code
8435 not#comment@x.y.z   # but this is a comment
8436 .endd
8437 .endlist
8438
8439 Putting a filename in a list has the same effect as inserting each line of the
8440 file as an item in the list (blank lines and comments excepted). However, there
8441 is one important difference: the file is read each time the list is processed,
8442 so if its contents vary over time, Exim's behaviour changes.
8443
8444 If a filename is preceded by an exclamation mark, the sense of any match
8445 within the file is inverted. For example, if
8446 .code
8447 hold_domains = !/etc/nohold-domains
8448 .endd
8449 and the file contains the lines
8450 .code
8451 !a.b.c
8452 *.b.c
8453 .endd
8454 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8455 any domain matching &`*.b.c`& is not.
8456
8457
8458
8459 .subsection "An lsearch file is not an out-of-line list" SECID77
8460 As will be described in the sections that follow, lookups can be used in lists
8461 to provide indexed methods of checking list membership. There has been some
8462 confusion about the way &(lsearch)& lookups work in lists. Because
8463 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8464 sometimes thought that it is allowed to contain wild cards and other kinds of
8465 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8466 always fixed strings, just as for any other single-key lookup type.
8467
8468 If you want to use a file to contain wild-card patterns that form part of a
8469 list, just give the filename on its own, without a search type, as described
8470 in the previous section. You could also use the &(wildlsearch)& or
8471 &(nwildlsearch)&, but there is no advantage in doing this.
8472
8473
8474
8475
8476 .subsection "Named lists" SECTnamedlists
8477 .cindex "named lists"
8478 .cindex "list" "named"
8479 A list of domains, hosts, email addresses, or local parts can be given a name
8480 which is then used to refer to the list elsewhere in the configuration. This is
8481 particularly convenient if the same list is required in several different
8482 places. It also allows lists to be given meaningful names, which can improve
8483 the readability of the configuration. For example, it is conventional to define
8484 a domain list called &'local_domains'& for all the domains that are handled
8485 locally on a host, using a configuration line such as
8486 .code
8487 domainlist local_domains = localhost:my.dom.example
8488 .endd
8489 Named lists are referenced by giving their name preceded by a plus sign, so,
8490 for example, a router that is intended to handle local domains would be
8491 configured with the line
8492 .code
8493 domains = +local_domains
8494 .endd
8495 The first router in a configuration is often one that handles all domains
8496 except the local ones, using a configuration with a negated item like this:
8497 .code
8498 dnslookup:
8499   driver = dnslookup
8500   domains = ! +local_domains
8501   transport = remote_smtp
8502   no_more
8503 .endd
8504 The four kinds of named list are created by configuration lines starting with
8505 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8506 respectively. Then there follows the name that you are defining, followed by an
8507 equals sign and the list itself. For example:
8508 .code
8509 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8510 addresslist bad_senders = cdb;/etc/badsenders
8511 .endd
8512 A named list may refer to other named lists:
8513 .code
8514 domainlist  dom1 = first.example : second.example
8515 domainlist  dom2 = +dom1 : third.example
8516 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8517 .endd
8518 &*Warning*&: If the last item in a referenced list is a negative one, the
8519 effect may not be what you intended, because the negation does not propagate
8520 out to the higher level. For example, consider:
8521 .code
8522 domainlist  dom1 = !a.b
8523 domainlist  dom2 = +dom1 : *.b
8524 .endd
8525 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8526 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8527 means it matches the second list as well. The effect is not the same as
8528 .code
8529 domainlist  dom2 = !a.b : *.b
8530 .endd
8531 where &'x.y'& does not match. It's best to avoid negation altogether in
8532 referenced lists if you can.
8533
8534 .cindex "hiding named list values"
8535 .cindex "named lists" "hiding value of"
8536 Some named list definitions may contain sensitive data, for example, passwords for
8537 accessing databases. To stop non-admin users from using the &%-bP%& command
8538 line option to read these values, you can precede the definition with the
8539 word &"hide"&. For example:
8540 .code
8541 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8542 .endd
8543
8544
8545 Named lists may have a performance advantage. When Exim is routing an
8546 address or checking an incoming message, it caches the result of tests on named
8547 lists. So, if you have a setting such as
8548 .code
8549 domains = +local_domains
8550 .endd
8551 on several of your routers
8552 or in several ACL statements,
8553 the actual test is done only for the first one. However, the caching works only
8554 if there are no expansions within the list itself or any sublists that it
8555 references. In other words, caching happens only for lists that are known to be
8556 the same each time they are referenced.
8557
8558 By default, there may be up to 16 named lists of each type. This limit can be
8559 extended by changing a compile-time variable. The use of domain and host lists
8560 is recommended for concepts such as local domains, relay domains, and relay
8561 hosts. The default configuration is set up like this.
8562
8563
8564
8565 .subsection "Named lists compared with macros" SECID78
8566 .cindex "list" "named compared with macro"
8567 .cindex "macro" "compared with named list"
8568 At first sight, named lists might seem to be no different from macros in the
8569 configuration file. However, macros are just textual substitutions. If you
8570 write
8571 .code
8572 ALIST = host1 : host2
8573 auth_advertise_hosts = !ALIST
8574 .endd
8575 it probably won't do what you want, because that is exactly the same as
8576 .code
8577 auth_advertise_hosts = !host1 : host2
8578 .endd
8579 Notice that the second host name is not negated. However, if you use a host
8580 list, and write
8581 .code
8582 hostlist alist = host1 : host2
8583 auth_advertise_hosts = ! +alist
8584 .endd
8585 the negation applies to the whole list, and so that is equivalent to
8586 .code
8587 auth_advertise_hosts = !host1 : !host2
8588 .endd
8589
8590
8591 .subsection "Named list caching" SECID79
8592 .cindex "list" "caching of named"
8593 .cindex "caching" "named lists"
8594 While processing a message, Exim caches the result of checking a named list if
8595 it is sure that the list is the same each time. In practice, this means that
8596 the cache operates only if the list contains no $ characters, which guarantees
8597 that it will not change when it is expanded. Sometimes, however, you may have
8598 an expanded list that you know will be the same each time within a given
8599 message. For example:
8600 .code
8601 domainlist special_domains = \
8602            ${lookup{$sender_host_address}cdb{/some/file}}
8603 .endd
8604 This provides a list of domains that depends only on the sending host's IP
8605 address. If this domain list is referenced a number of times (for example,
8606 in several ACL lines, or in several routers) the result of the check is not
8607 cached by default, because Exim does not know that it is going to be the
8608 same list each time.
8609
8610 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8611 cache the result anyway. For example:
8612 .code
8613 domainlist_cache special_domains = ${lookup{...
8614 .endd
8615 If you do this, you should be absolutely sure that caching is going to do
8616 the right thing in all cases. When in doubt, leave it out.
8617
8618
8619
8620 .section "Domain lists" "SECTdomainlist"
8621 .cindex "domain list" "patterns for"
8622 .cindex "list" "domain list"
8623 Domain lists contain patterns that are to be matched against a mail domain.
8624 The following types of item may appear in domain lists:
8625
8626 .ilist
8627 .cindex "primary host name"
8628 .cindex "host name" "matched in domain list"
8629 .oindex "&%primary_hostname%&"
8630 .cindex "domain list" "matching primary host name"
8631 .cindex "@ in a domain list"
8632 If a pattern consists of a single @ character, it matches the local host name,
8633 as set by the &%primary_hostname%& option (or defaulted). This makes it
8634 possible to use the same configuration file on several different hosts that
8635 differ only in their names.
8636
8637 The value for a match will be the primary host name.
8638
8639
8640 .next
8641 .cindex "@[] in a domain list"
8642 .cindex "domain list" "matching local IP interfaces"
8643 .cindex "domain literal"
8644 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8645 in square brackets (as in an email address that contains a domain literal), but
8646 only if that IP address is recognized as local for email routing purposes. The
8647 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8648 control which of a host's several IP addresses are treated as local.
8649 In today's Internet, the use of domain literals is controversial;
8650 see the &%allow_domain_literals%& main option.
8651
8652 The value for a match will be the string &`@[]`&.
8653
8654
8655 .next
8656 .cindex "@mx_any"
8657 .cindex "@mx_primary"
8658 .cindex "@mx_secondary"
8659 .cindex "domain list" "matching MX pointers to local host"
8660 If a pattern consists of the string &`@mx_any`& it matches any domain that
8661 has an MX record pointing to the local host or to any host that is listed in
8662 .oindex "&%hosts_treat_as_local%&"
8663 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8664 are similar, except that the first matches only when a primary MX target is the
8665 local host, and the second only when no primary MX target is the local host,
8666 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8667 preference value &-- there may of course be more than one of them.
8668
8669 The MX lookup that takes place when matching a pattern of this type is
8670 performed with the resolver options for widening names turned off. Thus, for
8671 example, a single-component domain will &'not'& be expanded by adding the
8672 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8673 options of the &(dnslookup)& router for a discussion of domain widening.
8674
8675 Sometimes you may want to ignore certain IP addresses when using one of these
8676 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8677 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8678 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8679 on a router). For example:
8680 .code
8681 domains = @mx_any/ignore=127.0.0.1
8682 .endd
8683 This example matches any domain that has an MX record pointing to one of
8684 the local host's IP addresses other than 127.0.0.1.
8685
8686 The list of IP addresses is in fact processed by the same code that processes
8687 host lists, so it may contain CIDR-coded network specifications and it may also
8688 contain negative items.
8689
8690 Because the list of IP addresses is a sublist within a domain list, you have to
8691 be careful about delimiters if there is more than one address. Like any other
8692 list, the default delimiter can be changed. Thus, you might have:
8693 .code
8694 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8695           an.other.domain : ...
8696 .endd
8697 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8698 involved, it is easiest to change the delimiter for the main list as well:
8699 .code
8700 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8701           an.other.domain ? ...
8702 .endd
8703 The value for a match will be the list element string (starting &`@mx_`&).
8704
8705
8706 .next
8707 .cindex "asterisk" "in domain list"
8708 .cindex "domain list" "asterisk in"
8709 .cindex "domain list" "matching &""ends with""&"
8710 If a pattern starts with an asterisk, the remaining characters of the pattern
8711 are compared with the terminating characters of the domain. The use of &"*"& in
8712 domain lists differs from its use in partial matching lookups. In a domain
8713 list, the character following the asterisk need not be a dot, whereas partial
8714 matching works only in terms of dot-separated components. For example, a domain
8715 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8716 &'cipher.key.ex'&.
8717
8718 The value for a match will be the list element string (starting with the asterisk).
8719 Additionally, &$0$& will be set to the matched string
8720 and &$1$& to the variable portion which the asterisk matched.
8721
8722 .next
8723 .cindex "regular expressions" "in domain list"
8724 .cindex "domain list" "matching regular expression"
8725 If a pattern starts with a circumflex character, it is treated as a regular
8726 expression, and matched against the domain using a regular expression matching
8727 function. The circumflex is treated as part of the regular expression.
8728 Email domains are case-independent, so this regular expression match is by
8729 default case-independent, but you can make it case-dependent by starting it
8730 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8731 are given in chapter &<<CHAPregexp>>&.
8732
8733 &*Warning*&: Because domain lists are expanded before being processed, you
8734 must escape any backslash and dollar characters in the regular expression, or
8735 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8736 it is not to be expanded (unless you really do want to build a regular
8737 expression by expansion, of course).
8738
8739 The value for a match will be the list element string (starting with the circumflex).
8740 Additionally, &$0$& will be set to the string matching the regular expression,
8741 and &$1$& (onwards) to any submatches identified by parentheses.
8742
8743
8744
8745 .next
8746 .cindex "lookup" "in domain list"
8747 .cindex "domain list" "matching by lookup"
8748 If a pattern starts with the name of a single-key lookup type followed by a
8749 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8750 must be a filename in a suitable format for the lookup type. For example, for
8751 &"cdb;"& it must be an absolute path:
8752 .code
8753 domains = cdb;/etc/mail/local_domains.cdb
8754 .endd
8755 The appropriate type of lookup is done on the file using the domain name as the
8756 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8757 only in whether or not the key is present in the file. However, when a lookup
8758 is used for the &%domains%& option on a router
8759 or a &%domains%& condition in an ACL statement, the value is preserved in the
8760 &$domain_data$& variable and can be referred to in other router options or
8761 other statements in the same ACL.
8762 .cindex "tainted data" "de-tainting"
8763 .cindex "de-tainting" "using ACL domains condition"
8764 The value will be untainted.
8765
8766 &*Note*&: If the data result of the lookup (as opposed to the key)
8767 is empty, then this empty value is stored in &$domain_data$&.
8768 The option to return the key for the lookup, as the value,
8769 may be what is wanted.
8770
8771
8772 .next
8773 Any of the single-key lookup type names may be preceded by
8774 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8775 .code
8776 domains = partial-dbm;/partial/domains
8777 .endd
8778 This causes partial matching logic to be invoked; a description of how this
8779 works is given in section &<<SECTpartiallookup>>&.
8780
8781 .next
8782 .cindex "asterisk" "in lookup type"
8783 Any of the single-key lookup types may be followed by an asterisk. This causes
8784 a default lookup for a key consisting of a single asterisk to be done if the
8785 original lookup fails. This is not a useful feature when using a domain list to
8786 select particular domains (because any domain would match), but it might have
8787 value if the result of the lookup is being used via the &$domain_data$&
8788 expansion variable.
8789
8790 .next
8791 If the pattern starts with the name of a query-style lookup type followed by a
8792 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8793 pattern must be an appropriate query for the lookup type, as described in
8794 chapter &<<CHAPfdlookup>>&. For example:
8795 .code
8796 hold_domains = mysql;select domain from holdlist \
8797   where domain = '${quote_mysql:$domain}';
8798 .endd
8799 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8800 example, it doesn't matter what field you select). Exim is interested only in
8801 whether or not the query succeeds. However, when a lookup is used for the
8802 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8803 variable and can be referred to in other options.
8804 .cindex "tainted data" "de-tainting"
8805 .cindex "de-tainting" "using router domains option"
8806 The value will be untainted.
8807
8808 .next
8809 If the pattern starts with the name of a lookup type
8810 of either kind (single-key or query-style) it may be
8811 followed by a comma and options,
8812 The options are lookup-type specific and consist of a comma-separated list.
8813 Each item starts with a tag and and equals "=" sign.
8814
8815 .next
8816 .cindex "domain list" "matching literal domain name"
8817 If none of the above cases apply, a caseless textual comparison is made
8818 between the pattern and the domain.
8819
8820 The value for a match will be the list element string.
8821 .cindex "tainted data" "de-tainting"
8822 Note that this is commonly untainted
8823 (depending on the way the list was created).
8824 Specifically, explicit text in the configuration file in not tainted.
8825 This is a useful way of obtaining an untainted equivalent to
8826 the domain, for later operations.
8827
8828 However if the list (including one-element lists)
8829 is created by expanding a variable containing tainted data,
8830 it is tainted and so will the match value be.
8831 .endlist
8832
8833
8834 Here is an example that uses several different kinds of pattern:
8835 .code
8836 domainlist funny_domains = \
8837   @ : \
8838   lib.unseen.edu : \
8839   *.foundation.fict.example : \
8840   \N^[1-2]\d{3}\.fict\.example$\N : \
8841   partial-dbm;/opt/data/penguin/book : \
8842   nis;domains.byname : \
8843   nisplus;[name=$domain,status=local],domains.org_dir
8844 .endd
8845 There are obvious processing trade-offs among the various matching modes. Using
8846 an asterisk is faster than a regular expression, and listing a few names
8847 explicitly probably is too. The use of a file or database lookup is expensive,
8848 but may be the only option if hundreds of names are required. Because the
8849 patterns are tested in order, it makes sense to put the most commonly matched
8850 patterns earlier.
8851
8852
8853
8854 .section "Host lists" "SECThostlist"
8855 .cindex "host list" "patterns in"
8856 .cindex "list" "host list"
8857 Host lists are used to control what remote hosts are allowed to do. For
8858 example, some hosts may be allowed to use the local host as a relay, and some
8859 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8860 two different ways, by name or by IP address. In a host list, some types of
8861 pattern are matched to a host name, and some are matched to an IP address.
8862 You need to be particularly careful with this when single-key lookups are
8863 involved, to ensure that the right value is being used as the key.
8864
8865
8866 .subsection "Special host list patterns" SECID80
8867 .cindex "empty item in hosts list"
8868 .cindex "host list" "empty string in"
8869 If a host list item is the empty string, it matches only when no remote host is
8870 involved. This is the case when a message is being received from a local
8871 process using SMTP on the standard input, that is, when a TCP/IP connection is
8872 not used.
8873
8874 .cindex "asterisk" "in host list"
8875 The special pattern &"*"& in a host list matches any host or no host. Neither
8876 the IP address nor the name is actually inspected.
8877
8878
8879
8880 .subsection "Host list patterns that match by IP address" SECThoslispatip
8881 .cindex "host list" "matching IP addresses"
8882 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8883 the incoming address actually appears in the IPv6 host as
8884 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8885 list, it is converted into a traditional IPv4 address first. (Not all operating
8886 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8887 concerns.)
8888
8889 The following types of pattern in a host list check the remote host by
8890 inspecting its IP address:
8891
8892 .ilist
8893 If the pattern is a plain domain name (not a regular expression, not starting
8894 with *, not a lookup of any kind), Exim calls the operating system function
8895 to find the associated IP address(es). Exim uses the newer
8896 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8897 This typically causes a forward DNS lookup of the name. The result is compared
8898 with the IP address of the subject host.
8899
8900 If there is a temporary problem (such as a DNS timeout) with the host name
8901 lookup, a temporary error occurs. For example, if the list is being used in an
8902 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8903 temporary SMTP error code. If no IP address can be found for the host name,
8904 what happens is described in section &<<SECTbehipnot>>& below.
8905
8906 .next
8907 .cindex "@ in a host list"
8908 If the pattern is &"@"&, the primary host name is substituted and used as a
8909 domain name, as just described.
8910
8911 .next
8912 If the pattern is an IP address, it is matched against the IP address of the
8913 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8914 IPv6 addresses can be given in colon-separated format, but the colons have to
8915 be doubled so as not to be taken as item separators when the default list
8916 separator is used. IPv6 addresses are recognized even when Exim is compiled
8917 without IPv6 support. This means that if they appear in a host list on an
8918 IPv4-only host, Exim will not treat them as host names. They are just addresses
8919 that can never match a client host.
8920
8921 .next
8922 .cindex "@[] in a host list"
8923 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8924 the local host. For example, if the local host is an IPv4 host with one
8925 interface address 10.45.23.56, these two ACL statements have the same effect:
8926 .code
8927 accept hosts = 127.0.0.1 : 10.45.23.56
8928 accept hosts = @[]
8929 .endd
8930 .next
8931 .cindex "CIDR notation"
8932 If the pattern is an IP address followed by a slash and a mask length, for
8933 example
8934 .code
8935 10.11.42.0/24
8936 .endd
8937 , it is matched against the IP address of the subject
8938 host under the given mask. This allows an entire network of hosts to be
8939 included (or excluded) by a single item. The mask uses CIDR notation; it
8940 specifies the number of address bits that must match, starting from the most
8941 significant end of the address.
8942
8943 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8944 of a range of addresses. It is the number of bits in the network portion of the
8945 address. The above example specifies a 24-bit netmask, so it matches all 256
8946 addresses in the 10.11.42.0 network. An item such as
8947 .code
8948 192.168.23.236/31
8949 .endd
8950 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8951 32 for an IPv4 address is the same as no mask at all; just a single address
8952 matches.
8953
8954 Here is another example which shows an IPv4 and an IPv6 network:
8955 .code
8956 recipient_unqualified_hosts = 192.168.0.0/16: \
8957                               3ffe::ffff::836f::::/48
8958 .endd
8959 The doubling of list separator characters applies only when these items
8960 appear inline in a host list. It is not required when indirecting via a file.
8961 For example:
8962 .code
8963 recipient_unqualified_hosts = /opt/exim/unqualnets
8964 .endd
8965 could make use of a file containing
8966 .code
8967 172.16.0.0/12
8968 3ffe:ffff:836f::/48
8969 .endd
8970 to have exactly the same effect as the previous example. When listing IPv6
8971 addresses inline, it is usually more convenient to use the facility for
8972 changing separator characters. This list contains the same two networks:
8973 .code
8974 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8975                                  3ffe:ffff:836f::/48
8976 .endd
8977 The separator is changed to semicolon by the leading &"<;"& at the start of the
8978 list.
8979 .endlist
8980
8981
8982
8983 .subsection "Host list patterns for single-key lookups by host address" &&&
8984          SECThoslispatsikey
8985 .cindex "host list" "lookup of IP address"
8986 When a host is to be identified by a single-key lookup of its complete IP
8987 address, the pattern takes this form:
8988 .display
8989 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8990 .endd
8991 For example:
8992 .code
8993 hosts_lookup = net-cdb;/hosts-by-ip.db
8994 .endd
8995 The text form of the IP address of the subject host is used as the lookup key.
8996 IPv6 addresses are converted to an unabbreviated form, using lower case
8997 letters, with dots as separators because colon is the key terminator in
8998 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8999 quoting the keys, but this is a facility that was added later.] The data
9000 returned by the lookup is not used.
9001
9002 .cindex "IP address" "masking"
9003 .cindex "host list" "masked IP address"
9004 Single-key lookups can also be performed using masked IP addresses, using
9005 patterns of this form:
9006 .display
9007 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9008 .endd
9009 For example:
9010 .code
9011 net24-dbm;/networks.db
9012 .endd
9013 The IP address of the subject host is masked using <&'number'&> as the mask
9014 length. A textual string is constructed from the masked value, followed by the
9015 mask, and this is used as the lookup key. For example, if the host's IP address
9016 is 192.168.34.6, the key that is looked up for the above example is
9017 &"192.168.34.0/24"&.
9018
9019 When an IPv6 address is converted to a string, dots are normally used instead
9020 of colons, so that keys in &(lsearch)& files need not contain colons (which
9021 terminate &(lsearch)& keys). This was implemented some time before the ability
9022 to quote keys was made available in &(lsearch)& files. However, the more
9023 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9024 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9025 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9026 converted using colons and not dots.
9027 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9028 addresses are always used.
9029 The latter are converted to IPv4 addresses, in dotted-quad form.
9030
9031 Ideally, it would be nice to tidy up this anomalous situation by changing to
9032 colons in all cases, given that quoting is now available for &(lsearch)&.
9033 However, this would be an incompatible change that might break some existing
9034 configurations.
9035
9036 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9037 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9038 the former case the key strings include the mask value, whereas in the latter
9039 case the IP address is used on its own.
9040
9041
9042
9043 .subsection "Host list patterns that match by host name" SECThoslispatnam
9044 .cindex "host" "lookup failures"
9045 .cindex "unknown host name"
9046 .cindex "host list" "matching host name"
9047 There are several types of pattern that require Exim to know the name of the
9048 remote host. These are either wildcard patterns or lookups by name. (If a
9049 complete hostname is given without any wildcarding, it is used to find an IP
9050 address to match against, as described in section &<<SECThoslispatip>>&
9051 above.)
9052
9053 If the remote host name is not already known when Exim encounters one of these
9054 patterns, it has to be found from the IP address.
9055 Although many sites on the Internet are conscientious about maintaining reverse
9056 DNS data for their hosts, there are also many that do not do this.
9057 Consequently, a name cannot always be found, and this may lead to unwanted
9058 effects. Take care when configuring host lists with wildcarded name patterns.
9059 Consider what will happen if a name cannot be found.
9060
9061 Because of the problems of determining host names from IP addresses, matching
9062 against host names is not as common as matching against IP addresses.
9063
9064 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9065 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9066 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9067 are done can be changed by setting the &%host_lookup_order%& option. For
9068 security, once Exim has found one or more names, it looks up the IP addresses
9069 for these names and compares them with the IP address that it started with.
9070 Only those names whose IP addresses match are accepted. Any other names are
9071 discarded. If no names are left, Exim behaves as if the host name cannot be
9072 found. In the most common case there is only one name and one IP address.
9073
9074 There are some options that control what happens if a host name cannot be
9075 found. These are described in section &<<SECTbehipnot>>& below.
9076
9077 .cindex "host" "alias for"
9078 .cindex "alias for host"
9079 As a result of aliasing, hosts may have more than one name. When processing any
9080 of the following types of pattern, all the host's names are checked:
9081
9082 .ilist
9083 .cindex "asterisk" "in host list"
9084 If a pattern starts with &"*"& the remainder of the item must match the end of
9085 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9086 &'.b.c'&. This special simple form is provided because this is a very common
9087 requirement. Other kinds of wildcarding require the use of a regular
9088 expression.
9089 .next
9090 .cindex "regular expressions" "in host list"
9091 .cindex "host list" "regular expression in"
9092 If the item starts with &"^"& it is taken to be a regular expression which is
9093 matched against the host name. Host names are case-independent, so this regular
9094 expression match is by default case-independent, but you can make it
9095 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9096 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9097 example,
9098 .code
9099 ^(a|b)\.c\.d$
9100 .endd
9101 is a regular expression that matches either of the two hosts &'a.c.d'& or
9102 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9103 that backslash and dollar characters are not misinterpreted as part of the
9104 string expansion. The simplest way to do this is to use &`\N`& to mark that
9105 part of the string as non-expandable. For example:
9106 .code
9107 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9108 .endd
9109 &*Warning*&: If you want to match a complete host name, you must include the
9110 &`$`& terminating metacharacter in the regular expression, as in the above
9111 example. Without it, a match at the start of the host name is all that is
9112 required.
9113 .endlist
9114
9115
9116
9117
9118 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9119 .cindex "host" "lookup failures, permanent"
9120 While processing a host list, Exim may need to look up an IP address from a
9121 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9122 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9123 behaviour when it fails to find the information it is seeking is the same.
9124
9125 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9126 apply to temporary DNS errors, whose handling is described in the next section.
9127
9128 .cindex "&`+include_unknown`&"
9129 .cindex "&`+ignore_unknown`&"
9130 Exim parses a host list from left to right. If it encounters a permanent
9131 lookup failure in any item in the host list before it has found a match,
9132 Exim treats it as a failure and the default behavior is as if the host
9133 does not match the list. This may not always be what you want to happen.
9134 To change Exim's behaviour, the special items &`+include_unknown`& or
9135 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9136 not recognized in an indirected file).
9137
9138 .ilist
9139 If any item that follows &`+include_unknown`& requires information that
9140 cannot found, Exim behaves as if the host does match the list. For example,
9141 .code
9142 host_reject_connection = +include_unknown:*.enemy.ex
9143 .endd
9144 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9145 any hosts whose name it cannot find.
9146
9147 .next
9148 If any item that follows &`+ignore_unknown`& requires information that cannot
9149 be found, Exim ignores that item and proceeds to the rest of the list. For
9150 example:
9151 .code
9152 accept hosts = +ignore_unknown : friend.example : \
9153                192.168.4.5
9154 .endd
9155 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9156 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9157 name can be found for 192.168.4.5, it is rejected.
9158 .endlist
9159
9160 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9161 list. The effect of each one lasts until the next, or until the end of the
9162 list.
9163
9164 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9165          SECTmixwilhos
9166 .cindex "host list" "mixing names and addresses in"
9167
9168 This section explains the host/ip processing logic with the same concepts
9169 as the previous section, but specifically addresses what happens when a
9170 wildcarded hostname is one of the items in the hostlist.
9171
9172 .ilist
9173 If you have name lookups or wildcarded host names and
9174 IP addresses in the same host list, you should normally put the IP
9175 addresses first. For example, in an ACL you could have:
9176 .code
9177 accept hosts = 10.9.8.7 : *.friend.example
9178 .endd
9179 The reason you normally would order it this way lies in the
9180 left-to-right way that Exim processes lists.  It can test IP addresses
9181 without doing any DNS lookups, but when it reaches an item that requires
9182 a host name, it fails if it cannot find a host name to compare with the
9183 pattern. If the above list is given in the opposite order, the
9184 &%accept%& statement fails for a host whose name cannot be found, even
9185 if its IP address is 10.9.8.7.
9186
9187 .next
9188 If you really do want to do the name check first, and still recognize the IP
9189 address, you can rewrite the ACL like this:
9190 .code
9191 accept hosts = *.friend.example
9192 accept hosts = 10.9.8.7
9193 .endd
9194 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9195 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9196 &`+ignore_unknown`&, which was discussed in depth in the first example in
9197 this section.
9198 .endlist
9199
9200
9201 .subsection "Temporary DNS errors when looking up host information" &&&
9202          SECTtemdnserr
9203 .cindex "host" "lookup failures, temporary"
9204 .cindex "&`+include_defer`&"
9205 .cindex "&`+ignore_defer`&"
9206 A temporary DNS lookup failure normally causes a defer action (except when
9207 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9208 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9209 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9210 section. These options should be used with care, probably only in non-critical
9211 host lists such as whitelists.
9212
9213
9214
9215 .subsection "Host list patterns for single-key lookups by host name" &&&
9216          SECThoslispatnamsk
9217 .cindex "unknown host name"
9218 .cindex "host list" "matching host name"
9219 If a pattern is of the form
9220 .display
9221 <&'single-key-search-type'&>;<&'search-data'&>
9222 .endd
9223 for example
9224 .code
9225 dbm;/host/accept/list
9226 .endd
9227 a single-key lookup is performed, using the host name as its key. If the
9228 lookup succeeds, the host matches the item. The actual data that is looked up
9229 is not used.
9230
9231 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9232 keys in the file, not IP addresses. If you want to do lookups based on IP
9233 addresses, you must precede the search type with &"net-"& (see section
9234 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9235 two items in the same list, one doing an address lookup and one doing a name
9236 lookup, both using the same file.
9237
9238
9239
9240 .subsection "Host list patterns for query-style lookups" SECID81
9241 If a pattern is of the form
9242 .display
9243 <&'query-style-search-type'&>;<&'query'&>
9244 .endd
9245 the query is obeyed, and if it succeeds, the host matches the item. The actual
9246 data that is looked up is not used. The variables &$sender_host_address$& and
9247 &$sender_host_name$& can be used in the query. For example:
9248 .code
9249 hosts_lookup = pgsql;\
9250   select ip from hostlist where ip='$sender_host_address'
9251 .endd
9252 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9253 can use the &%sg%& expansion item to change this if you need to. If you want to
9254 use masked IP addresses in database queries, you can use the &%mask%& expansion
9255 operator.
9256
9257 If the query contains a reference to &$sender_host_name$&, Exim automatically
9258 looks up the host name if it has not already done so. (See section
9259 &<<SECThoslispatnam>>& for comments on finding host names.)
9260
9261 Historical note: prior to release 4.30, Exim would always attempt to find a
9262 host name before running the query, unless the search type was preceded by
9263 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9264 still recognized for query-style lookups, but its presence or absence has no
9265 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9266 See section &<<SECThoslispatsikey>>&.)
9267
9268
9269
9270
9271
9272 .section "Address lists" "SECTaddresslist"
9273 .cindex "list" "address list"
9274 .cindex "address list" "empty item"
9275 .cindex "address list" "patterns"
9276 Address lists contain patterns that are matched against mail addresses. There
9277 is one special case to be considered: the sender address of a bounce message is
9278 always empty. You can test for this by providing an empty item in an address
9279 list. For example, you can set up a router to process bounce messages by
9280 using this option setting:
9281 .code
9282 senders = :
9283 .endd
9284 The presence of the colon creates an empty item. If you do not provide any
9285 data, the list is empty and matches nothing. The empty sender can also be
9286 detected by a regular expression that matches an empty string,
9287 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9288
9289 Non-empty items in an address list can be straightforward email addresses. For
9290 example:
9291 .code
9292 senders = jbc@askone.example : hs@anacreon.example
9293 .endd
9294 A certain amount of wildcarding is permitted. If a pattern contains an @
9295 character, but is not a regular expression and does not begin with a
9296 semicolon-terminated lookup type (described below), the local part of the
9297 subject address is compared with the local part of the pattern, which may start
9298 with an asterisk. If the local parts match, the domain is checked in exactly
9299 the same way as for a pattern in a domain list. For example, the domain can be
9300 wildcarded, refer to a named list, or be a lookup:
9301 .code
9302 deny senders = *@*.spamming.site:\
9303                *@+hostile_domains:\
9304                bozo@partial-lsearch;/list/of/dodgy/sites:\
9305                *@dbm;/bad/domains.db
9306 .endd
9307 .cindex "local part" "starting with !"
9308 .cindex "address list" "local part starting with !"
9309 If a local part that begins with an exclamation mark is required, it has to be
9310 specified using a regular expression, because otherwise the exclamation mark is
9311 treated as a sign of negation, as is standard in lists.
9312
9313 If a non-empty pattern that is not a regular expression or a lookup does not
9314 contain an @ character, it is matched against the domain part of the subject
9315 address. The only two formats that are recognized this way are a literal
9316 domain, or a domain pattern that starts with *. In both these cases, the effect
9317 is the same as if &`*@`& preceded the pattern. For example:
9318 .code
9319 deny senders = enemy.domain : *.enemy.domain
9320 .endd
9321
9322 The following kinds of more complicated address list pattern can match any
9323 address, including the empty address that is characteristic of bounce message
9324 senders:
9325
9326 .ilist
9327 .cindex "regular expressions" "in address list"
9328 .cindex "address list" "regular expression in"
9329 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9330 done against the complete address, with the pattern as the regular expression.
9331 You must take care that backslash and dollar characters are not misinterpreted
9332 as part of the string expansion. The simplest way to do this is to use &`\N`&
9333 to mark that part of the string as non-expandable. For example:
9334 .code
9335 deny senders = \N^.*this.*@example\.com$\N : \
9336                \N^\d{8}.+@spamhaus.example$\N : ...
9337 .endd
9338 The &`\N`& sequences are removed by the expansion, so these items do indeed
9339 start with &"^"& by the time they are being interpreted as address patterns.
9340
9341 .next
9342 .cindex "address list" "lookup for complete address"
9343 Complete addresses can be looked up by using a pattern that starts with a
9344 lookup type terminated by a semicolon, followed by the data for the lookup. For
9345 example:
9346 .code
9347 deny senders = cdb;/etc/blocked.senders : \
9348   mysql;select address from blocked where \
9349   address='${quote_mysql:$sender_address}'
9350 .endd
9351 Both query-style and single-key lookup types can be used. For a single-key
9352 lookup type, Exim uses the complete address as the key. However, empty keys are
9353 not supported for single-key lookups, so a match against the empty address
9354 always fails. This restriction does not apply to query-style lookups.
9355
9356 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9357 cannot be used, and is ignored if specified, with an entry being written to the
9358 panic log.
9359 .cindex "*@ with single-key lookup"
9360 However, you can configure lookup defaults, as described in section
9361 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9362 default. For example, with this lookup:
9363 .code
9364 accept senders = lsearch*@;/some/file
9365 .endd
9366 the file could contains lines like this:
9367 .code
9368 user1@domain1.example
9369 *@domain2.example
9370 .endd
9371 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9372 that are tried is:
9373 .code
9374 nimrod@jaeger.example
9375 *@jaeger.example
9376 *
9377 .endd
9378 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9379 would mean that every address matches, thus rendering the test useless.
9380
9381 &*Warning 2*&: Do not confuse these two kinds of item:
9382 .code
9383 deny recipients = dbm*@;/some/file
9384 deny recipients = *@dbm;/some/file
9385 .endd
9386 The first does a whole address lookup, with defaulting, as just described,
9387 because it starts with a lookup type. The second matches the local part and
9388 domain independently, as described in a bullet point below.
9389 .endlist
9390
9391
9392 The following kinds of address list pattern can match only non-empty addresses.
9393 If the subject address is empty, a match against any of these pattern types
9394 always fails.
9395
9396
9397 .ilist
9398 .cindex "@@ with single-key lookup"
9399 .cindex "address list" "@@ lookup type"
9400 .cindex "address list" "split local part and domain"
9401 If a pattern starts with &"@@"& followed by a single-key lookup item
9402 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9403 split into a local part and a domain. The domain is looked up in the file. If
9404 it is not found, there is no match. If it is found, the data that is looked up
9405 from the file is treated as a colon-separated list of local part patterns, each
9406 of which is matched against the subject local part in turn.
9407
9408 .cindex "asterisk" "in address list"
9409 The lookup may be a partial one, and/or one involving a search for a default
9410 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9411 patterns that are looked up can be regular expressions or begin with &"*"&, or
9412 even be further lookups. They may also be independently negated. For example,
9413 with
9414 .code
9415 deny senders = @@dbm;/etc/reject-by-domain
9416 .endd
9417 the data from which the DBM file is built could contain lines like
9418 .code
9419 baddomain.com:  !postmaster : *
9420 .endd
9421 to reject all senders except &%postmaster%& from that domain.
9422
9423 .cindex "local part" "starting with !"
9424 If a local part that actually begins with an exclamation mark is required, it
9425 has to be specified using a regular expression. In &(lsearch)& files, an entry
9426 may be split over several lines by indenting the second and subsequent lines,
9427 but the separating colon must still be included at line breaks. White space
9428 surrounding the colons is ignored. For example:
9429 .code
9430 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9431   spammer3 : spammer4
9432 .endd
9433 As in all colon-separated lists in Exim, a colon can be included in an item by
9434 doubling.
9435
9436 If the last item in the list starts with a right angle-bracket, the remainder
9437 of the item is taken as a new key to look up in order to obtain a continuation
9438 list of local parts. The new key can be any sequence of characters. Thus one
9439 might have entries like
9440 .code
9441 aol.com: spammer1 : spammer 2 : >*
9442 xyz.com: spammer3 : >*
9443 *:       ^\d{8}$
9444 .endd
9445 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9446 local parts for all domains, in addition to the specific local parts listed for
9447 each domain. Of course, using this feature costs another lookup each time a
9448 chain is followed, but the effort needed to maintain the data is reduced.
9449
9450 .cindex "loop" "in lookups"
9451 It is possible to construct loops using this facility, and in order to catch
9452 them, the chains may be no more than fifty items long.
9453
9454 .next
9455 The @@<&'lookup'&> style of item can also be used with a query-style
9456 lookup, but in this case, the chaining facility is not available. The lookup
9457 can only return a single list of local parts.
9458 .endlist
9459
9460 &*Warning*&: There is an important difference between the address list items
9461 in these two examples:
9462 .code
9463 senders = +my_list
9464 senders = *@+my_list
9465 .endd
9466 In the first one, &`my_list`& is a named address list, whereas in the second
9467 example it is a named domain list.
9468
9469
9470
9471
9472 .subsection "Case of letters in address lists" SECTcasletadd
9473 .cindex "case of local parts"
9474 .cindex "address list" "case forcing"
9475 .cindex "case forcing in address lists"
9476 Domains in email addresses are always handled caselessly, but for local parts
9477 case may be significant on some systems (see &%caseful_local_part%& for how
9478 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9479 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9480 blocking lists should be done in a case-independent manner. Since most address
9481 lists in Exim are used for this kind of control, Exim attempts to do this by
9482 default.
9483
9484 The domain portion of an address is always lowercased before matching it to an
9485 address list. The local part is lowercased by default, and any string
9486 comparisons that take place are done caselessly. This means that the data in
9487 the address list itself, in files included as plain filenames, and in any file
9488 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9489 keys in files that are looked up by a search type other than &(lsearch)& (which
9490 works caselessly) must be in lower case, because these lookups are not
9491 case-independent.
9492
9493 .cindex "&`+caseful`&"
9494 To allow for the possibility of caseful address list matching, if an item in
9495 an address list is the string &"+caseful"&, the original case of the local
9496 part is restored for any comparisons that follow, and string comparisons are no
9497 longer case-independent. This does not affect the domain, which remains in
9498 lower case. However, although independent matches on the domain alone are still
9499 performed caselessly, regular expressions that match against an entire address
9500 become case-sensitive after &"+caseful"& has been seen.
9501
9502
9503
9504 .section "Local part lists" "SECTlocparlis"
9505 .cindex "list" "local part list"
9506 .cindex "local part" "list"
9507 These behave in the same way as domain and host lists, with the following
9508 changes:
9509
9510 Case-sensitivity in local part lists is handled in the same way as for address
9511 lists, as just described. The &"+caseful"& item can be used if required. In a
9512 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9513 set false, the subject is lowercased and the matching is initially
9514 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9515 matching in the local part list, but not elsewhere in the router. If
9516 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9517 option is case-sensitive from the start.
9518
9519 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9520 comments are handled in the same way as address lists &-- they are recognized
9521 only if the # is preceded by white space or the start of the line.
9522 Otherwise, local part lists are matched in the same way as domain lists, except
9523 that the special items that refer to the local host (&`@`&, &`@[]`&,
9524 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9525 Refer to section &<<SECTdomainlist>>& for details of the other available item
9526 types.
9527 .ecindex IIDdohoadli
9528
9529
9530
9531
9532 . ////////////////////////////////////////////////////////////////////////////
9533 . ////////////////////////////////////////////////////////////////////////////
9534
9535 .chapter "String expansions" "CHAPexpand"
9536 .scindex IIDstrexp "expansion" "of strings"
9537 Many strings in Exim's runtime configuration are expanded before use. Some of
9538 them are expanded every time they are used; others are expanded only once.
9539
9540 When a string is being expanded it is copied verbatim from left to right except
9541 .cindex expansion "string concatenation"
9542 when a dollar or backslash character is encountered. A dollar specifies the
9543 start of a portion of the string that is interpreted and replaced as described
9544 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9545 escape character, as described in the following section.
9546
9547 .cindex "tainted data" tracking
9548 If any porttion of the result string is tainted, the entire result is.
9549
9550 Whether a string is expanded depends upon the context.  Usually this is solely
9551 dependent upon the option for which a value is sought; in this documentation,
9552 options for which string expansion is performed are marked with &dagger; after
9553 the data type.  ACL rules always expand strings.  A couple of expansion
9554 conditions do not expand some of the brace-delimited branches, for security
9555 reasons,
9556 .cindex "tainted data" expansion
9557 .cindex "tainted data" definition
9558 .cindex expansion "tainted data"
9559 and expansion of data deriving from the sender (&"tainted data"&)
9560 is not permitted (including acessing a file using a tainted name).
9561
9562 Common ways of obtaining untainted equivalents of variables with
9563 tainted values
9564 .cindex "tainted data" "de-tainting"
9565 come down to using the tainted value as a lookup key in a trusted database.
9566 This database could be the filesystem structure,
9567 or the password file,
9568 or accessed via a DBMS.
9569 Specific methods are indexed under &"de-tainting"&.
9570
9571
9572
9573 .section "Literal text in expanded strings" "SECTlittext"
9574 .cindex "expansion" "including literal text"
9575 An uninterpreted dollar can be included in an expanded string by putting a
9576 backslash in front of it. A backslash can be used to prevent any special
9577 character being treated specially in an expansion, including backslash itself.
9578 If the string appears in quotes in the configuration file, two backslashes are
9579 required because the quotes themselves cause interpretation of backslashes when
9580 the string is read in (see section &<<SECTstrings>>&).
9581
9582 .cindex "expansion" "non-expandable substrings"
9583 A portion of the string can specified as non-expandable by placing it between
9584 two occurrences of &`\N`&. This is particularly useful for protecting regular
9585 expressions, which often contain backslashes and dollar signs. For example:
9586 .code
9587 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9588 .endd
9589 On encountering the first &`\N`&, the expander copies subsequent characters
9590 without interpretation until it reaches the next &`\N`& or the end of the
9591 string.
9592
9593
9594
9595 .section "Character escape sequences in expanded strings" "SECID82"
9596 .cindex "expansion" "escape sequences"
9597 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9598 expanded string is recognized as an escape sequence for the character newline,
9599 carriage return, or tab, respectively. A backslash followed by up to three
9600 octal digits is recognized as an octal encoding for a single character, and a
9601 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9602 encoding.
9603
9604 These escape sequences are also recognized in quoted strings when they are read
9605 in. Their interpretation in expansions as well is useful for unquoted strings,
9606 and for other cases such as looked-up strings that are then expanded.
9607
9608
9609 .section "Testing string expansions" "SECID83"
9610 .cindex "expansion" "testing"
9611 .cindex "testing" "string expansion"
9612 .oindex "&%-be%&"
9613 Many expansions can be tested by calling Exim with the &%-be%& option. This
9614 takes the command arguments, or lines from the standard input if there are no
9615 arguments, runs them through the string expansion code, and writes the results
9616 to the standard output. Variables based on configuration values are set up, but
9617 since no message is being processed, variables such as &$local_part$& have no
9618 value. Nevertheless the &%-be%& option can be useful for checking out file and
9619 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9620 and &%nhash%&.
9621
9622 When reading lines from the standard input,
9623 macros can be defined and ACL variables can be set.
9624 For example:
9625 .code
9626 MY_MACRO = foo
9627 set acl_m_myvar = bar
9628 .endd
9629 Such macros and variables can then be used in later input lines.
9630
9631 Exim gives up its root privilege when it is called with the &%-be%& option, and
9632 instead runs under the uid and gid it was called with, to prevent users from
9633 using &%-be%& for reading files to which they do not have access.
9634
9635 .oindex "&%-bem%&"
9636 If you want to test expansions that include variables whose values are taken
9637 from a message, there are two other options that can be used. The &%-bem%&
9638 option is like &%-be%& except that it is followed by a filename. The file is
9639 read as a message before doing the test expansions. For example:
9640 .code
9641 exim -bem /tmp/test.message '$h_subject:'
9642 .endd
9643 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9644 Exim message identifier. For example:
9645 .code
9646 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9647 .endd
9648 This loads the message from Exim's spool before doing the test expansions, and
9649 is therefore restricted to admin users.
9650
9651
9652 .section "Forced expansion failure" "SECTforexpfai"
9653 .cindex "expansion" "forced failure"
9654 A number of expansions that are described in the following section have
9655 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9656 (which are sometimes called &"curly brackets"&). Which of the two strings is
9657 used depends on some condition that is evaluated as part of the expansion. If,
9658 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9659 the entire string expansion fails in a way that can be detected by the code
9660 that requested the expansion. This is called &"forced expansion failure"&, and
9661 its consequences depend on the circumstances. In some cases it is no different
9662 from any other expansion failure, but in others a different action may be
9663 taken. Such variations are mentioned in the documentation of the option that is
9664 being expanded.
9665
9666
9667
9668
9669 .section "Expansion items" "SECTexpansionitems"
9670 The following items are recognized in expanded strings. White space may be used
9671 between sub-items that are keywords or substrings enclosed in braces inside an
9672 outer set of braces, to improve readability. &*Warning*&: Within braces,
9673 white space is significant.
9674
9675 .vlist
9676 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9677 .cindex "expansion" "variables"
9678 Substitute the contents of the named variable, for example:
9679 .code
9680 $local_part
9681 ${domain}
9682 .endd
9683 The second form can be used to separate the name from subsequent alphanumeric
9684 characters. This form (using braces) is available only for variables; it does
9685 &'not'& apply to message headers. The names of the variables are given in
9686 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9687 given, the expansion fails.
9688
9689 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9690 .cindex "expansion" "operators"
9691 The string is first itself expanded, and then the operation specified by
9692 <&'op'&> is applied to it. For example:
9693 .code
9694 ${lc:$local_part}
9695 .endd
9696 The string starts with the first character after the colon, which may be
9697 leading white space. A list of operators is given in section &<<SECTexpop>>&
9698 below. The operator notation is used for simple expansion items that have just
9699 one argument, because it reduces the number of braces and therefore makes the
9700 string easier to understand.
9701
9702 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9703 This item inserts &"basic"& header lines. It is described with the &%header%&
9704 expansion item below.
9705
9706
9707 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9708 .cindex "expansion" "calling an acl"
9709 .cindex "&%acl%&" "call from expansion"
9710 The name and zero to nine argument strings are first expanded separately.  The expanded
9711 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9712 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9713 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9714 and may use the variables; if another acl expansion is used the values
9715 are restored after it returns.  If the ACL sets
9716 a value using a "message =" modifier and returns accept or deny, the value becomes
9717 the result of the expansion.
9718 If no message is set and the ACL returns accept or deny
9719 the expansion result is an empty string.
9720 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9721
9722
9723 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9724 .cindex authentication "results header"
9725 .chindex Authentication-Results:
9726 .cindex authentication "expansion item"
9727 This item returns a string suitable for insertion as an
9728 &'Authentication-Results:'&
9729 header line.
9730 The given <&'authserv-id'&> is included in the result; typically this
9731 will be a domain name identifying the system performing the authentications.
9732 Methods that might be present in the result include:
9733 .code
9734 none
9735 iprev
9736 auth
9737 spf
9738 dkim
9739 .endd
9740
9741 Example use (as an ACL modifier):
9742 .code
9743       add_header = :at_start:${authresults {$primary_hostname}}
9744 .endd
9745 This is safe even if no authentication results are available
9746 and would generally be placed in the DATA ACL.
9747
9748
9749 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9750        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9751 .cindex "expansion" "extracting certificate fields"
9752 .cindex "&%certextract%&" "certificate fields"
9753 .cindex "certificate" "extracting fields"
9754 The <&'certificate'&> must be a variable of type certificate.
9755 The field name is expanded and used to retrieve the relevant field from
9756 the certificate.  Supported fields are:
9757 .display
9758 &`version        `&
9759 &`serial_number  `&
9760 &`subject        `& RFC4514 DN
9761 &`issuer         `& RFC4514 DN
9762 &`notbefore      `& time
9763 &`notafter       `& time
9764 &`sig_algorithm  `&
9765 &`signature      `&
9766 &`subj_altname   `& tagged list
9767 &`ocsp_uri       `& list
9768 &`crl_uri        `& list
9769 .endd
9770 If the field is found,
9771 <&'string2'&> is expanded, and replaces the whole item;
9772 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9773 variable &$value$& contains the value that has been extracted. Afterwards, it
9774 is restored to any previous value it might have had.
9775
9776 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9777 key is not found. If {<&'string2'&>} is also omitted, the value that was
9778 extracted is used.
9779
9780 Some field names take optional modifiers, appended and separated by commas.
9781
9782 The field selectors marked as "RFC4514" above
9783 output a Distinguished Name string which is
9784 not quite
9785 parseable by Exim as a comma-separated tagged list
9786 (the exceptions being elements containing commas).
9787 RDN elements of a single type may be selected by
9788 a modifier of the type label; if so the expansion
9789 result is a list (newline-separated by default).
9790 The separator may be changed by another modifier of
9791 a right angle-bracket followed immediately by the new separator.
9792 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9793
9794 The field selectors marked as "time" above
9795 take an optional modifier of "int"
9796 for which the result is the number of seconds since epoch.
9797 Otherwise the result is a human-readable string
9798 in the timezone selected by the main "timezone" option.
9799
9800 The field selectors marked as "list" above return a list,
9801 newline-separated by default,
9802 (embedded separator characters in elements are doubled).
9803 The separator may be changed by a modifier of
9804 a right angle-bracket followed immediately by the new separator.
9805
9806 The field selectors marked as "tagged" above
9807 prefix each list element with a type string and an equals sign.
9808 Elements of only one type may be selected by a modifier
9809 which is one of "dns", "uri" or "mail";
9810 if so the element tags are omitted.
9811
9812 If not otherwise noted field values are presented in human-readable form.
9813
9814 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9815        {*&<&'arg'&>&*}...}*&"
9816 .cindex &%dlfunc%&
9817 This expansion dynamically loads and then calls a locally-written C function.
9818 This functionality is available only if Exim is compiled with
9819 .code
9820 EXPAND_DLFUNC=yes
9821 .endd
9822 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9823 object so that it doesn't reload the same object file in the same Exim process
9824 (but of course Exim does start new processes frequently).
9825
9826 There may be from zero to eight arguments to the function.
9827
9828 When compiling
9829 a local function that is to be called in this way,
9830 first &_DLFUNC_IMPL_& should be defined,
9831 and second &_local_scan.h_& should be included.
9832 The Exim variables and functions that are defined by that API
9833 are also available for dynamically loaded functions. The function itself
9834 must have the following type:
9835 .code
9836 int dlfunction(uschar **yield, int argc, uschar *argv[])
9837 .endd
9838 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9839 function should return one of the following values:
9840
9841 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9842 into the expanded string that is being built.
9843
9844 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9845 from &'yield'&, if it is set.
9846
9847 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9848 taken from &'yield'& if it is set.
9849
9850 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9851
9852 When compiling a function that is to be used in this way with gcc,
9853 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9854 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9855
9856
9857 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9858 .cindex "expansion" "extracting value from environment"
9859 .cindex "environment" "values from"
9860 The key is first expanded separately, and leading and trailing white space
9861 removed.
9862 This is then searched for as a name in the environment.
9863 If a variable is found then its value is placed in &$value$&
9864 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9865
9866 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9867 appear, for example:
9868 .code
9869 ${env{USER}{$value} fail }
9870 .endd
9871 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9872 {<&'string1'&>} must be present for &"fail"& to be recognized.
9873
9874 If {<&'string2'&>} is omitted an empty string is substituted on
9875 search failure.
9876 If {<&'string1'&>} is omitted the search result is substituted on
9877 search success.
9878
9879 The environment is adjusted by the &%keep_environment%& and
9880 &%add_environment%& main section options.
9881
9882
9883 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9884        {*&<&'string3'&>&*}}*&"
9885 .cindex "expansion" "extracting substrings by key"
9886 .cindex "&%extract%&" "substrings by key"
9887 The key and <&'string1'&> are first expanded separately. Leading and trailing
9888 white space is removed from the key (but not from any of the strings). The key
9889 must not be empty and must not consist entirely of digits.
9890 The expanded <&'string1'&> must be of the form:
9891 .display
9892 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9893 .endd
9894 .vindex "&$value$&"
9895 where the equals signs and spaces (but not both) are optional. If any of the
9896 values contain white space, they must be enclosed in double quotes, and any
9897 values that are enclosed in double quotes are subject to escape processing as
9898 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9899 for the value that corresponds to the key. The search is case-insensitive. If
9900 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9901 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9902 variable &$value$& contains the value that has been extracted. Afterwards, it
9903 is restored to any previous value it might have had.
9904
9905 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9906 key is not found. If {<&'string2'&>} is also omitted, the value that was
9907 extracted is used. Thus, for example, these two expansions are identical, and
9908 yield &"2001"&:
9909 .code
9910 ${extract{gid}{uid=1984 gid=2001}}
9911 ${extract{gid}{uid=1984 gid=2001}{$value}}
9912 .endd
9913 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9914 appear, for example:
9915 .code
9916 ${extract{Z}{A=... B=...}{$value} fail }
9917 .endd
9918 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9919 {<&'string2'&>} must be present for &"fail"& to be recognized.
9920
9921 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9922        {*&<&'string3'&>&*}}*&" &&&
9923        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9924        {*&<&'string3'&>&*}}*&"
9925 .cindex "expansion" "extracting from JSON object"
9926 .cindex JSON expansions
9927 The key and <&'string1'&> are first expanded separately. Leading and trailing
9928 white space is removed from the key (but not from any of the strings). The key
9929 must not be empty and must not consist entirely of digits.
9930 The expanded <&'string1'&> must be of the form:
9931 .display
9932 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9933 .endd
9934 .vindex "&$value$&"
9935 The braces, commas and colons, and the quoting of the member name are required;
9936 the spaces are optional.
9937 Matching of the key against the member names is done case-sensitively.
9938 For the &"json"& variant,
9939 if a returned value is a JSON string, it retains its leading and
9940 trailing quotes.
9941 For the &"jsons"& variant, which is intended for use with JSON strings, the
9942 leading and trailing quotes are removed from the returned value.
9943 . XXX should be a UTF-8 compare
9944
9945 The results of matching are handled as above.
9946
9947
9948 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9949         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9950 .cindex "expansion" "extracting substrings by number"
9951 .cindex "&%extract%&" "substrings by number"
9952 The <&'number'&> argument must consist entirely of decimal digits,
9953 apart from leading and trailing white space, which is ignored.
9954 This is what distinguishes this form of &%extract%& from the previous kind. It
9955 behaves in the same way, except that, instead of extracting a named field, it
9956 extracts from <&'string1'&> the field whose number is given as the first
9957 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9958 <&'string3'&> as before.
9959
9960 The fields in the string are separated by any one of the characters in the
9961 separator string. These may include space or tab characters.
9962 The first field is numbered one. If the number is negative, the fields are
9963 counted from the end of the string, with the rightmost one numbered -1. If the
9964 number given is zero, the entire string is returned. If the modulus of the
9965 number is greater than the number of fields in the string, the result is the
9966 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9967 provided. For example:
9968 .code
9969 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9970 .endd
9971 yields &"42"&, and
9972 .code
9973 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9974 .endd
9975 yields &"99"&. Two successive separators mean that the field between them is
9976 empty (for example, the fifth field above).
9977
9978
9979 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9980         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9981        "&*${extract jsons{*&<&'number'&>&*}}&&&
9982         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9983 .cindex "expansion" "extracting from JSON array"
9984 .cindex JSON expansions
9985 The <&'number'&> argument must consist entirely of decimal digits,
9986 apart from leading and trailing white space, which is ignored.
9987
9988 Field selection and result handling is as above;
9989 there is no choice of field separator.
9990 For the &"json"& variant,
9991 if a returned value is a JSON string, it retains its leading and
9992 trailing quotes.
9993 For the &"jsons"& variant, which is intended for use with JSON strings, the
9994 leading and trailing quotes are removed from the returned value.
9995
9996
9997 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9998 .cindex "list" "selecting by condition"
9999 .cindex "expansion" "selecting from list by condition"
10000 .vindex "&$item$&"
10001 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10002 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10003 For each item
10004 in this list, its value is placed in &$item$&, and then the condition is
10005 evaluated.
10006 Any modification of &$value$& by this evaluation is discarded.
10007 If the condition is true, &$item$& is added to the output as an
10008 item in a new list; if the condition is false, the item is discarded. The
10009 separator used for the output list is the same as the one used for the
10010 input, but a separator setting is not included in the output. For example:
10011 .code
10012 ${filter{a:b:c}{!eq{$item}{b}}}
10013 .endd
10014 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10015 to what it was before.
10016 See also the &%map%& and &%reduce%& expansion items.
10017
10018
10019 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10020 .cindex "hash function" "textual"
10021 .cindex "expansion" "textual hash"
10022 This is a textual hashing function, and was the first to be implemented in
10023 early versions of Exim. In current releases, there are other hashing functions
10024 (numeric, MD5, and SHA-1), which are described below.
10025
10026 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10027 <&'n'&>. If you are using fixed values for these numbers, that is, if
10028 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10029 use the simpler operator notation that avoids some of the braces:
10030 .code
10031 ${hash_<n>_<m>:<string>}
10032 .endd
10033 The second number is optional (in both notations). If <&'n'&> is greater than
10034 or equal to the length of the string, the expansion item returns the string.
10035 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10036 function to the string. The new string consists of characters taken from the
10037 first <&'m'&> characters of the string
10038 .code
10039 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10040 .endd
10041 If <&'m'&> is not present the value 26 is used, so that only lower case
10042 letters appear. For example:
10043 .display
10044 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10045 &`$hash{5}{monty}}           `&   yields  &`monty`&
10046 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10047 .endd
10048
10049 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10050         &*$h_*&<&'header&~name'&>&*:*&" &&&
10051        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10052         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10053        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10054         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10055        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10056         &*$rh_*&<&'header&~name'&>&*:*&"
10057 .cindex "expansion" "header insertion"
10058 .vindex "&$header_$&"
10059 .vindex "&$bheader_$&"
10060 .vindex "&$lheader_$&"
10061 .vindex "&$rheader_$&"
10062 .cindex "header lines" "in expansion strings"
10063 .cindex "header lines" "character sets"
10064 .cindex "header lines" "decoding"
10065 Substitute the contents of the named message header line, for example
10066 .code
10067 $header_reply-to:
10068 .endd
10069 The newline that terminates a header line is not included in the expansion, but
10070 internal newlines (caused by splitting the header line over several physical
10071 lines) may be present.
10072
10073 The difference between the four pairs of expansions is in the way
10074 the data in the header line is interpreted.
10075
10076 .ilist
10077 .cindex "white space" "in header lines"
10078 &%rheader%& gives the original &"raw"& content of the header line, with no
10079 processing at all, and without the removal of leading and trailing white space.
10080
10081 .next
10082 .cindex "list" "of header lines"
10083 &%lheader%& gives a colon-separated list, one element per header when there
10084 are multiple headers with a given name.
10085 Any embedded colon characters within an element are doubled, so normal Exim
10086 list-processing facilities can be used.
10087 The terminating newline of each element is removed; in other respects
10088 the content is &"raw"&.
10089
10090 .next
10091 .cindex "base64 encoding" "in header lines"
10092 &%bheader%& removes leading and trailing white space, and then decodes base64
10093 or quoted-printable MIME &"words"& within the header text, but does no
10094 character set translation. If decoding of what looks superficially like a MIME
10095 &"word"& fails, the raw string is returned. If decoding
10096 .cindex "binary zero" "in header line"
10097 produces a binary zero character, it is replaced by a question mark &-- this is
10098 what Exim does for binary zeros that are actually received in header lines.
10099
10100 .next
10101 &%header%& tries to translate the string as decoded by &%bheader%& to a
10102 standard character set. This is an attempt to produce the same string as would
10103 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10104 returned. Translation is attempted only on operating systems that support the
10105 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10106 a system Makefile or in &_Local/Makefile_&.
10107 .endlist ilist
10108
10109 In a filter file, the target character set for &%header%& can be specified by a
10110 command of the following form:
10111 .code
10112 headers charset "UTF-8"
10113 .endd
10114 This command affects all references to &$h_$& (or &$header_$&) expansions in
10115 subsequently obeyed filter commands. In the absence of this command, the target
10116 character set in a filter is taken from the setting of the &%headers_charset%&
10117 option in the runtime configuration. The value of this option defaults to the
10118 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10119 ISO-8859-1.
10120
10121 Header names follow the syntax of RFC 2822, which states that they may contain
10122 any printing characters except space and colon. Consequently, curly brackets
10123 &'do not'& terminate header names, and should not be used to enclose them as
10124 if they were variables. Attempting to do so causes a syntax error.
10125
10126 Only header lines that are common to all copies of a message are visible to
10127 this mechanism. These are the original header lines that are received with the
10128 message, and any that are added by an ACL statement or by a system
10129 filter. Header lines that are added to a particular copy of a message by a
10130 router or transport are not accessible.
10131
10132 For incoming SMTP messages, no header lines are visible in
10133 ACLs that are obeyed before the data phase completes,
10134 because the header structure is not set up until the message is received.
10135 They are visible in DKIM, PRDR and DATA ACLs.
10136 Header lines that are added in a RCPT ACL (for example)
10137 are saved until the message's incoming header lines are available, at which
10138 point they are added.
10139 When any of the above ACLs are
10140 running, however, header lines added by earlier ACLs are visible.
10141
10142 Upper case and lower case letters are synonymous in header names. If the
10143 following character is white space, the terminating colon may be omitted, but
10144 this is not recommended, because you may then forget it when it is needed. When
10145 white space terminates the header name, this white space is included in the
10146 expanded string.  If the message does not contain the given header, the
10147 expansion item is replaced by an empty string. (See the &%def%& condition in
10148 section &<<SECTexpcond>>& for a means of testing for the existence of a
10149 header.)
10150
10151 If there is more than one header with the same name, they are all concatenated
10152 to form the substitution string, up to a maximum length of 64K. Unless
10153 &%rheader%& is being used, leading and trailing white space is removed from
10154 each header before concatenation, and a completely empty header is ignored. A
10155 newline character is then inserted between non-empty headers, but there is no
10156 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10157 those headers that contain lists of addresses, a comma is also inserted at the
10158 junctions between headers. This does not happen for the &%rheader%& expansion.
10159
10160 .cindex "tainted data" "message headers"
10161 When the headers are from an incoming message,
10162 the result of expanding any of these variables is tainted.
10163
10164
10165 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10166 .cindex "expansion" "hmac hashing"
10167 .cindex &%hmac%&
10168 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10169 shared secret and some text into a message authentication code, as specified in
10170 RFC 2104. This differs from &`${md5:secret_text...}`& or
10171 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10172 cryptographic hash, allowing for authentication that is not possible with MD5
10173 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10174 present. For example:
10175 .code
10176 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10177 .endd
10178 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10179 produces:
10180 .code
10181 dd97e3ba5d1a61b5006108f8c8252953
10182 .endd
10183 As an example of how this might be used, you might put in the main part of
10184 an Exim configuration:
10185 .code
10186 SPAMSCAN_SECRET=cohgheeLei2thahw
10187 .endd
10188 In a router or a transport you could then have:
10189 .code
10190 headers_add = \
10191   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10192   ${hmac{md5}{SPAMSCAN_SECRET}\
10193   {${primary_hostname},${message_exim_id},$h_message-id:}}
10194 .endd
10195 Then given a message, you can check where it was scanned by looking at the
10196 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10197 this header line is authentic by recomputing the authentication code from the
10198 host name, message ID and the &'Message-id:'& header line. This can be done
10199 using Exim's &%-be%& option, or by other means, for example, by using the
10200 &'hmac_md5_hex()'& function in Perl.
10201
10202
10203 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10204 .cindex "expansion" "conditional"
10205 .cindex "&%if%&, expansion item"
10206 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10207 item; otherwise <&'string2'&> is used. The available conditions are described
10208 in section &<<SECTexpcond>>& below. For example:
10209 .code
10210 ${if eq {$local_part}{postmaster} {yes}{no} }
10211 .endd
10212 The second string need not be present; if it is not and the condition is not
10213 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10214 be present instead of the second string (without any curly brackets). In this
10215 case, the expansion is forced to fail if the condition is not true (see section
10216 &<<SECTforexpfai>>&).
10217
10218 If both strings are omitted, the result is the string &`true`& if the condition
10219 is true, and the empty string if the condition is false. This makes it less
10220 cumbersome to write custom ACL and router conditions. For example, instead of
10221 .code
10222 condition = ${if >{$acl_m4}{3}{true}{false}}
10223 .endd
10224 you can use
10225 .code
10226 condition = ${if >{$acl_m4}{3}}
10227 .endd
10228
10229
10230
10231 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10232 .cindex expansion "imap folder"
10233 .cindex "&%imapfolder%& expansion item"
10234 This item converts a (possibly multilevel, or with non-ASCII characters)
10235 folder specification to a Maildir name for filesystem use.
10236 For information on internationalisation support see &<<SECTi18nMDA>>&.
10237
10238
10239
10240 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10241 .cindex "expansion" "string truncation"
10242 .cindex "&%length%& expansion item"
10243 The &%length%& item is used to extract the initial portion of a string. Both
10244 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10245 you are using a fixed value for the number, that is, if <&'string1'&> does not
10246 change when expanded, you can use the simpler operator notation that avoids
10247 some of the braces:
10248 .code
10249 ${length_<n>:<string>}
10250 .endd
10251 The result of this item is either the first <&'n'&> bytes or the whole
10252 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10253 &%strlen%&, which gives the length of a string.
10254 All measurement is done in bytes and is not UTF-8 aware.
10255
10256
10257 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10258         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10259 .cindex "expansion" "extracting list elements by number"
10260 .cindex "&%listextract%&" "extract list elements by number"
10261 .cindex "list" "extracting elements by number"
10262 The <&'number'&> argument must consist entirely of decimal digits,
10263 apart from an optional leading minus,
10264 and leading and trailing white space (which is ignored).
10265
10266 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10267 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10268
10269 The first field of the list is numbered one.
10270 If the number is negative, the fields are
10271 counted from the end of the list, with the rightmost one numbered -1.
10272 The numbered element of the list is extracted and placed in &$value$&,
10273 then <&'string2'&> is expanded as the result.
10274
10275 If the modulus of the
10276 number is zero or greater than the number of fields in the string,
10277 the result is the expansion of <&'string3'&>.
10278
10279 For example:
10280 .code
10281 ${listextract{2}{x:42:99}}
10282 .endd
10283 yields &"42"&, and
10284 .code
10285 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10286 .endd
10287 yields &"result: 42"&.
10288
10289 If {<&'string3'&>} is omitted, an empty string is used for string3.
10290 If {<&'string2'&>} is also omitted, the value that was
10291 extracted is used.
10292 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10293
10294
10295 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10296 .cindex quoting "for list"
10297 .cindex list quoting
10298 This item doubles any occurrence of the separator character
10299 in the given string.
10300 An empty string is replaced with a single space.
10301 This converts the string into a safe form for use as a list element,
10302 in a list using the given separator.
10303
10304
10305 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10306         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10307        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10308         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10309 .cindex "expansion" "lookup in"
10310 .cindex "file" "lookups"
10311 .cindex "lookup" "in expanded string"
10312 The two forms of lookup item specify data lookups in files and databases, as
10313 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10314 lookups, and the second is used for query-style lookups. The <&'key'&>,
10315 <&'file'&>, and <&'query'&> strings are expanded before use.
10316
10317 If there is any white space in a lookup item which is part of a filter command,
10318 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10319 other place where white space is significant, the lookup item must be enclosed
10320 in double quotes. The use of data lookups in users' filter files may be locked
10321 out by the system administrator.
10322
10323 .vindex "&$value$&"
10324 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10325 During its expansion, the variable &$value$& contains the data returned by the
10326 lookup. Afterwards it reverts to the value it had previously (at the outer
10327 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10328 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10329 string on failure. If <&'string2'&> is provided, it can itself be a nested
10330 lookup, thus providing a mechanism for looking up a default value when the
10331 original lookup fails.
10332
10333 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10334 data for the outer lookup while the parameters of the second lookup are
10335 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10336 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10337 appear, and in this case, if the lookup fails, the entire expansion is forced
10338 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10339 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10340 successful lookup, and nothing in the case of failure.
10341
10342 For single-key lookups, the string &"partial"& is permitted to precede the
10343 search type in order to do partial matching, and * or *@ may follow a search
10344 type to request default lookups if the key does not match (see sections
10345 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10346
10347 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10348 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10349 and non-wild parts of the key during the expansion of the replacement text.
10350 They return to their previous values at the end of the lookup item.
10351
10352 This example looks up the postmaster alias in the conventional alias file:
10353 .code
10354 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10355 .endd
10356 This example uses NIS+ to look up the full name of the user corresponding to
10357 the local part of an address, forcing the expansion to fail if it is not found:
10358 .code
10359 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10360   {$value}fail}
10361 .endd
10362
10363
10364 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10365 .cindex "expansion" "list creation"
10366 .vindex "&$item$&"
10367 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10368 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10369 For each item
10370 in this list, its value is place in &$item$&, and then <&'string2'&> is
10371 expanded and added to the output as an item in a new list. The separator used
10372 for the output list is the same as the one used for the input, but a separator
10373 setting is not included in the output. For example:
10374 .code
10375 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10376 .endd
10377 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10378 value of &$item$& is restored to what it was before. See also the &%filter%&
10379 and &%reduce%& expansion items.
10380
10381 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10382 .cindex "expansion" "numeric hash"
10383 .cindex "hash function" "numeric"
10384 The three strings are expanded; the first two must yield numbers. Call them
10385 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10386 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10387 can use the simpler operator notation that avoids some of the braces:
10388 .code
10389 ${nhash_<n>_<m>:<string>}
10390 .endd
10391 The second number is optional (in both notations). If there is only one number,
10392 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10393 processed by a div/mod hash function that returns two numbers, separated by a
10394 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10395 example,
10396 .code
10397 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10398 .endd
10399 returns the string &"6/33"&.
10400
10401
10402
10403 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10404 .cindex "Perl" "use in expanded string"
10405 .cindex "expansion" "calling Perl from"
10406 This item is available only if Exim has been built to include an embedded Perl
10407 interpreter. The subroutine name and the arguments are first separately
10408 expanded, and then the Perl subroutine is called with those arguments. No
10409 additional arguments need be given; the maximum number permitted, including the
10410 name of the subroutine, is nine.
10411
10412 The return value of the subroutine is inserted into the expanded string, unless
10413 the return value is &%undef%&. In that case, the entire expansion is
10414 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10415 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10416 in a scalar context, thus the return value is a scalar.  For example, if you
10417 return a Perl vector, the return value is the size of the vector,
10418 not its contents.
10419
10420 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10421 with the error message that was passed to &%die%&. More details of the embedded
10422 Perl facility are given in chapter &<<CHAPperl>>&.
10423
10424 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10425 out the use of this expansion item in filter files.
10426
10427
10428 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10429 .cindex "&%prvs%& expansion item"
10430 The first argument is a complete email address and the second is secret
10431 keystring. The third argument, specifying a key number, is optional. If absent,
10432 it defaults to 0. The result of the expansion is a prvs-signed email address,
10433 to be typically used with the &%return_path%& option on an &(smtp)& transport
10434 as part of a bounce address tag validation (BATV) scheme. For more discussion
10435 and an example, see section &<<SECTverifyPRVS>>&.
10436
10437 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10438         {*&<&'string'&>&*}}*&"
10439 .cindex "&%prvscheck%& expansion item"
10440 This expansion item is the complement of the &%prvs%& item. It is used for
10441 checking prvs-signed addresses. If the expansion of the first argument does not
10442 yield a syntactically valid prvs-signed address, the whole item expands to the
10443 empty string. When the first argument does expand to a syntactically valid
10444 prvs-signed address, the second argument is expanded, with the prvs-decoded
10445 version of the address and the key number extracted from the address in the
10446 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10447
10448 These two variables can be used in the expansion of the second argument to
10449 retrieve the secret. The validity of the prvs-signed address is then checked
10450 against the secret. The result is stored in the variable &$prvscheck_result$&,
10451 which is empty for failure or &"1"& for success.
10452
10453 The third argument is optional; if it is missing, it defaults to an empty
10454 string. This argument is now expanded. If the result is an empty string, the
10455 result of the expansion is the decoded version of the address. This is the case
10456 whether or not the signature was valid. Otherwise, the result of the expansion
10457 is the expansion of the third argument.
10458
10459 All three variables can be used in the expansion of the third argument.
10460 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10461 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10462
10463 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10464 .cindex "expansion" "inserting an entire file"
10465 .cindex "file" "inserting into expansion"
10466 .cindex "&%readfile%& expansion item"
10467 The filename and end-of-line (eol) string are first expanded separately. The file is
10468 then read, and its contents replace the entire item. All newline characters in
10469 the file are replaced by the end-of-line string if it is present. Otherwise,
10470 newlines are left in the string.
10471 String expansion is not applied to the contents of the file. If you want this,
10472 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10473 the string expansion fails.
10474
10475 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10476 locks out the use of this expansion item in filter files.
10477
10478
10479
10480 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10481         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10482 .cindex "expansion" "inserting from a socket"
10483 .cindex "socket, use of in expansion"
10484 .cindex "&%readsocket%& expansion item"
10485 This item inserts data from a Unix domain or TCP socket into the expanded
10486 string. The minimal way of using it uses just two arguments, as in these
10487 examples:
10488 .code
10489 ${readsocket{/socket/name}{request string}}
10490 ${readsocket{inet:some.host:1234}{request string}}
10491 .endd
10492 For a Unix domain socket, the first substring must be the path to the socket.
10493 For an Internet socket, the first substring must contain &`inet:`& followed by
10494 a host name or IP address, followed by a colon and a port, which can be a
10495 number or the name of a TCP port in &_/etc/services_&. An IP address may
10496 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10497 example:
10498 .code
10499 ${readsocket{inet:[::1]:1234}{request string}}
10500 .endd
10501 Only a single host name may be given, but if looking it up yields more than
10502 one IP address, they are each tried in turn until a connection is made. For
10503 both kinds of socket, Exim makes a connection, writes the request string
10504 (unless it is an empty string; no terminating NUL is ever sent)
10505 and reads from the socket until an end-of-file
10506 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10507 extend what can be done. Firstly, you can vary the timeout. For example:
10508 .code
10509 ${readsocket{/socket/name}{request string}{3s}}
10510 .endd
10511
10512 The third argument is a list of options, of which the first element is the timeout
10513 and must be present if any options are given.
10514 Further elements are options of form &'name=value'&.
10515 Example:
10516 .code
10517 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10518 .endd
10519
10520 The following option names are recognised:
10521 .ilist
10522 &*cache*&
10523 Defines if the result data can be cached for use by a later identical
10524 request in the same process.
10525 Values are &"yes"& or &"no"& (the default).
10526 If not, all cached results for this connection specification
10527 will be invalidated.
10528
10529 .next
10530 &*shutdown*&
10531 Defines whether or not a write-shutdown is done on the connection after
10532 sending the request. Values are &"yes"& (the default) or &"no"&
10533 (preferred, eg. by some webservers).
10534
10535 .next
10536 &*sni*&
10537 Controls the use of Server Name Identification on the connection.
10538 Any nonempty value will be the SNI sent; TLS will be forced.
10539
10540 .next
10541 &*tls*&
10542 Controls the use of TLS on the connection.
10543 Values are &"yes"& or &"no"& (the default).
10544 If it is enabled, a shutdown as described above is never done.
10545 .endlist
10546
10547
10548 A fourth argument allows you to change any newlines that are in the data
10549 that is read, in the same way as for &%readfile%& (see above). This example
10550 turns them into spaces:
10551 .code
10552 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10553 .endd
10554 As with all expansions, the substrings are expanded before the processing
10555 happens. Errors in these sub-expansions cause the expansion to fail. In
10556 addition, the following errors can occur:
10557
10558 .ilist
10559 Failure to create a socket file descriptor;
10560 .next
10561 Failure to connect the socket;
10562 .next
10563 Failure to write the request string;
10564 .next
10565 Timeout on reading from the socket.
10566 .endlist
10567
10568 By default, any of these errors causes the expansion to fail. However, if
10569 you supply a fifth substring, it is expanded and used when any of the above
10570 errors occurs. For example:
10571 .code
10572 ${readsocket{/socket/name}{request string}{3s}{\n}\
10573   {socket failure}}
10574 .endd
10575 You can test for the existence of a Unix domain socket by wrapping this
10576 expansion in &`${if exists`&, but there is a race condition between that test
10577 and the actual opening of the socket, so it is safer to use the fifth argument
10578 if you want to be absolutely sure of avoiding an expansion error for a
10579 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10580
10581 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10582 locks out the use of this expansion item in filter files.
10583
10584
10585 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10586 .cindex "expansion" "reducing a list to a scalar"
10587 .cindex "list" "reducing to a scalar"
10588 .vindex "&$value$&"
10589 .vindex "&$item$&"
10590 This operation reduces a list to a single, scalar string. After expansion,
10591 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10592 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10593 Then <&'string2'&> is expanded and
10594 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10595 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10596 them. The result of that expansion is assigned to &$value$& before the next
10597 iteration. When the end of the list is reached, the final value of &$value$& is
10598 added to the expansion output. The &%reduce%& expansion item can be used in a
10599 number of ways. For example, to add up a list of numbers:
10600 .code
10601 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10602 .endd
10603 The result of that expansion would be &`6`&. The maximum of a list of numbers
10604 can be found:
10605 .code
10606 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10607 .endd
10608 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10609 restored to what they were before. See also the &%filter%& and &%map%&
10610 expansion items.
10611
10612 . A bit of a special-case logic error in writing an expansion;
10613 . probably not worth including in the mainline of documentation.
10614 . If only we had footnotes (the html output variant is the problem).
10615 .
10616 . .new
10617 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10618 . and that condition modifies &$value$&,
10619 . then the string expansions dependent on the condition cannot use
10620 . the &$value$& of the reduce iteration.
10621 . .wen
10622
10623 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10624 This item inserts &"raw"& header lines. It is described with the &%header%&
10625 expansion item in section &<<SECTexpansionitems>>& above.
10626
10627 .vitem "&*${run<&'options'&> {*&<&'command&~string'&>&*}{*&<&'string1'&>&*}&&&
10628         {*&<&'string2'&>&*}}*&"
10629 .cindex "expansion" "running a command"
10630 .cindex "&%run%& expansion item"
10631 This item runs an external command, as a subprocess.
10632 One option is supported after the word &'run'&, comma-separated
10633 and without whitespace.
10634
10635 If the option &'preexpand'& is not used,
10636 the command string before expansion is split into individual arguments by spaces
10637 and then each argument is separately expanded.
10638 Then the command is run
10639 in a separate process, but under the same uid and gid.  As in other command
10640 executions from Exim, a shell is not used by default. If the command requires
10641 a shell, you must explicitly code it.
10642 The command name may not be tainted, but the remaining arguments can be.
10643
10644 &*Note*&: if tainted arguments are used, they are supplied by a
10645 potential attacker;
10646 a careful assessment for security vulnerabilities should be done.
10647
10648 If the option &'preexpand'& is used,
10649 the command string is first expanded as a whole.
10650 The expansion result is split apart into individual arguments by spaces,
10651 and then the command is run as above.
10652 Since the arguments are split by spaces, when there is a variable expansion
10653 which has an empty result, it will cause the situation that the argument will
10654 simply be omitted when the program is actually executed by Exim. If the
10655 script/program requires a specific number of arguments and the expanded
10656 variable could possibly result in this empty expansion, the variable must be
10657 quoted. This is more difficult if the expanded variable itself could result
10658 in a string containing quotes, because it would interfere with the quotes
10659 around the command arguments. A possible guard against this is to wrap the
10660 variable in the &%sg%& operator to change any quote marks to some other
10661 character.
10662 Neither the command nor any argument may be tainted.
10663
10664 The standard input for the command exists, but is empty. The standard output
10665 and standard error are set to the same file descriptor.
10666 .cindex "return code" "from &%run%& expansion"
10667 .vindex "&$value$&"
10668 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10669 and replaces the entire item; during this expansion, the standard output/error
10670 from the command is in the variable &$value$&. If the command fails,
10671 <&'string2'&>, if present, is expanded and used. Once again, during the
10672 expansion, the standard output/error from the command is in the variable
10673 &$value$&.
10674
10675 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10676 can be the word &"fail"& (not in braces) to force expansion failure if the
10677 command does not succeed. If both strings are omitted, the result is contents
10678 of the standard output/error on success, and nothing on failure.
10679
10680 .vindex "&$run_in_acl$&"
10681 The standard output/error of the command is put in the variable &$value$&.
10682 In this ACL example, the output of a command is logged for the admin to
10683 troubleshoot:
10684 .code
10685 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10686       log_message  = Output of id: $value
10687 .endd
10688 If the command requires shell idioms, such as the > redirect operator, the
10689 shell must be invoked directly, such as with:
10690 .code
10691 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10692 .endd
10693 Note that &$value$& will not persist beyond the reception of a single message.
10694
10695 .vindex "&$runrc$&"
10696 The return code from the command is put in the variable &$runrc$&, and this
10697 remains set afterwards, so in a filter file you can do things like this:
10698 .code
10699 if "${run{x y z}{}}$runrc" is 1 then ...
10700   elif $runrc is 2 then ...
10701   ...
10702 endif
10703 .endd
10704 If execution of the command fails (for example, the command does not exist),
10705 the return code is 127 &-- the same code that shells use for non-existent
10706 commands.
10707
10708 &*Warning*&: In a router or transport, you cannot assume the order in which
10709 option values are expanded, except for those preconditions whose order of
10710 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10711 by the expansion of one option, and use it in another.
10712
10713 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10714 out the use of this expansion item in filter files.
10715
10716
10717 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10718 .cindex "expansion" "string substitution"
10719 .cindex "&%sg%& expansion item"
10720 This item works like Perl's substitution operator (s) with the global (/g)
10721 option; hence its name. However, unlike the Perl equivalent, Exim does not
10722 modify the subject string; instead it returns the modified string for insertion
10723 into the overall expansion. The item takes three arguments: the subject string,
10724 a regular expression, and a substitution string. For example:
10725 .code
10726 ${sg{abcdefabcdef}{abc}{xyz}}
10727 .endd
10728 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10729 if any $, } or \ characters are required in the regular expression or in the
10730 substitution string, they have to be escaped. For example:
10731 .code
10732 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10733 .endd
10734 yields &"defabc"&, and
10735 .code
10736 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10737 .endd
10738 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10739 the regular expression from string expansion.
10740
10741 The regular expression is compiled in 8-bit mode, working against bytes
10742 rather than any Unicode-aware character handling.
10743
10744
10745 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10746 .cindex sorting "a list"
10747 .cindex list sorting
10748 .cindex expansion "list sorting"
10749 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10750 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10751 The <&'comparator'&> argument is interpreted as the operator
10752 of a two-argument expansion condition.
10753 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10754 The comparison should return true when applied to two values
10755 if the first value should sort before the second value.
10756 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10757 the element being placed in &$item$&,
10758 to give values for comparison.
10759
10760 The item result is a sorted list,
10761 with the original list separator,
10762 of the list elements (in full) of the original.
10763
10764 Examples:
10765 .code
10766 ${sort{3:2:1:4}{<}{$item}}
10767 .endd
10768 sorts a list of numbers, and
10769 .code
10770 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10771 .endd
10772 will sort an MX lookup into priority order.
10773
10774
10775
10776 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10777 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10778
10779
10780
10781 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10782 .cindex "&%substr%& expansion item"
10783 .cindex "substring extraction"
10784 .cindex "expansion" "substring extraction"
10785 The three strings are expanded; the first two must yield numbers. Call them
10786 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10787 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10788 can use the simpler operator notation that avoids some of the braces:
10789 .code
10790 ${substr_<n>_<m>:<subject>}
10791 .endd
10792 The second number is optional (in both notations).
10793 If it is absent in the simpler format, the preceding underscore must also be
10794 omitted.
10795
10796 The &%substr%& item can be used to extract more general substrings than
10797 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10798 length required. For example
10799 .code
10800 ${substr{3}{2}{$local_part}}
10801 .endd
10802 If the starting offset is greater than the string length the result is the
10803 null string; if the length plus starting offset is greater than the string
10804 length, the result is the right-hand part of the string, starting from the
10805 given offset. The first byte (character) in the string has offset zero.
10806
10807 The &%substr%& expansion item can take negative offset values to count
10808 from the right-hand end of its operand. The last byte (character) is offset -1,
10809 the second-last is offset -2, and so on. Thus, for example,
10810 .code
10811 ${substr{-5}{2}{1234567}}
10812 .endd
10813 yields &"34"&. If the absolute value of a negative offset is greater than the
10814 length of the string, the substring starts at the beginning of the string, and
10815 the length is reduced by the amount of overshoot. Thus, for example,
10816 .code
10817 ${substr{-5}{2}{12}}
10818 .endd
10819 yields an empty string, but
10820 .code
10821 ${substr{-3}{2}{12}}
10822 .endd
10823 yields &"1"&.
10824
10825 When the second number is omitted from &%substr%&, the remainder of the string
10826 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10827 string preceding the offset point are taken. For example, an offset of -1 and
10828 no length, as in these semantically identical examples:
10829 .code
10830 ${substr_-1:abcde}
10831 ${substr{-1}{abcde}}
10832 .endd
10833 yields all but the last character of the string, that is, &"abcd"&.
10834
10835 All measurement is done in bytes and is not UTF-8 aware.
10836
10837
10838
10839 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10840         {*&<&'replacements'&>&*}}*&"
10841 .cindex "expansion" "character translation"
10842 .cindex "&%tr%& expansion item"
10843 This item does single-character (in bytes) translation on its subject string. The second
10844 argument is a list of characters to be translated in the subject string. Each
10845 matching character is replaced by the corresponding character from the
10846 replacement list. For example
10847 .code
10848 ${tr{abcdea}{ac}{13}}
10849 .endd
10850 yields &`1b3de1`&. If there are duplicates in the second character string, the
10851 last occurrence is used. If the third string is shorter than the second, its
10852 last character is replicated. However, if it is empty, no translation takes
10853 place.
10854
10855 All character handling is done in bytes and is not UTF-8 aware.
10856
10857 .endlist
10858
10859
10860
10861 .section "Expansion operators" "SECTexpop"
10862 .cindex "expansion" "operators"
10863 For expansion items that perform transformations on a single argument string,
10864 the &"operator"& notation is used because it is simpler and uses fewer braces.
10865 The substring is first expanded before the operation is applied to it. The
10866 following operations can be performed:
10867
10868 .vlist
10869 .vitem &*${address:*&<&'string'&>&*}*&
10870 .cindex "expansion" "RFC 2822 address handling"
10871 .cindex "&%address%& expansion item"
10872 The string is interpreted as an RFC 2822 address, as it might appear in a
10873 header line, and the effective address is extracted from it. If the string does
10874 not parse successfully, the result is empty.
10875
10876 The parsing correctly handles SMTPUTF8 Unicode in the string.
10877
10878
10879 .vitem &*${addresses:*&<&'string'&>&*}*&
10880 .cindex "expansion" "RFC 2822 address handling"
10881 .cindex "&%addresses%& expansion item"
10882 The string (after expansion) is interpreted as a list of addresses in RFC
10883 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10884 operative address (&'local-part@domain'&) is extracted from each item, and the
10885 result of the expansion is a colon-separated list, with appropriate
10886 doubling of colons should any happen to be present in the email addresses.
10887 Syntactically invalid RFC2822 address items are omitted from the output.
10888
10889 It is possible to specify a character other than colon for the output
10890 separator by starting the string with > followed by the new separator
10891 character. For example:
10892 .code
10893 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10894 .endd
10895 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10896 first, so if the expanded string starts with >, it may change the output
10897 separator unintentionally. This can be avoided by setting the output
10898 separator explicitly:
10899 .code
10900 ${addresses:>:$h_from:}
10901 .endd
10902
10903 Compare the &%address%& (singular)
10904 expansion item, which extracts the working address from a single RFC2822
10905 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10906 processing lists.
10907
10908 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10909 a strict interpretation of header line formatting.  Exim parses the bare,
10910 unquoted portion of an email address and if it finds a comma, treats it as an
10911 email address separator. For the example header line:
10912 .code
10913 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10914 .endd
10915 The first example below demonstrates that Q-encoded email addresses are parsed
10916 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10917 It does not see the comma because it's still encoded as "=2C".  The second
10918 example below is passed the contents of &`$header_from:`&, meaning it gets
10919 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10920 The third example shows that the presence of a comma is skipped when it is
10921 quoted.  The fourth example shows SMTPUTF8 handling.
10922 .code
10923 # exim -be '${addresses:From: \
10924 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10925 user@example.com
10926 # exim -be '${addresses:From: Last, First <user@example.com>}'
10927 Last:user@example.com
10928 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10929 user@example.com
10930 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10931 フィリップ@example.jp
10932 .endd
10933
10934 .vitem &*${base32:*&<&'digits'&>&*}*&
10935 .cindex "&%base32%& expansion item"
10936 .cindex "expansion" "conversion to base 32"
10937 The string must consist entirely of decimal digits. The number is converted to
10938 base 32 and output as a (empty, for zero) string of characters.
10939 Only lowercase letters are used.
10940
10941 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10942 .cindex "&%base32d%& expansion item"
10943 .cindex "expansion" "conversion to base 32"
10944 The string must consist entirely of base-32 digits.
10945 The number is converted to decimal and output as a string.
10946
10947 .vitem &*${base62:*&<&'digits'&>&*}*&
10948 .cindex "&%base62%& expansion item"
10949 .cindex "expansion" "conversion to base 62"
10950 The string must consist entirely of decimal digits. The number is converted to
10951 base 62 and output as a string of six characters, including leading zeros. In
10952 the few operating environments where Exim uses base 36 instead of base 62 for
10953 its message identifiers (because those systems do not have case-sensitive
10954 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10955 to be absolutely clear: this is &'not'& base64 encoding.
10956
10957 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10958 .cindex "&%base62d%& expansion item"
10959 .cindex "expansion" "conversion to base 62"
10960 The string must consist entirely of base-62 digits, or, in operating
10961 environments where Exim uses base 36 instead of base 62 for its message
10962 identifiers, base-36 digits. The number is converted to decimal and output as a
10963 string.
10964
10965 .vitem &*${base64:*&<&'string'&>&*}*&
10966 .cindex "expansion" "base64 encoding"
10967 .cindex "base64 encoding" "in string expansion"
10968 .cindex "&%base64%& expansion item"
10969 .cindex certificate "base64 of DER"
10970 This operator converts a string into one that is base64 encoded.
10971
10972 If the string is a single variable of type certificate,
10973 returns the base64 encoding of the DER form of the certificate.
10974
10975
10976 .vitem &*${base64d:*&<&'string'&>&*}*&
10977 .cindex "expansion" "base64 decoding"
10978 .cindex "base64 decoding" "in string expansion"
10979 .cindex "&%base64d%& expansion item"
10980 This operator converts a base64-encoded string into the un-coded form.
10981
10982
10983 .vitem &*${domain:*&<&'string'&>&*}*&
10984 .cindex "domain" "extraction"
10985 .cindex "expansion" "domain extraction"
10986 The string is interpreted as an RFC 2822 address and the domain is extracted
10987 from it. If the string does not parse successfully, the result is empty.
10988
10989
10990 .vitem &*${escape:*&<&'string'&>&*}*&
10991 .cindex "expansion" "escaping non-printing characters"
10992 .cindex "&%escape%& expansion item"
10993 If the string contains any non-printing characters, they are converted to
10994 escape sequences starting with a backslash. Whether characters with the most
10995 significant bit set (so-called &"8-bit characters"&) count as printing or not
10996 is controlled by the &%print_topbitchars%& option.
10997
10998 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10999 .cindex "expansion" "escaping 8-bit characters"
11000 .cindex "&%escape8bit%& expansion item"
11001 If the string contains any characters with the most significant bit set,
11002 they are converted to escape sequences starting with a backslash.
11003 Backslashes and DEL characters are also converted.
11004
11005
11006 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
11007 .cindex "expansion" "expression evaluation"
11008 .cindex "expansion" "arithmetic expression"
11009 .cindex "&%eval%& expansion item"
11010 These items supports simple arithmetic and bitwise logical operations in
11011 expansion strings. The string (after expansion) must be a conventional
11012 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11013 logical operators, and parentheses. All operations are carried out using
11014 integer arithmetic. The operator priorities are as follows (the same as in the
11015 C programming language):
11016 .table2 70pt 300pt
11017 .irow &'highest:'& "not (~), negate (-)"
11018 .irow ""   "multiply (*), divide (/), remainder (%)"
11019 .irow ""   "plus (+), minus (-)"
11020 .irow ""   "shift-left (<<), shift-right (>>)"
11021 .irow ""   "and (&&)"
11022 .irow ""   "xor (^)"
11023 .irow &'lowest:'&  "or (|)"
11024 .endtable
11025 Binary operators with the same priority are evaluated from left to right. White
11026 space is permitted before or after operators.
11027
11028 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11029 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11030 decimal, even if they start with a leading zero; hexadecimal numbers are not
11031 permitted. This can be useful when processing numbers extracted from dates or
11032 times, which often do have leading zeros.
11033
11034 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11035 or 1024*1024*1024,
11036 respectively. Negative numbers are supported. The result of the computation is
11037 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11038
11039 .display
11040 &`${eval:1+1}            `&  yields 2
11041 &`${eval:1+2*3}          `&  yields 7
11042 &`${eval:(1+2)*3}        `&  yields 9
11043 &`${eval:2+42%5}         `&  yields 4
11044 &`${eval:0xc&amp;5}          `&  yields 4
11045 &`${eval:0xc|5}          `&  yields 13
11046 &`${eval:0xc^5}          `&  yields 9
11047 &`${eval:0xc>>1}         `&  yields 6
11048 &`${eval:0xc<<1}         `&  yields 24
11049 &`${eval:~255&amp;0x1234}    `&  yields 4608
11050 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11051 .endd
11052
11053 As a more realistic example, in an ACL you might have
11054 .code
11055 deny   condition =                    \
11056          ${if and {                   \
11057            {>{$rcpt_count}{10}}       \
11058            {                          \
11059            <                          \
11060              {$recipients_count}      \
11061              {${eval:$rcpt_count/2}}  \
11062            }                          \
11063          }{yes}{no}}
11064        message = Too many bad recipients
11065 .endd
11066 The condition is true if there have been more than 10 RCPT commands and
11067 fewer than half of them have resulted in a valid recipient.
11068
11069
11070 .vitem &*${expand:*&<&'string'&>&*}*&
11071 .cindex "expansion" "re-expansion of substring"
11072 The &%expand%& operator causes a string to be expanded for a second time. For
11073 example,
11074 .code
11075 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11076 .endd
11077 first looks up a string in a file while expanding the operand for &%expand%&,
11078 and then re-expands what it has found.
11079
11080
11081 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11082 .cindex "Unicode"
11083 .cindex "UTF-8" "conversion from"
11084 .cindex "expansion" "UTF-8 conversion"
11085 .cindex "&%from_utf8%& expansion item"
11086 The world is slowly moving towards Unicode, although there are no standards for
11087 email yet. However, other applications (including some databases) are starting
11088 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11089 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11090 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11091 the result is an undefined sequence of bytes.
11092
11093 Unicode code points with values less than 256 are compatible with ASCII and
11094 ISO-8859-1 (also known as Latin-1).
11095 For example, character 169 is the copyright symbol in both cases, though the
11096 way it is encoded is different. In UTF-8, more than one byte is needed for
11097 characters with code values greater than 127, whereas ISO-8859-1 is a
11098 single-byte encoding (but thereby limited to 256 characters). This makes
11099 translation from UTF-8 to ISO-8859-1 straightforward.
11100
11101
11102 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11103 .cindex "hash function" "textual"
11104 .cindex "expansion" "textual hash"
11105 The &%hash%& operator is a simpler interface to the hashing function that can
11106 be used when the two parameters are fixed numbers (as opposed to strings that
11107 change when expanded). The effect is the same as
11108 .code
11109 ${hash{<n>}{<m>}{<string>}}
11110 .endd
11111 See the description of the general &%hash%& item above for details. The
11112 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11113
11114
11115
11116 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11117 .cindex header "wrapping operator"
11118 .cindex expansion "header wrapping"
11119 This operator line-wraps its argument in a way useful for headers.
11120 The &'cols'& value gives the column number to wrap after,
11121 the &'limit'& gives a limit number of result characters to truncate at.
11122 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11123 the defaults are 80 and 998.
11124 Wrapping will be inserted at a space if possible before the
11125 column number is reached.
11126 Whitespace at a chosen wrap point is removed.
11127 A line-wrap consists of a newline followed by a tab,
11128 and the tab is counted as 8 columns.
11129
11130
11131
11132 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11133 .cindex "base64 encoding" "conversion from hex"
11134 .cindex "expansion" "hex to base64"
11135 .cindex "&%hex2b64%& expansion item"
11136 This operator converts a hex string into one that is base64 encoded. This can
11137 be useful for processing the output of the various hashing functions.
11138
11139
11140
11141 .vitem &*${hexquote:*&<&'string'&>&*}*&
11142 .cindex "quoting" "hex-encoded unprintable characters"
11143 .cindex "&%hexquote%& expansion item"
11144 This operator converts non-printable characters in a string into a hex
11145 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11146 as is, and other byte values are converted to &`\xNN`&, for example, a
11147 byte value 127 is converted to &`\x7f`&.
11148
11149
11150 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11151 .cindex "&%ipv6denorm%& expansion item"
11152 .cindex "IP address" normalisation
11153 This expands an IPv6 address to a full eight-element colon-separated set
11154 of hex digits including leading zeroes.
11155 A trailing ipv4-style dotted-decimal set is converted to hex.
11156 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11157
11158 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11159 .cindex "&%ipv6norm%& expansion item"
11160 .cindex "IP address" normalisation
11161 .cindex "IP address" "canonical form"
11162 This converts an IPv6 address to canonical form.
11163 Leading zeroes of groups are omitted, and the longest
11164 set of zero-valued groups is replaced with a double colon.
11165 A trailing ipv4-style dotted-decimal set is converted to hex.
11166 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11167
11168
11169 .vitem &*${lc:*&<&'string'&>&*}*&
11170 .cindex "case forcing in strings"
11171 .cindex "string" "case forcing"
11172 .cindex "lower casing"
11173 .cindex "expansion" "case forcing"
11174 .cindex "&%lc%& expansion item"
11175 This forces the letters in the string into lower-case, for example:
11176 .code
11177 ${lc:$local_part}
11178 .endd
11179 Case is defined per the system C locale.
11180
11181 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11182 .cindex "expansion" "string truncation"
11183 .cindex "&%length%& expansion item"
11184 The &%length%& operator is a simpler interface to the &%length%& function that
11185 can be used when the parameter is a fixed number (as opposed to a string that
11186 changes when expanded). The effect is the same as
11187 .code
11188 ${length{<number>}{<string>}}
11189 .endd
11190 See the description of the general &%length%& item above for details. Note that
11191 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11192 when &%length%& is used as an operator.
11193 All measurement is done in bytes and is not UTF-8 aware.
11194
11195
11196 .vitem &*${listcount:*&<&'string'&>&*}*&
11197 .cindex "expansion" "list item count"
11198 .cindex "list" "item count"
11199 .cindex "list" "count of items"
11200 .cindex "&%listcount%& expansion item"
11201 The string is interpreted as a list and the number of items is returned.
11202
11203
11204 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11205 .cindex "expansion" "named list"
11206 .cindex "&%listnamed%& expansion item"
11207 The name is interpreted as a named list and the content of the list is returned,
11208 expanding any referenced lists, re-quoting as needed for colon-separation.
11209 If the optional type is given it must be one of "a", "d", "h" or "l"
11210 and selects address-, domain-, host- or localpart- lists to search among respectively.
11211 Otherwise all types are searched in an undefined order and the first
11212 matching list is returned.
11213 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11214 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11215
11216
11217 .vitem &*${local_part:*&<&'string'&>&*}*&
11218 .cindex "expansion" "local part extraction"
11219 .cindex "&%local_part%& expansion item"
11220 The string is interpreted as an RFC 2822 address and the local part is
11221 extracted from it. If the string does not parse successfully, the result is
11222 empty.
11223 The parsing correctly handles SMTPUTF8 Unicode in the string.
11224
11225
11226 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11227        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11228 .cindex "masked IP address"
11229 .cindex "IP address" "masking"
11230 .cindex "CIDR notation"
11231 .cindex "expansion" "IP address masking"
11232 .cindex "&%mask%& expansion item"
11233 If the form of the string to be operated on is not an IP address followed by a
11234 slash and an integer (that is, a network address in CIDR notation), the
11235 expansion fails. Otherwise, this operator converts the IP address to binary,
11236 masks off the least significant bits according to the bit count, and converts
11237 the result back to text, with mask appended. For example,
11238 .code
11239 ${mask:10.111.131.206/28}
11240 .endd
11241 returns the string &"10.111.131.192/28"&.
11242
11243 Since this operation is expected to
11244 be mostly used for looking up masked addresses in files, the
11245 normal
11246 result for an IPv6
11247 address uses dots to separate components instead of colons, because colon
11248 terminates a key string in lsearch files. So, for example,
11249 .code
11250 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11251 .endd
11252 returns the string
11253 .code
11254 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11255 .endd
11256 If the optional form &*mask_n*& is used, IPv6 address result are instead
11257 returned in normailsed form, using colons and with zero-compression.
11258 Letters in IPv6 addresses are always output in lower case.
11259
11260
11261 .vitem &*${md5:*&<&'string'&>&*}*&
11262 .cindex "MD5 hash"
11263 .cindex "expansion" "MD5 hash"
11264 .cindex certificate fingerprint
11265 .cindex "&%md5%& expansion item"
11266 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11267 as a 32-digit hexadecimal number, in which any letters are in lower case.
11268
11269 If the string is a single variable of type certificate,
11270 returns the MD5 hash fingerprint of the certificate.
11271
11272
11273 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11274 .cindex "expansion" "numeric hash"
11275 .cindex "hash function" "numeric"
11276 The &%nhash%& operator is a simpler interface to the numeric hashing function
11277 that can be used when the two parameters are fixed numbers (as opposed to
11278 strings that change when expanded). The effect is the same as
11279 .code
11280 ${nhash{<n>}{<m>}{<string>}}
11281 .endd
11282 See the description of the general &%nhash%& item above for details.
11283
11284
11285 .vitem &*${quote:*&<&'string'&>&*}*&
11286 .cindex "quoting" "in string expansions"
11287 .cindex "expansion" "quoting"
11288 .cindex "&%quote%& expansion item"
11289 The &%quote%& operator puts its argument into double quotes if it
11290 is an empty string or
11291 contains anything other than letters, digits, underscores, dots, and hyphens.
11292 Any occurrences of double quotes and backslashes are escaped with a backslash.
11293 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11294 respectively For example,
11295 .code
11296 ${quote:ab"*"cd}
11297 .endd
11298 becomes
11299 .code
11300 "ab\"*\"cd"
11301 .endd
11302 The place where this is useful is when the argument is a substitution from a
11303 variable or a message header.
11304
11305 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11306 .cindex "&%quote_local_part%& expansion item"
11307 This operator is like &%quote%&, except that it quotes the string only if
11308 required to do so by the rules of RFC 2822 for quoting local parts. For
11309 example, a plus sign would not cause quoting (but it would for &%quote%&).
11310 If you are creating a new email address from the contents of &$local_part$&
11311 (or any other unknown data), you should always use this operator.
11312
11313 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11314 will likely use the quoting form.
11315 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11316
11317
11318 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11319 .cindex "quoting" "lookup-specific"
11320 This operator applies lookup-specific quoting rules to the string. Each
11321 query-style lookup type has its own quoting rules which are described with
11322 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11323 .code
11324 ${quote_ldap:two * two}
11325 .endd
11326 returns
11327 .code
11328 two%20%5C2A%20two
11329 .endd
11330 For single-key lookup types, no quoting is ever necessary and this operator
11331 yields an unchanged string.
11332
11333
11334 .vitem &*${randint:*&<&'n'&>&*}*&
11335 .cindex "random number"
11336 This operator returns a somewhat random number which is less than the
11337 supplied number and is at least 0.  The quality of this randomness depends
11338 on how Exim was built; the values are not suitable for keying material.
11339 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11340 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11341 for versions of GnuTLS with that function.
11342 Otherwise, the implementation may be arc4random(), random() seeded by
11343 srandomdev() or srandom(), or a custom implementation even weaker than
11344 random().
11345
11346
11347 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11348 .cindex "expansion" "IP address"
11349 This operator reverses an IP address; for IPv4 addresses, the result is in
11350 dotted-quad decimal form, while for IPv6 addresses the result is in
11351 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11352 for DNS.  For example,
11353 .code
11354 ${reverse_ip:192.0.2.4}
11355 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11356 .endd
11357 returns
11358 .code
11359 4.2.0.192
11360 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
11361 .endd
11362
11363
11364 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11365 .cindex "expansion" "RFC 2047"
11366 .cindex "RFC 2047" "expansion operator"
11367 .cindex "&%rfc2047%& expansion item"
11368 This operator encodes text according to the rules of RFC 2047. This is an
11369 encoding that is used in header lines to encode non-ASCII characters. It is
11370 assumed that the input string is in the encoding specified by the
11371 &%headers_charset%& option, which gets its default at build time. If the string
11372 contains only characters in the range 33&--126, and no instances of the
11373 characters
11374 .code
11375 ? = ( ) < > @ , ; : \ " . [ ] _
11376 .endd
11377 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11378 string, using as many &"encoded words"& as necessary to encode all the
11379 characters.
11380
11381
11382 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11383 .cindex "expansion" "RFC 2047"
11384 .cindex "RFC 2047" "decoding"
11385 .cindex "&%rfc2047d%& expansion item"
11386 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11387 bytes are replaced by question marks. Characters are converted into the
11388 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11389 not recognized unless &%check_rfc2047_length%& is set false.
11390
11391 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11392 access a header line, RFC 2047 decoding is done automatically. You do not need
11393 to use this operator as well.
11394
11395
11396
11397 .vitem &*${rxquote:*&<&'string'&>&*}*&
11398 .cindex "quoting" "in regular expressions"
11399 .cindex "regular expressions" "quoting"
11400 .cindex "&%rxquote%& expansion item"
11401 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11402 characters in its argument. This is useful when substituting the values of
11403 variables or headers inside regular expressions.
11404
11405
11406 .vitem &*${sha1:*&<&'string'&>&*}*&
11407 .cindex "SHA-1 hash"
11408 .cindex "expansion" "SHA-1 hashing"
11409 .cindex certificate fingerprint
11410 .cindex "&%sha1%& expansion item"
11411 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11412 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11413
11414 If the string is a single variable of type certificate,
11415 returns the SHA-1 hash fingerprint of the certificate.
11416
11417
11418 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11419        &*${sha2:*&<&'string'&>&*}*& &&&
11420        &*${sha2_<n>:*&<&'string'&>&*}*&
11421 .cindex "SHA-256 hash"
11422 .cindex "SHA-2 hash"
11423 .cindex certificate fingerprint
11424 .cindex "expansion" "SHA-256 hashing"
11425 .cindex "&%sha256%& expansion item"
11426 .cindex "&%sha2%& expansion item"
11427 The &%sha256%& operator computes the SHA-256 hash value of the string
11428 and returns
11429 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11430
11431 If the string is a single variable of type certificate,
11432 returns the SHA-256 hash fingerprint of the certificate.
11433
11434 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11435 (except for certificates, which are not supported).
11436 Finally, if an underbar
11437 and a number is appended it specifies the output length, selecting a
11438 member of the SHA-2 family of hash functions.
11439 Values of 256, 384 and 512 are accepted, with 256 being the default.
11440
11441
11442 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11443        &*${sha3_<n>:*&<&'string'&>&*}*&
11444 .cindex "SHA3 hash"
11445 .cindex "expansion" "SHA3 hashing"
11446 .cindex "&%sha3%& expansion item"
11447 The &%sha3%& operator computes the SHA3-256 hash value of the string
11448 and returns
11449 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11450
11451 If a number is appended, separated by an underbar, it specifies
11452 the output length.  Values of 224, 256, 384 and 512 are accepted;
11453 with 256 being the default.
11454
11455 The &%sha3%& expansion item is only supported if Exim has been
11456 compiled with GnuTLS 3.5.0 or later,
11457 or OpenSSL 1.1.1 or later.
11458 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11459
11460
11461 .vitem &*${stat:*&<&'string'&>&*}*&
11462 .cindex "expansion" "statting a file"
11463 .cindex "file" "extracting characteristics"
11464 .cindex "&%stat%& expansion item"
11465 The string, after expansion, must be a file path. A call to the &[stat()]&
11466 function is made for this path. If &[stat()]& fails, an error occurs and the
11467 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11468 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11469 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11470 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11471 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11472 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11473 can extract individual fields using the &%extract%& expansion item.
11474
11475 The use of the &%stat%& expansion in users' filter files can be locked out by
11476 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11477 systems for files larger than 2GB.
11478
11479 .vitem &*${str2b64:*&<&'string'&>&*}*&
11480 .cindex "&%str2b64%& expansion item"
11481 Now deprecated, a synonym for the &%base64%& expansion operator.
11482
11483
11484
11485 .vitem &*${strlen:*&<&'string'&>&*}*&
11486 .cindex "expansion" "string length"
11487 .cindex "string" "length in expansion"
11488 .cindex "&%strlen%& expansion item"
11489 The item is replaced by the length of the expanded string, expressed as a
11490 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11491 All measurement is done in bytes and is not UTF-8 aware.
11492
11493
11494 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11495 .cindex "&%substr%& expansion item"
11496 .cindex "substring extraction"
11497 .cindex "expansion" "substring expansion"
11498 The &%substr%& operator is a simpler interface to the &%substr%& function that
11499 can be used when the two parameters are fixed numbers (as opposed to strings
11500 that change when expanded). The effect is the same as
11501 .code
11502 ${substr{<start>}{<length>}{<string>}}
11503 .endd
11504 See the description of the general &%substr%& item above for details. The
11505 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11506 All measurement is done in bytes and is not UTF-8 aware.
11507
11508 .vitem &*${time_eval:*&<&'string'&>&*}*&
11509 .cindex "&%time_eval%& expansion item"
11510 .cindex "time interval" "decoding"
11511 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11512 seconds.
11513
11514 .vitem &*${time_interval:*&<&'string'&>&*}*&
11515 .cindex "&%time_interval%& expansion item"
11516 .cindex "time interval" "formatting"
11517 The argument (after sub-expansion) must be a sequence of decimal digits that
11518 represents an interval of time as a number of seconds. It is converted into a
11519 number of larger units and output in Exim's normal time format, for example,
11520 &`1w3d4h2m6s`&.
11521
11522 .vitem &*${uc:*&<&'string'&>&*}*&
11523 .cindex "case forcing in strings"
11524 .cindex "string" "case forcing"
11525 .cindex "upper casing"
11526 .cindex "expansion" "case forcing"
11527 .cindex "&%uc%& expansion item"
11528 This forces the letters in the string into upper-case.
11529 Case is defined per the system C locale.
11530
11531 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11532 .cindex "correction of invalid utf-8 sequences in strings"
11533 .cindex "utf-8" "utf-8 sequences"
11534 .cindex "incorrect utf-8"
11535 .cindex "expansion" "utf-8 forcing"
11536 .cindex "&%utf8clean%& expansion item"
11537 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11538 In versions of Exim before 4.92, this did not correctly do so for a truncated
11539 final codepoint's encoding, and the character would be silently dropped.
11540 If you must handle detection of this scenario across both sets of Exim behavior,
11541 the complexity will depend upon the task.
11542 For instance, to detect if the first character is multibyte and a 1-byte
11543 extraction can be successfully used as a path component (as is common for
11544 dividing up delivery folders), you might use:
11545 .code
11546 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11547 .endd
11548 (which will false-positive if the first character of the local part is a
11549 literal question mark).
11550
11551 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11552        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11553        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11554        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11555 .cindex expansion UTF-8
11556 .cindex UTF-8 expansion
11557 .cindex EAI
11558 .cindex internationalisation
11559 .cindex "&%utf8_domain_to_alabel%& expansion item"
11560 .cindex "&%utf8_domain_from_alabel%& expansion item"
11561 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11562 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11563 These convert EAI mail name components between UTF-8 and a-label forms.
11564 For information on internationalisation support see &<<SECTi18nMTA>>&.
11565 .endlist
11566
11567
11568
11569
11570
11571
11572 .section "Expansion conditions" "SECTexpcond"
11573 .scindex IIDexpcond "expansion" "conditions"
11574 The following conditions are available for testing by the &%${if%& construct
11575 while expanding strings:
11576
11577 .vlist
11578 .vitem &*!*&<&'condition'&>
11579 .cindex "expansion" "negating a condition"
11580 .cindex "negation" "in expansion condition"
11581 Preceding any condition with an exclamation mark negates the result of the
11582 condition.
11583
11584 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11585 .cindex "numeric comparison"
11586 .cindex "expansion" "numeric comparison"
11587 There are a number of symbolic operators for doing numeric comparisons. They
11588 are:
11589 .itable none 0 0 2 10* left 90* left
11590 .irow "=   " "equal"
11591 .irow "==  " "equal"
11592 .irow ">   " "greater"
11593 .irow ">=  " "greater or equal"
11594 .irow "<   " "less"
11595 .irow "<=  " "less or equal"
11596 .endtable
11597 For example:
11598 .code
11599 ${if >{$message_size}{10M} ...
11600 .endd
11601 Note that the general negation operator provides for inequality testing. The
11602 two strings must take the form of optionally signed decimal integers,
11603 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11604 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11605 As a special case, the numerical value of an empty string is taken as
11606 zero.
11607
11608 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11609 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11610 10M, not if 10M is larger than &$message_size$&.
11611
11612
11613 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11614         {*&<&'arg2'&>&*}...}*&
11615 .cindex "expansion" "calling an acl"
11616 .cindex "&%acl%&" "expansion condition"
11617 The name and zero to nine argument strings are first expanded separately.  The expanded
11618 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11619 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11620 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11621 and may use the variables; if another acl expansion is used the values
11622 are restored after it returns.  If the ACL sets
11623 a value using a "message =" modifier the variable $value becomes
11624 the result of the expansion, otherwise it is empty.
11625 If the ACL returns accept the condition is true; if deny, false.
11626 If the ACL returns defer the result is a forced-fail.
11627
11628 .vitem &*bool&~{*&<&'string'&>&*}*&
11629 .cindex "expansion" "boolean parsing"
11630 .cindex "&%bool%& expansion condition"
11631 This condition turns a string holding a true or false representation into
11632 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11633 (case-insensitively); also integer numbers map to true if non-zero,
11634 false if zero.
11635 An empty string is treated as false.
11636 Leading and trailing whitespace is ignored;
11637 thus a string consisting only of whitespace is false.
11638 All other string values will result in expansion failure.
11639
11640 When combined with ACL variables, this expansion condition will let you
11641 make decisions in one place and act on those decisions in another place.
11642 For example:
11643 .code
11644 ${if bool{$acl_m_privileged_sender} ...
11645 .endd
11646
11647
11648 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11649 .cindex "expansion" "boolean parsing"
11650 .cindex "&%bool_lax%& expansion condition"
11651 Like &%bool%&, this condition turns a string into a boolean state.  But
11652 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11653 loose definition that the Router &%condition%& option uses.  The empty string
11654 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11655 true.  Leading and trailing whitespace is ignored.
11656
11657 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11658
11659 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11660 .cindex "expansion" "encrypted comparison"
11661 .cindex "encrypted strings, comparing"
11662 .cindex "&%crypteq%& expansion condition"
11663 This condition is included in the Exim binary if it is built to support any
11664 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11665 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11666 included in the binary.
11667
11668 The &%crypteq%& condition has two arguments. The first is encrypted and
11669 compared against the second, which is already encrypted. The second string may
11670 be in the LDAP form for storing encrypted strings, which starts with the
11671 encryption type in curly brackets, followed by the data. If the second string
11672 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11673 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11674 Typically this will be a field from a password file. An example of an encrypted
11675 string in LDAP form is:
11676 .code
11677 {md5}CY9rzUYh03PK3k6DJie09g==
11678 .endd
11679 If such a string appears directly in an expansion, the curly brackets have to
11680 be quoted, because they are part of the expansion syntax. For example:
11681 .code
11682 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11683 .endd
11684 The following encryption types (whose names are matched case-independently) are
11685 supported:
11686
11687 .ilist
11688 .cindex "MD5 hash"
11689 .cindex "base64 encoding" "in encrypted password"
11690 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11691 printable characters to compare with the remainder of the second string. If the
11692 length of the comparison string is 24, Exim assumes that it is base64 encoded
11693 (as in the above example). If the length is 32, Exim assumes that it is a
11694 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11695 comparison fails.
11696
11697 .next
11698 .cindex "SHA-1 hash"
11699 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11700 printable characters to compare with the remainder of the second string. If the
11701 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11702 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11703 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11704
11705 .next
11706 .cindex "&[crypt()]&"
11707 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11708 only the first eight characters of the password. However, in modern operating
11709 systems this is no longer true, and in many cases the entire password is used,
11710 whatever its length.
11711
11712 .next
11713 .cindex "&[crypt16()]&"
11714 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11715 use up to 16 characters of the password in some operating systems. Again, in
11716 modern operating systems, more characters may be used.
11717 .endlist
11718 Exim has its own version of &[crypt16()]&, which is just a double call to
11719 &[crypt()]&. For operating systems that have their own version, setting
11720 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11721 operating system version instead of its own. This option is set by default in
11722 the OS-dependent &_Makefile_& for those operating systems that are known to
11723 support &[crypt16()]&.
11724
11725 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11726 it was not using the same algorithm as some operating systems' versions. It
11727 turns out that as well as &[crypt16()]& there is a function called
11728 &[bigcrypt()]& in some operating systems. This may or may not use the same
11729 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11730
11731 However, since there is now a move away from the traditional &[crypt()]&
11732 functions towards using SHA1 and other algorithms, tidying up this area of
11733 Exim is seen as very low priority.
11734
11735 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11736 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11737 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11738 default is &`{crypt}`&. Whatever the default, you can always use either
11739 function by specifying it explicitly in curly brackets.
11740
11741 .vitem &*def:*&<&'variable&~name'&>
11742 .cindex "expansion" "checking for empty variable"
11743 .cindex "&%def%& expansion condition"
11744 The &%def%& condition must be followed by the name of one of the expansion
11745 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11746 variable does not contain the empty string. For example:
11747 .code
11748 ${if def:sender_ident {from $sender_ident}}
11749 .endd
11750 Note that the variable name is given without a leading &%$%& character. If the
11751 variable does not exist, the expansion fails.
11752
11753 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11754         &~&*def:h_*&<&'header&~name'&>&*:*&"
11755 .cindex "expansion" "checking header line existence"
11756 This condition is true if a message is being processed and the named header
11757 exists in the message. For example,
11758 .code
11759 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11760 .endd
11761 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11762 the header name must be terminated by a colon if white space does not follow.
11763
11764 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11765        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11766 .cindex "string" "comparison"
11767 .cindex "expansion" "string comparison"
11768 .cindex "&%eq%& expansion condition"
11769 .cindex "&%eqi%& expansion condition"
11770 The two substrings are first expanded. The condition is true if the two
11771 resulting strings are identical. For &%eq%& the comparison includes the case of
11772 letters, whereas for &%eqi%& the comparison is case-independent, where
11773 case is defined per the system C locale.
11774
11775 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11776 .cindex "expansion" "file existence test"
11777 .cindex "file" "existence test"
11778 .cindex "&%exists%&, expansion condition"
11779 The substring is first expanded and then interpreted as an absolute path. The
11780 condition is true if the named file (or directory) exists. The existence test
11781 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11782 users' filter files may be locked out by the system administrator.
11783
11784 &*Note:*& Testing a path using this condition is not a sufficient way of
11785 de-tainting it.
11786 Consider using a dsearch lookup.
11787
11788 .vitem &*first_delivery*&
11789 .cindex "delivery" "first"
11790 .cindex "first delivery"
11791 .cindex "expansion" "first delivery test"
11792 .cindex "&%first_delivery%& expansion condition"
11793 .cindex retry condition
11794 This condition, which has no data, is true during a message's first delivery
11795 attempt. It is false during any subsequent delivery attempts.
11796
11797
11798 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11799        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11800 .cindex "list" "iterative conditions"
11801 .cindex "expansion" "&*forall*& condition"
11802 .cindex "expansion" "&*forany*& condition"
11803 .vindex "&$item$&"
11804 These conditions iterate over a list. The first argument is expanded to form
11805 the list. By default, the list separator is a colon, but it can be changed by
11806 the normal method (&<<SECTlistsepchange>>&).
11807 The second argument is interpreted as a condition that is to
11808 be applied to each item in the list in turn. During the interpretation of the
11809 condition, the current list item is placed in a variable called &$item$&.
11810 .ilist
11811 For &*forany*&, interpretation stops if the condition is true for any item, and
11812 the result of the whole condition is true. If the condition is false for all
11813 items in the list, the overall condition is false.
11814 .next
11815 For &*forall*&, interpretation stops if the condition is false for any item,
11816 and the result of the whole condition is false. If the condition is true for
11817 all items in the list, the overall condition is true.
11818 .endlist
11819 Note that negation of &*forany*& means that the condition must be false for all
11820 items for the overall condition to succeed, and negation of &*forall*& means
11821 that the condition must be false for at least one item.
11822
11823 Example:
11824 .code
11825 ${if forany{$recipients_list}{match{$item}{^user3@}}{yes}{no}}
11826 .endd
11827 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11828 being processed, to enable these expansion items to be nested.
11829
11830 To scan a named list, expand it with the &*listnamed*& operator.
11831
11832 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11833        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11834        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11835        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11836 .cindex JSON "iterative conditions"
11837 .cindex JSON expansions
11838 .cindex expansion "&*forall_json*& condition"
11839 .cindex expansion "&*forany_json*& condition"
11840 .cindex expansion "&*forall_jsons*& condition"
11841 .cindex expansion "&*forany_jsons*& condition"
11842 As for the above, except that the first argument must, after expansion,
11843 be a JSON array.
11844 The array separator is not changeable.
11845 For the &"jsons"& variants the elements are expected to be JSON strings
11846 and have their quotes removed before the evaluation of the condition.
11847
11848
11849
11850 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11851        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11852 .cindex "string" "comparison"
11853 .cindex "expansion" "string comparison"
11854 .cindex "&%ge%& expansion condition"
11855 .cindex "&%gei%& expansion condition"
11856 The two substrings are first expanded. The condition is true if the first
11857 string is lexically greater than or equal to the second string. For &%ge%& the
11858 comparison includes the case of letters, whereas for &%gei%& the comparison is
11859 case-independent.
11860 Case and collation order are defined per the system C locale.
11861
11862 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11863        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11864 .cindex "string" "comparison"
11865 .cindex "expansion" "string comparison"
11866 .cindex "&%gt%& expansion condition"
11867 .cindex "&%gti%& expansion condition"
11868 The two substrings are first expanded. The condition is true if the first
11869 string is lexically greater than the second string. For &%gt%& the comparison
11870 includes the case of letters, whereas for &%gti%& the comparison is
11871 case-independent.
11872 Case and collation order are defined per the system C locale.
11873
11874
11875 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11876 SRS decode.  See SECT &<<SECTSRS>>& for details.
11877
11878
11879 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11880        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11881 .cindex "string" "comparison"
11882 .cindex "list" "iterative conditions"
11883 Both strings are expanded; the second string is treated as a list of simple
11884 strings; if the first string is a member of the second, then the condition
11885 is true.
11886 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11887
11888 These are simpler to use versions of the more powerful &*forany*& condition.
11889 Examples, and the &*forany*& equivalents:
11890 .code
11891 ${if inlist{needle}{foo:needle:bar}}
11892   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11893 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11894   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11895 .endd
11896
11897 The variable &$value$& will be set for a successful match and can be
11898 used in the success clause of an &%if%& expansion item using the condition.
11899 .cindex "tainted data" "de-tainting"
11900 .cindex "de-tainting" "using an inlist expansion condition"
11901 It will have the same taint status as the list; expansions such as
11902 .code
11903 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11904 .endd
11905 can be used for de-tainting.
11906 Any previous &$value$& is restored after the if.
11907
11908
11909 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11910        &*isip4&~{*&<&'string'&>&*}*& &&&
11911        &*isip6&~{*&<&'string'&>&*}*&
11912 .cindex "IP address" "testing string format"
11913 .cindex "string" "testing for IP address"
11914 .cindex "&%isip%& expansion condition"
11915 .cindex "&%isip4%& expansion condition"
11916 .cindex "&%isip6%& expansion condition"
11917 The substring is first expanded, and then tested to see if it has the form of
11918 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11919 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11920
11921 For an IPv4 address, the test is for four dot-separated components, each of
11922 which consists of from one to three digits. For an IPv6 address, up to eight
11923 colon-separated components are permitted, each containing from one to four
11924 hexadecimal digits. There may be fewer than eight components if an empty
11925 component (adjacent colons) is present. Only one empty component is permitted.
11926
11927 &*Note*&: The checks used to be just on the form of the address; actual numerical
11928 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11929 check.
11930 This is no longer the case.
11931
11932 The main use of these tests is to distinguish between IP addresses and
11933 host names, or between IPv4 and IPv6 addresses. For example, you could use
11934 .code
11935 ${if isip4{$sender_host_address}...
11936 .endd
11937 to test which IP version an incoming SMTP connection is using.
11938
11939 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11940 .cindex "LDAP" "use for authentication"
11941 .cindex "expansion" "LDAP authentication test"
11942 .cindex "&%ldapauth%& expansion condition"
11943 This condition supports user authentication using LDAP. See section
11944 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11945 queries. For this use, the query must contain a user name and password. The
11946 query itself is not used, and can be empty. The condition is true if the
11947 password is not empty, and the user name and password are accepted by the LDAP
11948 server. An empty password is rejected without calling LDAP because LDAP binds
11949 with an empty password are considered anonymous regardless of the username, and
11950 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11951 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11952 this can be used.
11953
11954
11955 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11956        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11957 .cindex "string" "comparison"
11958 .cindex "expansion" "string comparison"
11959 .cindex "&%le%& expansion condition"
11960 .cindex "&%lei%& expansion condition"
11961 The two substrings are first expanded. The condition is true if the first
11962 string is lexically less than or equal to the second string. For &%le%& the
11963 comparison includes the case of letters, whereas for &%lei%& the comparison is
11964 case-independent.
11965 Case and collation order are defined per the system C locale.
11966
11967 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11968        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11969 .cindex "string" "comparison"
11970 .cindex "expansion" "string comparison"
11971 .cindex "&%lt%& expansion condition"
11972 .cindex "&%lti%& expansion condition"
11973 The two substrings are first expanded. The condition is true if the first
11974 string is lexically less than the second string. For &%lt%& the comparison
11975 includes the case of letters, whereas for &%lti%& the comparison is
11976 case-independent.
11977 Case and collation order are defined per the system C locale.
11978
11979
11980 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11981 .cindex "expansion" "regular expression comparison"
11982 .cindex "regular expressions" "match in expanded string"
11983 .cindex "&%match%& expansion condition"
11984 The two substrings are first expanded. The second is then treated as a regular
11985 expression and applied to the first. Because of the pre-expansion, if the
11986 regular expression contains dollar, or backslash characters, they must be
11987 escaped. Care must also be taken if the regular expression contains braces
11988 (curly brackets). A closing brace must be escaped so that it is not taken as a
11989 premature termination of <&'string2'&>. The easiest approach is to use the
11990 &`\N`& feature to disable expansion of the regular expression.
11991 For example,
11992 .code
11993 ${if match {$local_part}{\N^\d{3}\N} ...
11994 .endd
11995 If the whole expansion string is in double quotes, further escaping of
11996 backslashes is also required.
11997
11998 The condition is true if the regular expression match succeeds.
11999 The regular expression is not required to begin with a circumflex
12000 metacharacter, but if there is no circumflex, the expression is not anchored,
12001 and it may match anywhere in the subject, not just at the start. If you want
12002 the pattern to match at the end of the subject, you must include the &`$`&
12003 metacharacter at an appropriate point.
12004 All character handling is done in bytes and is not UTF-8 aware,
12005 but we might change this in a future Exim release.
12006
12007 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
12008 At the start of an &%if%& expansion the values of the numeric variable
12009 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
12010 succeeds causes them to be reset to the substrings of that condition and they
12011 will have these values during the expansion of the success string. At the end
12012 of the &%if%& expansion, the previous values are restored. After testing a
12013 combination of conditions using &%or%&, the subsequent values of the numeric
12014 variables are those of the condition that succeeded.
12015
12016 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12017 .cindex "&%match_address%& expansion condition"
12018 See &*match_local_part*&.
12019
12020 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12021 .cindex "&%match_domain%& expansion condition"
12022 See &*match_local_part*&.
12023
12024 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12025 .cindex "&%match_ip%& expansion condition"
12026 This condition matches an IP address to a list of IP address patterns. It must
12027 be followed by two argument strings. The first (after expansion) must be an IP
12028 address or an empty string. The second (not expanded) is a restricted host
12029 list that can match only an IP address, not a host name. For example:
12030 .code
12031 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12032 .endd
12033 The specific types of host list item that are permitted in the list are:
12034
12035 .ilist
12036 An IP address, optionally with a CIDR mask.
12037 .next
12038 A single asterisk, which matches any IP address.
12039 .next
12040 An empty item, which matches only if the IP address is empty. This could be
12041 useful for testing for a locally submitted message or one from specific hosts
12042 in a single test such as
12043 . ==== As this is a nested list, any displays it contains must be indented
12044 . ==== as otherwise they are too far to the left. This comment applies to
12045 . ==== the use of xmlto plus fop. There's no problem when formatting with
12046 . ==== sdop, with or without the extra indent.
12047 .code
12048   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12049 .endd
12050 where the first item in the list is the empty string.
12051 .next
12052 The item @[] matches any of the local host's interface addresses.
12053 .next
12054 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12055 even if &`net-`& is not specified. There is never any attempt to turn the IP
12056 address into a host name. The most common type of linear search for
12057 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12058 masks. For example:
12059 .code
12060   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12061 .endd
12062 It is of course possible to use other kinds of lookup, and in such a case, you
12063 do need to specify the &`net-`& prefix if you want to specify a specific
12064 address mask, for example:
12065 .code
12066   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12067 .endd
12068 However, unless you are combining a &%match_ip%& condition with others, it is
12069 just as easy to use the fact that a lookup is itself a condition, and write:
12070 .code
12071   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12072 .endd
12073 .endlist ilist
12074
12075 Note that <&'string2'&> is not itself subject to string expansion, unless
12076 Exim was built with the EXPAND_LISTMATCH_RHS option.
12077
12078 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12079
12080 The variable &$value$& will be set for a successful match and can be
12081 used in the success clause of an &%if%& expansion item using the condition.
12082 Any previous &$value$& is restored after the if.
12083
12084 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12085 .cindex "domain list" "in expansion condition"
12086 .cindex "address list" "in expansion condition"
12087 .cindex "local part" "list, in expansion condition"
12088 .cindex "&%match_local_part%& expansion condition"
12089 This condition, together with &%match_address%& and &%match_domain%&, make it
12090 possible to test domain, address, and local part lists within expansions. Each
12091 condition requires two arguments: an item and a list to match. A trivial
12092 example is:
12093 .code
12094 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12095 .endd
12096 In each case, the second argument may contain any of the allowable items for a
12097 list of the appropriate type. Also, because the second argument
12098 is a standard form of list, it is possible to refer to a named list.
12099 Thus, you can use conditions like this:
12100 .code
12101 ${if match_domain{$domain}{+local_domains}{...
12102 .endd
12103 .cindex "&`+caseful`&"
12104 For address lists, the matching starts off caselessly, but the &`+caseful`&
12105 item can be used, as in all address lists, to cause subsequent items to
12106 have their local parts matched casefully. Domains are always matched
12107 caselessly.
12108
12109 The variable &$value$& will be set for a successful match and can be
12110 used in the success clause of an &%if%& expansion item using the condition.
12111 .cindex "tainted data" "de-tainting"
12112 .cindex "de-tainting" "using a match_local_part expansion condition"
12113 It will have the same taint status as the list; expansions such as
12114 .code
12115 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12116 .endd
12117 can be used for de-tainting.
12118 Any previous &$value$& is restored after the if.
12119
12120 Note that <&'string2'&> is not itself subject to string expansion, unless
12121 Exim was built with the EXPAND_LISTMATCH_RHS option.
12122
12123 &*Note*&: Host lists are &'not'& supported in this way. This is because
12124 hosts have two identities: a name and an IP address, and it is not clear
12125 how to specify cleanly how such a test would work. However, IP addresses can be
12126 matched using &%match_ip%&.
12127
12128 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12129 .cindex "PAM authentication"
12130 .cindex "AUTH" "with PAM"
12131 .cindex "Solaris" "PAM support"
12132 .cindex "expansion" "PAM authentication test"
12133 .cindex "&%pam%& expansion condition"
12134 &'Pluggable Authentication Modules'&
12135 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12136 available in Solaris
12137 and in some GNU/Linux distributions.
12138 The Exim support, which is intended for use in conjunction with
12139 the SMTP AUTH command, is available only if Exim is compiled with
12140 .code
12141 SUPPORT_PAM=yes
12142 .endd
12143 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12144 in some releases of GNU/Linux &%-ldl%& is also needed.
12145
12146 The argument string is first expanded, and the result must be a
12147 colon-separated list of strings. Leading and trailing white space is ignored.
12148 The PAM module is initialized with the service name &"exim"& and the user name
12149 taken from the first item in the colon-separated data string (<&'string1'&>).
12150 The remaining items in the data string are passed over in response to requests
12151 from the authentication function. In the simple case there will only be one
12152 request, for a password, so the data consists of just two strings.
12153
12154 There can be problems if any of the strings are permitted to contain colon
12155 characters. In the usual way, these have to be doubled to avoid being taken as
12156 separators.
12157 The &%listquote%& expansion item can be used for this.
12158 For example, the configuration
12159 of a LOGIN authenticator might contain this setting:
12160 .code
12161 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12162 .endd
12163 In some operating systems, PAM authentication can be done only from a process
12164 running as root. Since Exim is running as the Exim user when receiving
12165 messages, this means that PAM cannot be used directly in those systems.
12166 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12167
12168
12169 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12170 .cindex "&'pwcheck'& daemon"
12171 .cindex "Cyrus"
12172 .cindex "expansion" "&'pwcheck'& authentication test"
12173 .cindex "&%pwcheck%& expansion condition"
12174 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12175 This is one way of making it possible for passwords to be checked by a process
12176 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12177 deprecated. Its replacement is &'saslauthd'& (see below).
12178
12179 The pwcheck support is not included in Exim by default. You need to specify
12180 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12181 building Exim. For example:
12182 .code
12183 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12184 .endd
12185 You do not need to install the full Cyrus software suite in order to use
12186 the pwcheck daemon. You can compile and install just the daemon alone
12187 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12188 access to the &_/var/pwcheck_& directory.
12189
12190 The &%pwcheck%& condition takes one argument, which must be the user name and
12191 password, separated by a colon. For example, in a LOGIN authenticator
12192 configuration, you might have this:
12193 .code
12194 server_condition = ${if pwcheck{$auth1:$auth2}}
12195 .endd
12196 Again, for a PLAIN authenticator configuration, this would be:
12197 .code
12198 server_condition = ${if pwcheck{$auth2:$auth3}}
12199 .endd
12200 .vitem &*queue_running*&
12201 .cindex "queue runner" "detecting when delivering from"
12202 .cindex "expansion" "queue runner test"
12203 .cindex "&%queue_running%& expansion condition"
12204 This condition, which has no data, is true during delivery attempts that are
12205 initiated by queue runner processes, and false otherwise.
12206
12207
12208 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12209 .cindex "Radius"
12210 .cindex "expansion" "Radius authentication"
12211 .cindex "&%radius%& expansion condition"
12212 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12213 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12214 the Radius client configuration file in order to build Exim with Radius
12215 support.
12216
12217 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12218 library, using the original API. If you are using release 0.4.0 or later of
12219 this library, you need to set
12220 .code
12221 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12222 .endd
12223 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12224 &%libradius%& library that comes with FreeBSD. To do this, set
12225 .code
12226 RADIUS_LIB_TYPE=RADLIB
12227 .endd
12228 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12229 You may also have to supply a suitable setting in EXTRALIBS so that the
12230 Radius library can be found when Exim is linked.
12231
12232 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12233 Radius client library, which calls the Radius server. The condition is true if
12234 the authentication is successful. For example:
12235 .code
12236 server_condition = ${if radius{<arguments>}}
12237 .endd
12238
12239
12240 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12241         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12242 .cindex "&'saslauthd'& daemon"
12243 .cindex "Cyrus"
12244 .cindex "expansion" "&'saslauthd'& authentication test"
12245 .cindex "&%saslauthd%& expansion condition"
12246 This condition supports user authentication using the Cyrus &'saslauthd'&
12247 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12248 Using this daemon is one way of making it possible for passwords to be checked
12249 by a process that is not running as root.
12250
12251 The saslauthd support is not included in Exim by default. You need to specify
12252 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12253 building Exim. For example:
12254 .code
12255 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12256 .endd
12257 You do not need to install the full Cyrus software suite in order to use
12258 the saslauthd daemon. You can compile and install just the daemon alone
12259 from the Cyrus SASL library.
12260
12261 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12262 two are mandatory. For example:
12263 .code
12264 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12265 .endd
12266 The service and the realm are optional (which is why the arguments are enclosed
12267 in their own set of braces). For details of the meaning of the service and
12268 realm, and how to run the daemon, consult the Cyrus documentation.
12269 .endlist vlist
12270
12271
12272
12273 .section "Combining expansion conditions" "SECID84"
12274 .cindex "expansion" "combining conditions"
12275 Several conditions can be tested at once by combining them using the &%and%&
12276 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12277 conditions on their own, and precede their lists of sub-conditions. Each
12278 sub-condition must be enclosed in braces within the overall braces that contain
12279 the list. No repetition of &%if%& is used.
12280
12281
12282 .vlist
12283 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12284 .cindex "&""or""& expansion condition"
12285 .cindex "expansion" "&""or""& of conditions"
12286 The sub-conditions are evaluated from left to right. The condition is true if
12287 any one of the sub-conditions is true.
12288 For example,
12289 .code
12290 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12291 .endd
12292 When a true sub-condition is found, the following ones are parsed but not
12293 evaluated. If there are several &"match"& sub-conditions the values of the
12294 numeric variables afterwards are taken from the first one that succeeds.
12295
12296 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12297 .cindex "&""and""& expansion condition"
12298 .cindex "expansion" "&""and""& of conditions"
12299 The sub-conditions are evaluated from left to right. The condition is true if
12300 all of the sub-conditions are true. If there are several &"match"&
12301 sub-conditions, the values of the numeric variables afterwards are taken from
12302 the last one. When a false sub-condition is found, the following ones are
12303 parsed but not evaluated.
12304 .endlist
12305 .ecindex IIDexpcond
12306
12307
12308
12309
12310 .section "Expansion variables" "SECTexpvar"
12311 .cindex "expansion" "variables, list of"
12312 This section contains an alphabetical list of all the expansion variables. Some
12313 of them are available only when Exim is compiled with specific options such as
12314 support for TLS or the content scanning extension.
12315 .cindex "tainted data"
12316 Variables marked as &'tainted'& are likely to carry data supplied by
12317 a potential attacker.
12318 Variables without such marking may also, depending on how their
12319 values are created.
12320 Such variables should not be further expanded,
12321 used as filenames
12322 or used as command-line arguments for external commands.
12323
12324 .vlist
12325 .vitem "&$0$&, &$1$&, etc"
12326 .cindex "numerical variables (&$1$& &$2$& etc)"
12327 When a &%match%& expansion condition succeeds, these variables contain the
12328 captured substrings identified by the regular expression during subsequent
12329 processing of the success string of the containing &%if%& expansion item.
12330 In the expansion condition case
12331 they do not retain their values afterwards; in fact, their previous
12332 values are restored at the end of processing an &%if%& item. The numerical
12333 variables may also be set externally by some other matching process which
12334 precedes the expansion of the string. For example, the commands available in
12335 Exim filter files include an &%if%& command with its own regular expression
12336 matching condition.
12337 If the subject string was tainted then any captured substring will also be.
12338
12339 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12340 Within an acl condition, expansion condition or expansion item
12341 any arguments are copied to these variables,
12342 any unused variables being made empty.
12343
12344 .vitem "&$acl_c...$&"
12345 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12346 can be given any name that starts with &$acl_c$& and is at least six characters
12347 long, but the sixth character must be either a digit or an underscore. For
12348 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12349 variables persist throughout the lifetime of an SMTP connection. They can be
12350 used to pass information between ACLs and between different invocations of the
12351 same ACL. When a message is received, the values of these variables are saved
12352 with the message, and can be accessed by filters, routers, and transports
12353 during subsequent delivery.
12354
12355 .vitem "&$acl_m...$&"
12356 These variables are like the &$acl_c...$& variables, except that their values
12357 are reset after a message has been received. Thus, if several messages are
12358 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12359 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12360 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12361 message is received, the values of these variables are saved with the message,
12362 and can be accessed by filters, routers, and transports during subsequent
12363 delivery.
12364
12365 .vitem &$acl_narg$&
12366 Within an acl condition, expansion condition or expansion item
12367 this variable has the number of arguments.
12368
12369 .vitem &$acl_verify_message$&
12370 .vindex "&$acl_verify_message$&"
12371 After an address verification has failed, this variable contains the failure
12372 message. It retains its value for use in subsequent modifiers of the verb.
12373 The message can be preserved by coding like this:
12374 .code
12375 warn !verify = sender
12376      set acl_m0 = $acl_verify_message
12377 .endd
12378 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12379 &%log_message%& modifiers, to include information about the verification
12380 failure.
12381 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12382
12383 .vitem &$address_data$&
12384 .vindex "&$address_data$&"
12385 This variable is set by means of the &%address_data%& option in routers. The
12386 value then remains with the address while it is processed by subsequent routers
12387 and eventually a transport. If the transport is handling multiple addresses,
12388 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12389 for more details. &*Note*&: The contents of &$address_data$& are visible in
12390 user filter files.
12391
12392 If &$address_data$& is set when the routers are called from an ACL to verify
12393 a recipient address, the final value is still in the variable for subsequent
12394 conditions and modifiers of the ACL statement. If routing the address caused it
12395 to be redirected to just one address, the child address is also routed as part
12396 of the verification, and in this case the final value of &$address_data$& is
12397 from the child's routing.
12398
12399 If &$address_data$& is set when the routers are called from an ACL to verify a
12400 sender address, the final value is also preserved, but this time in
12401 &$sender_address_data$&, to distinguish it from data from a recipient
12402 address.
12403
12404 In both cases (recipient and sender verification), the value does not persist
12405 after the end of the current ACL statement. If you want to preserve
12406 these values for longer, you can save them in ACL variables.
12407
12408 .vitem &$address_file$&
12409 .vindex "&$address_file$&"
12410 When, as a result of aliasing, forwarding, or filtering, a message is directed
12411 to a specific file, this variable holds the name of the file when the transport
12412 is running. At other times, the variable is empty. For example, using the
12413 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12414 .code
12415 /home/r2d2/savemail
12416 .endd
12417 then when the &(address_file)& transport is running, &$address_file$&
12418 contains the text string &`/home/r2d2/savemail`&.
12419 .cindex "Sieve filter" "value of &$address_file$&"
12420 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12421 then up to the transport configuration to generate an appropriate absolute path
12422 to the relevant file.
12423
12424 .vitem &$address_pipe$&
12425 .vindex "&$address_pipe$&"
12426 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12427 this variable holds the pipe command when the transport is running.
12428
12429 .vitem "&$auth1$& &-- &$auth4$&"
12430 .vindex "&$auth1$&, &$auth2$&, etc"
12431 These variables are used in SMTP authenticators (see chapters
12432 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12433
12434 .vitem &$authenticated_id$&
12435 .cindex "authentication" "id"
12436 .vindex "&$authenticated_id$&"
12437 When a server successfully authenticates a client it may be configured to
12438 preserve some of the authentication information in the variable
12439 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12440 user/password authenticator configuration might preserve the user name for use
12441 in the routers. Note that this is not the same information that is saved in
12442 &$sender_host_authenticated$&.
12443
12444 When a message is submitted locally (that is, not over a TCP connection)
12445 the value of &$authenticated_id$& is normally the login name of the calling
12446 process. However, a trusted user can override this by means of the &%-oMai%&
12447 command line option.
12448 This second case also sets up information used by the
12449 &$authresults$& expansion item.
12450
12451 .vitem &$authenticated_fail_id$&
12452 .cindex "authentication" "fail" "id"
12453 .vindex "&$authenticated_fail_id$&"
12454 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12455 will contain the failed authentication id. If more than one authentication
12456 id is attempted, it will contain only the last one. The variable is
12457 available for processing in the ACL's, generally the quit or notquit ACL.
12458 A message to a local recipient could still be accepted without requiring
12459 authentication, which means this variable could also be visible in all of
12460 the ACL's as well.
12461
12462
12463 .tvar &$authenticated_sender$&
12464 .cindex "sender" "authenticated"
12465 .cindex "authentication" "sender"
12466 .cindex "AUTH" "on MAIL command"
12467 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12468 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12469 described in section &<<SECTauthparamail>>&. Unless the data is the string
12470 &"<>"&, it is set as the authenticated sender of the message, and the value is
12471 available during delivery in the &$authenticated_sender$& variable. If the
12472 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12473
12474 .vindex "&$qualify_domain$&"
12475 When a message is submitted locally (that is, not over a TCP connection), the
12476 value of &$authenticated_sender$& is an address constructed from the login
12477 name of the calling process and &$qualify_domain$&, except that a trusted user
12478 can override this by means of the &%-oMas%& command line option.
12479
12480
12481 .vitem &$authentication_failed$&
12482 .cindex "authentication" "failure"
12483 .vindex "&$authentication_failed$&"
12484 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12485 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12486 possible to distinguish between &"did not try to authenticate"&
12487 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12488 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12489 is empty and &$authentication_failed$& is set to &"1"&).
12490 Failure includes cancellation of a authentication attempt,
12491 and any negative response to an AUTH command,
12492 (including, for example, an attempt to use an undefined mechanism).
12493
12494 .vitem &$av_failed$&
12495 .cindex "content scanning" "AV scanner failure"
12496 This variable is available when Exim is compiled with the content-scanning
12497 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12498 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12499 the ACL malware condition.
12500
12501 .vitem &$body_linecount$&
12502 .cindex "message body" "line count"
12503 .cindex "body of message" "line count"
12504 .vindex "&$body_linecount$&"
12505 When a message is being received or delivered, this variable contains the
12506 number of lines in the message's body. See also &$message_linecount$&.
12507
12508 .vitem &$body_zerocount$&
12509 .cindex "message body" "binary zero count"
12510 .cindex "body of message" "binary zero count"
12511 .cindex "binary zero" "in message body"
12512 .vindex "&$body_zerocount$&"
12513 When a message is being received or delivered, this variable contains the
12514 number of binary zero bytes (ASCII NULs) in the message's body.
12515
12516 .vitem &$bounce_recipient$&
12517 .vindex "&$bounce_recipient$&"
12518 This is set to the recipient address of a bounce message while Exim is creating
12519 it. It is useful if a customized bounce message text file is in use (see
12520 chapter &<<CHAPemsgcust>>&).
12521
12522 .vitem &$bounce_return_size_limit$&
12523 .vindex "&$bounce_return_size_limit$&"
12524 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12525 up to a multiple of 1000. It is useful when a customized error message text
12526 file is in use (see chapter &<<CHAPemsgcust>>&).
12527
12528 .vitem &$caller_gid$&
12529 .cindex "gid (group id)" "caller"
12530 .vindex "&$caller_gid$&"
12531 The real group id under which the process that called Exim was running. This is
12532 not the same as the group id of the originator of a message (see
12533 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12534 incarnation normally contains the Exim gid.
12535
12536 .vitem &$caller_uid$&
12537 .cindex "uid (user id)" "caller"
12538 .vindex "&$caller_uid$&"
12539 The real user id under which the process that called Exim was running. This is
12540 not the same as the user id of the originator of a message (see
12541 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12542 incarnation normally contains the Exim uid.
12543
12544 .vitem &$callout_address$&
12545 .vindex "&$callout_address$&"
12546 After a callout for verification, spamd or malware daemon service, the
12547 address that was connected to.
12548
12549 .vitem &$compile_number$&
12550 .vindex "&$compile_number$&"
12551 The building process for Exim keeps a count of the number
12552 of times it has been compiled. This serves to distinguish different
12553 compilations of the same version of Exim.
12554
12555 .vitem &$config_dir$&
12556 .vindex "&$config_dir$&"
12557 The directory name of the main configuration file. That is, the content of
12558 &$config_file$& with the last component stripped. The value does not
12559 contain the trailing slash. If &$config_file$& does not contain a slash,
12560 &$config_dir$& is ".".
12561
12562 .vitem &$config_file$&
12563 .vindex "&$config_file$&"
12564 The name of the main configuration file Exim is using.
12565
12566 .vitem &$dkim_verify_status$&
12567 Results of DKIM verification.
12568 For details see section &<<SECDKIMVFY>>&.
12569
12570 .vitem &$dkim_cur_signer$& &&&
12571        &$dkim_verify_reason$& &&&
12572        &$dkim_domain$& &&&
12573        &$dkim_identity$& &&&
12574        &$dkim_selector$& &&&
12575        &$dkim_algo$& &&&
12576        &$dkim_canon_body$& &&&
12577        &$dkim_canon_headers$& &&&
12578        &$dkim_copiedheaders$& &&&
12579        &$dkim_bodylength$& &&&
12580        &$dkim_created$& &&&
12581        &$dkim_expires$& &&&
12582        &$dkim_headernames$& &&&
12583        &$dkim_key_testing$& &&&
12584        &$dkim_key_nosubdomains$& &&&
12585        &$dkim_key_srvtype$& &&&
12586        &$dkim_key_granularity$& &&&
12587        &$dkim_key_notes$& &&&
12588        &$dkim_key_length$&
12589 These variables are only available within the DKIM ACL.
12590 For details see section &<<SECDKIMVFY>>&.
12591
12592 .vitem &$dkim_signers$&
12593 .vindex &$dkim_signers$&
12594 When a message has been received this variable contains
12595 a colon-separated list of signer domains and identities for the message.
12596 For details see section &<<SECDKIMVFY>>&.
12597
12598 .vitem &$dmarc_domain_policy$& &&&
12599        &$dmarc_status$& &&&
12600        &$dmarc_status_text$& &&&
12601        &$dmarc_used_domains$&
12602 Results of DMARC verification.
12603 For details see section &<<SECDMARC>>&.
12604
12605 .vitem &$dnslist_domain$& &&&
12606        &$dnslist_matched$& &&&
12607        &$dnslist_text$& &&&
12608        &$dnslist_value$&
12609 .vindex "&$dnslist_domain$&"
12610 .vindex "&$dnslist_matched$&"
12611 .vindex "&$dnslist_text$&"
12612 .vindex "&$dnslist_value$&"
12613 .cindex "black list (DNS)"
12614 When a DNS (black) list lookup succeeds, these variables are set to contain
12615 the following data from the lookup: the list's domain name, the key that was
12616 looked up, the contents of any associated TXT record, and the value from the
12617 main A record. See section &<<SECID204>>& for more details.
12618
12619 .tvar &$domain$&
12620 When an address is being routed, or delivered on its own, this variable
12621 contains the domain. Uppercase letters in the domain are converted into lower
12622 case for &$domain$&.
12623
12624 Global address rewriting happens when a message is received, so the value of
12625 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12626 is set during user filtering, but not during system filtering, because a
12627 message may have many recipients and the system filter is called just once.
12628
12629 When more than one address is being delivered at once (for example, several
12630 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12631 have the same domain. Transports can be restricted to handling only one domain
12632 at a time if the value of &$domain$& is required at transport time &-- this is
12633 the default for local transports. For further details of the environment in
12634 which local transports are run, see chapter &<<CHAPenvironment>>&.
12635
12636 .oindex "&%delay_warning_condition%&"
12637 At the end of a delivery, if all deferred addresses have the same domain, it is
12638 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12639
12640 The &$domain$& variable is also used in some other circumstances:
12641
12642 .ilist
12643 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12644 the recipient address. The domain of the &'sender'& address is in
12645 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12646 normally set during the running of the MAIL ACL. However, if the sender address
12647 is verified with a callout during the MAIL ACL, the sender domain is placed in
12648 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12649 the &(smtp)& transport.
12650
12651 .next
12652 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12653 &$domain$& contains the domain portion of the address that is being rewritten;
12654 it can be used in the expansion of the replacement address, for example, to
12655 rewrite domains by file lookup.
12656
12657 .next
12658 With one important exception, whenever a domain list is being scanned,
12659 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12660 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12661 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12662 that, in a RCPT ACL, the sender domain list can be dependent on the
12663 recipient domain (which is what is in &$domain$& at this time).
12664
12665 .next
12666 .cindex "ETRN" "value of &$domain$&"
12667 .oindex "&%smtp_etrn_command%&"
12668 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12669 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12670 .endlist
12671
12672 .cindex "tainted data"
12673 If the origin of the data is an incoming message,
12674 the result of expanding this variable is tainted and may not
12675 be further expanded or used as a filename.
12676 When an untainted version is needed, one should be obtained from
12677 looking up the value in a local (therefore trusted) database.
12678 Often &$domain_data$& is usable in this role.
12679
12680
12681 .vitem &$domain_data$&
12682 .vindex "&$domain_data$&"
12683 When the &%domains%& condition on a router
12684 or an ACL
12685 matches a domain
12686 against a list, the match value is copied to &$domain_data$&.
12687 This is an enhancement over previous versions of Exim, when it only
12688 applied to the data read by a lookup.
12689 For details on match values see section &<<SECTlistresults>>& et. al.
12690
12691 If the router routes the
12692 address to a transport, the value is available in that transport. If the
12693 transport is handling multiple addresses, the value from the first address is
12694 used.
12695
12696 &$domain_data$& set in an ACL is available during
12697 the rest of the ACL statement.
12698
12699 .vitem &$exim_gid$&
12700 .vindex "&$exim_gid$&"
12701 This variable contains the numerical value of the Exim group id.
12702
12703 .vitem &$exim_path$&
12704 .vindex "&$exim_path$&"
12705 This variable contains the path to the Exim binary.
12706
12707 .vitem &$exim_uid$&
12708 .vindex "&$exim_uid$&"
12709 This variable contains the numerical value of the Exim user id.
12710
12711 .vitem &$exim_version$&
12712 .vindex "&$exim_version$&"
12713 This variable contains the version string of the Exim build.
12714 The first character is a major version number, currently 4.
12715 Then after a dot, the next group of digits is a minor version number.
12716 There may be other characters following the minor version.
12717 This value may be overridden by the &%exim_version%& main config option.
12718
12719 .vitem &$header_$&<&'name'&>
12720 .tmark
12721 This is not strictly an expansion variable. It is expansion syntax for
12722 inserting the message header line with the given name. Note that the name must
12723 be terminated by colon or white space, because it may contain a wide variety of
12724 characters. Note also that braces must &'not'& be used.
12725 See the full description in section &<<SECTexpansionitems>>& above.
12726
12727 .vitem &$headers_added$&
12728 .vindex "&$headers_added$&"
12729 Within an ACL this variable contains the headers added so far by
12730 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12731 The headers are a newline-separated list.
12732
12733 .vitem &$home$&
12734 .vindex "&$home$&"
12735 When the &%check_local_user%& option is set for a router, the user's home
12736 directory is placed in &$home$& when the check succeeds. In particular, this
12737 means it is set during the running of users' filter files. A router may also
12738 explicitly set a home directory for use by a transport; this can be overridden
12739 by a setting on the transport itself.
12740
12741 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12742 of the environment variable HOME, which is subject to the
12743 &%keep_environment%& and &%add_environment%& main config options.
12744
12745 .vitem &$host$&
12746 .vindex "&$host$&"
12747 If a router assigns an address to a transport (any transport), and passes a
12748 list of hosts with the address, the value of &$host$& when the transport starts
12749 to run is the name of the first host on the list. Note that this applies both
12750 to local and remote transports.
12751
12752 .cindex "transport" "filter"
12753 .cindex "filter" "transport filter"
12754 For the &(smtp)& transport, if there is more than one host, the value of
12755 &$host$& changes as the transport works its way through the list. In
12756 particular, when the &(smtp)& transport is expanding its options for encryption
12757 using TLS, or for specifying a transport filter (see chapter
12758 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12759 is connected.
12760
12761 When used in the client part of an authenticator configuration (see chapter
12762 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12763 client is connected.
12764
12765
12766 .vitem &$host_address$&
12767 .vindex "&$host_address$&"
12768 This variable is set to the remote host's IP address whenever &$host$& is set
12769 for a remote connection. It is also set to the IP address that is being checked
12770 when the &%ignore_target_hosts%& option is being processed.
12771
12772 .vitem &$host_data$&
12773 .vindex "&$host_data$&"
12774 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12775 result of the lookup is made available in the &$host_data$& variable. This
12776 allows you, for example, to do things like this:
12777 .code
12778 deny  hosts = net-lsearch;/some/file
12779       message = $host_data
12780 .endd
12781
12782 .vitem &$host_lookup_deferred$&
12783 .cindex "host name" "lookup, failure of"
12784 .vindex "&$host_lookup_deferred$&"
12785 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12786 message comes from a remote host and there is an attempt to look up the host's
12787 name from its IP address, and the attempt is not successful, one of these
12788 variables is set to &"1"&.
12789
12790 .ilist
12791 If the lookup receives a definite negative response (for example, a DNS lookup
12792 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12793
12794 .next
12795 If there is any kind of problem during the lookup, such that Exim cannot
12796 tell whether or not the host name is defined (for example, a timeout for a DNS
12797 lookup), &$host_lookup_deferred$& is set to &"1"&.
12798 .endlist ilist
12799
12800 Looking up a host's name from its IP address consists of more than just a
12801 single reverse lookup. Exim checks that a forward lookup of at least one of the
12802 names it receives from a reverse lookup yields the original IP address. If this
12803 is not the case, Exim does not accept the looked up name(s), and
12804 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12805 IP address (for example, the existence of a PTR record in the DNS) is not
12806 sufficient on its own for the success of a host name lookup. If the reverse
12807 lookup succeeds, but there is a lookup problem such as a timeout when checking
12808 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12809 &"1"&. See also &$sender_host_name$&.
12810
12811 .cindex authentication "expansion item"
12812 Performing these checks sets up information used by the
12813 &%authresults%& expansion item.
12814
12815
12816 .vitem &$host_lookup_failed$&
12817 .vindex "&$host_lookup_failed$&"
12818 See &$host_lookup_deferred$&.
12819
12820 .vitem &$host_port$&
12821 .vindex "&$host_port$&"
12822 This variable is set to the remote host's TCP port whenever &$host$& is set
12823 for an outbound connection.
12824
12825 .vitem &$initial_cwd$&
12826 .vindex "&$initial_cwd$&
12827 This variable contains the full path name of the initial working
12828 directory of the current Exim process. This may differ from the current
12829 working directory, as Exim changes this to "/" during early startup, and
12830 to &$spool_directory$& later.
12831
12832 .vitem &$inode$&
12833 .vindex "&$inode$&"
12834 The only time this variable is set is while expanding the &%directory_file%&
12835 option in the &(appendfile)& transport. The variable contains the inode number
12836 of the temporary file which is about to be renamed. It can be used to construct
12837 a unique name for the file.
12838
12839 .vitem &$interface_address$& &&&
12840        &$interface_port$&
12841 .vindex "&$interface_address$&"
12842 .vindex "&$interface_port$&"
12843 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12844
12845 .vitem &$item$&
12846 .vindex "&$item$&"
12847 This variable is used during the expansion of &*forall*& and &*forany*&
12848 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12849 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12850 empty.
12851
12852 .vitem &$ldap_dn$&
12853 .vindex "&$ldap_dn$&"
12854 This variable, which is available only when Exim is compiled with LDAP support,
12855 contains the DN from the last entry in the most recently successful LDAP
12856 lookup.
12857
12858 .vitem &$load_average$&
12859 .vindex "&$load_average$&"
12860 This variable contains the system load average, multiplied by 1000 so that it
12861 is an integer. For example, if the load average is 0.21, the value of the
12862 variable is 210. The value is recomputed every time the variable is referenced.
12863
12864 .tvar &$local_part$&
12865 When an address is being routed, or delivered on its own, this
12866 variable contains the local part. When a number of addresses are being
12867 delivered together (for example, multiple RCPT commands in an SMTP
12868 session), &$local_part$& is not set.
12869
12870 Global address rewriting happens when a message is received, so the value of
12871 &$local_part$& during routing and delivery is the value after rewriting.
12872 &$local_part$& is set during user filtering, but not during system filtering,
12873 because a message may have many recipients and the system filter is called just
12874 once.
12875
12876 .cindex "tainted data"
12877 If the origin of the data is an incoming message,
12878 the result of expanding this variable is tainted and
12879 may not be further expanded or used as a filename.
12880
12881 &*Warning*&: the content of this variable is usually provided by a potential
12882 attacker.
12883 Consider carefully the implications of using it unvalidated as a name
12884 for file access.
12885 This presents issues for users' &_.forward_& and filter files.
12886 For traditional full user accounts, use &%check_local_users%& and the
12887 &$local_part_data$& variable rather than this one.
12888 For virtual users, store a suitable pathname component in the database
12889 which is used for account name validation, and use that retrieved value
12890 rather than this variable.
12891 Often &$local_part_data$& is usable in this role.
12892 If needed, use a router &%address_data%& or &%set%& option for
12893 the retrieved data.
12894
12895 When a message is being delivered to a file, pipe, or autoreply transport as a
12896 result of aliasing or forwarding, &$local_part$& is set to the local part of
12897 the parent address, not to the filename or command (see &$address_file$& and
12898 &$address_pipe$&).
12899
12900 When an ACL is running for a RCPT command, &$local_part$& contains the
12901 local part of the recipient address.
12902
12903 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12904 &$local_part$& contains the local part of the address that is being rewritten;
12905 it can be used in the expansion of the replacement address, for example.
12906
12907 In all cases, all quoting is removed from the local part. For example, for both
12908 the addresses
12909 .code
12910 "abc:xyz"@test.example
12911 abc\:xyz@test.example
12912 .endd
12913 the value of &$local_part$& is
12914 .code
12915 abc:xyz
12916 .endd
12917 If you use &$local_part$& to create another address, you should always wrap it
12918 inside a quoting operator. For example, in a &(redirect)& router you could
12919 have:
12920 .code
12921 data = ${quote_local_part:$local_part}@new.domain.example
12922 .endd
12923 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12924 to process local parts in a case-dependent manner in a router, you can set the
12925 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12926
12927 .vitem &$local_part_data$&
12928 .vindex "&$local_part_data$&"
12929 When the &%local_parts%& condition on a router or ACL
12930 matches a local part list
12931 the match value is copied to &$local_part_data$&.
12932 This is an enhancement over previous versions of Exim, when it only
12933 applied to the data read by a lookup.
12934 For details on match values see section &<<SECTlistresults>>& et. al.
12935
12936 The &%check_local_user%& router option also sets this variable.
12937
12938 .vindex &$local_part_prefix$& &&&
12939         &$local_part_prefix_v$& &&&
12940         &$local_part_suffix$& &&&
12941         &$local_part_suffix_v$&
12942 .cindex affix variables
12943 If a local part prefix or suffix has been recognized, it is not included in the
12944 value of &$local_part$& during routing and subsequent delivery. The values of
12945 any prefix or suffix are in &$local_part_prefix$& and
12946 &$local_part_suffix$&, respectively.
12947 .cindex "tainted data"
12948 If the specification did not include a wildcard then
12949 the affix variable value is not tainted.
12950
12951 If the affix specification included a wildcard then the portion of
12952 the affix matched by the wildcard is in
12953 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12954 and both the whole and varying values are tainted.
12955
12956 .vitem &$local_scan_data$&
12957 .vindex "&$local_scan_data$&"
12958 This variable contains the text returned by the &[local_scan()]& function when
12959 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12960
12961 .vitem &$local_user_gid$&
12962 .vindex "&$local_user_gid$&"
12963 See &$local_user_uid$&.
12964
12965 .vitem &$local_user_uid$&
12966 .vindex "&$local_user_uid$&"
12967 This variable and &$local_user_gid$& are set to the uid and gid after the
12968 &%check_local_user%& router precondition succeeds. This means that their values
12969 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12970 and &%condition%&), for the &%address_data%& expansion, and for any
12971 router-specific expansions. At all other times, the values in these variables
12972 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12973
12974 .vitem &$localhost_number$&
12975 .vindex "&$localhost_number$&"
12976 This contains the expanded value of the
12977 &%localhost_number%& option. The expansion happens after the main options have
12978 been read.
12979
12980 .vitem &$log_inodes$&
12981 .vindex "&$log_inodes$&"
12982 The number of free inodes in the disk partition where Exim's
12983 log files are being written. The value is recalculated whenever the variable is
12984 referenced. If the relevant file system does not have the concept of inodes,
12985 the value of is -1. See also the &%check_log_inodes%& option.
12986
12987 .vitem &$log_space$&
12988 .vindex "&$log_space$&"
12989 The amount of free space (as a number of kilobytes) in the disk
12990 partition where Exim's log files are being written. The value is recalculated
12991 whenever the variable is referenced. If the operating system does not have the
12992 ability to find the amount of free space (only true for experimental systems),
12993 the space value is -1. See also the &%check_log_space%& option.
12994
12995
12996 .vitem &$lookup_dnssec_authenticated$&
12997 .vindex "&$lookup_dnssec_authenticated$&"
12998 This variable is set after a DNS lookup done by
12999 a dnsdb lookup expansion, dnslookup router or smtp transport.
13000 .cindex "DNS" "DNSSEC"
13001 It will be empty if &(DNSSEC)& was not requested,
13002 &"no"& if the result was not labelled as authenticated data
13003 and &"yes"& if it was.
13004 Results that are labelled as authoritative answer that match
13005 the &%dns_trust_aa%& configuration variable count also
13006 as authenticated data.
13007
13008 .vitem &$mailstore_basename$&
13009 .vindex "&$mailstore_basename$&"
13010 This variable is set only when doing deliveries in &"mailstore"& format in the
13011 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
13012 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
13013 contains the basename of the files that are being written, that is, the name
13014 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
13015 variable is empty.
13016
13017 .vitem &$malware_name$&
13018 .vindex "&$malware_name$&"
13019 This variable is available when Exim is compiled with the
13020 content-scanning extension. It is set to the name of the virus that was found
13021 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
13022
13023 .vitem &$max_received_linelength$&
13024 .vindex "&$max_received_linelength$&"
13025 .cindex "maximum" "line length"
13026 .cindex "line length" "maximum"
13027 This variable contains the number of bytes in the longest line that was
13028 received as part of the message, not counting the line termination
13029 character(s).
13030 It is not valid if the &%spool_wireformat%& option is used.
13031
13032 .vitem &$message_age$&
13033 .cindex "message" "age of"
13034 .vindex "&$message_age$&"
13035 This variable is set at the start of a delivery attempt to contain the number
13036 of seconds since the message was received. It does not change during a single
13037 delivery attempt.
13038
13039 .tvar &$message_body$&
13040 .cindex "body of message" "expansion variable"
13041 .cindex "message body" "in expansion"
13042 .cindex "binary zero" "in message body"
13043 .oindex "&%message_body_visible%&"
13044 This variable contains the initial portion of a message's body while it is
13045 being delivered, and is intended mainly for use in filter files. The maximum
13046 number of characters of the body that are put into the variable is set by the
13047 &%message_body_visible%& configuration option; the default is 500.
13048
13049 .oindex "&%message_body_newlines%&"
13050 By default, newlines are converted into spaces in &$message_body$&, to make it
13051 easier to search for phrases that might be split over a line break. However,
13052 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13053 zeros are always converted into spaces.
13054
13055 .tvar &$message_body_end$&
13056 .cindex "body of message" "expansion variable"
13057 .cindex "message body" "in expansion"
13058 This variable contains the final portion of a message's
13059 body while it is being delivered. The format and maximum size are as for
13060 &$message_body$&.
13061
13062 .vitem &$message_body_size$&
13063 .cindex "body of message" "size"
13064 .cindex "message body" "size"
13065 .vindex "&$message_body_size$&"
13066 When a message is being delivered, this variable contains the size of the body
13067 in bytes. The count starts from the character after the blank line that
13068 separates the body from the header. Newlines are included in the count. See
13069 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13070
13071 If the spool file is wireformat
13072 (see the &%spool_wireformat%& main option)
13073 the CRLF line-terminators are included in the count.
13074
13075 .vitem &$message_exim_id$&
13076 .vindex "&$message_exim_id$&"
13077 When a message is being received or delivered, this variable contains the
13078 unique message id that is generated and used by Exim to identify the message.
13079 An id is not created for a message until after its header has been successfully
13080 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13081 line; it is the local id that Exim assigns to the message, for example:
13082 &`1BXTIK-0001yO-VA`&.
13083
13084 .tvar &$message_headers$&
13085 This variable contains a concatenation of all the header lines when a message
13086 is being processed, except for lines added by routers or transports. The header
13087 lines are separated by newline characters. Their contents are decoded in the
13088 same way as a header line that is inserted by &%bheader%&.
13089
13090 .tvar &$message_headers_raw$&
13091 This variable is like &$message_headers$& except that no processing of the
13092 contents of header lines is done.
13093
13094 .vitem &$message_id$&
13095 This is an old name for &$message_exim_id$&. It is now deprecated.
13096
13097 .vitem &$message_linecount$&
13098 .vindex "&$message_linecount$&"
13099 This variable contains the total number of lines in the header and body of the
13100 message. Compare &$body_linecount$&, which is the count for the body only.
13101 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13102 number of lines received. Before delivery happens (that is, before filters,
13103 routers, and transports run) the count is increased to include the
13104 &'Received:'& header line that Exim standardly adds, and also any other header
13105 lines that are added by ACLs. The blank line that separates the message header
13106 from the body is not counted.
13107
13108 As with the special case of &$message_size$&, during the expansion of the
13109 appendfile transport's maildir_tag option in maildir format, the value of
13110 &$message_linecount$& is the precise size of the number of newlines in the
13111 file that has been written (minus one for the blank line between the
13112 header and the body).
13113
13114 Here is an example of the use of this variable in a DATA ACL:
13115 .code
13116 deny condition = \
13117       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13118      message   = Too many lines in message header
13119 .endd
13120 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13121 message has not yet been received.
13122
13123 This variable is not valid if the &%spool_wireformat%& option is used.
13124
13125 .vitem &$message_size$&
13126 .cindex "size" "of message"
13127 .cindex "message" "size"
13128 .vindex "&$message_size$&"
13129 When a message is being processed, this variable contains its size in bytes. In
13130 most cases, the size includes those headers that were received with the
13131 message, but not those (such as &'Envelope-to:'&) that are added to individual
13132 deliveries as they are written. However, there is one special case: during the
13133 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13134 doing a delivery in maildir format, the value of &$message_size$& is the
13135 precise size of the file that has been written. See also
13136 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13137
13138 .cindex "RCPT" "value of &$message_size$&"
13139 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13140 contains the size supplied on the MAIL command, or -1 if no size was given. The
13141 value may not, of course, be truthful.
13142
13143 .vitem &$mime_anomaly_level$& &&&
13144        &$mime_anomaly_text$& &&&
13145        &$mime_boundary$& &&&
13146        &$mime_charset$& &&&
13147        &$mime_content_description$& &&&
13148        &$mime_content_disposition$& &&&
13149        &$mime_content_id$& &&&
13150        &$mime_content_size$& &&&
13151        &$mime_content_transfer_encoding$& &&&
13152        &$mime_content_type$& &&&
13153        &$mime_decoded_filename$& &&&
13154        &$mime_filename$& &&&
13155        &$mime_is_coverletter$& &&&
13156        &$mime_is_multipart$& &&&
13157        &$mime_is_rfc822$& &&&
13158        &$mime_part_count$&
13159 A number of variables whose names start with &$mime$& are
13160 available when Exim is compiled with the content-scanning extension. For
13161 details, see section &<<SECTscanmimepart>>&.
13162
13163 .vitem "&$n0$& &-- &$n9$&"
13164 These variables are counters that can be incremented by means
13165 of the &%add%& command in filter files.
13166
13167 .tvar &$original_domain$&
13168 .vindex "&$domain$&"
13169 When a top-level address is being processed for delivery, this contains the
13170 same value as &$domain$&. However, if a &"child"& address (for example,
13171 generated by an alias, forward, or filter file) is being processed, this
13172 variable contains the domain of the original address (lower cased). This
13173 differs from &$parent_domain$& only when there is more than one level of
13174 aliasing or forwarding. When more than one address is being delivered in a
13175 single transport run, &$original_domain$& is not set.
13176
13177 If a new address is created by means of a &%deliver%& command in a system
13178 filter, it is set up with an artificial &"parent"& address. This has the local
13179 part &'system-filter'& and the default qualify domain.
13180
13181 .tvar &$original_local_part$&
13182 .vindex "&$local_part$&"
13183 When a top-level address is being processed for delivery, this contains the
13184 same value as &$local_part$&, unless a prefix or suffix was removed from the
13185 local part, because &$original_local_part$& always contains the full local
13186 part. When a &"child"& address (for example, generated by an alias, forward, or
13187 filter file) is being processed, this variable contains the full local part of
13188 the original address.
13189
13190 If the router that did the redirection processed the local part
13191 case-insensitively, the value in &$original_local_part$& is in lower case.
13192 This variable differs from &$parent_local_part$& only when there is more than
13193 one level of aliasing or forwarding. When more than one address is being
13194 delivered in a single transport run, &$original_local_part$& is not set.
13195
13196 If a new address is created by means of a &%deliver%& command in a system
13197 filter, it is set up with an artificial &"parent"& address. This has the local
13198 part &'system-filter'& and the default qualify domain.
13199
13200 .vitem &$originator_gid$&
13201 .cindex "gid (group id)" "of originating user"
13202 .cindex "sender" "gid"
13203 .vindex "&$caller_gid$&"
13204 .vindex "&$originator_gid$&"
13205 This variable contains the value of &$caller_gid$& that was set when the
13206 message was received. For messages received via the command line, this is the
13207 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13208 normally the gid of the Exim user.
13209
13210 .vitem &$originator_uid$&
13211 .cindex "uid (user id)" "of originating user"
13212 .cindex "sender" "uid"
13213 .vindex "&$caller_uid$&"
13214 .vindex "&$originator_uid$&"
13215 The value of &$caller_uid$& that was set when the message was received. For
13216 messages received via the command line, this is the uid of the sending user.
13217 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13218 user.
13219
13220 .tvar &$parent_domain$&
13221 This variable is similar to &$original_domain$& (see
13222 above), except that it refers to the immediately preceding parent address.
13223
13224 .tvar &$parent_local_part$&
13225 This variable is similar to &$original_local_part$&
13226 (see above), except that it refers to the immediately preceding parent address.
13227
13228 .vitem &$pid$&
13229 .cindex "pid (process id)" "of current process"
13230 .vindex "&$pid$&"
13231 This variable contains the current process id.
13232
13233 .vitem &$pipe_addresses$&
13234 .cindex "filter" "transport filter"
13235 .cindex "transport" "filter"
13236 .vindex "&$pipe_addresses$&"
13237 This is not an expansion variable, but is mentioned here because the string
13238 &`$pipe_addresses`& is handled specially in the command specification for the
13239 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13240 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13241 It cannot be used in general expansion strings, and provokes an &"unknown
13242 variable"& error if encountered.
13243 &*Note*&: This value permits data supplied by a potential attacker to
13244 be used in the command for a &(pipe)& transport.
13245 Such configurations should be carefully assessed for security vulnerbilities.
13246
13247 .vitem &$primary_hostname$&
13248 .vindex "&$primary_hostname$&"
13249 This variable contains the value set by &%primary_hostname%& in the
13250 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13251 a single-component name, Exim calls &[gethostbyname()]& (or
13252 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13253 qualified host name. See also &$smtp_active_hostname$&.
13254
13255
13256 .vitem &$proxy_external_address$& &&&
13257        &$proxy_external_port$& &&&
13258        &$proxy_local_address$& &&&
13259        &$proxy_local_port$& &&&
13260        &$proxy_session$&
13261 These variables are only available when built with Proxy Protocol
13262 or SOCKS5 support.
13263 For details see chapter &<<SECTproxyInbound>>&.
13264
13265 .vitem &$prdr_requested$&
13266 .cindex "PRDR" "variable for"
13267 This variable is set to &"yes"& if PRDR was requested by the client for the
13268 current message, otherwise &"no"&.
13269
13270 .vitem &$prvscheck_address$& &&&
13271        &$prvscheck_keynum$& &&&
13272        &$prvscheck_result$&
13273 These variables are used in conjunction with the &%prvscheck%& expansion item,
13274 which is described in sections &<<SECTexpansionitems>>& and
13275 &<<SECTverifyPRVS>>&.
13276
13277 .vitem &$qualify_domain$&
13278 .vindex "&$qualify_domain$&"
13279 The value set for the &%qualify_domain%& option in the configuration file.
13280
13281 .vitem &$qualify_recipient$&
13282 .vindex "&$qualify_recipient$&"
13283 The value set for the &%qualify_recipient%& option in the configuration file,
13284 or if not set, the value of &$qualify_domain$&.
13285
13286 .vitem &$queue_name$&
13287 .vindex &$queue_name$&
13288 .cindex "named queues" variable
13289 .cindex queues named
13290 The name of the spool queue in use; empty for the default queue.
13291
13292 .vitem &$queue_size$&
13293 .vindex "&$queue_size$&"
13294 .cindex "queue" "size of"
13295 .cindex "spool" "number of messages"
13296 This variable contains the number of messages queued.
13297 It is evaluated on demand, but no more often than once every minute.
13298 If there is no daemon notifier socket open, the value will be
13299 an empty string.
13300
13301 .vitem &$r_...$&
13302 .vindex &$r_...$&
13303 .cindex router variables
13304 Values can be placed in these variables by the &%set%& option of a router.
13305 They can be given any name that starts with &$r_$&.
13306 The values persist for the address being handled through subsequent routers
13307 and the eventual transport.
13308
13309 .vitem &$rcpt_count$&
13310 .vindex "&$rcpt_count$&"
13311 When a message is being received by SMTP, this variable contains the number of
13312 RCPT commands received for the current message. If this variable is used in a
13313 RCPT ACL, its value includes the current command.
13314
13315 .vitem &$rcpt_defer_count$&
13316 .vindex "&$rcpt_defer_count$&"
13317 .cindex "4&'xx'& responses" "count of"
13318 When a message is being received by SMTP, this variable contains the number of
13319 RCPT commands in the current message that have previously been rejected with a
13320 temporary (4&'xx'&) response.
13321
13322 .vitem &$rcpt_fail_count$&
13323 .vindex "&$rcpt_fail_count$&"
13324 When a message is being received by SMTP, this variable contains the number of
13325 RCPT commands in the current message that have previously been rejected with a
13326 permanent (5&'xx'&) response.
13327
13328 .vitem &$received_count$&
13329 .vindex "&$received_count$&"
13330 This variable contains the number of &'Received:'& header lines in the message,
13331 including the one added by Exim (so its value is always greater than zero). It
13332 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13333 delivering.
13334
13335 .tvar &$received_for$&
13336 If there is only a single recipient address in an incoming message, this
13337 variable contains that address when the &'Received:'& header line is being
13338 built. The value is copied after recipient rewriting has happened, but before
13339 the &[local_scan()]& function is run.
13340
13341 .vitem &$received_ip_address$& &&&
13342        &$received_port$&
13343 .vindex "&$received_ip_address$&"
13344 .vindex "&$received_port$&"
13345 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13346 variables are set to the address and port on the local IP interface.
13347 (The remote IP address and port are in
13348 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13349 the port value is -1 unless it has been set using the &%-oMi%& command line
13350 option.
13351
13352 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13353 could be used, for example, to make the filename for a TLS certificate depend
13354 on which interface and/or port is being used for the incoming connection. The
13355 values of &$received_ip_address$& and &$received_port$& are saved with any
13356 messages that are received, thus making these variables available at delivery
13357 time.
13358 For outbound connections see &$sending_ip_address$&.
13359
13360 .vitem &$received_protocol$&
13361 .vindex "&$received_protocol$&"
13362 When a message is being processed, this variable contains the name of the
13363 protocol by which it was received. Most of the names used by Exim are defined
13364 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13365 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13366 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13367 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13368 connection and the client was successfully authenticated.
13369
13370 Exim uses the protocol name &"smtps"& for the case when encryption is
13371 automatically set up on connection without the use of STARTTLS (see
13372 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13373 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13374 where the client initially uses EHLO, sets up an encrypted connection using
13375 STARTTLS, and then uses HELO afterwards.
13376
13377 The &%-oMr%& option provides a way of specifying a custom protocol name for
13378 messages that are injected locally by trusted callers. This is commonly used to
13379 identify messages that are being re-injected after some kind of scanning.
13380
13381 .vitem &$received_time$&
13382 .vindex "&$received_time$&"
13383 This variable contains the date and time when the current message was received,
13384 as a number of seconds since the start of the Unix epoch.
13385
13386 .vitem &$recipient_data$&
13387 .vindex "&$recipient_data$&"
13388 This variable is set after an indexing lookup success in an ACL &%recipients%&
13389 condition. It contains the data from the lookup, and the value remains set
13390 until the next &%recipients%& test. Thus, you can do things like this:
13391 .display
13392 &`require recipients  = cdb*@;/some/file`&
13393 &`deny    `&&'some further test involving'& &`$recipient_data`&
13394 .endd
13395 &*Warning*&: This variable is set only when a lookup is used as an indexing
13396 method in the address list, using the semicolon syntax as in the example above.
13397 The variable is not set for a lookup that is used as part of the string
13398 expansion that all such lists undergo before being interpreted.
13399
13400 .vitem &$recipient_verify_failure$&
13401 .vindex "&$recipient_verify_failure$&"
13402 In an ACL, when a recipient verification fails, this variable contains
13403 information about the failure. It is set to one of the following words:
13404
13405 .ilist
13406 &"qualify"&: The address was unqualified (no domain), and the message
13407 was neither local nor came from an exempted host.
13408
13409 .next
13410 &"route"&: Routing failed.
13411
13412 .next
13413 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13414 or before the MAIL command (that is, on initial connection, HELO, or
13415 MAIL).
13416
13417 .next
13418 &"recipient"&: The RCPT command in a callout was rejected.
13419 .next
13420
13421 &"postmaster"&: The postmaster check in a callout was rejected.
13422 .endlist
13423
13424 The main use of this variable is expected to be to distinguish between
13425 rejections of MAIL and rejections of RCPT.
13426
13427 .tvar &$recipients$&
13428 .tvar &$recipients_list$&
13429 These variables both contain the envelope recipients for a message.
13430
13431 The first uses a comma and a space separate the addresses in the replacement text.
13432 &*Note*&: an address can legitimately contain a comma;
13433 this variable is not intended for further processing.
13434
13435 The second is a proper Exim list; colon-separated.
13436
13437 However, the variables
13438 are not generally available, to prevent exposure of Bcc recipients in
13439 unprivileged users' filter files. You can use either of them  only in these
13440 cases:
13441
13442 .olist
13443 In a system filter file.
13444 .next
13445 In the ACLs associated with the DATA command and with non-SMTP messages, that
13446 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13447 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13448 &%acl_not_smtp_mime%&.
13449 .next
13450 From within a &[local_scan()]& function.
13451 .endlist
13452
13453
13454 .vitem &$recipients_count$&
13455 .vindex "&$recipients_count$&"
13456 When a message is being processed, this variable contains the number of
13457 envelope recipients that came with the message. Duplicates are not excluded
13458 from the count. While a message is being received over SMTP, the number
13459 increases for each accepted recipient. It can be referenced in an ACL.
13460
13461
13462 .vitem &$regex_match_string$&
13463 .vindex "&$regex_match_string$&"
13464 This variable is set to contain the matching regular expression after a
13465 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13466
13467 .vitem "&$regex1$&, &$regex2$&, etc"
13468 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13469 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13470 these variables contain the
13471 captured substrings identified by the regular expression.
13472 If the subject string was tainted then so will any captured substring.
13473
13474
13475 .tvar &$reply_address$&
13476 When a message is being processed, this variable contains the contents of the
13477 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13478 contents of the &'From:'& header line. Apart from the removal of leading
13479 white space, the value is not processed in any way. In particular, no RFC 2047
13480 decoding or character code translation takes place.
13481
13482 .vitem &$return_path$&
13483 .vindex "&$return_path$&"
13484 When a message is being delivered, this variable contains the return path &--
13485 the sender field that will be sent as part of the envelope. It is not enclosed
13486 in <> characters. At the start of routing an address, &$return_path$& has the
13487 same value as &$sender_address$&, but if, for example, an incoming message to a
13488 mailing list has been expanded by a router which specifies a different address
13489 for bounce messages, &$return_path$& subsequently contains the new bounce
13490 address, whereas &$sender_address$& always contains the original sender address
13491 that was received with the message. In other words, &$sender_address$& contains
13492 the incoming envelope sender, and &$return_path$& contains the outgoing
13493 envelope sender.
13494
13495 .vitem &$return_size_limit$&
13496 .vindex "&$return_size_limit$&"
13497 This is an obsolete name for &$bounce_return_size_limit$&.
13498
13499 .vitem &$router_name$&
13500 .cindex "router" "name"
13501 .cindex "name" "of router"
13502 .vindex "&$router_name$&"
13503 During the running of a router, or a transport called,
13504 this variable contains the router name.
13505
13506 .vitem &$runrc$&
13507 .cindex "return code" "from &%run%& expansion"
13508 .vindex "&$runrc$&"
13509 This variable contains the return code from a command that is run by the
13510 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13511 assume the order in which option values are expanded, except for those
13512 preconditions whose order of testing is documented. Therefore, you cannot
13513 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13514 another.
13515
13516 .vitem &$self_hostname$&
13517 .oindex "&%self%&" "value of host name"
13518 .vindex "&$self_hostname$&"
13519 When an address is routed to a supposedly remote host that turns out to be the
13520 local host, what happens is controlled by the &%self%& generic router option.
13521 One of its values causes the address to be passed to another router. When this
13522 happens, &$self_hostname$& is set to the name of the local host that the
13523 original router encountered. In other circumstances its contents are null.
13524
13525 .tvar &$sender_address$&
13526 When a message is being processed, this variable contains the sender's address
13527 that was received in the message's envelope. The case of letters in the address
13528 is retained, in both the local part and the domain. For bounce messages, the
13529 value of this variable is the empty string. See also &$return_path$&.
13530
13531 .vitem &$sender_address_data$&
13532 .vindex "&$address_data$&"
13533 .vindex "&$sender_address_data$&"
13534 If &$address_data$& is set when the routers are called from an ACL to verify a
13535 sender address, the final value is preserved in &$sender_address_data$&, to
13536 distinguish it from data from a recipient address. The value does not persist
13537 after the end of the current ACL statement. If you want to preserve it for
13538 longer, you can save it in an ACL variable.
13539
13540 .tvar &$sender_address_domain$&
13541 The domain portion of &$sender_address$&.
13542
13543 .tvar &$sender_address_local_part$&
13544 The local part portion of &$sender_address$&.
13545
13546 .vitem &$sender_data$&
13547 .vindex "&$sender_data$&"
13548 This variable is set after a lookup success in an ACL &%senders%& condition or
13549 in a router &%senders%& option. It contains the data from the lookup, and the
13550 value remains set until the next &%senders%& test. Thus, you can do things like
13551 this:
13552 .display
13553 &`require senders      = cdb*@;/some/file`&
13554 &`deny    `&&'some further test involving'& &`$sender_data`&
13555 .endd
13556 &*Warning*&: This variable is set only when a lookup is used as an indexing
13557 method in the address list, using the semicolon syntax as in the example above.
13558 The variable is not set for a lookup that is used as part of the string
13559 expansion that all such lists undergo before being interpreted.
13560
13561 .vitem &$sender_fullhost$&
13562 .vindex "&$sender_fullhost$&"
13563 When a message is received from a remote host, this variable contains the host
13564 name and IP address in a single string. It ends with the IP address in square
13565 brackets, followed by a colon and a port number if the logging of ports is
13566 enabled. The format of the rest of the string depends on whether the host
13567 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13568 looking up its IP address. (Looking up the IP address can be forced by the
13569 &%host_lookup%& option, independent of verification.) A plain host name at the
13570 start of the string is a verified host name; if this is not present,
13571 verification either failed or was not requested. A host name in parentheses is
13572 the argument of a HELO or EHLO command. This is omitted if it is identical to
13573 the verified host name or to the host's IP address in square brackets.
13574
13575 .vitem &$sender_helo_dnssec$&
13576 .vindex "&$sender_helo_dnssec$&"
13577 This boolean variable is true if a successful HELO verification was
13578 .cindex "DNS" "DNSSEC"
13579 done using DNS information the resolver library stated was authenticated data.
13580
13581 .tvar &$sender_helo_name$&
13582 When a message is received from a remote host that has issued a HELO or EHLO
13583 command, the argument of that command is placed in this variable. It is also
13584 set if HELO or EHLO is used when a message is received using SMTP locally via
13585 the &%-bs%& or &%-bS%& options.
13586
13587 .vitem &$sender_host_address$&
13588 .vindex "&$sender_host_address$&"
13589 When a message is received from a remote host using SMTP,
13590 this variable contains that
13591 host's IP address. For locally non-SMTP submitted messages, it is empty.
13592
13593 .vitem &$sender_host_authenticated$&
13594 .vindex "&$sender_host_authenticated$&"
13595 This variable contains the name (not the public name) of the authenticator
13596 driver that successfully authenticated the client from which the message was
13597 received. It is empty if there was no successful authentication. See also
13598 &$authenticated_id$&.
13599
13600 .vitem &$sender_host_dnssec$&
13601 .vindex "&$sender_host_dnssec$&"
13602 If an attempt to populate &$sender_host_name$& has been made
13603 (by reference, &%hosts_lookup%& or
13604 otherwise) then this boolean will have been set true if, and only if, the
13605 resolver library states that both
13606 the reverse and forward DNS were authenticated data.  At all
13607 other times, this variable is false.
13608
13609 .cindex "DNS" "DNSSEC"
13610 It is likely that you will need to coerce DNSSEC support on in the resolver
13611 library, by setting:
13612 .code
13613 dns_dnssec_ok = 1
13614 .endd
13615
13616 In addition, on Linux with glibc 2.31 or newer the resolver library will
13617 default to stripping out a successful validation status.
13618 This will break a previously working Exim installation.
13619 Provided that you do trust the resolver (ie, is on localhost) you can tell
13620 glibc to pass through any successful validation with a new option in
13621 &_/etc/resolv.conf_&:
13622 .code
13623 options trust-ad
13624 .endd
13625
13626 Exim does not perform DNSSEC validation itself, instead leaving that to a
13627 validating resolver (e.g. unbound, or bind with suitable configuration).
13628
13629 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13630 mechanism in the list, then this variable will be false.
13631
13632 This requires that your system resolver library support EDNS0 (and that
13633 DNSSEC flags exist in the system headers).  If the resolver silently drops
13634 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13635 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13636
13637
13638 .tvar &$sender_host_name$&
13639 When a message is received from a remote host, this variable contains the
13640 host's name as obtained by looking up its IP address. For messages received by
13641 other means, this variable is empty.
13642
13643 .vindex "&$host_lookup_failed$&"
13644 If the host name has not previously been looked up, a reference to
13645 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13646 A looked up name is accepted only if it leads back to the original IP address
13647 via a forward lookup. If either the reverse or the forward lookup fails to find
13648 any data, or if the forward lookup does not yield the original IP address,
13649 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13650
13651 .vindex "&$host_lookup_deferred$&"
13652 However, if either of the lookups cannot be completed (for example, there is a
13653 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13654 &$host_lookup_failed$& remains set to &"0"&.
13655
13656 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13657 host name again if there is a subsequent reference to &$sender_host_name$&
13658 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13659 is set to &"1"&.
13660
13661 Exim does not automatically look up every calling host's name. If you want
13662 maximum efficiency, you should arrange your configuration so that it avoids
13663 these lookups altogether. The lookup happens only if one or more of the
13664 following are true:
13665
13666 .ilist
13667 A string containing &$sender_host_name$& is expanded.
13668 .next
13669 The calling host matches the list in &%host_lookup%&. In the default
13670 configuration, this option is set to *, so it must be changed if lookups are
13671 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13672 .next
13673 Exim needs the host name in order to test an item in a host list. The items
13674 that require this are described in sections &<<SECThoslispatnam>>& and
13675 &<<SECThoslispatnamsk>>&.
13676 .next
13677 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13678 In this case, the host name is required to compare with the name quoted in any
13679 EHLO or HELO commands that the client issues.
13680 .next
13681 The remote host issues a EHLO or HELO command that quotes one of the
13682 domains in &%helo_lookup_domains%&. The default value of this option is
13683 . ==== As this is a nested list, any displays it contains must be indented
13684 . ==== as otherwise they are too far to the left.
13685 .code
13686   helo_lookup_domains = @ : @[]
13687 .endd
13688 which causes a lookup if a remote host (incorrectly) gives the server's name or
13689 IP address in an EHLO or HELO command.
13690 .endlist
13691
13692
13693 .vitem &$sender_host_port$&
13694 .vindex "&$sender_host_port$&"
13695 When a message is received from a remote host, this variable contains the port
13696 number that was used on the remote host.
13697
13698 .vitem &$sender_ident$&
13699 .vindex "&$sender_ident$&"
13700 When a message is received from a remote host, this variable contains the
13701 identification received in response to an RFC 1413 request. When a message has
13702 been received locally, this variable contains the login name of the user that
13703 called Exim.
13704
13705 .vitem &$sender_rate_$&&'xxx'&
13706 A number of variables whose names begin &$sender_rate_$& are set as part of the
13707 &%ratelimit%& ACL condition. Details are given in section
13708 &<<SECTratelimiting>>&.
13709
13710 .vitem &$sender_rcvhost$&
13711 .cindex "DNS" "reverse lookup"
13712 .cindex "reverse DNS lookup"
13713 .vindex "&$sender_rcvhost$&"
13714 This is provided specifically for use in &'Received:'& headers. It starts with
13715 either the verified host name (as obtained from a reverse DNS lookup) or, if
13716 there is no verified host name, the IP address in square brackets. After that
13717 there may be text in parentheses. When the first item is a verified host name,
13718 the first thing in the parentheses is the IP address in square brackets,
13719 followed by a colon and a port number if port logging is enabled. When the
13720 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13721 the parentheses.
13722
13723 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13724 was used and its argument was not identical to the real host name or IP
13725 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13726 all three items are present in the parentheses, a newline and tab are inserted
13727 into the string, to improve the formatting of the &'Received:'& header.
13728
13729 .vitem &$sender_verify_failure$&
13730 .vindex "&$sender_verify_failure$&"
13731 In an ACL, when a sender verification fails, this variable contains information
13732 about the failure. The details are the same as for
13733 &$recipient_verify_failure$&.
13734
13735 .vitem &$sending_ip_address$&
13736 .vindex "&$sending_ip_address$&"
13737 This variable is set whenever an outgoing SMTP connection to another host has
13738 been set up. It contains the IP address of the local interface that is being
13739 used. This is useful if a host that has more than one IP address wants to take
13740 on different personalities depending on which one is being used. For incoming
13741 connections, see &$received_ip_address$&.
13742
13743 .vitem &$sending_port$&
13744 .vindex "&$sending_port$&"
13745 This variable is set whenever an outgoing SMTP connection to another host has
13746 been set up. It contains the local port that is being used. For incoming
13747 connections, see &$received_port$&.
13748
13749 .vitem &$smtp_active_hostname$&
13750 .vindex "&$smtp_active_hostname$&"
13751 During an incoming SMTP session, this variable contains the value of the active
13752 host name, as specified by the &%smtp_active_hostname%& option. The value of
13753 &$smtp_active_hostname$& is saved with any message that is received, so its
13754 value can be consulted during routing and delivery.
13755
13756 .tvar &$smtp_command$&
13757 During the processing of an incoming SMTP command, this variable contains the
13758 entire command. This makes it possible to distinguish between HELO and EHLO in
13759 the HELO ACL, and also to distinguish between commands such as these:
13760 .code
13761 MAIL FROM:<>
13762 MAIL FROM: <>
13763 .endd
13764 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13765 command, the address in &$smtp_command$& is the original address before any
13766 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13767 the address after SMTP-time rewriting.
13768
13769 .tvar &$smtp_command_argument$&
13770 .cindex "SMTP" "command, argument for"
13771 While an ACL is running to check an SMTP command, this variable contains the
13772 argument, that is, the text that follows the command name, with leading white
13773 space removed. Following the introduction of &$smtp_command$&, this variable is
13774 somewhat redundant, but is retained for backwards compatibility.
13775
13776 .vitem &$smtp_command_history$&
13777 .cindex SMTP "command history"
13778 .vindex "&$smtp_command_history$&"
13779 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13780 received, in time-order left to right.  Only a limited number of commands
13781 are remembered.
13782
13783 .vitem &$smtp_count_at_connection_start$&
13784 .vindex "&$smtp_count_at_connection_start$&"
13785 This variable is set greater than zero only in processes spawned by the Exim
13786 daemon for handling incoming SMTP connections. The name is deliberately long,
13787 in order to emphasize what the contents are. When the daemon accepts a new
13788 connection, it increments this variable. A copy of the variable is passed to
13789 the child process that handles the connection, but its value is fixed, and
13790 never changes. It is only an approximation of how many incoming connections
13791 there actually are, because many other connections may come and go while a
13792 single connection is being processed. When a child process terminates, the
13793 daemon decrements its copy of the variable.
13794
13795 .vitem &$smtp_notquit_reason$&
13796 .vindex "&$smtp_notquit_reason$&"
13797 When the not-QUIT ACL is running, this variable is set to a string
13798 that indicates the reason for the termination of the SMTP connection.
13799
13800 .vitem "&$sn0$& &-- &$sn9$&"
13801 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13802 that were current at the end of the system filter file. This allows a system
13803 filter file to set values that can be tested in users' filter files. For
13804 example, a system filter could set a value indicating how likely it is that a
13805 message is junk mail.
13806
13807 .vitem &$spam_score$& &&&
13808        &$spam_score_int$& &&&
13809        &$spam_bar$& &&&
13810        &$spam_report$& &&&
13811        &$spam_action$&
13812 A number of variables whose names start with &$spam$& are available when Exim
13813 is compiled with the content-scanning extension. For details, see section
13814 &<<SECTscanspamass>>&.
13815
13816 .vitem &$spf_header_comment$& &&&
13817        &$spf_received$& &&&
13818        &$spf_result$& &&&
13819        &$spf_result_guessed$& &&&
13820        &$spf_smtp_comment$&
13821 These variables are only available if Exim is built with SPF support.
13822 For details see section &<<SECSPF>>&.
13823
13824 .vitem &$spool_directory$&
13825 .vindex "&$spool_directory$&"
13826 The name of Exim's spool directory.
13827
13828 .vitem &$spool_inodes$&
13829 .vindex "&$spool_inodes$&"
13830 The number of free inodes in the disk partition where Exim's spool files are
13831 being written. The value is recalculated whenever the variable is referenced.
13832 If the relevant file system does not have the concept of inodes, the value of
13833 is -1. See also the &%check_spool_inodes%& option.
13834
13835 .vitem &$spool_space$&
13836 .vindex "&$spool_space$&"
13837 The amount of free space (as a number of kilobytes) in the disk partition where
13838 Exim's spool files are being written. The value is recalculated whenever the
13839 variable is referenced. If the operating system does not have the ability to
13840 find the amount of free space (only true for experimental systems), the space
13841 value is -1. For example, to check in an ACL that there is at least 50
13842 megabytes free on the spool, you could write:
13843 .code
13844 condition = ${if > {$spool_space}{50000}}
13845 .endd
13846 See also the &%check_spool_space%& option.
13847
13848
13849 .vitem &$thisaddress$&
13850 .vindex "&$thisaddress$&"
13851 This variable is set only during the processing of the &%foranyaddress%&
13852 command in a filter file. Its use is explained in the description of that
13853 command, which can be found in the separate document entitled &'Exim's
13854 interfaces to mail filtering'&.
13855
13856 .vitem &$tls_in_bits$&
13857 .vindex "&$tls_in_bits$&"
13858 Contains an approximation of the TLS cipher's bit-strength
13859 on the inbound connection; the meaning of
13860 this depends upon the TLS implementation used.
13861 If TLS has not been negotiated, the value will be 0.
13862 The value of this is automatically fed into the Cyrus SASL authenticator
13863 when acting as a server, to specify the "external SSF" (a SASL term).
13864
13865 The deprecated &$tls_bits$& variable refers to the inbound side
13866 except when used in the context of an outbound SMTP delivery, when it refers to
13867 the outbound.
13868
13869 .vitem &$tls_out_bits$&
13870 .vindex "&$tls_out_bits$&"
13871 Contains an approximation of the TLS cipher's bit-strength
13872 on an outbound SMTP connection; the meaning of
13873 this depends upon the TLS implementation used.
13874 If TLS has not been negotiated, the value will be 0.
13875
13876 .vitem &$tls_in_ourcert$&
13877 .vindex "&$tls_in_ourcert$&"
13878 .cindex certificate variables
13879 This variable refers to the certificate presented to the peer of an
13880 inbound connection when the message was received.
13881 It is only useful as the argument of a
13882 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13883 or a &%def%& condition.
13884
13885 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13886 when a list of more than one
13887 file is used for &%tls_certificate%&, this variable is not reliable.
13888 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13889
13890 .vitem &$tls_in_peercert$&
13891 .vindex "&$tls_in_peercert$&"
13892 This variable refers to the certificate presented by the peer of an
13893 inbound connection when the message was received.
13894 It is only useful as the argument of a
13895 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13896 or a &%def%& condition.
13897 If certificate verification fails it may refer to a failing chain element
13898 which is not the leaf.
13899
13900 .vitem &$tls_out_ourcert$&
13901 .vindex "&$tls_out_ourcert$&"
13902 This variable refers to the certificate presented to the peer of an
13903 outbound connection.  It is only useful as the argument of a
13904 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13905 or a &%def%& condition.
13906
13907 .vitem &$tls_out_peercert$&
13908 .vindex "&$tls_out_peercert$&"
13909 This variable refers to the certificate presented by the peer of an
13910 outbound connection.  It is only useful as the argument of a
13911 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13912 or a &%def%& condition.
13913 If certificate verification fails it may refer to a failing chain element
13914 which is not the leaf.
13915
13916 .vitem &$tls_in_certificate_verified$&
13917 .vindex "&$tls_in_certificate_verified$&"
13918 This variable is set to &"1"& if a TLS certificate was verified when the
13919 message was received, and &"0"& otherwise.
13920
13921 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13922 except when used in the context of an outbound SMTP delivery, when it refers to
13923 the outbound.
13924
13925 .vitem &$tls_out_certificate_verified$&
13926 .vindex "&$tls_out_certificate_verified$&"
13927 This variable is set to &"1"& if a TLS certificate was verified when an
13928 outbound SMTP connection was made,
13929 and &"0"& otherwise.
13930
13931 .vitem &$tls_in_cipher$&
13932 .vindex "&$tls_in_cipher$&"
13933 .vindex "&$tls_cipher$&"
13934 When a message is received from a remote host over an encrypted SMTP
13935 connection, this variable is set to the cipher suite that was negotiated, for
13936 example DES-CBC3-SHA. In other circumstances, in particular, for message
13937 received over unencrypted connections, the variable is empty. Testing
13938 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13939 non-encrypted connections during ACL processing.
13940
13941 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13942 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13943 becomes the same as &$tls_out_cipher$&.
13944
13945 .vitem &$tls_in_cipher_std$&
13946 .vindex "&$tls_in_cipher_std$&"
13947 As above, but returning the RFC standard name for the cipher suite.
13948
13949 .vitem &$tls_out_cipher$&
13950 .vindex "&$tls_out_cipher$&"
13951 This variable is
13952 cleared before any outgoing SMTP connection is made,
13953 and then set to the outgoing cipher suite if one is negotiated. See chapter
13954 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13955 details of the &(smtp)& transport.
13956
13957 .vitem &$tls_out_cipher_std$&
13958 .vindex "&$tls_out_cipher_std$&"
13959 As above, but returning the RFC standard name for the cipher suite.
13960
13961 .vitem &$tls_out_dane$&
13962 .vindex &$tls_out_dane$&
13963 DANE active status.  See section &<<SECDANE>>&.
13964
13965 .vitem &$tls_in_ocsp$&
13966 .vindex "&$tls_in_ocsp$&"
13967 When a message is received from a remote client connection
13968 the result of any OCSP request from the client is encoded in this variable:
13969 .code
13970 0 OCSP proof was not requested (default value)
13971 1 No response to request
13972 2 Response not verified
13973 3 Verification failed
13974 4 Verification succeeded
13975 .endd
13976
13977 .vitem &$tls_out_ocsp$&
13978 .vindex "&$tls_out_ocsp$&"
13979 When a message is sent to a remote host connection
13980 the result of any OCSP request made is encoded in this variable.
13981 See &$tls_in_ocsp$& for values.
13982
13983 .vitem &$tls_in_peerdn$&
13984 .vindex "&$tls_in_peerdn$&"
13985 .vindex "&$tls_peerdn$&"
13986 .cindex certificate "extracting fields"
13987 When a message is received from a remote host over an encrypted SMTP
13988 connection, and Exim is configured to request a certificate from the client,
13989 the value of the Distinguished Name of the certificate is made available in the
13990 &$tls_in_peerdn$& during subsequent processing.
13991 If certificate verification fails it may refer to a failing chain element
13992 which is not the leaf.
13993
13994 The deprecated &$tls_peerdn$& variable refers to the inbound side
13995 except when used in the context of an outbound SMTP delivery, when it refers to
13996 the outbound.
13997
13998 .vitem &$tls_out_peerdn$&
13999 .vindex "&$tls_out_peerdn$&"
14000 When a message is being delivered to a remote host over an encrypted SMTP
14001 connection, and Exim is configured to request a certificate from the server,
14002 the value of the Distinguished Name of the certificate is made available in the
14003 &$tls_out_peerdn$& during subsequent processing.
14004 If certificate verification fails it may refer to a failing chain element
14005 which is not the leaf.
14006
14007
14008 .vitem &$tls_in_resumption$& &&&
14009        &$tls_out_resumption$&
14010 .vindex &$tls_in_resumption$&
14011 .vindex &$tls_out_resumption$&
14012 .cindex TLS resumption
14013 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
14014
14015
14016 .tvar &$tls_in_sni$&
14017 .vindex "&$tls_sni$&"
14018 .cindex "TLS" "Server Name Indication"
14019 .cindex "TLS" SNI
14020 .cindex SNI "observability on server"
14021 When a TLS session is being established, if the client sends the Server
14022 Name Indication extension, the value will be placed in this variable.
14023 If the variable appears in &%tls_certificate%& then this option and
14024 some others, described in &<<SECTtlssni>>&,
14025 will be re-expanded early in the TLS session, to permit
14026 a different certificate to be presented (and optionally a different key to be
14027 used) to the client, based upon the value of the SNI extension.
14028
14029 The deprecated &$tls_sni$& variable refers to the inbound side
14030 except when used in the context of an outbound SMTP delivery, when it refers to
14031 the outbound.
14032
14033 .vitem &$tls_out_sni$&
14034 .vindex "&$tls_out_sni$&"
14035 .cindex "TLS" "Server Name Indication"
14036 .cindex "TLS" SNI
14037 .cindex SNI "observability in client"
14038 During outbound
14039 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14040 the transport.
14041
14042 .vitem &$tls_out_tlsa_usage$&
14043 .vindex &$tls_out_tlsa_usage$&
14044 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14045
14046 .vitem &$tls_in_ver$&
14047 .vindex "&$tls_in_ver$&"
14048 When a message is received from a remote host over an encrypted SMTP connection
14049 this variable is set to the protocol version, eg &'TLS1.2'&.
14050
14051 .vitem &$tls_out_ver$&
14052 .vindex "&$tls_out_ver$&"
14053 When a message is being delivered to a remote host over an encrypted SMTP connection
14054 this variable is set to the protocol version.
14055
14056
14057 .vitem &$tod_bsdinbox$&
14058 .vindex "&$tod_bsdinbox$&"
14059 The time of day and the date, in the format required for BSD-style mailbox
14060 files, for example: Thu Oct 17 17:14:09 1995.
14061
14062 .vitem &$tod_epoch$&
14063 .vindex "&$tod_epoch$&"
14064 The time and date as a number of seconds since the start of the Unix epoch.
14065
14066 .vitem &$tod_epoch_l$&
14067 .vindex "&$tod_epoch_l$&"
14068 The time and date as a number of microseconds since the start of the Unix epoch.
14069
14070 .vitem &$tod_full$&
14071 .vindex "&$tod_full$&"
14072 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14073 +0100. The timezone is always given as a numerical offset from UTC, with
14074 positive values used for timezones that are ahead (east) of UTC, and negative
14075 values for those that are behind (west).
14076
14077 .vitem &$tod_log$&
14078 .vindex "&$tod_log$&"
14079 The time and date in the format used for writing Exim's log files, for example:
14080 1995-10-12 15:32:29, but without a timezone.
14081
14082 .vitem &$tod_logfile$&
14083 .vindex "&$tod_logfile$&"
14084 This variable contains the date in the format yyyymmdd. This is the format that
14085 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14086 flag.
14087
14088 .vitem &$tod_zone$&
14089 .vindex "&$tod_zone$&"
14090 This variable contains the numerical value of the local timezone, for example:
14091 -0500.
14092
14093 .vitem &$tod_zulu$&
14094 .vindex "&$tod_zulu$&"
14095 This variable contains the UTC date and time in &"Zulu"& format, as specified
14096 by ISO 8601, for example: 20030221154023Z.
14097
14098 .vitem &$transport_name$&
14099 .cindex "transport" "name"
14100 .cindex "name" "of transport"
14101 .vindex "&$transport_name$&"
14102 During the running of a transport, this variable contains its name.
14103
14104 .vitem &$value$&
14105 .vindex "&$value$&"
14106 This variable contains the result of an expansion lookup, extraction operation,
14107 or external command, as described above. It is also used during a
14108 &*reduce*& expansion.
14109
14110 .vitem &$verify_mode$&
14111 .vindex "&$verify_mode$&"
14112 While a router or transport is being run in verify mode or for cutthrough delivery,
14113 contains "S" for sender-verification or "R" for recipient-verification.
14114 Otherwise, empty.
14115
14116 .vitem &$version_number$&
14117 .vindex "&$version_number$&"
14118 The version number of Exim. Same as &$exim_version$&, may be overridden
14119 by the &%exim_version%& main config option.
14120
14121 .vitem &$warn_message_delay$&
14122 .vindex "&$warn_message_delay$&"
14123 This variable is set only during the creation of a message warning about a
14124 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14125
14126 .vitem &$warn_message_recipients$&
14127 .vindex "&$warn_message_recipients$&"
14128 This variable is set only during the creation of a message warning about a
14129 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14130 .endlist
14131 .ecindex IIDstrexp
14132
14133
14134
14135 . ////////////////////////////////////////////////////////////////////////////
14136 . ////////////////////////////////////////////////////////////////////////////
14137
14138 .chapter "Embedded Perl" "CHAPperl"
14139 .scindex IIDperl "Perl" "calling from Exim"
14140 Exim can be built to include an embedded Perl interpreter. When this is done,
14141 Perl subroutines can be called as part of the string expansion process. To make
14142 use of the Perl support, you need version 5.004 or later of Perl installed on
14143 your system. To include the embedded interpreter in the Exim binary, include
14144 the line
14145 .code
14146 EXIM_PERL = perl.o
14147 .endd
14148 in your &_Local/Makefile_& and then build Exim in the normal way.
14149
14150
14151 .section "Setting up so Perl can be used" "SECID85"
14152 .oindex "&%perl_startup%&"
14153 Access to Perl subroutines is via a global configuration option called
14154 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14155 no &%perl_startup%& option in the Exim configuration file then no Perl
14156 interpreter is started and there is almost no overhead for Exim (since none of
14157 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14158 option then the associated value is taken to be Perl code which is executed in
14159 a newly created Perl interpreter.
14160
14161 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14162 need backslashes before any characters to escape special meanings. The option
14163 should usually be something like
14164 .code
14165 perl_startup = do '/etc/exim.pl'
14166 .endd
14167 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14168 use from Exim. Exim can be configured either to start up a Perl interpreter as
14169 soon as it is entered, or to wait until the first time it is needed. Starting
14170 the interpreter at the beginning ensures that it is done while Exim still has
14171 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14172 fact used in a particular run. Also, note that this does not mean that Exim is
14173 necessarily running as root when Perl is called at a later time. By default,
14174 the interpreter is started only when it is needed, but this can be changed in
14175 two ways:
14176
14177 .ilist
14178 .oindex "&%perl_at_start%&"
14179 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14180 a startup when Exim is entered.
14181 .next
14182 The command line option &%-ps%& also requests a startup when Exim is entered,
14183 overriding the setting of &%perl_at_start%&.
14184 .endlist
14185
14186 There is also a command line option &%-pd%& (for delay) which suppresses the
14187 initial startup, even if &%perl_at_start%& is set.
14188
14189 .ilist
14190 .oindex "&%perl_taintmode%&"
14191 .cindex "Perl" "taintmode"
14192 To provide more security executing Perl code via the embedded Perl
14193 interpreter, the &%perl_taintmode%& option can be set. This enables the
14194 taint mode of the Perl interpreter. You are encouraged to set this
14195 option to a true value. To avoid breaking existing installations, it
14196 defaults to false.
14197
14198 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14199
14200
14201 .section "Calling Perl subroutines" "SECID86"
14202 When the configuration file includes a &%perl_startup%& option you can make use
14203 of the string expansion item to call the Perl subroutines that are defined
14204 by the &%perl_startup%& code. The operator is used in any of the following
14205 forms:
14206 .code
14207 ${perl{foo}}
14208 ${perl{foo}{argument}}
14209 ${perl{foo}{argument1}{argument2} ... }
14210 .endd
14211 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14212 arguments may be passed. Passing more than this results in an expansion failure
14213 with an error message of the form
14214 .code
14215 Too many arguments passed to Perl subroutine "foo" (max is 8)
14216 .endd
14217 The return value of the Perl subroutine is evaluated in a scalar context before
14218 it is passed back to Exim to be inserted into the expanded string. If the
14219 return value is &'undef'&, the expansion is forced to fail in the same way as
14220 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14221 by obeying Perl's &%die%& function, the expansion fails with the error message
14222 that was passed to &%die%&.
14223
14224
14225 .section "Calling Exim functions from Perl" "SECID87"
14226 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14227 is available to call back into Exim's string expansion function. For example,
14228 the Perl code
14229 .code
14230 my $lp = Exim::expand_string('$local_part');
14231 .endd
14232 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14233 Note those are single quotes and not double quotes to protect against
14234 &$local_part$& being interpolated as a Perl variable.
14235
14236 If the string expansion is forced to fail by a &"fail"& item, the result of
14237 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14238 expansion string, the Perl call from the original expansion string fails with
14239 an appropriate error message, in the same way as if &%die%& were used.
14240
14241 .cindex "debugging" "from embedded Perl"
14242 .cindex "log" "writing from embedded Perl"
14243 Two other Exim functions are available for use from within Perl code.
14244 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14245 debugging is enabled. If you want a newline at the end, you must supply it.
14246 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14247 timestamp. In this case, you should not supply a terminating newline.
14248
14249
14250 .section "Use of standard output and error by Perl" "SECID88"
14251 .cindex "Perl" "standard output and error"
14252 You should not write to the standard error or output streams from within your
14253 Perl code, as it is not defined how these are set up. In versions of Exim
14254 before 4.50, it is possible for the standard output or error to refer to the
14255 SMTP connection during message reception via the daemon. Writing to this stream
14256 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14257 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14258 avoided, but the output is lost.
14259
14260 .cindex "Perl" "use of &%warn%&"
14261 The Perl &%warn%& statement writes to the standard error stream by default.
14262 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14263 you have no control. When Exim starts up the Perl interpreter, it arranges for
14264 output from the &%warn%& statement to be written to the Exim main log. You can
14265 change this by including appropriate Perl magic somewhere in your Perl code.
14266 For example, to discard &%warn%& output completely, you need this:
14267 .code
14268 $SIG{__WARN__} = sub { };
14269 .endd
14270 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14271 example, the code for the subroutine is empty, so it does nothing, but you can
14272 include any Perl code that you like. The text of the &%warn%& message is passed
14273 as the first subroutine argument.
14274 .ecindex IIDperl
14275
14276
14277 . ////////////////////////////////////////////////////////////////////////////
14278 . ////////////////////////////////////////////////////////////////////////////
14279
14280 .chapter "Starting the daemon and the use of network interfaces" &&&
14281          "CHAPinterfaces" &&&
14282          "Starting the daemon"
14283 .cindex "daemon" "starting"
14284 .cindex "interface" "listening"
14285 .cindex "network interface"
14286 .cindex "interface" "network"
14287 .cindex "IP address" "for listening"
14288 .cindex "daemon" "listening IP addresses"
14289 .cindex "TCP/IP" "setting listening interfaces"
14290 .cindex "TCP/IP" "setting listening ports"
14291 A host that is connected to a TCP/IP network may have one or more physical
14292 hardware network interfaces. Each of these interfaces may be configured as one
14293 or more &"logical"& interfaces, which are the entities that a program actually
14294 works with. Each of these logical interfaces is associated with an IP address.
14295 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14296 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14297 knowledge about the host's interfaces for use in three different circumstances:
14298
14299 .olist
14300 When a listening daemon is started, Exim needs to know which interfaces
14301 and ports to listen on.
14302 .next
14303 When Exim is routing an address, it needs to know which IP addresses
14304 are associated with local interfaces. This is required for the correct
14305 processing of MX lists by removing the local host and others with the
14306 same or higher priority values. Also, Exim needs to detect cases
14307 when an address is routed to an IP address that in fact belongs to the
14308 local host. Unless the &%self%& router option or the &%allow_localhost%&
14309 option of the smtp transport is set (as appropriate), this is treated
14310 as an error situation.
14311 .next
14312 When Exim connects to a remote host, it may need to know which interface to use
14313 for the outgoing connection.
14314 .endlist
14315
14316
14317 Exim's default behaviour is likely to be appropriate in the vast majority
14318 of cases. If your host has only one interface, and you want all its IP
14319 addresses to be treated in the same way, and you are using only the
14320 standard SMTP port, you should not need to take any special action. The
14321 rest of this chapter does not apply to you.
14322
14323 In a more complicated situation you may want to listen only on certain
14324 interfaces, or on different ports, and for this reason there are a number of
14325 options that can be used to influence Exim's behaviour. The rest of this
14326 chapter describes how they operate.
14327
14328 When a message is received over TCP/IP, the interface and port that were
14329 actually used are set in &$received_ip_address$& and &$received_port$&.
14330
14331
14332
14333 .section "Starting a listening daemon" "SECID89"
14334 When a listening daemon is started (by means of the &%-bd%& command line
14335 option), the interfaces and ports on which it listens are controlled by the
14336 following options:
14337
14338 .ilist
14339 &%daemon_smtp_ports%& contains a list of default ports
14340 or service names.
14341 (For backward compatibility, this option can also be specified in the singular.)
14342 .next
14343 &%local_interfaces%& contains list of interface IP addresses on which to
14344 listen. Each item may optionally also specify a port.
14345 .endlist
14346
14347 The default list separator in both cases is a colon, but this can be changed as
14348 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14349 it is usually best to change the separator to avoid having to double all the
14350 colons. For example:
14351 .code
14352 local_interfaces = <; 127.0.0.1 ; \
14353                       192.168.23.65 ; \
14354                       ::1 ; \
14355                       3ffe:ffff:836f::fe86:a061
14356 .endd
14357 There are two different formats for specifying a port along with an IP address
14358 in &%local_interfaces%&:
14359
14360 .olist
14361 The port is added onto the address with a dot separator. For example, to listen
14362 on port 1234 on two different IP addresses:
14363 .code
14364 local_interfaces = <; 192.168.23.65.1234 ; \
14365                       3ffe:ffff:836f::fe86:a061.1234
14366 .endd
14367 .next
14368 The IP address is enclosed in square brackets, and the port is added
14369 with a colon separator, for example:
14370 .code
14371 local_interfaces = <; [192.168.23.65]:1234 ; \
14372                       [3ffe:ffff:836f::fe86:a061]:1234
14373 .endd
14374 .endlist
14375
14376 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14377 default setting contains just one port:
14378 .code
14379 daemon_smtp_ports = smtp
14380 .endd
14381 If more than one port is listed, each interface that does not have its own port
14382 specified listens on all of them. Ports that are listed in
14383 &%daemon_smtp_ports%& can be identified either by name (defined in
14384 &_/etc/services_&) or by number. However, when ports are given with individual
14385 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14386
14387
14388
14389 .section "Special IP listening addresses" "SECID90"
14390 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14391 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14392 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14393 instead of setting up separate listening sockets for each interface. The
14394 default value of &%local_interfaces%& is
14395 .code
14396 local_interfaces = 0.0.0.0
14397 .endd
14398 when Exim is built without IPv6 support; otherwise it is:
14399 .code
14400 local_interfaces = <; ::0 ; 0.0.0.0
14401 .endd
14402 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14403
14404
14405
14406 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14407 The &%-oX%& command line option can be used to override the values of
14408 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14409 instance. Another way of doing this would be to use macros and the &%-D%&
14410 option. However, &%-oX%& can be used by any admin user, whereas modification of
14411 the runtime configuration by &%-D%& is allowed only when the caller is root or
14412 exim.
14413
14414 The value of &%-oX%& is a list of items. The default colon separator can be
14415 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14416 If there are any items that do not
14417 contain dots or colons (that is, are not IP addresses), the value of
14418 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14419 items that do contain dots or colons, the value of &%local_interfaces%& is
14420 replaced by those items. Thus, for example,
14421 .code
14422 -oX 1225
14423 .endd
14424 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14425 whereas
14426 .code
14427 -oX 192.168.34.5.1125
14428 .endd
14429 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14430 (However, since &%local_interfaces%& now contains no items without ports, the
14431 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14432
14433
14434
14435 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14436 .cindex "submissions protocol"
14437 .cindex "ssmtp protocol"
14438 .cindex "smtps protocol"
14439 .cindex "SMTP" "ssmtp protocol"
14440 .cindex "SMTP" "smtps protocol"
14441 Exim supports the use of TLS-on-connect, used by mail clients in the
14442 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14443 For some years, IETF Standards Track documents only blessed the
14444 STARTTLS-based Submission service (port 587) while common practice was to support
14445 the same feature set on port 465, but using TLS-on-connect.
14446 If your installation needs to provide service to mail clients
14447 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14448 the 465 TCP ports.
14449
14450 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14451 service names, connections to those ports must first establish TLS, before
14452 proceeding to the application layer use of the SMTP protocol.
14453
14454 The common use of this option is expected to be
14455 .code
14456 tls_on_connect_ports = 465
14457 .endd
14458 per RFC 8314.
14459 There is also a command line option &%-tls-on-connect%&, which forces all ports
14460 to behave in this way when a daemon is started.
14461
14462 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14463 daemon to listen on those ports. You must still specify them in
14464 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14465 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14466 connections via the daemon.)
14467
14468
14469
14470
14471 .section "IPv6 address scopes" "SECID92"
14472 .cindex "IPv6" "address scopes"
14473 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14474 can, in principle, have the same link-local IPv6 address on different
14475 interfaces. Thus, additional information is needed, over and above the IP
14476 address, to distinguish individual interfaces. A convention of using a
14477 percent sign followed by something (often the interface name) has been
14478 adopted in some cases, leading to addresses like this:
14479 .code
14480 fe80::202:b3ff:fe03:45c1%eth0
14481 .endd
14482 To accommodate this usage, a percent sign followed by an arbitrary string is
14483 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14484 to convert a textual IPv6 address for actual use. This function recognizes the
14485 percent convention in operating systems that support it, and it processes the
14486 address appropriately. Unfortunately, some older libraries have problems with
14487 &[getaddrinfo()]&. If
14488 .code
14489 IPV6_USE_INET_PTON=yes
14490 .endd
14491 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14492 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14493 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14494 function.) Of course, this means that the additional functionality of
14495 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14496
14497 .section "Disabling IPv6" "SECID93"
14498 .cindex "IPv6" "disabling"
14499 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14500 run on a host whose kernel does not support IPv6. The binary will fall back to
14501 using IPv4, but it may waste resources looking up AAAA records, and trying to
14502 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14503 .oindex "&%disable_ipv6%&"
14504 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14505 activities take place. AAAA records are never looked up, and any IPv6 addresses
14506 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14507 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14508 to handle IPv6 literal addresses.
14509
14510 On the other hand, when IPv6 is in use, there may be times when you want to
14511 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14512 option to globally suppress the lookup of AAAA records for specified domains,
14513 and you can use the &%ignore_target_hosts%& generic router option to ignore
14514 IPv6 addresses in an individual router.
14515
14516
14517
14518 .section "Examples of starting a listening daemon" "SECID94"
14519 The default case in an IPv6 environment is
14520 .code
14521 daemon_smtp_ports = smtp
14522 local_interfaces = <; ::0 ; 0.0.0.0
14523 .endd
14524 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14525 Either one or two sockets may be used, depending on the characteristics of
14526 the TCP/IP stack. (This is complicated and messy; for more information,
14527 read the comments in the &_daemon.c_& source file.)
14528
14529 To specify listening on ports 25 and 26 on all interfaces:
14530 .code
14531 daemon_smtp_ports = 25 : 26
14532 .endd
14533 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14534 .code
14535 local_interfaces = <; ::0.25     ; ::0.26 \
14536                       0.0.0.0.25 ; 0.0.0.0.26
14537 .endd
14538 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14539 IPv4 loopback address only:
14540 .code
14541 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14542 .endd
14543 To specify listening on the default port on specific interfaces only:
14544 .code
14545 local_interfaces = 10.0.0.67 : 192.168.34.67
14546 .endd
14547 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14548
14549
14550
14551 .section "Recognizing the local host" "SECTreclocipadd"
14552 The &%local_interfaces%& option is also used when Exim needs to determine
14553 whether or not an IP address refers to the local host. That is, the IP
14554 addresses of all the interfaces on which a daemon is listening are always
14555 treated as local.
14556
14557 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14558 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14559 available interfaces from the operating system, and extracts the relevant
14560 (that is, IPv4 or IPv6) addresses to use for checking.
14561
14562 Some systems set up large numbers of virtual interfaces in order to provide
14563 many virtual web servers. In this situation, you may want to listen for
14564 email on only a few of the available interfaces, but nevertheless treat all
14565 interfaces as local when routing. You can do this by setting
14566 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14567 &"all"& wildcard values. These addresses are recognized as local, but are not
14568 used for listening. Consider this example:
14569 .code
14570 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14571                       192.168.53.235 ; \
14572                       3ffe:2101:12:1:a00:20ff:fe86:a061
14573
14574 extra_local_interfaces = <; ::0 ; 0.0.0.0
14575 .endd
14576 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14577 address, but all available interface addresses are treated as local when
14578 Exim is routing.
14579
14580 In some environments the local host name may be in an MX list, but with an IP
14581 address that is not assigned to any local interface. In other cases it may be
14582 desirable to treat other host names as if they referred to the local host. Both
14583 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14584 This contains host names rather than IP addresses. When a host is referenced
14585 during routing, either via an MX record or directly, it is treated as the local
14586 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14587 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14588
14589
14590
14591 .section "Delivering to a remote host" "SECID95"
14592 Delivery to a remote host is handled by the smtp transport. By default, it
14593 allows the system's TCP/IP functions to choose which interface to use (if
14594 there is more than one) when connecting to a remote host. However, the
14595 &%interface%& option can be set to specify which interface is used. See the
14596 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14597 details.
14598
14599
14600
14601
14602 . ////////////////////////////////////////////////////////////////////////////
14603 . ////////////////////////////////////////////////////////////////////////////
14604
14605 .chapter "Main configuration" "CHAPmainconfig"
14606 .scindex IIDconfima "configuration file" "main section"
14607 .scindex IIDmaiconf "main configuration"
14608 The first part of the runtime configuration file contains three types of item:
14609
14610 .ilist
14611 Macro definitions: These lines start with an upper case letter. See section
14612 &<<SECTmacrodefs>>& for details of macro processing.
14613 .next
14614 Named list definitions: These lines start with one of the words &"domainlist"&,
14615 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14616 section &<<SECTnamedlists>>&.
14617 .next
14618 Main configuration settings: Each setting occupies one line of the file
14619 (with possible continuations). If any setting is preceded by the word
14620 &"hide"&, the &%-bP%& command line option displays its value to admin users
14621 only. See section &<<SECTcos>>& for a description of the syntax of these option
14622 settings.
14623 .endlist
14624
14625 This chapter specifies all the main configuration options, along with their
14626 types and default values. For ease of finding a particular option, they appear
14627 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14628 are now so many options, they are first listed briefly in functional groups, as
14629 an aid to finding the name of the option you are looking for. Some options are
14630 listed in more than one group.
14631
14632 .section "Miscellaneous" "SECID96"
14633 .table2
14634 .row &%add_environment%&             "environment variables"
14635 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14636 .row &%debug_store%&                 "do extra internal checks"
14637 .row &%disable_ipv6%&                "do no IPv6 processing"
14638 .row &%keep_environment%&            "environment variables"
14639 .row &%keep_malformed%&              "for broken files &-- should not happen"
14640 .row &%localhost_number%&            "for unique message ids in clusters"
14641 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14642 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14643 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14644 .row &%print_topbitchars%&           "top-bit characters are printing"
14645 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14646 .row &%timezone%&                    "force time zone"
14647 .endtable
14648
14649
14650 .section "Exim parameters" "SECID97"
14651 .table2
14652 .row &%exim_group%&                  "override compiled-in value"
14653 .row &%exim_path%&                   "override compiled-in value"
14654 .row &%exim_user%&                   "override compiled-in value"
14655 .row &%primary_hostname%&            "default from &[uname()]&"
14656 .row &%split_spool_directory%&       "use multiple directories"
14657 .row &%spool_directory%&             "override compiled-in value"
14658 .endtable
14659
14660
14661
14662 .section "Privilege controls" "SECID98"
14663 .table2
14664 .row &%admin_groups%&                "groups that are Exim admin users"
14665 .row &%commandline_checks_require_admin%& "require admin for various checks"
14666 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14667 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14668 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14669 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14670 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14671 .row &%never_users%&                 "do not run deliveries as these"
14672 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14673 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14674 .row &%trusted_groups%&              "groups that are trusted"
14675 .row &%trusted_users%&               "users that are trusted"
14676 .endtable
14677
14678
14679
14680 .section "Logging" "SECID99"
14681 .table2
14682 .row &%event_action%&                "custom logging"
14683 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14684 .row &%log_file_path%&               "override compiled-in value"
14685 .row &%log_selector%&                "set/unset optional logging"
14686 .row &%log_timezone%&                "add timezone to log lines"
14687 .row &%message_logs%&                "create per-message logs"
14688 .row &%preserve_message_logs%&       "after message completion"
14689 .row &%panic_coredump%&              "request coredump on fatal errors"
14690 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14691 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14692 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14693 .row &%syslog_facility%&             "set syslog &""facility""& field"
14694 .row &%syslog_pid%&                  "pid in syslog lines"
14695 .row &%syslog_processname%&          "set syslog &""ident""& field"
14696 .row &%syslog_timestamp%&            "timestamp syslog lines"
14697 .row &%write_rejectlog%&             "control use of message log"
14698 .endtable
14699
14700
14701
14702 .section "Frozen messages" "SECID100"
14703 .table2
14704 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14705 .row &%freeze_tell%&                 "send message when freezing"
14706 .row &%move_frozen_messages%&        "to another directory"
14707 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14708 .endtable
14709
14710
14711
14712 .section "Data lookups" "SECID101"
14713 .table2
14714 .row &%ibase_servers%&               "InterBase servers"
14715 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14716 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14717 .row &%ldap_cert_file%&              "client cert file for LDAP"
14718 .row &%ldap_cert_key%&               "client key file for LDAP"
14719 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14720 .row &%ldap_default_servers%&        "used if no server in query"
14721 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14722 .row &%ldap_start_tls%&              "require TLS within LDAP"
14723 .row &%ldap_version%&                "set protocol version"
14724 .row &%lookup_open_max%&             "lookup files held open"
14725 .row &%mysql_servers%&               "default MySQL servers"
14726 .row &%oracle_servers%&              "Oracle servers"
14727 .row &%pgsql_servers%&               "default PostgreSQL servers"
14728 .row &%sqlite_lock_timeout%&         "as it says"
14729 .endtable
14730
14731
14732
14733 .section "Message ids" "SECID102"
14734 .table2
14735 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14736 .row &%message_id_header_text%&      "ditto"
14737 .endtable
14738
14739
14740
14741 .section "Embedded Perl Startup" "SECID103"
14742 .table2
14743 .row &%perl_at_start%&               "always start the interpreter"
14744 .row &%perl_startup%&                "code to obey when starting Perl"
14745 .row &%perl_taintmode%&              "enable taint mode in Perl"
14746 .endtable
14747
14748
14749
14750 .section "Daemon" "SECID104"
14751 .table2
14752 .row &%daemon_smtp_ports%&           "default ports"
14753 .row &%daemon_startup_retries%&      "number of times to retry"
14754 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14755 .row &%extra_local_interfaces%&      "not necessarily listened on"
14756 .row &%local_interfaces%&            "on which to listen, with optional ports"
14757 .row &%notifier_socket%&             "override compiled-in value"
14758 .row &%pid_file_path%&               "override compiled-in value"
14759 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14760 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14761 .endtable
14762
14763
14764
14765 .section "Resource control" "SECID105"
14766 .table2
14767 .row &%check_log_inodes%&            "before accepting a message"
14768 .row &%check_log_space%&             "before accepting a message"
14769 .row &%check_spool_inodes%&          "before accepting a message"
14770 .row &%check_spool_space%&           "before accepting a message"
14771 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14772 .row &%queue_only_load%&             "queue incoming if load high"
14773 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14774 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14775 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14776 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14777 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14778 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14779 .row &%smtp_accept_max_per_connection%& "messages per connection"
14780 .row &%smtp_accept_max_per_host%&    "connections from one host"
14781 .row &%smtp_accept_queue%&           "queue mail if more connections"
14782 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14783                                            connection"
14784 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14785 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14786 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14787 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14788 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14789 .endtable
14790
14791
14792
14793 .section "Policy controls" "SECID106"
14794 .table2
14795 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14796 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14797 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14798 .row &%acl_smtp_auth%&               "ACL for AUTH"
14799 .row &%acl_smtp_connect%&            "ACL for connection"
14800 .row &%acl_smtp_data%&               "ACL for DATA"
14801 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14802 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14803 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14804 .row &%acl_smtp_expn%&               "ACL for EXPN"
14805 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14806 .row &%acl_smtp_mail%&               "ACL for MAIL"
14807 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14808 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14809 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14810 .row &%acl_smtp_predata%&            "ACL for start of data"
14811 .row &%acl_smtp_quit%&               "ACL for QUIT"
14812 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14813 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14814 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14815 .row &%av_scanner%&                  "specify virus scanner"
14816 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14817                                       words""&"
14818 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14819 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14820 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14821 .row &%header_maxsize%&              "total size of message header"
14822 .row &%header_line_maxsize%&         "individual header line limit"
14823 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14824 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14825 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14826 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14827 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14828 .row &%host_lookup%&                 "host name looked up for these hosts"
14829 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14830 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14831 .row &%host_reject_connection%&      "reject connection from these hosts"
14832 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14833 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14834 .row &%message_size_limit%&          "for all messages"
14835 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14836 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14837 .row &%spamd_address%&               "set interface to SpamAssassin"
14838 .row &%strict_acl_vars%&             "object to unset ACL variables"
14839 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14840 .endtable
14841
14842
14843
14844 .section "Callout cache" "SECID107"
14845 .table2
14846 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14847                                          item"
14848 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14849                                          item"
14850 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14851 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14852 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14853 .endtable
14854
14855
14856
14857 .section "TLS" "SECID108"
14858 .table2
14859 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14860 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14861 .row &%hosts_require_alpn%&          "mandatory ALPN"
14862 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14863 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14864 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14865 .row &%tls_alpn%&                    "acceptable protocol names"
14866 .row &%tls_certificate%&             "location of server certificate"
14867 .row &%tls_crl%&                     "certificate revocation list"
14868 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14869 .row &%tls_dhparam%&                 "DH parameters for server"
14870 .row &%tls_eccurve%&                 "EC curve selection for server"
14871 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14872 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14873 .row &%tls_privatekey%&              "location of server private key"
14874 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14875 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14876 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14877 .row &%tls_verify_certificates%&     "expected client certificates"
14878 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14879 .endtable
14880
14881
14882
14883 .section "Local user handling" "SECID109"
14884 .table2
14885 .row &%finduser_retries%&            "useful in NIS environments"
14886 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14887 .row &%gecos_pattern%&               "ditto"
14888 .row &%max_username_length%&         "for systems that truncate"
14889 .row &%unknown_login%&               "used when no login name found"
14890 .row &%unknown_username%&            "ditto"
14891 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14892 .row &%uucp_from_sender%&            "ditto"
14893 .endtable
14894
14895
14896
14897 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14898 .table2
14899 .row &%header_maxsize%&              "total size of message header"
14900 .row &%header_line_maxsize%&         "individual header line limit"
14901 .row &%message_size_limit%&          "applies to all messages"
14902 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14903 .row &%received_header_text%&        "expanded to make &'Received:'&"
14904 .row &%received_headers_max%&        "for mail loop detection"
14905 .row &%recipients_max%&              "limit per message"
14906 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14907 .endtable
14908
14909
14910
14911
14912 .section "Non-SMTP incoming messages" "SECID111"
14913 .table2
14914 .row &%receive_timeout%&             "for non-SMTP messages"
14915 .endtable
14916
14917
14918
14919
14920
14921 .section "Incoming SMTP messages" "SECID112"
14922 See also the &'Policy controls'& section above.
14923
14924 .table2
14925 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14926 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14927 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14928 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14929 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14930 .row &%dmarc_history_file%&          "DMARC results log"
14931 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14932 .row &%host_lookup%&                 "host name looked up for these hosts"
14933 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14934 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14935 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14936 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14937 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14938 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14939 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14940 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14941 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14942 .row &%smtp_accept_max_per_connection%& "messages per connection"
14943 .row &%smtp_accept_max_per_host%&    "connections from one host"
14944 .row &%smtp_accept_queue%&           "queue mail if more connections"
14945 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14946                                            connection"
14947 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14948 .row &%smtp_active_hostname%&        "host name to use in messages"
14949 .row &%smtp_banner%&                 "text for welcome banner"
14950 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14951 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14952 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14953 .row &%smtp_etrn_command%&           "what to run for ETRN"
14954 .row &%smtp_etrn_serialize%&         "only one at once"
14955 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14956 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14957 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14958 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14959 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14960 .row &%smtp_receive_timeout%&        "per command or data line"
14961 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14962 .row &%smtp_return_error_details%&   "give detail on rejections"
14963 .endtable
14964
14965
14966
14967 .section "SMTP extensions" "SECID113"
14968 .table2
14969 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14970 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14971 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14972 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14973 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14974 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14975 .row &%limits_advertise_hosts%&      "advertise LIMITS to these hosts"
14976 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14977 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14978 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14979 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14980 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14981 .endtable
14982
14983
14984
14985 .section "Processing messages" "SECID114"
14986 .table2
14987 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14988 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14989 .row &%allow_utf8_domains%&          "in addresses"
14990 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14991                                       words""&"
14992 .row &%delivery_date_remove%&        "from incoming messages"
14993 .row &%envelope_to_remove%&          "from incoming messages"
14994 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14995 .row &%headers_charset%&             "default for translations"
14996 .row &%qualify_domain%&              "default for senders"
14997 .row &%qualify_recipient%&           "default for recipients"
14998 .row &%return_path_remove%&          "from incoming messages"
14999 .row &%strip_excess_angle_brackets%& "in addresses"
15000 .row &%strip_trailing_dot%&          "at end of addresses"
15001 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
15002 .endtable
15003
15004
15005
15006 .section "System filter" "SECID115"
15007 .table2
15008 .row &%system_filter%&               "locate system filter"
15009 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
15010                                             directory"
15011 .row &%system_filter_file_transport%& "transport for delivery to a file"
15012 .row &%system_filter_group%&         "group for filter running"
15013 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
15014 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
15015 .row &%system_filter_user%&          "user for filter running"
15016 .endtable
15017
15018
15019
15020 .section "Routing and delivery" "SECID116"
15021 .table2
15022 .row &%disable_ipv6%&                "do no IPv6 processing"
15023 .row &%dns_again_means_nonexist%&    "for broken domains"
15024 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
15025 .row &%dns_dnssec_ok%&               "parameter for resolver"
15026 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
15027 .row &%dns_retrans%&                 "parameter for resolver"
15028 .row &%dns_retry%&                   "parameter for resolver"
15029 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15030 .row &%dns_use_edns0%&               "parameter for resolver"
15031 .row &%hold_domains%&                "hold delivery for these domains"
15032 .row &%local_interfaces%&            "for routing checks"
15033 .row &%queue_domains%&               "no immediate delivery for these"
15034 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15035 .row &%queue_only%&                  "no immediate delivery at all"
15036 .row &%queue_only_file%&             "no immediate delivery if file exists"
15037 .row &%queue_only_load%&             "no immediate delivery if load is high"
15038 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15039 .row &%queue_only_override%&         "allow command line to override"
15040 .row &%queue_run_in_order%&          "order of arrival"
15041 .row &%queue_run_max%&               "of simultaneous queue runners"
15042 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15043 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15044 .row &%remote_sort_domains%&         "order of remote deliveries"
15045 .row &%retry_data_expire%&           "timeout for retry data"
15046 .row &%retry_interval_max%&          "safety net for retry rules"
15047 .endtable
15048
15049
15050
15051 .section "Bounce and warning messages" "SECID117"
15052 .table2
15053 .row &%bounce_message_file%&         "content of bounce"
15054 .row &%bounce_message_text%&         "content of bounce"
15055 .row &%bounce_return_body%&          "include body if returning message"
15056 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15057 .row &%bounce_return_message%&       "include original message in bounce"
15058 .row &%bounce_return_size_limit%&    "limit on returned message"
15059 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15060 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15061 .row &%errors_copy%&                 "copy bounce messages"
15062 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15063 .row &%delay_warning%&               "time schedule"
15064 .row &%delay_warning_condition%&     "condition for warning messages"
15065 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15066 .row &%smtp_return_error_details%&   "give detail on rejections"
15067 .row &%warn_message_file%&           "content of warning message"
15068 .endtable
15069
15070
15071
15072 .section "Alphabetical list of main options" "SECTalomo"
15073 Those options that undergo string expansion before use are marked with
15074 &dagger;.
15075
15076 .option accept_8bitmime main boolean true
15077 .cindex "8BITMIME"
15078 .cindex "8-bit characters"
15079 .cindex "log" "selectors"
15080 .cindex "log" "8BITMIME"
15081 .cindex "ESMTP extensions" 8BITMIME
15082 This option causes Exim to send 8BITMIME in its response to an SMTP
15083 EHLO command, and to accept the BODY= parameter on MAIL commands.
15084 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15085 takes no steps to do anything special with messages received by this route.
15086
15087 Historically Exim kept this option off by default, but the maintainers
15088 feel that in today's Internet, this causes more problems than it solves.
15089 It now defaults to true.
15090 A more detailed analysis of the issues is provided by Dan Bernstein:
15091 .display
15092 &url(https://cr.yp.to/smtp/8bitmime.html)
15093 .endd
15094
15095 To log received 8BITMIME status use
15096 .code
15097 log_selector = +8bitmime
15098 .endd
15099
15100 .option acl_not_smtp main string&!! unset
15101 .cindex "&ACL;" "for non-SMTP messages"
15102 .cindex "non-SMTP messages" "ACLs for"
15103 This option defines the ACL that is run when a non-SMTP message has been
15104 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15105 further details.
15106
15107 .option acl_not_smtp_mime main string&!! unset
15108 This option defines the ACL that is run for individual MIME parts of non-SMTP
15109 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15110 SMTP messages.
15111
15112 .option acl_not_smtp_start main string&!! unset
15113 .cindex "&ACL;" "at start of non-SMTP message"
15114 .cindex "non-SMTP messages" "ACLs for"
15115 This option defines the ACL that is run before Exim starts reading a
15116 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15117
15118 .option acl_smtp_auth main string&!! unset
15119 .cindex "&ACL;" "setting up for SMTP commands"
15120 .cindex "AUTH" "ACL for"
15121 This option defines the ACL that is run when an SMTP AUTH command is
15122 received. See chapter &<<CHAPACL>>& for further details.
15123
15124 .option acl_smtp_connect main string&!! unset
15125 .cindex "&ACL;" "on SMTP connection"
15126 This option defines the ACL that is run when an SMTP connection is received.
15127 See chapter &<<CHAPACL>>& for further details.
15128
15129 .option acl_smtp_data main string&!! unset
15130 .cindex "DATA" "ACL for"
15131 This option defines the ACL that is run after an SMTP DATA command has been
15132 processed and the message itself has been received, but before the final
15133 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15134
15135 .option acl_smtp_data_prdr main string&!! accept
15136 .cindex "PRDR" "ACL for"
15137 .cindex "DATA" "PRDR ACL for"
15138 .cindex "&ACL;" "PRDR-related"
15139 .cindex "&ACL;" "per-user data processing"
15140 This option defines the ACL that,
15141 if the PRDR feature has been negotiated,
15142 is run for each recipient after an SMTP DATA command has been
15143 processed and the message itself has been received, but before the
15144 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15145
15146 .option acl_smtp_dkim main string&!! unset
15147 .cindex DKIM "ACL for"
15148 This option defines the ACL that is run for each DKIM signature
15149 (by default, or as specified in the dkim_verify_signers option)
15150 of a received message.
15151 See section &<<SECDKIMVFY>>& for further details.
15152
15153 .option acl_smtp_etrn main string&!! unset
15154 .cindex "ETRN" "ACL for"
15155 This option defines the ACL that is run when an SMTP ETRN command is
15156 received. See chapter &<<CHAPACL>>& for further details.
15157
15158 .option acl_smtp_expn main string&!! unset
15159 .cindex "EXPN" "ACL for"
15160 This option defines the ACL that is run when an SMTP EXPN command is
15161 received. See chapter &<<CHAPACL>>& for further details.
15162
15163 .option acl_smtp_helo main string&!! unset
15164 .cindex "EHLO" "ACL for"
15165 .cindex "HELO" "ACL for"
15166 This option defines the ACL that is run when an SMTP EHLO or HELO
15167 command is received. See chapter &<<CHAPACL>>& for further details.
15168
15169
15170 .option acl_smtp_mail main string&!! unset
15171 .cindex "MAIL" "ACL for"
15172 This option defines the ACL that is run when an SMTP MAIL command is
15173 received. See chapter &<<CHAPACL>>& for further details.
15174
15175 .option acl_smtp_mailauth main string&!! unset
15176 .cindex "AUTH" "on MAIL command"
15177 This option defines the ACL that is run when there is an AUTH parameter on
15178 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15179 &<<CHAPSMTPAUTH>>& for details of authentication.
15180
15181 .option acl_smtp_mime main string&!! unset
15182 .cindex "MIME content scanning" "ACL for"
15183 This option is available when Exim is built with the content-scanning
15184 extension. It defines the ACL that is run for each MIME part in a message. See
15185 section &<<SECTscanmimepart>>& for details.
15186
15187 .option acl_smtp_notquit main string&!! unset
15188 .cindex "not-QUIT, ACL for"
15189 This option defines the ACL that is run when an SMTP session
15190 ends without a QUIT command being received.
15191 See chapter &<<CHAPACL>>& for further details.
15192
15193 .option acl_smtp_predata main string&!! unset
15194 This option defines the ACL that is run when an SMTP DATA command is
15195 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15196 further details.
15197
15198 .option acl_smtp_quit main string&!! unset
15199 .cindex "QUIT, ACL for"
15200 This option defines the ACL that is run when an SMTP QUIT command is
15201 received. See chapter &<<CHAPACL>>& for further details.
15202
15203 .option acl_smtp_rcpt main string&!! unset
15204 .cindex "RCPT" "ACL for"
15205 This option defines the ACL that is run when an SMTP RCPT command is
15206 received. See chapter &<<CHAPACL>>& for further details.
15207
15208 .option acl_smtp_starttls main string&!! unset
15209 .cindex "STARTTLS, ACL for"
15210 This option defines the ACL that is run when an SMTP STARTTLS command is
15211 received. See chapter &<<CHAPACL>>& for further details.
15212
15213 .option acl_smtp_vrfy main string&!! unset
15214 .cindex "VRFY" "ACL for"
15215 This option defines the ACL that is run when an SMTP VRFY command is
15216 received. See chapter &<<CHAPACL>>& for further details.
15217
15218 .option add_environment main "string list" empty
15219 .cindex "environment" "set values"
15220 This option adds individual environment variables that the
15221 currently linked libraries and programs in child processes may use.
15222 Each list element should be of the form &"name=value"&.
15223
15224 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15225
15226 .option admin_groups main "string list&!!" unset
15227 .cindex "admin user"
15228 This option is expanded just once, at the start of Exim's processing. If the
15229 current group or any of the supplementary groups of an Exim caller is in this
15230 colon-separated list, the caller has admin privileges. If all your system
15231 programmers are in a specific group, for example, you can give them all Exim
15232 admin privileges by putting that group in &%admin_groups%&. However, this does
15233 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15234 To permit this, you have to add individuals to the Exim group.
15235
15236 .option allow_domain_literals main boolean false
15237 .cindex "domain literal"
15238 If this option is set, the RFC 2822 domain literal format is permitted in
15239 email addresses. The option is not set by default, because the domain literal
15240 format is not normally required these days, and few people know about it. It
15241 has, however, been exploited by mail abusers.
15242
15243 Unfortunately, it seems that some DNS black list maintainers are using this
15244 format to report black listing to postmasters. If you want to accept messages
15245 addressed to your hosts by IP address, you need to set
15246 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15247 domains (defined in the named domain list &%local_domains%& in the default
15248 configuration). This &"magic string"& matches the domain literal form of all
15249 the local host's IP addresses.
15250
15251 .option allow_mx_to_ip main boolean false
15252 .cindex "MX record" "pointing to IP address"
15253 It appears that more and more DNS zone administrators are breaking the rules
15254 and putting domain names that look like IP addresses on the right hand side of
15255 MX records. Exim follows the rules and rejects this, giving an error message
15256 that explains the misconfiguration. However, some other MTAs support this
15257 practice, so to avoid &"Why can't Exim do this?"& complaints,
15258 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15259 recommended, except when you have no other choice.
15260
15261 .option allow_utf8_domains main boolean false
15262 .cindex "domain" "UTF-8 characters in"
15263 .cindex "UTF-8" "in domain name"
15264 Lots of discussion is going on about internationalized domain names. One
15265 camp is strongly in favour of just using UTF-8 characters, and it seems
15266 that at least two other MTAs permit this.
15267 This option allows Exim users to experiment if they wish.
15268
15269 If it is set true, Exim's domain parsing function allows valid
15270 UTF-8 multicharacters to appear in domain name components, in addition to
15271 letters, digits, and hyphens.
15272
15273 If Exim is built with internationalization support
15274 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15275 this option can be left as default.
15276 Without that,
15277 if you want to look up such domain names in the DNS, you must also
15278 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15279 suitable setting is:
15280 .code
15281 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15282   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15283 .endd
15284 Alternatively, you can just disable this feature by setting
15285 .code
15286 dns_check_names_pattern =
15287 .endd
15288 That is, set the option to an empty string so that no check is done.
15289
15290
15291 .option auth_advertise_hosts main "host list&!!" *
15292 .cindex "authentication" "advertising"
15293 .cindex "AUTH" "advertising"
15294 .cindex "ESMTP extensions" AUTH
15295 If any server authentication mechanisms are configured, Exim advertises them in
15296 response to an EHLO command only if the calling host matches this list.
15297 Otherwise, Exim does not advertise AUTH.
15298 Exim does not accept AUTH commands from clients to which it has not
15299 advertised the availability of AUTH. The advertising of individual
15300 authentication mechanisms can be controlled by the use of the
15301 &%server_advertise_condition%& generic authenticator option on the individual
15302 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15303
15304 Certain mail clients (for example, Netscape) require the user to provide a name
15305 and password for authentication if AUTH is advertised, even though it may
15306 not be needed (the host may accept messages from hosts on its local LAN without
15307 authentication, for example). The &%auth_advertise_hosts%& option can be used
15308 to make these clients more friendly by excluding them from the set of hosts to
15309 which Exim advertises AUTH.
15310
15311 .cindex "AUTH" "advertising when encrypted"
15312 If you want to advertise the availability of AUTH only when the connection
15313 is encrypted using TLS, you can make use of the fact that the value of this
15314 option is expanded, with a setting like this:
15315 .code
15316 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15317 .endd
15318 .vindex "&$tls_in_cipher$&"
15319 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15320 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15321 expansion is *, which matches all hosts.
15322
15323
15324 .option auto_thaw main time 0s
15325 .cindex "thawing messages"
15326 .cindex "unfreezing messages"
15327 If this option is set to a time greater than zero, a queue runner will try a
15328 new delivery attempt on any frozen message, other than a bounce message, if
15329 this much time has passed since it was frozen. This may result in the message
15330 being re-frozen if nothing has changed since the last attempt. It is a way of
15331 saying &"keep on trying, even though there are big problems"&.
15332
15333 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15334 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15335 thought to be very useful any more, and its use should probably be avoided.
15336
15337
15338 .option av_scanner main string "see below"
15339 This option is available if Exim is built with the content-scanning extension.
15340 It specifies which anti-virus scanner to use. The default value is:
15341 .code
15342 sophie:/var/run/sophie
15343 .endd
15344 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15345 before use. See section &<<SECTscanvirus>>& for further details.
15346
15347
15348 .option bi_command main string unset
15349 .oindex "&%-bi%&"
15350 This option supplies the name of a command that is run when Exim is called with
15351 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15352 just the command name, it is not a complete command line. If an argument is
15353 required, it must come from the &%-oA%& command line option.
15354
15355
15356 .option bounce_message_file main string&!! unset
15357 .cindex "bounce message" "customizing"
15358 .cindex "customizing" "bounce message"
15359 This option defines a template file containing paragraphs of text to be used
15360 for constructing bounce messages.  Details of the file's contents are given in
15361 chapter &<<CHAPemsgcust>>&.
15362 .cindex bounce_message_file "tainted data"
15363 The option is expanded to give the file path, which must be
15364 absolute and untainted.
15365 See also &%warn_message_file%&.
15366
15367
15368 .option bounce_message_text main string unset
15369 When this option is set, its contents are included in the default bounce
15370 message immediately after &"This message was created automatically by mail
15371 delivery software."& It is not used if &%bounce_message_file%& is set.
15372
15373 .option bounce_return_body main boolean true
15374 .cindex "bounce message" "including body"
15375 This option controls whether the body of an incoming message is included in a
15376 bounce message when &%bounce_return_message%& is true. The default setting
15377 causes the entire message, both header and body, to be returned (subject to the
15378 value of &%bounce_return_size_limit%&). If this option is false, only the
15379 message header is included. In the case of a non-SMTP message containing an
15380 error that is detected during reception, only those header lines preceding the
15381 point at which the error was detected are returned.
15382 .cindex "bounce message" "including original"
15383
15384 .option bounce_return_linesize_limit main integer 998
15385 .cindex "size" "of bounce lines, limit"
15386 .cindex "bounce message" "line length limit"
15387 .cindex "limit" "bounce message line length"
15388 This option sets a limit in bytes on the line length of messages
15389 that are returned to senders due to delivery problems,
15390 when &%bounce_return_message%& is true.
15391 The default value corresponds to RFC limits.
15392 If the message being returned has lines longer than this value it is
15393 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15394
15395 The option also applies to bounces returned when an error is detected
15396 during reception of a message.
15397 In this case lines from the original are truncated.
15398
15399 The option does not apply to messages generated by an &(autoreply)& transport.
15400
15401
15402 .option bounce_return_message main boolean true
15403 If this option is set false, none of the original message is included in
15404 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15405 &%bounce_return_body%&.
15406
15407
15408 .option bounce_return_size_limit main integer 100K
15409 .cindex "size" "of bounce, limit"
15410 .cindex "bounce message" "size limit"
15411 .cindex "limit" "bounce message size"
15412 This option sets a limit in bytes on the size of messages that are returned to
15413 senders as part of bounce messages when &%bounce_return_message%& is true. The
15414 limit should be less than the value of the global &%message_size_limit%& and of
15415 any &%message_size_limit%& settings on transports, to allow for the bounce text
15416 that Exim generates. If this option is set to zero there is no limit.
15417
15418 When the body of any message that is to be included in a bounce message is
15419 greater than the limit, it is truncated, and a comment pointing this out is
15420 added at the top. The actual cutoff may be greater than the value given, owing
15421 to the use of buffering for transferring the message in chunks (typically 8K in
15422 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15423 messages.
15424
15425 .option bounce_sender_authentication main string unset
15426 .cindex "bounce message" "sender authentication"
15427 .cindex "authentication" "bounce message"
15428 .cindex "AUTH" "on bounce message"
15429 This option provides an authenticated sender address that is sent with any
15430 bounce messages generated by Exim that are sent over an authenticated SMTP
15431 connection. A typical setting might be:
15432 .code
15433 bounce_sender_authentication = mailer-daemon@my.domain.example
15434 .endd
15435 which would cause bounce messages to be sent using the SMTP command:
15436 .code
15437 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15438 .endd
15439 The value of &%bounce_sender_authentication%& must always be a complete email
15440 address.
15441
15442 .option callout_domain_negative_expire main time 3h
15443 .cindex "caching" "callout timeouts"
15444 .cindex "callout" "caching timeouts"
15445 This option specifies the expiry time for negative callout cache data for a
15446 domain. See section &<<SECTcallver>>& for details of callout verification, and
15447 section &<<SECTcallvercache>>& for details of the caching.
15448
15449
15450 .option callout_domain_positive_expire main time 7d
15451 This option specifies the expiry time for positive callout cache data for a
15452 domain. See section &<<SECTcallver>>& for details of callout verification, and
15453 section &<<SECTcallvercache>>& for details of the caching.
15454
15455
15456 .option callout_negative_expire main time 2h
15457 This option specifies the expiry time for negative callout cache data for an
15458 address. See section &<<SECTcallver>>& for details of callout verification, and
15459 section &<<SECTcallvercache>>& for details of the caching.
15460
15461
15462 .option callout_positive_expire main time 24h
15463 This option specifies the expiry time for positive callout cache data for an
15464 address. See section &<<SECTcallver>>& for details of callout verification, and
15465 section &<<SECTcallvercache>>& for details of the caching.
15466
15467
15468 .option callout_random_local_part main string&!! "see below"
15469 This option defines the &"random"& local part that can be used as part of
15470 callout verification. The default value is
15471 .code
15472 $primary_hostname-$tod_epoch-testing
15473 .endd
15474 See section &<<CALLaddparcall>>& for details of how this value is used.
15475
15476
15477 .options check_log_inodes main integer 100 &&&
15478          check_log_space main integer 10M
15479 See &%check_spool_space%& below.
15480
15481 .oindex "&%check_rfc2047_length%&"
15482 .cindex "RFC 2047" "disabling length check"
15483 .option check_rfc2047_length main boolean true
15484 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15485 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15486 word; strings to be encoded that exceed this length are supposed to use
15487 multiple encoded words. By default, Exim does not recognize encoded words that
15488 exceed the maximum length. However, it seems that some software, in violation
15489 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15490 set false, Exim recognizes encoded words of any length.
15491
15492
15493 .options check_spool_inodes main integer 100 &&&
15494          check_spool_space main integer 10M
15495 .cindex "checking disk space"
15496 .cindex "disk space, checking"
15497 .cindex "spool directory" "checking space"
15498 The four &%check_...%& options allow for checking of disk resources before a
15499 message is accepted.
15500
15501 .vindex "&$log_inodes$&"
15502 .vindex "&$log_space$&"
15503 .vindex "&$spool_inodes$&"
15504 .vindex "&$spool_space$&"
15505 When any of these options are nonzero, they apply to all incoming messages. If you
15506 want to apply different checks to different kinds of message, you can do so by
15507 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15508 &$spool_space$& in an ACL with appropriate additional conditions.
15509
15510
15511 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15512 either value is greater than zero, for example:
15513 .code
15514 check_spool_space = 100M
15515 check_spool_inodes = 100
15516 .endd
15517 The spool partition is the one that contains the directory defined by
15518 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15519 transit.
15520
15521 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15522 files are written if either is greater than zero. These should be set only if
15523 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15524
15525 If there is less space or fewer inodes than requested, Exim refuses to accept
15526 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15527 error response to the MAIL command. If ESMTP is in use and there was a
15528 SIZE parameter on the MAIL command, its value is added to the
15529 &%check_spool_space%& value, and the check is performed even if
15530 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15531
15532 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15533 number of kilobytes (though specified in bytes).
15534 If a non-multiple of 1024 is specified, it is rounded up.
15535
15536 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15537 failure a message is written to stderr and Exim exits with a non-zero code, as
15538 it obviously cannot send an error message of any kind.
15539
15540 There is a slight performance penalty for these checks.
15541 Versions of Exim preceding 4.88 had these disabled by default;
15542 high-rate installations confident they will never run out of resources
15543 may wish to deliberately disable them.
15544
15545 .option chunking_advertise_hosts main "host list&!!" *
15546 .cindex CHUNKING advertisement
15547 .cindex "RFC 3030" "CHUNKING"
15548 .cindex "ESMTP extensions" CHUNKING
15549 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15550 these hosts.
15551 Hosts may use the BDAT command as an alternate to DATA.
15552
15553 .option commandline_checks_require_admin main boolean &`false`&
15554 .cindex "restricting access to features"
15555 This option restricts various basic checking features to require an
15556 administrative user.
15557 This affects most of the &%-b*%& options, such as &%-be%&.
15558
15559 .option debug_store main boolean &`false`&
15560 .cindex debugging "memory corruption"
15561 .cindex memory debugging
15562 This option, when true, enables extra checking in Exim's internal memory
15563 management.  For use when a memory corruption issue is being investigated,
15564 it should normally be left as default.
15565
15566 .option daemon_smtp_ports main string &`smtp`&
15567 .cindex "port" "for daemon"
15568 .cindex "TCP/IP" "setting listening ports"
15569 This option specifies one or more default SMTP ports on which the Exim daemon
15570 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15571 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15572
15573 .options daemon_startup_retries main integer 9 &&&
15574          daemon_startup_sleep main time 30s
15575 .cindex "daemon startup, retrying"
15576 These options control the retrying done by
15577 the daemon at startup when it cannot immediately bind a listening socket
15578 (typically because the socket is already in use): &%daemon_startup_retries%&
15579 defines the number of retries after the first failure, and
15580 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15581
15582 .option delay_warning main "time list" 24h
15583 .cindex "warning of delay"
15584 .cindex "delay warning, specifying"
15585 .cindex "queue" "delay warning"
15586 When a message is delayed, Exim sends a warning message to the sender at
15587 intervals specified by this option. The data is a colon-separated list of times
15588 after which to send warning messages. If the value of the option is an empty
15589 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15590 message has been in the queue for longer than the last time, the last interval
15591 between the times is used to compute subsequent warning times. For example,
15592 with
15593 .code
15594 delay_warning = 4h:8h:24h
15595 .endd
15596 the first message is sent after 4 hours, the second after 8 hours, and
15597 the third one after 24 hours. After that, messages are sent every 16 hours,
15598 because that is the interval between the last two times on the list. If you set
15599 just one time, it specifies the repeat interval. For example, with:
15600 .code
15601 delay_warning = 6h
15602 .endd
15603 messages are repeated every six hours. To stop warnings after a given time, set
15604 a very large time at the end of the list. For example:
15605 .code
15606 delay_warning = 2h:12h:99d
15607 .endd
15608 Note that the option is only evaluated at the time a delivery attempt fails,
15609 which depends on retry and queue-runner configuration.
15610 Typically retries will be configured more frequently than warning messages.
15611
15612 .option delay_warning_condition main string&!! "see below"
15613 .vindex "&$domain$&"
15614 The string is expanded at the time a warning message might be sent. If all the
15615 deferred addresses have the same domain, it is set in &$domain$& during the
15616 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15617 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15618 &"false"& (the comparison being done caselessly) then the warning message is
15619 not sent. The default is:
15620 .code
15621 delay_warning_condition = ${if or {\
15622   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15623   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15624   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15625   } {no}{yes}}
15626 .endd
15627 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15628 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15629 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15630 &"auto-replied"& in an &'Auto-Submitted:'& header.
15631
15632 .option deliver_drop_privilege main boolean false
15633 .cindex "unprivileged delivery"
15634 .cindex "delivery" "unprivileged"
15635 If this option is set true, Exim drops its root privilege at the start of a
15636 delivery process, and runs as the Exim user throughout. This severely restricts
15637 the kinds of local delivery that are possible, but is viable in certain types
15638 of configuration. There is a discussion about the use of root privilege in
15639 chapter &<<CHAPsecurity>>&.
15640
15641 .option deliver_queue_load_max main fixed-point unset
15642 .cindex "load average"
15643 .cindex "queue runner" "abandoning"
15644 When this option is set, a queue run is abandoned if the system load average
15645 becomes greater than the value of the option. The option has no effect on
15646 ancient operating systems on which Exim cannot determine the load average.
15647 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15648
15649
15650 .option delivery_date_remove main boolean true
15651 .cindex "&'Delivery-date:'& header line"
15652 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15653 message when it is delivered, in exactly the same way as &'Return-path:'& is
15654 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15655 should not be present in incoming messages, and this option causes them to be
15656 removed at the time the message is received, to avoid any problems that might
15657 occur when a delivered message is subsequently sent on to some other recipient.
15658
15659 .option disable_fsync main boolean false
15660 .cindex "&[fsync()]&, disabling"
15661 This option is available only if Exim was built with the compile-time option
15662 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15663 a runtime configuration generates an &"unknown option"& error. You should not
15664 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15665 really, really, really understand what you are doing. &'No pre-compiled
15666 distributions of Exim should ever make this option available.'&
15667
15668 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15669 updated files' data to be written to disc before continuing. Unexpected events
15670 such as crashes and power outages may cause data to be lost or scrambled.
15671 Here be Dragons. &*Beware.*&
15672
15673
15674 .option disable_ipv6 main boolean false
15675 .cindex "IPv6" "disabling"
15676 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15677 activities take place. AAAA records are never looked up, and any IPv6 addresses
15678 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15679 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15680 to handle IPv6 literal addresses.
15681
15682
15683 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15684 .cindex DKIM "selecting signature algorithms"
15685 This option gives a list of hash types which are acceptable in signatures,
15686 and an order of processing.
15687 Signatures with algorithms not in the list will be ignored.
15688
15689 Acceptable values include:
15690 .code
15691 sha1
15692 sha256
15693 sha512
15694 .endd
15695
15696 Note that the acceptance of sha1 violates RFC 8301.
15697
15698 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15699 This option gives a list of key types which are acceptable in signatures,
15700 and an order of processing.
15701 Signatures with algorithms not in the list will be ignored.
15702
15703
15704 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15705 This option gives a list of key sizes which are acceptable in signatures.
15706 The list is keyed by the algorithm type for the key; the values are in bits.
15707 Signatures with keys smaller than given by this option will fail verification.
15708
15709 The default enforces the RFC 8301 minimum key size for RSA signatures.
15710
15711 .option dkim_verify_minimal main boolean false
15712 If set to true, verification of signatures will terminate after the
15713 first success.
15714
15715 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15716 .cindex DKIM "controlling calls to the ACL"
15717 This option gives a list of DKIM domains for which the DKIM ACL is run.
15718 It is expanded after the message is received; by default it runs
15719 the ACL once for each signature in the message.
15720 See section &<<SECDKIMVFY>>&.
15721
15722
15723 .option dmarc_forensic_sender main string&!! unset &&&
15724         dmarc_history_file main string unset &&&
15725         dmarc_tld_file main string unset
15726 .cindex DMARC "main section options"
15727 These options control DMARC processing.
15728 See section &<<SECDMARC>>& for details.
15729
15730
15731 .option dns_again_means_nonexist main "domain list&!!" unset
15732 .cindex "DNS" "&""try again""& response; overriding"
15733 DNS lookups give a &"try again"& response for the DNS errors
15734 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15735 keep trying to deliver a message, or to give repeated temporary errors to
15736 incoming mail. Sometimes the effect is caused by a badly set up name server and
15737 may persist for a long time. If a domain which exhibits this problem matches
15738 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15739 This option should be used with care. You can make it apply to reverse lookups
15740 by a setting such as this:
15741 .code
15742 dns_again_means_nonexist = *.in-addr.arpa
15743 .endd
15744 This option applies to all DNS lookups that Exim does,
15745 except for TLSA lookups (where knowing about such failures
15746 is security-relevant).
15747 It also applies when the
15748 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15749 since these are most likely to be caused by DNS lookup problems. The
15750 &(dnslookup)& router has some options of its own for controlling what happens
15751 when lookups for MX or SRV records give temporary errors. These more specific
15752 options are applied after this global option.
15753
15754 .option dns_check_names_pattern main string "see below"
15755 .cindex "DNS" "pre-check of name syntax"
15756 When this option is set to a non-empty string, it causes Exim to check domain
15757 names for characters that are not allowed in host names before handing them to
15758 the DNS resolver, because some resolvers give temporary errors for names that
15759 contain unusual characters. If a domain name contains any unwanted characters,
15760 a &"not found"& result is forced, and the resolver is not called. The check is
15761 done by matching the domain name against a regular expression, which is the
15762 value of this option. The default pattern is
15763 .code
15764 dns_check_names_pattern = \
15765   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15766 .endd
15767 which permits only letters, digits, slashes, and hyphens in components, but
15768 they must start and end with a letter or digit. Slashes are not, in fact,
15769 permitted in host names, but they are found in certain NS records (which can be
15770 accessed in Exim by using a &%dnsdb%& lookup). If you set
15771 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15772 empty string.
15773
15774 .option dns_csa_search_limit main integer 5
15775 This option controls the depth of parental searching for CSA SRV records in the
15776 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15777
15778 .option dns_csa_use_reverse main boolean true
15779 This option controls whether or not an IP address, given as a CSA domain, is
15780 reversed and looked up in the reverse DNS, as described in more detail in
15781 section &<<SECTverifyCSA>>&.
15782
15783 .option dns_cname_loops main integer 1
15784 .cindex DNS "CNAME following"
15785 This option controls the following of CNAME chains, needed if the resolver does
15786 not do it internally.
15787 As of 2018 most should, and the default can be left.
15788 If you have an ancient one, a value of 10 is likely needed.
15789
15790 The default value of one CNAME-follow is needed
15791 thanks to the observed return for an MX request,
15792 given no MX presence but a CNAME to an A, of the CNAME.
15793
15794
15795 .option dns_dnssec_ok main integer -1
15796 .cindex "DNS" "resolver options"
15797 .cindex "DNS" "DNSSEC"
15798 If this option is set to a non-negative number then Exim will initialise the
15799 DNS resolver library to either use or not use DNSSEC, overriding the system
15800 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15801
15802 If the resolver library does not support DNSSEC then this option has no effect.
15803
15804 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15805 will default to stripping out a successful validation status.
15806 This will break a previously working Exim installation.
15807 Provided that you do trust the resolver (ie, is on localhost) you can tell
15808 glibc to pass through any successful validation with a new option in
15809 &_/etc/resolv.conf_&:
15810 .code
15811 options trust-ad
15812 .endd
15813
15814
15815 .option dns_ipv4_lookup main "domain list&!!" unset
15816 .cindex "IPv6" "DNS lookup for AAAA records"
15817 .cindex "DNS" "IPv6 lookup for AAAA records"
15818 .cindex DNS "IPv6 disabling"
15819 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15820 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15821 (A records) when trying to find IP addresses for hosts, unless the host's
15822 domain matches this list.
15823
15824 This is a fudge to help with name servers that give big delays or otherwise do
15825 not work for the AAAA record type. In due course, when the world's name
15826 servers have all been upgraded, there should be no need for this option.
15827 Note that all lookups, including those done for verification, are affected;
15828 this will result in verify failure for IPv6 connections or ones using names
15829 only valid for IPv6 addresses.
15830
15831
15832 .option dns_retrans main time 0s
15833 .cindex "DNS" "resolver options"
15834 .cindex timeout "dns lookup"
15835 .cindex "DNS" timeout
15836 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15837 retransmission and retry parameters for DNS lookups. Values of zero (the
15838 defaults) leave the system default settings unchanged. The first value is the
15839 time between retries, and the second is the number of retries. It isn't
15840 totally clear exactly how these settings affect the total time a DNS lookup may
15841 take. I haven't found any documentation about timeouts on DNS lookups; these
15842 parameter values are available in the external resolver interface structure,
15843 but nowhere does it seem to describe how they are used or what you might want
15844 to set in them.
15845 See also the &%slow_lookup_log%& option.
15846
15847
15848 .option dns_retry main integer 0
15849 See &%dns_retrans%& above.
15850
15851
15852 .option dns_trust_aa main "domain list&!!" unset
15853 .cindex "DNS" "resolver options"
15854 .cindex "DNS" "DNSSEC"
15855 If this option is set then lookup results marked with the AA bit
15856 (Authoritative Answer) are trusted the same way as if they were
15857 DNSSEC-verified. The authority section's name of the answer must
15858 match with this expanded domain list.
15859
15860 Use this option only if you talk directly to a resolver that is
15861 authoritative for some zones and does not set the AD (Authentic Data)
15862 bit in the answer. Some DNS servers may have an configuration option to
15863 mark the answers from their own zones as verified (they set the AD bit).
15864 Others do not have this option. It is considered as poor practice using
15865 a resolver that is an authoritative server for some zones.
15866
15867 Use this option only if you really have to (e.g. if you want
15868 to use DANE for remote delivery to a server that is listed in the DNS
15869 zones that your resolver is authoritative for).
15870
15871 If the DNS answer packet has the AA bit set and contains resource record
15872 in the answer section, the name of the first NS record appearing in the
15873 authority section is compared against the list. If the answer packet is
15874 authoritative but the answer section is empty, the name of the first SOA
15875 record in the authoritative section is used instead.
15876
15877 .cindex "DNS" "resolver options"
15878 .option dns_use_edns0 main integer -1
15879 .cindex "DNS" "resolver options"
15880 .cindex "DNS" "EDNS0"
15881 .cindex "DNS" "OpenBSD
15882 If this option is set to a non-negative number then Exim will initialise the
15883 DNS resolver library to either use or not use EDNS0 extensions, overriding
15884 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15885 on.
15886
15887 If the resolver library does not support EDNS0 then this option has no effect.
15888
15889 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15890 means that DNSSEC will not work with Exim on that platform either, unless Exim
15891 is linked against an alternative DNS client library.
15892
15893
15894 .option drop_cr main boolean false
15895 This is an obsolete option that is now a no-op. It used to affect the way Exim
15896 handled CR and LF characters in incoming messages. What happens now is
15897 described in section &<<SECTlineendings>>&.
15898
15899 .option dsn_advertise_hosts main "host list&!!" unset
15900 .cindex "bounce messages" "success"
15901 .cindex "DSN" "success"
15902 .cindex "Delivery Status Notification" "success"
15903 .cindex "ESMTP extensions" DSN
15904 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15905 and accepted from, these hosts.
15906 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15907 and RET and ENVID options on MAIL FROM commands.
15908 A NOTIFY=SUCCESS option requests success-DSN messages.
15909 A NOTIFY= option with no argument requests that no delay or failure DSNs
15910 are sent.
15911 &*Note*&: Supplying success-DSN messages has been criticised
15912 on privacy grounds; it can leak details of internal forwarding.
15913
15914 .option dsn_from main "string&!!" "see below"
15915 .cindex "&'From:'& header line" "in bounces"
15916 .cindex "bounce messages" "&'From:'& line, specifying"
15917 This option can be used to vary the contents of &'From:'& header lines in
15918 bounces and other automatically generated messages (&"Delivery Status
15919 Notifications"& &-- hence the name of the option). The default setting is:
15920 .code
15921 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15922 .endd
15923 The value is expanded every time it is needed. If the expansion fails, a
15924 panic is logged, and the default value is used.
15925
15926 .option envelope_to_remove main boolean true
15927 .cindex "&'Envelope-to:'& header line"
15928 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15929 message when it is delivered, in exactly the same way as &'Return-path:'& is
15930 handled. &'Envelope-to:'& records the original recipient address from the
15931 message's envelope that caused the delivery to happen. Such headers should not
15932 be present in incoming messages, and this option causes them to be removed at
15933 the time the message is received, to avoid any problems that might occur when a
15934 delivered message is subsequently sent on to some other recipient.
15935
15936
15937 .option errors_copy main "string list&!!" unset
15938 .cindex "bounce message" "copy to other address"
15939 .cindex "copy of bounce message"
15940 Setting this option causes Exim to send bcc copies of bounce messages that it
15941 generates to other addresses. &*Note*&: This does not apply to bounce messages
15942 coming from elsewhere. The value of the option is a colon-separated list of
15943 items. Each item consists of a pattern, terminated by white space, followed by
15944 a comma-separated list of email addresses. If a pattern contains spaces, it
15945 must be enclosed in double quotes.
15946
15947 Each pattern is processed in the same way as a single item in an address list
15948 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15949 the bounce message, the message is copied to the addresses on the list. The
15950 items are scanned in order, and once a matching one is found, no further items
15951 are examined. For example:
15952 .code
15953 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15954               rqps@mydomain   hostmaster@mydomain.example,\
15955                               postmaster@mydomain.example
15956 .endd
15957 .vindex "&$domain$&"
15958 .vindex "&$local_part$&"
15959 The address list is expanded before use. The expansion variables &$local_part$&
15960 and &$domain$& are set from the original recipient of the error message, and if
15961 there was any wildcard matching in the pattern, the expansion
15962 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15963 variables &$0$&, &$1$&, etc. are set in the normal way.
15964
15965
15966 .option errors_reply_to main string unset
15967 .cindex "bounce message" "&'Reply-to:'& in"
15968 By default, Exim's bounce and delivery warning messages contain the header line
15969 .display
15970 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15971 .endd
15972 .oindex &%quota_warn_message%&
15973 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15974 A warning message that is generated by the &%quota_warn_message%& option in an
15975 &(appendfile)& transport may contain its own &'From:'& header line that
15976 overrides the default.
15977
15978 Experience shows that people reply to bounce messages. If the
15979 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15980 and warning messages. For example:
15981 .code
15982 errors_reply_to = postmaster@my.domain.example
15983 .endd
15984 The value of the option is not expanded. It must specify a valid RFC 2822
15985 address. However, if a warning message that is generated by the
15986 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15987 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15988 not used.
15989
15990
15991 .option event_action main string&!! unset
15992 .cindex events
15993 This option declares a string to be expanded for Exim's events mechanism.
15994 For details see chapter &<<CHAPevents>>&.
15995
15996
15997 .option exim_group main string "compile-time configured"
15998 .cindex "gid (group id)" "Exim's own"
15999 .cindex "Exim group"
16000 This option changes the gid under which Exim runs when it gives up root
16001 privilege. The default value is compiled into the binary. The value of this
16002 option is used only when &%exim_user%& is also set. Unless it consists entirely
16003 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
16004 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
16005 security issues.
16006
16007
16008 .option exim_path main string "see below"
16009 .cindex "Exim binary, path name"
16010 This option specifies the path name of the Exim binary, which is used when Exim
16011 needs to re-exec itself. The default is set up to point to the file &'exim'& in
16012 the directory configured at compile time by the BIN_DIRECTORY setting. It
16013 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
16014 other place.
16015 &*Warning*&: Do not use a macro to define the value of this option, because
16016 you will break those Exim utilities that scan the configuration file to find
16017 where the binary is. (They then use the &%-bP%& option to extract option
16018 settings such as the value of &%spool_directory%&.)
16019
16020
16021 .option exim_user main string "compile-time configured"
16022 .cindex "uid (user id)" "Exim's own"
16023 .cindex "Exim user"
16024 This option changes the uid under which Exim runs when it gives up root
16025 privilege. The default value is compiled into the binary. Ownership of the run
16026 time configuration file and the use of the &%-C%& and &%-D%& command line
16027 options is checked against the values in the binary, not what is set here.
16028
16029 Unless it consists entirely of digits, the string is looked up using
16030 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16031 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16032 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16033
16034
16035 .option exim_version main string "current version"
16036 .cindex "Exim version"
16037 .cindex customizing "version number"
16038 .cindex "version number of Exim" override
16039 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16040 various places.  Use with care; this may fool stupid security scanners.
16041
16042
16043 .option extra_local_interfaces main "string list" unset
16044 This option defines network interfaces that are to be considered local when
16045 routing, but which are not used for listening by the daemon. See section
16046 &<<SECTreclocipadd>>& for details.
16047
16048
16049 . Allow this long option name to split; give it unsplit as a fifth argument
16050 . for the automatic .oindex that is generated by .option.
16051
16052 .option "extract_addresses_remove_arguments" main boolean true &&&
16053          extract_addresses_remove_arguments
16054 .oindex "&%-t%&"
16055 .cindex "command line" "addresses with &%-t%&"
16056 .cindex "Sendmail compatibility" "&%-t%& option"
16057 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16058 are present on the command line when the &%-t%& option is used to build an
16059 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16060 line addresses are removed from the recipients list. This is also how Smail
16061 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16062 command line addresses are added to those obtained from the header lines. When
16063 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16064 argument headers. If it is set false, Exim adds rather than removes argument
16065 addresses.
16066
16067
16068 .option finduser_retries main integer 0
16069 .cindex "NIS, retrying user lookups"
16070 On systems running NIS or other schemes in which user and group information is
16071 distributed from a remote system, there can be times when &[getpwnam()]& and
16072 related functions fail, even when given valid data, because things time out.
16073 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16074 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16075 many extra times to find a user or a group, waiting for one second between
16076 retries.
16077
16078 .cindex "&_/etc/passwd_&" "multiple reading of"
16079 You should not set this option greater than zero if your user information is in
16080 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16081 search the file multiple times for non-existent users, and also cause delay.
16082
16083
16084
16085 .option freeze_tell main "string list, comma separated" unset
16086 .cindex "freezing messages" "sending a message when freezing"
16087 .cindex "frozen messages" "sending a message when freezing"
16088 On encountering certain errors, or when configured to do so in a system filter,
16089 ACL, or special router, Exim freezes a message. This means that no further
16090 delivery attempts take place until an administrator thaws the message, or the
16091 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16092 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16093 warning message whenever it freezes something, unless the message it is
16094 freezing is a locally-generated bounce message. (Without this exception there
16095 is the possibility of looping.) The warning message is sent to the addresses
16096 supplied as the comma-separated value of this option. If several of the
16097 message's addresses cause freezing, only a single message is sent. If the
16098 freezing was automatic, the reason(s) for freezing can be found in the message
16099 log. If you configure freezing in a filter or ACL, you must arrange for any
16100 logging that you require.
16101
16102
16103 .options gecos_name main string&!! unset &&&
16104          gecos_pattern main string unset
16105 .cindex "HP-UX"
16106 .cindex "&""gecos""& field, parsing"
16107 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16108 password file to hold other information in addition to users' real names. Exim
16109 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16110 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16111 of the field are used unchanged, except that, if an ampersand is encountered,
16112 it is replaced by the user's login name with the first character forced to
16113 upper case, since this is a convention that is observed on many systems.
16114
16115 When these options are set, &%gecos_pattern%& is treated as a regular
16116 expression that is to be applied to the field (again with && replaced by the
16117 login name), and if it matches, &%gecos_name%& is expanded and used as the
16118 user's name.
16119
16120 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16121 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16122 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16123 name terminates at the first comma, the following can be used:
16124 .code
16125 gecos_pattern = ([^,]*)
16126 gecos_name = $1
16127 .endd
16128
16129
16130 .option gnutls_compat_mode main boolean unset
16131 This option controls whether GnuTLS is used in compatibility mode in an Exim
16132 server. This reduces security slightly, but improves interworking with older
16133 implementations of TLS.
16134
16135
16136 .option gnutls_allow_auto_pkcs11 main boolean unset
16137 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16138 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16139
16140 See
16141 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16142 for documentation.
16143
16144
16145
16146 .option headers_charset main string "see below"
16147 This option sets a default character set for translating from encoded MIME
16148 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16149 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16150 ultimate default is ISO-8859-1. For more details see the description of header
16151 insertions in section &<<SECTexpansionitems>>&.
16152
16153
16154
16155 .option header_maxsize main integer "see below"
16156 .cindex "header section" "maximum size of"
16157 .cindex "limit" "size of message header section"
16158 This option controls the overall maximum size of a message's header
16159 section. The default is the value of HEADER_MAXSIZE in
16160 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16161 sections are rejected.
16162
16163
16164 .option header_line_maxsize main integer 0
16165 .cindex "header lines" "maximum size of"
16166 .cindex "limit" "size of one header line"
16167 This option limits the length of any individual header line in a message, after
16168 all the continuations have been joined together. Messages with individual
16169 header lines that are longer than the limit are rejected. The default value of
16170 zero means &"no limit"&.
16171
16172
16173
16174
16175 .option helo_accept_junk_hosts main "host list&!!" unset
16176 .cindex "HELO" "accepting junk data"
16177 .cindex "EHLO" "accepting junk data"
16178 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16179 mail, and gives an error response for invalid data. Unfortunately, there are
16180 some SMTP clients that send syntactic junk. They can be accommodated by setting
16181 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16182 if you want to do semantic checking.
16183 See also &%helo_allow_chars%& for a way of extending the permitted character
16184 set.
16185
16186
16187 .option helo_allow_chars main string unset
16188 .cindex "HELO" "underscores in"
16189 .cindex "EHLO" "underscores in"
16190 .cindex "underscore in EHLO/HELO"
16191 This option can be set to a string of rogue characters that are permitted in
16192 all EHLO and HELO names in addition to the standard letters, digits,
16193 hyphens, and dots. If you really must allow underscores, you can set
16194 .code
16195 helo_allow_chars = _
16196 .endd
16197 Note that the value is one string, not a list.
16198
16199
16200 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16201 .cindex "HELO" "forcing reverse lookup"
16202 .cindex "EHLO" "forcing reverse lookup"
16203 If the domain given by a client in a HELO or EHLO command matches this
16204 list, a reverse lookup is done in order to establish the host's true name. The
16205 default forces a lookup if the client host gives the server's name or any of
16206 its IP addresses (in brackets), something that broken clients have been seen to
16207 do.
16208
16209
16210 .option helo_try_verify_hosts main "host list&!!" unset
16211 .cindex "HELO verifying" "optional"
16212 .cindex "EHLO" "verifying, optional"
16213 By default, Exim just checks the syntax of HELO and EHLO commands (see
16214 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16215 to do more extensive checking of the data supplied by these commands. The ACL
16216 condition &`verify = helo`& is provided to make this possible.
16217 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16218 to force the check to occur. From release 4.53 onwards, this is no longer
16219 necessary. If the check has not been done before &`verify = helo`& is
16220 encountered, it is done at that time. Consequently, this option is obsolete.
16221 Its specification is retained here for backwards compatibility.
16222
16223 When an EHLO or HELO command is received, if the calling host matches
16224 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16225 EHLO command either:
16226
16227 .ilist
16228 is an IP literal matching the calling address of the host, or
16229 .next
16230 .cindex "DNS" "reverse lookup"
16231 .cindex "reverse DNS lookup"
16232 matches the host name that Exim obtains by doing a reverse lookup of the
16233 calling host address, or
16234 .next
16235 when looked up in DNS yields the calling host address.
16236 .endlist
16237
16238 However, the EHLO or HELO command is not rejected if any of the checks
16239 fail. Processing continues, but the result of the check is remembered, and can
16240 be detected later in an ACL by the &`verify = helo`& condition.
16241
16242 If DNS was used for successful verification, the variable
16243 .cindex "DNS" "DNSSEC"
16244 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16245
16246 .option helo_verify_hosts main "host list&!!" unset
16247 .cindex "HELO verifying" "mandatory"
16248 .cindex "EHLO" "verifying, mandatory"
16249 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16250 backwards compatibility. For hosts that match this option, Exim checks the host
16251 name given in the HELO or EHLO in the same way as for
16252 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16253 rejected with a 550 error, and entries are written to the main and reject logs.
16254 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16255 error.
16256
16257 .option hold_domains main "domain list&!!" unset
16258 .cindex "domain" "delaying delivery"
16259 .cindex "delivery" "delaying certain domains"
16260 This option allows mail for particular domains to be held in the queue
16261 manually. The option is overridden if a message delivery is forced with the
16262 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16263 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16264 item in &%hold_domains%&, no routing or delivery for that address is done, and
16265 it is deferred every time the message is looked at.
16266
16267 This option is intended as a temporary operational measure for delaying the
16268 delivery of mail while some problem is being sorted out, or some new
16269 configuration tested. If you just want to delay the processing of some
16270 domains until a queue run occurs, you should use &%queue_domains%& or
16271 &%queue_smtp_domains%&, not &%hold_domains%&.
16272
16273 A setting of &%hold_domains%& does not override Exim's code for removing
16274 messages from the queue if they have been there longer than the longest retry
16275 time in any retry rule. If you want to hold messages for longer than the normal
16276 retry times, insert a dummy retry rule with a long retry time.
16277
16278
16279 .option host_lookup main "host list&!!" unset
16280 .cindex "host name" "lookup, forcing"
16281 Exim does not look up the name of a calling host from its IP address unless it
16282 is required to compare against some host list, or the host matches
16283 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16284 option (which normally contains IP addresses rather than host names). The
16285 default configuration file contains
16286 .code
16287 host_lookup = *
16288 .endd
16289 which causes a lookup to happen for all hosts. If the expense of these lookups
16290 is felt to be too great, the setting can be changed or removed.
16291
16292 After a successful reverse lookup, Exim does a forward lookup on the name it
16293 has obtained, to verify that it yields the IP address that it started with. If
16294 this check fails, Exim behaves as if the name lookup failed.
16295
16296 .vindex "&$host_lookup_failed$&"
16297 .vindex "&$sender_host_name$&"
16298 After any kind of failure, the host name (in &$sender_host_name$&) remains
16299 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16300 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16301 &`verify = reverse_host_lookup`& in ACLs.
16302
16303
16304 .option host_lookup_order main "string list" &`bydns:byaddr`&
16305 This option specifies the order of different lookup methods when Exim is trying
16306 to find a host name from an IP address. The default is to do a DNS lookup
16307 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16308 if that fails. You can change the order of these lookups, or omit one entirely,
16309 if you want.
16310
16311 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16312 multiple PTR records in the DNS and the IP address is not listed in
16313 &_/etc/hosts_&. Different operating systems give different results in this
16314 case. That is why the default tries a DNS lookup first.
16315
16316
16317
16318 .option host_reject_connection main "host list&!!" unset
16319 .cindex "host" "rejecting connections from"
16320 If this option is set, incoming SMTP calls from the hosts listed are rejected
16321 as soon as the connection is made.
16322 This option is obsolete, and retained only for backward compatibility, because
16323 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16324 connections immediately.
16325
16326 If the connection is on a TLS-on-connect port then the TCP connection is
16327 just dropped.  Otherwise, an SMTP error is sent first.
16328
16329 The ability to give an immediate rejection (either by this option or using an
16330 ACL) is provided for use in unusual cases. Many hosts will just try again,
16331 sometimes without much delay. Normally, it is better to use an ACL to reject
16332 incoming messages at a later stage, such as after RCPT commands. See
16333 chapter &<<CHAPACL>>&.
16334
16335
16336 .option hosts_connection_nolog main "host list&!!" unset
16337 .cindex "host" "not logging connections from"
16338 This option defines a list of hosts for which connection logging does not
16339 happen, even though the &%smtp_connection%& log selector is set. For example,
16340 you might want not to log SMTP connections from local processes, or from
16341 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16342 the daemon; you should therefore strive to restrict its value to a short inline
16343 list of IP addresses and networks. To disable logging SMTP connections from
16344 local processes, you must create a host list with an empty item. For example:
16345 .code
16346 hosts_connection_nolog = :
16347 .endd
16348 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16349 lines, as may commonly be produced by a monitoring system.
16350
16351
16352 .option hosts_require_alpn main "host list&!!" unset
16353 .cindex ALPN "require negotiation in server"
16354 .cindex TLS ALPN
16355 .cindex TLS "Application Layer Protocol Names"
16356 If the TLS library supports ALPN
16357 then a successful negotiation of ALPN will be required for any client
16358 matching the list, for TLS to be used.
16359 See also the &%tls_alpn%& option.
16360
16361 &*Note*&: prevention of fallback to in-clear connection is not
16362 managed by this option, and should be done separately.
16363
16364
16365 .option hosts_require_helo main "host list&!!" *
16366 .cindex "HELO/EHLO" requiring
16367 Exim will require an accepted HELO or EHLO command from a host matching
16368 this list, before accepting a MAIL command.
16369
16370
16371 .option hosts_proxy main "host list&!!" unset
16372 .cindex proxy "proxy protocol"
16373 This option enables use of Proxy Protocol proxies for incoming
16374 connections.  For details see section &<<SECTproxyInbound>>&.
16375
16376
16377 .option hosts_treat_as_local main "domain list&!!" unset
16378 .cindex "local host" "domains treated as"
16379 .cindex "host" "treated as local"
16380 If this option is set, any host names that match the domain list are treated as
16381 if they were the local host when Exim is scanning host lists obtained from MX
16382 records
16383 or other sources. Note that the value of this option is a domain list, not a
16384 host list, because it is always used to check host names, not IP addresses.
16385
16386 This option also applies when Exim is matching the special items
16387 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16388 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16389 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16390 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16391 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16392 interfaces and recognizing the local host.
16393
16394
16395 .option ibase_servers main "string list" unset
16396 .cindex "InterBase" "server list"
16397 This option provides a list of InterBase servers and associated connection data,
16398 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16399 The option is available only if Exim has been built with InterBase support.
16400
16401
16402
16403 .option ignore_bounce_errors_after main time 10w
16404 .cindex "bounce message" "discarding"
16405 .cindex "discarding bounce message"
16406 This option affects the processing of bounce messages that cannot be delivered,
16407 that is, those that suffer a permanent delivery failure. (Bounce messages that
16408 suffer temporary delivery failures are of course retried in the usual way.)
16409
16410 After a permanent delivery failure, bounce messages are frozen,
16411 because there is no sender to whom they can be returned. When a frozen bounce
16412 message has been in the queue for more than the given time, it is unfrozen at
16413 the next queue run, and a further delivery is attempted. If delivery fails
16414 again, the bounce message is discarded. This makes it possible to keep failed
16415 bounce messages around for a shorter time than the normal maximum retry time
16416 for frozen messages. For example,
16417 .code
16418 ignore_bounce_errors_after = 12h
16419 .endd
16420 retries failed bounce message deliveries after 12 hours, discarding any further
16421 failures. If the value of this option is set to a zero time period, bounce
16422 failures are discarded immediately. Setting a very long time (as in the default
16423 value) has the effect of disabling this option. For ways of automatically
16424 dealing with other kinds of frozen message, see &%auto_thaw%& and
16425 &%timeout_frozen_after%&.
16426
16427
16428 .options ignore_fromline_hosts main "host list&!!" unset &&&
16429          ignore_fromline_local main boolean false
16430 .cindex "&""From""& line"
16431 .cindex "UUCP" "&""From""& line"
16432 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16433 the headers of a message. By default this is treated as the start of the
16434 message's body, which means that any following headers are not recognized as
16435 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16436 match those hosts that insist on sending it. If the sender is actually a local
16437 process rather than a remote host, and is using &%-bs%& to inject the messages,
16438 &%ignore_fromline_local%& must be set to achieve this effect.
16439
16440
16441
16442 .option keep_environment main "string list" unset
16443 .cindex "environment" "values from"
16444 This option contains a string list of environment variables to keep.
16445 You have to trust these variables or you have to be sure that
16446 these variables do not impose any security risk. Keep in mind that
16447 during the startup phase Exim is running with an effective UID 0 in most
16448 installations. As the default value is an empty list, the default
16449 environment for using libraries, running embedded Perl code, or running
16450 external binaries is empty, and does not not even contain PATH or HOME.
16451
16452 Actually the list is interpreted as a list of patterns
16453 (&<<SECTlistexpand>>&), except that it is not expanded first.
16454
16455 WARNING: Macro substitution is still done first, so having a macro
16456 FOO and having FOO_HOME in your &%keep_environment%& option may have
16457 unexpected results. You may work around this using a regular expression
16458 that does not match the macro name: ^[F]OO_HOME$.
16459
16460 Current versions of Exim issue a warning during startup if you do not mention
16461 &%keep_environment%& in your runtime configuration file and if your
16462 current environment is not empty. Future versions may not issue that warning
16463 anymore.
16464
16465 See the &%add_environment%& main config option for a way to set
16466 environment variables to a fixed value.  The environment for &(pipe)&
16467 transports is handled separately, see section &<<SECTpipeenv>>& for
16468 details.
16469
16470
16471 .option keep_malformed main time 4d
16472 This option specifies the length of time to keep messages whose spool files
16473 have been corrupted in some way. This should, of course, never happen. At the
16474 next attempt to deliver such a message, it gets removed. The incident is
16475 logged.
16476
16477
16478 .option ldap_ca_cert_dir main string unset
16479 .cindex "LDAP", "TLS CA certificate directory"
16480 .cindex certificate "directory for LDAP"
16481 This option indicates which directory contains CA certificates for verifying
16482 a TLS certificate presented by an LDAP server.
16483 While Exim does not provide a default value, your SSL library may.
16484 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16485 and constrained to be a directory.
16486
16487
16488 .option ldap_ca_cert_file main string unset
16489 .cindex "LDAP", "TLS CA certificate file"
16490 .cindex certificate "file for LDAP"
16491 This option indicates which file contains CA certificates for verifying
16492 a TLS certificate presented by an LDAP server.
16493 While Exim does not provide a default value, your SSL library may.
16494 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16495 and constrained to be a file.
16496
16497
16498 .option ldap_cert_file main string unset
16499 .cindex "LDAP" "TLS client certificate file"
16500 .cindex certificate "file for LDAP"
16501 This option indicates which file contains an TLS client certificate which
16502 Exim should present to the LDAP server during TLS negotiation.
16503 Should be used together with &%ldap_cert_key%&.
16504
16505
16506 .option ldap_cert_key main string unset
16507 .cindex "LDAP" "TLS client key file"
16508 .cindex certificate "key for LDAP"
16509 This option indicates which file contains the secret/private key to use
16510 to prove identity to the LDAP server during TLS negotiation.
16511 Should be used together with &%ldap_cert_file%&, which contains the
16512 identity to be proven.
16513
16514
16515 .option ldap_cipher_suite main string unset
16516 .cindex "LDAP" "TLS cipher suite"
16517 This controls the TLS cipher-suite negotiation during TLS negotiation with
16518 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16519 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16520
16521
16522 .option ldap_default_servers main "string list" unset
16523 .cindex "LDAP" "default servers"
16524 This option provides a list of LDAP servers which are tried in turn when an
16525 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16526 details of LDAP queries. This option is available only when Exim has been built
16527 with LDAP support.
16528
16529
16530 .option ldap_require_cert main string unset.
16531 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16532 This should be one of the values "hard", "demand", "allow", "try" or "never".
16533 A value other than one of these is interpreted as "never".
16534 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16535 Although Exim does not set a default, the LDAP library probably defaults
16536 to hard/demand.
16537
16538
16539 .option ldap_start_tls main boolean false
16540 .cindex "LDAP" "whether or not to negotiate TLS"
16541 If set, Exim will attempt to negotiate TLS with the LDAP server when
16542 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16543 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16544 of SSL-on-connect.
16545 In the event of failure to negotiate TLS, the action taken is controlled
16546 by &%ldap_require_cert%&.
16547 This option is ignored for &`ldapi`& connections.
16548
16549
16550 .option ldap_version main integer unset
16551 .cindex "LDAP" "protocol version, forcing"
16552 This option can be used to force Exim to set a specific protocol version for
16553 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16554 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16555 the LDAP headers; otherwise it is 2. This option is available only when Exim
16556 has been built with LDAP support.
16557
16558
16559
16560 .new
16561 .option limits_advertise_hosts main "host list&!!" *
16562 .cindex LIMITS "suppressing advertising"
16563 .cindex "ESMTP extensions" LIMITS
16564 This option can be used to suppress the advertisement of the SMTP
16565 LIMITS extension (RFC 9422) to specific hosts.
16566 If permitted, Exim as a servier will advertise in the EHLO response
16567 the limit for RCPT commands set by the &%recipients_max%& option (if it is set)
16568 and the limit for MAIL commands set by the &%smtp_accept_max_per_connection%&
16569 option.
16570 ,wen
16571
16572 .option local_from_check main boolean true
16573 .cindex "&'Sender:'& header line" "disabling addition of"
16574 .cindex "&'From:'& header line" "disabling checking of"
16575 When a message is submitted locally (that is, not over a TCP/IP connection) by
16576 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16577 checks that the &'From:'& header line matches the login of the calling user and
16578 the domain specified by &%qualify_domain%&.
16579
16580 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16581 locally submitted message is automatically qualified by Exim, unless the
16582 &%-bnq%& command line option is used.
16583
16584 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16585 on the local part. If the &'From:'& header line does not match, Exim adds a
16586 &'Sender:'& header with an address constructed from the calling user's login
16587 and the default qualify domain.
16588
16589 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16590 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16591 &'Sender:'& header lines supplied by untrusted users, you must also set
16592 &%local_sender_retain%& to be true.
16593
16594 .cindex "envelope from"
16595 .cindex "envelope sender"
16596 These options affect only the header lines in the message. The envelope sender
16597 is still forced to be the login id at the qualify domain unless
16598 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16599
16600 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16601 request similar header line checking. See section &<<SECTthesenhea>>&, which
16602 has more details about &'Sender:'& processing.
16603
16604
16605
16606
16607 .options local_from_prefix main string unset &&&
16608          local_from_suffix main string unset
16609 When Exim checks the &'From:'& header line of locally submitted messages for
16610 matching the login id (see &%local_from_check%& above), it can be configured to
16611 ignore certain prefixes and suffixes in the local part of the address. This is
16612 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16613 appropriate lists, in the same form as the &%local_part_prefix%& and
16614 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16615 example, if
16616 .code
16617 local_from_prefix = *-
16618 .endd
16619 is set, a &'From:'& line containing
16620 .code
16621 From: anything-user@your.domain.example
16622 .endd
16623 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16624 matches the actual sender address that is constructed from the login name and
16625 qualify domain.
16626
16627
16628 .option local_interfaces main "string list" "see below"
16629 This option controls which network interfaces are used by the daemon for
16630 listening; they are also used to identify the local host when routing. Chapter
16631 &<<CHAPinterfaces>>& contains a full description of this option and the related
16632 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16633 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16634 &%local_interfaces%& is
16635 .code
16636 local_interfaces = 0.0.0.0
16637 .endd
16638 when Exim is built without IPv6 support; otherwise it is
16639 .code
16640 local_interfaces = <; ::0 ; 0.0.0.0
16641 .endd
16642
16643 .option local_scan_timeout main time 5m
16644 .cindex "timeout" "for &[local_scan()]& function"
16645 .cindex "&[local_scan()]& function" "timeout"
16646 This timeout applies to the &[local_scan()]& function (see chapter
16647 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16648 the incoming message is rejected with a temporary error if it is an SMTP
16649 message. For a non-SMTP message, the message is dropped and Exim ends with a
16650 non-zero code. The incident is logged on the main and reject logs.
16651
16652
16653
16654 .option local_sender_retain main boolean false
16655 .cindex "&'Sender:'& header line" "retaining from local submission"
16656 When a message is submitted locally (that is, not over a TCP/IP connection) by
16657 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16658 do not want this to happen, you must set &%local_sender_retain%&, and you must
16659 also set &%local_from_check%& to be false (Exim will complain if you do not).
16660 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16661 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16662
16663
16664
16665
16666 .option localhost_number main string&!! unset
16667 .cindex "host" "locally unique number for"
16668 .cindex "message ids" "with multiple hosts"
16669 .cindex multiple "systems sharing a spool"
16670 .cindex "multiple hosts" "sharing a spool"
16671 .cindex "shared spool directory"
16672 .cindex "spool directory" sharing
16673 .vindex "&$localhost_number$&"
16674 Exim's message ids are normally unique only within the local host. If
16675 uniqueness among a set of hosts is required
16676 (eg. because they share a spool directory),
16677 each host must set a different
16678 value for the &%localhost_number%& option. The string is expanded immediately
16679 after reading the configuration file (so that a number can be computed from the
16680 host name, for example) and the result of the expansion must be a number in the
16681 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16682 systems). This is available in subsequent string expansions via the variable
16683 &$localhost_number$&. When &%localhost_number%& is set, the final four
16684 characters of the message id, instead of just being a fractional part of the
16685 time, are computed from the time and the local host number as described in
16686 section &<<SECTmessiden>>&.
16687
16688
16689
16690 .option log_file_path main "string list&!!" "set at compile time"
16691 .cindex "log" "file path for"
16692 This option sets the path which is used to determine the names of Exim's log
16693 files, or indicates that logging is to be to syslog, or both. It is expanded
16694 when Exim is entered, so it can, for example, contain a reference to the host
16695 name. If no specific path is set for the log files at compile or runtime,
16696 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16697 they are written in a sub-directory called &_log_& in Exim's spool directory.
16698 A path must start with a slash.
16699 To send to syslog, use the word &"syslog"&.
16700 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16701 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16702 used. If this string is fixed at your installation (contains no expansion
16703 variables) it is recommended that you do not set this option in the
16704 configuration file, but instead supply the path using LOG_FILE_PATH in
16705 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16706 early on &-- in particular, failure to read the configuration file.
16707
16708
16709 .option log_selector main string unset
16710 .cindex "log" "selectors"
16711 This option can be used to reduce or increase the number of things that Exim
16712 writes to its log files. Its argument is made up of names preceded by plus or
16713 minus characters. For example:
16714 .code
16715 log_selector = +arguments -retry_defer
16716 .endd
16717 A list of possible names and what they control is given in the chapter on
16718 logging, in section &<<SECTlogselector>>&.
16719
16720
16721 .option log_timezone main boolean false
16722 .cindex "log" "timezone for entries"
16723 .vindex "&$tod_log$&"
16724 .vindex "&$tod_zone$&"
16725 By default, the timestamps on log lines are in local time without the
16726 timezone. This means that if your timezone changes twice a year, the timestamps
16727 in log lines are ambiguous for an hour when the clocks go back. One way of
16728 avoiding this problem is to set the timezone to UTC. An alternative is to set
16729 &%log_timezone%& true. This turns on the addition of the timezone offset to
16730 timestamps in log lines. Turning on this option can add quite a lot to the size
16731 of log files because each line is extended by 6 characters. Note that the
16732 &$tod_log$& variable contains the log timestamp without the zone, but there is
16733 another variable called &$tod_zone$& that contains just the timezone offset.
16734
16735
16736 .option lookup_open_max main integer 25
16737 .cindex "too many open files"
16738 .cindex "open files, too many"
16739 .cindex "file" "too many open"
16740 .cindex "lookup" "maximum open files"
16741 .cindex "limit" "open files for lookups"
16742 This option limits the number of simultaneously open files for single-key
16743 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16744 Exim normally keeps these files open during routing, because often the same
16745 file is required several times. If the limit is reached, Exim closes the least
16746 recently used file. Note that if you are using the &'ndbm'& library, it
16747 actually opens two files for each logical DBM database, though it still counts
16748 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16749 open files"& errors with NDBM, you need to reduce the value of
16750 &%lookup_open_max%&.
16751
16752
16753 .option max_username_length main integer 0
16754 .cindex "length of login name"
16755 .cindex "user name" "maximum length"
16756 .cindex "limit" "user name length"
16757 Some operating systems are broken in that they truncate long arguments to
16758 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16759 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16760 an argument that is longer behaves as if &[getpwnam()]& failed.
16761
16762
16763 .option message_body_newlines main bool false
16764 .cindex "message body" "newlines in variables"
16765 .cindex "newline" "in message body variables"
16766 .vindex "&$message_body$&"
16767 .vindex "&$message_body_end$&"
16768 By default, newlines in the message body are replaced by spaces when setting
16769 the &$message_body$& and &$message_body_end$& expansion variables. If this
16770 option is set true, this no longer happens.
16771
16772
16773 .option message_body_visible main integer 500
16774 .cindex "body of message" "visible size"
16775 .cindex "message body" "visible size"
16776 .vindex "&$message_body$&"
16777 .vindex "&$message_body_end$&"
16778 This option specifies how much of a message's body is to be included in the
16779 &$message_body$& and &$message_body_end$& expansion variables.
16780
16781
16782 .option message_id_header_domain main string&!! unset
16783 .cindex "&'Message-ID:'& header line"
16784 If this option is set, the string is expanded and used as the right hand side
16785 (domain) of the &'Message-ID:'& header that Exim creates if a
16786 locally-originated incoming message does not have one. &"Locally-originated"&
16787 means &"not received over TCP/IP."&
16788 Otherwise, the primary host name is used.
16789 Only letters, digits, dot and hyphen are accepted; any other characters are
16790 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16791 empty string, the option is ignored.
16792
16793
16794 .option message_id_header_text main string&!! unset
16795 If this variable is set, the string is expanded and used to augment the text of
16796 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16797 message does not have one. The text of this header is required by RFC 2822 to
16798 take the form of an address. By default, Exim uses its internal message id as
16799 the local part, and the primary host name as the domain. If this option is set,
16800 it is expanded, and provided the expansion is not forced to fail, and does not
16801 yield an empty string, the result is inserted into the header immediately
16802 before the @, separated from the internal message id by a dot. Any characters
16803 that are illegal in an address are automatically converted into hyphens. This
16804 means that variables such as &$tod_log$& can be used, because the spaces and
16805 colons will become hyphens.
16806
16807
16808 .option message_logs main boolean true
16809 .cindex "message logs" "disabling"
16810 .cindex "log" "message log; disabling"
16811 If this option is turned off, per-message log files are not created in the
16812 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16813 Exim, by reducing the number of files involved in handling a message from a
16814 minimum of four (header spool file, body spool file, delivery journal, and
16815 per-message log) to three. The other major I/O activity is Exim's main log,
16816 which is not affected by this option.
16817
16818
16819 .option message_size_limit main string&!! 50M
16820 .cindex "message" "size limit"
16821 .cindex "limit" "message size"
16822 .cindex "size" "of message, limit"
16823 This option limits the maximum size of message that Exim will process. The
16824 value is expanded for each incoming connection so, for example, it can be made
16825 to depend on the IP address of the remote host for messages arriving via
16826 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16827 optionally followed by K or M.
16828
16829 .cindex "SIZE" "ESMTP extension, advertising"
16830 .cindex "ESMTP extensions" SIZE
16831 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16832 service extension keyword.
16833
16834 &*Note*&: This limit cannot be made to depend on a message's sender or any
16835 other properties of an individual message, because it has to be advertised in
16836 the server's response to EHLO. String expansion failure causes a temporary
16837 error. A value of zero means no limit, but its use is not recommended. See also
16838 &%bounce_return_size_limit%&.
16839
16840 Incoming SMTP messages are failed with a 552 error if the limit is
16841 exceeded; locally-generated messages either get a stderr message or a delivery
16842 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16843 an oversized message is logged in both the main and the reject logs. See also
16844 the generic transport option &%message_size_limit%&, which limits the size of
16845 message that an individual transport can process.
16846
16847 If you use a virus-scanner and set this option to to a value larger than the
16848 maximum size that your virus-scanner is configured to support, you may get
16849 failures triggered by large mails.  The right size to configure for the
16850 virus-scanner depends upon what data is passed and the options in use but it's
16851 probably safest to just set it to a little larger than this value.  E.g., with a
16852 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16853 some problems may result.
16854
16855 A value of 0 will disable size limit checking; Exim will still advertise the
16856 SIZE extension in an EHLO response, but without a limit, so as to permit
16857 SMTP clients to still indicate the message size along with the MAIL verb.
16858
16859
16860 .option move_frozen_messages main boolean false
16861 .cindex "frozen messages" "moving"
16862 This option, which is available only if Exim has been built with the setting
16863 .code
16864 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16865 .endd
16866 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16867 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16868 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16869 standard utilities for handling such moved messages, and they do not show up in
16870 lists generated by &%-bp%& or by the Exim monitor.
16871
16872
16873 .option mua_wrapper main boolean false
16874 Setting this option true causes Exim to run in a very restrictive mode in which
16875 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16876 contains a full description of this facility.
16877
16878
16879
16880 .option mysql_servers main "string list" unset
16881 .cindex "MySQL" "server list"
16882 This option provides a list of MySQL servers and associated connection data, to
16883 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16884 option is available only if Exim has been built with MySQL support.
16885
16886
16887 .option never_users main "string list&!!" unset
16888 This option is expanded just once, at the start of Exim's processing. Local
16889 message deliveries are normally run in processes that are setuid to the
16890 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16891 It is usually desirable to prevent any deliveries from running as root, as a
16892 safety precaution.
16893
16894 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16895 list of users that must not be used for local deliveries. This list is fixed in
16896 the binary and cannot be overridden by the configuration file. By default, it
16897 contains just the single user name &"root"&. The &%never_users%& runtime option
16898 can be used to add more users to the fixed list.
16899
16900 If a message is to be delivered as one of the users on the fixed list or the
16901 &%never_users%& list, an error occurs, and delivery is deferred. A common
16902 example is
16903 .code
16904 never_users = root:daemon:bin
16905 .endd
16906 Including root is redundant if it is also on the fixed list, but it does no
16907 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16908 transport driver.
16909
16910
16911 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16912 This option gives the name for a unix-domain socket on which the daemon
16913 listens for work and information-requests.
16914 Only installations running multiple daemons sharing a spool directory
16915 should need to modify the default.
16916
16917 The option is expanded before use.
16918 If the platform supports Linux-style abstract socket names, the result
16919 is used with a nul byte prefixed.
16920 Otherwise,
16921 it should be a full path name and use a directory accessible
16922 to Exim.
16923
16924 If this option is set as empty,
16925 or the command line &%-oY%& option is used, or
16926 the command line uses a &%-oX%& option and does not use &%-oP%&,
16927 then a notifier socket is not created.
16928
16929
16930 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16931 .cindex "OpenSSL "compatibility options"
16932 This option allows an administrator to adjust the SSL options applied
16933 by OpenSSL to connections.  It is given as a space-separated list of items,
16934 each one to be +added or -subtracted from the current value.
16935
16936 This option is only available if Exim is built against OpenSSL.  The values
16937 available for this option vary according to the age of your OpenSSL install.
16938 The &"all"& value controls a subset of flags which are available, typically
16939 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16940 list the values known on your system and Exim should support all the
16941 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16942 names lose the leading &"SSL_OP_"& and are lower-cased.
16943
16944 Note that adjusting the options can have severe impact upon the security of
16945 SSL as used by Exim.  It is possible to disable safety checks and shoot
16946 yourself in the foot in various unpleasant ways.  This option should not be
16947 adjusted lightly.  An unrecognised item will be detected at startup, by
16948 invoking Exim with the &%-bV%& flag.
16949
16950 The option affects Exim operating both as a server and as a client.
16951
16952 Historical note: prior to release 4.80, Exim defaulted this value to
16953 "+dont_insert_empty_fragments", which may still be needed for compatibility
16954 with some clients, but which lowers security by increasing exposure to
16955 some now infamous attacks.
16956
16957 Examples:
16958 .code
16959 # Make both old MS and old Eudora happy:
16960 openssl_options = -all +microsoft_big_sslv3_buffer \
16961                        +dont_insert_empty_fragments
16962
16963 # Disable older protocol versions:
16964 openssl_options = +no_sslv2 +no_sslv3
16965 .endd
16966
16967 Possible options may include:
16968 .ilist
16969 &`all`&
16970 .next
16971 &`allow_unsafe_legacy_renegotiation`&
16972 .next
16973 &`cipher_server_preference`&
16974 .next
16975 &`dont_insert_empty_fragments`&
16976 .next
16977 &`ephemeral_rsa`&
16978 .next
16979 &`legacy_server_connect`&
16980 .next
16981 &`microsoft_big_sslv3_buffer`&
16982 .next
16983 &`microsoft_sess_id_bug`&
16984 .next
16985 &`msie_sslv2_rsa_padding`&
16986 .next
16987 &`netscape_challenge_bug`&
16988 .next
16989 &`netscape_reuse_cipher_change_bug`&
16990 .next
16991 &`no_compression`&
16992 .next
16993 &`no_session_resumption_on_renegotiation`&
16994 .next
16995 &`no_sslv2`&
16996 .next
16997 &`no_sslv3`&
16998 .next
16999 &`no_ticket`&
17000 .next
17001 &`no_tlsv1`&
17002 .next
17003 &`no_tlsv1_1`&
17004 .next
17005 &`no_tlsv1_2`&
17006 .next
17007 &`safari_ecdhe_ecdsa_bug`&
17008 .next
17009 &`single_dh_use`&
17010 .next
17011 &`single_ecdh_use`&
17012 .next
17013 &`ssleay_080_client_dh_bug`&
17014 .next
17015 &`sslref2_reuse_cert_type_bug`&
17016 .next
17017 &`tls_block_padding_bug`&
17018 .next
17019 &`tls_d5_bug`&
17020 .next
17021 &`tls_rollback_bug`&
17022 .endlist
17023
17024 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
17025 all clients connecting using the MacOS SecureTransport TLS facility prior
17026 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
17027 to negotiate TLS then this option value might help, provided that your OpenSSL
17028 release is new enough to contain this work-around.  This may be a situation
17029 where you have to upgrade OpenSSL to get buggy clients working.
17030
17031
17032 .option oracle_servers main "string list" unset
17033 .cindex "Oracle" "server list"
17034 This option provides a list of Oracle servers and associated connection data,
17035 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17036 The option is available only if Exim has been built with Oracle support.
17037
17038
17039 .option panic_coredump main boolean false
17040 This option is rarely needed but can help for some debugging investigations.
17041 If set, when an internal error is detected by Exim which is sufficient
17042 to terminate the process
17043 (all such are logged in the paniclog)
17044 then a coredump is requested.
17045
17046 Note that most systems require additional administrative configuration
17047 to permit write a core file for a setuid program, which is Exim's
17048 common installed configuration.
17049
17050 .option percent_hack_domains main "domain list&!!" unset
17051 .cindex "&""percent hack""&"
17052 .cindex "source routing" "in email address"
17053 .cindex "address" "source-routed"
17054 The &"percent hack"& is the convention whereby a local part containing a
17055 percent sign is re-interpreted as a new email address, with the percent
17056 replaced by @. This is sometimes called &"source routing"&, though that term is
17057 also applied to RFC 2822 addresses that begin with an @ character. If this
17058 option is set, Exim implements the percent facility for those domains listed,
17059 but no others. This happens before an incoming SMTP address is tested against
17060 an ACL.
17061
17062 &*Warning*&: The &"percent hack"& has often been abused by people who are
17063 trying to get round relaying restrictions. For this reason, it is best avoided
17064 if at all possible. Unfortunately, a number of less security-conscious MTAs
17065 implement it unconditionally. If you are running Exim on a gateway host, and
17066 routing mail through to internal MTAs without processing the local parts, it is
17067 a good idea to reject recipient addresses with percent characters in their
17068 local parts. Exim's default configuration does this.
17069
17070
17071 .options perl_at_start main boolean false &&&
17072          perl_startup main string unset
17073 .cindex "Perl"
17074 These options are available only when Exim is built with an embedded Perl
17075 interpreter. See chapter &<<CHAPperl>>& for details of their use.
17076
17077 .option perl_taintmode main boolean false
17078 .cindex "Perl"
17079 This option enables the taint mode of the embedded Perl interpreter.
17080
17081
17082 .option pgsql_servers main "string list" unset
17083 .cindex "PostgreSQL lookup type" "server list"
17084 This option provides a list of PostgreSQL servers and associated connection
17085 data, to be used in conjunction with &(pgsql)& lookups (see section
17086 &<<SECID72>>&). The option is available only if Exim has been built with
17087 PostgreSQL support.
17088
17089
17090 .option pid_file_path main string&!! "set at compile time"
17091 .cindex "daemon" "pid file path"
17092 .cindex "pid file, path for"
17093 This option sets the name of the file to which the Exim daemon writes its
17094 process id. The string is expanded, so it can contain, for example, references
17095 to the host name:
17096 .code
17097 pid_file_path = /var/log/$primary_hostname/exim.pid
17098 .endd
17099 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17100 spool directory.
17101 The value set by the option can be overridden by the &%-oP%& command line
17102 option. A pid file is not written if a &"non-standard"& daemon is run by means
17103 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17104
17105
17106 .option pipelining_advertise_hosts main "host list&!!" *
17107 .cindex "PIPELINING" "suppressing advertising"
17108 .cindex "ESMTP extensions" PIPELINING
17109 This option can be used to suppress the advertisement of the SMTP
17110 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17111 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17112 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17113 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17114 that clients will use it; &"out of order"& commands that are &"expected"& do
17115 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17116
17117 .option pipelining_connect_advertise_hosts main "host list&!!" *
17118 .cindex "pipelining" "early connection"
17119 .cindex "pipelining" PIPECONNECT
17120 .cindex "ESMTP extensions" PIPECONNECT
17121 If Exim is built without the DISABLE_PIPE_CONNECT build option
17122 this option controls which hosts the facility is advertised to
17123 and from which pipeline early-connection (before MAIL) SMTP
17124 commands are acceptable.
17125 When used, the pipelining saves on roundtrip times.
17126
17127 See also the &%hosts_pipe_connect%& smtp transport option.
17128
17129 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17130 it permits the client to pipeline
17131 TCP connection and hello command (inclear phase),
17132 or TLS-establishment and hello command (encrypted phase),
17133 on later connections to the same host.
17134
17135
17136 .option prdr_enable main boolean false
17137 .cindex "PRDR" "enabling on server"
17138 .cindex "ESMTP extensions" PRDR
17139 This option can be used to enable the Per-Recipient Data Response extension
17140 to SMTP, defined by Eric Hall.
17141 If the option is set, PRDR is advertised by Exim when operating as a server.
17142 If the client requests PRDR, and more than one recipient, for a message
17143 an additional ACL is called for each recipient after the message content
17144 is received.  See section &<<SECTPRDRACL>>&.
17145
17146 .option preserve_message_logs main boolean false
17147 .cindex "message logs" "preserving"
17148 If this option is set, message log files are not deleted when messages are
17149 completed. Instead, they are moved to a sub-directory of the spool directory
17150 called &_msglog.OLD_&, where they remain available for statistical or debugging
17151 purposes. This is a dangerous option to set on systems with any appreciable
17152 volume of mail. Use with care!
17153
17154
17155 .option primary_hostname main string "see below"
17156 .cindex "name" "of local host"
17157 .cindex "host" "name of local"
17158 .cindex "local host" "name of"
17159 .vindex "&$primary_hostname$&"
17160 This specifies the name of the current host. It is used in the default EHLO or
17161 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17162 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17163 The value is also used by default in some SMTP response messages from an Exim
17164 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17165
17166 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17167 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17168 contains only one component, Exim passes it to &[gethostbyname()]& (or
17169 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17170 version. The variable &$primary_hostname$& contains the host name, whether set
17171 explicitly by this option, or defaulted.
17172
17173
17174 .option print_topbitchars main boolean false
17175 .cindex "printing characters"
17176 .cindex "8-bit characters"
17177 By default, Exim considers only those characters whose codes lie in the range
17178 32&--126 to be printing characters. In a number of circumstances (for example,
17179 when writing log entries) non-printing characters are converted into escape
17180 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17181 is set, code values of 128 and above are also considered to be printing
17182 characters.
17183
17184 This option also affects the header syntax checks performed by the
17185 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17186 the user's full name when constructing From: and Sender: addresses (as
17187 described in section &<<SECTconstr>>&). Setting this option can cause
17188 Exim to generate eight bit message headers that do not conform to the
17189 standards.
17190
17191
17192 .option process_log_path main string unset
17193 .cindex "process log path"
17194 .cindex "log" "process log"
17195 .cindex "&'exiwhat'&"
17196 This option sets the name of the file to which an Exim process writes its
17197 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17198 utility script. If this option is unset, the file called &_exim-process.info_&
17199 in Exim's spool directory is used. The ability to specify the name explicitly
17200 can be useful in environments where two different Exims are running, using
17201 different spool directories.
17202
17203
17204 .option prod_requires_admin main boolean true
17205 .cindex "restricting access to features"
17206 .oindex "&%-M%&"
17207 .oindex "&%-R%&"
17208 .oindex "&%-q%&"
17209 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17210 admin user unless &%prod_requires_admin%& is set false. See also
17211 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17212
17213
17214 .option proxy_protocol_timeout main time 3s
17215 .cindex proxy "proxy protocol"
17216 This option sets the timeout for proxy protocol negotiation.
17217 For details see section &<<SECTproxyInbound>>&.
17218
17219
17220 .option qualify_domain main string "see below"
17221 .cindex "domain" "for qualifying addresses"
17222 .cindex "address" "qualification"
17223 This option specifies the domain name that is added to any envelope sender
17224 addresses that do not have a domain qualification. It also applies to
17225 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17226 are accepted by default only for locally-generated messages. Qualification is
17227 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17228 locally-generated messages, unless the &%-bnq%& command line option is used.
17229
17230 Messages from external sources must always contain fully qualified addresses,
17231 unless the sending host matches &%sender_unqualified_hosts%& or
17232 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17233 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17234 necessary. Internally, Exim always works with fully qualified envelope
17235 addresses. If &%qualify_domain%& is not set, it defaults to the
17236 &%primary_hostname%& value.
17237
17238
17239 .option qualify_recipient main string "see below"
17240 This option allows you to specify a different domain for qualifying recipient
17241 addresses to the one that is used for senders. See &%qualify_domain%& above.
17242
17243
17244
17245 .option queue_domains main "domain list&!!" unset
17246 .cindex "domain" "specifying non-immediate delivery"
17247 .cindex "queueing incoming messages"
17248 .cindex "message" "queueing certain domains"
17249 This option lists domains for which immediate delivery is not required.
17250 A delivery process is started whenever a message is received, but only those
17251 domains that do not match are processed. All other deliveries wait until the
17252 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17253
17254
17255 .option queue_fast_ramp main boolean true
17256 .cindex "queue runner" "two phase"
17257 .cindex "queue" "double scanning"
17258 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17259 command line, may start parallel delivery processes during their first
17260 phase.  This will be done when a threshold number of messages have been
17261 routed for a single host.
17262
17263
17264 .option queue_list_requires_admin main boolean true
17265 .cindex "restricting access to features"
17266 .oindex "&%-bp%&"
17267 The &%-bp%& command-line option, which lists the messages that are on the
17268 queue, requires the caller to be an admin user unless
17269 &%queue_list_requires_admin%& is set false.
17270 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17271
17272
17273 .option queue_only main boolean false
17274 .cindex "queueing incoming messages"
17275 .cindex "message" "queueing unconditionally"
17276 If &%queue_only%& is set, a delivery process is not automatically started
17277 whenever a message is received. Instead, the message waits in the queue for the
17278 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17279 delivered immediately when certain conditions (such as heavy load) occur.
17280
17281 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17282 and &%-odi%& command line options override &%queue_only%& unless
17283 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17284 &%queue_only_load%&, and &%smtp_accept_queue%&.
17285
17286
17287 .option queue_only_file main "string list" unset
17288 .cindex "queueing incoming messages"
17289 .cindex "message" "queueing by file existence"
17290 This option can be set to a colon-separated list of absolute path names, each
17291 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17292 it tests for the existence of each listed path using a call to &[stat()]&. For
17293 each path that exists, the corresponding queueing option is set.
17294 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17295 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17296 .code
17297 queue_only_file = smtp/some/file
17298 .endd
17299 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17300 &_/some/file_& exists.
17301
17302
17303 .option queue_only_load main fixed-point unset
17304 .cindex "load average"
17305 .cindex "queueing incoming messages"
17306 .cindex "message" "queueing by load"
17307 If the system load average is higher than this value, incoming messages from
17308 all sources are queued, and no automatic deliveries are started. If this
17309 happens during local or remote SMTP input, all subsequent messages received on
17310 the same SMTP connection are queued by default, whatever happens to the load in
17311 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17312 false.
17313
17314 Deliveries will subsequently be performed by queue runner processes. This
17315 option has no effect on ancient operating systems on which Exim cannot
17316 determine the load average. See also &%deliver_queue_load_max%& and
17317 &%smtp_load_reserve%&.
17318
17319
17320 .option queue_only_load_latch main boolean true
17321 .cindex "load average" "re-evaluating per message"
17322 When this option is true (the default), once one message has been queued
17323 because the load average is higher than the value set by &%queue_only_load%&,
17324 all subsequent messages received on the same SMTP connection are also queued.
17325 This is a deliberate choice; even though the load average may fall below the
17326 threshold, it doesn't seem right to deliver later messages on the same
17327 connection when not delivering earlier ones. However, there are special
17328 circumstances such as very long-lived connections from scanning appliances
17329 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17330 should be set false. This causes the value of the load average to be
17331 re-evaluated for each message.
17332
17333
17334 .option queue_only_override main boolean true
17335 .cindex "queueing incoming messages"
17336 When this option is true, the &%-od%&&'x'& command line options override the
17337 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17338 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17339 to override; they are accepted, but ignored.
17340
17341
17342 .option queue_run_in_order main boolean false
17343 .cindex "queue runner" "processing messages in order"
17344 If this option is set, queue runs happen in order of message arrival instead of
17345 in an arbitrary order. For this to happen, a complete list of the entire queue
17346 must be set up before the deliveries start. When the queue is all held in a
17347 single directory (the default), a single list is created for both the ordered
17348 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17349 single list is not created when &%queue_run_in_order%& is false. In this case,
17350 the sub-directories are processed one at a time (in a random order), and this
17351 avoids setting up one huge list for the whole queue. Thus, setting
17352 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17353 when the queue is large, because of the extra work in setting up the single,
17354 large list. In most situations, &%queue_run_in_order%& should not be set.
17355
17356
17357
17358 .option queue_run_max main integer&!! 5
17359 .cindex "queue runner" "maximum number of"
17360 This controls the maximum number of queue runner processes that an Exim daemon
17361 can run simultaneously. This does not mean that it starts them all at once,
17362 but rather that if the maximum number are still running when the time comes to
17363 start another one, it refrains from starting another one. This can happen with
17364 very large queues and/or very sluggish deliveries. This option does not,
17365 however, interlock with other processes, so additional queue runners can be
17366 started by other means, or by killing and restarting the daemon.
17367
17368 Setting this option to zero does not suppress queue runs; rather, it disables
17369 the limit, allowing any number of simultaneous queue runner processes to be
17370 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17371 the daemon's command line.
17372
17373 .cindex queues named
17374 .cindex "named queues" "resource limit"
17375 To set limits for different named queues use
17376 an expansion depending on the &$queue_name$& variable.
17377
17378 .option queue_smtp_domains main "domain list&!!" unset
17379 .cindex "queueing incoming messages"
17380 .cindex "message" "queueing remote deliveries"
17381 .cindex "first pass routing"
17382 When this option is set, a delivery process is started whenever a message is
17383 received, routing is performed, and local deliveries take place.
17384 However, if any SMTP deliveries are required for domains that match
17385 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17386 message waits in the queue for the next queue run. Since routing of the message
17387 has taken place, Exim knows to which remote hosts it must be delivered, and so
17388 when the queue run happens, multiple messages for the same host are delivered
17389 over a single SMTP connection. The &%-odqs%& command line option causes all
17390 SMTP deliveries to be queued in this way, and is equivalent to setting
17391 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17392 &%queue_domains%&.
17393
17394
17395 .option receive_timeout main time 0s
17396 .cindex "timeout" "for non-SMTP input"
17397 This option sets the timeout for accepting a non-SMTP message, that is, the
17398 maximum time that Exim waits when reading a message on the standard input. If
17399 the value is zero, it will wait forever. This setting is overridden by the
17400 &%-or%& command line option. The timeout for incoming SMTP messages is
17401 controlled by &%smtp_receive_timeout%&.
17402
17403 .option received_header_text main string&!! "see below"
17404 .cindex "customizing" "&'Received:'& header"
17405 .cindex "&'Received:'& header line" "customizing"
17406 This string defines the contents of the &'Received:'& message header that is
17407 added to each message, except for the timestamp, which is automatically added
17408 on at the end (preceded by a semicolon). The string is expanded each time it is
17409 used. If the expansion yields an empty string, no &'Received:'& header line is
17410 added to the message. Otherwise, the string should start with the text
17411 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17412 header lines.
17413 The default setting is:
17414
17415 .code
17416 received_header_text = Received: \
17417   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17418     {${if def:sender_ident \
17419       {from ${quote_local_part:$sender_ident} }}\
17420         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17421   by $primary_hostname \
17422   ${if def:received_protocol {with $received_protocol }}\
17423   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17424   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17425   (Exim $version_number)\n\t\
17426   ${if def:sender_address \
17427   {(envelope-from <$sender_address>)\n\t}}\
17428   id $message_exim_id\
17429   ${if def:received_for {\n\tfor $received_for}}
17430 .endd
17431
17432 The references to the TLS version and cipher are
17433 omitted when Exim is built without TLS
17434 support. The use of conditional expansions ensures that this works for both
17435 locally generated messages and messages received from remote hosts, giving
17436 header lines such as the following:
17437 .code
17438 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17439 by marley.carol.example with esmtp (Exim 4.00)
17440 (envelope-from <bob@carol.example>)
17441 id 16IOWa-00019l-00
17442 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17443 Received: by scrooge.carol.example with local (Exim 4.00)
17444 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17445 .endd
17446 Until the body of the message has been received, the timestamp is the time when
17447 the message started to be received. Once the body has arrived, and all policy
17448 checks have taken place, the timestamp is updated to the time at which the
17449 message was accepted.
17450
17451
17452 .option received_headers_max main integer 30
17453 .cindex "loop" "prevention"
17454 .cindex "mail loop prevention"
17455 .cindex "&'Received:'& header line" "counting"
17456 When a message is to be delivered, the number of &'Received:'& headers is
17457 counted, and if it is greater than this parameter, a mail loop is assumed to
17458 have occurred, the delivery is abandoned, and an error message is generated.
17459 This applies to both local and remote deliveries.
17460
17461
17462 .option recipient_unqualified_hosts main "host list&!!" unset
17463 .cindex "unqualified addresses"
17464 .cindex "host" "unqualified addresses from"
17465 This option lists those hosts from which Exim is prepared to accept unqualified
17466 recipient addresses in message envelopes. The addresses are made fully
17467 qualified by the addition of the &%qualify_recipient%& value. This option also
17468 affects message header lines. Exim does not reject unqualified recipient
17469 addresses in headers, but it qualifies them only if the message came from a
17470 host that matches &%recipient_unqualified_hosts%&,
17471 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17472 option was not set.
17473
17474
17475 .option recipients_max main integer&!! 50000
17476 .cindex "limit" "number of recipients"
17477 .cindex "recipient" "maximum number"
17478 If the value resulting from expanding this option
17479 is set greater than zero, it specifies the maximum number of
17480 original recipients for any message. Additional recipients that are generated
17481 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17482 all recipients over the limit; earlier recipients are delivered as normal.
17483 Non-SMTP messages with too many recipients are failed, and no deliveries are
17484 done.
17485
17486 .new
17487 For SMTP message the expansion is done after the connection is
17488 accepted (but before any SMTP conversation) and may depend on
17489 the IP addresses and port numbers of the connection.
17490 &*Note*&: If an expansion is used for the option,
17491 care should be taken that a resonable value results for
17492 non-SMTP messages.
17493 .wen
17494
17495 .cindex "RCPT" "maximum number of incoming"
17496 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17497 RCPT commands in a single message.
17498
17499
17500 .option recipients_max_reject main boolean false
17501 If this option is set true, Exim rejects SMTP messages containing too many
17502 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17503 error to the eventual DATA command. Otherwise (the default) it gives a 452
17504 error to the surplus RCPT commands and accepts the message on behalf of the
17505 initial set of recipients. The remote server should then re-send the message
17506 for the remaining recipients at a later time.
17507
17508
17509 .option remote_max_parallel main integer 4
17510 .cindex "delivery" "parallelism for remote"
17511 This option controls parallel delivery of one message to a number of remote
17512 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17513 does all the remote deliveries for a message one by one. Otherwise, if a single
17514 message has to be delivered to more than one remote host, or if several copies
17515 have to be sent to the same remote host, up to &%remote_max_parallel%&
17516 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17517 deliveries are required, the maximum number of processes are started, and as
17518 each one finishes, another is begun. The order of starting processes is the
17519 same as if sequential delivery were being done, and can be controlled by the
17520 &%remote_sort_domains%& option. If parallel delivery takes place while running
17521 with debugging turned on, the debugging output from each delivery process is
17522 tagged with its process id.
17523
17524 This option controls only the maximum number of parallel deliveries for one
17525 message in one Exim delivery process. Because Exim has no central queue
17526 manager, there is no way of controlling the total number of simultaneous
17527 deliveries if the configuration allows a delivery attempt as soon as a message
17528 is received.
17529
17530 See also the &%max_parallel%& generic transport option,
17531 and the &%serialize_hosts%& smtp transport option.
17532
17533 .cindex "number of deliveries"
17534 .cindex "delivery" "maximum number of"
17535 If you want to control the total number of deliveries on the system, you
17536 need to set the &%queue_only%& option. This ensures that all incoming messages
17537 are added to the queue without starting a delivery process. Then set up an Exim
17538 daemon to start queue runner processes at appropriate intervals (probably
17539 fairly often, for example, every minute), and limit the total number of queue
17540 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17541 delivers only one message at a time, the maximum number of deliveries that can
17542 then take place at once is &%queue_run_max%& multiplied by
17543 &%remote_max_parallel%&.
17544
17545 If it is purely remote deliveries you want to control, use
17546 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17547 doing the SMTP routing before queueing, so that several messages for the same
17548 host will eventually get delivered down the same connection.
17549
17550
17551 .option remote_sort_domains main "domain list&!!" unset
17552 .cindex "sorting remote deliveries"
17553 .cindex "delivery" "sorting remote"
17554 When there are a number of remote deliveries for a message, they are sorted by
17555 domain into the order given by this list. For example,
17556 .code
17557 remote_sort_domains = *.cam.ac.uk:*.uk
17558 .endd
17559 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17560 then to those in the &%uk%& domain, then to any others.
17561
17562
17563 .option retry_data_expire main time 7d
17564 .cindex "hints database" "data expiry"
17565 This option sets a &"use before"& time on retry information in Exim's hints
17566 database. Any older retry data is ignored. This means that, for example, once a
17567 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17568 past failures.
17569
17570
17571 .option retry_interval_max main time 24h
17572 .cindex "retry" "limit on interval"
17573 .cindex "limit" "on retry interval"
17574 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17575 intervals between delivery attempts for messages that cannot be delivered
17576 straight away. This option sets an overall limit to the length of time between
17577 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17578 the default value.
17579
17580
17581 .option return_path_remove main boolean true
17582 .cindex "&'Return-path:'& header line" "removing"
17583 RFC 2821, section 4.4, states that an SMTP server must insert a
17584 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17585 The &'Return-path:'& header preserves the sender address as received in the
17586 MAIL command. This description implies that this header should not be present
17587 in an incoming message. If &%return_path_remove%& is true, any existing
17588 &'Return-path:'& headers are removed from messages at the time they are
17589 received. Exim's transports have options for adding &'Return-path:'& headers at
17590 the time of delivery. They are normally used only for final local deliveries.
17591
17592
17593 .option return_size_limit main integer 100K
17594 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17595
17596
17597 .option rfc1413_hosts main "host list&!!" @[]
17598 .cindex "RFC 1413"
17599 .cindex "host" "for RFC 1413 calls"
17600 RFC 1413 identification calls are made to any client host which matches
17601 an item in the list.
17602 The default value specifies just this host, being any local interface
17603 for the system.
17604
17605 .option rfc1413_query_timeout main time 0s
17606 .cindex "RFC 1413" "query timeout"
17607 .cindex "timeout" "for RFC 1413 call"
17608 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17609 no RFC 1413 calls are ever made.
17610
17611
17612 .option sender_unqualified_hosts main "host list&!!" unset
17613 .cindex "unqualified addresses"
17614 .cindex "host" "unqualified addresses from"
17615 This option lists those hosts from which Exim is prepared to accept unqualified
17616 sender addresses. The addresses are made fully qualified by the addition of
17617 &%qualify_domain%&. This option also affects message header lines. Exim does
17618 not reject unqualified addresses in headers that contain sender addresses, but
17619 it qualifies them only if the message came from a host that matches
17620 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17621 using TCP/IP), and the &%-bnq%& option was not set.
17622
17623
17624 .option slow_lookup_log main integer 0
17625 .cindex "logging" "slow lookups"
17626 .cindex "dns" "logging slow lookups"
17627 This option controls logging of slow lookups.
17628 If the value is nonzero it is taken as a number of milliseconds
17629 and lookups taking longer than this are logged.
17630 Currently this applies only to DNS lookups.
17631
17632
17633
17634 .option smtp_accept_keepalive main boolean true
17635 .cindex "keepalive" "on incoming connection"
17636 This option controls the setting of the SO_KEEPALIVE option on incoming
17637 TCP/IP socket connections. When set, it causes the kernel to probe idle
17638 connections periodically, by sending packets with &"old"& sequence numbers. The
17639 other end of the connection should send an acknowledgment if the connection is
17640 still okay or a reset if the connection has been aborted. The reason for doing
17641 this is that it has the beneficial effect of freeing up certain types of
17642 connection that can get stuck when the remote host is disconnected without
17643 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17644 hours to detect unreachable hosts.
17645
17646
17647
17648 .option smtp_accept_max main integer 20
17649 .cindex "limit" "incoming SMTP connections"
17650 .cindex "SMTP" "incoming connection count"
17651 .cindex "inetd"
17652 This option specifies the maximum number of simultaneous incoming SMTP calls
17653 that Exim will accept. It applies only to the listening daemon; there is no
17654 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17655 value is set to zero, no limit is applied. However, it is required to be
17656 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17657 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17658
17659 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17660 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17661 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17662 and &%smtp_load_reserve%& are then checked before accepting the connection.
17663
17664
17665 .option smtp_accept_max_nonmail main integer 10
17666 .cindex "limit" "non-mail SMTP commands"
17667 .cindex "SMTP" "limiting non-mail commands"
17668 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17669 the connection if there are too many. This option defines &"too many"&. The
17670 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17671 client looping sending EHLO, for example. The check is applied only if the
17672 client host matches &%smtp_accept_max_nonmail_hosts%&.
17673
17674 When a new message is expected, one occurrence of RSET is not counted. This
17675 allows a client to send one RSET between messages (this is not necessary,
17676 but some clients do it). Exim also allows one uncounted occurrence of HELO
17677 or EHLO, and one occurrence of STARTTLS between messages. After
17678 starting up a TLS session, another EHLO is expected, and so it too is not
17679 counted. The first occurrence of AUTH in a connection, or immediately
17680 following STARTTLS is not counted. Otherwise, all commands other than
17681 MAIL, RCPT, DATA, and QUIT are counted.
17682
17683
17684 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17685 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17686 check by setting this option. The default value makes it apply to all hosts. By
17687 changing the value, you can exclude any badly-behaved hosts that you have to
17688 live with.
17689
17690
17691 . Allow this long option name to split; give it unsplit as a fifth argument
17692 . for the automatic .oindex that is generated by .option.
17693 . We insert " &~&~" which is both pretty nasty visually and results in
17694 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17695 . zero-width-space, which would be nicer visually and results in (at least)
17696 . html that Firefox will split on when it's forced to reflow (rather than
17697 . inserting a horizontal scrollbar).  However, the text is still not
17698 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17699 . the option name to split.
17700
17701 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17702          smtp_accept_max_per_connection
17703 .cindex "SMTP" "limiting incoming message count"
17704 .cindex "limit" "messages per SMTP connection"
17705 The value of this option limits the number of MAIL commands that Exim is
17706 prepared to accept over a single SMTP connection, whether or not each command
17707 results in the transfer of a message. After the limit is reached, a 421
17708 response is given to subsequent MAIL commands. This limit is a safety
17709 precaution against a client that goes mad (incidents of this type have been
17710 seen).
17711 The option is expanded after the HELO or EHLO is received
17712 and may depend on values available at that time.
17713 An empty or zero value after expansion removes the limit.
17714
17715
17716 .option smtp_accept_max_per_host main string&!! unset
17717 .cindex "limit" "SMTP connections from one host"
17718 .cindex "host" "limiting SMTP connections from"
17719 This option restricts the number of simultaneous IP connections from a single
17720 host (strictly, from a single IP address) to the Exim daemon. The option is
17721 expanded, to enable different limits to be applied to different hosts by
17722 reference to &$sender_host_address$&. Once the limit is reached, additional
17723 connection attempts from the same host are rejected with error code 421. This
17724 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17725 of zero imposes no limit. If this option is set greater than zero, it is
17726 required that &%smtp_accept_max%& be non-zero.
17727
17728 &*Warning*&: When setting this option you should not use any expansion
17729 constructions that take an appreciable amount of time. The expansion and test
17730 happen in the main daemon loop, in order to reject additional connections
17731 without forking additional processes (otherwise a denial-of-service attack
17732 could cause a vast number or processes to be created). While the daemon is
17733 doing this processing, it cannot accept any other incoming connections.
17734
17735
17736
17737 .option smtp_accept_queue main integer 0
17738 .cindex "SMTP" "incoming connection count"
17739 .cindex "queueing incoming messages"
17740 .cindex "message" "queueing by SMTP connection count"
17741 If the number of simultaneous incoming SMTP connections being handled via the
17742 listening daemon exceeds this value, messages received by SMTP are just placed
17743 in the queue; no delivery processes are started automatically. The count is
17744 fixed at the start of an SMTP connection. It cannot be updated in the
17745 subprocess that receives messages, and so the queueing or not queueing applies
17746 to all messages received in the same connection.
17747
17748 A value of zero implies no limit, and clearly any non-zero value is useful only
17749 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17750 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17751 various &%-od%&&'x'& command line options.
17752
17753
17754 . See the comment on smtp_accept_max_per_connection
17755
17756 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17757          smtp_accept_queue_per_connection
17758 .cindex "queueing incoming messages"
17759 .cindex "message" "queueing by message count"
17760 This option limits the number of delivery processes that Exim starts
17761 automatically when receiving messages via SMTP, whether via the daemon or by
17762 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17763 and the number of messages received in a single SMTP session exceeds this
17764 number, subsequent messages are placed in the queue, but no delivery processes
17765 are started. This helps to limit the number of Exim processes when a server
17766 restarts after downtime and there is a lot of mail waiting for it on other
17767 systems. On large systems, the default should probably be increased, and on
17768 dial-in client systems it should probably be set to zero (that is, disabled).
17769
17770
17771 .option smtp_accept_reserve main integer 0
17772 .cindex "SMTP" "incoming call count"
17773 .cindex "host" "reserved"
17774 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17775 number of SMTP connections that are reserved for connections from the hosts
17776 that are specified in &%smtp_reserve_hosts%&. The value set in
17777 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17778 restricted to this number of connections; the option specifies a minimum number
17779 of connection slots for them, not a maximum. It is a guarantee that this group
17780 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17781 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17782 individual host.
17783
17784 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17785 set to 5, once there are 45 active connections (from any hosts), new
17786 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17787 provided the other criteria for acceptance are met.
17788
17789
17790 .option smtp_active_hostname main string&!! unset
17791 .cindex "host" "name in SMTP responses"
17792 .cindex "SMTP" "host name in responses"
17793 .vindex "&$primary_hostname$&"
17794 This option is provided for multi-homed servers that want to masquerade as
17795 several different hosts. At the start of an incoming SMTP connection, its value
17796 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17797 responses. For example, it is used as domain name in the response to an
17798 incoming HELO or EHLO command.
17799
17800 .vindex "&$smtp_active_hostname$&"
17801 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17802 is saved with any messages that are received. It is therefore available for use
17803 in routers and transports when the message is later delivered.
17804
17805 If this option is unset, or if its expansion is forced to fail, or if the
17806 expansion results in an empty string, the value of &$primary_hostname$& is
17807 used. Other expansion failures cause a message to be written to the main and
17808 panic logs, and the SMTP command receives a temporary error. Typically, the
17809 value of &%smtp_active_hostname%& depends on the incoming interface address.
17810 For example:
17811 .code
17812 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17813   {cox.mydomain}{box.mydomain}}
17814 .endd
17815
17816 Although &$smtp_active_hostname$& is primarily concerned with incoming
17817 messages, it is also used as the default for HELO commands in callout
17818 verification if there is no remote transport from which to obtain a
17819 &%helo_data%& value.
17820
17821 .option smtp_backlog_monitor main integer 0
17822 .cindex "connection backlog" monitoring
17823 If this option is set to greater than zero, and the backlog of available
17824 TCP connections on a socket listening for SMTP is larger than it, a line
17825 is logged giving the value and the socket address and port.
17826 The value is retrived jsut before an accept call.
17827 This facility is only available on Linux.
17828
17829 .option smtp_banner main string&!! "see below"
17830 .cindex "SMTP" "welcome banner"
17831 .cindex "banner for SMTP"
17832 .cindex "welcome banner for SMTP"
17833 .cindex "customizing" "SMTP banner"
17834 If a connect ACL does not supply a message,
17835 this string (which is expanded every time it is used) is output as the initial
17836 positive response to an SMTP connection. The default setting is:
17837 .code
17838 smtp_banner = $smtp_active_hostname ESMTP Exim \
17839   $version_number $tod_full
17840 .endd
17841 Failure to expand the string causes a panic error;
17842 a forced fail just closes the connection.
17843 If you want to create a
17844 multiline response to the initial SMTP connection, use &"\n"& in the string at
17845 appropriate points, but not at the end. Note that the 220 code is not included
17846 in this string. Exim adds it automatically (several times in the case of a
17847 multiline response).
17848
17849
17850 .option smtp_check_spool_space main boolean true
17851 .cindex "checking disk space"
17852 .cindex "disk space, checking"
17853 .cindex "spool directory" "checking space"
17854 When this option is set, if an incoming SMTP session encounters the SIZE
17855 option on a MAIL command, it checks that there is enough space in the
17856 spool directory's partition to accept a message of that size, while still
17857 leaving free the amount specified by &%check_spool_space%& (even if that value
17858 is zero). If there isn't enough space, a temporary error code is returned.
17859
17860
17861 .option smtp_connect_backlog main integer 20
17862 .cindex "connection backlog" "set maximum"
17863 .cindex "SMTP" "connection backlog"
17864 .cindex "backlog of connections"
17865 This option specifies a maximum number of waiting SMTP connections. Exim passes
17866 this value to the TCP/IP system when it sets up its listener. Once this number
17867 of connections are waiting for the daemon's attention, subsequent connection
17868 attempts are refused at the TCP/IP level. At least, that is what the manuals
17869 say; in some circumstances such connection attempts have been observed to time
17870 out instead. For large systems it is probably a good idea to increase the
17871 value (to 50, say). It also gives some protection against denial-of-service
17872 attacks by SYN flooding.
17873
17874
17875 .option smtp_enforce_sync main boolean true
17876 .cindex "SMTP" "synchronization checking"
17877 .cindex "synchronization checking in SMTP"
17878 The SMTP protocol specification requires the client to wait for a response from
17879 the server at certain points in the dialogue. Without PIPELINING these
17880 synchronization points are after every command; with PIPELINING they are
17881 fewer, but they still exist.
17882
17883 Some spamming sites send out a complete set of SMTP commands without waiting
17884 for any response. Exim protects against this by rejecting a message if the
17885 client has sent further input when it should not have. The error response &"554
17886 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17887 for this error cannot be perfect because of transmission delays (unexpected
17888 input may be on its way but not yet received when Exim checks). However, it
17889 does detect many instances.
17890
17891 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17892 If you want to disable the check selectively (for example, only for certain
17893 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17894 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17895
17896
17897
17898 .option smtp_etrn_command main string&!! unset
17899 .cindex "ETRN" "command to be run"
17900 .cindex "ESMTP extensions" ETRN
17901 .vindex "&$domain$&"
17902 If this option is set, the given command is run whenever an SMTP ETRN
17903 command is received from a host that is permitted to issue such commands (see
17904 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17905 are independently expanded. The expansion variable &$domain$& is set to the
17906 argument of the ETRN command, and no syntax checking is done on it. For
17907 example:
17908 .code
17909 smtp_etrn_command = /etc/etrn_command $domain \
17910                     $sender_host_address
17911 .endd
17912 If the option is not set, the argument for the ETRN command must
17913 be a &'#'& followed by an address string.
17914 In this case an &'exim -R <string>'& command is used;
17915 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17916
17917 A new process is created to run the command, but Exim does not wait for it to
17918 complete. Consequently, its status cannot be checked. If the command cannot be
17919 run, a line is written to the panic log, but the ETRN caller still receives
17920 a 250 success response. Exim is normally running under its own uid when
17921 receiving SMTP, so it is not possible for it to change the uid before running
17922 the command.
17923
17924
17925 .option smtp_etrn_serialize main boolean true
17926 .cindex "ETRN" "serializing"
17927 When this option is set, it prevents the simultaneous execution of more than
17928 one identical command as a result of ETRN in an SMTP connection. See
17929 section &<<SECTETRN>>& for details.
17930
17931
17932 .option smtp_load_reserve main fixed-point unset
17933 .cindex "load average"
17934 If the system load average ever gets higher than this, incoming SMTP calls are
17935 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17936 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17937 the load is over the limit. The option has no effect on ancient operating
17938 systems on which Exim cannot determine the load average. See also
17939 &%deliver_queue_load_max%& and &%queue_only_load%&.
17940
17941
17942
17943 .option smtp_max_synprot_errors main integer 3
17944 .cindex "SMTP" "limiting syntax and protocol errors"
17945 .cindex "limit" "SMTP syntax and protocol errors"
17946 Exim rejects SMTP commands that contain syntax or protocol errors. In
17947 particular, a syntactically invalid email address, as in this command:
17948 .code
17949 RCPT TO:<abc xyz@a.b.c>
17950 .endd
17951 causes immediate rejection of the command, before any other tests are done.
17952 (The ACL cannot be run if there is no valid address to set up for it.) An
17953 example of a protocol error is receiving RCPT before MAIL. If there are
17954 too many syntax or protocol errors in one SMTP session, the connection is
17955 dropped. The limit is set by this option.
17956
17957 .cindex "PIPELINING" "expected errors"
17958 When the PIPELINING extension to SMTP is in use, some protocol errors are
17959 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17960 Exim assumes that PIPELINING will be used if it advertises it (see
17961 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17962 not count towards the limit.
17963
17964
17965
17966 .option smtp_max_unknown_commands main integer 3
17967 .cindex "SMTP" "limiting unknown commands"
17968 .cindex "limit" "unknown SMTP commands"
17969 If there are too many unrecognized commands in an incoming SMTP session, an
17970 Exim server drops the connection. This is a defence against some kinds of abuse
17971 that subvert web
17972 clients
17973 into making connections to SMTP ports; in these circumstances, a number of
17974 non-SMTP command lines are sent first.
17975
17976
17977
17978 .options smtp_ratelimit_hosts main "host list&!!" unset &&&
17979          smtp_ratelimit_mail main string unset &&&
17980          smtp_ratelimit_rcpt main string unset
17981 .cindex "SMTP" "rate limiting"
17982 .cindex "limit" "rate of message arrival"
17983 .cindex "RCPT" "rate limiting"
17984 Some sites find it helpful to be able to limit the rate at which certain hosts
17985 can send them messages, and the rate at which an individual message can specify
17986 recipients.
17987
17988 Exim has two rate-limiting facilities. This section describes the older
17989 facility, which can limit rates within a single connection. The newer
17990 &%ratelimit%& ACL condition can limit rates across all connections. See section
17991 &<<SECTratelimiting>>& for details of the newer facility.
17992
17993 When a host matches &%smtp_ratelimit_hosts%&, the values of
17994 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17995 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17996 respectively. Each option, if set, must contain a set of four comma-separated
17997 values:
17998
17999 .ilist
18000 A threshold, before which there is no rate limiting.
18001 .next
18002 An initial time delay. Unlike other times in Exim, numbers with decimal
18003 fractional parts are allowed here.
18004 .next
18005 A factor by which to increase the delay each time.
18006 .next
18007 A maximum value for the delay. This should normally be less than 5 minutes,
18008 because after that time, the client is liable to timeout the SMTP command.
18009 .endlist
18010
18011 For example, these settings have been used successfully at the site which
18012 first suggested this feature, for controlling mail from their customers:
18013 .code
18014 smtp_ratelimit_mail = 2,0.5s,1.05,4m
18015 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
18016 .endd
18017 The first setting specifies delays that are applied to MAIL commands after
18018 two have been received over a single connection. The initial delay is 0.5
18019 seconds, increasing by a factor of 1.05 each time. The second setting applies
18020 delays to RCPT commands when more than four occur in a single message.
18021
18022
18023
18024 .option smtp_receive_timeout main time&!! 5m
18025 .cindex "timeout" "for SMTP input"
18026 .cindex "SMTP" "input timeout"
18027 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
18028 input, including batch SMTP. If a line of input (either an SMTP command or a
18029 data line) is not received within this time, the SMTP connection is dropped and
18030 the message is abandoned.
18031 A line is written to the log containing one of the following messages:
18032 .code
18033 SMTP command timeout on connection from...
18034 SMTP data timeout on connection from...
18035 .endd
18036 The former means that Exim was expecting to read an SMTP command; the latter
18037 means that it was in the DATA phase, reading the contents of a message.
18038
18039 If the first character of the option is a &"$"& the option is
18040 expanded before use and may depend on
18041 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18042
18043
18044 .oindex "&%-os%&"
18045 The value set by this option can be overridden by the
18046 &%-os%& command-line option. A setting of zero time disables the timeout, but
18047 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18048 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18049 timeout is controlled by &%receive_timeout%& and &%-or%&.
18050
18051
18052 .option smtp_reserve_hosts main "host list&!!" unset
18053 This option defines hosts for which SMTP connections are reserved; see
18054 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18055
18056
18057 .option smtp_return_error_details main boolean false
18058 .cindex "SMTP" "details policy failures"
18059 .cindex "policy control" "rejection, returning details"
18060 In the default state, Exim uses bland messages such as
18061 &"Administrative prohibition"& when it rejects SMTP commands for policy
18062 reasons. Many sysadmins like this because it gives away little information
18063 to spammers. However, some other sysadmins who are applying strict checking
18064 policies want to give out much fuller information about failures. Setting
18065 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18066 example, instead of &"Administrative prohibition"&, it might give:
18067 .code
18068 550-Rejected after DATA: '>' missing at end of address:
18069 550 failing address in "From" header is: <user@dom.ain
18070 .endd
18071
18072
18073 .option smtputf8_advertise_hosts main "host list&!!" *
18074 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18075 .cindex "ESMTP extensions" SMTPUTF8
18076 When Exim is built with support for internationalised mail names,
18077 the availability thereof is advertised in
18078 response to EHLO only to those client hosts that match this option. See
18079 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18080
18081
18082 .option spamd_address main string "127.0.0.1 783"
18083 This option is available when Exim is compiled with the content-scanning
18084 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18085 See section &<<SECTscanspamass>>& for more details.
18086
18087
18088
18089 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18090 This option is available when Exim is compiled with SPF support.
18091 See section &<<SECSPF>>& for more details.
18092
18093 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18094 This option is available when Exim is compiled with SPF support.  It
18095 allows the customisation of the SMTP comment that the SPF library
18096 generates.  You are strongly encouraged to link to your own explanative
18097 site. The template must not contain spaces. If you need spaces in the
18098 output, use the proper placeholder. If libspf2 can not parse the
18099 template, it uses a built-in default broken link. The following placeholders
18100 (along with Exim variables (but see below)) are allowed in the template:
18101 .ilist
18102 &*%_*&: A space.
18103 .next
18104 &*%{L}*&: Envelope sender's local part.
18105 .next
18106 &*%{S}*&: Envelope sender.
18107 .next
18108 &*%{O}*&: Envelope sender's domain.
18109 .next
18110 &*%{D}*&: Current(?) domain.
18111 .next
18112 &*%{I}*&: SMTP client Ip.
18113 .next
18114 &*%{C}*&: SMTP client pretty IP.
18115 .next
18116 &*%{T}*&: Epoch time (UTC).
18117 .next
18118 &*%{P}*&: SMTP client domain name.
18119 .next
18120 &*%{V}*&: IP version.
18121 .next
18122 &*%{H}*&: EHLO/HELO domain.
18123 .next
18124 &*%{R}*&: Receiving domain.
18125 .endlist
18126 The capitalized placeholders do proper URL encoding, if you use them
18127 lowercased, no encoding takes place.  This list was compiled from the
18128 libspf2 sources.
18129
18130 A note on using Exim variables: As
18131 currently the SPF library is initialized before the SMTP EHLO phase,
18132 the variables useful for expansion are quite limited.
18133
18134
18135 .option split_spool_directory main boolean false
18136 .cindex "multiple spool directories"
18137 .cindex "spool directory" "split"
18138 .cindex "directories, multiple"
18139 If this option is set, it causes Exim to split its input directory into 62
18140 subdirectories, each with a single alphanumeric character as its name. The
18141 sixth character of the message id is used to allocate messages to
18142 subdirectories; this is the least significant base-62 digit of the time of
18143 arrival of the message.
18144
18145 Splitting up the spool in this way may provide better performance on systems
18146 where there are long mail queues, by reducing the number of files in any one
18147 directory. The msglog directory is also split up in a similar way to the input
18148 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18149 are still placed in the single directory &_msglog.OLD_&.
18150
18151 It is not necessary to take any special action for existing messages when
18152 changing &%split_spool_directory%&. Exim notices messages that are in the
18153 &"wrong"& place, and continues to process them. If the option is turned off
18154 after a period of being on, the subdirectories will eventually empty and be
18155 automatically deleted.
18156
18157 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18158 changes. Instead of creating a list of all messages in the queue, and then
18159 trying to deliver each one, in turn, it constructs a list of those in one
18160 sub-directory and tries to deliver them, before moving on to the next
18161 sub-directory. The sub-directories are processed in a random order. This
18162 spreads out the scanning of the input directories, and uses less memory. It is
18163 particularly beneficial when there are lots of messages in the queue. However,
18164 if &%queue_run_in_order%& is set, none of this new processing happens. The
18165 entire queue has to be scanned and sorted before any deliveries can start.
18166
18167
18168 .option spool_directory main string&!! "set at compile time"
18169 .cindex "spool directory" "path to"
18170 This defines the directory in which Exim keeps its spool, that is, the messages
18171 it is waiting to deliver. The default value is taken from the compile-time
18172 configuration setting, if there is one. If not, this option must be set. The
18173 string is expanded, so it can contain, for example, a reference to
18174 &$primary_hostname$&.
18175
18176 If the spool directory name is fixed on your installation, it is recommended
18177 that you set it at build time rather than from this option, particularly if the
18178 log files are being written to the spool directory (see &%log_file_path%&).
18179 Otherwise log files cannot be used for errors that are detected early on, such
18180 as failures in the configuration file.
18181
18182 By using this option to override the compiled-in path, it is possible to run
18183 tests of Exim without using the standard spool.
18184
18185 .option spool_wireformat main boolean false
18186 .cindex "spool directory" "file formats"
18187 If this option is set, Exim may for some messages use an alternative format
18188 for data-files in the spool which matches the wire format.
18189 Doing this permits more efficient message reception and transmission.
18190 Currently it is only done for messages received using the ESMTP CHUNKING
18191 option.
18192
18193 The following variables will not have useful values:
18194 .code
18195 $max_received_linelength
18196 $body_linecount
18197 $body_zerocount
18198 .endd
18199
18200 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18201 and any external programs which are passed a reference to a message data file
18202 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18203 will need to be aware of the different formats potentially available.
18204
18205 Using any of the ACL conditions noted will negate the reception benefit
18206 (as a Unix-mbox-format file is constructed for them).
18207 The transmission benefit is maintained.
18208
18209 .option sqlite_lock_timeout main time 5s
18210 .cindex "sqlite lookup type" "lock timeout"
18211 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18212 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18213
18214 .option strict_acl_vars main boolean false
18215 .cindex "&ACL;" "variables, handling unset"
18216 This option controls what happens if a syntactically valid but undefined ACL
18217 variable is referenced. If it is false (the default), an empty string
18218 is substituted; if it is true, an error is generated. See section
18219 &<<SECTaclvariables>>& for details of ACL variables.
18220
18221 .option strip_excess_angle_brackets main boolean false
18222 .cindex "angle brackets, excess"
18223 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18224 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18225 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18226 passed on to another MTA, the excess angle brackets are not passed on. If this
18227 option is not set, multiple pairs of angle brackets cause a syntax error.
18228
18229
18230 .option strip_trailing_dot main boolean false
18231 .cindex "trailing dot on domain"
18232 .cindex "dot" "trailing on domain"
18233 If this option is set, a trailing dot at the end of a domain in an address is
18234 ignored. If this is in the envelope and the message is passed on to another
18235 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18236 domain causes a syntax error.
18237 However, addresses in header lines are checked only when an ACL requests header
18238 syntax checking.
18239
18240
18241 .option syslog_duplication main boolean true
18242 .cindex "syslog" "duplicate log lines; suppressing"
18243 When Exim is logging to syslog, it writes the log lines for its three
18244 separate logs at different syslog priorities so that they can in principle
18245 be separated on the logging hosts. Some installations do not require this
18246 separation, and in those cases, the duplication of certain log lines is a
18247 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18248 particular log line is written to syslog. For lines that normally go to
18249 both the main log and the reject log, the reject log version (possibly
18250 containing message header lines) is written, at LOG_NOTICE priority.
18251 Lines that normally go to both the main and the panic log are written at
18252 the LOG_ALERT priority.
18253
18254
18255 .option syslog_facility main string unset
18256 .cindex "syslog" "facility; setting"
18257 This option sets the syslog &"facility"& name, used when Exim is logging to
18258 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18259 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18260 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18261 details of Exim's logging.
18262
18263
18264 .option syslog_pid main boolean true
18265 .cindex "syslog" "pid"
18266 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18267 omitted when these lines are sent to syslog. (Syslog normally prefixes
18268 the log lines with the PID of the logging process automatically.) You need
18269 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18270 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18271
18272
18273
18274 .option syslog_processname main string &`exim`&
18275 .cindex "syslog" "process name; setting"
18276 This option sets the syslog &"ident"& name, used when Exim is logging to
18277 syslog. The value must be no longer than 32 characters. See chapter
18278 &<<CHAPlog>>& for details of Exim's logging.
18279
18280
18281
18282 .option syslog_timestamp main boolean true
18283 .cindex "syslog" "timestamps"
18284 .cindex timestamps syslog
18285 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18286 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18287 details of Exim's logging.
18288
18289
18290 .option system_filter main string&!! unset
18291 .cindex "filter" "system filter"
18292 .cindex "system filter" "specifying"
18293 .cindex "Sieve filter" "not available for system filter"
18294 This option specifies an Exim filter file that is applied to all messages at
18295 the start of each delivery attempt, before any routing is done. System filters
18296 must be Exim filters; they cannot be Sieve filters. If the system filter
18297 generates any deliveries to files or pipes, or any new mail messages, the
18298 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18299 which transports are to be used. Details of this facility are given in chapter
18300 &<<CHAPsystemfilter>>&.
18301 A forced expansion failure results in no filter operation.
18302
18303
18304 .option system_filter_directory_transport main string&!! unset
18305 .vindex "&$address_file$&"
18306 This sets the name of the transport driver that is to be used when the
18307 &%save%& command in a system message filter specifies a path ending in &"/"&,
18308 implying delivery of each message into a separate file in some directory.
18309 During the delivery, the variable &$address_file$& contains the path name.
18310
18311
18312 .option system_filter_file_transport main string&!! unset
18313 .cindex "file" "transport for system filter"
18314 This sets the name of the transport driver that is to be used when the &%save%&
18315 command in a system message filter specifies a path not ending in &"/"&. During
18316 the delivery, the variable &$address_file$& contains the path name.
18317
18318 .option system_filter_group main string unset
18319 .cindex "gid (group id)" "system filter"
18320 This option is used only when &%system_filter_user%& is also set. It sets the
18321 gid under which the system filter is run, overriding any gid that is associated
18322 with the user. The value may be numerical or symbolic.
18323
18324 .option system_filter_pipe_transport main string&!! unset
18325 .cindex "&(pipe)& transport" "for system filter"
18326 .vindex "&$address_pipe$&"
18327 This specifies the transport driver that is to be used when a &%pipe%& command
18328 is used in a system filter. During the delivery, the variable &$address_pipe$&
18329 contains the pipe command.
18330
18331
18332 .option system_filter_reply_transport main string&!! unset
18333 .cindex "&(autoreply)& transport" "for system filter"
18334 This specifies the transport driver that is to be used when a &%mail%& command
18335 is used in a system filter.
18336
18337
18338 .option system_filter_user main string unset
18339 .cindex "uid (user id)" "system filter"
18340 If this option is set to root, the system filter is run in the main Exim
18341 delivery process, as root.  Otherwise, the system filter runs in a separate
18342 process, as the given user, defaulting to the Exim run-time user.
18343 Unless the string consists entirely of digits, it
18344 is looked up in the password data. Failure to find the named user causes a
18345 configuration error. The gid is either taken from the password data, or
18346 specified by &%system_filter_group%&. When the uid is specified numerically,
18347 &%system_filter_group%& is required to be set.
18348
18349 If the system filter generates any pipe, file, or reply deliveries, the uid
18350 under which the filter is run is used when transporting them, unless a
18351 transport option overrides.
18352
18353
18354 .option tcp_nodelay main boolean true
18355 .cindex "daemon" "TCP_NODELAY on sockets"
18356 .cindex "Nagle algorithm"
18357 .cindex "TCP_NODELAY on listening sockets"
18358 If this option is set false, it stops the Exim daemon setting the
18359 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18360 turns off the &"Nagle algorithm"&, which is a way of improving network
18361 performance in interactive (character-by-character) situations. Turning it off
18362 should improve Exim's performance a bit, so that is what happens by default.
18363 However, it appears that some broken clients cannot cope, and time out. Hence
18364 this option. It affects only those sockets that are set up for listening by the
18365 daemon. Sockets created by the smtp transport for delivering mail always set
18366 TCP_NODELAY.
18367
18368
18369 .option timeout_frozen_after main time 0s
18370 .cindex "frozen messages" "timing out"
18371 .cindex "timeout" "frozen messages"
18372 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18373 message of any kind that has been in the queue for longer than the given time
18374 is automatically cancelled at the next queue run. If the frozen message is a
18375 bounce message, it is just discarded; otherwise, a bounce is sent to the
18376 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18377 If you want to timeout frozen bounce messages earlier than other kinds of
18378 frozen message, see &%ignore_bounce_errors_after%&.
18379
18380 &*Note:*& the default value of zero means no timeouts; with this setting,
18381 frozen messages remain in the queue forever (except for any frozen bounce
18382 messages that are released by &%ignore_bounce_errors_after%&).
18383
18384
18385 .option timezone main string unset
18386 .cindex "timezone, setting"
18387 .cindex "environment" "values from"
18388 The value of &%timezone%& is used to set the environment variable TZ while
18389 running Exim (if it is different on entry). This ensures that all timestamps
18390 created by Exim are in the required timezone. If you want all your timestamps
18391 to be in UTC (aka GMT) you should set
18392 .code
18393 timezone = UTC
18394 .endd
18395 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18396 or, if that is not set, from the value of the TZ environment variable when Exim
18397 is built. If &%timezone%& is set to the empty string, either at build or run
18398 time, any existing TZ variable is removed from the environment when Exim
18399 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18400 unfortunately not all, operating systems.
18401
18402
18403 .option tls_advertise_hosts main "host list&!!" *
18404 .cindex "TLS" "advertising"
18405 .cindex "encryption" "on SMTP connection"
18406 .cindex "SMTP" "encrypted connection"
18407 .cindex "ESMTP extensions" STARTTLS
18408 When Exim is built with support for TLS encrypted connections, the availability
18409 of the STARTTLS command to set up an encrypted session is advertised in
18410 response to EHLO only to those client hosts that match this option. See
18411 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18412 Note that the default value requires that a certificate be supplied
18413 using the &%tls_certificate%& option.  If TLS support for incoming connections
18414 is not required the &%tls_advertise_hosts%& option should be set empty.
18415
18416
18417 .option tls_alpn main "string list&!!" "smtp : esmtp"
18418 .cindex TLS "Application Layer Protocol Names"
18419 .cindex TLS ALPN
18420 .cindex ALPN "set acceptable names for server"
18421 If this option is set,
18422 the TLS library supports ALPN,
18423 and the client offers either more than one
18424 ALPN name or a name which does not match the list,
18425 the TLS connection is declined.
18426
18427
18428 .option tls_certificate main "string list&!!" unset
18429 .cindex "TLS" "server certificate; location of"
18430 .cindex "certificate" "server, location of"
18431 The value of this option is expanded, and must then be a list of absolute paths to
18432 files which contain the server's certificates (in PEM format).
18433 Commonly only one file is needed.
18434 The server's private key is also
18435 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18436 &<<CHAPTLS>>& for further details.
18437
18438 &*Note*&: The certificates defined by this option are used only when Exim is
18439 receiving incoming messages as a server. If you want to supply certificates for
18440 use when sending messages as a client, you must set the &%tls_certificate%&
18441 option in the relevant &(smtp)& transport.
18442
18443 &*Note*&: If you use filenames based on IP addresses, change the list
18444 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18445
18446 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18447 when a list of more than one
18448 file is used, the &$tls_in_ourcert$& variable is unreliable.
18449 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18450
18451 .cindex SNI "selecting server certificate based on"
18452 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18453 if the OpenSSL build supports TLS extensions and the TLS client sends the
18454 Server Name Indication extension, then this option and others documented in
18455 &<<SECTtlssni>>& will be re-expanded.
18456
18457 If this option is unset or empty a self-signed certificate will be
18458 used.
18459 Under Linux this is generated at daemon startup; on other platforms it will be
18460 generated fresh for every connection.
18461
18462 .option tls_crl main string&!! unset
18463 .cindex "TLS" "server certificate revocation list"
18464 .cindex "certificate" "revocation list for server"
18465 This option specifies a certificate revocation list. The expanded value must
18466 be the name of a file that contains CRLs in PEM format.
18467
18468 Under OpenSSL the option can specify a directory with CRL files.
18469
18470 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18471 for each signing element of the certificate chain (i.e. all but the leaf).
18472 For the file variant this can be multiple PEM blocks in the one file.
18473
18474 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18475
18476
18477 .option tls_dh_max_bits main integer 2236
18478 .cindex "TLS" "D-H bit count"
18479 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18480 the chosen TLS library.  That value might prove to be too high for
18481 interoperability.  This option provides a maximum clamp on the value
18482 suggested, trading off security for interoperability.
18483
18484 The value must be at least 1024.
18485
18486 The value 2236 was chosen because, at time of adding the option, it was the
18487 hard-coded maximum value supported by the NSS cryptographic library, as used
18488 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18489
18490 If you prefer more security and are willing to break some clients, raise this
18491 number.
18492
18493 Note that the value passed to GnuTLS for *generating* a new prime may be a
18494 little less than this figure, because GnuTLS is inexact and may produce a
18495 larger prime than requested.
18496
18497
18498 .option tls_dhparam main string&!! unset
18499 .cindex "TLS" "D-H parameters for server"
18500 The value of this option is expanded and indicates the source of DH parameters
18501 to be used by Exim.
18502
18503 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18504 local DH parameters*&, which has been supported across all versions of Exim.  The
18505 other specific constants available are a fallback so that even when
18506 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18507
18508 If &%tls_dhparam%& is a filename starting with a &`/`&,
18509 then it names a file from which DH
18510 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18511 PKCS#3 representation of the DH prime.  If the file does not exist, for
18512 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18513 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18514 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18515 and treated as though the &%tls_dhparam%& were set to "none".
18516
18517 If this option expands to the string "none", then no DH parameters will be
18518 loaded by Exim.
18519
18520 If this option expands to the string "historic" and Exim is using GnuTLS, then
18521 Exim will attempt to load a file from inside the spool directory.  If the file
18522 does not exist, Exim will attempt to create it.
18523 See section &<<SECTgnutlsparam>>& for further details.
18524
18525 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18526 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18527
18528 In older versions of Exim the default was the 2048 bit prime described in section
18529 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18530 in IKE is assigned number 23.
18531
18532 Otherwise, the option must expand to the name used by Exim for any of a number
18533 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18534 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18535 the number used by IKE, or "default" which corresponds to
18536 &`exim.dev.20160529.3`&.
18537
18538 The available standard primes are:
18539 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18540 &`ike1`&, &`ike2`&, &`ike5`&,
18541 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18542 &`ike22`&, &`ike23`& and &`ike24`&.
18543
18544 The available additional primes are:
18545 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18546
18547 Some of these will be too small to be accepted by clients.
18548 Some may be too large to be accepted by clients.
18549 The open cryptographic community has suspicions about the integrity of some
18550 of the later IKE values, which led into RFC7919 providing new fixed constants
18551 (the "ffdhe" identifiers).
18552
18553 At this point, all of the "ike" values should be considered obsolete;
18554 they are still in Exim to avoid breaking unusual configurations, but are
18555 candidates for removal the next time we have backwards-incompatible changes.
18556 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18557 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18558 SHOULD NOT.
18559 Because of this, Exim regards them as deprecated; if either of the first pair
18560 are used, warnings will be logged in the paniclog, and if any are used then
18561 warnings will be logged in the mainlog.
18562 All four will be removed in a future Exim release.
18563
18564 The TLS protocol does not negotiate an acceptable size for this; clients tend
18565 to hard-drop connections if what is offered by the server is unacceptable,
18566 whether too large or too small, and there's no provision for the client to
18567 tell the server what these constraints are.  Thus, as a server operator, you
18568 need to make an educated guess as to what is most likely to work for your
18569 userbase.
18570
18571 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18572 is most likely to maximise interoperability.  The upper bound comes from
18573 applications using the Mozilla Network Security Services (NSS) library, which
18574 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18575 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18576 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18577 acceptable bound from 1024 to 2048.
18578
18579
18580 .option tls_eccurve main string list&!! &`auto`&
18581 .cindex TLS "EC cryptography"
18582 This option selects EC curves for use by Exim when used with OpenSSL.
18583 It has no effect when Exim is used with GnuTLS
18584 (the equivalent can be done using a priority string for the
18585 &%tls_require_ciphers%& option).
18586
18587 After expansion it must contain
18588 one or (only for OpenSSL versiona 1.1.1 onwards) more
18589 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18590 Consult your OpenSSL manual for valid curve names.
18591
18592 For OpenSSL versions before (and not including) 1.0.2, the string
18593 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18594 &`auto`& tells the library to choose.
18595
18596 If the option expands to an empty string, the effect is undefined.
18597
18598
18599 .option tls_ocsp_file main string&!! unset
18600 .cindex TLS "certificate status"
18601 .cindex TLS "OCSP proof file"
18602 This option
18603 must if set expand to the absolute path to a file which contains a current
18604 status proof for the server's certificate, as obtained from the
18605 Certificate Authority.
18606
18607 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18608 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18609
18610 For OpenSSL 1.1.0 or later, and
18611 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18612 of files, to match a list given for the &%tls_certificate%& option.
18613 The ordering of the two lists must match.
18614 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18615
18616 The file(s) should be in DER format,
18617 except for GnuTLS 3.6.3 or later
18618 or for OpenSSL,
18619 when an optional filetype prefix can be used.
18620 The prefix must be one of "DER" or "PEM", followed by
18621 a single space.  If one is used it sets the format for subsequent
18622 files in the list; the initial format is DER.
18623 If multiple proofs are wanted, for multiple chain elements
18624 (this only works under TLS1.3)
18625 they must be coded as a combined OCSP response.
18626
18627 Although GnuTLS will accept PEM files with multiple separate
18628 PEM blobs (ie. separate OCSP responses), it sends them in the
18629 TLS Certificate record interleaved with the certificates of the chain;
18630 although a GnuTLS client is happy with that, an OpenSSL client is not.
18631
18632 .option tls_on_connect_ports main "string list" unset
18633 .cindex SSMTP
18634 .cindex SMTPS
18635 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18636 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18637 set up without waiting for the client to issue a STARTTLS command. For
18638 further details, see section &<<SECTsupobssmt>>&.
18639
18640
18641
18642 .option tls_privatekey main "string list&!!" unset
18643 .cindex "TLS" "server private key; location of"
18644 The value of this option is expanded, and must then be a list of absolute paths to
18645 files which contains the server's private keys.
18646 If this option is unset, or if
18647 the expansion is forced to fail, or the result is an empty string, the private
18648 key is assumed to be in the same file as the server's certificates. See chapter
18649 &<<CHAPTLS>>& for further details.
18650
18651 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18652
18653
18654 .option tls_remember_esmtp main boolean false
18655 .cindex "TLS" "esmtp state; remembering"
18656 .cindex "TLS" "broken clients"
18657 If this option is set true, Exim violates the RFCs by remembering that it is in
18658 &"esmtp"& state after successfully negotiating a TLS session. This provides
18659 support for broken clients that fail to send a new EHLO after starting a
18660 TLS session.
18661
18662
18663 .option tls_require_ciphers main string&!! unset
18664 .cindex "TLS" "requiring specific ciphers"
18665 .cindex "cipher" "requiring specific"
18666 This option controls which ciphers can be used for incoming TLS connections.
18667 The &(smtp)& transport has an option of the same name for controlling outgoing
18668 connections. This option is expanded for each connection, so can be varied for
18669 different clients if required. The value of this option must be a list of
18670 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18671 in somewhat different ways. If GnuTLS is being used, the client controls the
18672 preference order of the available ciphers. Details are given in sections
18673 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18674
18675
18676 .option tls_resumption_hosts main "host list&!!" unset
18677 .cindex TLS resumption
18678 This option controls which connections to offer the TLS resumption feature.
18679 See &<<SECTresumption>>& for details.
18680
18681
18682 .option tls_try_verify_hosts main "host list&!!" unset
18683 .cindex "TLS" "client certificate verification"
18684 .cindex "certificate" "verification of client"
18685 See &%tls_verify_hosts%& below.
18686
18687
18688 .option tls_verify_certificates main string&!! system
18689 .cindex "TLS" "client certificate verification"
18690 .cindex "certificate" "verification of client"
18691 The value of this option is expanded, and must then be either the
18692 word "system"
18693 or the absolute path to
18694 a file or directory containing permitted certificates for clients that
18695 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18696
18697 The "system" value for the option will use a
18698 system default location compiled into the SSL library.
18699 This is not available for GnuTLS versions preceding 3.0.20,
18700 and will be taken as empty; an explicit location
18701 must be specified.
18702
18703 The use of a directory for the option value is not available for GnuTLS versions
18704 preceding 3.3.6 and a single file must be used.
18705
18706 With OpenSSL the certificates specified
18707 explicitly
18708 either by file or directory
18709 are added to those given by the system default location.
18710
18711 These certificates should be for the certificate authorities trusted, rather
18712 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18713 the value is a file then the certificates are sent by Exim as a server to
18714 connecting clients, defining the list of accepted certificate authorities.
18715 Thus the values defined should be considered public data.  To avoid this,
18716 use the explicit directory version. (If your peer is Exim up to 4.85,
18717 using GnuTLS, you may need to send the CAs (thus using the file
18718 variant). Otherwise the peer doesn't send its certificate.)
18719
18720 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18721
18722 A forced expansion failure or setting to an empty string is equivalent to
18723 being unset.
18724
18725
18726 .option tls_verify_hosts main "host list&!!" unset
18727 .cindex "TLS" "client certificate verification"
18728 .cindex "certificate" "verification of client"
18729 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18730 certificates from clients. The expected certificates are defined by
18731 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18732 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18733 &%tls_verify_certificates%& is not set.
18734
18735 Any client that matches &%tls_verify_hosts%& is constrained by
18736 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18737 present one of the listed certificates. If it does not, the connection is
18738 aborted.
18739 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18740 the host to use TLS. It can still send SMTP commands through unencrypted
18741 connections. Forcing a client to use TLS has to be done separately using an
18742 ACL to reject inappropriate commands when the connection is not encrypted.
18743
18744 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18745 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18746 certificate and checks it against &%tls_verify_certificates%&, but does not
18747 abort the connection if there is no certificate or if it does not match. This
18748 state can be detected in an ACL, which makes it possible to implement policies
18749 such as &"accept for relay only if a verified certificate has been received,
18750 but accept for local delivery if encrypted, even without a verified
18751 certificate"&.
18752
18753 Client hosts that match neither of these lists are not asked to present
18754 certificates.
18755
18756
18757 .option trusted_groups main "string list&!!" unset
18758 .cindex "trusted groups"
18759 .cindex "groups" "trusted"
18760 This option is expanded just once, at the start of Exim's processing. If this
18761 option is set, any process that is running in one of the listed groups, or
18762 which has one of them as a supplementary group, is trusted. The groups can be
18763 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18764 details of what trusted callers are permitted to do. If neither
18765 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18766 are trusted.
18767
18768 .option trusted_users main "string list&!!" unset
18769 .cindex "trusted users"
18770 .cindex "user" "trusted"
18771 This option is expanded just once, at the start of Exim's processing. If this
18772 option is set, any process that is running as one of the listed users is
18773 trusted. The users can be specified numerically or by name. See section
18774 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18775 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18776 Exim user are trusted.
18777
18778 .option unknown_login main string&!! unset
18779 .cindex "uid (user id)" "unknown caller"
18780 .vindex "&$caller_uid$&"
18781 This is a specialized feature for use in unusual configurations. By default, if
18782 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18783 gives up. The &%unknown_login%& option can be used to set a login name to be
18784 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18785 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18786 is used for the user's real name (gecos field), unless this has been set by the
18787 &%-F%& option.
18788
18789 .option unknown_username main string unset
18790 See &%unknown_login%&.
18791
18792 .option untrusted_set_sender main "address list&!!" unset
18793 .cindex "trusted users"
18794 .cindex "sender" "setting by untrusted user"
18795 .cindex "untrusted user setting sender"
18796 .cindex "user" "untrusted setting sender"
18797 .cindex "envelope from"
18798 .cindex "envelope sender"
18799 When an untrusted user submits a message to Exim using the standard input, Exim
18800 normally creates an envelope sender address from the user's login and the
18801 default qualification domain. Data from the &%-f%& option (for setting envelope
18802 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18803 is used) is ignored.
18804
18805 However, untrusted users are permitted to set an empty envelope sender address,
18806 to declare that a message should never generate any bounces. For example:
18807 .code
18808 exim -f '<>' user@domain.example
18809 .endd
18810 .vindex "&$sender_ident$&"
18811 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18812 other envelope sender addresses in a controlled way. When it is set, untrusted
18813 users are allowed to set envelope sender addresses that match any of the
18814 patterns in the list. Like all address lists, the string is expanded. The
18815 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18816 users to setting senders that start with their login ids
18817 followed by a hyphen
18818 by a setting like this:
18819 .code
18820 untrusted_set_sender = ^$sender_ident-
18821 .endd
18822 If you want to allow untrusted users to set envelope sender addresses without
18823 restriction, you can use
18824 .code
18825 untrusted_set_sender = *
18826 .endd
18827 The &%untrusted_set_sender%& option applies to all forms of local input, but
18828 only to the setting of the envelope sender. It does not permit untrusted users
18829 to use the other options which trusted user can use to override message
18830 parameters. Furthermore, it does not stop Exim from removing an existing
18831 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18832 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18833 overriding these actions. The handling of the &'Sender:'& header is also
18834 described in section &<<SECTthesenhea>>&.
18835
18836 The log line for a message's arrival shows the envelope sender following
18837 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18838 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18839 envelope sender address, the user's login is shown in parentheses after the
18840 sender address.
18841
18842
18843 .option uucp_from_pattern main string "see below"
18844 .cindex "&""From""& line"
18845 .cindex "UUCP" "&""From""& line"
18846 Some applications that pass messages to an MTA via a command line interface use
18847 an initial line starting with &"From&~"& to pass the envelope sender. In
18848 particular, this is used by UUCP software. Exim recognizes such a line by means
18849 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18850 matches, the sender address is constructed by expanding the contents of
18851 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18852 default pattern recognizes lines in the following two forms:
18853 .code
18854 From ph10 Fri Jan  5 12:35 GMT 1996
18855 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18856 .endd
18857 The pattern can be seen by running
18858 .code
18859 exim -bP uucp_from_pattern
18860 .endd
18861 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18862 year in the second case. The first word after &"From&~"& is matched in the
18863 regular expression by a parenthesized subpattern. The default value for
18864 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18865 (&"ph10"& in the example above) as the message's sender. See also
18866 &%ignore_fromline_hosts%&.
18867
18868
18869 .option uucp_from_sender main string&!! &`$1`&
18870 See &%uucp_from_pattern%& above.
18871
18872
18873 .option warn_message_file main string&!! unset
18874 .cindex "warning of delay" "customizing the message"
18875 .cindex "customizing" "warning message"
18876 This option defines a template file containing paragraphs of text to be used
18877 for constructing the warning message which is sent by Exim when a message has
18878 been in the queue for a specified amount of time, as specified by
18879 &%delay_warning%&. Details of the file's contents are given in chapter
18880 &<<CHAPemsgcust>>&.
18881 .cindex warn_message_file "tainted data"
18882 The option is expanded to give the file path, which must be
18883 absolute and untainted.
18884 See also &%bounce_message_file%&.
18885
18886
18887 .option write_rejectlog main boolean true
18888 .cindex "reject log" "disabling"
18889 If this option is set false, Exim no longer writes anything to the reject log.
18890 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18891 .ecindex IIDconfima
18892 .ecindex IIDmaiconf
18893
18894
18895
18896
18897 . ////////////////////////////////////////////////////////////////////////////
18898 . ////////////////////////////////////////////////////////////////////////////
18899
18900 .chapter "Generic options for routers" "CHAProutergeneric"
18901 .scindex IIDgenoprou1 "options" "generic; for routers"
18902 .scindex IIDgenoprou2 "generic options" "router"
18903 This chapter describes the generic options that apply to all routers.
18904 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18905
18906 For a general description of how a router operates, see sections
18907 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18908 which the preconditions are tested. The order of expansion of the options that
18909 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18910 &%headers_remove%&, &%transport%&.
18911
18912 The name of a router is limited to be &drivernamemax; ASCII characters long;
18913 prior to Exim 4.95 names would be silently truncated at this length, but now
18914 it is enforced.
18915
18916
18917 .option address_data routers string&!! unset
18918 .cindex "router" "data attached to address"
18919 The string is expanded just before the router is run, that is, after all the
18920 precondition tests have succeeded. If the expansion is forced to fail, the
18921 router declines, the value of &%address_data%& remains unchanged, and the
18922 &%more%& option controls what happens next. Other expansion failures cause
18923 delivery of the address to be deferred.
18924
18925 .vindex "&$address_data$&"
18926 When the expansion succeeds, the value is retained with the address, and can be
18927 accessed using the variable &$address_data$& in the current router, subsequent
18928 routers, and the eventual transport.
18929
18930 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18931 that runs a user's filter file, the contents of &$address_data$& are accessible
18932 in the filter. This is not normally a problem, because such data is usually
18933 either not confidential or it &"belongs"& to the current user, but if you do
18934 put confidential data into &$address_data$& you need to remember this point.
18935
18936 Even if the router declines or passes, the value of &$address_data$& remains
18937 with the address, though it can be changed by another &%address_data%& setting
18938 on a subsequent router. If a router generates child addresses, the value of
18939 &$address_data$& propagates to them. This also applies to the special kind of
18940 &"child"& that is generated by a router with the &%unseen%& option.
18941
18942 The idea of &%address_data%& is that you can use it to look up a lot of data
18943 for the address once, and then pick out parts of the data later. For example,
18944 you could use a single LDAP lookup to return a string of the form
18945 .code
18946 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18947 .endd
18948 In the transport you could pick out the mailbox by a setting such as
18949 .code
18950 file = ${extract{mailbox}{$address_data}}
18951 .endd
18952 This makes the configuration file less messy, and also reduces the number of
18953 lookups (though Exim does cache lookups).
18954
18955 See also the &%set%& option below.
18956
18957 .vindex "&$sender_address_data$&"
18958 .vindex "&$address_data$&"
18959 The &%address_data%& facility is also useful as a means of passing information
18960 from one router to another, and from a router to a transport. In addition, if
18961 &$address_data$& is set by a router when verifying a recipient address from an
18962 ACL, it remains available for use in the rest of the ACL statement. After
18963 verifying a sender, the value is transferred to &$sender_address_data$&.
18964
18965
18966
18967 .option address_test routers&!? boolean true
18968 .oindex "&%-bt%&"
18969 .cindex "router" "skipping when address testing"
18970 If this option is set false, the router is skipped when routing is being tested
18971 by means of the &%-bt%& command line option. This can be a convenience when
18972 your first router sends messages to an external scanner, because it saves you
18973 having to set the &"already scanned"& indicator when testing real address
18974 routing.
18975
18976
18977
18978 .option cannot_route_message routers string&!! unset
18979 .cindex "router" "customizing &""cannot route""& message"
18980 .cindex "customizing" "&""cannot route""& message"
18981 This option specifies a text message that is used when an address cannot be
18982 routed because Exim has run out of routers. The default message is
18983 &"Unrouteable address"&. This option is useful only on routers that have
18984 &%more%& set false, or on the very last router in a configuration, because the
18985 value that is used is taken from the last router that is considered. This
18986 includes a router that is skipped because its preconditions are not met, as
18987 well as a router that declines. For example, using the default configuration,
18988 you could put:
18989 .code
18990 cannot_route_message = Remote domain not found in DNS
18991 .endd
18992 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18993 and
18994 .code
18995 cannot_route_message = Unknown local user
18996 .endd
18997 on the final router that checks for local users. If string expansion fails for
18998 this option, the default message is used. Unless the expansion failure was
18999 explicitly forced, a message about the failure is written to the main and panic
19000 logs, in addition to the normal message about the routing failure.
19001
19002
19003 .option caseful_local_part routers boolean false
19004 .cindex "case of local parts"
19005 .cindex "router" "case of local parts"
19006 By default, routers handle the local parts of addresses in a case-insensitive
19007 manner, though the actual case is preserved for transmission with the message.
19008 If you want the case of letters to be significant in a router, you must set
19009 this option true. For individual router options that contain address or local
19010 part lists (for example, &%local_parts%&), case-sensitive matching can be
19011 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
19012 more details.
19013
19014 .vindex "&$local_part$&"
19015 .vindex "&$original_local_part$&"
19016 .vindex "&$parent_local_part$&"
19017 The value of the &$local_part$& variable is forced to lower case while a
19018 router is running unless &%caseful_local_part%& is set. When a router assigns
19019 an address to a transport, the value of &$local_part$& when the transport runs
19020 is the same as it was in the router. Similarly, when a router generates child
19021 addresses by aliasing or forwarding, the values of &$original_local_part$&
19022 and &$parent_local_part$& are those that were used by the redirecting router.
19023
19024 This option applies to the processing of an address by a router. When a
19025 recipient address is being processed in an ACL, there is a separate &%control%&
19026 modifier that can be used to specify case-sensitive processing within the ACL
19027 (see section &<<SECTcontrols>>&).
19028
19029
19030
19031 .option check_local_user routers&!? boolean false
19032 .cindex "local user, checking in router"
19033 .cindex "router" "checking for local user"
19034 .cindex "&_/etc/passwd_&"
19035 .vindex "&$home$&"
19036 When this option is true, Exim checks that the local part of the recipient
19037 address (with affixes removed if relevant) is the name of an account on the
19038 local system. The check is done by calling the &[getpwnam()]& function rather
19039 than trying to read &_/etc/passwd_& directly. This means that other methods of
19040 holding password data (such as NIS) are supported. If the local part is a local
19041 user,
19042 .cindex "tainted data" "de-tainting"
19043 .cindex "de-tainting" "using router check_local_user option"
19044 &$local_part_data$& is set to an untainted version of the local part and
19045 &$home$& is set from the password data. The latter can be tested in other
19046 preconditions that are evaluated after this one (the order of evaluation is
19047 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19048 overridden by &%router_home_directory%&. If the local part is not a local user,
19049 the router is skipped.
19050
19051 If you want to check that the local part is either the name of a local user
19052 or matches something else, you cannot combine &%check_local_user%& with a
19053 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19054 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19055 setting to achieve this. For example:
19056 .code
19057 local_parts = passwd;$local_part : lsearch;/etc/other/users
19058 .endd
19059 Note, however, that the side effects of &%check_local_user%& (such as setting
19060 up a home directory) do not occur when a &(passwd)& lookup is used in a
19061 &%local_parts%& (or any other) precondition.
19062
19063
19064
19065 .option condition routers&!? string&!! unset
19066 .cindex "router" "customized precondition"
19067 This option specifies a general precondition test that has to succeed for the
19068 router to be called. The &%condition%& option is the last precondition to be
19069 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19070 result is a forced failure, or an empty string, or one of the strings &"0"& or
19071 &"no"& or &"false"& (checked without regard to the case of the letters), the
19072 router is skipped, and the address is offered to the next one.
19073
19074 If the result is any other value, the router is run (as this is the last
19075 precondition to be evaluated, all the other preconditions must be true).
19076
19077 This option is unusual in that multiple &%condition%& options may be present.
19078 All &%condition%& options must succeed.
19079
19080 The &%condition%& option provides a means of applying custom conditions to the
19081 running of routers. Note that in the case of a simple conditional expansion,
19082 the default expansion values are exactly what is wanted. For example:
19083 .code
19084 condition = ${if >{$message_age}{600}}
19085 .endd
19086 Because of the default behaviour of the string expansion, this is equivalent to
19087 .code
19088 condition = ${if >{$message_age}{600}{true}{}}
19089 .endd
19090
19091 A multiple condition example, which succeeds:
19092 .code
19093 condition = ${if >{$message_age}{600}}
19094 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19095 condition = foobar
19096 .endd
19097
19098 If the expansion fails (other than forced failure) delivery is deferred. Some
19099 of the other precondition options are common special cases that could in fact
19100 be specified using &%condition%&.
19101
19102 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19103 are far older, and use one set of semantics.  ACLs are newer and when
19104 they were created, the ACL &%condition%& process was given far stricter
19105 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19106 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19107 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19108 Router rules processing behavior.
19109
19110 This is best illustrated in an example:
19111 .code
19112 # If used in an ACL condition will fail with a syntax error, but
19113 # in a router condition any extra characters are treated as a string
19114
19115 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19116 true {yes} {no}}
19117
19118 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19119  {yes} {no}}
19120 .endd
19121 In each example above, the &%if%& statement actually ends after
19122 &"{google.com}}"&.  Since no true or false braces were defined, the
19123 default &%if%& behavior is to return a boolean true or a null answer
19124 (which evaluates to false). The rest of the line is then treated as a
19125 string. So the first example resulted in the boolean answer &"true"&
19126 with the string &" {yes} {no}}"& appended to it. The second example
19127 resulted in the null output (indicating false) with the string
19128 &" {yes} {no}}"& appended to it.
19129
19130 In fact you can put excess forward braces in too.  In the router
19131 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19132 mean something, like after a &"$"& or when required as part of a
19133 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19134 string characters.
19135
19136 Thus, in a Router, the above expansion strings will both always evaluate
19137 true, as the result of expansion is a non-empty string which doesn't
19138 match an explicit false value.  This can be tricky to debug.  By
19139 contrast, in an ACL either of those strings will always result in an
19140 expansion error because the result doesn't look sufficiently boolean.
19141
19142
19143 .option debug_print routers string&!! unset
19144 .cindex "testing" "variables in drivers"
19145 If this option is set and debugging is enabled (see the &%-d%& command line
19146 option) or in address-testing mode (see the &%-bt%& command line option),
19147 the string is expanded and included in the debugging output.
19148 If expansion of the string fails, the error message is written to the debugging
19149 output, and Exim carries on processing.
19150 This option is provided to help with checking out the values of variables and
19151 so on when debugging router configurations. For example, if a &%condition%&
19152 option appears not to be working, &%debug_print%& can be used to output the
19153 variables it references. The output happens after checks for &%domains%&,
19154 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19155 are tested. A newline is added to the text if it does not end with one.
19156 The variable &$router_name$& contains the name of the router.
19157
19158
19159
19160 .option disable_logging routers boolean false
19161 If this option is set true, nothing is logged for any routing errors
19162 or for any deliveries caused by this router. You should not set this option
19163 unless you really, really know what you are doing. See also the generic
19164 transport option of the same name.
19165
19166 .option dnssec_request_domains routers "domain list&!!" *
19167 .cindex "MX record" "security"
19168 .cindex "DNSSEC" "MX lookup"
19169 .cindex "security" "MX lookup"
19170 .cindex "DNS" "DNSSEC"
19171 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19172 the DNSSEC request bit set.
19173 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19174
19175 .option dnssec_require_domains routers "domain list&!!" unset
19176 .cindex "MX record" "security"
19177 .cindex "DNSSEC" "MX lookup"
19178 .cindex "security" "MX lookup"
19179 .cindex "DNS" "DNSSEC"
19180 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19181 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19182 (AD bit) set will be ignored and logged as a host-lookup failure.
19183 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19184
19185
19186 .option domains routers&!? "domain list&!!" unset
19187 .cindex "router" "restricting to specific domains"
19188 .vindex "&$domain_data$&"
19189 If this option is set, the router is skipped unless the current domain matches
19190 the list.
19191 The data returned by the list check
19192 is placed in &$domain_data$& for use in string
19193 expansions of the driver's private options and in the transport.
19194 See section &<<SECTrouprecon>>& for
19195 a list of the order in which preconditions are evaluated.
19196
19197 A complex example, using a file like:
19198 .code
19199 alice@dom1
19200 bill@dom1
19201 maggie@dom1
19202 .endd
19203 and checking both domain and local_part
19204 .code
19205 domains =         ${domain:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19206 local_parts = ${local_part:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19207 .endd
19208
19209
19210
19211 .option driver routers string unset
19212 This option must always be set. It specifies which of the available routers is
19213 to be used.
19214
19215
19216 .option dsn_lasthop routers boolean false
19217 .cindex "DSN" "success"
19218 .cindex "Delivery Status Notification" "success"
19219 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19220 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19221 instead send a success DSN as if the next hop does not support DSN.
19222 Not effective on redirect routers.
19223
19224
19225
19226 .option errors_to routers string&!! unset
19227 .cindex "envelope from"
19228 .cindex "envelope sender"
19229 .cindex "router" "changing address for errors"
19230 If a router successfully handles an address, it may assign the address to a
19231 transport for delivery or it may generate child addresses. In both cases, if
19232 there is a delivery problem during later processing, the resulting bounce
19233 message is sent to the address that results from expanding this string,
19234 provided that the address verifies successfully. The &%errors_to%& option is
19235 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19236
19237 The &%errors_to%& setting associated with an address can be overridden if it
19238 subsequently passes through other routers that have their own &%errors_to%&
19239 settings, or if the message is delivered by a transport with a &%return_path%&
19240 setting.
19241
19242 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19243 the expansion fails to verify, the errors address associated with the incoming
19244 address is used. At top level, this is the envelope sender. A non-forced
19245 expansion failure causes delivery to be deferred.
19246
19247 If an address for which &%errors_to%& has been set ends up being delivered over
19248 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19249 any bounces that are generated by other MTAs on the delivery route are also
19250 sent there. You can set &%errors_to%& to the empty string by either of these
19251 settings:
19252 .code
19253 errors_to =
19254 errors_to = ""
19255 .endd
19256 An expansion item that yields an empty string has the same effect. If you do
19257 this, a locally detected delivery error for addresses processed by this router
19258 no longer gives rise to a bounce message; the error is discarded. If the
19259 address is delivered to a remote host, the return path is set to &`<>`&, unless
19260 overridden by the &%return_path%& option on the transport.
19261
19262 .vindex "&$address_data$&"
19263 If for some reason you want to discard local errors, but use a non-empty
19264 MAIL command for remote delivery, you can preserve the original return
19265 path in &$address_data$& in the router, and reinstate it in the transport by
19266 setting &%return_path%&.
19267
19268 The most common use of &%errors_to%& is to direct mailing list bounces to the
19269 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19270 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19271
19272
19273
19274 .option expn routers&!? boolean true
19275 .cindex "address" "testing"
19276 .cindex "testing" "addresses"
19277 .cindex "EXPN" "router skipping"
19278 .cindex "router" "skipping for EXPN"
19279 If this option is turned off, the router is skipped when testing an address
19280 as a result of processing an SMTP EXPN command. You might, for example,
19281 want to turn it off on a router for users' &_.forward_& files, while leaving it
19282 on for the system alias file.
19283 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19284 are evaluated.
19285
19286 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19287 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19288 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19289
19290
19291
19292 .option fail_verify routers boolean false
19293 .cindex "router" "forcing verification failure"
19294 Setting this option has the effect of setting both &%fail_verify_sender%& and
19295 &%fail_verify_recipient%& to the same value.
19296
19297
19298
19299 .option fail_verify_recipient routers boolean false
19300 If this option is true and an address is accepted by this router when
19301 verifying a recipient, verification fails.
19302
19303
19304
19305 .option fail_verify_sender routers boolean false
19306 If this option is true and an address is accepted by this router when
19307 verifying a sender, verification fails.
19308
19309
19310
19311 .option fallback_hosts routers "string list" unset
19312 .cindex "router" "fallback hosts"
19313 .cindex "fallback" "hosts specified on router"
19314 String expansion is not applied to this option. The argument must be a
19315 colon-separated list of host names or IP addresses. The list separator can be
19316 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19317 each name or address. In fact, the format of each item is exactly the same as
19318 defined for the list of hosts in a &(manualroute)& router (see section
19319 &<<SECTformatonehostitem>>&).
19320
19321 If a router queues an address for a remote transport, this host list is
19322 associated with the address, and used instead of the transport's fallback host
19323 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19324 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19325 transport for further details.
19326
19327
19328 .option group routers string&!! "see below"
19329 .cindex "gid (group id)" "local delivery"
19330 .cindex "local transports" "uid and gid"
19331 .cindex "transport" "local"
19332 .cindex "router" "setting group"
19333 When a router queues an address for a transport, and the transport does not
19334 specify a group, the group given here is used when running the delivery
19335 process.
19336 The group may be specified numerically or by name. If expansion fails, the
19337 error is logged and delivery is deferred.
19338 The default is unset, unless &%check_local_user%& is set, when the default
19339 is taken from the password information. See also &%initgroups%& and &%user%&
19340 and the discussion in chapter &<<CHAPenvironment>>&.
19341
19342
19343
19344 .option headers_add routers list&!! unset
19345 .cindex "header lines" "adding"
19346 .cindex "router" "adding header lines"
19347 This option specifies a list of text headers,
19348 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19349 that is associated with any addresses that are accepted by the router.
19350 Each item is separately expanded, at routing time.  However, this
19351 option has no effect when an address is just being verified. The way in which
19352 the text is used to add header lines at transport time is described in section
19353 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19354 message is in the process of being transported. This means that references to
19355 header lines in string expansions in the transport's configuration do not
19356 &"see"& the added header lines.
19357
19358 The &%headers_add%& option is expanded after &%errors_to%&, but before
19359 &%headers_remove%& and &%transport%&. If an item is empty, or if
19360 an item expansion is forced to fail, the item has no effect. Other expansion
19361 failures are treated as configuration errors.
19362
19363 Unlike most options, &%headers_add%& can be specified multiple times
19364 for a router; all listed headers are added.
19365
19366 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19367 router that has the &%one_time%& option set.
19368
19369 .cindex "duplicate addresses"
19370 .oindex "&%unseen%&"
19371 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19372 additions are deleted when the address is passed on to subsequent routers.
19373 For a &%redirect%& router, if a generated address is the same as the incoming
19374 address, this can lead to duplicate addresses with different header
19375 modifications. Exim does not do duplicate deliveries (except, in certain
19376 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19377 which of the duplicates is discarded, so this ambiguous situation should be
19378 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19379
19380
19381
19382 .option headers_remove routers list&!! unset
19383 .cindex "header lines" "removing"
19384 .cindex "router" "removing header lines"
19385 This option specifies a list of text headers,
19386 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19387 that is associated with any addresses that are accepted by the router.
19388 However, the option has no effect when an address is just being verified.
19389 Each list item is separately expanded, at transport time.
19390 If an item ends in *, it will match any header with the given prefix.
19391 The way in which
19392 the text is used to remove header lines at transport time is described in
19393 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19394 the message is in the process of being transported. This means that references
19395 to header lines in string expansions in the transport's configuration still
19396 &"see"& the original header lines.
19397
19398 The &%headers_remove%& option is handled after &%errors_to%& and
19399 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19400 the item has no effect. Other expansion failures are treated as configuration
19401 errors.
19402
19403 Unlike most options, &%headers_remove%& can be specified multiple times
19404 for a router; all listed headers are removed.
19405
19406 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19407 router that has the &%one_time%& option set.
19408
19409 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19410 removal requests are deleted when the address is passed on to subsequent
19411 routers, and this can lead to problems with duplicates -- see the similar
19412 warning for &%headers_add%& above.
19413
19414 &*Warning 3*&: Because of the separate expansion of the list items,
19415 items that contain a list separator must have it doubled.
19416 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19417
19418
19419
19420 .option ignore_target_hosts routers "host list&!!" unset
19421 .cindex "IP address" "discarding"
19422 .cindex "router" "discarding IP addresses"
19423 Although this option is a host list, it should normally contain IP address
19424 entries rather than names. If any host that is looked up by the router has an
19425 IP address that matches an item in this list, Exim behaves as if that IP
19426 address did not exist. This option allows you to cope with rogue DNS entries
19427 like
19428 .code
19429 remote.domain.example.  A  127.0.0.1
19430 .endd
19431 by setting
19432 .code
19433 ignore_target_hosts = 127.0.0.1
19434 .endd
19435 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19436 discarded in this way, the router declines. In a conventional configuration, an
19437 attempt to mail to such a domain would normally provoke the &"unrouteable
19438 domain"& error, and an attempt to verify an address in the domain would fail.
19439 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19440 router declines if presented with one of the listed addresses.
19441
19442 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19443 means of the first or the second of the following settings, respectively:
19444 .code
19445 ignore_target_hosts = 0.0.0.0/0
19446 ignore_target_hosts = <; 0::0/0
19447 .endd
19448 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19449 in the second line matches all IPv6 addresses.
19450
19451 This option may also be useful for ignoring link-local and site-local IPv6
19452 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19453 is expanded before use as a list, it is possible to make it dependent on the
19454 domain that is being routed.
19455
19456 .vindex "&$host_address$&"
19457 During its expansion, &$host_address$& is set to the IP address that is being
19458 checked.
19459
19460 .option initgroups routers boolean false
19461 .cindex "additional groups"
19462 .cindex "groups" "additional"
19463 .cindex "local transports" "uid and gid"
19464 .cindex "transport" "local"
19465 If the router queues an address for a transport, and this option is true, and
19466 the uid supplied by the router is not overridden by the transport, the
19467 &[initgroups()]& function is called when running the transport to ensure that
19468 any additional groups associated with the uid are set up. See also &%group%&
19469 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19470
19471
19472
19473 .option local_part_prefix routers&!? "string list" unset
19474 .cindex affix "router precondition"
19475 .cindex "router" "prefix for local part"
19476 .cindex "prefix" "for local part, used in router"
19477 If this option is set, the router is skipped unless the local part starts with
19478 one of the given strings, or &%local_part_prefix_optional%& is true. See
19479 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19480 evaluated.
19481
19482 The list is scanned from left to right, and the first prefix that matches is
19483 used. A limited form of wildcard is available; if the prefix begins with an
19484 asterisk, it matches the longest possible sequence of arbitrary characters at
19485 the start of the local part. An asterisk should therefore always be followed by
19486 some character that does not occur in normal local parts.
19487 .cindex "multiple mailboxes"
19488 .cindex "mailbox" "multiple"
19489 Wildcarding can be used to set up multiple user mailboxes, as described in
19490 section &<<SECTmulbox>>&.
19491
19492 .vindex "&$local_part$&"
19493 .vindex "&$local_part_prefix$&"
19494 During the testing of the &%local_parts%& option, and while the router is
19495 running, the prefix is removed from the local part, and is available in the
19496 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19497 the router accepts the address, this remains true during subsequent delivery by
19498 a transport. In particular, the local part that is transmitted in the RCPT
19499 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19500 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19501 the relevant transport.
19502
19503 .vindex &$local_part_prefix_v$&
19504 If wildcarding (above) was used then the part of the prefix matching the
19505 wildcard is available in &$local_part_prefix_v$&.
19506
19507 When an address is being verified, &%local_part_prefix%& affects only the
19508 behaviour of the router. If the callout feature of verification is in use, this
19509 means that the full address, including the prefix, will be used during the
19510 callout.
19511
19512 The prefix facility is commonly used to handle local parts of the form
19513 &%owner-something%&. Another common use is to support local parts of the form
19514 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19515 to tell a user their forwarding is broken &-- by placing a router like this one
19516 immediately before the router that handles &_.forward_& files:
19517 .code
19518 real_localuser:
19519   driver = accept
19520   local_part_prefix = real-
19521   check_local_user
19522   transport = local_delivery
19523 .endd
19524 For security, it would probably be a good idea to restrict the use of this
19525 router to locally-generated messages, using a condition such as this:
19526 .code
19527   condition = ${if match {$sender_host_address}\
19528                          {\N^(|127\.0\.0\.1)$\N}}
19529 .endd
19530
19531 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19532 both conditions must be met if not optional. Care must be taken if wildcards
19533 are used in both a prefix and a suffix on the same router. Different
19534 separator characters must be used to avoid ambiguity.
19535
19536
19537 .option local_part_prefix_optional routers boolean false
19538 See &%local_part_prefix%& above.
19539
19540
19541
19542 .option local_part_suffix routers&!? "string list" unset
19543 .cindex "router" "suffix for local part"
19544 .cindex "suffix for local part" "used in router"
19545 This option operates in the same way as &%local_part_prefix%&, except that the
19546 local part must end (rather than start) with the given string, the
19547 &%local_part_suffix_optional%& option determines whether the suffix is
19548 mandatory, and the wildcard * character, if present, must be the last
19549 character of the suffix. This option facility is commonly used to handle local
19550 parts of the form &%something-request%& and multiple user mailboxes of the form
19551 &%username-foo%&.
19552
19553
19554 .option local_part_suffix_optional routers boolean false
19555 See &%local_part_suffix%& above.
19556
19557
19558
19559 .option local_parts routers&!? "local part list&!!" unset
19560 .cindex "router" "restricting to specific local parts"
19561 .cindex "local part" "checking in router"
19562 The router is run only if the local part of the address matches the list.
19563 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19564 are evaluated, and
19565 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19566 string is expanded, it is possible to make it depend on the domain, for
19567 example:
19568 .code
19569 local_parts = dbm;/usr/local/specials/$domain_data
19570 .endd
19571 .vindex "&$local_part_data$&"
19572 the data returned by the list check
19573 for the local part is placed in the variable &$local_part_data$& for use in
19574 expansions of the router's private options or in the transport.
19575 You might use this option, for
19576 example, if you have a large number of local virtual domains, and you want to
19577 send all postmaster mail to the same place without having to set up an alias in
19578 each virtual domain:
19579 .code
19580 postmaster:
19581   driver = redirect
19582   local_parts = postmaster
19583   data = postmaster@real.domain.example
19584 .endd
19585
19586
19587 .option log_as_local routers boolean "see below"
19588 .cindex "log" "delivery line"
19589 .cindex "delivery" "log line format"
19590 Exim has two logging styles for delivery, the idea being to make local
19591 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19592 recipient address is given just as the local part, without a domain. The use of
19593 this style is controlled by this option. It defaults to true for the &(accept)&
19594 router, and false for all the others. This option applies only when a
19595 router assigns an address to a transport. It has no effect on routers that
19596 redirect addresses.
19597
19598
19599
19600 .option more routers boolean&!! true
19601 The result of string expansion for this option must be a valid boolean value,
19602 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19603 result causes an error, and delivery is deferred. If the expansion is forced to
19604 fail, the default value for the option (true) is used. Other failures cause
19605 delivery to be deferred.
19606
19607 If this option is set false, and the router declines to handle the address, no
19608 further routers are tried, routing fails, and the address is bounced.
19609 .oindex "&%self%&"
19610 However, if the router explicitly passes an address to the following router by
19611 means of the setting
19612 .code
19613 self = pass
19614 .endd
19615 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19616 does not affect the behaviour if one of the precondition tests fails. In that
19617 case, the address is always passed to the next router.
19618
19619 Note that &%address_data%& is not considered to be a precondition. If its
19620 expansion is forced to fail, the router declines, and the value of &%more%&
19621 controls what happens next.
19622
19623
19624 .option pass_on_timeout routers boolean false
19625 .cindex "timeout" "of router"
19626 .cindex "router" "timeout"
19627 If a router times out during a host lookup, it normally causes deferral of the
19628 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19629 router, overriding &%no_more%&. This may be helpful for systems that are
19630 intermittently connected to the Internet, or those that want to pass to a smart
19631 host any messages that cannot immediately be delivered.
19632
19633 There are occasional other temporary errors that can occur while doing DNS
19634 lookups. They are treated in the same way as a timeout, and this option
19635 applies to all of them.
19636
19637
19638
19639 .option pass_router routers string unset
19640 .cindex "router" "go to after &""pass""&"
19641 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19642 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19643 routing to continue, and overriding a false setting of &%more%&. When one of
19644 these routers returns &"pass"&, the address is normally handed on to the next
19645 router in sequence. This can be changed by setting &%pass_router%& to the name
19646 of another router. However (unlike &%redirect_router%&) the named router must
19647 be below the current router, to avoid loops. Note that this option applies only
19648 to the special case of &"pass"&. It does not apply when a router returns
19649 &"decline"& because it cannot handle an address.
19650
19651
19652
19653 .option redirect_router routers string unset
19654 .cindex "router" "start at after redirection"
19655 Sometimes an administrator knows that it is pointless to reprocess addresses
19656 generated from alias or forward files with the same router again. For
19657 example, if an alias file translates real names into login ids there is no
19658 point searching the alias file a second time, especially if it is a large file.
19659
19660 The &%redirect_router%& option can be set to the name of any router instance.
19661 It causes the routing of any generated addresses to start at the named router
19662 instead of at the first router. This option has no effect if the router in
19663 which it is set does not generate new addresses.
19664
19665
19666
19667 .option require_files routers&!? "string list&!!" unset
19668 .cindex "file" "requiring for router"
19669 .cindex "router" "requiring file existence"
19670 This option provides a general mechanism for predicating the running of a
19671 router on the existence or non-existence of certain files or directories.
19672 Before running a router, as one of its precondition tests, Exim works its way
19673 through the &%require_files%& list, expanding each item separately.
19674
19675 Because the list is split before expansion, any colons in expansion items must
19676 be doubled, or the facility for using a different list separator must be used
19677 (&<<SECTlistsepchange>>&).
19678 If any expansion is forced to fail, the item is ignored. Other expansion
19679 failures cause routing of the address to be deferred.
19680
19681 If any expanded string is empty, it is ignored. Otherwise, except as described
19682 below, each string must be a fully qualified file path, optionally preceded by
19683 &"!"&. The paths are passed to the &[stat()]& function to test for the
19684 existence of the files or directories. The router is skipped if any paths not
19685 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19686
19687 .cindex "NFS"
19688 If &[stat()]& cannot determine whether a file exists or not, delivery of
19689 the message is deferred. This can happen when NFS-mounted filesystems are
19690 unavailable.
19691
19692 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19693 options, so you cannot use it to check for the existence of a file in which to
19694 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19695 full list of the order in which preconditions are evaluated.) However, as
19696 these options are all expanded, you can use the &%exists%& expansion condition
19697 to make such tests. The &%require_files%& option is intended for checking files
19698 that the router may be going to use internally, or which are needed by a
19699 transport (e.g., &_.procmailrc_&).
19700
19701 During delivery, the &[stat()]& function is run as root, but there is a
19702 facility for some checking of the accessibility of a file by another user.
19703 This is not a proper permissions check, but just a &"rough"& check that
19704 operates as follows:
19705
19706 If an item in a &%require_files%& list does not contain any forward slash
19707 characters, it is taken to be the user (and optional group, separated by a
19708 comma) to be checked for subsequent files in the list. If no group is specified
19709 but the user is specified symbolically, the gid associated with the uid is
19710 used. For example:
19711 .code
19712 require_files = mail:/some/file
19713 require_files = $local_part_data:$home/.procmailrc
19714 .endd
19715 If a user or group name in a &%require_files%& list does not exist, the
19716 &%require_files%& condition fails.
19717
19718 Exim performs the check by scanning along the components of the file path, and
19719 checking the access for the given uid and gid. It checks for &"x"& access on
19720 directories, and &"r"& access on the final file. Note that this means that file
19721 access control lists, if the operating system has them, are ignored.
19722
19723 &*Warning 1*&: When the router is being run to verify addresses for an
19724 incoming SMTP message, Exim is not running as root, but under its own uid. This
19725 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19726 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19727 user is not permitted to read one of the directories on the file's path.
19728
19729 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19730 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19731 without root access. In this case, if a check for access by a particular user
19732 is requested, Exim creates a subprocess that runs as that user, and tries the
19733 check again in that process.
19734
19735 The default action for handling an unresolved EACCES is to consider it to
19736 be caused by a configuration error, and routing is deferred because the
19737 existence or non-existence of the file cannot be determined. However, in some
19738 circumstances it may be desirable to treat this condition as if the file did
19739 not exist. If the filename (or the exclamation mark that precedes the filename
19740 for non-existence) is preceded by a plus sign, the EACCES error is treated
19741 as if the file did not exist. For example:
19742 .code
19743 require_files = +/some/file
19744 .endd
19745 If the router is not an essential part of verification (for example, it
19746 handles users' &_.forward_& files), another solution is to set the &%verify%&
19747 option false so that the router is skipped when verifying.
19748
19749
19750
19751 .option retry_use_local_part routers boolean "see below"
19752 .cindex "hints database" "retry keys"
19753 .cindex "local part" "in retry keys"
19754 When a delivery suffers a temporary routing failure, a retry record is created
19755 in Exim's hints database. For addresses whose routing depends only on the
19756 domain, the key for the retry record should not involve the local part, but for
19757 other addresses, both the domain and the local part should be included.
19758 Usually, remote routing is of the former kind, and local routing is of the
19759 latter kind.
19760
19761 This option controls whether the local part is used to form the key for retry
19762 hints for addresses that suffer temporary errors while being handled by this
19763 router. The default value is true for any router that has any of
19764 &%check_local_user%&,
19765 &%local_parts%&,
19766 &%condition%&,
19767 &%local_part_prefix%&,
19768 &%local_part_suffix%&,
19769 &%senders%& or
19770 &%require_files%&
19771 set, and false otherwise. Note that this option does not apply to hints keys
19772 for transport delays; they are controlled by a generic transport option of the
19773 same name.
19774
19775 Failing to set this option when it is needed
19776 (because a remote router handles only some of the local-parts for a domain)
19777 can result in incorrect error messages being generated.
19778
19779 The setting of &%retry_use_local_part%& applies only to the router on which it
19780 appears. If the router generates child addresses, they are routed
19781 independently; this setting does not become attached to them.
19782
19783
19784
19785 .option router_home_directory routers string&!! unset
19786 .cindex "router" "home directory for"
19787 .cindex "home directory" "for router"
19788 .vindex "&$home$&"
19789 This option sets a home directory for use while the router is running. (Compare
19790 &%transport_home_directory%&, which sets a home directory for later
19791 transporting.) In particular, if used on a &(redirect)& router, this option
19792 sets a value for &$home$& while a filter is running. The value is expanded;
19793 forced expansion failure causes the option to be ignored &-- other failures
19794 cause the router to defer.
19795
19796 Expansion of &%router_home_directory%& happens immediately after the
19797 &%check_local_user%& test (if configured), before any further expansions take
19798 place.
19799 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19800 are evaluated.)
19801 While the router is running, &%router_home_directory%& overrides the value of
19802 &$home$& that came from &%check_local_user%&.
19803
19804 When a router accepts an address and assigns it to a local transport (including
19805 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19806 delivery), the home directory setting for the transport is taken from the first
19807 of these values that is set:
19808
19809 .ilist
19810 The &%home_directory%& option on the transport;
19811 .next
19812 The &%transport_home_directory%& option on the router;
19813 .next
19814 The password data if &%check_local_user%& is set on the router;
19815 .next
19816 The &%router_home_directory%& option on the router.
19817 .endlist
19818
19819 In other words, &%router_home_directory%& overrides the password data for the
19820 router, but not for the transport.
19821
19822
19823
19824 .option self routers string freeze
19825 .cindex "MX record" "pointing to local host"
19826 .cindex "local host" "MX pointing to"
19827 This option applies to those routers that use a recipient address to find a
19828 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19829 and &(manualroute)& routers.
19830 Certain configurations of the &(queryprogram)& router can also specify a list
19831 of remote hosts.
19832 Usually such routers are configured to send the message to a remote host via an
19833 &(smtp)& transport. The &%self%& option specifies what happens when the first
19834 host on the list turns out to be the local host.
19835 The way in which Exim checks for the local host is described in section
19836 &<<SECTreclocipadd>>&.
19837
19838 Normally this situation indicates either an error in Exim's configuration (for
19839 example, the router should be configured not to process this domain), or an
19840 error in the DNS (for example, the MX should not point to this host). For this
19841 reason, the default action is to log the incident, defer the address, and
19842 freeze the message. The following alternatives are provided for use in special
19843 cases:
19844
19845 .vlist
19846 .vitem &%defer%&
19847 Delivery of the message is tried again later, but the message is not frozen.
19848
19849 .vitem "&%reroute%&: <&'domain'&>"
19850 The domain is changed to the given domain, and the address is passed back to
19851 be reprocessed by the routers. No rewriting of headers takes place. This
19852 behaviour is essentially a redirection.
19853
19854 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19855 The domain is changed to the given domain, and the address is passed back to be
19856 reprocessed by the routers. Any headers that contain the original domain are
19857 rewritten.
19858
19859 .vitem &%pass%&
19860 .oindex "&%more%&"
19861 .vindex "&$self_hostname$&"
19862 The router passes the address to the next router, or to the router named in the
19863 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19864 subsequent routing and delivery, the variable &$self_hostname$& contains the
19865 name of the local host that the router encountered. This can be used to
19866 distinguish between different cases for hosts with multiple names. The
19867 combination
19868 .code
19869 self = pass
19870 no_more
19871 .endd
19872 ensures that only those addresses that routed to the local host are passed on.
19873 Without &%no_more%&, addresses that were declined for other reasons would also
19874 be passed to the next router.
19875
19876 .vitem &%fail%&
19877 Delivery fails and an error report is generated.
19878
19879 .vitem &%send%&
19880 .cindex "local host" "sending to"
19881 The anomaly is ignored and the address is queued for the transport. This
19882 setting should be used with extreme caution. For an &(smtp)& transport, it
19883 makes sense only in cases where the program that is listening on the SMTP port
19884 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19885 different configuration file that handles the domain in another way.
19886 .endlist
19887
19888
19889
19890 .option senders routers&!? "address list&!!" unset
19891 .cindex "router" "checking senders"
19892 If this option is set, the router is skipped unless the message's sender
19893 address matches something on the list.
19894 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19895 are evaluated.
19896
19897 There are issues concerning verification when the running of routers is
19898 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19899 setting, it sets the sender to the null string. When using the &%-bt%& option
19900 to check a configuration file, it is necessary also to use the &%-f%& option to
19901 set an appropriate sender. For incoming mail, the sender is unset when
19902 verifying the sender, but is available when verifying any recipients. If the
19903 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19904 matters.
19905
19906
19907 .option set routers "string list" unset
19908 .cindex router variables
19909 This option may be used multiple times on a router;
19910 because of this the list aspect is mostly irrelevant.
19911 The list separator is a semicolon but can be changed in the
19912 usual way.
19913
19914 Each list-element given must be of the form &"name = value"&
19915 and the names used must start with the string &"r_"&.
19916 Values containing a list-separator should have them doubled.
19917 When a router runs, the strings are evaluated in order,
19918 to create variables which are added to the set associated with
19919 the address.
19920 This is done immediately after all the preconditions, before the
19921 evaluation of the &%address_data%& option.
19922 The variable is set with the expansion of the value.
19923 The variables can be used by the router options
19924 (not including any preconditions)
19925 and by the transport.
19926 Later definitions of a given named variable will override former ones.
19927 Variable use is via the usual &$r_...$& syntax.
19928
19929 This is similar to the &%address_data%& option, except that
19930 many independent variables can be used, with choice of naming.
19931
19932
19933 .option translate_ip_address routers string&!! unset
19934 .cindex "IP address" "translating"
19935 .cindex "packet radio"
19936 .cindex "router" "IP address translation"
19937 There exist some rare networking situations (for example, packet radio) where
19938 it is helpful to be able to translate IP addresses generated by normal routing
19939 mechanisms into other IP addresses, thus performing a kind of manual IP
19940 routing. This should be done only if the normal IP routing of the TCP/IP stack
19941 is inadequate or broken. Because this is an extremely uncommon requirement, the
19942 code to support this option is not included in the Exim binary unless
19943 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19944
19945 .vindex "&$host_address$&"
19946 The &%translate_ip_address%& string is expanded for every IP address generated
19947 by the router, with the generated address set in &$host_address$&. If the
19948 expansion is forced to fail, no action is taken.
19949 For any other expansion error, delivery of the message is deferred.
19950 If the result of the expansion is an IP address, that replaces the original
19951 address; otherwise the result is assumed to be a host name &-- this is looked
19952 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19953 produce one or more replacement IP addresses. For example, to subvert all IP
19954 addresses in some specific networks, this could be added to a router:
19955 .code
19956 translate_ip_address = \
19957   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19958     {$value}fail}}
19959 .endd
19960 The file would contain lines like
19961 .code
19962 10.2.3.128/26    some.host
19963 10.8.4.34/26     10.44.8.15
19964 .endd
19965 You should not make use of this facility unless you really understand what you
19966 are doing.
19967
19968
19969
19970 .option transport routers string&!! unset
19971 This option specifies the transport to be used when a router accepts an address
19972 and sets it up for delivery. A transport is never needed if a router is used
19973 only for verification. The value of the option is expanded at routing time,
19974 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19975 and result must be the name of one of the configured transports. If it is not,
19976 delivery is deferred.
19977
19978 The &%transport%& option is not used by the &(redirect)& router, but it does
19979 have some private options that set up transports for pipe and file deliveries
19980 (see chapter &<<CHAPredirect>>&).
19981
19982
19983
19984 .option transport_current_directory routers string&!! unset
19985 .cindex "current directory for local transport"
19986 This option associates a current directory with any address that is routed
19987 to a local transport. This can happen either because a transport is
19988 explicitly configured for the router, or because it generates a delivery to a
19989 file or a pipe. During the delivery process (that is, at transport time), this
19990 option string is expanded and is set as the current directory, unless
19991 overridden by a setting on the transport.
19992 If the expansion fails for any reason, including forced failure, an error is
19993 logged, and delivery is deferred.
19994 See chapter &<<CHAPenvironment>>& for details of the local delivery
19995 environment.
19996
19997
19998
19999
20000 .option transport_home_directory routers string&!! "see below"
20001 .cindex "home directory" "for local transport"
20002 This option associates a home directory with any address that is routed to a
20003 local transport. This can happen either because a transport is explicitly
20004 configured for the router, or because it generates a delivery to a file or a
20005 pipe. During the delivery process (that is, at transport time), the option
20006 string is expanded and is set as the home directory, unless overridden by a
20007 setting of &%home_directory%& on the transport.
20008 If the expansion fails for any reason, including forced failure, an error is
20009 logged, and delivery is deferred.
20010
20011 If the transport does not specify a home directory, and
20012 &%transport_home_directory%& is not set for the router, the home directory for
20013 the transport is taken from the password data if &%check_local_user%& is set for
20014 the router. Otherwise it is taken from &%router_home_directory%& if that option
20015 is set; if not, no home directory is set for the transport.
20016
20017 See chapter &<<CHAPenvironment>>& for further details of the local delivery
20018 environment.
20019
20020
20021
20022
20023 .option unseen routers boolean&!! false
20024 .cindex "router" "carrying on after success"
20025 The result of string expansion for this option must be a valid boolean value,
20026 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
20027 result causes an error, and delivery is deferred. If the expansion is forced to
20028 fail, the default value for the option (false) is used. Other failures cause
20029 delivery to be deferred.
20030
20031 When this option is set true, routing does not cease if the router accepts the
20032 address. Instead, a copy of the incoming address is passed to the next router,
20033 overriding a false setting of &%more%&. There is little point in setting
20034 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
20035 the value of &%unseen%& contains expansion items (and therefore, presumably, is
20036 sometimes true and sometimes false).
20037
20038 .cindex "copy of message (&%unseen%& option)"
20039 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20040 qualifier in filter files. It can be used to cause copies of messages to be
20041 delivered to some other destination, while also carrying out a normal delivery.
20042 In effect, the current address is made into a &"parent"& that has two children
20043 &-- one that is delivered as specified by this router, and a clone that goes on
20044 to be routed further. For this reason, &%unseen%& may not be combined with the
20045 &%one_time%& option in a &(redirect)& router.
20046
20047 &*Warning*&: Header lines added to the address (or specified for removal) by
20048 this router or by previous routers affect the &"unseen"& copy of the message
20049 only. The clone that continues to be processed by further routers starts with
20050 no added headers and none specified for removal. For a &%redirect%& router, if
20051 a generated address is the same as the incoming address, this can lead to
20052 duplicate addresses with different header modifications. Exim does not do
20053 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20054 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20055 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20056 &%redirect%& router may be of help.
20057
20058 Unlike the handling of header modifications, any data that was set by the
20059 &%address_data%& option in the current or previous routers &'is'& passed on to
20060 subsequent routers.
20061
20062
20063 .option user routers string&!! "see below"
20064 .cindex "uid (user id)" "local delivery"
20065 .cindex "local transports" "uid and gid"
20066 .cindex "transport" "local"
20067 .cindex "router" "user for filter processing"
20068 .cindex "filter" "user for processing"
20069 When a router queues an address for a transport, and the transport does not
20070 specify a user, the user given here is used when running the delivery process.
20071 The user may be specified numerically or by name. If expansion fails, the
20072 error is logged and delivery is deferred.
20073 This user is also used by the &(redirect)& router when running a filter file.
20074 The default is unset, except when &%check_local_user%& is set. In this case,
20075 the default is taken from the password information. If the user is specified as
20076 a name, and &%group%& is not set, the group associated with the user is used.
20077 See also &%initgroups%& and &%group%& and the discussion in chapter
20078 &<<CHAPenvironment>>&.
20079
20080
20081
20082 .option verify routers&!? boolean true
20083 Setting this option has the effect of setting &%verify_sender%& and
20084 &%verify_recipient%& to the same value.
20085
20086
20087 .option verify_only routers&!? boolean false
20088 .cindex "EXPN" "with &%verify_only%&"
20089 .oindex "&%-bv%&"
20090 .cindex "router" "used only when verifying"
20091 If this option is set, the router is used only when verifying an address,
20092 delivering in cutthrough mode or
20093 testing with the &%-bv%& option, not when actually doing a delivery, testing
20094 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20095 restricted to verifying only senders or recipients by means of
20096 &%verify_sender%& and &%verify_recipient%&.
20097
20098 &*Warning*&: When the router is being run to verify addresses for an incoming
20099 SMTP message, Exim is not running as root, but under its own uid. If the router
20100 accesses any files, you need to make sure that they are accessible to the Exim
20101 user or group.
20102
20103
20104 .option verify_recipient routers&!? boolean true
20105 If this option is false, the router is skipped when verifying recipient
20106 addresses,
20107 delivering in cutthrough mode
20108 or testing recipient verification using &%-bv%&.
20109 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20110 are evaluated.
20111 See also the &$verify_mode$& variable.
20112
20113
20114 .option verify_sender routers&!? boolean true
20115 If this option is false, the router is skipped when verifying sender addresses
20116 or testing sender verification using &%-bvs%&.
20117 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20118 are evaluated.
20119 See also the &$verify_mode$& variable.
20120 .ecindex IIDgenoprou1
20121 .ecindex IIDgenoprou2
20122
20123
20124
20125
20126
20127
20128 . ////////////////////////////////////////////////////////////////////////////
20129 . ////////////////////////////////////////////////////////////////////////////
20130
20131 .chapter "The accept router" "CHID4"
20132 .cindex "&(accept)& router"
20133 .cindex "routers" "&(accept)&"
20134 The &(accept)& router has no private options of its own. Unless it is being
20135 used purely for verification (see &%verify_only%&) a transport is required to
20136 be defined by the generic &%transport%& option. If the preconditions that are
20137 specified by generic options are met, the router accepts the address and queues
20138 it for the given transport. The most common use of this router is for setting
20139 up deliveries to local mailboxes. For example:
20140 .code
20141 localusers:
20142   driver = accept
20143   domains = mydomain.example
20144   check_local_user
20145   transport = local_delivery
20146 .endd
20147 The &%domains%& condition in this example checks the domain of the address, and
20148 &%check_local_user%& checks that the local part is the login of a local user.
20149 When both preconditions are met, the &(accept)& router runs, and queues the
20150 address for the &(local_delivery)& transport.
20151
20152
20153
20154
20155
20156
20157 . ////////////////////////////////////////////////////////////////////////////
20158 . ////////////////////////////////////////////////////////////////////////////
20159
20160 .chapter "The dnslookup router" "CHAPdnslookup"
20161 .scindex IIDdnsrou1 "&(dnslookup)& router"
20162 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20163 The &(dnslookup)& router looks up the hosts that handle mail for the
20164 recipient's domain in the DNS. A transport must always be set for this router,
20165 unless &%verify_only%& is set.
20166
20167 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20168 SRV records. If none are found, or if SRV support is not configured,
20169 MX records are looked up. If no MX records exist, address records are sought.
20170 However, &%mx_domains%& can be set to disable the direct use of address
20171 records.
20172
20173 MX records of equal priority are sorted by Exim into a random order. Exim then
20174 looks for address records for the host names obtained from MX or SRV records.
20175 When a host has more than one IP address, they are sorted into a random order,
20176 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20177 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20178 generic option, the router declines.
20179
20180 Unless they have the highest priority (lowest MX value), MX records that point
20181 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20182 are discarded, together with any other MX records of equal or lower priority.
20183
20184 .cindex "MX record" "pointing to local host"
20185 .cindex "local host" "MX pointing to"
20186 .oindex "&%self%&" "in &(dnslookup)& router"
20187 If the host pointed to by the highest priority MX record, or looked up as an
20188 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20189 happens is controlled by the generic &%self%& option.
20190
20191
20192 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20193 There have been problems with DNS servers when SRV records are looked up.
20194 Some misbehaving servers return a DNS error or timeout when a non-existent
20195 SRV record is sought. Similar problems have in the past been reported for
20196 MX records. The global &%dns_again_means_nonexist%& option can help with this
20197 problem, but it is heavy-handed because it is a global option.
20198
20199 For this reason, there are two options, &%srv_fail_domains%& and
20200 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20201 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20202 an attempt to look up an SRV or MX record causes one of these results, and the
20203 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20204 such record"&. In the case of an SRV lookup, this means that the router
20205 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20206 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20207 case routing fails.
20208
20209
20210 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20211 .cindex "&(dnslookup)& router" "declines"
20212 There are a few cases where a &(dnslookup)& router will decline to accept
20213 an address; if such a router is expected to handle "all remaining non-local
20214 domains", then it is important to set &%no_more%&.
20215
20216 The router will defer rather than decline if the domain
20217 is found in the &%fail_defer_domains%& router option.
20218
20219 Reasons for a &(dnslookup)& router to decline currently include:
20220 .ilist
20221 The domain does not exist in DNS
20222 .next
20223 The domain exists but the MX record's host part is just "."; this is a common
20224 convention (borrowed from SRV) used to indicate that there is no such service
20225 for this domain and to not fall back to trying A/AAAA records.
20226 .next
20227 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20228 .next
20229 MX record points to a non-existent host.
20230 .next
20231 MX record points to an IP address and the main section option
20232 &%allow_mx_to_ip%& is not set.
20233 .next
20234 MX records exist and point to valid hosts, but all hosts resolve only to
20235 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20236 .next
20237 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20238 &%dns_check_names_pattern%& for handling one variant of this)
20239 .next
20240 &%check_secondary_mx%& is set on this router but the local host can
20241 not be found in the MX records (see below)
20242 .endlist
20243
20244
20245
20246
20247 .section "Private options for dnslookup" "SECID118"
20248 .cindex "options" "&(dnslookup)& router"
20249 The private options for the &(dnslookup)& router are as follows:
20250
20251 .option check_secondary_mx dnslookup boolean false
20252 .cindex "MX record" "checking for secondary"
20253 If this option is set, the router declines unless the local host is found in
20254 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20255 process domains for which the local host is a secondary mail exchanger
20256 differently to other domains. The way in which Exim decides whether a host is
20257 the local host is described in section &<<SECTreclocipadd>>&.
20258
20259
20260 .option check_srv dnslookup string&!! unset
20261 .cindex "SRV record" "enabling use of"
20262 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20263 addition to MX and address records. The support is disabled by default. To
20264 enable SRV support, set the &%check_srv%& option to the name of the service
20265 required. For example,
20266 .code
20267 check_srv = smtp
20268 .endd
20269 looks for SRV records that refer to the normal smtp service. The option is
20270 expanded, so the service name can vary from message to message or address
20271 to address. This might be helpful if SRV records are being used for a
20272 submission service. If the expansion is forced to fail, the &%check_srv%&
20273 option is ignored, and the router proceeds to look for MX records in the
20274 normal way.
20275
20276 When the expansion succeeds, the router searches first for SRV records for
20277 the given service (it assumes TCP protocol). A single SRV record with a
20278 host name that consists of just a single dot indicates &"no such service for
20279 this domain"&; if this is encountered, the router declines. If other kinds of
20280 SRV record are found, they are used to construct a host list for delivery
20281 according to the rules of RFC 2782. MX records are not sought in this case.
20282
20283 When no SRV records are found, MX records (and address records) are sought in
20284 the traditional way. In other words, SRV records take precedence over MX
20285 records, just as MX records take precedence over address records. Note that
20286 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20287 defined it. It is apparently believed that MX records are sufficient for email
20288 and that SRV records should not be used for this purpose. However, SRV records
20289 have an additional &"weight"& feature which some people might find useful when
20290 trying to split an SMTP load between hosts of different power.
20291
20292 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20293 when there is a DNS lookup error.
20294
20295
20296
20297
20298 .option fail_defer_domains dnslookup "domain list&!!" unset
20299 .cindex "MX record" "not found"
20300 DNS lookups for domains matching &%fail_defer_domains%&
20301 which find no matching record will cause the router to defer
20302 rather than the default behaviour of decline.
20303 This maybe be useful for queueing messages for a newly created
20304 domain while the DNS configuration is not ready.
20305 However, it will result in any message with mistyped domains
20306 also being queued.
20307
20308
20309 .option ipv4_only "string&!!" unset
20310 .cindex IPv6 disabling
20311 .cindex DNS "IPv6 disabling"
20312 The string is expanded, and if the result is anything but a forced failure,
20313 or an empty string, or one of the strings “0” or “no” or “false”
20314 (checked without regard to the case of the letters),
20315 only A records are used.
20316
20317 .option ipv4_prefer "string&!!" unset
20318 .cindex IPv4 preference
20319 .cindex DNS "IPv4 preference"
20320 The string is expanded, and if the result is anything but a forced failure,
20321 or an empty string, or one of the strings “0” or “no” or “false”
20322 (checked without regard to the case of the letters),
20323 A records are sorted before AAAA records (inverting the default).
20324
20325 .option mx_domains dnslookup "domain list&!!" unset
20326 .cindex "MX record" "required to exist"
20327 .cindex "SRV record" "required to exist"
20328 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20329 record in order to be recognized. (The name of this option could be improved.)
20330 For example, if all the mail hosts in &'fict.example'& are known to have MX
20331 records, except for those in &'discworld.fict.example'&, you could use this
20332 setting:
20333 .code
20334 mx_domains = ! *.discworld.fict.example : *.fict.example
20335 .endd
20336 This specifies that messages addressed to a domain that matches the list but
20337 has no MX record should be bounced immediately instead of being routed using
20338 the address record.
20339
20340
20341 .option mx_fail_domains dnslookup "domain list&!!" unset
20342 If the DNS lookup for MX records for one of the domains in this list causes a
20343 DNS lookup error, Exim behaves as if no MX records were found. See section
20344 &<<SECTprowitdnsloo>>& for more discussion.
20345
20346
20347
20348
20349 .option qualify_single dnslookup boolean true
20350 .cindex "DNS" "resolver options"
20351 .cindex "DNS" "qualifying single-component names"
20352 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20353 lookups. Typically, but not standardly, this causes the resolver to qualify
20354 single-component names with the default domain. For example, on a machine
20355 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20356 &'thesaurus.ref.example'& inside the resolver. For details of what your
20357 resolver actually does, consult your man pages for &'resolver'& and
20358 &'resolv.conf'&.
20359
20360
20361
20362 .option rewrite_headers dnslookup boolean true
20363 .cindex "rewriting" "header lines"
20364 .cindex "header lines" "rewriting"
20365 If the domain name in the address that is being processed is not fully
20366 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20367 an address is specified as &'dormouse@teaparty'&, the domain might be
20368 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20369 occur as a result of setting the &%widen_domains%& option. If
20370 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20371 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20372 header lines of the message are rewritten with the full domain name.
20373
20374 This option should be turned off only when it is known that no message is
20375 ever going to be sent outside an environment where the abbreviation makes
20376 sense.
20377
20378 When an MX record is looked up in the DNS and matches a wildcard record, name
20379 servers normally return a record containing the name that has been looked up,
20380 making it impossible to detect whether a wildcard was present or not. However,
20381 some name servers have recently been seen to return the wildcard entry. If the
20382 name returned by a DNS lookup begins with an asterisk, it is not used for
20383 header rewriting.
20384
20385
20386 .option same_domain_copy_routing dnslookup boolean false
20387 .cindex "address" "copying routing"
20388 Addresses with the same domain are normally routed by the &(dnslookup)& router
20389 to the same list of hosts. However, this cannot be presumed, because the router
20390 options and preconditions may refer to the local part of the address. By
20391 default, therefore, Exim routes each address in a message independently. DNS
20392 servers run caches, so repeated DNS lookups are not normally expensive, and in
20393 any case, personal messages rarely have more than a few recipients.
20394
20395 If you are running mailing lists with large numbers of subscribers at the same
20396 domain, and you are using a &(dnslookup)& router which is independent of the
20397 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20398 lookups for identical domains in one message. In this case, when &(dnslookup)&
20399 routes an address to a remote transport, any other unrouted addresses in the
20400 message that have the same domain are automatically given the same routing
20401 without processing them independently,
20402 provided the following conditions are met:
20403
20404 .ilist
20405 No router that processed the address specified &%headers_add%& or
20406 &%headers_remove%&.
20407 .next
20408 The router did not change the address in any way, for example, by &"widening"&
20409 the domain.
20410 .endlist
20411
20412
20413
20414
20415 .option search_parents dnslookup boolean false
20416 .cindex "DNS" "resolver options"
20417 When this option is true, the resolver option RES_DNSRCH is set for DNS
20418 lookups. This is different from the &%qualify_single%& option in that it
20419 applies to domains containing dots. Typically, but not standardly, it causes
20420 the resolver to search for the name in the current domain and in parent
20421 domains. For example, on a machine in the &'fict.example'& domain, if looking
20422 up &'teaparty.wonderland'& failed, the resolver would try
20423 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20424 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20425
20426 Setting this option true can cause problems in domains that have a wildcard MX
20427 record, because any domain that does not have its own MX record matches the
20428 local wildcard.
20429
20430
20431
20432 .option srv_fail_domains dnslookup "domain list&!!" unset
20433 If the DNS lookup for SRV records for one of the domains in this list causes a
20434 DNS lookup error, Exim behaves as if no SRV records were found. See section
20435 &<<SECTprowitdnsloo>>& for more discussion.
20436
20437
20438
20439
20440 .option widen_domains dnslookup "string list" unset
20441 .cindex "domain" "partial; widening"
20442 If a DNS lookup fails and this option is set, each of its strings in turn is
20443 added onto the end of the domain, and the lookup is tried again. For example,
20444 if
20445 .code
20446 widen_domains = fict.example:ref.example
20447 .endd
20448 is set and a lookup of &'klingon.dictionary'& fails,
20449 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20450 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20451 and &%search_parents%& options can cause some widening to be undertaken inside
20452 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20453 when verifying, unless &%rewrite_headers%& is false (not the default).
20454
20455
20456 .section "Effect of qualify_single and search_parents" "SECID119"
20457 When a domain from an envelope recipient is changed by the resolver as a result
20458 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20459 corresponding address in the message's header lines unless &%rewrite_headers%&
20460 is set false. Exim then re-routes the address, using the full domain.
20461
20462 These two options affect only the DNS lookup that takes place inside the router
20463 for the domain of the address that is being routed. They do not affect lookups
20464 such as that implied by
20465 .code
20466 domains = @mx_any
20467 .endd
20468 that may happen while processing a router precondition before the router is
20469 entered. No widening ever takes place for these lookups.
20470 .ecindex IIDdnsrou1
20471 .ecindex IIDdnsrou2
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481 . ////////////////////////////////////////////////////////////////////////////
20482 . ////////////////////////////////////////////////////////////////////////////
20483
20484 .chapter "The ipliteral router" "CHID5"
20485 .cindex "&(ipliteral)& router"
20486 .cindex "domain literal" "routing"
20487 .cindex "routers" "&(ipliteral)&"
20488 This router has no private options. Unless it is being used purely for
20489 verification (see &%verify_only%&) a transport is required to be defined by the
20490 generic &%transport%& option. The router accepts the address if its domain part
20491 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20492 router handles the address
20493 .code
20494 root@[192.168.1.1]
20495 .endd
20496 by setting up delivery to the host with that IP address. IPv4 domain literals
20497 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20498 are similar, but the address is preceded by &`ipv6:`&. For example:
20499 .code
20500 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20501 .endd
20502 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20503 grounds that sooner or later somebody will try it.
20504
20505 .oindex "&%self%&" "in &(ipliteral)& router"
20506 If the IP address matches something in &%ignore_target_hosts%&, the router
20507 declines. If an IP literal turns out to refer to the local host, the generic
20508 &%self%& option determines what happens.
20509
20510 The RFCs require support for domain literals; however, their use is
20511 controversial in today's Internet. If you want to use this router, you must
20512 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20513 Exim will not recognize the domain literal syntax in addresses.
20514
20515
20516
20517 . ////////////////////////////////////////////////////////////////////////////
20518 . ////////////////////////////////////////////////////////////////////////////
20519
20520 .chapter "The iplookup router" "CHID6"
20521 .cindex "&(iplookup)& router"
20522 .cindex "routers" "&(iplookup)&"
20523 The &(iplookup)& router was written to fulfil a specific requirement in
20524 Cambridge University (which in fact no longer exists). For this reason, it is
20525 not included in the binary of Exim by default. If you want to include it, you
20526 must set
20527 .code
20528 ROUTER_IPLOOKUP=yes
20529 .endd
20530 in your &_Local/Makefile_& configuration file.
20531
20532 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20533 connection to one or more specific hosts. The host can then return the same or
20534 a different address &-- in effect rewriting the recipient address in the
20535 message's envelope. The new address is then passed on to subsequent routers. If
20536 this process fails, the address can be passed on to other routers, or delivery
20537 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20538 must not be specified for it.
20539
20540 .cindex "options" "&(iplookup)& router"
20541 .option hosts iplookup string unset
20542 This option must be supplied. Its value is a colon-separated list of host
20543 names. The hosts are looked up using &[gethostbyname()]&
20544 (or &[getipnodebyname()]& when available)
20545 and are tried in order until one responds to the query. If none respond, what
20546 happens is controlled by &%optional%&.
20547
20548
20549 .option optional iplookup boolean false
20550 If &%optional%& is true, if no response is obtained from any host, the address
20551 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20552 delivery to the address is deferred.
20553
20554
20555 .option port iplookup integer 0
20556 .cindex "port" "&(iplookup)& router"
20557 This option must be supplied. It specifies the port number for the TCP or UDP
20558 call.
20559
20560
20561 .option protocol iplookup string udp
20562 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20563 protocols is to be used.
20564
20565
20566 .option query iplookup string&!! "see below"
20567 This defines the content of the query that is sent to the remote hosts. The
20568 default value is:
20569 .code
20570 $local_part@$domain $local_part@$domain
20571 .endd
20572 The repetition serves as a way of checking that a response is to the correct
20573 query in the default case (see &%response_pattern%& below).
20574
20575
20576 .option reroute iplookup string&!! unset
20577 If this option is not set, the rerouted address is precisely the byte string
20578 returned by the remote host, up to the first white space, if any. If set, the
20579 string is expanded to form the rerouted address. It can include parts matched
20580 in the response by &%response_pattern%& by means of numeric variables such as
20581 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20582 whether or not a pattern is in use. In all cases, the rerouted address must end
20583 up in the form &'local_part@domain'&.
20584
20585
20586 .option response_pattern iplookup string unset
20587 This option can be set to a regular expression that is applied to the string
20588 returned from the remote host. If the pattern does not match the response, the
20589 router declines. If &%response_pattern%& is not set, no checking of the
20590 response is done, unless the query was defaulted, in which case there is a
20591 check that the text returned after the first white space is the original
20592 address. This checks that the answer that has been received is in response to
20593 the correct question. For example, if the response is just a new domain, the
20594 following could be used:
20595 .code
20596 response_pattern = ^([^@]+)$
20597 reroute = $local_part@$1
20598 .endd
20599
20600 .option timeout iplookup time 5s
20601 This specifies the amount of time to wait for a response from the remote
20602 machine. The same timeout is used for the &[connect()]& function for a TCP
20603 call. It does not apply to UDP.
20604
20605
20606
20607
20608 . ////////////////////////////////////////////////////////////////////////////
20609 . ////////////////////////////////////////////////////////////////////////////
20610
20611 .chapter "The manualroute router" "CHID7"
20612 .scindex IIDmanrou1 "&(manualroute)& router"
20613 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20614 .cindex "domain" "manually routing"
20615 The &(manualroute)& router is so-called because it provides a way of manually
20616 routing an address according to its domain. It is mainly used when you want to
20617 route addresses to remote hosts according to your own rules, bypassing the
20618 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20619 route to local transports, a facility that may be useful if you want to save
20620 messages for dial-in hosts in local files.
20621
20622 The &(manualroute)& router compares a list of domain patterns with the domain
20623 it is trying to route. If there is no match, the router declines. Each pattern
20624 has associated with it a list of hosts and some other optional data, which may
20625 include a transport. The combination of a pattern and its data is called a
20626 &"routing rule"&. For patterns that do not have an associated transport, the
20627 generic &%transport%& option must specify a transport, unless the router is
20628 being used purely for verification (see &%verify_only%&).
20629
20630 .vindex "&$host$&"
20631 In the case of verification, matching the domain pattern is sufficient for the
20632 router to accept the address. When actually routing an address for delivery,
20633 an address that matches a domain pattern is queued for the associated
20634 transport. If the transport is not a local one, a host list must be associated
20635 with the pattern; IP addresses are looked up for the hosts, and these are
20636 passed to the transport along with the mail address. For local transports, a
20637 host list is optional. If it is present, it is passed in &$host$& as a single
20638 text string.
20639
20640 The list of routing rules can be provided as an inline string in
20641 &%route_list%&, or the data can be obtained by looking up the domain in a file
20642 or database by setting &%route_data%&. Only one of these settings may appear in
20643 any one instance of &(manualroute)&. The format of routing rules is described
20644 below, following the list of private options.
20645
20646
20647 .section "Private options for manualroute" "SECTprioptman"
20648
20649 .cindex "options" "&(manualroute)& router"
20650 The private options for the &(manualroute)& router are as follows:
20651
20652 .option host_all_ignored manualroute string defer
20653 See &%host_find_failed%&.
20654
20655 .option host_find_failed manualroute string freeze
20656 This option controls what happens when &(manualroute)& tries to find an IP
20657 address for a host, and the host does not exist. The option can be set to one
20658 of the following values:
20659 .code
20660 decline
20661 defer
20662 fail
20663 freeze
20664 ignore
20665 pass
20666 .endd
20667 The default (&"freeze"&) assumes that this state is a serious configuration
20668 error. The difference between &"pass"& and &"decline"& is that the former
20669 forces the address to be passed to the next router (or the router defined by
20670 &%pass_router%&),
20671 .oindex "&%more%&"
20672 overriding &%no_more%&, whereas the latter passes the address to the next
20673 router only if &%more%& is true.
20674
20675 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20676 cannot be found. If all the hosts in the list are ignored, the behaviour is
20677 controlled by the &%host_all_ignored%& option. This takes the same values
20678 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20679
20680 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20681 state; if a host lookup gets a temporary error, delivery is deferred unless the
20682 generic &%pass_on_timeout%& option is set.
20683
20684
20685 .option hosts_randomize manualroute boolean false
20686 .cindex "randomized host list"
20687 .cindex "host" "list of; randomized"
20688 If this option is set, the order of the items in a host list in a routing rule
20689 is randomized each time the list is used, unless an option in the routing rule
20690 overrides (see below). Randomizing the order of a host list can be used to do
20691 crude load sharing. However, if more than one mail address is routed by the
20692 same router to the same host list, the host lists are considered to be the same
20693 (even though they may be randomized into different orders) for the purpose of
20694 deciding whether to batch the deliveries into a single SMTP transaction.
20695
20696 When &%hosts_randomize%& is true, a host list may be split
20697 into groups whose order is separately randomized. This makes it possible to
20698 set up MX-like behaviour. The boundaries between groups are indicated by an
20699 item that is just &`+`& in the host list. For example:
20700 .code
20701 route_list = * host1:host2:host3:+:host4:host5
20702 .endd
20703 The order of the first three hosts and the order of the last two hosts is
20704 randomized for each use, but the first three always end up before the last two.
20705 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20706 randomized host list is passed to an &(smtp)& transport that also has
20707 &%hosts_randomize set%&, the list is not re-randomized.
20708
20709
20710 .option route_data manualroute string&!! unset
20711 If this option is set, it must expand to yield the data part of a routing rule.
20712 Typically, the expansion string includes a lookup based on the domain. For
20713 example:
20714 .code
20715 route_data = ${lookup{$domain}dbm{/etc/routes}}
20716 .endd
20717 If the expansion is forced to fail, or the result is an empty string, the
20718 router declines. Other kinds of expansion failure cause delivery to be
20719 deferred.
20720
20721
20722 .option route_list manualroute "string list" unset
20723 This string is a list of routing rules, in the form defined below. Note that,
20724 unlike most string lists, the items are separated by semicolons. This is so
20725 that they may contain colon-separated host lists.
20726
20727
20728 .option same_domain_copy_routing manualroute boolean false
20729 .cindex "address" "copying routing"
20730 Addresses with the same domain are normally routed by the &(manualroute)&
20731 router to the same list of hosts. However, this cannot be presumed, because the
20732 router options and preconditions may refer to the local part of the address. By
20733 default, therefore, Exim routes each address in a message independently. DNS
20734 servers run caches, so repeated DNS lookups are not normally expensive, and in
20735 any case, personal messages rarely have more than a few recipients.
20736
20737 If you are running mailing lists with large numbers of subscribers at the same
20738 domain, and you are using a &(manualroute)& router which is independent of the
20739 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20740 lookups for identical domains in one message. In this case, when
20741 &(manualroute)& routes an address to a remote transport, any other unrouted
20742 addresses in the message that have the same domain are automatically given the
20743 same routing without processing them independently. However, this is only done
20744 if &%headers_add%& and &%headers_remove%& are unset.
20745
20746
20747
20748
20749 .section "Routing rules in route_list" "SECID120"
20750 The value of &%route_list%& is a string consisting of a sequence of routing
20751 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20752 entered as two semicolons. Alternatively, the list separator can be changed as
20753 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20754 Empty rules are ignored. The format of each rule is
20755 .display
20756 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20757 .endd
20758 The following example contains two rules, each with a simple domain pattern and
20759 no options:
20760 .code
20761 route_list = \
20762   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20763   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20764 .endd
20765 The three parts of a rule are separated by white space. The pattern and the
20766 list of hosts can be enclosed in quotes if necessary, and if they are, the
20767 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20768 single domain pattern, which is the only mandatory item in the rule. The
20769 pattern is in the same format as one item in a domain list (see section
20770 &<<SECTdomainlist>>&),
20771 except that it may not be the name of an interpolated file.
20772 That is, it may be wildcarded, or a regular expression, or a file or database
20773 lookup (with semicolons doubled, because of the use of semicolon as a separator
20774 in a &%route_list%&).
20775
20776 The rules in &%route_list%& are searched in order until one of the patterns
20777 matches the domain that is being routed. The list of hosts and then options are
20778 then used as described below. If there is no match, the router declines. When
20779 &%route_list%& is set, &%route_data%& must not be set.
20780
20781
20782
20783 .section "Routing rules in route_data" "SECID121"
20784 The use of &%route_list%& is convenient when there are only a small number of
20785 routing rules. For larger numbers, it is easier to use a file or database to
20786 hold the routing information, and use the &%route_data%& option instead.
20787 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20788 Most commonly, &%route_data%& is set as a string that contains an
20789 expansion lookup. For example, suppose we place two routing rules in a file
20790 like this:
20791 .code
20792 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20793 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20794 .endd
20795 This data can be accessed by setting
20796 .code
20797 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20798 .endd
20799 Failure of the lookup results in an empty string, causing the router to
20800 decline. However, you do not have to use a lookup in &%route_data%&. The only
20801 requirement is that the result of expanding the string is a list of hosts,
20802 possibly followed by options, separated by white space. The list of hosts must
20803 be enclosed in quotes if it contains white space.
20804
20805
20806
20807
20808 .section "Format of the list of hosts" "SECID122"
20809 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20810 always separately expanded before use. If the expansion fails, the router
20811 declines. The result of the expansion must be a colon-separated list of names
20812 and/or IP addresses, optionally also including ports.
20813 If the list is written with spaces, it must be protected with quotes.
20814 The format of each item
20815 in the list is described in the next section. The list separator can be changed
20816 as described in section &<<SECTlistsepchange>>&.
20817
20818 If the list of hosts was obtained from a &%route_list%& item, the following
20819 variables are set during its expansion:
20820
20821 .ilist
20822 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20823 If the domain was matched against a regular expression, the numeric variables
20824 &$1$&, &$2$&, etc. may be set. For example:
20825 .code
20826 route_list = ^domain(\d+)   host-$1.text.example
20827 .endd
20828 .next
20829 &$0$& is always set to the entire domain.
20830 .next
20831 &$1$& is also set when partial matching is done in a file lookup.
20832
20833 .next
20834 .vindex "&$value$&"
20835 If the pattern that matched the domain was a lookup item, the data that was
20836 looked up is available in the expansion variable &$value$&. For example:
20837 .code
20838 route_list = lsearch;;/some/file.routes  $value
20839 .endd
20840 .endlist
20841
20842 Note the doubling of the semicolon in the pattern that is necessary because
20843 semicolon is the default route list separator.
20844
20845
20846
20847 .section "Format of one host item" "SECTformatonehostitem"
20848 Each item in the list of hosts can be either a host name or an IP address,
20849 optionally with an attached port number, or it can be a single "+"
20850 (see &%hosts_randomize%&).
20851 When no port is given, an IP address
20852 is not enclosed in brackets. When a port is specified, it overrides the port
20853 specification on the transport. The port is separated from the name or address
20854 by a colon. This leads to some complications:
20855
20856 .ilist
20857 Because colon is the default separator for the list of hosts, either
20858 the colon that specifies a port must be doubled, or the list separator must
20859 be changed. The following two examples have the same effect:
20860 .code
20861 route_list = * "host1.tld::1225 : host2.tld::1226"
20862 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20863 .endd
20864 .next
20865 When IPv6 addresses are involved, it gets worse, because they contain
20866 colons of their own. To make this case easier, it is permitted to
20867 enclose an IP address (either v4 or v6) in square brackets if a port
20868 number follows. For example:
20869 .code
20870 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20871 .endd
20872 .endlist
20873
20874 .section "How the list of hosts is used" "SECThostshowused"
20875 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20876 the hosts is tried, in the order specified, when carrying out the SMTP
20877 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20878 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20879 transport.
20880
20881 Hosts may be listed by name or by IP address. An unadorned name in the list of
20882 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20883 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20884 records in the DNS. For example:
20885 .code
20886 route_list = *  x.y.z:p.q.r/MX:e.f.g
20887 .endd
20888 If this feature is used with a port specifier, the port must come last. For
20889 example:
20890 .code
20891 route_list = *  dom1.tld/mx::1225
20892 .endd
20893 If the &%hosts_randomize%& option is set, the order of the items in the list is
20894 randomized before any lookups are done. Exim then scans the list; for any name
20895 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20896 be an interface on the local host and the item is not the first in the list,
20897 Exim discards it and any subsequent items. If it is the first item, what
20898 happens is controlled by the
20899 .oindex "&%self%&" "in &(manualroute)& router"
20900 &%self%& option of the router.
20901
20902 A name on the list that is followed by &`/MX`& is replaced with the list of
20903 hosts obtained by looking up MX records for the name. This is always a DNS
20904 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20905 below) are not relevant here. The order of these hosts is determined by the
20906 preference values in the MX records, according to the usual rules. Because
20907 randomizing happens before the MX lookup, it does not affect the order that is
20908 defined by MX preferences.
20909
20910 If the local host is present in the sublist obtained from MX records, but is
20911 not the most preferred host in that list, it and any equally or less
20912 preferred hosts are removed before the sublist is inserted into the main list.
20913
20914 If the local host is the most preferred host in the MX list, what happens
20915 depends on where in the original list of hosts the &`/MX`& item appears. If it
20916 is not the first item (that is, there are previous hosts in the main list),
20917 Exim discards this name and any subsequent items in the main list.
20918
20919 If the MX item is first in the list of hosts, and the local host is the
20920 most preferred host, what happens is controlled by the &%self%& option of the
20921 router.
20922
20923 DNS failures when lookup up the MX records are treated in the same way as DNS
20924 failures when looking up IP addresses: &%pass_on_timeout%& and
20925 &%host_find_failed%& are used when relevant.
20926
20927 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20928 whether obtained from an MX lookup or not.
20929
20930
20931
20932 .section "How the options are used" "SECThowoptused"
20933 The options are a sequence of words, space-separated.
20934 One of the words can be the name of a transport; this overrides the
20935 &%transport%& option on the router for this particular routing rule only. The
20936 other words (if present) control randomization of the list of hosts on a
20937 per-rule basis, and how the IP addresses of the hosts are to be found when
20938 routing to a remote transport. These options are as follows:
20939
20940 .ilist
20941 &%randomize%&: randomize the order of the hosts in this list, overriding the
20942 setting of &%hosts_randomize%& for this routing rule only.
20943 .next
20944 &%no_randomize%&: do not randomize the order of the hosts in this list,
20945 overriding the setting of &%hosts_randomize%& for this routing rule only.
20946 .next
20947 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20948 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20949 also look in &_/etc/hosts_& or other sources of information.
20950 .next
20951 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20952 no address records are found. If there is a temporary DNS error (such as a
20953 timeout), delivery is deferred.
20954 .next
20955 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20956 .next
20957 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20958 .endlist
20959
20960 For example:
20961 .code
20962 route_list = domain1  host1:host2:host3  randomize bydns;\
20963              domain2  host4:host5
20964 .endd
20965 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20966 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20967 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20968 or &[gethostbyname()]&, and the result of the lookup is the result of that
20969 call.
20970
20971 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20972 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20973 instead of TRY_AGAIN. That is why the default action is to try a DNS
20974 lookup first. Only if that gives a definite &"no such host"& is the local
20975 function called.
20976
20977 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20978 inadvertent constraint that a transport name as an option had to be the last
20979 option specified.
20980
20981
20982
20983 If no IP address for a host can be found, what happens is controlled by the
20984 &%host_find_failed%& option.
20985
20986 .vindex "&$host$&"
20987 When an address is routed to a local transport, IP addresses are not looked up.
20988 The host list is passed to the transport in the &$host$& variable.
20989
20990
20991
20992 .section "Manualroute examples" "SECID123"
20993 In some of the examples that follow, the presence of the &%remote_smtp%&
20994 transport, as defined in the default configuration file, is assumed:
20995
20996 .ilist
20997 .cindex "smart host" "example router"
20998 The &(manualroute)& router can be used to forward all external mail to a
20999 &'smart host'&. If you have set up, in the main part of the configuration, a
21000 named domain list that contains your local domains, for example:
21001 .code
21002 domainlist local_domains = my.domain.example
21003 .endd
21004 You can arrange for all other domains to be routed to a smart host by making
21005 your first router something like this:
21006 .code
21007 smart_route:
21008   driver = manualroute
21009   domains = !+local_domains
21010   transport = remote_smtp
21011   route_list = * smarthost.ref.example
21012 .endd
21013 This causes all non-local addresses to be sent to the single host
21014 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
21015 they are tried in order
21016 (but you can use &%hosts_randomize%& to vary the order each time).
21017 Another way of configuring the same thing is this:
21018 .code
21019 smart_route:
21020   driver = manualroute
21021   transport = remote_smtp
21022   route_list = !+local_domains  smarthost.ref.example
21023 .endd
21024 There is no difference in behaviour between these two routers as they stand.
21025 However, they behave differently if &%no_more%& is added to them. In the first
21026 example, the router is skipped if the domain does not match the &%domains%&
21027 precondition; the following router is always tried. If the router runs, it
21028 always matches the domain and so can never decline. Therefore, &%no_more%&
21029 would have no effect. In the second case, the router is never skipped; it
21030 always runs. However, if it doesn't match the domain, it declines. In this case
21031 &%no_more%& would prevent subsequent routers from running.
21032
21033 .next
21034 .cindex "mail hub example"
21035 A &'mail hub'& is a host which receives mail for a number of domains via MX
21036 records in the DNS and delivers it via its own private routing mechanism. Often
21037 the final destinations are behind a firewall, with the mail hub being the one
21038 machine that can connect to machines both inside and outside the firewall. The
21039 &(manualroute)& router is usually used on a mail hub to route incoming messages
21040 to the correct hosts. For a small number of domains, the routing can be inline,
21041 using the &%route_list%& option, but for a larger number a file or database
21042 lookup is easier to manage.
21043
21044 If the domain names are in fact the names of the machines to which the mail is
21045 to be sent by the mail hub, the configuration can be quite simple. For
21046 example:
21047 .code
21048 hub_route:
21049   driver = manualroute
21050   transport = remote_smtp
21051   route_list = *.rhodes.tvs.example  $domain
21052 .endd
21053 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21054 whose names are the same as the mail domains. A similar approach can be taken
21055 if the host name can be obtained from the domain name by a string manipulation
21056 that the expansion facilities can handle. Otherwise, a lookup based on the
21057 domain can be used to find the host:
21058 .code
21059 through_firewall:
21060   driver = manualroute
21061   transport = remote_smtp
21062   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21063 .endd
21064 The result of the lookup must be the name or IP address of the host (or
21065 hosts) to which the address is to be routed. If the lookup fails, the route
21066 data is empty, causing the router to decline. The address then passes to the
21067 next router.
21068
21069 .next
21070 .cindex "batched SMTP output example"
21071 .cindex "SMTP" "batched outgoing; example"
21072 You can use &(manualroute)& to deliver messages to pipes or files in batched
21073 SMTP format for onward transportation by some other means. This is one way of
21074 storing mail for a dial-up host when it is not connected. The route list entry
21075 can be as simple as a single domain name in a configuration like this:
21076 .code
21077 save_in_file:
21078   driver = manualroute
21079   transport = batchsmtp_appendfile
21080   route_list = saved.domain.example
21081 .endd
21082 though often a pattern is used to pick up more than one domain. If there are
21083 several domains or groups of domains with different transport requirements,
21084 different transports can be listed in the routing information:
21085 .code
21086 save_in_file:
21087   driver = manualroute
21088   route_list = \
21089     *.saved.domain1.example  $domain  batch_appendfile; \
21090     *.saved.domain2.example  \
21091       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21092       batch_pipe
21093 .endd
21094 .vindex "&$domain$&"
21095 .vindex "&$host$&"
21096 The first of these just passes the domain in the &$host$& variable, which
21097 doesn't achieve much (since it is also in &$domain$&), but the second does a
21098 file lookup to find a value to pass, causing the router to decline to handle
21099 the address if the lookup fails.
21100
21101 .next
21102 .cindex "UUCP" "example of router for"
21103 Routing mail directly to UUCP software is a specific case of the use of
21104 &(manualroute)& in a gateway to another mail environment. This is an example of
21105 one way it can be done:
21106 .code
21107 # Transport
21108 uucp:
21109   driver = pipe
21110   user = nobody
21111   command = /usr/local/bin/uux -r - \
21112     ${substr_-5:$host}!rmail ${local_part}
21113   return_fail_output = true
21114
21115 # Router
21116 uucphost:
21117   transport = uucp
21118   driver = manualroute
21119   route_data = \
21120     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21121 .endd
21122 The file &_/usr/local/exim/uucphosts_& contains entries like
21123 .code
21124 darksite.ethereal.example:           darksite.UUCP
21125 .endd
21126 It can be set up more simply without adding and removing &".UUCP"& but this way
21127 makes clear the distinction between the domain name
21128 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21129 .endlist
21130 .ecindex IIDmanrou1
21131 .ecindex IIDmanrou2
21132
21133
21134
21135
21136
21137
21138
21139
21140 . ////////////////////////////////////////////////////////////////////////////
21141 . ////////////////////////////////////////////////////////////////////////////
21142
21143 .chapter "The queryprogram router" "CHAPdriverlast"
21144 .scindex IIDquerou1 "&(queryprogram)& router"
21145 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21146 .cindex "routing" "by external program"
21147 The &(queryprogram)& router routes an address by running an external command
21148 and acting on its output. This is an expensive way to route, and is intended
21149 mainly for use in lightly-loaded systems, or for performing experiments.
21150 However, if it is possible to use the precondition options (&%domains%&,
21151 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21152 be used in special cases, even on a busy host. There are the following private
21153 options:
21154 .cindex "options" "&(queryprogram)& router"
21155
21156 .option command queryprogram string&!! unset
21157 This option must be set. It specifies the command that is to be run. The
21158 command is split up into a command name and arguments, and then each is
21159 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21160 &<<CHAPpipetransport>>&).
21161
21162
21163 .option command_group queryprogram string unset
21164 .cindex "gid (group id)" "in &(queryprogram)& router"
21165 This option specifies a gid to be set when running the command while routing an
21166 address for deliver. It must be set if &%command_user%& specifies a numerical
21167 uid. If it begins with a digit, it is interpreted as the numerical value of the
21168 gid. Otherwise it is looked up using &[getgrnam()]&.
21169
21170
21171 .option command_user queryprogram string unset
21172 .cindex "uid (user id)" "for &(queryprogram)&"
21173 This option must be set. It specifies the uid which is set when running the
21174 command while routing an address for delivery. If the value begins with a digit,
21175 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21176 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21177 not set, a value for the gid also.
21178
21179 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21180 root, which it does during a normal delivery in a conventional configuration.
21181 However, when an address is being verified during message reception, Exim is
21182 usually running as the Exim user, not as root. If the &(queryprogram)& router
21183 is called from a non-root process, Exim cannot change uid or gid before running
21184 the command. In this circumstance the command runs under the current uid and
21185 gid.
21186
21187
21188 .option current_directory queryprogram string /
21189 This option specifies an absolute path which is made the current directory
21190 before running the command.
21191
21192
21193 .option timeout queryprogram time 1h
21194 If the command does not complete within the timeout period, its process group
21195 is killed and the message is frozen. A value of zero time specifies no
21196 timeout.
21197
21198
21199 The standard output of the command is connected to a pipe, which is read when
21200 the command terminates. It should consist of a single line of output,
21201 containing up to five fields, separated by white space. The maximum length of
21202 the line is 1023 characters. Longer lines are silently truncated. The first
21203 field is one of the following words (case-insensitive):
21204
21205 .ilist
21206 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21207 below).
21208 .next
21209 &'Decline'&: the router declines; pass the address to the next router, unless
21210 &%no_more%& is set.
21211 .next
21212 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21213 subsequent text on the line is an error message. If the router is run as part
21214 of address verification during an incoming SMTP message, the message is
21215 included in the SMTP response.
21216 .next
21217 &'Defer'&: routing could not be completed at this time; try again later. Any
21218 subsequent text on the line is an error message which is logged. It is not
21219 included in any SMTP response.
21220 .next
21221 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21222 .next
21223 &'Pass'&: pass the address to the next router (or the router specified by
21224 &%pass_router%&), overriding &%no_more%&.
21225 .next
21226 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21227 new addresses, which are routed independently, starting with the first router,
21228 or the router specified by &%redirect_router%&, if set.
21229 .endlist
21230
21231 When the first word is &'accept'&, the remainder of the line consists of a
21232 number of keyed data values, as follows (split into two lines here, to fit on
21233 the page):
21234 .code
21235 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21236 LOOKUP=byname|bydns DATA=<text>
21237 .endd
21238 The data items can be given in any order, and all are optional. If no transport
21239 is included, the transport specified by the generic &%transport%& option is
21240 used. The list of hosts and the lookup type are needed only if the transport is
21241 an &(smtp)& transport that does not itself supply a list of hosts.
21242
21243 The format of the list of hosts is the same as for the &(manualroute)& router.
21244 As well as host names and IP addresses with optional port numbers, as described
21245 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21246 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21247 (see section &<<SECThostshowused>>&).
21248
21249 If the lookup type is not specified, Exim behaves as follows when trying to
21250 find an IP address for each host: First, a DNS lookup is done. If this yields
21251 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21252 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21253 result of the lookup is the result of that call.
21254
21255 .vindex "&$address_data$&"
21256 If the DATA field is set, its value is placed in the &$address_data$&
21257 variable. For example, this return line
21258 .code
21259 accept hosts=x1.y.example:x2.y.example data="rule1"
21260 .endd
21261 routes the address to the default transport, passing a list of two hosts. When
21262 the transport runs, the string &"rule1"& is in &$address_data$&.
21263 .ecindex IIDquerou1
21264 .ecindex IIDquerou2
21265
21266
21267
21268
21269 . ////////////////////////////////////////////////////////////////////////////
21270 . ////////////////////////////////////////////////////////////////////////////
21271
21272 .chapter "The redirect router" "CHAPredirect"
21273 .scindex IIDredrou1 "&(redirect)& router"
21274 .scindex IIDredrou2 "routers" "&(redirect)&"
21275 .cindex "alias file" "in a &(redirect)& router"
21276 .cindex "address redirection" "&(redirect)& router"
21277 The &(redirect)& router handles several kinds of address redirection. Its most
21278 common uses are for resolving local part aliases from a central alias file
21279 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21280 files, but it has many other potential uses. The incoming address can be
21281 redirected in several different ways:
21282
21283 .ilist
21284 It can be replaced by one or more new addresses which are themselves routed
21285 independently.
21286 .next
21287 It can be routed to be delivered to a given file or directory.
21288 .next
21289 It can be routed to be delivered to a specified pipe command.
21290 .next
21291 It can cause an automatic reply to be generated.
21292 .next
21293 It can be forced to fail, optionally with a custom error message.
21294 .next
21295 It can be temporarily deferred, optionally with a custom message.
21296 .next
21297 It can be discarded.
21298 .endlist
21299
21300 The generic &%transport%& option must not be set for &(redirect)& routers.
21301 However, there are some private options which define transports for delivery to
21302 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21303 &%pipe_transport%& and &%reply_transport%& descriptions below.
21304
21305 If success DSNs have been requested
21306 .cindex "DSN" "success"
21307 .cindex "Delivery Status Notification" "success"
21308 redirection triggers one and the DSN options are not passed any further.
21309
21310
21311
21312 .section "Redirection data" "SECID124"
21313 The router operates by interpreting a text string which it obtains either by
21314 expanding the contents of the &%data%& option, or by reading the entire
21315 contents of a file whose name is given in the &%file%& option. These two
21316 options are mutually exclusive. The first is commonly used for handling system
21317 aliases, in a configuration like this:
21318 .code
21319 system_aliases:
21320   driver = redirect
21321   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21322 .endd
21323 If the lookup fails, the expanded string in this example is empty. When the
21324 expansion of &%data%& results in an empty string, the router declines. A forced
21325 expansion failure also causes the router to decline; other expansion failures
21326 cause delivery to be deferred.
21327
21328 A configuration using &%file%& is commonly used for handling users'
21329 &_.forward_& files, like this:
21330 .code
21331 userforward:
21332   driver = redirect
21333   check_local_user
21334   file = $home/.forward
21335   no_verify
21336 .endd
21337 If the file does not exist, or causes no action to be taken (for example, it is
21338 empty or consists only of comments), the router declines. &*Warning*&: This
21339 is not the case when the file contains syntactically valid items that happen to
21340 yield empty addresses, for example, items containing only RFC 2822 address
21341 comments.
21342
21343 .cindex "tainted data" "in filenames"
21344 .cindex redirect "tainted data"
21345 Tainted data may not be used for a filename.
21346
21347 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21348 directly for redirection,
21349 as they are provided by a potential attacker.
21350 In the examples above, &$local_part$& is used for looking up data held locally
21351 on the system, and not used directly (the second example derives &$home$& via
21352 the passsword file or database, using &$local_part$&).
21353
21354
21355
21356 .section "Forward files and address verification" "SECID125"
21357 .cindex "address redirection" "while verifying"
21358 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21359 &_.forward_& files, as in the example above. There are two reasons for this:
21360
21361 .ilist
21362 When Exim is receiving an incoming SMTP message from a remote host, it is
21363 running under the Exim uid, not as root. Exim is unable to change uid to read
21364 the file as the user, and it may not be able to read it as the Exim user. So in
21365 practice the router may not be able to operate.
21366 .next
21367 However, even when the router can operate, the existence of a &_.forward_& file
21368 is unimportant when verifying an address. What should be checked is whether the
21369 local part is a valid user name or not. Cutting out the redirection processing
21370 saves some resources.
21371 .endlist
21372
21373
21374
21375
21376
21377
21378 .section "Interpreting redirection data" "SECID126"
21379 .cindex "Sieve filter" "specifying in redirection data"
21380 .cindex "filter" "specifying in redirection data"
21381 The contents of the data string, whether obtained from &%data%& or &%file%&,
21382 can be interpreted in two different ways:
21383
21384 .ilist
21385 If the &%allow_filter%& option is set true, and the data begins with the text
21386 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21387 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21388 respectively. Details of the syntax and semantics of filter files are described
21389 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21390 document is intended for use by end users.
21391 .next
21392 Otherwise, the data must be a comma-separated list of redirection items, as
21393 described in the next section.
21394 .endlist
21395
21396 When a message is redirected to a file (a &"mail folder"&), the filename given
21397 in a non-filter redirection list must always be an absolute path. A filter may
21398 generate a relative path &-- how this is handled depends on the transport's
21399 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21400 for the &(appendfile)& transport.
21401
21402
21403
21404 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21405 .cindex "address redirection" "non-filter list items"
21406 When the redirection data is not an Exim or Sieve filter, for example, if it
21407 comes from a conventional alias or forward file, it consists of a list of
21408 addresses, filenames, pipe commands, or certain special items (see section
21409 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21410 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21411 depending on their default values. The items in the list are separated by
21412 commas or newlines.
21413 If a comma is required in an item, the entire item must be enclosed in double
21414 quotes.
21415
21416 Lines starting with a # character are comments, and are ignored, and # may
21417 also appear following a comma, in which case everything between the # and the
21418 next newline character is ignored.
21419
21420 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21421 double quotes are retained because some forms of mail address require their use
21422 (but never to enclose the entire address). In the following description,
21423 &"item"& refers to what remains after any surrounding double quotes have been
21424 removed.
21425
21426 .vindex "&$local_part$&"
21427 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21428 and the expansion contains a reference to &$local_part$&, you should make use
21429 of the &%quote_local_part%& expansion operator, in case the local part contains
21430 special characters. For example, to redirect all mail for the domain
21431 &'obsolete.example'&, retaining the existing local part, you could use this
21432 setting:
21433 .code
21434 data = ${quote_local_part:$local_part}@newdomain.example
21435 .endd
21436
21437
21438 .section "Redirecting to a local mailbox" "SECTredlocmai"
21439 .cindex "routing" "loops in"
21440 .cindex "loop" "while routing, avoidance of"
21441 .cindex "address redirection" "to local mailbox"
21442 A redirection item may safely be the same as the address currently under
21443 consideration. This does not cause a routing loop, because a router is
21444 automatically skipped if any ancestor of the address that is being processed
21445 is the same as the current address and was processed by the current router.
21446 Such an address is therefore passed to the following routers, so it is handled
21447 as if there were no redirection. When making this loop-avoidance test, the
21448 complete local part, including any prefix or suffix, is used.
21449
21450 .cindex "address redirection" "local part without domain"
21451 Specifying the same local part without a domain is a common usage in personal
21452 filter files when the user wants to have messages delivered to the local
21453 mailbox and also forwarded elsewhere. For example, the user whose login is
21454 &'cleo'& might have a &_.forward_& file containing this:
21455 .code
21456 cleo, cleopatra@egypt.example
21457 .endd
21458 .cindex "backslash in alias file"
21459 .cindex "alias file" "backslash in"
21460 For compatibility with other MTAs, such unqualified local parts may be
21461 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21462 it does make a difference if more than one domain is being handled
21463 synonymously.
21464
21465 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21466 2822 address that does not include a domain, the item is qualified using the
21467 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21468 addresses are qualified using the value in &%qualify_recipient%&, but you can
21469 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21470
21471 Care must be taken if there are alias names for local users.
21472 Consider an MTA handling a single local domain where the system alias file
21473 contains:
21474 .code
21475 Sam.Reman: spqr
21476 .endd
21477 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21478 messages in the local mailbox, and also forward copies elsewhere. He creates
21479 this forward file:
21480 .code
21481 Sam.Reman, spqr@reme.elsewhere.example
21482 .endd
21483 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21484 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21485 second time round, because it has previously routed it,
21486 and the following routers presumably cannot handle the alias. The forward file
21487 should really contain
21488 .code
21489 spqr, spqr@reme.elsewhere.example
21490 .endd
21491 but because this is such a common error, the &%check_ancestor%& option (see
21492 below) exists to provide a way to get round it. This is normally set on a
21493 &(redirect)& router that is handling users' &_.forward_& files.
21494
21495
21496
21497 .section "Special items in redirection lists" "SECTspecitredli"
21498 In addition to addresses, the following types of item may appear in redirection
21499 lists (that is, in non-filter redirection data):
21500
21501 .ilist
21502 .cindex "pipe" "in redirection list"
21503 .cindex "address redirection" "to pipe"
21504 An item is treated as a pipe command if it begins with &"|"& and does not parse
21505 as a valid RFC 2822 address that includes a domain. A transport for running the
21506 command must be specified by the &%pipe_transport%& option.
21507 Normally, either the router or the transport specifies a user and a group under
21508 which to run the delivery. The default is to use the Exim user and group.
21509
21510 Single or double quotes can be used for enclosing the individual arguments of
21511 the pipe command; no interpretation of escapes is done for single quotes. If
21512 the command contains a comma character, it is necessary to put the whole item
21513 in double quotes, for example:
21514 .code
21515 "|/some/command ready,steady,go"
21516 .endd
21517 since items in redirection lists are terminated by commas. Do not, however,
21518 quote just the command. An item such as
21519 .code
21520 |"/some/command ready,steady,go"
21521 .endd
21522 is interpreted as a pipe with a rather strange command name, and no arguments.
21523
21524 Note that the above example assumes that the text comes from a lookup source
21525 of some sort, so that the quotes are part of the data.  If composing a
21526 redirect router with a &%data%& option directly specifying this command, the
21527 quotes will be used by the configuration parser to define the extent of one
21528 string, but will not be passed down into the redirect router itself.  There
21529 are two main approaches to get around this: escape quotes to be part of the
21530 data itself, or avoid using this mechanism and instead create a custom
21531 transport with the &%command%& option set and reference that transport from
21532 an &%accept%& router.
21533
21534 .next
21535 .cindex "file" "in redirection list"
21536 .cindex "address redirection" "to file"
21537 An item is interpreted as a path name if it begins with &"/"& and does not
21538 parse as a valid RFC 2822 address that includes a domain. For example,
21539 .code
21540 /home/world/minbari
21541 .endd
21542 is treated as a filename, but
21543 .code
21544 /s=molari/o=babylon/@x400gate.way
21545 .endd
21546 is treated as an address. For a filename, a transport must be specified using
21547 the &%file_transport%& option. However, if the generated path name ends with a
21548 forward slash character, it is interpreted as a directory name rather than a
21549 filename, and &%directory_transport%& is used instead.
21550
21551 Normally, either the router or the transport specifies a user and a group under
21552 which to run the delivery. The default is to use the Exim user and group.
21553
21554 .cindex "&_/dev/null_&"
21555 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21556 bypassed at a high level, and the log entry shows &"**bypassed**"&
21557 instead of a transport name. In this case the user and group are not used.
21558
21559 .next
21560 .cindex "included address list"
21561 .cindex "address redirection" "included external list"
21562 If an item is of the form
21563 .code
21564 :include:<path name>
21565 .endd
21566 a list of further items is taken from the given file and included at that
21567 point. &*Note*&: Such a file can not be a filter file; it is just an
21568 out-of-line addition to the list. The items in the included list are separated
21569 by commas or newlines and are not subject to expansion. If this is the first
21570 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21571 the alias name. This example is incorrect:
21572 .code
21573 list1    :include:/opt/lists/list1
21574 .endd
21575 It must be given as
21576 .code
21577 list1:   :include:/opt/lists/list1
21578 .endd
21579 .cindex "tainted data" "in filenames"
21580 .cindex redirect "tainted data"
21581 Tainted data may not be used for a filename.
21582 .next
21583 .cindex "address redirection" "to black hole"
21584 .cindex "delivery" "discard"
21585 .cindex "delivery" "blackhole"
21586 .cindex "black hole"
21587 .cindex "abandoning mail"
21588 Sometimes you want to throw away mail to a particular local part.  Making the
21589 &%data%& option expand to an empty string does not work, because that causes
21590 the router to decline. Instead, the alias item
21591 .code
21592 :blackhole:
21593 .endd
21594 can be used. It does what its name implies. No delivery is
21595 done, and no error message is generated. This has the same effect as specifying
21596 &_/dev/null_& as a destination, but it can be independently disabled.
21597
21598 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21599 delivery is done for the original local part, even if other redirection items
21600 are present. If you are generating a multi-item list (for example, by reading a
21601 database) and need the ability to provide a no-op item, you must use
21602 &_/dev/null_&.
21603
21604 .next
21605 .cindex "delivery" "forcing failure"
21606 .cindex "delivery" "forcing deferral"
21607 .cindex "failing delivery" "forcing"
21608 .cindex "deferred delivery, forcing"
21609 .cindex "customizing" "failure message"
21610 An attempt to deliver a particular address can be deferred or forced to fail by
21611 redirection items of the form
21612 .code
21613 :defer:
21614 :fail:
21615 .endd
21616 respectively. When a redirection list contains such an item, it applies
21617 to the entire redirection; any other items in the list are ignored. Any
21618 text following &':fail:'& or &':defer:'& is placed in the error text
21619 associated with the failure. For example, an alias file might contain:
21620 .code
21621 X.Employee:  :fail: Gone away, no forwarding address
21622 .endd
21623 In the case of an address that is being verified from an ACL or as the subject
21624 of a
21625 .cindex "VRFY" "error text, display of"
21626 VRFY command, the text is included in the SMTP error response by
21627 default.
21628 .cindex "EXPN" "error text, display of"
21629 The text is not included in the response to an EXPN command. In non-SMTP cases
21630 the text is included in the error message that Exim generates.
21631
21632 .cindex "SMTP" "error codes"
21633 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21634 &':fail:'&. However, if the message starts with three digits followed by a
21635 space, optionally followed by an extended code of the form &'n.n.n'&, also
21636 followed by a space, and the very first digit is the same as the default error
21637 code, the code from the message is used instead. If the very first digit is
21638 incorrect, a panic error is logged, and the default code is used. You can
21639 suppress the use of the supplied code in a redirect router by setting the
21640 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21641 ignored.
21642
21643 .vindex "&$acl_verify_message$&"
21644 In an ACL, an explicitly provided message overrides the default, but the
21645 default message is available in the variable &$acl_verify_message$& and can
21646 therefore be included in a custom message if this is desired.
21647
21648 Normally the error text is the rest of the redirection list &-- a comma does
21649 not terminate it &-- but a newline does act as a terminator. Newlines are not
21650 normally present in alias expansions. In &(lsearch)& lookups they are removed
21651 as part of the continuation process, but they may exist in other kinds of
21652 lookup and in &':include:'& files.
21653
21654 During routing for message delivery (as opposed to verification), a redirection
21655 containing &':fail:'& causes an immediate failure of the incoming address,
21656 whereas &':defer:'& causes the message to remain in the queue so that a
21657 subsequent delivery attempt can happen at a later time. If an address is
21658 deferred for too long, it will ultimately fail, because the normal retry
21659 rules still apply.
21660
21661 .next
21662 .cindex "alias file" "exception to default"
21663 Sometimes it is useful to use a single-key search type with a default (see
21664 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21665 for exceptions to the default. These can be handled by aliasing them to
21666 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21667 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21668 results in an empty redirection list has the same effect.
21669 .endlist
21670
21671
21672 .section "Duplicate addresses" "SECTdupaddr"
21673 .cindex "duplicate addresses"
21674 .cindex "address duplicate, discarding"
21675 .cindex "pipe" "duplicated"
21676 Exim removes duplicate addresses from the list to which it is delivering, so as
21677 to deliver just one copy to each address. This does not apply to deliveries
21678 routed to pipes by different immediate parent addresses, but an indirect
21679 aliasing scheme of the type
21680 .code
21681 pipe:       |/some/command $local_part
21682 localpart1: pipe
21683 localpart2: pipe
21684 .endd
21685 does not work with a message that is addressed to both local parts, because
21686 when the second is aliased to the intermediate local part &"pipe"& it gets
21687 discarded as being the same as a previously handled address. However, a scheme
21688 such as
21689 .code
21690 localpart1: |/some/command $local_part
21691 localpart2: |/some/command $local_part
21692 .endd
21693 does result in two different pipe deliveries, because the immediate parents of
21694 the pipes are distinct.
21695
21696
21697
21698 .section "Repeated redirection expansion" "SECID128"
21699 .cindex "repeated redirection expansion"
21700 .cindex "address redirection" "repeated for each delivery attempt"
21701 When a message cannot be delivered to all of its recipients immediately,
21702 leading to two or more delivery attempts, redirection expansion is carried out
21703 afresh each time for those addresses whose children were not all previously
21704 delivered. If redirection is being used as a mailing list, this can lead to new
21705 members of the list receiving copies of old messages. The &%one_time%& option
21706 can be used to avoid this.
21707
21708
21709 .section "Errors in redirection lists" "SECID129"
21710 .cindex "address redirection" "errors"
21711 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21712 error is skipped, and an entry is written to the main log. This may be useful
21713 for mailing lists that are automatically managed. Otherwise, if an error is
21714 detected while generating the list of new addresses, the original address is
21715 deferred. See also &%syntax_errors_to%&.
21716
21717
21718
21719 .section "Private options for the redirect router" "SECID130"
21720
21721 .cindex "options" "&(redirect)& router"
21722 The private options for the &(redirect)& router are as follows:
21723
21724
21725 .option allow_defer redirect boolean false
21726 Setting this option allows the use of &':defer:'& in non-filter redirection
21727 data, or the &%defer%& command in an Exim filter file.
21728
21729
21730 .option allow_fail redirect boolean false
21731 .cindex "failing delivery" "from filter"
21732 If this option is true, the &':fail:'& item can be used in a redirection list,
21733 and the &%fail%& command may be used in an Exim filter file.
21734
21735
21736 .option allow_filter redirect boolean false
21737 .cindex "filter" "enabling use of"
21738 .cindex "Sieve filter" "enabling use of"
21739 Setting this option allows Exim to interpret redirection data that starts with
21740 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21741 are some features of Exim filter files that some administrators may wish to
21742 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21743
21744 It is also possible to lock out Exim filters or Sieve filters while allowing
21745 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21746
21747
21748 The filter is run using the uid and gid set by the generic &%user%& and
21749 &%group%& options. These take their defaults from the password data if
21750 &%check_local_user%& is set, so in the normal case of users' personal filter
21751 files, the filter is run as the relevant user. When &%allow_filter%& is set
21752 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21753
21754
21755
21756 .option allow_freeze redirect boolean false
21757 .cindex "freezing messages" "allowing in filter"
21758 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21759 This command is more normally encountered in system filters, and is disabled by
21760 default for redirection filters because it isn't something you usually want to
21761 let ordinary users do.
21762
21763
21764
21765 .option check_ancestor redirect boolean false
21766 This option is concerned with handling generated addresses that are the same
21767 as some address in the list of redirection ancestors of the current address.
21768 Although it is turned off by default in the code, it is set in the default
21769 configuration file for handling users' &_.forward_& files. It is recommended
21770 for this use of the &(redirect)& router.
21771
21772 When &%check_ancestor%& is set, if a generated address (including the domain)
21773 is the same as any ancestor of the current address, it is replaced by a copy of
21774 the current address. This helps in the case where local part A is aliased to B,
21775 and B has a &_.forward_& file pointing back to A. For example, within a single
21776 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21777 &_&~jb/.forward_& contains:
21778 .code
21779 \Joe.Bloggs, <other item(s)>
21780 .endd
21781 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21782 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21783 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21784 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21785 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21786 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21787 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21788 original address. See also the &%repeat_use%& option below.
21789
21790
21791 .option check_group redirect boolean "see below"
21792 When the &%file%& option is used, the group owner of the file is checked only
21793 when this option is set. The permitted groups are those listed in the
21794 &%owngroups%& option, together with the user's default group if
21795 &%check_local_user%& is set. If the file has the wrong group, routing is
21796 deferred. The default setting for this option is true if &%check_local_user%&
21797 is set and the &%modemask%& option permits the group write bit, or if the
21798 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21799
21800
21801
21802 .option check_owner redirect boolean "see below"
21803 When the &%file%& option is used, the owner of the file is checked only when
21804 this option is set. If &%check_local_user%& is set, the local user is
21805 permitted; otherwise the owner must be one of those listed in the &%owners%&
21806 option. The default value for this option is true if &%check_local_user%& or
21807 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21808
21809
21810 .option data redirect string&!! unset
21811 This option is mutually exclusive with &%file%&. One or other of them must be
21812 set, but not both. The contents of &%data%& are expanded, and then used as the
21813 list of forwarding items, or as a set of filtering instructions. If the
21814 expansion is forced to fail, or the result is an empty string or a string that
21815 has no effect (consists entirely of comments), the router declines.
21816
21817 When filtering instructions are used, the string must begin with &"#Exim
21818 filter"&, and all comments in the string, including this initial one, must be
21819 terminated with newline characters. For example:
21820 .code
21821 data = #Exim filter\n\
21822        if $h_to: contains Exim then save $home/mail/exim endif
21823 .endd
21824 If you are reading the data from a database where newlines cannot be included,
21825 you can use the &${sg}$& expansion item to turn the escape string of your
21826 choice into a newline.
21827
21828
21829 .option directory_transport redirect string&!! unset
21830 A &(redirect)& router sets up a direct delivery to a directory when a path name
21831 ending with a slash is specified as a new &"address"&. The transport used is
21832 specified by this option, which, after expansion, must be the name of a
21833 configured transport. This should normally be an &(appendfile)& transport.
21834
21835
21836 .option file redirect string&!! unset
21837 This option specifies the name of a file that contains the redirection data. It
21838 is mutually exclusive with the &%data%& option. The string is expanded before
21839 use; if the expansion is forced to fail, the router declines. Other expansion
21840 failures cause delivery to be deferred. The result of a successful expansion
21841 must be an absolute path. The entire file is read and used as the redirection
21842 data. If the data is an empty string or a string that has no effect (consists
21843 entirely of comments), the router declines.
21844
21845 .cindex "NFS" "checking for file existence"
21846 If the attempt to open the file fails with a &"does not exist"& error, Exim
21847 runs a check on the containing directory,
21848 unless &%ignore_enotdir%& is true (see below).
21849 If the directory does not appear to exist, delivery is deferred. This can
21850 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21851 is a mount problem. If the containing directory does exist, but the file does
21852 not, the router declines.
21853
21854
21855 .option file_transport redirect string&!! unset
21856 .vindex "&$address_file$&"
21857 A &(redirect)& router sets up a direct delivery to a file when a path name not
21858 ending in a slash is specified as a new &"address"&. The transport used is
21859 specified by this option, which, after expansion, must be the name of a
21860 configured transport. This should normally be an &(appendfile)& transport. When
21861 it is running, the filename is in &$address_file$&.
21862
21863
21864 .option filter_prepend_home redirect boolean true
21865 When this option is true, if a &(save)& command in an Exim filter specifies a
21866 relative path, and &$home$& is defined, it is automatically prepended to the
21867 relative path. If this option is set false, this action does not happen. The
21868 relative path is then passed to the transport unmodified.
21869
21870
21871 .option forbid_blackhole redirect boolean false
21872 .cindex "restricting access to features"
21873 .cindex "filter" "locking out certain features"
21874 If this option is true, the &':blackhole:'& item may not appear in a
21875 redirection list.
21876
21877
21878 .option forbid_exim_filter redirect boolean false
21879 .cindex "restricting access to features"
21880 .cindex "filter" "locking out certain features"
21881 If this option is set true, only Sieve filters are permitted when
21882 &%allow_filter%& is true.
21883
21884
21885
21886
21887 .option forbid_file redirect boolean false
21888 .cindex "restricting access to features"
21889 .cindex "delivery" "to file; forbidding"
21890 .cindex "filter" "locking out certain features"
21891 .cindex "Sieve filter" "forbidding delivery to a file"
21892 .cindex "Sieve filter" "&""keep""& facility; disabling"
21893 If this option is true, this router may not generate a new address that
21894 specifies delivery to a local file or directory, either from a filter or from a
21895 conventional forward file. This option is forced to be true if &%one_time%& is
21896 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21897 locks out the Sieve's &"keep"& facility.
21898
21899
21900 .option forbid_filter_dlfunc redirect boolean false
21901 .cindex "restricting access to features"
21902 .cindex "filter" "locking out certain features"
21903 If this option is true, string expansions in Exim filters are not allowed to
21904 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21905 functions.
21906
21907 .option forbid_filter_existstest redirect boolean false
21908 .cindex "restricting access to features"
21909 .cindex "filter" "locking out certain features"
21910 .cindex "expansion" "statting a file"
21911 If this option is true, string expansions in Exim filters are not allowed to
21912 make use of the &%exists%& condition or the &%stat%& expansion item.
21913
21914 .option forbid_filter_logwrite redirect boolean false
21915 .cindex "restricting access to features"
21916 .cindex "filter" "locking out certain features"
21917 If this option is true, use of the logging facility in Exim filters is not
21918 permitted. Logging is in any case available only if the filter is being run
21919 under some unprivileged uid (which is normally the case for ordinary users'
21920 &_.forward_& files).
21921
21922
21923 .option forbid_filter_lookup redirect boolean false
21924 .cindex "restricting access to features"
21925 .cindex "filter" "locking out certain features"
21926 If this option is true, string expansions in Exim filter files are not allowed
21927 to make use of &%lookup%& items.
21928
21929
21930 .option forbid_filter_perl redirect boolean false
21931 .cindex "restricting access to features"
21932 .cindex "filter" "locking out certain features"
21933 This option has an effect only if Exim is built with embedded Perl support. If
21934 it is true, string expansions in Exim filter files are not allowed to make use
21935 of the embedded Perl support.
21936
21937
21938 .option forbid_filter_readfile redirect boolean false
21939 .cindex "restricting access to features"
21940 .cindex "filter" "locking out certain features"
21941 If this option is true, string expansions in Exim filter files are not allowed
21942 to make use of &%readfile%& items.
21943
21944
21945 .option forbid_filter_readsocket redirect boolean false
21946 .cindex "restricting access to features"
21947 .cindex "filter" "locking out certain features"
21948 If this option is true, string expansions in Exim filter files are not allowed
21949 to make use of &%readsocket%& items.
21950
21951
21952 .option forbid_filter_reply redirect boolean false
21953 .cindex "restricting access to features"
21954 .cindex "filter" "locking out certain features"
21955 If this option is true, this router may not generate an automatic reply
21956 message. Automatic replies can be generated only from Exim or Sieve filter
21957 files, not from traditional forward files. This option is forced to be true if
21958 &%one_time%& is set.
21959
21960
21961 .option forbid_filter_run redirect boolean false
21962 .cindex "restricting access to features"
21963 .cindex "filter" "locking out certain features"
21964 If this option is true, string expansions in Exim filter files are not allowed
21965 to make use of &%run%& items.
21966
21967
21968 .option forbid_include redirect boolean false
21969 .cindex "restricting access to features"
21970 .cindex "filter" "locking out certain features"
21971 If this option is true, items of the form
21972 .code
21973 :include:<path name>
21974 .endd
21975 are not permitted in non-filter redirection lists.
21976
21977
21978 .option forbid_pipe redirect boolean false
21979 .cindex "restricting access to features"
21980 .cindex "filter" "locking out certain features"
21981 .cindex "delivery" "to pipe; forbidding"
21982 If this option is true, this router may not generate a new address which
21983 specifies delivery to a pipe, either from an Exim filter or from a conventional
21984 forward file. This option is forced to be true if &%one_time%& is set.
21985
21986
21987 .option forbid_sieve_filter redirect boolean false
21988 .cindex "restricting access to features"
21989 .cindex "filter" "locking out certain features"
21990 If this option is set true, only Exim filters are permitted when
21991 &%allow_filter%& is true.
21992
21993
21994 .cindex "SMTP" "error codes"
21995 .option forbid_smtp_code redirect boolean false
21996 If this option is set true, any SMTP error codes that are present at the start
21997 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21998 the default codes (451 and 550, respectively) are always used.
21999
22000
22001
22002
22003 .option hide_child_in_errmsg redirect boolean false
22004 .cindex "bounce message" "redirection details; suppressing"
22005 If this option is true, it prevents Exim from quoting a child address if it
22006 generates a bounce or delay message for it. Instead it says &"an address
22007 generated from <&'the top level address'&>"&. Of course, this applies only to
22008 bounces generated locally. If a message is forwarded to another host, &'its'&
22009 bounce may well quote the generated address.
22010
22011
22012 .option ignore_eacces redirect boolean false
22013 .cindex "EACCES"
22014 If this option is set and an attempt to open a redirection file yields the
22015 EACCES error (permission denied), the &(redirect)& router behaves as if the
22016 file did not exist.
22017
22018
22019 .option ignore_enotdir redirect boolean false
22020 .cindex "ENOTDIR"
22021 If this option is set and an attempt to open a redirection file yields the
22022 ENOTDIR error (something on the path is not a directory), the &(redirect)&
22023 router behaves as if the file did not exist.
22024
22025 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
22026 router that has the &%file%& option set discovers that the file does not exist
22027 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
22028 against unmounted NFS directories. If the parent can not be statted, delivery
22029 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
22030 is set, because that option tells Exim to ignore &"something on the path is not
22031 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
22032 that some operating systems give ENOENT where others give ENOTDIR.
22033
22034
22035
22036 .option include_directory redirect string unset
22037 If this option is set, the path names of any &':include:'& items in a
22038 redirection list must start with this directory.
22039
22040
22041 .option modemask redirect "octal integer" 022
22042 This specifies mode bits which must not be set for a file specified by the
22043 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22044
22045
22046 .option one_time redirect boolean false
22047 .cindex "one-time aliasing/forwarding expansion"
22048 .cindex "alias file" "one-time expansion"
22049 .cindex "forward file" "one-time expansion"
22050 .cindex "mailing lists" "one-time expansion"
22051 .cindex "address redirection" "one-time expansion"
22052 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22053 files each time it tries to deliver a message causes a problem when one or more
22054 of the generated addresses fails be delivered at the first attempt. The problem
22055 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22056 but of what happens when the redirection list changes during the time that the
22057 message is on Exim's queue. This is particularly true in the case of mailing
22058 lists, where new subscribers might receive copies of messages that were posted
22059 before they subscribed.
22060
22061 If &%one_time%& is set and any addresses generated by the router fail to
22062 deliver at the first attempt, the failing addresses are added to the message as
22063 &"top level"& addresses, and the parent address that generated them is marked
22064 &"delivered"&. Thus, redirection does not happen again at the next delivery
22065 attempt.
22066
22067 &*Warning 1*&: Any header line addition or removal that is specified by this
22068 router would be lost if delivery did not succeed at the first attempt. For this
22069 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22070 permitted when &%one_time%& is set.
22071
22072 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22073 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22074 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22075
22076 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22077 &%one_time%&.
22078
22079 The original top-level address is remembered with each of the generated
22080 addresses, and is output in any log messages. However, any intermediate parent
22081 addresses are not recorded. This makes a difference to the log only if
22082 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22083 typically be used for mailing lists, where there is normally just one level of
22084 expansion.
22085
22086
22087 .option owners redirect "string list" unset
22088 .cindex "ownership" "alias file"
22089 .cindex "ownership" "forward file"
22090 .cindex "alias file" "ownership"
22091 .cindex "forward file" "ownership"
22092 This specifies a list of permitted owners for the file specified by &%file%&.
22093 This list is in addition to the local user when &%check_local_user%& is set.
22094 See &%check_owner%& above.
22095
22096
22097 .option owngroups redirect "string list" unset
22098 This specifies a list of permitted groups for the file specified by &%file%&.
22099 The list is in addition to the local user's primary group when
22100 &%check_local_user%& is set. See &%check_group%& above.
22101
22102
22103 .option pipe_transport redirect string&!! unset
22104 .vindex "&$address_pipe$&"
22105 A &(redirect)& router sets up a direct delivery to a pipe when a string
22106 starting with a vertical bar character is specified as a new &"address"&. The
22107 transport used is specified by this option, which, after expansion, must be the
22108 name of a configured transport. This should normally be a &(pipe)& transport.
22109 When the transport is run, the pipe command is in &$address_pipe$&.
22110
22111
22112 .option qualify_domain redirect string&!! unset
22113 .vindex "&$qualify_recipient$&"
22114 If this option is set, and an unqualified address (one without a domain) is
22115 generated, and that address would normally be qualified by the global setting
22116 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22117 expanding this string. If the expansion fails, the router declines. If you want
22118 to revert to the default, you can have the expansion generate
22119 &$qualify_recipient$&.
22120
22121 This option applies to all unqualified addresses generated by Exim filters,
22122 but for traditional &_.forward_& files, it applies only to addresses that are
22123 not preceded by a backslash. Sieve filters cannot generate unqualified
22124 addresses.
22125
22126 .option qualify_preserve_domain redirect boolean false
22127 .cindex "domain" "in redirection; preserving"
22128 .cindex "preserving domain in redirection"
22129 .cindex "address redirection" "domain; preserving"
22130 If this option is set, the router's local &%qualify_domain%& option must not be
22131 set (a configuration error occurs if it is). If an unqualified address (one
22132 without a domain) is generated, it is qualified with the domain of the parent
22133 address (the immediately preceding ancestor) instead of the global
22134 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22135 this applies whether or not the address is preceded by a backslash.
22136
22137
22138 .option repeat_use redirect boolean true
22139 If this option is set false, the router is skipped for a child address that has
22140 any ancestor that was routed by this router. This test happens before any of
22141 the other preconditions are tested. Exim's default anti-looping rules skip
22142 only when the ancestor is the same as the current address. See also
22143 &%check_ancestor%& above and the generic &%redirect_router%& option.
22144
22145
22146 .option reply_transport redirect string&!! unset
22147 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22148 &%vacation%& command is used in a filter file. The transport used is specified
22149 by this option, which, after expansion, must be the name of a configured
22150 transport. This should normally be an &(autoreply)& transport. Other transports
22151 are unlikely to do anything sensible or useful.
22152
22153
22154 .option rewrite redirect boolean true
22155 .cindex "address redirection" "disabling rewriting"
22156 If this option is set false, addresses generated by the router are not
22157 subject to address rewriting. Otherwise, they are treated like new addresses
22158 and are rewritten according to the global rewriting rules.
22159
22160
22161 .option sieve_subaddress redirect string&!! unset
22162 The value of this option is passed to a Sieve filter to specify the
22163 :subaddress part of an address.
22164
22165 .option sieve_useraddress redirect string&!! unset
22166 The value of this option is passed to a Sieve filter to specify the :user part
22167 of an address. However, if it is unset, the entire original local part
22168 (including any prefix or suffix) is used for :user.
22169
22170
22171 .option sieve_vacation_directory redirect string&!! unset
22172 .cindex "Sieve filter" "vacation directory"
22173 To enable the &"vacation"& extension for Sieve filters, you must set
22174 &%sieve_vacation_directory%& to the directory where vacation databases are held
22175 (do not put anything else in that directory), and ensure that the
22176 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22177 needs their own directory; Exim will create it if necessary.
22178
22179
22180
22181 .option skip_syntax_errors redirect boolean false
22182 .cindex "forward file" "broken"
22183 .cindex "address redirection" "broken files"
22184 .cindex "alias file" "broken"
22185 .cindex "broken alias or forward files"
22186 .cindex "ignoring faulty addresses"
22187 .cindex "skipping faulty addresses"
22188 .cindex "error" "skipping bad syntax"
22189 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22190 non-filter redirection data are skipped, and each failing address is logged. If
22191 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22192 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22193 are expanded and placed at the head of the error message generated by
22194 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22195 be the same address as the generic &%errors_to%& option. The
22196 &%skip_syntax_errors%& option is often used when handling mailing lists.
22197
22198 If all the addresses in a redirection list are skipped because of syntax
22199 errors, the router declines to handle the original address, and it is passed to
22200 the following routers.
22201
22202 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22203 error in the filter causes filtering to be abandoned without any action being
22204 taken. The incident is logged, and the router declines to handle the address,
22205 so it is passed to the following routers.
22206
22207 .cindex "Sieve filter" "syntax errors in"
22208 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22209 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22210 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22211
22212 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22213 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22214 option, used with an address that does not get redirected, can be used to
22215 notify users of these errors, by means of a router like this:
22216 .code
22217 userforward:
22218   driver = redirect
22219   allow_filter
22220   check_local_user
22221   file = $home/.forward
22222   file_transport = address_file
22223   pipe_transport = address_pipe
22224   reply_transport = address_reply
22225   no_verify
22226   skip_syntax_errors
22227   syntax_errors_to = real-$local_part@$domain
22228   syntax_errors_text = \
22229    This is an automatically generated message. An error has\n\
22230    been found in your .forward file. Details of the error are\n\
22231    reported below. While this error persists, you will receive\n\
22232    a copy of this message for every message that is addressed\n\
22233    to you. If your .forward file is a filter file, or if it is\n\
22234    a non-filter file containing no valid forwarding addresses,\n\
22235    a copy of each incoming message will be put in your normal\n\
22236    mailbox. If a non-filter file contains at least one valid\n\
22237    forwarding address, forwarding to the valid addresses will\n\
22238    happen, and those will be the only deliveries that occur.
22239 .endd
22240 You also need a router to ensure that local addresses that are prefixed by
22241 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22242 put this immediately before the &(userforward)& router:
22243 .code
22244 real_localuser:
22245   driver = accept
22246   check_local_user
22247   local_part_prefix = real-
22248   transport = local_delivery
22249 .endd
22250 For security, it would probably be a good idea to restrict the use of this
22251 router to locally-generated messages, using a condition such as this:
22252 .code
22253   condition = ${if match {$sender_host_address}\
22254                          {\N^(|127\.0\.0\.1)$\N}}
22255 .endd
22256
22257
22258 .option syntax_errors_text redirect string&!! unset
22259 See &%skip_syntax_errors%& above.
22260
22261
22262 .option syntax_errors_to redirect string unset
22263 See &%skip_syntax_errors%& above.
22264 .ecindex IIDredrou1
22265 .ecindex IIDredrou2
22266
22267
22268
22269
22270
22271
22272 . ////////////////////////////////////////////////////////////////////////////
22273 . ////////////////////////////////////////////////////////////////////////////
22274
22275 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22276          "Environment for local transports"
22277 .scindex IIDenvlotra1 "local transports" "environment for"
22278 .scindex IIDenvlotra2 "environment" "local transports"
22279 .scindex IIDenvlotra3 "transport" "local; environment for"
22280 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22281 transport can be thought of as similar to a pipe.) Exim always runs transports
22282 in subprocesses, under specified uids and gids. Typical deliveries to local
22283 mailboxes run under the uid and gid of the local user.
22284
22285 Exim also sets a specific current directory while running the transport; for
22286 some transports a home directory setting is also relevant. The &(pipe)&
22287 transport is the only one that sets up environment variables; see section
22288 &<<SECTpipeenv>>& for details.
22289
22290 The values used for the uid, gid, and the directories may come from several
22291 different places. In many cases, the router that handles the address associates
22292 settings with that address as a result of its &%check_local_user%&, &%group%&,
22293 or &%user%& options. However, values may also be given in the transport's own
22294 configuration, and these override anything that comes from the router.
22295
22296
22297
22298 .section "Concurrent deliveries" "SECID131"
22299 .cindex "concurrent deliveries"
22300 .cindex "simultaneous deliveries"
22301 If two different messages for the same local recipient arrive more or less
22302 simultaneously, the two delivery processes are likely to run concurrently. When
22303 the &(appendfile)& transport is used to write to a file, Exim applies locking
22304 rules to stop concurrent processes from writing to the same file at the same
22305 time.
22306
22307 However, when you use a &(pipe)& transport, it is up to you to arrange any
22308 locking that is needed. Here is a silly example:
22309 .code
22310 my_transport:
22311   driver = pipe
22312   command = /bin/sh -c 'cat >>/some/file'
22313 .endd
22314 This is supposed to write the message at the end of the file. However, if two
22315 messages arrive at the same time, the file will be scrambled. You can use the
22316 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22317 file using the same algorithm that Exim itself uses.
22318
22319
22320
22321
22322 .section "Uids and gids" "SECTenvuidgid"
22323 .cindex "local transports" "uid and gid"
22324 .cindex "transport" "local; uid and gid"
22325 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22326 overrides any group that the router set in the address, even if &%user%& is not
22327 set for the transport. This makes it possible, for example, to run local mail
22328 delivery under the uid of the recipient (set by the router), but in a special
22329 group (set by the transport). For example:
22330 .code
22331 # Routers ...
22332 # User/group are set by check_local_user in this router
22333 local_users:
22334   driver = accept
22335   check_local_user
22336   transport = group_delivery
22337
22338 # Transports ...
22339 # This transport overrides the group
22340 group_delivery:
22341   driver = appendfile
22342   file = /var/spool/mail/$local_part_data
22343   group = mail
22344 .endd
22345 If &%user%& is set for a transport, its value overrides what is set in the
22346 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22347 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22348 set.
22349
22350 .oindex "&%initgroups%&"
22351 When the uid is taken from the transport's configuration, the &[initgroups()]&
22352 function is called for the groups associated with that uid if the
22353 &%initgroups%& option is set for the transport. When the uid is not specified
22354 by the transport, but is associated with the address by a router, the option
22355 for calling &[initgroups()]& is taken from the router configuration.
22356
22357 .cindex "&(pipe)& transport" "uid for"
22358 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22359 is set and &%user%& is not set, the uid of the process that called Exim to
22360 receive the message is used, and if &%group%& is not set, the corresponding
22361 original gid is also used.
22362
22363 This is the detailed preference order for obtaining a gid; the first of the
22364 following that is set is used:
22365
22366 .ilist
22367 A &%group%& setting of the transport;
22368 .next
22369 A &%group%& setting of the router;
22370 .next
22371 A gid associated with a user setting of the router, either as a result of
22372 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22373 .next
22374 The group associated with a non-numeric &%user%& setting of the transport;
22375 .next
22376 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22377 the uid is the creator's uid;
22378 .next
22379 The Exim gid if the Exim uid is being used as a default.
22380 .endlist
22381
22382 If, for example, the user is specified numerically on the router and there are
22383 no group settings, no gid is available. In this situation, an error occurs.
22384 This is different for the uid, for which there always is an ultimate default.
22385 The first of the following that is set is used:
22386
22387 .ilist
22388 A &%user%& setting of the transport;
22389 .next
22390 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22391 .next
22392 A &%user%& setting of the router;
22393 .next
22394 A &%check_local_user%& setting of the router;
22395 .next
22396 The Exim uid.
22397 .endlist
22398
22399 Of course, an error will still occur if the uid that is chosen is on the
22400 &%never_users%& list.
22401
22402
22403
22404
22405
22406 .section "Current and home directories" "SECID132"
22407 .cindex "current directory for local transport"
22408 .cindex "home directory" "for local transport"
22409 .cindex "transport" "local; home directory for"
22410 .cindex "transport" "local; current directory for"
22411 Routers may set current and home directories for local transports by means of
22412 the &%transport_current_directory%& and &%transport_home_directory%& options.
22413 However, if the transport's &%current_directory%& or &%home_directory%& options
22414 are set, they override the router's values. In detail, the home directory
22415 for a local transport is taken from the first of these values that is set:
22416
22417 .ilist
22418 The &%home_directory%& option on the transport;
22419 .next
22420 The &%transport_home_directory%& option on the router;
22421 .next
22422 The password data if &%check_local_user%& is set on the router;
22423 .next
22424 The &%router_home_directory%& option on the router.
22425 .endlist
22426
22427 The current directory is taken from the first of these values that is set:
22428
22429 .ilist
22430 The &%current_directory%& option on the transport;
22431 .next
22432 The &%transport_current_directory%& option on the router.
22433 .endlist
22434
22435
22436 If neither the router nor the transport sets a current directory, Exim uses the
22437 value of the home directory, if it is set. Otherwise it sets the current
22438 directory to &_/_& before running a local transport.
22439
22440
22441
22442 .section "Expansion variables derived from the address" "SECID133"
22443 .vindex "&$domain$&"
22444 .vindex "&$local_part$&"
22445 .vindex "&$original_domain$&"
22446 Normally a local delivery is handling a single address, and in that case the
22447 variables such as &$domain$& and &$local_part$& are set during local
22448 deliveries. However, in some circumstances more than one address may be handled
22449 at once (for example, while writing batch SMTP for onward transmission by some
22450 other means). In this case, the variables associated with the local part are
22451 never set, &$domain$& is set only if all the addresses have the same domain,
22452 and &$original_domain$& is never set.
22453 .ecindex IIDenvlotra1
22454 .ecindex IIDenvlotra2
22455 .ecindex IIDenvlotra3
22456
22457
22458
22459
22460
22461
22462
22463 . ////////////////////////////////////////////////////////////////////////////
22464 . ////////////////////////////////////////////////////////////////////////////
22465
22466 .chapter "Generic options for transports" "CHAPtransportgeneric"
22467 .scindex IIDgenoptra1 "generic options" "transport"
22468 .scindex IIDgenoptra2 "options" "generic; for transports"
22469 .scindex IIDgenoptra3 "transport" "generic options for"
22470 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22471 prior to Exim 4.95 names would be silently truncated at this length, but now
22472 it is enforced.
22473
22474 The following generic options apply to all transports:
22475
22476
22477 .option body_only transports boolean false
22478 .cindex "transport" "body only"
22479 .cindex "message" "transporting body only"
22480 .cindex "body of message" "transporting"
22481 If this option is set, the message's headers are not transported. It is
22482 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22483 or &(pipe)& transports, the settings of &%message_prefix%& and
22484 &%message_suffix%& should be checked, because this option does not
22485 automatically suppress them.
22486
22487
22488 .option current_directory transports string&!! unset
22489 .cindex "transport" "current directory for"
22490 This specifies the current directory that is to be set while running the
22491 transport, overriding any value that may have been set by the router.
22492 If the expansion fails for any reason, including forced failure, an error is
22493 logged, and delivery is deferred.
22494
22495
22496 .option disable_logging transports boolean false
22497 If this option is set true, nothing is logged for any
22498 deliveries by the transport or for any
22499 transport errors. You should not set this option unless you really, really know
22500 what you are doing.
22501
22502
22503 .option debug_print transports string&!! unset
22504 .cindex "testing" "variables in drivers"
22505 If this option is set and debugging is enabled (see the &%-d%& command line
22506 option), the string is expanded and included in the debugging output when the
22507 transport is run.
22508 If expansion of the string fails, the error message is written to the debugging
22509 output, and Exim carries on processing.
22510 This facility is provided to help with checking out the values of variables and
22511 so on when debugging driver configurations. For example, if a &%headers_add%&
22512 option is not working properly, &%debug_print%& could be used to output the
22513 variables it references. A newline is added to the text if it does not end with
22514 one.
22515 The variables &$transport_name$& and &$router_name$& contain the name of the
22516 transport and the router that called it.
22517
22518 .option delivery_date_add transports boolean false
22519 .cindex "&'Delivery-date:'& header line"
22520 If this option is true, a &'Delivery-date:'& header is added to the message.
22521 This gives the actual time the delivery was made. As this is not a standard
22522 header, Exim has a configuration option (&%delivery_date_remove%&) which
22523 requests its removal from incoming messages, so that delivered messages can
22524 safely be resent to other recipients.
22525
22526
22527 .option driver transports string unset
22528 This specifies which of the available transport drivers is to be used.
22529 There is no default, and this option must be set for every transport.
22530
22531
22532 .option envelope_to_add transports boolean false
22533 .cindex "&'Envelope-to:'& header line"
22534 If this option is true, an &'Envelope-to:'& header is added to the message.
22535 This gives the original address(es) in the incoming envelope that caused this
22536 delivery to happen. More than one address may be present if the transport is
22537 configured to handle several addresses at once, or if more than one original
22538 address was redirected to the same final address. As this is not a standard
22539 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22540 its removal from incoming messages, so that delivered messages can safely be
22541 resent to other recipients.
22542
22543 &*Note:*& If used on a transport handling multiple recipients
22544 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22545 transport if &%batch_max%& is greater than 1)
22546 then information about Bcc recipients will be leaked.
22547 Doing so is generally not advised.
22548
22549
22550 .option event_action transports string&!! unset
22551 .cindex events
22552 This option declares a string to be expanded for Exim's events mechanism.
22553 For details see chapter &<<CHAPevents>>&.
22554
22555
22556 .option group transports string&!! "Exim group"
22557 .cindex "transport" "group; specifying"
22558 This option specifies a gid for running the transport process, overriding any
22559 value that the router supplies, and also overriding any value associated with
22560 &%user%& (see below).
22561
22562
22563 .option headers_add transports list&!! unset
22564 .cindex "header lines" "adding in transport"
22565 .cindex "transport" "header lines; adding"
22566 This option specifies a list of text headers,
22567 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22568 which are (separately) expanded and added to the header
22569 portion of a message as it is transported, as described in section
22570 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22571 routers. If the result of the expansion is an empty string, or if the expansion
22572 is forced to fail, no action is taken. Other expansion failures are treated as
22573 errors and cause the delivery to be deferred.
22574
22575 Unlike most options, &%headers_add%& can be specified multiple times
22576 for a transport; all listed headers are added.
22577
22578
22579 .option headers_only transports boolean false
22580 .cindex "transport" "header lines only"
22581 .cindex "message" "transporting headers only"
22582 .cindex "header lines" "transporting"
22583 If this option is set, the message's body is not transported. It is mutually
22584 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22585 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22586 checked, since this option does not automatically suppress them.
22587
22588
22589 .option headers_remove transports list&!! unset
22590 .cindex "header lines" "removing"
22591 .cindex "transport" "header lines; removing"
22592 This option specifies a list of text headers,
22593 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22594 to be removed from the message.
22595 However, the option has no effect when an address is just being verified.
22596 Each list item is separately expanded.
22597 If the result of the expansion is an empty string, or if the expansion
22598 is forced to fail, no action is taken. Other expansion failures are treated as
22599 errors and cause the delivery to be deferred.
22600 If an item ends in *, it will match any header with the given prefix.
22601
22602 Matching headers are omitted from the message as it is transported, as described
22603 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22604 routers.
22605
22606 Unlike most options, &%headers_remove%& can be specified multiple times
22607 for a transport; all listed headers are removed.
22608
22609 &*Warning*&: Because of the separate expansion of the list items,
22610 items that contain a list separator must have it doubled.
22611 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22612
22613
22614
22615 .option headers_rewrite transports string unset
22616 .cindex "transport" "header lines; rewriting"
22617 .cindex "rewriting" "at transport time"
22618 This option allows addresses in header lines to be rewritten at transport time,
22619 that is, as the message is being copied to its destination. The contents of the
22620 option are a colon-separated list of rewriting rules. Each rule is in exactly
22621 the same form as one of the general rewriting rules that are applied when a
22622 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22623 example,
22624 .code
22625 headers_rewrite = a@b c@d f : \
22626                   x@y w@z
22627 .endd
22628 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22629 &'w@z'& in all address-bearing header lines. The rules are applied to the
22630 header lines just before they are written out at transport time, so they affect
22631 only those copies of the message that pass through the transport. However, only
22632 the message's original header lines, and any that were added by a system
22633 filter, are rewritten. If a router or transport adds header lines, they are not
22634 affected by this option. These rewriting rules are &'not'& applied to the
22635 envelope. You can change the return path using &%return_path%&, but you cannot
22636 change envelope recipients at this time.
22637
22638
22639 .option home_directory transports string&!! unset
22640 .cindex "transport" "home directory for"
22641 .vindex "&$home$&"
22642 This option specifies a home directory setting for a local transport,
22643 overriding any value that may be set by the router. The home directory is
22644 placed in &$home$& while expanding the transport's private options. It is also
22645 used as the current directory if no current directory is set by the
22646 &%current_directory%& option on the transport or the
22647 &%transport_current_directory%& option on the router. If the expansion fails
22648 for any reason, including forced failure, an error is logged, and delivery is
22649 deferred.
22650
22651
22652 .option initgroups transports boolean false
22653 .cindex "additional groups"
22654 .cindex "groups" "additional"
22655 .cindex "transport" "group; additional"
22656 If this option is true and the uid for the delivery process is provided by the
22657 transport, the &[initgroups()]& function is called when running the transport
22658 to ensure that any additional groups associated with the uid are set up.
22659
22660
22661 .option max_parallel transports integer&!! unset
22662 .cindex limit "transport parallelism"
22663 .cindex transport "parallel processes"
22664 .cindex transport "concurrency limit"
22665 .cindex "delivery" "parallelism for transport"
22666 If this option is set and expands to an integer greater than zero
22667 it limits the number of concurrent runs of the transport.
22668 The control does not apply to shadow transports.
22669
22670 .cindex "hints database" "transport concurrency control"
22671 Exim implements this control by means of a hints database in which a record is
22672 incremented whenever a transport process is being created. The record
22673 is decremented and possibly removed when the process terminates.
22674 Obviously there is scope for
22675 records to get left lying around if there is a system or program crash. To
22676 guard against this, Exim ignores any records that are more than six hours old.
22677
22678 If you use this option, you should also arrange to delete the
22679 relevant hints database whenever your system reboots. The names of the files
22680 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22681 may be one or two files, depending on the type of DBM in use. The same files
22682 are used for ETRN and smtp transport serialization.
22683
22684
22685 .option message_size_limit transports string&!! 0
22686 .cindex "limit" "message size per transport"
22687 .cindex "size" "of message, limit"
22688 .cindex "transport" "message size; limiting"
22689 This option controls the size of messages passed through the transport. It is
22690 expanded before use; the result of the expansion must be a sequence of decimal
22691 digits, optionally followed by K or M. If the expansion fails for any reason,
22692 including forced failure, or if the result is not of the required form,
22693 delivery is deferred. If the value is greater than zero and the size of a
22694 message exceeds this limit, the address is failed. If there is any chance that
22695 the resulting bounce message could be routed to the same transport, you should
22696 ensure that &%return_size_limit%& is less than the transport's
22697 &%message_size_limit%&, as otherwise the bounce message will fail to get
22698 delivered.
22699
22700
22701
22702 .option rcpt_include_affixes transports boolean false
22703 .cindex "prefix" "for local part, including in envelope"
22704 .cindex "suffix for local part" "including in envelope"
22705 .cindex "local part" "prefix"
22706 .cindex "local part" "suffix"
22707 When this option is false (the default), and an address that has had any
22708 affixes (prefixes or suffixes) removed from the local part is delivered by any
22709 form of SMTP or LMTP, the affixes are not included. For example, if a router
22710 that contains
22711 .code
22712 local_part_prefix = *-
22713 .endd
22714 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22715 is delivered with
22716 .code
22717 RCPT TO:<xyz@some.domain>
22718 .endd
22719 This is also the case when an ACL-time callout is being used to verify a
22720 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22721 whole local part is included in the RCPT command. This option applies to BSMTP
22722 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22723 &(lmtp)& and &(smtp)& transports.
22724
22725
22726 .option retry_use_local_part transports boolean "see below"
22727 .cindex "hints database" "retry keys"
22728 When a delivery suffers a temporary failure, a retry record is created
22729 in Exim's hints database. For remote deliveries, the key for the retry record
22730 is based on the name and/or IP address of the failing remote host. For local
22731 deliveries, the key is normally the entire address, including both the local
22732 part and the domain. This is suitable for most common cases of local delivery
22733 temporary failure &-- for example, exceeding a mailbox quota should delay only
22734 deliveries to that mailbox, not to the whole domain.
22735
22736 However, in some special cases you may want to treat a temporary local delivery
22737 as a failure associated with the domain, and not with a particular local part.
22738 (For example, if you are storing all mail for some domain in files.) You can do
22739 this by setting &%retry_use_local_part%& false.
22740
22741 For all the local transports, its default value is true. For remote transports,
22742 the default value is false for tidiness, but changing the value has no effect
22743 on a remote transport in the current implementation.
22744
22745
22746 .option return_path transports string&!! unset
22747 .cindex "envelope sender"
22748 .cindex "envelope from"
22749 .cindex "transport" "return path; changing"
22750 .cindex "return path" "changing in transport"
22751 If this option is set, the string is expanded at transport time and replaces
22752 the existing return path (envelope sender) value in the copy of the message
22753 that is being delivered. An empty return path is permitted. This feature is
22754 designed for remote deliveries, where the value of this option is used in the
22755 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22756 only effect is to change the address that is placed in the &'Return-path:'&
22757 header line, if one is added to the message (see the next option).
22758
22759 &*Note:*& A changed return path is not logged unless you add
22760 &%return_path_on_delivery%& to the log selector.
22761
22762 .vindex "&$return_path$&"
22763 The expansion can refer to the existing value via &$return_path$&. This is
22764 either the message's envelope sender, or an address set by the
22765 &%errors_to%& option on a router. If the expansion is forced to fail, no
22766 replacement occurs; if it fails for another reason, delivery is deferred. This
22767 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22768 section &<<SECTverp>>&.
22769
22770 &*Note*&: If a delivery error is detected locally, including the case when a
22771 remote server rejects a message at SMTP time, the bounce message is not sent to
22772 the value of this option. It is sent to the previously set errors address.
22773 This defaults to the incoming sender address, but can be changed by setting
22774 &%errors_to%& in a router.
22775
22776
22777
22778 .option return_path_add transports boolean false
22779 .chindex Return-path:
22780 If this option is true, a &'Return-path:'& header is added to the message.
22781 Although the return path is normally available in the prefix line of BSD
22782 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22783 have easy access to it.
22784
22785 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22786 the delivery SMTP server makes the final delivery"&. This implies that this
22787 header should not be present in incoming messages. Exim has a configuration
22788 option, &%return_path_remove%&, which requests removal of this header from
22789 incoming messages, so that delivered messages can safely be resent to other
22790 recipients.
22791
22792
22793 .option shadow_condition transports string&!! unset
22794 See &%shadow_transport%& below.
22795
22796
22797 .option shadow_transport transports string unset
22798 .cindex "shadow transport"
22799 .cindex "transport" "shadow"
22800 A local transport may set the &%shadow_transport%& option to the name of
22801 another local transport. Shadow remote transports are not supported.
22802
22803 Whenever a delivery to the main transport succeeds, and either
22804 &%shadow_condition%& is unset, or its expansion does not result in the empty
22805 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22806 passed to the shadow transport, with the same delivery address or addresses. If
22807 expansion fails, no action is taken except that non-forced expansion failures
22808 cause a log line to be written.
22809
22810 The result of the shadow transport is discarded and does not affect the
22811 subsequent processing of the message. Only a single level of shadowing is
22812 provided; the &%shadow_transport%& option is ignored on any transport when it
22813 is running as a shadow. Options concerned with output from pipes are also
22814 ignored. The log line for the successful delivery has an item added on the end,
22815 of the form
22816 .code
22817 ST=<shadow transport name>
22818 .endd
22819 If the shadow transport did not succeed, the error message is put in
22820 parentheses afterwards. Shadow transports can be used for a number of different
22821 purposes, including keeping more detailed log information than Exim normally
22822 provides, and implementing automatic acknowledgment policies based on message
22823 headers that some sites insist on.
22824
22825
22826 .option transport_filter transports string&!! unset
22827 .cindex "transport" "filter"
22828 .cindex "filter" "transport filter"
22829 This option sets up a filtering (in the Unix shell sense) process for messages
22830 at transport time. It should not be confused with mail filtering as set up by
22831 individual users or via a system filter.
22832 If unset, or expanding to an empty string, no filtering is done.
22833
22834 When the message is about to be written out, the command specified by
22835 &%transport_filter%& is started up in a separate, parallel process, and
22836 the entire message, including the header lines, is passed to it on its standard
22837 input (this in fact is done from a third process, to avoid deadlock).
22838 The command must be specified as an absolute path.
22839
22840 The process run by the command must use its standard input as the message
22841 data to be transformed, and write the results on its standard output.
22842
22843 The lines of the message that are written to the transport filter are
22844 terminated by newline (&"\n"&). The message is passed to the filter before any
22845 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22846 lines beginning with a dot, and also before any processing implied by the
22847 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22848 &(pipe)& transports.
22849
22850 The standard error for the filter process is set to the same destination as its
22851 standard output; this is read and written to the message's ultimate
22852 destination. The process that writes the message to the filter, the
22853 filter itself, and the original process that reads the result and delivers it
22854 are all run in parallel, like a shell pipeline.
22855
22856 The filter can perform any transformations it likes, but of course should take
22857 care not to break RFC 2822 syntax. Exim does not check the result, except to
22858 test for a final newline when SMTP is in use. All messages transmitted over
22859 SMTP must end with a newline, so Exim supplies one if it is missing.
22860
22861 .cindex "content scanning" "per user"
22862 A transport filter can be used to provide content-scanning on a per-user basis
22863 at delivery time if the only required effect of the scan is to modify the
22864 message. For example, a content scan could insert a new header line containing
22865 a spam score. This could be interpreted by a filter in the user's MUA. It is
22866 not possible to discard a message at this stage.
22867
22868 .cindex "SIZE" "ESMTP extension"
22869 A problem might arise if the filter increases the size of a message that is
22870 being sent down an SMTP connection. If the receiving SMTP server has indicated
22871 support for the SIZE parameter, Exim will have sent the size of the message
22872 at the start of the SMTP session. If what is actually sent is substantially
22873 more, the server might reject the message. This can be worked round by setting
22874 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22875 additions to the message, or to disable the use of SIZE altogether.
22876
22877 .vindex "&$pipe_addresses$&"
22878 The value of the &%transport_filter%& option is the command string for starting
22879 the filter, which is run directly from Exim, not under a shell. The string is
22880 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22881 Exim breaks it up into arguments and then expands each argument separately (see
22882 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22883 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22884 of arguments, one for each address that applies to this delivery. (This isn't
22885 an ideal name for this feature here, but as it was already implemented for the
22886 &(pipe)& transport, it seemed sensible not to change it.)
22887
22888 .vindex "&$host$&"
22889 .vindex "&$host_address$&"
22890 The expansion variables &$host$& and &$host_address$& are available when the
22891 transport is a remote one. They contain the name and IP address of the host to
22892 which the message is being sent. For example:
22893 . used to have $sender_address in this cmdline, but it's tainted
22894 .code
22895 transport_filter = /some/directory/transport-filter.pl \
22896   $host $host_address $pipe_addresses
22897 .endd
22898
22899 Two problems arise if you want to use more complicated expansion items to
22900 generate transport filter commands, both of which due to the fact that the
22901 command is split up &'before'& expansion.
22902 .ilist
22903 If an expansion item contains white space, you must quote it, so that it is all
22904 part of the same command item. If the entire option setting is one such
22905 expansion item, you have to take care what kind of quoting you use. For
22906 example:
22907 .code
22908 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22909 .endd
22910 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22911 &(/bin/cmd2)& otherwise.
22912
22913 Option strings in general have any fully-surrounding double quote wrapping
22914 removed early in parsing (see &<<SECTstrings>>&).
22915 Then, for this option, quotes protect against whitespace being
22916 regarded as a separator while splitting into the command argument vector.
22917 Either double or single quotes can be used here;
22918 the former interprets backlash-quoted charachters
22919 and the latter does not.
22920
22921 If double quotes had been used in this example, they would have been
22922 stripped by Exim when it read the option's value. When the value is used, if
22923 the single quotes were missing, the line would be split into two items,
22924 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22925 Exim tried to expand the first one.
22926 .next
22927 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22928 expansion cannot generate multiple arguments, or a command name followed by
22929 arguments. Consider this example:
22930 .code
22931 transport_filter = ${lookup{$host}lsearch{/a/file}\
22932                     {$value}{/bin/cat}}
22933 .endd
22934 The result of the lookup is interpreted as the name of the command, even
22935 if it contains white space. The simplest way round this is to use a shell:
22936 .code
22937 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22938                                {$value}{/bin/cat}}
22939 .endd
22940 .endlist
22941
22942 The filter process is run under the same uid and gid as the normal delivery.
22943 For remote deliveries this is the Exim uid/gid by default. The command should
22944 normally yield a zero return code. Transport filters are not supposed to fail.
22945 A non-zero code is taken to mean that the transport filter encountered some
22946 serious problem. Delivery of the message is deferred; the message remains on
22947 the queue and is tried again later. It is not possible to cause a message to be
22948 bounced from a transport filter.
22949
22950 If a transport filter is set on an autoreply transport, the original message is
22951 passed through the filter as it is being copied into the newly generated
22952 message, which happens if the &%return_message%& option is set.
22953
22954
22955 .option transport_filter_timeout transports time 5m
22956 .cindex "transport" "filter, timeout"
22957 When Exim is reading the output of a transport filter, it applies a timeout
22958 that can be set by this option. Exceeding the timeout is normally treated as a
22959 temporary delivery failure. However, if a transport filter is used with a
22960 &(pipe)& transport, a timeout in the transport filter is treated in the same
22961 way as a timeout in the pipe command itself. By default, a timeout is a hard
22962 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22963 becomes a temporary error.
22964
22965
22966 .option user transports string&!! "Exim user"
22967 .cindex "uid (user id)" "local delivery"
22968 .cindex "transport" "user, specifying"
22969 This option specifies the user under whose uid the delivery process is to be
22970 run, overriding any uid that may have been set by the router. If the user is
22971 given as a name, the uid is looked up from the password data, and the
22972 associated group is taken as the value of the gid to be used if the &%group%&
22973 option is not set.
22974
22975 For deliveries that use local transports, a user and group are normally
22976 specified explicitly or implicitly (for example, as a result of
22977 &%check_local_user%&) by the router or transport.
22978
22979 .cindex "hints database" "access by remote transport"
22980 For remote transports, you should leave this option unset unless you really are
22981 sure you know what you are doing. When a remote transport is running, it needs
22982 to be able to access Exim's hints databases, because each host may have its own
22983 retry data.
22984 .ecindex IIDgenoptra1
22985 .ecindex IIDgenoptra2
22986 .ecindex IIDgenoptra3
22987
22988
22989
22990
22991
22992
22993 . ////////////////////////////////////////////////////////////////////////////
22994 . ////////////////////////////////////////////////////////////////////////////
22995
22996 .chapter "Address batching in local transports" "CHAPbatching" &&&
22997          "Address batching"
22998 .cindex "transport" "local; address batching in"
22999 The only remote transport (&(smtp)&) is normally configured to handle more than
23000 one address at a time, so that when several addresses are routed to the same
23001 remote host, just one copy of the message is sent. Local transports, however,
23002 normally handle one address at a time. That is, a separate instance of the
23003 transport is run for each address that is routed to the transport. A separate
23004 copy of the message is delivered each time.
23005
23006 .cindex "batched local delivery"
23007 .oindex "&%batch_max%&"
23008 .oindex "&%batch_id%&"
23009 In special cases, it may be desirable to handle several addresses at once in a
23010 local transport, for example:
23011
23012 .ilist
23013 In an &(appendfile)& transport, when storing messages in files for later
23014 delivery by some other means, a single copy of the message with multiple
23015 recipients saves space.
23016 .next
23017 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
23018 a single copy saves time, and is the normal way LMTP is expected to work.
23019 .next
23020 In a &(pipe)& transport, when passing the message
23021 to a scanner program or
23022 to some other delivery mechanism such as UUCP, multiple recipients may be
23023 acceptable.
23024 .endlist
23025
23026 These three local transports all have the same options for controlling multiple
23027 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
23028 repeating the information for each transport, these options are described here.
23029
23030 The &%batch_max%& option specifies the maximum number of addresses that can be
23031 delivered together in a single run of the transport. Its default value is one
23032 (no batching). When more than one address is routed to a transport that has a
23033 &%batch_max%& value greater than one, the addresses are delivered in a batch
23034 (that is, in a single run of the transport with multiple recipients), subject
23035 to certain conditions:
23036
23037 .ilist
23038 .vindex "&$local_part$&"
23039 If any of the transport's options contain a reference to &$local_part$&, no
23040 batching is possible.
23041 .next
23042 .vindex "&$domain$&"
23043 If any of the transport's options contain a reference to &$domain$&, only
23044 addresses with the same domain are batched.
23045 .next
23046 .cindex "customizing" "batching condition"
23047 If &%batch_id%& is set, it is expanded for each address, and only those
23048 addresses with the same expanded value are batched. This allows you to specify
23049 customized batching conditions. Failure of the expansion for any reason,
23050 including forced failure, disables batching, but it does not stop the delivery
23051 from taking place.
23052 .next
23053 Batched addresses must also have the same errors address (where to send
23054 delivery errors), the same header additions and removals, the same user and
23055 group for the transport, and if a host list is present, the first host must
23056 be the same.
23057 .endlist
23058
23059 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23060 both when the file or pipe command is specified in the transport, and when it
23061 is specified by a &(redirect)& router, but all the batched addresses must of
23062 course be routed to the same file or pipe command. These two transports have an
23063 option called &%use_bsmtp%&, which causes them to deliver the message in
23064 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23065 &%check_string%& and &%escape_string%& options are forced to the values
23066 .code
23067 check_string = "."
23068 escape_string = ".."
23069 .endd
23070 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23071 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23072 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23073
23074 .cindex "&'Envelope-to:'& header line"
23075 If the generic &%envelope_to_add%& option is set for a batching transport, the
23076 &'Envelope-to:'& header that is added to the message contains all the addresses
23077 that are being processed together. If you are using a batching &(appendfile)&
23078 transport without &%use_bsmtp%&, the only way to preserve the recipient
23079 addresses is to set the &%envelope_to_add%& option.
23080
23081 .cindex "&(pipe)& transport" "with multiple addresses"
23082 .vindex "&$pipe_addresses$&"
23083 If you are using a &(pipe)& transport without BSMTP, and setting the
23084 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23085 the command. This is not a true variable; it is a bit of magic that causes each
23086 of the recipient addresses to be inserted into the command as a separate
23087 argument. This provides a way of accessing all the addresses that are being
23088 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23089 are specified by a &(redirect)& router.
23090
23091
23092
23093
23094 . ////////////////////////////////////////////////////////////////////////////
23095 . ////////////////////////////////////////////////////////////////////////////
23096
23097 .chapter "The appendfile transport" "CHAPappendfile"
23098 .scindex IIDapptra1 "&(appendfile)& transport"
23099 .scindex IIDapptra2 "transports" "&(appendfile)&"
23100 .cindex "directory creation"
23101 .cindex "creating directories"
23102 The &(appendfile)& transport delivers a message by appending it to an existing
23103 file, or by creating an entirely new file in a specified directory. Single
23104 files to which messages are appended can be in the traditional Unix mailbox
23105 format, or optionally in the MBX format supported by the Pine MUA and
23106 University of Washington IMAP daemon, &'inter alia'&. When each message is
23107 being delivered as a separate file, &"maildir"& format can optionally be used
23108 to give added protection against failures that happen part-way through the
23109 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23110 supported. For all file formats, Exim attempts to create as many levels of
23111 directory as necessary, provided that &%create_directory%& is set.
23112
23113 The code for the optional formats is not included in the Exim binary by
23114 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23115 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23116 included.
23117
23118 .cindex "quota" "system"
23119 Exim recognizes system quota errors, and generates an appropriate message. Exim
23120 also supports its own quota control within the transport, for use when the
23121 system facility is unavailable or cannot be used for some reason.
23122
23123 If there is an error while appending to a file (for example, quota exceeded or
23124 partition filled), Exim attempts to reset the file's length and last
23125 modification time back to what they were before. If there is an error while
23126 creating an entirely new file, the new file is removed.
23127
23128 Before appending to a file, a number of security checks are made, and the
23129 file is locked. A detailed description is given below, after the list of
23130 private options.
23131
23132 The &(appendfile)& transport is most commonly used for local deliveries to
23133 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23134 putting messages into files for remote delivery by some means other than Exim.
23135 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23136 option).
23137
23138
23139
23140 .section "The file and directory options" "SECTfildiropt"
23141 The &%file%& option specifies a single file, to which the message is appended;
23142 the &%directory%& option specifies a directory, in which a new file containing
23143 the message is created. Only one of these two options can be set, and for
23144 normal deliveries to mailboxes, one of them &'must'& be set.
23145
23146 .vindex "&$address_file$&"
23147 .vindex "&$local_part$&"
23148 However, &(appendfile)& is also used for delivering messages to files or
23149 directories whose names (or parts of names) are obtained from alias,
23150 forwarding, or filtering operations (for example, a &%save%& command in a
23151 user's Exim filter). When such a transport is running, &$local_part$& contains
23152 the local part that was aliased or forwarded, and &$address_file$& contains the
23153 name (or partial name) of the file or directory generated by the redirection
23154 operation. There are two cases:
23155
23156 .ilist
23157 If neither &%file%& nor &%directory%& is set, the redirection operation
23158 must specify an absolute path (one that begins with &`/`&). This is the most
23159 common case when users with local accounts use filtering to sort mail into
23160 different folders. See for example, the &(address_file)& transport in the
23161 default configuration. If the path ends with a slash, it is assumed to be the
23162 name of a directory. A delivery to a directory can also be forced by setting
23163 &%maildir_format%& or &%mailstore_format%&.
23164 .next
23165 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23166 used to determine the file or directory name for the delivery. Normally, the
23167 contents of &$address_file$& are used in some way in the string expansion.
23168 .endlist
23169 If the &%create_file%& option is set to a path which
23170 matches (see the option definition below for details)
23171 a file or directory name
23172 for the delivery, that name becomes de-tainted.
23173
23174 .cindex "tainted data" "in filenames"
23175 .cindex appendfile "tainted data"
23176 Tainted data may not be used for a file or directory name.
23177 This means that, for instance, &$local_part$& cannot be used directly
23178 as a component of a path.  It can however be used as the key for a lookup
23179 which returns a path (or component).
23180
23181
23182 .cindex "Sieve filter" "configuring &(appendfile)&"
23183 .cindex "Sieve filter" "relative mailbox path handling"
23184 As an example of the second case, consider an environment where users do not
23185 have home directories. They may be permitted to use Exim filter commands of the
23186 form:
23187 .code
23188 save folder23
23189 .endd
23190 or Sieve filter commands of the form:
23191 .code
23192 require "fileinto";
23193 fileinto "folder23";
23194 .endd
23195 In this situation, the expansion of &%file%& or &%directory%& in the transport
23196 must transform the relative path into an appropriate absolute filename. In the
23197 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23198 is used as a result of a &"keep"& action in the filter. This example shows one
23199 way of handling this requirement:
23200 .code
23201 file = ${if eq{$address_file}{inbox} \
23202             {/var/mail/$local_part_data} \
23203             {${if eq{${substr_0_1:$address_file}}{/} \
23204                   {$address_file} \
23205                   {$home/mail/$address_file} \
23206             }} \
23207        }
23208 .endd
23209 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23210 location, absolute paths are used without change, and other folders are in the
23211 &_mail_& directory within the home directory.
23212
23213 &*Note 1*&: While processing an Exim filter, a relative path such as
23214 &_folder23_& is turned into an absolute path if a home directory is known to
23215 the router. In particular, this is the case if &%check_local_user%& is set. If
23216 you want to prevent this happening at routing time, you can set
23217 &%router_home_directory%& empty. This forces the router to pass the relative
23218 path to the transport.
23219
23220 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23221 the &%file%& or &%directory%& option is still used if it is set.
23222
23223
23224
23225
23226 .section "Private options for appendfile" "SECID134"
23227 .cindex "options" "&(appendfile)& transport"
23228
23229
23230
23231 .option allow_fifo appendfile boolean false
23232 .cindex "fifo (named pipe)"
23233 .cindex "named pipe (fifo)"
23234 .cindex "pipe" "named (fifo)"
23235 Setting this option permits delivery to named pipes (FIFOs) as well as to
23236 regular files. If no process is reading the named pipe at delivery time, the
23237 delivery is deferred.
23238
23239
23240 .option allow_symlink appendfile boolean false
23241 .cindex "symbolic link" "to mailbox"
23242 .cindex "mailbox" "symbolic link"
23243 By default, &(appendfile)& will not deliver if the path name for the file is
23244 that of a symbolic link. Setting this option relaxes that constraint, but there
23245 are security issues involved in the use of symbolic links. Be sure you know
23246 what you are doing if you set this. Details of exactly what this option affects
23247 are included in the discussion which follows this list of options.
23248
23249
23250 .option batch_id appendfile string&!! unset
23251 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23252 However, batching is automatically disabled for &(appendfile)& deliveries that
23253 happen as a result of forwarding or aliasing or other redirection directly to a
23254 file.
23255
23256
23257 .option batch_max appendfile integer 1
23258 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23259
23260
23261 .option check_group appendfile boolean false
23262 When this option is set, the group owner of the file defined by the &%file%&
23263 option is checked to see that it is the same as the group under which the
23264 delivery process is running. The default setting is false because the default
23265 file mode is 0600, which means that the group is irrelevant.
23266
23267
23268 .option check_owner appendfile boolean true
23269 When this option is set, the owner of the file defined by the &%file%& option
23270 is checked to ensure that it is the same as the user under which the delivery
23271 process is running.
23272
23273
23274 .option check_string appendfile string "see below"
23275 .cindex "&""From""& line"
23276 As &(appendfile)& writes the message, the start of each line is tested for
23277 matching &%check_string%&, and if it does, the initial matching characters are
23278 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23279 a literal string, not a regular expression, and the case of any letters it
23280 contains is significant.
23281
23282 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23283 are forced to &"."& and &".."& respectively, and any settings in the
23284 configuration are ignored. Otherwise, they default to &"From&~"& and
23285 &">From&~"& when the &%file%& option is set, and unset when any of the
23286 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23287
23288 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23289 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23290 &"From&~"& indicates the start of a new message. All four options need changing
23291 if another format is used. For example, to deliver to mailboxes in MMDF format:
23292 .cindex "MMDF format mailbox"
23293 .cindex "mailbox" "MMDF format"
23294 .code
23295 check_string = "\1\1\1\1\n"
23296 escape_string = "\1\1\1\1 \n"
23297 message_prefix = "\1\1\1\1\n"
23298 message_suffix = "\1\1\1\1\n"
23299 .endd
23300 .option create_directory appendfile boolean true
23301 .cindex "directory creation"
23302 When this option is true, Exim attempts to create any missing superior
23303 directories for the file that it is about to write. A created directory's mode
23304 is given by the &%directory_mode%& option.
23305
23306 The group ownership of a newly created directory is highly dependent on the
23307 operating system (and possibly the file system) that is being used. For
23308 example, in Solaris, if the parent directory has the setgid bit set, its group
23309 is propagated to the child; if not, the currently set group is used. However,
23310 in FreeBSD, the parent's group is always used.
23311
23312
23313
23314 .option create_file appendfile string anywhere
23315 This option constrains the location of files and directories that are created
23316 by this transport. It applies to files defined by the &%file%& option and
23317 directories defined by the &%directory%& option. In the case of maildir
23318 delivery, it applies to the top level directory, not the maildir directories
23319 beneath.
23320
23321 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23322 &"belowhome"&, or to an absolute path.
23323
23324 In the second and third cases, a home directory must have been
23325 set for the transport, and the file or directory being created must
23326 reside within it.
23327 The "belowhome" checking additionally checks for attempts to use "../"
23328 to evade the testing.
23329 This option is not useful when an explicit filename is
23330 given for normal mailbox deliveries. It is intended for the case when filenames
23331 are generated from users' &_.forward_& files. These are usually handled
23332 by an &(appendfile)& transport called &%address_file%&. See also
23333 &%file_must_exist%&.
23334
23335 In the fourth case,
23336 the value given for this option must be an absolute path for an
23337 existing directory.
23338 The value is used for checking instead of a home directory;
23339 checking is done in "belowhome" mode.
23340
23341 .cindex "tainted data" "de-tainting"
23342 .cindex "de-tainting" "using appendfile create_file option"
23343 If "belowhome" checking is used, the file or directory path
23344 becomes de-tainted.
23345
23346
23347 .option directory appendfile string&!! unset
23348 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23349 or &%directory%& must be set, unless the delivery is the direct result of a
23350 redirection (see section &<<SECTfildiropt>>&).
23351
23352 When &%directory%& is set, the string is expanded, and the message is delivered
23353 into a new file or files in or below the given directory, instead of being
23354 appended to a single mailbox file. A number of different formats are provided
23355 (see &%maildir_format%& and &%mailstore_format%&), and see section
23356 &<<SECTopdir>>& for further details of this form of delivery.
23357
23358 The result of expansion must not be tainted, unless the &%create_file%& option
23359 specifies a path.
23360
23361
23362 .option directory_file appendfile string&!! "see below"
23363 .cindex "base62"
23364 .vindex "&$inode$&"
23365 When &%directory%& is set, but neither &%maildir_format%& nor
23366 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23367 whose name is obtained by expanding this string. The default value is:
23368 .code
23369 q${base62:$tod_epoch}-$inode
23370 .endd
23371 This generates a unique name from the current time, in base 62 form, and the
23372 inode of the file. The variable &$inode$& is available only when expanding this
23373 option.
23374
23375
23376 .option directory_mode appendfile "octal integer" 0700
23377 If &(appendfile)& creates any directories as a result of the
23378 &%create_directory%& option, their mode is specified by this option.
23379
23380
23381 .option escape_string appendfile string "see description"
23382 See &%check_string%& above.
23383
23384
23385 .option file appendfile string&!! unset
23386 This option is mutually exclusive with the &%directory%& option, but one of
23387 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23388 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23389 specifies a single file, to which the message is appended. One or more of
23390 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23391 &%file%&.
23392
23393 The result of expansion must not be tainted, unless the &%create_file%& option
23394 specifies a path.
23395
23396 .cindex "NFS" "lock file"
23397 .cindex "locking files"
23398 .cindex "lock files"
23399 If you are using more than one host to deliver over NFS into the same
23400 mailboxes, you should always use lock files.
23401
23402 The string value is expanded for each delivery, and must yield an absolute
23403 path. The most common settings of this option are variations on one of these
23404 examples:
23405 .code
23406 file = /var/spool/mail/$local_part_data
23407 file = /home/$local_part_data/inbox
23408 file = $home/inbox
23409 .endd
23410 .cindex "&""sticky""& bit"
23411 In the first example, all deliveries are done into the same directory. If Exim
23412 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23413 create a file in the directory, so the &"sticky"& bit must be turned on for
23414 deliveries to be possible, or alternatively the &%group%& option can be used to
23415 run the delivery under a group id which has write access to the directory.
23416
23417
23418
23419 .option file_format appendfile string unset
23420 .cindex "file" "mailbox; checking existing format"
23421 This option requests the transport to check the format of an existing file
23422 before adding to it. The check consists of matching a specific string at the
23423 start of the file. The value of the option consists of an even number of
23424 colon-separated strings. The first of each pair is the test string, and the
23425 second is the name of a transport. If the transport associated with a matched
23426 string is not the current transport, control is passed over to the other
23427 transport. For example, suppose the standard &(local_delivery)& transport has
23428 this added to it:
23429 .code
23430 file_format = "From       : local_delivery :\
23431                \1\1\1\1\n : local_mmdf_delivery"
23432 .endd
23433 Mailboxes that begin with &"From"& are still handled by this transport, but if
23434 a mailbox begins with four binary ones followed by a newline, control is passed
23435 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23436 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23437 is assumed to match the current transport. If the start of a mailbox doesn't
23438 match any string, or if the transport named for a given string is not defined,
23439 delivery is deferred.
23440
23441
23442 .option file_must_exist appendfile boolean false
23443 If this option is true, the file specified by the &%file%& option must exist.
23444 A temporary error occurs if it does not, causing delivery to be deferred.
23445 If this option is false, the file is created if it does not exist.
23446
23447
23448 .option lock_fcntl_timeout appendfile time 0s
23449 .cindex "timeout" "mailbox locking"
23450 .cindex "mailbox" "locking, blocking and non-blocking"
23451 .cindex "locking files"
23452 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23453 when locking an open mailbox file. If the call fails, the delivery process
23454 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23455 Non-blocking calls are used so that the file is not kept open during the wait
23456 for the lock; the reason for this is to make it as safe as possible for
23457 deliveries over NFS in the case when processes might be accessing an NFS
23458 mailbox without using a lock file. This should not be done, but
23459 misunderstandings and hence misconfigurations are not unknown.
23460
23461 On a busy system, however, the performance of a non-blocking lock approach is
23462 not as good as using a blocking lock with a timeout. In this case, the waiting
23463 is done inside the system call, and Exim's delivery process acquires the lock
23464 and can proceed as soon as the previous lock holder releases it.
23465
23466 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23467 timeout, are used. There may still be some retrying: the maximum number of
23468 retries is
23469 .code
23470 (lock_retries * lock_interval) / lock_fcntl_timeout
23471 .endd
23472 rounded up to the next whole number. In other words, the total time during
23473 which &(appendfile)& is trying to get a lock is roughly the same, unless
23474 &%lock_fcntl_timeout%& is set very large.
23475
23476 You should consider setting this option if you are getting a lot of delayed
23477 local deliveries because of errors of the form
23478 .code
23479 failed to lock mailbox /some/file (fcntl)
23480 .endd
23481
23482 .option lock_flock_timeout appendfile time 0s
23483 This timeout applies to file locking when using &[flock()]& (see
23484 &%use_flock%&); the timeout operates in a similar manner to
23485 &%lock_fcntl_timeout%&.
23486
23487
23488 .option lock_interval appendfile time 3s
23489 This specifies the time to wait between attempts to lock the file. See below
23490 for details of locking.
23491
23492
23493 .option lock_retries appendfile integer 10
23494 This specifies the maximum number of attempts to lock the file. A value of zero
23495 is treated as 1. See below for details of locking.
23496
23497
23498 .option lockfile_mode appendfile "octal integer" 0600
23499 This specifies the mode of the created lock file, when a lock file is being
23500 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23501
23502
23503 .option lockfile_timeout appendfile time 30m
23504 .cindex "timeout" "mailbox locking"
23505 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23506 exists and is older than this value, it is assumed to have been left behind by
23507 accident, and Exim attempts to remove it.
23508
23509
23510 .option mailbox_filecount appendfile string&!! unset
23511 .cindex "mailbox" "specifying size of"
23512 .cindex "size" "of mailbox"
23513 If this option is set, it is expanded, and the result is taken as the current
23514 number of files in the mailbox. It must be a decimal number, optionally
23515 followed by K or M. This provides a way of obtaining this information from an
23516 external source that maintains the data.
23517
23518
23519 .option mailbox_size appendfile string&!! unset
23520 .cindex "mailbox" "specifying size of"
23521 .cindex "size" "of mailbox"
23522 If this option is set, it is expanded, and the result is taken as the current
23523 size the mailbox. It must be a decimal number, optionally followed by K or M.
23524 This provides a way of obtaining this information from an external source that
23525 maintains the data. This is likely to be helpful for maildir deliveries where
23526 it is computationally expensive to compute the size of a mailbox.
23527
23528
23529
23530 .option maildir_format appendfile boolean false
23531 .cindex "maildir format" "specifying"
23532 If this option is set with the &%directory%& option, the delivery is into a new
23533 file, in the &"maildir"& format that is used by other mail software. When the
23534 transport is activated directly from a &(redirect)& router (for example, the
23535 &(address_file)& transport in the default configuration), setting
23536 &%maildir_format%& causes the path received from the router to be treated as a
23537 directory, whether or not it ends with &`/`&. This option is available only if
23538 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23539 &<<SECTmaildirdelivery>>& below for further details.
23540
23541
23542 .option maildir_quota_directory_regex appendfile string "See below"
23543 .cindex "maildir format" "quota; directories included in"
23544 .cindex "quota" "maildir; directories included in"
23545 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23546 a regular expression for specifying directories, relative to the quota
23547 directory (see &%quota_directory%&), that should be included in the quota
23548 calculation. The default value is:
23549 .code
23550 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23551 .endd
23552 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23553 (directories whose names begin with a dot). If you want to exclude the
23554 &_Trash_&
23555 folder from the count (as some sites do), you need to change this setting to
23556 .code
23557 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23558 .endd
23559 This uses a negative lookahead in the regular expression to exclude the
23560 directory whose name is &_.Trash_&. When a directory is excluded from quota
23561 calculations, quota processing is bypassed for any messages that are delivered
23562 directly into that directory.
23563
23564
23565 .option maildir_retries appendfile integer 10
23566 This option specifies the number of times to retry when writing a file in
23567 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23568
23569
23570 .option maildir_tag appendfile string&!! unset
23571 This option applies only to deliveries in maildir format, and is described in
23572 section &<<SECTmaildirdelivery>>& below.
23573
23574
23575 .option maildir_use_size_file appendfile&!! boolean false
23576 .cindex "maildir format" "&_maildirsize_& file"
23577 The result of string expansion for this option must be a valid boolean value.
23578 If it is true, it enables support for &_maildirsize_& files. Exim
23579 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23580 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23581 value is zero. See &%maildir_quota_directory_regex%& above and section
23582 &<<SECTmaildirdelivery>>& below for further details.
23583
23584 .option maildirfolder_create_regex appendfile string unset
23585 .cindex "maildir format" "&_maildirfolder_& file"
23586 .cindex "&_maildirfolder_&, creating"
23587 The value of this option is a regular expression. If it is unset, it has no
23588 effect. Otherwise, before a maildir delivery takes place, the pattern is
23589 matched against the name of the maildir directory, that is, the directory
23590 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23591 delivery. If there is a match, Exim checks for the existence of a file called
23592 &_maildirfolder_& in the directory, and creates it if it does not exist.
23593 See section &<<SECTmaildirdelivery>>& for more details.
23594
23595
23596 .option mailstore_format appendfile boolean false
23597 .cindex "mailstore format" "specifying"
23598 If this option is set with the &%directory%& option, the delivery is into two
23599 new files in  &"mailstore"& format. The option is available only if
23600 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23601 below for further details.
23602
23603
23604 .option mailstore_prefix appendfile string&!! unset
23605 This option applies only to deliveries in mailstore format, and is described in
23606 section &<<SECTopdir>>& below.
23607
23608
23609 .option mailstore_suffix appendfile string&!! unset
23610 This option applies only to deliveries in mailstore format, and is described in
23611 section &<<SECTopdir>>& below.
23612
23613
23614 .option mbx_format appendfile boolean false
23615 .cindex "locking files"
23616 .cindex "file" "locking"
23617 .cindex "file" "MBX format"
23618 .cindex "MBX format, specifying"
23619 This option is available only if Exim has been compiled with SUPPORT_MBX
23620 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23621 the message is appended to the mailbox file in MBX format instead of
23622 traditional Unix format. This format is supported by Pine4 and its associated
23623 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23624
23625 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23626 automatically changed by the use of &%mbx_format%&. They should normally be set
23627 empty when using MBX format, so this option almost always appears in this
23628 combination:
23629 .code
23630 mbx_format = true
23631 message_prefix =
23632 message_suffix =
23633 .endd
23634 If none of the locking options are mentioned in the configuration,
23635 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23636 is possible to specify the other kinds of locking with &%mbx_format%&, but
23637 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23638 interworks with &'c-client'&, providing for shared access to the mailbox. It
23639 should not be used if any program that does not use this form of locking is
23640 going to access the mailbox, nor should it be used if the mailbox file is NFS
23641 mounted, because it works only when the mailbox is accessed from a single host.
23642
23643 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23644 the standard version of &'c-client'&, because as long as it has a mailbox open
23645 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23646 append messages to it.
23647
23648
23649 .option message_prefix appendfile string&!! "see below"
23650 .cindex "&""From""& line"
23651 The string specified here is expanded and output at the start of every message.
23652 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23653 in which case it is:
23654 .code
23655 message_prefix = "From ${if def:return_path{$return_path}\
23656   {MAILER-DAEMON}} $tod_bsdinbox\n"
23657 .endd
23658 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23659 &`\n`& to &`\r\n`& in &%message_prefix%&.
23660
23661 .option message_suffix appendfile string&!! "see below"
23662 The string specified here is expanded and output at the end of every message.
23663 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23664 in which case it is a single newline character. The suffix can be suppressed by
23665 setting
23666 .code
23667 message_suffix =
23668 .endd
23669 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23670 &`\n`& to &`\r\n`& in &%message_suffix%&.
23671
23672 .option mode appendfile "octal integer" 0600
23673 If the output file is created, it is given this mode. If it already exists and
23674 has wider permissions, they are reduced to this mode. If it has narrower
23675 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23676 if the delivery is the result of a &%save%& command in a filter file specifying
23677 a particular mode, the mode of the output file is always forced to take that
23678 value, and this option is ignored.
23679
23680
23681 .option mode_fail_narrower appendfile boolean true
23682 This option applies in the case when an existing mailbox file has a narrower
23683 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23684 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23685 continues with the delivery attempt, using the existing mode of the file.
23686
23687
23688 .option notify_comsat appendfile boolean false
23689 If this option is true, the &'comsat'& daemon is notified after every
23690 successful delivery to a user mailbox. This is the daemon that notifies logged
23691 on users about incoming mail.
23692
23693
23694 .option quota appendfile string&!! unset
23695 .cindex "quota" "imposed by Exim"
23696 This option imposes a limit on the size of the file to which Exim is appending,
23697 or to the total space used in the directory tree when the &%directory%& option
23698 is set. In the latter case, computation of the space used is expensive, because
23699 all the files in the directory (and any sub-directories) have to be
23700 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23701 &%maildir_use_size_file%& for ways to avoid this in environments where users
23702 have no shell access to their mailboxes).
23703
23704 As there is no interlock against two simultaneous deliveries into a
23705 multi-file mailbox, it is possible for the quota to be overrun in this case.
23706 For single-file mailboxes, of course, an interlock is a necessity.
23707
23708 A file's size is taken as its &'used'& value. Because of blocking effects, this
23709 may be a lot less than the actual amount of disk space allocated to the file.
23710 If the sizes of a number of files are being added up, the rounding effect can
23711 become quite noticeable, especially on systems that have large block sizes.
23712 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23713 the obvious value which users understand most easily.
23714
23715 The value of the option is expanded, and must then be a numerical value
23716 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23717 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23718 and further option modifiers. If Exim is running on a system with
23719 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23720 be handled.
23721
23722 The option modifier &%no_check%& can be used to force delivery even if the over
23723 quota condition is met. The quota gets updated as usual.
23724
23725 &*Note*&: A value of zero is interpreted as &"no quota"&.
23726
23727 The expansion happens while Exim is running as root, before it changes uid for
23728 the delivery. This means that files that are inaccessible to the end user can
23729 be used to hold quota values that are looked up in the expansion. When delivery
23730 fails because this quota is exceeded, the handling of the error is as for
23731 system quota failures.
23732
23733 By default, Exim's quota checking mimics system quotas, and restricts the
23734 mailbox to the specified maximum size, though the value is not accurate to the
23735 last byte, owing to separator lines and additional headers that may get added
23736 during message delivery. When a mailbox is nearly full, large messages may get
23737 refused even though small ones are accepted, because the size of the current
23738 message is added to the quota when the check is made. This behaviour can be
23739 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23740 for exceeding the quota does not include the current message. Thus, deliveries
23741 continue until the quota has been exceeded; thereafter, no further messages are
23742 delivered. See also &%quota_warn_threshold%&.
23743
23744
23745 .option quota_directory appendfile string&!! unset
23746 This option defines the directory to check for quota purposes when delivering
23747 into individual files. The default is the delivery directory, or, if a file
23748 called &_maildirfolder_& exists in a maildir directory, the parent of the
23749 delivery directory.
23750
23751
23752 .option quota_filecount appendfile string&!! 0
23753 This option applies when the &%directory%& option is set. It limits the total
23754 number of files in the directory (compare the inode limit in system quotas). It
23755 can only be used if &%quota%& is also set. The value is expanded; an expansion
23756 failure causes delivery to be deferred. A value of zero is interpreted as
23757 &"no quota"&.
23758
23759 The option modifier &%no_check%& can be used to force delivery even if the over
23760 quota condition is met. The quota gets updated as usual.
23761
23762 .option quota_is_inclusive appendfile boolean true
23763 See &%quota%& above.
23764
23765
23766 .option quota_size_regex appendfile string unset
23767 This option applies when one of the delivery modes that writes a separate file
23768 for each message is being used. When Exim wants to find the size of one of
23769 these files in order to test the quota, it first checks &%quota_size_regex%&.
23770 If this is set to a regular expression that matches the filename, and it
23771 captures one string, that string is interpreted as a representation of the
23772 file's size. The value of &%quota_size_regex%& is not expanded.
23773
23774 This feature is useful only when users have no shell access to their mailboxes
23775 &-- otherwise they could defeat the quota simply by renaming the files. This
23776 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23777 the file length to the filename. For example:
23778 .code
23779 maildir_tag = ,S=$message_size
23780 quota_size_regex = ,S=(\d+)
23781 .endd
23782 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23783 number of lines in the message.
23784
23785 The regular expression should not assume that the length is at the end of the
23786 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23787 sometimes add other information onto the ends of message filenames.
23788
23789 Section &<<SECID136>>& contains further information.
23790
23791 This option should not be used when other message-handling software
23792 may duplicate messages by making hardlinks to the files.  When that is done Exim
23793 will count the message size once for each filename, in contrast with the actual
23794 disk usage.  When the option is not set, calculating total usage requires
23795 a system-call per file to get the size; the number of links is then available also
23796 as is used to adjust the effective size.
23797
23798
23799 .option quota_warn_message appendfile string&!! "see below"
23800 See below for the use of this option. If it is not set when
23801 &%quota_warn_threshold%& is set, it defaults to
23802 .code
23803 quota_warn_message = "\
23804   To: $local_part@$domain\n\
23805   Subject: Your mailbox\n\n\
23806   This message is automatically created \
23807   by mail delivery software.\n\n\
23808   The size of your mailbox has exceeded \
23809   a warning threshold that is\n\
23810   set by the system administrator.\n"
23811 .endd
23812
23813
23814 .option quota_warn_threshold appendfile string&!! 0
23815 .cindex "quota" "warning threshold"
23816 .cindex "mailbox" "size warning"
23817 .cindex "size" "of mailbox"
23818 This option is expanded in the same way as &%quota%& (see above). If the
23819 resulting value is greater than zero, and delivery of the message causes the
23820 size of the file or total space in the directory tree to cross the given
23821 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23822 may be specified as a percentage of it by following the value with a percent
23823 sign. For example:
23824 .code
23825 quota = 10M
23826 quota_warn_threshold = 75%
23827 .endd
23828 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23829 percent sign is ignored.
23830
23831 The warning message itself is specified by the &%quota_warn_message%& option,
23832 and it must start with a &'To:'& header line containing the recipient(s) of the
23833 warning message. These do not necessarily have to include the recipient(s) of
23834 the original message. A &'Subject:'& line should also normally be supplied. You
23835 can include any other header lines that you want. If you do not include a
23836 &'From:'& line, the default is:
23837 .code
23838 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23839 .endd
23840 .oindex &%errors_reply_to%&
23841 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23842 option.
23843
23844 The &%quota%& option does not have to be set in order to use this option; they
23845 are independent of one another except when the threshold is specified as a
23846 percentage.
23847
23848
23849 .option use_bsmtp appendfile boolean false
23850 .cindex "envelope from"
23851 .cindex "envelope sender"
23852 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23853 format, with the envelope sender and recipient(s) included as SMTP commands. If
23854 you want to include a leading HELO command with such messages, you can do
23855 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23856 for details of batch SMTP.
23857
23858
23859 .option use_crlf appendfile boolean false
23860 .cindex "carriage return"
23861 .cindex "linefeed"
23862 This option causes lines to be terminated with the two-character CRLF sequence
23863 (carriage return, linefeed) instead of just a linefeed character. In the case
23864 of batched SMTP, the byte sequence written to the file is then an exact image
23865 of what would be sent down a real SMTP connection.
23866
23867 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23868 (which are used to supply the traditional &"From&~"& and blank line separators
23869 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23870 carriage return characters if these are needed. In cases where these options
23871 have non-empty defaults, the values end with a single linefeed, so they must be
23872 changed to end with &`\r\n`& if &%use_crlf%& is set.
23873
23874
23875 .option use_fcntl_lock appendfile boolean "see below"
23876 This option controls the use of the &[fcntl()]& function to lock a file for
23877 exclusive use when a message is being appended. It is set by default unless
23878 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23879 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23880 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23881
23882
23883 .option use_flock_lock appendfile boolean false
23884 This option is provided to support the use of &[flock()]& for file locking, for
23885 the few situations where it is needed. Most modern operating systems support
23886 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23887 each other. Exim uses &[fcntl()]& locking by default.
23888
23889 This option is required only if you are using an operating system where
23890 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23891 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23892 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23893
23894 .cindex "Solaris" "&[flock()]& support"
23895 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23896 have it (and some, I think, provide a not quite right version built on top of
23897 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23898 the ability to use it, and any attempt to do so will cause a configuration
23899 error.
23900
23901 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23902 is just being mapped onto &[fcntl()]& by the OS).
23903
23904
23905 .option use_lockfile appendfile boolean "see below"
23906 If this option is turned off, Exim does not attempt to create a lock file when
23907 appending to a mailbox file. In this situation, the only locking is by
23908 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23909 sure that every MUA that is ever going to look at your users' mailboxes uses
23910 &[fcntl()]& rather than a lock file, and even then only when you are not
23911 delivering over NFS from more than one host.
23912
23913 .cindex "NFS" "lock file"
23914 In order to append to an NFS file safely from more than one host, it is
23915 necessary to take out a lock &'before'& opening the file, and the lock file
23916 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23917 file corruption.
23918
23919 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23920 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23921 except when &%mbx_format%& is set.
23922
23923
23924 .option use_mbx_lock appendfile boolean "see below"
23925 This option is available only if Exim has been compiled with SUPPORT_MBX
23926 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23927 locking rules be used. It is set by default if &%mbx_format%& is set and none
23928 of the locking options are mentioned in the configuration. The locking rules
23929 are the same as are used by the &'c-client'& library that underlies Pine and
23930 the IMAP4 and POP daemons that come with it (see the discussion below). The
23931 rules allow for shared access to the mailbox. However, this kind of locking
23932 does not work when the mailbox is NFS mounted.
23933
23934 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23935 &%use_flock_lock%& to control what kind of locking is used in implementing the
23936 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23937 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23938
23939
23940
23941
23942 .section "Operational details for appending" "SECTopappend"
23943 .cindex "appending to a file"
23944 .cindex "file" "appending"
23945 Before appending to a file, the following preparations are made:
23946
23947 .ilist
23948 If the name of the file is &_/dev/null_&, no action is taken, and a success
23949 return is given.
23950
23951 .next
23952 .cindex "directory creation"
23953 If any directories on the file's path are missing, Exim creates them if the
23954 &%create_directory%& option is set. A created directory's mode is given by the
23955 &%directory_mode%& option.
23956
23957 .next
23958 If &%file_format%& is set, the format of an existing file is checked. If this
23959 indicates that a different transport should be used, control is passed to that
23960 transport.
23961
23962 .next
23963 .cindex "file" "locking"
23964 .cindex "locking files"
23965 .cindex "NFS" "lock file"
23966 If &%use_lockfile%& is set, a lock file is built in a way that will work
23967 reliably over NFS, as follows:
23968
23969 .olist
23970 Create a &"hitching post"& file whose name is that of the lock file with the
23971 current time, primary host name, and process id added, by opening for writing
23972 as a new file. If this fails with an access error, delivery is deferred.
23973 .next
23974 Close the hitching post file, and hard link it to the lock filename.
23975 .next
23976 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23977 Unlink the hitching post name.
23978 .next
23979 Otherwise, use &[stat()]& to get information about the hitching post file, and
23980 then unlink hitching post name. If the number of links is exactly two, creation
23981 of the lock file succeeded but something (for example, an NFS server crash and
23982 restart) caused this fact not to be communicated to the &[link()]& call.
23983 .next
23984 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23985 up to &%lock_retries%& times. However, since any program that writes to a
23986 mailbox should complete its task very quickly, it is reasonable to time out old
23987 lock files that are normally the result of user agent and system crashes. If an
23988 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23989 it before trying again.
23990 .endlist olist
23991
23992 .next
23993 A call is made to &[lstat()]& to discover whether the main file exists, and if
23994 so, what its characteristics are. If &[lstat()]& fails for any reason other
23995 than non-existence, delivery is deferred.
23996
23997 .next
23998 .cindex "symbolic link" "to mailbox"
23999 .cindex "mailbox" "symbolic link"
24000 If the file does exist and is a symbolic link, delivery is deferred, unless the
24001 &%allow_symlink%& option is set, in which case the ownership of the link is
24002 checked, and then &[stat()]& is called to find out about the real file, which
24003 is then subjected to the checks below. The check on the top-level link
24004 ownership prevents one user creating a link for another's mailbox in a sticky
24005 directory, though allowing symbolic links in this case is definitely not a good
24006 idea. If there is a chain of symbolic links, the intermediate ones are not
24007 checked.
24008
24009 .next
24010 If the file already exists but is not a regular file, or if the file's owner
24011 and group (if the group is being checked &-- see &%check_group%& above) are
24012 different from the user and group under which the delivery is running,
24013 delivery is deferred.
24014
24015 .next
24016 If the file's permissions are more generous than specified, they are reduced.
24017 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
24018 is set false, in which case the delivery is tried using the existing
24019 permissions.
24020
24021 .next
24022 The file's inode number is saved, and the file is then opened for appending.
24023 If this fails because the file has vanished, &(appendfile)& behaves as if it
24024 hadn't existed (see below). For any other failures, delivery is deferred.
24025
24026 .next
24027 If the file is opened successfully, check that the inode number hasn't
24028 changed, that it is still a regular file, and that the owner and permissions
24029 have not changed. If anything is wrong, defer delivery and freeze the message.
24030
24031 .next
24032 If the file did not exist originally, defer delivery if the &%file_must_exist%&
24033 option is set. Otherwise, check that the file is being created in a permitted
24034 directory if the &%create_file%& option is set (deferring on failure), and then
24035 open for writing as a new file, with the O_EXCL and O_CREAT options,
24036 except when dealing with a symbolic link (the &%allow_symlink%& option must be
24037 set). In this case, which can happen if the link points to a non-existent file,
24038 the file is opened for writing using O_CREAT but not O_EXCL, because
24039 that prevents link following.
24040
24041 .next
24042 .cindex "loop" "while file testing"
24043 If opening fails because the file exists, obey the tests given above for
24044 existing files. However, to avoid looping in a situation where the file is
24045 being continuously created and destroyed, the exists/not-exists loop is broken
24046 after 10 repetitions, and the message is then frozen.
24047
24048 .next
24049 If opening fails with any other error, defer delivery.
24050
24051 .next
24052 .cindex "file" "locking"
24053 .cindex "locking files"
24054 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24055 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24056 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24057 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24058 file, and an exclusive lock on the file whose name is
24059 .code
24060 /tmp/.<device-number>.<inode-number>
24061 .endd
24062 using the device and inode numbers of the open mailbox file, in accordance with
24063 the MBX locking rules. This file is created with a mode that is specified by
24064 the &%lockfile_mode%& option.
24065
24066 If Exim fails to lock the file, there are two possible courses of action,
24067 depending on the value of the locking timeout. This is obtained from
24068 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24069
24070 If the timeout value is zero, the file is closed, Exim waits for
24071 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24072 to lock it again. This happens up to &%lock_retries%& times, after which the
24073 delivery is deferred.
24074
24075 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24076 &[flock()]& are used (with the given timeout), so there has already been some
24077 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24078 immediately. It retries up to
24079 .code
24080 (lock_retries * lock_interval) / <timeout>
24081 .endd
24082 times (rounded up).
24083 .endlist
24084
24085 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24086 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24087
24088
24089 .section "Operational details for delivery to a new file" "SECTopdir"
24090 .cindex "delivery" "to single file"
24091 .cindex "&""From""& line"
24092 When the &%directory%& option is set instead of &%file%&, each message is
24093 delivered into a newly-created file or set of files. When &(appendfile)& is
24094 activated directly from a &(redirect)& router, neither &%file%& nor
24095 &%directory%& is normally set, because the path for delivery is supplied by the
24096 router. (See for example, the &(address_file)& transport in the default
24097 configuration.) In this case, delivery is to a new file if either the path name
24098 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24099
24100 No locking is required while writing the message to a new file, so the various
24101 locking options of the transport are ignored. The &"From"& line that by default
24102 separates messages in a single file is not normally needed, nor is the escaping
24103 of message lines that start with &"From"&, and there is no need to ensure a
24104 newline at the end of each message. Consequently, the default values for
24105 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24106 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24107
24108 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24109 the files in the delivery directory by default. However, you can specify a
24110 different directory by setting &%quota_directory%&. Also, for maildir
24111 deliveries (see below) the &_maildirfolder_& convention is honoured.
24112
24113
24114 .cindex "maildir format"
24115 .cindex "mailstore format"
24116 There are three different ways in which delivery to individual files can be
24117 done, controlled by the settings of the &%maildir_format%& and
24118 &%mailstore_format%& options. Note that code to support maildir or mailstore
24119 formats is not included in the binary unless SUPPORT_MAILDIR or
24120 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24121
24122 .cindex "directory creation"
24123 In all three cases an attempt is made to create the directory and any necessary
24124 sub-directories if they do not exist, provided that the &%create_directory%&
24125 option is set (the default). The location of a created directory can be
24126 constrained by setting &%create_file%&. A created directory's mode is given by
24127 the &%directory_mode%& option. If creation fails, or if the
24128 &%create_directory%& option is not set when creation is required, delivery is
24129 deferred.
24130
24131
24132
24133 .section "Maildir delivery" "SECTmaildirdelivery"
24134 .cindex "maildir format" "description of"
24135 If the &%maildir_format%& option is true, Exim delivers each message by writing
24136 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24137 directory that is defined by the &%directory%& option (the &"delivery
24138 directory"&). If the delivery is successful, the file is renamed into the
24139 &_new_& subdirectory.
24140
24141 In the filename, <&'stime'&> is the current time of day in seconds, and
24142 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24143 Exim checks that the time-of-day clock has moved on by at least one microsecond
24144 before terminating the delivery process. This guarantees uniqueness for the
24145 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24146 opening it. If any response other than ENOENT (does not exist) is given,
24147 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24148
24149 Before Exim carries out a maildir delivery, it ensures that subdirectories
24150 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24151 do not exist, Exim tries to create them and any superior directories in their
24152 path, subject to the &%create_directory%& and &%create_file%& options. If the
24153 &%maildirfolder_create_regex%& option is set, and the regular expression it
24154 contains matches the delivery directory, Exim also ensures that a file called
24155 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24156 &_maildirfolder_& file cannot be created, delivery is deferred.
24157
24158 These features make it possible to use Exim to create all the necessary files
24159 and directories in a maildir mailbox, including subdirectories for maildir++
24160 folders. Consider this example:
24161 .code
24162 maildir_format = true
24163 directory = /var/mail/$local_part_data\
24164            ${if eq{$local_part_suffix}{}{}\
24165            {/.${substr_1:$local_part_suffix}}}
24166 maildirfolder_create_regex = /\.[^/]+$
24167 .endd
24168 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24169 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24170 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24171 not match this name, so Exim will not look for or create the file
24172 &_/var/mail/pimbo/maildirfolder_&, though it will create
24173 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24174
24175 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24176 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24177 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24178 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24179 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24180
24181 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24182 not inadvertently match the toplevel maildir directory, because a
24183 &_maildirfolder_& file at top level would completely break quota calculations.
24184
24185 .cindex "quota" "in maildir delivery"
24186 .cindex "maildir++"
24187 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24188 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24189 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24190 Exim assumes the directory is a maildir++ folder directory, which is one level
24191 down from the user's top level mailbox directory. This causes it to start at
24192 the parent directory instead of the current directory when calculating the
24193 amount of space used.
24194
24195 One problem with delivering into a multi-file mailbox is that it is
24196 computationally expensive to compute the size of the mailbox for quota
24197 checking. Various approaches have been taken to reduce the amount of work
24198 needed. The next two sections describe two of them. A third alternative is to
24199 use some external process for maintaining the size data, and use the expansion
24200 of the &%mailbox_size%& option as a way of importing it into Exim.
24201
24202
24203
24204
24205 .section "Using tags to record message sizes" "SECID135"
24206 If &%maildir_tag%& is set, the string is expanded for each delivery.
24207 When the maildir file is renamed into the &_new_& sub-directory, the
24208 tag is added to its name. However, if adding the tag takes the length of the
24209 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24210 the tag is dropped and the maildir file is created with no tag.
24211
24212
24213 .vindex "&$message_size$&"
24214 Tags can be used to encode the size of files in their names; see
24215 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24216 happens after the message has been written. The value of the &$message_size$&
24217 variable is set to the number of bytes actually written. If the expansion is
24218 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24219 be deferred. The expanded tag may contain any printing characters except &"/"&.
24220 Non-printing characters in the string are ignored; if the resulting string is
24221 empty, it is ignored. If it starts with an alphanumeric character, a leading
24222 colon is inserted; this default has not proven to be the path that popular
24223 maildir implementations have chosen (but changing it in Exim would break
24224 backwards compatibility).
24225
24226 For one common implementation, you might set:
24227 .code
24228 maildir_tag = ,S=${message_size}
24229 .endd
24230 but you should check the documentation of the other software to be sure.
24231
24232 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24233 as this allows Exim to extract the size from your tag, instead of having to
24234 &[stat()]& each message file.
24235
24236
24237 .section "Using a maildirsize file" "SECID136"
24238 .cindex "quota" "in maildir delivery"
24239 .cindex "maildir format" "&_maildirsize_& file"
24240 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24241 storing quota and message size information in a file called &_maildirsize_&
24242 within the toplevel maildir directory. If this file does not exist, Exim
24243 creates it, setting the quota from the &%quota%& option of the transport. If
24244 the maildir directory itself does not exist, it is created before any attempt
24245 to write a &_maildirsize_& file.
24246
24247 The &_maildirsize_& file is used to hold information about the sizes of
24248 messages in the maildir, thus speeding up quota calculations. The quota value
24249 in the file is just a cache; if the quota is changed in the transport, the new
24250 value overrides the cached value when the next message is delivered. The cache
24251 is maintained for the benefit of other programs that access the maildir and
24252 need to know the quota.
24253
24254 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24255 file is maintained (with a zero quota setting), but no quota is imposed.
24256
24257 A regular expression is available for controlling which directories in the
24258 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24259 See the description of the &%maildir_quota_directory_regex%& option above for
24260 details.
24261
24262
24263 .section "Mailstore delivery" "SECID137"
24264 .cindex "mailstore format" "description of"
24265 If the &%mailstore_format%& option is true, each message is written as two
24266 files in the given directory. A unique base name is constructed from the
24267 message id and the current delivery process, and the files that are written use
24268 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24269 contains the message's envelope, and the &_.msg_& file contains the message
24270 itself. The base name is placed in the variable &$mailstore_basename$&.
24271
24272 During delivery, the envelope is first written to a file with the suffix
24273 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24274 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24275 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24276 file before accessing either of them. An alternative approach is to wait for
24277 the absence of a &_.tmp_& file.
24278
24279 The envelope file starts with any text defined by the &%mailstore_prefix%&
24280 option, expanded and terminated by a newline if there isn't one. Then follows
24281 the sender address on one line, then all the recipient addresses, one per line.
24282 There can be more than one recipient only if the &%batch_max%& option is set
24283 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24284 appended to the file, followed by a newline if it does not end with one.
24285
24286 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24287 failure, it is ignored. Other expansion errors are treated as serious
24288 configuration errors, and delivery is deferred. The variable
24289 &$mailstore_basename$& is available for use during these expansions.
24290
24291
24292 .section "Non-special new file delivery" "SECID138"
24293 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24294 file is created directly in the named directory. For example, when delivering
24295 messages into files in batched SMTP format for later delivery to some host (see
24296 section &<<SECTbatchSMTP>>&), a setting such as
24297 .code
24298 directory = /var/bsmtp/$host
24299 .endd
24300 might be used. A message is written to a file with a temporary name, which is
24301 then renamed when the delivery is complete. The final name is obtained by
24302 expanding the contents of the &%directory_file%& option.
24303 .ecindex IIDapptra1
24304 .ecindex IIDapptra2
24305
24306
24307
24308
24309
24310
24311 . ////////////////////////////////////////////////////////////////////////////
24312 . ////////////////////////////////////////////////////////////////////////////
24313
24314 .chapter "The autoreply transport" "CHID8"
24315 .scindex IIDauttra1 "transports" "&(autoreply)&"
24316 .scindex IIDauttra2 "&(autoreply)& transport"
24317 The &(autoreply)& transport is not a true transport in that it does not cause
24318 the message to be transmitted. Instead, it generates a new mail message as an
24319 automatic reply to the incoming message. &'References:'& and
24320 &'Auto-Submitted:'& header lines are included. These are constructed according
24321 to the rules in RFCs 2822 and 3834, respectively.
24322
24323 If the router that passes the message to this transport does not have the
24324 &%unseen%& option set, the original message (for the current recipient) is not
24325 delivered anywhere. However, when the &%unseen%& option is set on the router
24326 that passes the message to this transport, routing of the address continues, so
24327 another router can set up a normal message delivery.
24328
24329
24330 The &(autoreply)& transport is usually run as the result of mail filtering, a
24331 &"vacation"& message being the standard example. However, it can also be run
24332 directly from a router like any other transport. To reduce the possibility of
24333 message cascades, messages created by the &(autoreply)& transport always have
24334 empty envelope sender addresses, like bounce messages.
24335
24336 The parameters of the message to be sent can be specified in the configuration
24337 by options described below. However, these are used only when the address
24338 passed to the transport does not contain its own reply information. When the
24339 transport is run as a consequence of a
24340 &%mail%&
24341 or &%vacation%& command in a filter file, the parameters of the message are
24342 supplied by the filter, and passed with the address. The transport's options
24343 that define the message are then ignored (so they are not usually set in this
24344 case). The message is specified entirely by the filter or by the transport; it
24345 is never built from a mixture of options. However, the &%file_optional%&,
24346 &%mode%&, and &%return_message%& options apply in all cases.
24347
24348 &(Autoreply)& is implemented as a local transport. When used as a result of a
24349 command in a user's filter file, &(autoreply)& normally runs under the uid and
24350 gid of the user, and with appropriate current and home directories (see chapter
24351 &<<CHAPenvironment>>&).
24352
24353 There is a subtle difference between routing a message to a &(pipe)& transport
24354 that generates some text to be returned to the sender, and routing it to an
24355 &(autoreply)& transport. This difference is noticeable only if more than one
24356 address from the same message is so handled. In the case of a pipe, the
24357 separate outputs from the different addresses are gathered up and returned to
24358 the sender in a single message, whereas if &(autoreply)& is used, a separate
24359 message is generated for each address that is passed to it.
24360
24361 Non-printing characters are not permitted in the header lines generated for the
24362 message that &(autoreply)& creates, with the exception of newlines that are
24363 immediately followed by white space. If any non-printing characters are found,
24364 the transport defers.
24365 Whether characters with the top bit set count as printing characters or not is
24366 controlled by the &%print_topbitchars%& global option.
24367
24368 If any of the generic options for manipulating headers (for example,
24369 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24370 of the original message that is included in the generated message when
24371 &%return_message%& is set. They do not apply to the generated message itself.
24372
24373 .vindex "&$sender_address$&"
24374 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24375 the message, indicating that there were no recipients, it does not treat this
24376 as an error. This means that autoreplies sent to &$sender_address$& when this
24377 is empty (because the incoming message is a bounce message) do not cause
24378 problems. They are just discarded.
24379
24380
24381
24382 .section "Private options for autoreply" "SECID139"
24383 .cindex "options" "&(autoreply)& transport"
24384
24385 .option bcc autoreply string&!! unset
24386 This specifies the addresses that are to receive &"blind carbon copies"& of the
24387 message when the message is specified by the transport.
24388
24389
24390 .option cc autoreply string&!! unset
24391 This specifies recipients of the message and the contents of the &'Cc:'& header
24392 when the message is specified by the transport.
24393
24394
24395 .option file autoreply string&!! unset
24396 The contents of the file are sent as the body of the message when the message
24397 is specified by the transport. If both &%file%& and &%text%& are set, the text
24398 string comes first.
24399
24400
24401 .option file_expand autoreply boolean false
24402 If this is set, the contents of the file named by the &%file%& option are
24403 subjected to string expansion as they are added to the message.
24404
24405
24406 .option file_optional autoreply boolean false
24407 If this option is true, no error is generated if the file named by the &%file%&
24408 option or passed with the address does not exist or cannot be read.
24409
24410
24411 .option from autoreply string&!! unset
24412 This specifies the contents of the &'From:'& header when the message is
24413 specified by the transport.
24414
24415
24416 .option headers autoreply string&!! unset
24417 This specifies additional RFC 2822 headers that are to be added to the message
24418 when the message is specified by the transport. Several can be given by using
24419 &"\n"& to separate them. There is no check on the format.
24420
24421
24422 .option log autoreply string&!! unset
24423 This option names a file in which a record of every message sent is logged when
24424 the message is specified by the transport.
24425
24426
24427 .option mode autoreply "octal integer" 0600
24428 If either the log file or the &"once"& file has to be created, this mode is
24429 used.
24430
24431
24432 .option never_mail autoreply "address list&!!" unset
24433 If any run of the transport creates a message with a recipient that matches any
24434 item in the list, that recipient is quietly discarded. If all recipients are
24435 discarded, no message is created. This applies both when the recipients are
24436 generated by a filter and when they are specified in the transport.
24437
24438
24439
24440 .option once autoreply string&!! unset
24441 This option names a file or DBM database in which a record of each &'To:'&
24442 recipient is kept when the message is specified by the transport. &*Note*&:
24443 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24444
24445 If &%once%& is unset, or is set to an empty string, the message is always sent.
24446 By default, if &%once%& is set to a non-empty filename, the message
24447 is not sent if a potential recipient is already listed in the database.
24448 However, if the &%once_repeat%& option specifies a time greater than zero, the
24449 message is sent if that much time has elapsed since a message was last sent to
24450 this recipient. A setting of zero time for &%once_repeat%& (the default)
24451 prevents a message from being sent a second time &-- in this case, zero means
24452 infinity.
24453
24454 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24455 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24456 greater than zero, it changes the way Exim implements the &%once%& option.
24457 Instead of using a DBM file to record every recipient it sends to, it uses a
24458 regular file, whose size will never get larger than the given value.
24459
24460 In the file, Exim keeps a linear list of recipient addresses and the times at
24461 which they were sent messages. If the file is full when a new address needs to
24462 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24463 means that a given recipient may receive multiple messages, but at
24464 unpredictable intervals that depend on the rate of turnover of addresses in the
24465 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24466
24467
24468 .option once_file_size autoreply integer 0
24469 See &%once%& above.
24470
24471
24472 .option once_repeat autoreply time&!! 0s
24473 See &%once%& above.
24474 After expansion, the value of this option must be a valid time value.
24475
24476
24477 .option reply_to autoreply string&!! unset
24478 This specifies the contents of the &'Reply-To:'& header when the message is
24479 specified by the transport.
24480
24481
24482 .option return_message autoreply boolean false
24483 If this is set, a copy of the original message is returned with the new
24484 message, subject to the maximum size set in the &%return_size_limit%& global
24485 configuration option.
24486
24487
24488 .option subject autoreply string&!! unset
24489 This specifies the contents of the &'Subject:'& header when the message is
24490 specified by the transport. It is tempting to quote the original subject in
24491 automatic responses. For example:
24492 .code
24493 subject = Re: $h_subject:
24494 .endd
24495 There is a danger in doing this, however. It may allow a third party to
24496 subscribe your users to an opt-in mailing list, provided that the list accepts
24497 bounce messages as subscription confirmations. Well-managed lists require a
24498 non-bounce message to confirm a subscription, so the danger is relatively
24499 small.
24500
24501
24502
24503 .option text autoreply string&!! unset
24504 This specifies a single string to be used as the body of the message when the
24505 message is specified by the transport. If both &%text%& and &%file%& are set,
24506 the text comes first.
24507
24508
24509 .option to autoreply string&!! unset
24510 This specifies recipients of the message and the contents of the &'To:'& header
24511 when the message is specified by the transport.
24512 .ecindex IIDauttra1
24513 .ecindex IIDauttra2
24514
24515
24516
24517
24518 . ////////////////////////////////////////////////////////////////////////////
24519 . ////////////////////////////////////////////////////////////////////////////
24520
24521 .chapter "The lmtp transport" "CHAPLMTP"
24522 .cindex "transports" "&(lmtp)&"
24523 .cindex "&(lmtp)& transport"
24524 .cindex "LMTP" "over a pipe"
24525 .cindex "LMTP" "over a socket"
24526 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24527 specified command
24528 or by interacting with a Unix domain socket.
24529 This transport is something of a cross between the &(pipe)& and &(smtp)&
24530 transports. Exim also has support for using LMTP over TCP/IP; this is
24531 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24532 to be of minority interest, the default build-time configure in &_src/EDITME_&
24533 has it commented out. You need to ensure that
24534 .code
24535 TRANSPORT_LMTP=yes
24536 .endd
24537 .cindex "options" "&(lmtp)& transport"
24538 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24539 included in the Exim binary. The private options of the &(lmtp)& transport are
24540 as follows:
24541
24542 .option batch_id lmtp string&!! unset
24543 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24544
24545
24546 .option batch_max lmtp integer 1
24547 This limits the number of addresses that can be handled in a single delivery.
24548 Most LMTP servers can handle several addresses at once, so it is normally a
24549 good idea to increase this value. See the description of local delivery
24550 batching in chapter &<<CHAPbatching>>&.
24551
24552
24553 .option command lmtp string&!! unset
24554 This option must be set if &%socket%& is not set. The string is a command which
24555 is run in a separate process. It is split up into a command name and list of
24556 arguments, each of which is separately expanded (so expansion cannot change the
24557 number of arguments). The command is run directly, not via a shell. The message
24558 is passed to the new process using the standard input and output to operate the
24559 LMTP protocol.
24560
24561 .option ignore_quota lmtp boolean false
24562 .cindex "LMTP" "ignoring quota errors"
24563 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24564 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24565 in its response to the LHLO command.
24566
24567 .option socket lmtp string&!! unset
24568 This option must be set if &%command%& is not set. The result of expansion must
24569 be the name of a Unix domain socket. The transport connects to the socket and
24570 delivers the message to it using the LMTP protocol.
24571
24572
24573 .option timeout lmtp time 5m
24574 The transport is aborted if the created process or Unix domain socket does not
24575 respond to LMTP commands or message input within this timeout. Delivery
24576 is deferred, and will be tried again later. Here is an example of a typical
24577 LMTP transport:
24578 .code
24579 lmtp:
24580   driver = lmtp
24581   command = /some/local/lmtp/delivery/program
24582   batch_max = 20
24583   user = exim
24584 .endd
24585 This delivers up to 20 addresses at a time, in a mixture of domains if
24586 necessary, running as the user &'exim'&.
24587
24588
24589
24590 . ////////////////////////////////////////////////////////////////////////////
24591 . ////////////////////////////////////////////////////////////////////////////
24592
24593 .chapter "The pipe transport" "CHAPpipetransport"
24594 .scindex IIDpiptra1 "transports" "&(pipe)&"
24595 .scindex IIDpiptra2 "&(pipe)& transport"
24596 The &(pipe)& transport is used to deliver messages via a pipe to a command
24597 running in another process. One example is the use of &(pipe)& as a
24598 pseudo-remote transport for passing messages to some other delivery mechanism
24599 (such as UUCP). Another is the use by individual users to automatically process
24600 their incoming messages. The &(pipe)& transport can be used in one of the
24601 following ways:
24602
24603 .ilist
24604 .vindex "&$local_part$&"
24605 A router routes one address to a transport in the normal way, and the
24606 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24607 contains the local part of the address (as usual), and the command that is run
24608 is specified by the &%command%& option on the transport.
24609 .next
24610 .vindex "&$pipe_addresses$&"
24611 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24612 transport can handle more than one address in a single run. In this case, when
24613 more than one address is routed to the transport, &$local_part$& is not set
24614 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24615 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24616 that are routed to the transport.
24617 .next
24618 .vindex "&$address_pipe$&"
24619 A router redirects an address directly to a pipe command (for example, from an
24620 alias or forward file). In this case, &$address_pipe$& contains the text of the
24621 pipe command, and the &%command%& option on the transport is ignored unless
24622 &%force_command%& is set. If only one address is being transported
24623 (&%batch_max%& is not greater than one, or only one address was redirected to
24624 this pipe command), &$local_part$& contains the local part that was redirected.
24625 .endlist
24626
24627
24628 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24629 deliver messages over pipes using the LMTP interactive protocol. This is
24630 implemented by the &(lmtp)& transport.
24631
24632 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24633 &_.forward_& file, the command runs under the uid and gid of that user. In
24634 other cases, the uid and gid have to be specified explicitly, either on the
24635 transport or on the router that handles the address. Current and &"home"&
24636 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24637 details of the local delivery environment and chapter &<<CHAPbatching>>&
24638 for a discussion of local delivery batching.
24639
24640 .cindex "tainted data" "in pipe command"
24641 .cindex pipe "tainted data"
24642 Tainted data may not be used for the command name.
24643
24644
24645 .section "Concurrent delivery" "SECID140"
24646 If two messages arrive at almost the same time, and both are routed to a pipe
24647 delivery, the two pipe transports may be run concurrently. You must ensure that
24648 any pipe commands you set up are robust against this happening. If the commands
24649 write to a file, the &%exim_lock%& utility might be of use.
24650 Alternatively the &%max_parallel%& option could be used with a value
24651 of "1" to enforce serialization.
24652
24653
24654
24655
24656 .section "Returned status and data" "SECID141"
24657 .cindex "&(pipe)& transport" "returned data"
24658 If the command exits with a non-zero return code, the delivery is deemed to
24659 have failed, unless either the &%ignore_status%& option is set (in which case
24660 the return code is treated as zero), or the return code is one of those listed
24661 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24662 later"&. In this case, delivery is deferred. Details of a permanent failure are
24663 logged, but are not included in the bounce message, which merely contains
24664 &"local delivery failed"&.
24665
24666 If the command exits on a signal and the &%freeze_signal%& option is set then
24667 the message will be frozen in the queue. If that option is not set, a bounce
24668 will be sent as normal.
24669
24670 If the return code is greater than 128 and the command being run is a shell
24671 script, it normally means that the script was terminated by a signal whose
24672 value is the return code minus 128. The &%freeze_signal%& option does not
24673 apply in this case.
24674
24675 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24676 return code is set to 127. This is the value that a shell returns if it is
24677 asked to run a non-existent command. The wording for the log line suggests that
24678 a non-existent command may be the problem.
24679
24680 The &%return_output%& option can affect the result of a pipe delivery. If it is
24681 set and the command produces any output on its standard output or standard
24682 error streams, the command is considered to have failed, even if it gave a zero
24683 return code or if &%ignore_status%& is set. The output from the command is
24684 included as part of the bounce message. The &%return_fail_output%& option is
24685 similar, except that output is returned only when the command exits with a
24686 failure return code, that is, a value other than zero or a code that matches
24687 &%temp_errors%&.
24688
24689
24690
24691 .section "How the command is run" "SECThowcommandrun"
24692 .cindex "&(pipe)& transport" "path for command"
24693 The command line is (by default) broken down into a command name and arguments
24694 by the &(pipe)& transport itself. The &%allow_commands%& and
24695 &%restrict_to_path%& options can be used to restrict the commands that may be
24696 run.
24697
24698 .cindex "quoting" "in pipe command"
24699 Unquoted arguments are delimited by white space. If an argument appears in
24700 double quotes, backslash is interpreted as an escape character in the usual
24701 way. If an argument appears in single quotes, no escaping is done.
24702
24703 String expansion is applied to the command line except when it comes from a
24704 traditional &_.forward_& file (commands from a filter file are expanded). The
24705 expansion is applied to each argument in turn rather than to the whole line.
24706 For this reason, any string expansion item that contains white space must be
24707 quoted so as to be contained within a single argument. A setting such as
24708 .code
24709 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24710 .endd
24711 will not work, because the expansion item gets split between several
24712 arguments. You have to write
24713 .code
24714 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24715 .endd
24716 to ensure that it is all in one argument. The expansion is done in this way,
24717 argument by argument, so that the number of arguments cannot be changed as a
24718 result of expansion, and quotes or backslashes in inserted variables do not
24719 interact with external quoting. However, this leads to problems if you want to
24720 generate multiple arguments (or the command name plus arguments) from a single
24721 expansion. In this situation, the simplest solution is to use a shell. For
24722 example:
24723 .code
24724 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24725 .endd
24726
24727 .cindex "transport" "filter"
24728 .cindex "filter" "transport filter"
24729 .vindex "&$pipe_addresses$&"
24730 Special handling takes place when an argument consists of precisely the text
24731 &`$pipe_addresses`& (no quotes).
24732 This is not a general expansion variable; the only
24733 place this string is recognized is when it appears as an argument for a pipe or
24734 transport filter command. It causes each address that is being handled to be
24735 inserted in the argument list at that point &'as a separate argument'&. This
24736 avoids any problems with spaces or shell metacharacters, and is of use when a
24737 &(pipe)& transport is handling groups of addresses in a batch.
24738
24739 If &%force_command%& is enabled on the transport, special handling takes place
24740 for an argument that consists of precisely the text &`$address_pipe`&.  It
24741 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24742 argument is inserted in the argument list at that point
24743 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24744 the only item in the argument; in fact, if it were then &%force_command%&
24745 should behave as a no-op.  Rather, it should be used to adjust the command
24746 run while preserving the argument vector separation.
24747
24748 After splitting up into arguments and expansion, the resulting command is run
24749 in a subprocess directly from the transport, &'not'& under a shell. The
24750 message that is being delivered is supplied on the standard input, and the
24751 standard output and standard error are both connected to a single pipe that is
24752 read by Exim. The &%max_output%& option controls how much output the command
24753 may produce, and the &%return_output%& and &%return_fail_output%& options
24754 control what is done with it.
24755
24756 Not running the command under a shell (by default) lessens the security risks
24757 in cases when a command from a user's filter file is built out of data that was
24758 taken from an incoming message. If a shell is required, it can of course be
24759 explicitly specified as the command to be run. However, there are circumstances
24760 where existing commands (for example, in &_.forward_& files) expect to be run
24761 under a shell and cannot easily be modified. To allow for these cases, there is
24762 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24763 works. Instead of breaking up the command line as just described, it expands it
24764 as a single string and passes the result to &_/bin/sh_&. The
24765 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24766 with &%use_shell%&, and the whole mechanism is inherently less secure.
24767
24768
24769
24770 .section "Environment variables" "SECTpipeenv"
24771 .cindex "&(pipe)& transport" "environment for command"
24772 .cindex "environment" "&(pipe)& transport"
24773 The environment variables listed below are set up when the command is invoked.
24774 This list is a compromise for maximum compatibility with other MTAs. Note that
24775 the &%environment%& option can be used to add additional variables to this
24776 environment. The environment for the &(pipe)& transport is not subject
24777 to the &%add_environment%& and &%keep_environment%& main config options.
24778 &*Note*&: Using enviroment variables loses track of tainted data.
24779 Writers of &(pipe)& transport commands should be wary of data supplied
24780 by potential attackers.
24781 .display
24782 &`DOMAIN            `&   the domain of the address
24783 &`HOME              `&   the home directory, if set
24784 &`HOST              `&   the host name when called from a router (see below)
24785 &`LOCAL_PART        `&   see below
24786 &`LOCAL_PART_PREFIX `&   see below
24787 &`LOCAL_PART_SUFFIX `&   see below
24788 &`LOGNAME           `&   see below
24789 &`MESSAGE_ID        `&   Exim's local ID for the message
24790 &`PATH              `&   as specified by the &%path%& option below
24791 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24792 &`RECIPIENT         `&   the complete recipient address
24793 &`SENDER            `&   the sender of the message (empty if a bounce)
24794 &`SHELL             `&   &`/bin/sh`&
24795 &`TZ                `&   the value of the &%timezone%& option, if set
24796 &`USER              `&   see below
24797 .endd
24798 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24799 router, LOCAL_PART is set to the local part of the address. When it is
24800 called as a result of a forward or alias expansion, LOCAL_PART is set to
24801 the local part of the address that was expanded. In both cases, any affixes are
24802 removed from the local part, and made available in LOCAL_PART_PREFIX and
24803 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24804 same value as LOCAL_PART for compatibility with other MTAs.
24805
24806 .cindex "HOST"
24807 HOST is set only when a &(pipe)& transport is called from a router that
24808 associates hosts with an address, typically when using &(pipe)& as a
24809 pseudo-remote transport. HOST is set to the first host name specified by
24810 the router.
24811
24812 .cindex "HOME"
24813 If the transport's generic &%home_directory%& option is set, its value is used
24814 for the HOME environment variable. Otherwise, a home directory may be set
24815 by the router's &%transport_home_directory%& option, which defaults to the
24816 user's home directory if &%check_local_user%& is set.
24817
24818
24819 .section "Private options for pipe" "SECID142"
24820 .cindex "options" "&(pipe)& transport"
24821
24822
24823
24824 .option allow_commands pipe "string list&!!" unset
24825 .cindex "&(pipe)& transport" "permitted commands"
24826 The string is expanded, and is then interpreted as a colon-separated list of
24827 permitted commands. If &%restrict_to_path%& is not set, the only commands
24828 permitted are those in the &%allow_commands%& list. They need not be absolute
24829 paths; the &%path%& option is still used for relative paths. If
24830 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24831 in the &%allow_commands%& list, or a name without any slashes that is found on
24832 the path. In other words, if neither &%allow_commands%& nor
24833 &%restrict_to_path%& is set, there is no restriction on the command, but
24834 otherwise only commands that are permitted by one or the other are allowed. For
24835 example, if
24836 .code
24837 allow_commands = /usr/bin/vacation
24838 .endd
24839 and &%restrict_to_path%& is not set, the only permitted command is
24840 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24841 &%use_shell%& is set.
24842
24843
24844 .option batch_id pipe string&!! unset
24845 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24846
24847
24848 .option batch_max pipe integer 1
24849 This limits the number of addresses that can be handled in a single delivery.
24850 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24851
24852
24853 .option check_string pipe string unset
24854 As &(pipe)& writes the message, the start of each line is tested for matching
24855 &%check_string%&, and if it does, the initial matching characters are replaced
24856 by the contents of &%escape_string%&, provided both are set. The value of
24857 &%check_string%& is a literal string, not a regular expression, and the case of
24858 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24859 of &%check_string%& and &%escape_string%& are forced to values that implement
24860 the SMTP escaping protocol. Any settings made in the configuration file are
24861 ignored.
24862
24863
24864 .option command pipe string&!! unset
24865 This option need not be set when &(pipe)& is being used to deliver to pipes
24866 obtained directly from address redirections. In other cases, the option must be
24867 set, to provide a command to be run. It need not yield an absolute path (see
24868 the &%path%& option below). The command is split up into separate arguments by
24869 Exim, and each argument is separately expanded, as described in section
24870 &<<SECThowcommandrun>>& above.
24871
24872 .cindex "tainted data"
24873 No part of the resulting command may be tainted.
24874
24875
24876 .option environment pipe "string list&!!" unset
24877 .cindex "&(pipe)& transport" "environment for command"
24878 .cindex "environment" "&(pipe)& transport"
24879 This option is used to add additional variables to the environment in which the
24880 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24881 a string which is expanded, and then interpreted as a colon-separated list of
24882 environment settings of the form <&'name'&>=<&'value'&>.
24883
24884
24885 .option escape_string pipe string unset
24886 See &%check_string%& above.
24887
24888
24889 .option freeze_exec_fail pipe boolean false
24890 .cindex "exec failure"
24891 .cindex "failure of exec"
24892 .cindex "&(pipe)& transport" "failure of exec"
24893 Failure to exec the command in a pipe transport is by default treated like
24894 any other failure while running the command. However, if &%freeze_exec_fail%&
24895 is set, failure to exec is treated specially, and causes the message to be
24896 frozen, whatever the setting of &%ignore_status%&.
24897
24898
24899 .option freeze_signal pipe boolean false
24900 .cindex "signal exit"
24901 .cindex "&(pipe)& transport", "signal exit"
24902 Normally if the process run by a command in a pipe transport exits on a signal,
24903 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24904 frozen in Exim's queue instead.
24905
24906
24907 .option force_command pipe boolean false
24908 .cindex "force command"
24909 .cindex "&(pipe)& transport", "force command"
24910 Normally when a router redirects an address directly to a pipe command
24911 the &%command%& option on the transport is ignored.  If &%force_command%&
24912 is set, the &%command%& option will used. This is especially
24913 useful for forcing a wrapper or additional argument to be added to the
24914 command. For example:
24915 .code
24916 command = /usr/bin/remote_exec myhost -- $address_pipe
24917 force_command
24918 .endd
24919
24920 Note that &$address_pipe$& is handled specially in &%command%& when
24921 &%force_command%& is set, expanding out to the original argument vector as
24922 separate items, similarly to a Unix shell &`"$@"`& construct.
24923
24924
24925 .option ignore_status pipe boolean false
24926 If this option is true, the status returned by the subprocess that is set up to
24927 run the command is ignored, and Exim behaves as if zero had been returned.
24928 Otherwise, a non-zero status or termination by signal causes an error return
24929 from the transport unless the status value is one of those listed in
24930 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24931
24932 &*Note*&: This option does not apply to timeouts, which do not return a status.
24933 See the &%timeout_defer%& option for how timeouts are handled.
24934
24935
24936 .option log_defer_output pipe boolean false
24937 .cindex "&(pipe)& transport" "logging output"
24938 If this option is set, and the status returned by the command is
24939 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24940 and any output was produced on stdout or stderr, the first line of it is
24941 written to the main log.
24942
24943
24944 .option log_fail_output pipe boolean false
24945 If this option is set, and the command returns any output on stdout or
24946 stderr, and also ends with a return code that is neither zero nor one of
24947 the return codes listed in &%temp_errors%& (that is, the delivery
24948 failed), the first line of output is written to the main log. This
24949 option and &%log_output%& are mutually exclusive.  Only one of them may
24950 be set.
24951
24952
24953 .option log_output pipe boolean false
24954 If this option is set and the command returns any output on stdout or
24955 stderr, the first line of output is written to the main log, whatever
24956 the return code. This option and &%log_fail_output%& are mutually
24957 exclusive. Only one of them may be set.
24958
24959
24960 .option max_output pipe integer 20K
24961 This specifies the maximum amount of output that the command may produce on its
24962 standard output and standard error file combined. If the limit is exceeded, the
24963 process running the command is killed. This is intended as a safety measure to
24964 catch runaway processes. The limit is applied independently of the settings of
24965 the options that control what is done with such output (for example,
24966 &%return_output%&). Because of buffering effects, the amount of output may
24967 exceed the limit by a small amount before Exim notices.
24968
24969
24970 .option message_prefix pipe string&!! "see below"
24971 The string specified here is expanded and output at the start of every message.
24972 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24973 .code
24974 message_prefix = \
24975   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24976   ${tod_bsdinbox}\n
24977 .endd
24978 .cindex "Cyrus"
24979 .cindex "&%tmail%&"
24980 .cindex "&""From""& line"
24981 This is required by the commonly used &_/usr/bin/vacation_& program.
24982 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24983 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24984 setting
24985 .code
24986 message_prefix =
24987 .endd
24988 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24989 &`\n`& to &`\r\n`& in &%message_prefix%&.
24990
24991
24992 .option message_suffix pipe string&!! "see below"
24993 The string specified here is expanded and output at the end of every message.
24994 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24995 The suffix can be suppressed by setting
24996 .code
24997 message_suffix =
24998 .endd
24999 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
25000 &`\n`& to &`\r\n`& in &%message_suffix%&.
25001
25002
25003 .option path pipe string&!! "/bin:/usr/bin"
25004 This option is expanded and
25005 specifies the string that is set up in the PATH environment
25006 variable of the subprocess.
25007 If the &%command%& option does not yield an absolute path name, the command is
25008 sought in the PATH directories, in the usual way. &*Warning*&: This does not
25009 apply to a command specified as a transport filter.
25010
25011
25012 .option permit_coredump pipe boolean false
25013 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
25014 a core-dump of a pipe command, enable this command.  This enables core-dumps
25015 during delivery and affects both the Exim binary and the pipe command run.
25016 It is recommended that this option remain off unless and until you have a need
25017 for it and that this only be enabled when needed, as the risk of excessive
25018 resource consumption can be quite high.  Note also that Exim is typically
25019 installed as a setuid binary and most operating systems will inhibit coredumps
25020 of these by default, so further OS-specific action may be required.
25021
25022
25023 .option pipe_as_creator pipe boolean false
25024 .cindex "uid (user id)" "local delivery"
25025 If the generic &%user%& option is not set and this option is true, the delivery
25026 process is run under the uid that was in force when Exim was originally called
25027 to accept the message. If the group id is not otherwise set (via the generic
25028 &%group%& option), the gid that was in force when Exim was originally called to
25029 accept the message is used.
25030
25031
25032 .option restrict_to_path pipe boolean false
25033 When this option is set, any command name not listed in &%allow_commands%& must
25034 contain no slashes. The command is searched for only in the directories listed
25035 in the &%path%& option. This option is intended for use in the case when a pipe
25036 command has been generated from a user's &_.forward_& file. This is usually
25037 handled by a &(pipe)& transport called &%address_pipe%&.
25038
25039
25040 .option return_fail_output pipe boolean false
25041 If this option is true, and the command produced any output and ended with a
25042 return code other than zero or one of the codes listed in &%temp_errors%& (that
25043 is, the delivery failed), the output is returned in the bounce message.
25044 However, if the message has a null sender (that is, it is itself a bounce
25045 message), output from the command is discarded. This option and
25046 &%return_output%& are mutually exclusive. Only one of them may be set.
25047
25048
25049
25050 .option return_output pipe boolean false
25051 If this option is true, and the command produced any output, the delivery is
25052 deemed to have failed whatever the return code from the command, and the output
25053 is returned in the bounce message. Otherwise, the output is just discarded.
25054 However, if the message has a null sender (that is, it is a bounce message),
25055 output from the command is always discarded, whatever the setting of this
25056 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25057 of them may be set.
25058
25059
25060
25061 .option temp_errors pipe "string list" "see below"
25062 .cindex "&(pipe)& transport" "temporary failure"
25063 This option contains either a colon-separated list of numbers, or a single
25064 asterisk. If &%ignore_status%& is false
25065 and &%return_output%& is not set,
25066 and the command exits with a non-zero return code, the failure is treated as
25067 temporary and the delivery is deferred if the return code matches one of the
25068 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25069 codes are treated as permanent errors. The default setting contains the codes
25070 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25071 compiled on a system that does not define these macros, it assumes values of 75
25072 and 73, respectively.
25073
25074
25075 .option timeout pipe time 1h
25076 If the command fails to complete within this time, it is killed. This normally
25077 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25078 specifies no timeout. In order to ensure that any subprocesses created by the
25079 command are also killed, Exim makes the initial process a process group leader,
25080 and kills the whole process group on a timeout. However, this can be defeated
25081 if one of the processes starts a new process group.
25082
25083 .option timeout_defer pipe boolean false
25084 A timeout in a &(pipe)& transport, either in the command that the transport
25085 runs, or in a transport filter that is associated with it, is by default
25086 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25087 is set true, both kinds of timeout become temporary errors, causing the
25088 delivery to be deferred.
25089
25090 .option umask pipe "octal integer" 022
25091 This specifies the umask setting for the subprocess that runs the command.
25092
25093
25094 .option use_bsmtp pipe boolean false
25095 .cindex "envelope sender"
25096 If this option is set true, the &(pipe)& transport writes messages in &"batch
25097 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25098 commands. If you want to include a leading HELO command with such messages,
25099 you can do so by setting the &%message_prefix%& option. See section
25100 &<<SECTbatchSMTP>>& for details of batch SMTP.
25101
25102 .option use_classresources pipe boolean false
25103 .cindex "class resources (BSD)"
25104 This option is available only when Exim is running on FreeBSD, NetBSD, or
25105 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25106 resource limits when a &(pipe)& transport is run to perform a delivery. The
25107 limits for the uid under which the pipe is to run are obtained from the login
25108 class database.
25109
25110
25111 .option use_crlf pipe boolean false
25112 .cindex "carriage return"
25113 .cindex "linefeed"
25114 This option causes lines to be terminated with the two-character CRLF sequence
25115 (carriage return, linefeed) instead of just a linefeed character. In the case
25116 of batched SMTP, the byte sequence written to the pipe is then an exact image
25117 of what would be sent down a real SMTP connection.
25118
25119 The contents of the &%message_prefix%& and &%message_suffix%& options are
25120 written verbatim, so must contain their own carriage return characters if these
25121 are needed. When &%use_bsmtp%& is not set, the default values for both
25122 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25123 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25124
25125
25126 .option use_shell pipe boolean false
25127 .vindex "&$pipe_addresses$&"
25128 If this option is set, it causes the command to be passed to &_/bin/sh_&
25129 instead of being run directly from the transport, as described in section
25130 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25131 where the command is expected to be run under a shell and cannot easily be
25132 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25133 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25134 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25135 its &%-c%& option.
25136
25137
25138
25139 .section "Using an external local delivery agent" "SECID143"
25140 .cindex "local delivery" "using an external agent"
25141 .cindex "&'procmail'&"
25142 .cindex "external local delivery"
25143 .cindex "delivery" "&'procmail'&"
25144 .cindex "delivery" "by external agent"
25145 The &(pipe)& transport can be used to pass all messages that require local
25146 delivery to a separate local delivery agent such as &%procmail%&. When doing
25147 this, care must be taken to ensure that the pipe is run under an appropriate
25148 uid and gid. In some configurations one wants this to be a uid that is trusted
25149 by the delivery agent to supply the correct sender of the message. It may be
25150 necessary to recompile or reconfigure the delivery agent so that it trusts an
25151 appropriate user. The following is an example transport and router
25152 configuration for &%procmail%&:
25153 .code
25154 # transport
25155 procmail_pipe:
25156   driver = pipe
25157   command = /usr/local/bin/procmail -d $local_part_data
25158   return_path_add
25159   delivery_date_add
25160   envelope_to_add
25161   check_string = "From "
25162   escape_string = ">From "
25163   umask = 077
25164   user = $local_part_data
25165   group = mail
25166
25167 # router
25168 procmail:
25169   driver = accept
25170   check_local_user
25171   transport = procmail_pipe
25172 .endd
25173 In this example, the pipe is run as the local user, but with the group set to
25174 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25175 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25176 user to supply a correct sender address. If you do not specify either a
25177 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25178 home directory is the user's home directory by default.
25179
25180 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25181 .code
25182 IFS=" "
25183 .endd
25184 as shown in some &%procmail%& documentation, because Exim does not by default
25185 use a shell to run pipe commands.
25186
25187 .cindex "Cyrus"
25188 The next example shows a transport and a router for a system where local
25189 deliveries are handled by the Cyrus IMAP server.
25190 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25191 . but that suffix is tainted so cannot be used in a command arg
25192 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25193 .code
25194 # transport
25195 local_delivery_cyrus:
25196   driver = pipe
25197   command = /usr/cyrus/bin/deliver \
25198             -- $local_part_data
25199   user = cyrus
25200   group = mail
25201   return_output
25202   log_output
25203   message_prefix =
25204   message_suffix =
25205
25206 # router
25207 local_user_cyrus:
25208   driver = accept
25209   check_local_user
25210   transport = local_delivery_cyrus
25211 .endd
25212 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25213 &%return_output%& to cause any text written by Cyrus to be returned to the
25214 sender.
25215 .ecindex IIDpiptra1
25216 .ecindex IIDpiptra2
25217
25218
25219 . ////////////////////////////////////////////////////////////////////////////
25220 . ////////////////////////////////////////////////////////////////////////////
25221
25222 .chapter "The smtp transport" "CHAPsmtptrans"
25223 .scindex IIDsmttra1 "transports" "&(smtp)&"
25224 .scindex IIDsmttra2 "&(smtp)& transport"
25225 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25226 or LMTP protocol. The list of hosts to try can either be taken from the address
25227 that is being processed (having been set up by the router), or specified
25228 explicitly for the transport. Timeout and retry processing (see chapter
25229 &<<CHAPretry>>&) is applied to each IP address independently.
25230
25231
25232 .section "Multiple messages on a single connection" "SECID144"
25233 The sending of multiple messages over a single TCP/IP connection can arise in
25234 two ways:
25235
25236 .ilist
25237 If a message contains more than &%max_rcpt%& (see below) addresses that are
25238 routed to the same host, more than one copy of the message has to be sent to
25239 that host. In this situation, multiple copies may be sent in a single run of
25240 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25241 does when it has too many addresses to send in one message also depends on the
25242 value of the global &%remote_max_parallel%& option. Details are given in
25243 section &<<SECToutSMTPTCP>>&.)
25244 .next
25245 .cindex "hints database" "remembering routing"
25246 When a message has been successfully delivered over a TCP/IP connection, Exim
25247 looks in its hints database to see if there are any other messages awaiting a
25248 connection to the same host. If there are, a new delivery process is started
25249 for one of them, and the current TCP/IP connection is passed on to it. The new
25250 process may in turn send multiple copies and possibly create yet another
25251 process.
25252 .endlist
25253
25254
25255 For each copy sent over the same TCP/IP connection, a sequence counter is
25256 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25257 no further messages are sent over that connection.
25258
25259
25260
25261 .section "Use of the $host and $host_address variables" "SECID145"
25262 .vindex "&$host$&"
25263 .vindex "&$host_address$&"
25264 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25265 &$host_address$& are the name and IP address of the first host on the host list
25266 passed by the router. However, when the transport is about to connect to a
25267 specific host, and while it is connected to that host, &$host$& and
25268 &$host_address$& are set to the values for that host. These are the values
25269 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25270 &%serialize_hosts%&, and the various TLS options are expanded.
25271
25272
25273 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25274 .vindex &$tls_bits$&
25275 .vindex &$tls_cipher$&
25276 .vindex &$tls_peerdn$&
25277 .vindex &$tls_sni$&
25278 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25279 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25280 are the values that were set when the message was received.
25281 These are the values that are used for options that are expanded before any
25282 SMTP connections are made. Just before each connection is made, these four
25283 variables are emptied. If TLS is subsequently started, they are set to the
25284 appropriate values for the outgoing connection, and these are the values that
25285 are in force when any authenticators are run and when the
25286 &%authenticated_sender%& option is expanded.
25287
25288 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25289 and will be removed in a future release.
25290
25291
25292 .section "Private options for smtp" "SECID146"
25293 .cindex "options" "&(smtp)& transport"
25294 The private options of the &(smtp)& transport are as follows:
25295
25296
25297 .option address_retry_include_sender smtp boolean true
25298 .cindex "4&'xx'& responses" "retrying after"
25299 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25300 is the combination of sender and recipient that is delayed in subsequent queue
25301 runs until the retry time is reached. You can delay the recipient without
25302 reference to the sender (which is what earlier versions of Exim did), by
25303 setting &%address_retry_include_sender%& false. However, this can lead to
25304 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25305
25306 .option allow_localhost smtp boolean false
25307 .cindex "local host" "sending to"
25308 .cindex "fallback" "hosts specified on transport"
25309 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25310 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25311 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25312 the delivery anyway. This should be used only in special cases when the
25313 configuration ensures that no looping will result (for example, a differently
25314 configured Exim is listening on the port to which the message is sent).
25315
25316
25317 .option authenticated_sender smtp string&!! unset
25318 .cindex "Cyrus"
25319 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25320 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25321 overriding any existing authenticated sender value. If the string expansion is
25322 forced to fail, the option is ignored. Other expansion failures cause delivery
25323 to be deferred. If the result of expansion is an empty string, that is also
25324 ignored.
25325
25326 The expansion happens after the outgoing connection has been made and TLS
25327 started, if required. This means that the &$host$&, &$host_address$&,
25328 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25329 particular connection.
25330
25331 If the SMTP session is not authenticated, the expansion of
25332 &%authenticated_sender%& still happens (and can cause the delivery to be
25333 deferred if it fails), but no AUTH= item is added to MAIL commands
25334 unless &%authenticated_sender_force%& is true.
25335
25336 This option allows you to use the &(smtp)& transport in LMTP mode to
25337 deliver mail to Cyrus IMAP and provide the proper local part as the
25338 &"authenticated sender"&, via a setting such as:
25339 .code
25340 authenticated_sender = $local_part
25341 .endd
25342 This removes the need for IMAP subfolders to be assigned special ACLs to
25343 allow direct delivery to those subfolders.
25344
25345 Because of expected uses such as that just described for Cyrus (when no
25346 domain is involved), there is no checking on the syntax of the provided
25347 value.
25348
25349
25350 .option authenticated_sender_force smtp boolean false
25351 If this option is set true, the &%authenticated_sender%& option's value
25352 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25353 authenticated as a client.
25354
25355
25356 .option command_timeout smtp time 5m
25357 .cindex timeout "smtp transport command"
25358 This sets a timeout for receiving a response to an SMTP command that has been
25359 sent out. It is also used when waiting for the initial banner line from the
25360 remote host. Its value must not be zero.
25361
25362
25363 .option connect_timeout smtp time 5m
25364 .cindex timeout "smtp transport connect"
25365 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25366 to a remote host. A setting of zero allows the system timeout (typically
25367 several minutes) to act. To have any effect, the value of this option must be
25368 less than the system timeout. However, it has been observed that on some
25369 systems there is no system timeout, which is why the default value for this
25370 option is 5 minutes, a value recommended by RFC 1123.
25371
25372
25373 .option connection_max_messages smtp integer 500
25374 .cindex "SMTP" "passed connection"
25375 .cindex "SMTP" "multiple deliveries"
25376 .cindex "multiple SMTP deliveries"
25377 This controls the maximum number of separate message deliveries that are sent
25378 over a single TCP/IP connection. If the value is zero, there is no limit.
25379 For testing purposes, this value can be overridden by the &%-oB%& command line
25380 option.
25381
25382 .new
25383 .cindex "ESMTP extensions" LIMITS
25384 If the peer advertises a LIMITS extension with a MAILMAX value,
25385 and either TLSS is in use or was not advertised,
25386 that value also constrains the result of this option.
25387 .wen
25388
25389
25390 .option dane_require_tls_ciphers smtp string&!! unset
25391 .cindex "TLS" "requiring specific ciphers for DANE"
25392 .cindex "cipher" "requiring specific"
25393 .cindex DANE "TLS ciphers"
25394 This option may be used to override &%tls_require_ciphers%& for connections
25395 where DANE has been determined to be in effect.
25396 If not set, then &%tls_require_ciphers%& will be used.
25397 Normal SMTP delivery is not able to make strong demands of TLS cipher
25398 configuration, because delivery will fall back to plaintext.  Once DANE has
25399 been determined to be in effect, there is no plaintext fallback and making the
25400 TLS cipherlist configuration stronger will increase security, rather than
25401 counter-intuitively decreasing it.
25402 If the option expands to be empty or is forced to fail, then it will
25403 be treated as unset and &%tls_require_ciphers%& will be used instead.
25404
25405
25406 .option data_timeout smtp time 5m
25407 .cindex timeout "for transmitted SMTP data blocks"
25408 This sets a timeout for the transmission of each block in the data portion of
25409 the message. As a result, the overall timeout for a message depends on the size
25410 of the message. Its value must not be zero. See also &%final_timeout%&.
25411
25412
25413 .option dkim_canon smtp string&!! unset
25414 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25415 .option dkim_domain smtp "string list&!!" unset
25416 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25417 .option dkim_hash smtp string&!! sha256
25418 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25419 .option dkim_identity smtp string&!! unset
25420 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25421 .option dkim_private_key smtp string&!! unset
25422 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25423 .option dkim_selector smtp string&!! unset
25424 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25425 .option dkim_strict smtp string&!! unset
25426 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25427 .option dkim_sign_headers smtp string&!! "per RFC"
25428 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25429 .option dkim_timestamps smtp string&!! unset
25430 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25431
25432
25433 .option delay_after_cutoff smtp boolean true
25434 .cindex "final cutoff" "retries, controlling"
25435 .cindex retry "final cutoff"
25436 This option controls what happens when all remote IP addresses for a given
25437 domain have been inaccessible for so long that they have passed their retry
25438 cutoff times.
25439
25440 In the default state, if the next retry time has not been reached for any of
25441 them, the address is bounced without trying any deliveries. In other words,
25442 Exim delays retrying an IP address after the final cutoff time until a new
25443 retry time is reached, and can therefore bounce an address without ever trying
25444 a delivery, when machines have been down for a long time. Some people are
25445 unhappy at this prospect, so...
25446
25447 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25448 addresses are past their final cutoff time, Exim tries to deliver to those
25449 IP addresses that have not been tried since the message arrived. If there are
25450 none, of if they all fail, the address is bounced. In other words, it does not
25451 delay when a new message arrives, but immediately tries those expired IP
25452 addresses that haven't been tried since the message arrived. If there is a
25453 continuous stream of messages for the dead hosts, unsetting
25454 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25455 to them.
25456
25457
25458 .option dns_qualify_single smtp boolean true
25459 If the &%hosts%& or &%fallback_hosts%& option is being used,
25460 and the &%gethostbyname%& option is false,
25461 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25462 in chapter &<<CHAPdnslookup>>& for more details.
25463
25464
25465 .option dns_search_parents smtp boolean false
25466 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25467 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25468 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25469 details.
25470
25471
25472 .option dnssec_request_domains smtp "domain list&!!" *
25473 .cindex "MX record" "security"
25474 .cindex "DNSSEC" "MX lookup"
25475 .cindex "security" "MX lookup"
25476 .cindex "DNS" "DNSSEC"
25477 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25478 the DNSSEC request bit set. Setting this transport option is only useful if the
25479 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25480 router option.
25481
25482
25483
25484 .option dnssec_require_domains smtp "domain list&!!" unset
25485 .cindex "MX record" "security"
25486 .cindex "DNSSEC" "MX lookup"
25487 .cindex "security" "MX lookup"
25488 .cindex "DNS" "DNSSEC"
25489 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25490 the DNSSEC request bit set.  Setting this transport option is only
25491 useful if the transport overrides or sets the host names. See the
25492 &%dnssec_require_domains%& router option.
25493
25494
25495
25496 .option dscp smtp string&!! unset
25497 .cindex "DCSP" "outbound"
25498 This option causes the DSCP value associated with a socket to be set to one
25499 of a number of fixed strings or to numeric value.
25500 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25501 Common values include &`throughput`&, &`mincost`&, and on newer systems
25502 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25503
25504 The outbound packets from Exim will be marked with this value in the header
25505 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25506 that these values will have any effect, not be stripped by networking
25507 equipment, or do much of anything without cooperation with your Network
25508 Engineer and those of all network operators between the source and destination.
25509
25510
25511 .option fallback_hosts smtp "string list" unset
25512 .cindex "fallback" "hosts specified on transport"
25513 String expansion is not applied to this option. The argument must be a
25514 colon-separated list of host names or IP addresses, optionally also including
25515 port numbers, though the separator can be changed, as described in section
25516 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25517 item in a &%route_list%& setting for the &(manualroute)& router, as described
25518 in section &<<SECTformatonehostitem>>&.
25519
25520 Fallback hosts can also be specified on routers, which associate them with the
25521 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25522 &%fallback_hosts%& specified on the transport is used only if the address does
25523 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25524 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25525 However, &%hosts_randomize%& does apply to fallback host lists.
25526
25527 If Exim is unable to deliver to any of the hosts for a particular address, and
25528 the errors are not permanent rejections, the address is put on a separate
25529 transport queue with its host list replaced by the fallback hosts, unless the
25530 address was routed via MX records and the current host was in the original MX
25531 list. In that situation, the fallback host list is not used.
25532
25533 Once normal deliveries are complete, the fallback queue is delivered by
25534 re-running the same transports with the new host lists. If several failing
25535 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25536 copy of the message is sent.
25537
25538 The resolution of the host names on the fallback list is controlled by the
25539 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25540 both to cases when the host list comes with the address and when it is taken
25541 from &%hosts%&. This option provides a &"use a smart host only if delivery
25542 fails"& facility.
25543
25544
25545 .option final_timeout smtp time 10m
25546 .cindex timeout "for transmitted SMTP data accept"
25547 This is the timeout that applies while waiting for the response to the final
25548 line containing just &"."& that terminates a message. Its value must not be
25549 zero.
25550
25551 .option gethostbyname smtp boolean false
25552 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25553 being used, names are looked up using &[gethostbyname()]&
25554 (or &[getipnodebyname()]& when available)
25555 instead of using the DNS. Of course, that function may in fact use the DNS, but
25556 it may also consult other sources of information such as &_/etc/hosts_&.
25557
25558 .option gnutls_compat_mode smtp boolean unset
25559 This option controls whether GnuTLS is used in compatibility mode in an Exim
25560 server. This reduces security slightly, but improves interworking with older
25561 implementations of TLS.
25562
25563 .option helo_data smtp string&!! "see below"
25564 .cindex "HELO" "argument, setting"
25565 .cindex "EHLO" "argument, setting"
25566 .cindex "LHLO argument setting"
25567 The value of this option is expanded after a connection to a another host has
25568 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25569 command that starts the outgoing SMTP or LMTP session. The default value of the
25570 option is:
25571 .code
25572 $primary_hostname
25573 .endd
25574 During the expansion, the variables &$host$& and &$host_address$& are set to
25575 the identity of the remote host, and the variables &$sending_ip_address$& and
25576 &$sending_port$& are set to the local IP address and port number that are being
25577 used. These variables can be used to generate different values for different
25578 servers or different local IP addresses. For example, if you want the string
25579 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25580 interface address, you could use this:
25581 .code
25582 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25583   {${listextract{1}{<\n $value}}} \
25584   {$primary_hostname}}
25585 .endd
25586 The use of &%helo_data%& applies both to sending messages and when doing
25587 callouts.
25588
25589 .option host_name_extract smtp "string list&!!" "see below"
25590 .cindex "load balancer" "hosts behind"
25591 .cindex TLS resumption
25592 Some mail-accepting sites
25593 (notably Microsoft)
25594 operate many servers behind a network load-balancer.  When this is done,
25595 with separated TLS session caches, TLS session resuption becomes problematic.
25596 It will only succeed when the same server happens to be selected by the
25597 load-balancer, matching the session stored in the client's cache.
25598
25599 Exim can pull out a server name, if there is one, from the response to the
25600 client's SMTP EHLO command.
25601 For normal STARTTLS use, the default value of this option:
25602 .code
25603     ${if and { {match {$host} {.outlook.com\$}} \
25604                {match {$item} {\N^250-([\w.]+)\s\N}} \
25605              } {$1}}
25606 .endd
25607 suffices for one known case.
25608
25609 During the expansion of this option the &$item$& variable will have the
25610 server's EHLO response.
25611
25612 .new
25613 For TLS-on-connect connections we do not have an EHLO
25614 response to use. Because of this the default value of this option is
25615 set to a static string for those cases, meaning that resumption will
25616 always be attempted if permitted by the &%tls_resumption_hosts%& option.
25617 .wen
25618
25619 The result of the option expansion is included in the key used to store and
25620 retrieve the TLS session, for session resumption.
25621
25622 Operators of high-load sites may wish to evaluate their logs for indications
25623 of other destination sites operating load-balancers, and develop a suitable
25624 expression for this option.
25625 The smtp:ehlo event and the &$tls_out_resumption$& variable
25626 will be useful for such work.
25627
25628 .option hosts smtp "string list&!!" unset
25629 Hosts are associated with an address by a router such as &(dnslookup)&, which
25630 finds the hosts by looking up the address domain in the DNS, or by
25631 &(manualroute)&, which has lists of hosts in its configuration. However,
25632 email addresses can be passed to the &(smtp)& transport by any router, and not
25633 all of them can provide an associated list of hosts.
25634
25635 The &%hosts%& option specifies a list of hosts to be used if the address being
25636 processed does not have any hosts associated with it. The hosts specified by
25637 &%hosts%& are also used, whether or not the address has its own hosts, if
25638 &%hosts_override%& is set.
25639
25640 The string is first expanded, before being interpreted as a colon-separated
25641 list of host names or IP addresses, possibly including port numbers. The
25642 separator may be changed to something other than colon, as described in section
25643 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25644 item in a &%route_list%& setting for the &(manualroute)& router, as described
25645 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25646 of the &(manualroute)& router is not available here.
25647
25648 If the expansion fails, delivery is deferred. Unless the failure was caused by
25649 the inability to complete a lookup, the error is logged to the panic log as
25650 well as the main log. Host names are looked up either by searching directly for
25651 address records in the DNS or by calling &[gethostbyname()]& (or
25652 &[getipnodebyname()]& when available), depending on the setting of the
25653 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25654 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25655 address are used.
25656
25657 During delivery, the hosts are tried in order, subject to their retry status,
25658 unless &%hosts_randomize%& is set.
25659
25660
25661 .option hosts_avoid_esmtp smtp "host list&!!" unset
25662 .cindex "ESMTP, avoiding use of"
25663 .cindex "HELO" "forcing use of"
25664 .cindex "EHLO" "avoiding use of"
25665 .cindex "PIPELINING" "avoiding the use of"
25666 This option is for use with broken hosts that announce ESMTP facilities (for
25667 example, PIPELINING) and then fail to implement them properly. When a host
25668 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25669 start of the SMTP session. This means that it cannot use any of the ESMTP
25670 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25671
25672
25673 .option hosts_avoid_pipelining smtp "host list&!!" unset
25674 .cindex "PIPELINING" "avoiding the use of"
25675 .cindex "ESMTP extensions" PIPELINING
25676 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25677 that matches this list, even if the server host advertises PIPELINING support.
25678
25679 .option hosts_pipe_connect smtp "host list&!!" unset
25680 .cindex "pipelining" "early connection"
25681 .cindex "pipelining" PIPECONNECT
25682 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25683 this option controls which to hosts the facility watched for
25684 and recorded, and used for subsequent connections.
25685
25686 The retry hints database is used for the record,
25687 and records are subject to the &%retry_data_expire%& option.
25688 When used, the pipelining saves on roundtrip times.
25689 It also turns SMTP into a client-first protocol
25690 so combines well with TCP Fast Open.
25691
25692 See also the &%pipelining_connect_advertise_hosts%& main option.
25693
25694 Note:
25695 When the facility is used, if the transport &%interface%& option is unset
25696 the &%helo_data%& option
25697 will be expanded before the &$sending_ip_address$& variable
25698 is filled in.
25699 A check is made for the use of that variable, without the
25700 presence of a &"def:"& test on it, but suitably complex coding
25701 can avoid the check and produce unexpected results.
25702 You have been warned.
25703
25704
25705 .option hosts_avoid_tls smtp "host list&!!" unset
25706 .cindex "TLS" "avoiding for certain hosts"
25707 Exim will not try to start a TLS session when delivering to any host that
25708 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25709
25710 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25711 .cindex "TLS" "avoiding for certain hosts"
25712 Exim will not try to start a TLS session for a verify callout,
25713 or when delivering in cutthrough mode,
25714 to any host that matches this list.
25715
25716
25717 .option hosts_max_try smtp integer 5
25718 .cindex "host" "maximum number to try"
25719 .cindex "limit" "number of hosts tried"
25720 .cindex "limit" "number of MX tried"
25721 .cindex "MX record" "maximum tried"
25722 This option limits the number of IP addresses that are tried for any one
25723 delivery in cases where there are temporary delivery errors. Section
25724 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25725
25726
25727 .option hosts_max_try_hardlimit smtp integer 50
25728 This is an additional check on the maximum number of IP addresses that Exim
25729 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25730 why it exists.
25731
25732
25733
25734 .option hosts_nopass_tls smtp "host list&!!" unset
25735 .cindex "TLS" "passing connection"
25736 .cindex "multiple SMTP deliveries"
25737 .cindex "TLS" "multiple message deliveries"
25738 For any host that matches this list, a connection on which a TLS session has
25739 been started will not be passed to a new delivery process for sending another
25740 message on the same connection. See section &<<SECTmulmessam>>& for an
25741 explanation of when this might be needed.
25742
25743 .option hosts_noproxy_tls smtp "host list&!!" unset
25744 .cindex "TLS" "passing connection"
25745 .cindex "multiple SMTP deliveries"
25746 .cindex "TLS" "multiple message deliveries"
25747 For any host that matches this list, a TLS session which has
25748 been started will not be passed to a new delivery process for sending another
25749 message on the same session.
25750
25751 The traditional implementation closes down TLS and re-starts it in the new
25752 process, on the same open TCP connection, for each successive message
25753 sent.  If permitted by this option a pipe to to the new process is set up
25754 instead, and the original process maintains the TLS connection and proxies
25755 the SMTP connection from and to the new process and any subsequents.
25756 The new process has no access to TLS information, so cannot include it in
25757 logging.
25758
25759
25760
25761 .option hosts_override smtp boolean false
25762 If this option is set and the &%hosts%& option is also set, any hosts that are
25763 attached to the address are ignored, and instead the hosts specified by the
25764 &%hosts%& option are always used. This option does not apply to
25765 &%fallback_hosts%&.
25766
25767
25768 .option hosts_randomize smtp boolean false
25769 .cindex "randomized host list"
25770 .cindex "host" "list of; randomized"
25771 .cindex "fallback" "randomized hosts"
25772 If this option is set, and either the list of hosts is taken from the
25773 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25774 were not obtained from MX records (this includes fallback hosts from the
25775 router), and were not randomized by the router, the order of trying the hosts
25776 is randomized each time the transport runs. Randomizing the order of a host
25777 list can be used to do crude load sharing.
25778
25779 When &%hosts_randomize%& is true, a host list may be split into groups whose
25780 order is separately randomized. This makes it possible to set up MX-like
25781 behaviour. The boundaries between groups are indicated by an item that is just
25782 &`+`& in the host list. For example:
25783 .code
25784 hosts = host1:host2:host3:+:host4:host5
25785 .endd
25786 The order of the first three hosts and the order of the last two hosts is
25787 randomized for each use, but the first three always end up before the last two.
25788 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25789
25790 .option hosts_require_auth smtp "host list&!!" unset
25791 .cindex "authentication" "required by client"
25792 This option provides a list of servers for which authentication must succeed
25793 before Exim will try to transfer a message. If authentication fails for
25794 servers which are not in this list, Exim tries to send unauthenticated. If
25795 authentication fails for one of these servers, delivery is deferred. This
25796 temporary error is detectable in the retry rules, so it can be turned into a
25797 hard failure if required. See also &%hosts_try_auth%&, and chapter
25798 &<<CHAPSMTPAUTH>>& for details of authentication.
25799
25800
25801 .option hosts_request_ocsp smtp "host list&!!" "see below"
25802 .cindex "TLS" "requiring for certain servers"
25803 Exim will request a Certificate Status on a
25804 TLS session for any host that matches this list.
25805 &%tls_verify_certificates%& should also be set for the transport.
25806
25807 The default is &"**"& if DANE is not in use for the connection,
25808 or if DANE-TA us used.
25809 It is empty if DANE-EE is used.
25810
25811 .option hosts_require_alpn smtp "host list&!!" unset
25812 .cindex ALPN "require negotiation in client"
25813 .cindex TLS ALPN
25814 .cindex TLS "Application Layer Protocol Names"
25815 If the TLS library supports ALPN
25816 then a successful negotiation of ALPN will be required for any host
25817 matching the list, for TLS to be used.
25818 See also the &%tls_alpn%& option.
25819
25820 &*Note*&: prevention of fallback to in-clear connection is not
25821 managed by this option; see &%hosts_require_tls%&.
25822
25823 .option hosts_require_dane smtp "host list&!!" unset
25824 .cindex DANE "transport options"
25825 .cindex DANE "requiring for certain servers"
25826 If built with DANE support, Exim  will require that a DNSSEC-validated
25827 TLSA record is present for any host matching the list,
25828 and that a DANE-verified TLS connection is made.
25829 There will be no fallback to in-clear communication.
25830 See the &%dnssec_request_domains%& router and transport options.
25831 See section &<<SECDANE>>&.
25832
25833 .option hosts_require_ocsp smtp "host list&!!" unset
25834 .cindex "TLS" "requiring for certain servers"
25835 Exim will request, and check for a valid Certificate Status being given, on a
25836 TLS session for any host that matches this list.
25837 &%tls_verify_certificates%& should also be set for the transport.
25838
25839 .option hosts_require_tls smtp "host list&!!" unset
25840 .cindex "TLS" "requiring for certain servers"
25841 Exim will insist on using a TLS session when delivering to any host that
25842 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25843 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25844 incoming messages, use an appropriate ACL.
25845
25846 .option hosts_try_auth smtp "host list&!!" unset
25847 .cindex "authentication" "optional in client"
25848 This option provides a list of servers to which, provided they announce
25849 authentication support, Exim will attempt to authenticate as a client when it
25850 connects. If authentication fails
25851 and &%hosts_require_auth%& permits,
25852 Exim will try to transfer the message unauthenticated.
25853 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25854
25855 .option hosts_try_chunking smtp "host list&!!" *
25856 .cindex CHUNKING "enabling, in client"
25857 .cindex BDAT "SMTP command"
25858 .cindex "RFC 3030" "CHUNKING"
25859 This option provides a list of servers to which, provided they announce
25860 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25861 Unless DKIM signing is being done,
25862 BDAT will not be used in conjunction with a transport filter.
25863
25864 .option hosts_try_dane smtp "host list&!!" *
25865 .cindex DANE "transport options"
25866 .cindex DANE "attempting for certain servers"
25867 If built with DANE support, Exim  will look up a
25868 TLSA record for any host matching the list,
25869 If one is found and that lookup was DNSSEC-validated,
25870 then Exim requires that a DANE-verified TLS connection is made for that host;
25871 there will be no fallback to in-clear communication.
25872 See the &%dnssec_request_domains%& router and transport options.
25873 See section &<<SECDANE>>&.
25874
25875 .option hosts_try_fastopen smtp "host list&!!" *
25876 .cindex "fast open, TCP" "enabling, in client"
25877 .cindex "TCP Fast Open" "enabling, in client"
25878 .cindex "RFC 7413" "TCP Fast Open"
25879 This option provides a list of servers to which, provided
25880 the facility is supported by this system, Exim will attempt to
25881 perform a TCP Fast Open.
25882 No data is sent on the SYN segment but, if the remote server also
25883 supports the facility, it can send its SMTP banner immediately after
25884 the SYN,ACK segment.  This can save up to one round-trip time.
25885
25886 The facility is only active for previously-contacted servers,
25887 as the initiator must present a cookie in the SYN segment.
25888
25889 On (at least some) current Linux distributions the facility must be enabled
25890 in the kernel by the sysadmin before the support is usable.
25891 There is no option for control of the server side; if the system supports
25892 it it is always enabled.  Note that lengthy operations in the connect ACL,
25893 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25894
25895 .option hosts_try_prdr smtp "host list&!!" *
25896 .cindex "PRDR" "enabling, optional in client"
25897 .cindex "ESMTP extensions" PRDR
25898 This option provides a list of servers to which, provided they announce
25899 PRDR support, Exim will attempt to negotiate PRDR
25900 for multi-recipient messages.
25901 The option can usually be left as default.
25902
25903 .option interface smtp "string list&!!" unset
25904 .cindex "bind IP address"
25905 .cindex "IP address" "binding"
25906 .vindex "&$host$&"
25907 .vindex "&$host_address$&"
25908 This option specifies which interface to bind to when making an outgoing SMTP
25909 call. The value is an IP address, not an interface name such as
25910 &`eth0`&. Do not confuse this with the interface address that was used when a
25911 message was received, which is in &$received_ip_address$&, formerly known as
25912 &$interface_address$&. The name was changed to minimize confusion with the
25913 outgoing interface address. There is no variable that contains an outgoing
25914 interface address because, unless it is set by this option, its value is
25915 unknown.
25916
25917 During the expansion of the &%interface%& option the variables &$host$& and
25918 &$host_address$& refer to the host to which a connection is about to be made
25919 during the expansion of the string. Forced expansion failure, or an empty
25920 string result causes the option to be ignored. Otherwise, after expansion, the
25921 string must be a list of IP addresses, colon-separated by default, but the
25922 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25923 For example:
25924 .code
25925 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25926 .endd
25927 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25928 connection. If none of them are the correct type, the option is ignored. If
25929 &%interface%& is not set, or is ignored, the system's IP functions choose which
25930 interface to use if the host has more than one.
25931
25932
25933 .option keepalive smtp boolean true
25934 .cindex "keepalive" "on outgoing connection"
25935 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25936 connections. When set, it causes the kernel to probe idle connections
25937 periodically, by sending packets with &"old"& sequence numbers. The other end
25938 of the connection should send a acknowledgment if the connection is still okay
25939 or a reset if the connection has been aborted. The reason for doing this is
25940 that it has the beneficial effect of freeing up certain types of connection
25941 that can get stuck when the remote host is disconnected without tidying up the
25942 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25943 unreachable hosts.
25944
25945
25946 .option lmtp_ignore_quota smtp boolean false
25947 .cindex "LMTP" "ignoring quota errors"
25948 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25949 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25950 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25951
25952 .option max_rcpt smtp integer&!! 100
25953 .cindex "RCPT" "maximum number of outgoing"
25954 This option,
25955 after expansion,
25956 limits the number of RCPT commands that are sent in a single
25957 SMTP message transaction.
25958 A value setting of zero disables the limit.
25959
25960 If a constant is given,
25961 each set of addresses is treated independently, and
25962 so can cause parallel connections to the same host if &%remote_max_parallel%&
25963 permits this.
25964
25965 .new
25966 .cindex "ESMTP extensions" LIMITS
25967 If the peer advertises a LIMITS extension with a RCPTMAX value,
25968 and either TLSS is in use or was not advertised,
25969 that value also constrains the result of this option
25970 and no parallel connections will be caused on meeting the RCPTMAX limit.
25971 .wen
25972
25973
25974 .option message_linelength_limit smtp integer 998
25975 .cindex "line length" limit
25976 This option sets the maximum line length, in bytes, that the transport
25977 will send.  Any messages with lines exceeding the given value
25978 (before a transport filter, if any)
25979 will fail and a failure-DSN ("bounce") message will if possible be returned
25980 to the sender.
25981 The default value is that defined by the SMTP standards.
25982
25983 It is generally wise to also check in the data ACL so that messages
25984 received via SMTP can be refused without producing a bounce.
25985
25986
25987 .option multi_domain smtp boolean&!! true
25988 .vindex "&$domain$&"
25989 When this option is set, the &(smtp)& transport can handle a number of
25990 addresses containing a mixture of different domains provided they all resolve
25991 to the same list of hosts. Turning the option off restricts the transport to
25992 handling only one domain at a time. This is useful if you want to use
25993 &$domain$& in an expansion for the transport, because it is set only when there
25994 is a single domain involved in a remote delivery.
25995
25996 It is expanded per-address and can depend on any of
25997 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25998 &$host$&, &$host_address$& and &$host_port$&.
25999
26000 If the connection is DANE-enabled then this option is ignored;
26001 only messages having the domain used for the DANE TLSA lookup are
26002 sent on the connection.
26003
26004 .new
26005 .cindex "ESMTP extensions" LIMITS
26006 If the peer advertises a LIMITS extension with a RCPTDOMAINMAX value,
26007 and either TLSS is in use or was not advertised,
26008 this option is regarded as being false.
26009 .wen
26010
26011
26012 .option port smtp string&!! "see below"
26013 .cindex "port" "sending TCP/IP"
26014 .cindex "TCP/IP" "setting outgoing port"
26015 This option specifies the TCP/IP port on the server to which Exim connects.
26016 &*Note:*& Do not confuse this with the port that was used when a message was
26017 received, which is in &$received_port$&, formerly known as &$interface_port$&.
26018 The name was changed to minimize confusion with the outgoing port. There is no
26019 variable that contains an outgoing port.
26020
26021 If the value of this option begins with a digit it is taken as a port number;
26022 otherwise it is looked up using &[getservbyname()]&. The default value is
26023 normally &"smtp"&,
26024 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
26025 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
26026 If the expansion fails, or if a port number cannot be found, delivery
26027 is deferred.
26028
26029 Note that at least one Linux distribution has been seen failing
26030 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
26031
26032
26033
26034 .option protocol smtp string smtp
26035 .cindex "LMTP" "over TCP/IP"
26036 .cindex "ssmtp protocol" "outbound"
26037 .cindex "TLS" "SSL-on-connect outbound"
26038 .vindex "&$port$&"
26039 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
26040 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
26041 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
26042 deliveries into closed message stores. Exim also has support for running LMTP
26043 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
26044
26045 If this option is set to &"smtps"&, the default value for the &%port%& option
26046 changes to &"smtps"&, and the transport initiates TLS immediately after
26047 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
26048 The Internet standards bodies used to strongly discourage use of this mode,
26049 but as of RFC 8314 it is preferred over STARTTLS for message submission
26050 (as distinct from MTA-MTA communication).
26051
26052
26053 .option retry_include_ip_address smtp boolean&!! true
26054 Exim normally includes both the host name and the IP address in the key it
26055 constructs for indexing retry data after a temporary delivery failure. This
26056 means that when one of several IP addresses for a host is failing, it gets
26057 tried periodically (controlled by the retry rules), but use of the other IP
26058 addresses is not affected.
26059
26060 However, in some dialup environments hosts are assigned a different IP address
26061 each time they connect. In this situation the use of the IP address as part of
26062 the retry key leads to undesirable behaviour. Setting this option false causes
26063 Exim to use only the host name.
26064 Since it is expanded it can be made to depend on the host or domain.
26065
26066
26067 .option serialize_hosts smtp "host list&!!" unset
26068 .cindex "serializing connections"
26069 .cindex "host" "serializing connections"
26070 Because Exim operates in a distributed manner, if several messages for the same
26071 host arrive at around the same time, more than one simultaneous connection to
26072 the remote host can occur. This is not usually a problem except when there is a
26073 slow link between the hosts. In that situation it may be helpful to restrict
26074 Exim to one connection at a time. This can be done by setting
26075 &%serialize_hosts%& to match the relevant hosts.
26076
26077 .cindex "hints database" "serializing deliveries to a host"
26078 Exim implements serialization by means of a hints database in which a record is
26079 written whenever a process connects to one of the restricted hosts. The record
26080 is deleted when the connection is completed. Obviously there is scope for
26081 records to get left lying around if there is a system or program crash. To
26082 guard against this, Exim ignores any records that are more than six hours old.
26083
26084 If you set up this kind of serialization, you should also arrange to delete the
26085 relevant hints database whenever your system reboots. The names of the files
26086 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26087 may be one or two files, depending on the type of DBM in use. The same files
26088 are used for ETRN serialization.
26089
26090 See also the &%max_parallel%& generic transport option.
26091
26092
26093 .option size_addition smtp integer 1024
26094 .cindex "SIZE" "ESMTP extension"
26095 .cindex "message" "size issue for transport filter"
26096 .cindex "size" "of message"
26097 .cindex "transport" "filter"
26098 .cindex "filter" "transport filter"
26099 If a remote SMTP server indicates that it supports the SIZE option of the
26100 MAIL command, Exim uses this to pass over the message size at the start of
26101 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26102 sends, to allow for headers and other text that may be added during delivery by
26103 configuration options or in a transport filter. It may be necessary to increase
26104 this if a lot of text is added to messages.
26105
26106 Alternatively, if the value of &%size_addition%& is set negative, it disables
26107 the use of the SIZE option altogether.
26108
26109
26110 .option socks_proxy smtp string&!! unset
26111 .cindex proxy SOCKS
26112 This option enables use of SOCKS proxies for connections made by the
26113 transport.  For details see section &<<SECTproxySOCKS>>&.
26114
26115
26116 .option tls_alpn smtp string&!! unset
26117 .cindex TLS "Application Layer Protocol Names"
26118 .cindex TLS ALPN
26119 .cindex ALPN "set name in client"
26120 If this option is set
26121 and the TLS library supports ALPN,
26122 the value given is used.
26123
26124 As of writing no value has been standardised for email use.
26125 The authors suggest using &"smtp"&.
26126
26127
26128
26129 .option tls_certificate smtp string&!! unset
26130 .cindex "TLS" "client certificate, location of"
26131 .cindex "certificate" "client, location of"
26132 .vindex "&$host$&"
26133 .vindex "&$host_address$&"
26134 The value of this option must be the absolute path to a file which contains the
26135 client's certificate, for possible use when sending a message over an encrypted
26136 connection. The values of &$host$& and &$host_address$& are set to the name and
26137 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26138 details of TLS.
26139
26140 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26141 certificate when sending messages as a client. The global option of the same
26142 name specifies the certificate for Exim as a server; it is not automatically
26143 assumed that the same certificate should be used when Exim is operating as a
26144 client.
26145
26146
26147 .option tls_crl smtp string&!! unset
26148 .cindex "TLS" "client certificate revocation list"
26149 .cindex "certificate" "revocation list for client"
26150 This option specifies a certificate revocation list. The expanded value must
26151 be the name of a file that contains a CRL in PEM format.
26152
26153
26154 .option tls_dh_min_bits smtp integer 1024
26155 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26156 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26157 key agreement is negotiated, the server will provide a large prime number
26158 for use.  This option establishes the minimum acceptable size of that number.
26159 If the parameter offered by the server is too small, then the TLS handshake
26160 will fail.
26161
26162 Only supported when using GnuTLS.
26163
26164
26165 .option tls_privatekey smtp string&!! unset
26166 .cindex "TLS" "client private key, location of"
26167 .vindex "&$host$&"
26168 .vindex "&$host_address$&"
26169 The value of this option must be the absolute path to a file which contains the
26170 client's private key. This is used when sending a message over an encrypted
26171 connection using a client certificate. The values of &$host$& and
26172 &$host_address$& are set to the name and address of the server during the
26173 expansion. If this option is unset, or the expansion is forced to fail, or the
26174 result is an empty string, the private key is assumed to be in the same file as
26175 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26176
26177
26178 .option tls_require_ciphers smtp string&!! unset
26179 .cindex "TLS" "requiring specific ciphers"
26180 .cindex "cipher" "requiring specific"
26181 .vindex "&$host$&"
26182 .vindex "&$host_address$&"
26183 The value of this option must be a list of permitted cipher suites, for use
26184 when setting up an outgoing encrypted connection. (There is a global option of
26185 the same name for controlling incoming connections.) The values of &$host$& and
26186 &$host_address$& are set to the name and address of the server during the
26187 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26188 is used in different ways by OpenSSL and GnuTLS (see sections
26189 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26190 ciphers is a preference order.
26191
26192
26193 .option tls_resumption_hosts smtp "host list&!!" unset
26194 .cindex TLS resumption
26195 This option controls which connections to use the TLS resumption feature.
26196 See &<<SECTresumption>>& for details.
26197
26198
26199
26200 .option tls_sni smtp string&!! unset
26201 .cindex "TLS" "Server Name Indication"
26202 .cindex "TLS" SNI
26203 .cindex SNI "setting in client"
26204 .vindex "&$tls_sni$&"
26205 If this option is set
26206 and the connection is not DANE-validated
26207 then it sets the $tls_out_sni variable and causes any
26208 TLS session to pass this value as the Server Name Indication extension to
26209 the remote side, which can be used by the remote side to select an appropriate
26210 certificate and private key for the session.
26211
26212 See &<<SECTtlssni>>& for more information.
26213
26214 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26215 TLS extensions.
26216
26217
26218
26219
26220 .option tls_tempfail_tryclear smtp boolean true
26221 .cindex "4&'xx'& responses" "to STARTTLS"
26222 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26223 setting up a TLS session, this option determines whether or not Exim should try
26224 to deliver the message unencrypted. If it is set false, delivery to the
26225 current host is deferred; if there are other hosts, they are tried. If this
26226 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26227 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26228 TLS negotiation fails, Exim closes the current connection (because it is in an
26229 unknown state), opens a new one to the same host, and then tries the delivery
26230 in clear.
26231
26232
26233 .option tls_try_verify_hosts smtp "host list&!!" *
26234 .cindex "TLS" "server certificate verification"
26235 .cindex "certificate" "verification of server"
26236 This option gives a list of hosts for which, on encrypted connections,
26237 certificate verification will be tried but need not succeed.
26238 The &%tls_verify_certificates%& option must also be set.
26239 Note that unless the host is in this list
26240 TLS connections will be denied to hosts using self-signed certificates
26241 when &%tls_verify_certificates%& is matched.
26242 The &$tls_out_certificate_verified$& variable is set when
26243 certificate verification succeeds.
26244
26245
26246 .option tls_verify_cert_hostnames smtp "host list&!!" *
26247 .cindex "TLS" "server certificate hostname verification"
26248 .cindex "certificate" "verification of server"
26249 This option give a list of hosts for which,
26250 while verifying the server certificate,
26251 checks will be included on the host name
26252 (note that this will generally be the result of a DNS MX lookup)
26253 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26254 Wildcard names are permitted,
26255 limited to being the initial component of a 3-or-more component FQDN.
26256
26257 There is no equivalent checking on client certificates.
26258
26259
26260 .option tls_verify_certificates smtp string&!! system
26261 .cindex "TLS" "server certificate verification"
26262 .cindex "certificate" "verification of server"
26263 .vindex "&$host$&"
26264 .vindex "&$host_address$&"
26265 The value of this option must be either the
26266 word "system"
26267 or the absolute path to
26268 a file or directory containing permitted certificates for servers,
26269 for use when setting up an encrypted connection.
26270
26271 The "system" value for the option will use a location compiled into the SSL library.
26272 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26273 is taken as empty and an explicit location
26274 must be specified.
26275
26276 The use of a directory for the option value is not available for GnuTLS versions
26277 preceding 3.3.6 and a single file must be used.
26278
26279 With OpenSSL the certificates specified
26280 explicitly
26281 either by file or directory
26282 are added to those given by the system default location.
26283
26284 The values of &$host$& and
26285 &$host_address$& are set to the name and address of the server during the
26286 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26287
26288 For back-compatibility,
26289 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26290 (a single-colon empty list counts as being set)
26291 and certificate verification fails the TLS connection is closed.
26292
26293
26294 .option tls_verify_hosts smtp "host list&!!" unset
26295 .cindex "TLS" "server certificate verification"
26296 .cindex "certificate" "verification of server"
26297 This option gives a list of hosts for which, on encrypted connections,
26298 certificate verification must succeed.
26299 The &%tls_verify_certificates%& option must also be set.
26300 If both this option and &%tls_try_verify_hosts%& are unset
26301 operation is as if this option selected all hosts.
26302 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26303 that connections use TLS.
26304 Fallback to in-clear communication will be done unless restricted by
26305 the &%hosts_require_tls%& option.
26306
26307 .option utf8_downconvert smtp integer&!! -1
26308 .cindex utf8 "address downconversion"
26309 .cindex i18n "utf8 address downconversion"
26310 If built with internationalization support,
26311 this option controls conversion of UTF-8 in message envelope addresses
26312 to a-label form.
26313 If, after expansion, the value is 1, 0, or -1 then this value overrides
26314 any value previously set for the message.  Otherwise, any previously
26315 set value is used.  To permit use of a previous value,
26316 set this option to an empty string.
26317 For details on the values see section &<<SECTi18nMTA>>&.
26318
26319
26320
26321
26322 .section "How the limits for the number of hosts to try are used" &&&
26323          "SECTvalhosmax"
26324 .cindex "host" "maximum number to try"
26325 .cindex "limit" "hosts; maximum number tried"
26326 There are two options that are concerned with the number of hosts that are
26327 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26328 &%hosts_max_try_hardlimit%&.
26329
26330
26331 The &%hosts_max_try%& option limits the number of hosts that are tried
26332 for a single delivery. However, despite the term &"host"& in its name, the
26333 option actually applies to each IP address independently. In other words, a
26334 multihomed host is treated as several independent hosts, just as it is for
26335 retrying.
26336
26337 Many of the larger ISPs have multiple MX records which often point to
26338 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26339 created as a result of routing one of these domains.
26340
26341 Trying every single IP address on such a long list does not seem sensible; if
26342 several at the top of the list fail, it is reasonable to assume there is some
26343 problem that is likely to affect all of them. Roughly speaking, the value of
26344 &%hosts_max_try%& is the maximum number that are tried before deferring the
26345 delivery. However, the logic cannot be quite that simple.
26346
26347 Firstly, IP addresses that are skipped because their retry times have not
26348 arrived do not count, and in addition, addresses that are past their retry
26349 limits are also not counted, even when they are tried. This means that when
26350 some IP addresses are past their retry limits, more than the value of
26351 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26352 that all IP addresses are considered before timing out an email address (but
26353 see below for an exception).
26354
26355 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26356 list to see if there is a subsequent host with a different (higher valued) MX.
26357 If there is, that host is considered next, and the current IP address is used
26358 but not counted. This behaviour helps in the case of a domain with a retry rule
26359 that hardly ever delays any hosts, as is now explained:
26360
26361 Consider the case of a long list of hosts with one MX value, and a few with a
26362 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26363 hosts at the top of the list are tried at first. With the default retry rule,
26364 which specifies increasing retry times, the higher MX hosts are eventually
26365 tried when those at the top of the list are skipped because they have not
26366 reached their retry times.
26367
26368 However, it is common practice to put a fixed short retry time on domains for
26369 large ISPs, on the grounds that their servers are rarely down for very long.
26370 Unfortunately, these are exactly the domains that tend to resolve to long lists
26371 of hosts. The short retry time means that the lowest MX hosts are tried every
26372 time. The attempts may be in a different order because of random sorting, but
26373 without the special MX check, the higher MX hosts would never be tried until
26374 all the lower MX hosts had timed out (which might be several days), because
26375 there are always some lower MX hosts that have reached their retry times. With
26376 the special check, Exim considers at least one IP address from each MX value at
26377 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26378 reached.
26379
26380 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26381 particular, Exim normally eventually tries all the IP addresses before timing
26382 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26383 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26384 been set up with hundreds of IP addresses for some domains. It can
26385 take a very long time indeed for an address to time out in these cases.
26386
26387 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26388 Exim never tries more than this number of IP addresses; if it hits this limit
26389 and they are all timed out, the email address is bounced, even though not all
26390 possible IP addresses have been tried.
26391 .ecindex IIDsmttra1
26392 .ecindex IIDsmttra2
26393
26394
26395
26396
26397
26398 . ////////////////////////////////////////////////////////////////////////////
26399 . ////////////////////////////////////////////////////////////////////////////
26400
26401 .chapter "Address rewriting" "CHAPrewrite"
26402 .scindex IIDaddrew "rewriting" "addresses"
26403 There are some circumstances in which Exim automatically rewrites domains in
26404 addresses. The two most common are when an address is given without a domain
26405 (referred to as an &"unqualified address"&) or when an address contains an
26406 abbreviated domain that is expanded by DNS lookup.
26407
26408 Unqualified envelope addresses are accepted only for locally submitted
26409 messages, or for messages that are received from hosts matching
26410 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26411 appropriate. Unqualified addresses in header lines are qualified if they are in
26412 locally submitted messages, or messages from hosts that are permitted to send
26413 unqualified envelope addresses. Otherwise, unqualified addresses in header
26414 lines are neither qualified nor rewritten.
26415
26416 One situation in which Exim does &'not'& automatically rewrite a domain is
26417 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26418 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26419 do this. The new RFCs do not contain this suggestion.
26420
26421
26422 .section "Explicitly configured address rewriting" "SECID147"
26423 This chapter describes the rewriting rules that can be used in the
26424 main rewrite section of the configuration file, and also in the generic
26425 &%headers_rewrite%& option that can be set on any transport.
26426
26427 Some people believe that configured address rewriting is a Mortal Sin.
26428 Others believe that life is not possible without it. Exim provides the
26429 facility; you do not have to use it.
26430
26431 The main rewriting rules that appear in the &"rewrite"& section of the
26432 configuration file are applied to addresses in incoming messages, both envelope
26433 addresses and addresses in header lines. Each rule specifies the types of
26434 address to which it applies.
26435
26436 Whether or not addresses in header lines are rewritten depends on the origin of
26437 the headers and the type of rewriting. Global rewriting, that is, rewriting
26438 rules from the rewrite section of the configuration file, is applied only to
26439 those headers that were received with the message. Header lines that are added
26440 by ACLs or by a system filter or by individual routers or transports (which
26441 are specific to individual recipient addresses) are not rewritten by the global
26442 rules.
26443
26444 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26445 applies all headers except those added by routers and transports. That is, as
26446 well as the headers that were received with the message, it also applies to
26447 headers that were added by an ACL or a system filter.
26448
26449
26450 In general, rewriting addresses from your own system or domain has some
26451 legitimacy. Rewriting other addresses should be done only with great care and
26452 in special circumstances. The author of Exim believes that rewriting should be
26453 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26454 Although it can sometimes be used as a routing tool, this is very strongly
26455 discouraged.
26456
26457 There are two commonly encountered circumstances where rewriting is used, as
26458 illustrated by these examples:
26459
26460 .ilist
26461 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26462 exchange mail with each other behind a firewall, but there is only a single
26463 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26464 &'hitch.fict.example'& when sending mail off-site.
26465 .next
26466 A host rewrites the local parts of its own users so that, for example,
26467 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26468 .endlist
26469
26470
26471
26472 .section "When does rewriting happen?" "SECID148"
26473 .cindex "rewriting" "timing of"
26474 .cindex "&ACL;" "rewriting addresses in"
26475 Configured address rewriting can take place at several different stages of a
26476 message's processing.
26477
26478 .vindex "&$sender_address$&"
26479 At the start of an ACL for MAIL, the sender address may have been rewritten
26480 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26481 ordinary rewrite rules have yet been applied. If, however, the sender address
26482 is verified in the ACL, it is rewritten before verification, and remains
26483 rewritten thereafter. The subsequent value of &$sender_address$& is the
26484 rewritten address. This also applies if sender verification happens in a
26485 RCPT ACL. Otherwise, when the sender address is not verified, it is
26486 rewritten as soon as a message's header lines have been received.
26487
26488 .vindex "&$domain$&"
26489 .vindex "&$local_part$&"
26490 Similarly, at the start of an ACL for RCPT, the current recipient's address
26491 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26492 rewrite rules have yet been applied to it. However, the behaviour is different
26493 from the sender address when a recipient is verified. The address is rewritten
26494 for the verification, but the rewriting is not remembered at this stage. The
26495 value of &$local_part$& and &$domain$& after verification are always the same
26496 as they were before (that is, they contain the unrewritten &-- except for
26497 SMTP-time rewriting &-- address).
26498
26499 As soon as a message's header lines have been received, all the envelope
26500 recipient addresses are permanently rewritten, and rewriting is also applied to
26501 the addresses in the header lines (if configured). This happens before adding
26502 any header lines that were specified in MAIL or RCPT ACLs, and
26503 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26504 before the DATA ACL and &[local_scan()]& functions are run.
26505
26506 When an address is being routed, either for delivery or for verification,
26507 rewriting is applied immediately to child addresses that are generated by
26508 redirection, unless &%no_rewrite%& is set on the router.
26509
26510 .cindex "envelope from"
26511 .cindex "envelope sender" "rewriting at transport time"
26512 .cindex "rewriting" "at transport time"
26513 .cindex "header lines" "rewriting at transport time"
26514 At transport time, additional rewriting of addresses in header lines can be
26515 specified by setting the generic &%headers_rewrite%& option on a transport.
26516 This option contains rules that are identical in form to those in the rewrite
26517 section of the configuration file. They are applied to the original message
26518 header lines and any that were added by ACLs or a system filter. They are not
26519 applied to header lines that are added by routers or the transport.
26520
26521 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26522 transport option. However, it is not possible to rewrite envelope recipients at
26523 transport time.
26524
26525
26526
26527
26528 .section "Testing the rewriting rules that apply on input" "SECID149"
26529 .cindex "rewriting" "testing"
26530 .cindex "testing" "rewriting"
26531 Exim's input rewriting configuration appears in a part of the runtime
26532 configuration file headed by &"begin rewrite"&. It can be tested by the
26533 &%-brw%& command line option. This takes an address (which can be a full RFC
26534 2822 address) as its argument. The output is a list of how the address would be
26535 transformed by the rewriting rules for each of the different places it might
26536 appear in an incoming message, that is, for each different header and for the
26537 envelope sender and recipient fields. For example,
26538 .code
26539 exim -brw ph10@exim.workshop.example
26540 .endd
26541 might produce the output
26542 .code
26543 sender: Philip.Hazel@exim.workshop.example
26544 from: Philip.Hazel@exim.workshop.example
26545 to: ph10@exim.workshop.example
26546 cc: ph10@exim.workshop.example
26547 bcc: ph10@exim.workshop.example
26548 reply-to: Philip.Hazel@exim.workshop.example
26549 env-from: Philip.Hazel@exim.workshop.example
26550 env-to: ph10@exim.workshop.example
26551 .endd
26552 which shows that rewriting has been set up for that address when used in any of
26553 the source fields, but not when it appears as a recipient address. At the
26554 present time, there is no equivalent way of testing rewriting rules that are
26555 set for a particular transport.
26556
26557
26558 .section "Rewriting rules" "SECID150"
26559 .cindex "rewriting" "rules"
26560 The rewrite section of the configuration file consists of lines of rewriting
26561 rules in the form
26562 .display
26563 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26564 .endd
26565 Rewriting rules that are specified for the &%headers_rewrite%& generic
26566 transport option are given as a colon-separated list. Each item in the list
26567 takes the same form as a line in the main rewriting configuration (except that
26568 any colons must be doubled, of course).
26569
26570 The formats of source patterns and replacement strings are described below.
26571 Each is terminated by white space, unless enclosed in double quotes, in which
26572 case normal quoting conventions apply inside the quotes. The flags are single
26573 characters which may appear in any order. Spaces and tabs between them are
26574 ignored.
26575
26576 For each address that could potentially be rewritten, the rules are scanned in
26577 order, and replacements for the address from earlier rules can themselves be
26578 replaced by later rules (but see the &"q"& and &"R"& flags).
26579
26580 The order in which addresses are rewritten is undefined, may change between
26581 releases, and must not be relied on, with one exception: when a message is
26582 received, the envelope sender is always rewritten first, before any header
26583 lines are rewritten. For example, the replacement string for a rewrite of an
26584 address in &'To:'& must not assume that the message's address in &'From:'& has
26585 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26586 that the envelope sender has already been rewritten.
26587
26588 .vindex "&$domain$&"
26589 .vindex "&$local_part$&"
26590 The variables &$local_part$& and &$domain$& can be used in the replacement
26591 string to refer to the address that is being rewritten. Note that lookup-driven
26592 rewriting can be done by a rule of the form
26593 .code
26594 *@*   ${lookup ...
26595 .endd
26596 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26597 refer to the address that is being rewritten.
26598
26599
26600 .section "Rewriting patterns" "SECID151"
26601 .cindex "rewriting" "patterns"
26602 .cindex "address list" "in a rewriting pattern"
26603 The source pattern in a rewriting rule is any item which may appear in an
26604 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26605 single-item address list, which means that it is expanded before being tested
26606 against the address. As always, if you use a regular expression as a pattern,
26607 you must take care to escape dollar and backslash characters, or use the &`\N`&
26608 facility to suppress string expansion within the regular expression.
26609
26610 Domains in patterns should be given in lower case. Local parts in patterns are
26611 case-sensitive. If you want to do case-insensitive matching of local parts, you
26612 can use a regular expression that starts with &`^(?i)`&.
26613
26614 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26615 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26616 depending on the type of match which occurred. These can be used in the
26617 replacement string to insert portions of the incoming address. &$0$& always
26618 refers to the complete incoming address. When a regular expression is used, the
26619 numerical variables are set from its capturing subexpressions. For other types
26620 of pattern they are set as follows:
26621
26622 .ilist
26623 If a local part or domain starts with an asterisk, the numerical variables
26624 refer to the character strings matched by asterisks, with &$1$& associated with
26625 the first asterisk, and &$2$& with the second, if present. For example, if the
26626 pattern
26627 .code
26628 *queen@*.fict.example
26629 .endd
26630 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26631 .code
26632 $0 = hearts-queen@wonderland.fict.example
26633 $1 = hearts-
26634 $2 = wonderland
26635 .endd
26636 Note that if the local part does not start with an asterisk, but the domain
26637 does, it is &$1$& that contains the wild part of the domain.
26638
26639 .next
26640 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26641 of the domain are placed in the next available numerical variables. Suppose,
26642 for example, that the address &'foo@bar.baz.example'& is processed by a
26643 rewriting rule of the form
26644 .display
26645 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26646 .endd
26647 and the key in the file that matches the domain is &`*.baz.example`&. Then
26648 .code
26649 $1 = foo
26650 $2 = bar
26651 $3 = baz.example
26652 .endd
26653 If the address &'foo@baz.example'& is looked up, this matches the same
26654 wildcard file entry, and in this case &$2$& is set to the empty string, but
26655 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26656 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26657 whole domain. For non-partial domain lookups, no numerical variables are set.
26658 .endlist
26659
26660
26661 .section "Rewriting replacements" "SECID152"
26662 .cindex "rewriting" "replacements"
26663 If the replacement string for a rule is a single asterisk, addresses that
26664 match the pattern and the flags are &'not'& rewritten, and no subsequent
26665 rewriting rules are scanned. For example,
26666 .code
26667 hatta@lookingglass.fict.example  *  f
26668 .endd
26669 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26670 &'From:'& headers.
26671
26672 .vindex "&$domain$&"
26673 .vindex "&$local_part$&"
26674 If the replacement string is not a single asterisk, it is expanded, and must
26675 yield a fully qualified address. Within the expansion, the variables
26676 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26677 Any letters they contain retain their original case &-- they are not lower
26678 cased. The numerical variables are set up according to the type of pattern that
26679 matched the address, as described above. If the expansion is forced to fail by
26680 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26681 current rule is abandoned, but subsequent rules may take effect. Any other
26682 expansion failure causes the entire rewriting operation to be abandoned, and an
26683 entry written to the panic log.
26684
26685
26686
26687 .subsection "Rewriting flags" "SSECID153"
26688 There are three different kinds of flag that may appear on rewriting rules:
26689
26690 .ilist
26691 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26692 c, f, h, r, s, t.
26693 .next
26694 A flag that specifies rewriting at SMTP time: S.
26695 .next
26696 Flags that control the rewriting process: Q, q, R, w.
26697 .endlist
26698
26699 For rules that are part of the &%headers_rewrite%& generic transport option,
26700 E, F, T, and S are not permitted.
26701
26702
26703
26704 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26705          "SSECID154"
26706 .cindex rewriting flags
26707 If none of the following flag letters, nor the &"S"& flag (see section
26708 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26709 and to both the sender and recipient fields of the envelope, whereas a
26710 transport-time rewriting rule just applies to all headers. Otherwise, the
26711 rewriting rule is skipped unless the relevant addresses are being processed.
26712 .display
26713 &`E`&       rewrite all envelope fields
26714 &`F`&       rewrite the envelope From field
26715 &`T`&       rewrite the envelope To field
26716 &`b`&       rewrite the &'Bcc:'& header
26717 &`c`&       rewrite the &'Cc:'& header
26718 &`f`&       rewrite the &'From:'& header
26719 &`h`&       rewrite all headers
26720 &`r`&       rewrite the &'Reply-To:'& header
26721 &`s`&       rewrite the &'Sender:'& header
26722 &`t`&       rewrite the &'To:'& header
26723 .endd
26724 "All headers" means all of the headers listed above that can be selected
26725 individually, plus their &'Resent-'& versions. It does not include
26726 other headers such as &'Subject:'& etc.
26727
26728 You should be particularly careful about rewriting &'Sender:'& headers, and
26729 restrict this to special known cases in your own domains.
26730
26731
26732 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26733 .cindex SMTP "rewriting malformed addresses"
26734 .cindex RCPT "rewriting argument of"
26735 .cindex MAIL "rewriting argument of"
26736 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26737 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26738 before any other processing; even before syntax checking. The pattern is
26739 required to be a regular expression, and it is matched against the whole of the
26740 data for the command, including any surrounding angle brackets.
26741
26742 .vindex "&$domain$&"
26743 .vindex "&$local_part$&"
26744 This form of rewrite rule allows for the handling of addresses that are not
26745 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26746 input). Because the input is not required to be a syntactically valid address,
26747 the variables &$local_part$& and &$domain$& are not available during the
26748 expansion of the replacement string. The result of rewriting replaces the
26749 original address in the MAIL or RCPT command.
26750
26751
26752 .subsection "Flags controlling the rewriting process" SSECID155
26753 There are four flags which control the way the rewriting process works. These
26754 take effect only when a rule is invoked, that is, when the address is of the
26755 correct type (matches the flags) and matches the pattern:
26756
26757 .ilist
26758 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26759 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26760 absence of &"Q"& the rewritten address must always include a domain.
26761 .next
26762 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26763 even if no rewriting actually takes place because of a &"fail"& in the
26764 expansion. The &"q"& flag is not effective if the address is of the wrong type
26765 (does not match the flags) or does not match the pattern.
26766 .next
26767 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26768 address, up to ten times. It can be combined with the &"q"& flag, to stop
26769 rewriting once it fails to match (after at least one successful rewrite).
26770 .next
26771 .cindex "rewriting" "whole addresses"
26772 When an address in a header is rewritten, the rewriting normally applies only
26773 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26774 left unchanged. For example, rewriting might change
26775 .code
26776 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26777 .endd
26778 into
26779 .code
26780 From: Ford Prefect <prefectf@hitch.fict.example>
26781 .endd
26782 .cindex "RFC 2047"
26783 Sometimes there is a need to replace the whole address item, and this can be
26784 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26785 causes an address in a header line to be rewritten, the entire address is
26786 replaced, not just the working part. The replacement must be a complete RFC
26787 2822 address, including the angle brackets if necessary. If text outside angle
26788 brackets contains a character whose value is greater than 126 or less than 32
26789 (except for tab), the text is encoded according to RFC 2047. The character set
26790 is taken from &%headers_charset%&, which gets its default at build time.
26791
26792 When the &"w"& flag is set on a rule that causes an envelope address to be
26793 rewritten, all but the working part of the replacement address is discarded.
26794 .endlist
26795
26796
26797 .section "Rewriting examples" "SECID156"
26798 Here is an example of the two common rewriting paradigms:
26799 .code
26800 *@*.hitch.fict.example  $1@hitch.fict.example
26801 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26802                      {$value}fail}@hitch.fict.example bctfrF
26803 .endd
26804 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26805 the string expansion to fail if the lookup does not succeed. In this context it
26806 has the effect of leaving the original address unchanged, but Exim goes on to
26807 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26808 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26809 explicitly, which would cause the rewritten address to be the same as before,
26810 at the cost of a small bit of processing. Not supplying either of these is an
26811 error, since the rewritten address would then contain no local part.
26812
26813 The first example above replaces the domain with a superior, more general
26814 domain. This may not be desirable for certain local parts. If the rule
26815 .code
26816 root@*.hitch.fict.example  *
26817 .endd
26818 were inserted before the first rule, rewriting would be suppressed for the
26819 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26820
26821 Rewriting can be made conditional on a number of tests, by making use of
26822 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26823 messages that originate outside the local host:
26824 .code
26825 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26826                          {$1@hitch.fict.example}fail}"
26827 .endd
26828 The replacement string is quoted in this example because it contains white
26829 space.
26830
26831 .cindex "rewriting" "bang paths"
26832 .cindex "bang paths" "rewriting"
26833 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26834 an address it treats it as an unqualified local part which it qualifies with
26835 the local qualification domain (if the source of the message is local or if the
26836 remote host is permitted to send unqualified addresses). Rewriting can
26837 sometimes be used to handle simple bang paths with a fixed number of
26838 components. For example, the rule
26839 .code
26840 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26841 .endd
26842 rewrites a two-component bang path &'host.name!user'& as the domain address
26843 &'user@host.name'&. However, there is a security implication in using this as
26844 a global rewriting rule for envelope addresses. It can provide a backdoor
26845 method for using your system as a relay, because the incoming addresses appear
26846 to be local. If the bang path addresses are received via SMTP, it is safer to
26847 use the &"S"& flag to rewrite them as they are received, so that relay checking
26848 can be done on the rewritten addresses.
26849 .ecindex IIDaddrew
26850
26851
26852
26853
26854
26855 . ////////////////////////////////////////////////////////////////////////////
26856 . ////////////////////////////////////////////////////////////////////////////
26857
26858 .chapter "Retry configuration" "CHAPretry"
26859 .scindex IIDretconf1 "retry" "configuration, description of"
26860 .scindex IIDregconf2 "configuration file" "retry section"
26861 The &"retry"& section of the runtime configuration file contains a list of
26862 retry rules that control how often Exim tries to deliver messages that cannot
26863 be delivered at the first attempt. If there are no retry rules (the section is
26864 empty or not present), there are no retries. In this situation, temporary
26865 errors are treated as permanent. The default configuration contains a single,
26866 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26867 line option can be used to test which retry rule will be used for a given
26868 address, domain and error.
26869
26870 The most common cause of retries is temporary failure to deliver to a remote
26871 host because the host is down, or inaccessible because of a network problem.
26872 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26873 address) basis, not on a per-message basis. Thus, if one message has recently
26874 been delayed, delivery of a new message to the same host is not immediately
26875 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26876 log selector is set, the message
26877 .cindex "retry" "time not reached"
26878 &"retry time not reached"& is written to the main log whenever a delivery is
26879 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26880 the handling of errors during remote deliveries.
26881
26882 Retry processing applies to routing as well as to delivering, except as covered
26883 in the next paragraph. The retry rules do not distinguish between these
26884 actions. It is not possible, for example, to specify different behaviour for
26885 failures to route the domain &'snark.fict.example'& and failures to deliver to
26886 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26887 added complication, so did not implement it. However, although they share the
26888 same retry rule, the actual retry times for routing and transporting a given
26889 domain are maintained independently.
26890
26891 When a delivery is not part of a queue run (typically an immediate delivery on
26892 receipt of a message), the routers are always run, and local deliveries are
26893 always attempted, even if retry times are set for them. This makes for better
26894 behaviour if one particular message is causing problems (for example, causing
26895 quota overflow, or provoking an error in a filter file). If such a delivery
26896 suffers a temporary failure, the retry data is updated as normal, and
26897 subsequent delivery attempts from queue runs occur only when the retry time for
26898 the local address is reached.
26899
26900 .section "Changing retry rules" "SECID157"
26901 If you change the retry rules in your configuration, you should consider
26902 whether or not to delete the retry data that is stored in Exim's spool area in
26903 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26904 always safe; that is why they are called &"hints"&.
26905
26906 The hints retry data contains suggested retry times based on the previous
26907 rules. In the case of a long-running problem with a remote host, it might
26908 record the fact that the host has timed out. If your new rules increase the
26909 timeout time for such a host, you should definitely remove the old retry data
26910 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26911 messages that it should now be retaining.
26912
26913
26914
26915 .section "Format of retry rules" "SECID158"
26916 .cindex "retry" "rules"
26917 Each retry rule occupies one line and consists of three or four parts,
26918 separated by white space: a pattern, an error name, an optional list of sender
26919 addresses, and a list of retry parameters. The pattern and sender lists must be
26920 enclosed in double quotes if they contain white space. The rules are searched
26921 in order until one is found where the pattern, error name, and sender list (if
26922 present) match the failing host or address, the error that occurred, and the
26923 message's sender, respectively.
26924
26925
26926 The pattern is any single item that may appear in an address list (see section
26927 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26928 which means that it is expanded before being tested against the address that
26929 has been delayed. A negated address list item is permitted. Address
26930 list processing treats a plain domain name as if it were preceded by &"*@"&,
26931 which makes it possible for many retry rules to start with just a domain. For
26932 example,
26933 .code
26934 lookingglass.fict.example        *  F,24h,30m;
26935 .endd
26936 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26937 whereas
26938 .code
26939 alice@lookingglass.fict.example  *  F,24h,30m;
26940 .endd
26941 applies only to temporary failures involving the local part &%alice%&.
26942 In practice, almost all rules start with a domain name pattern without a local
26943 part.
26944
26945 .cindex "regular expressions" "in retry rules"
26946 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26947 must match a complete address, not just a domain, because that is how regular
26948 expressions work in address lists.
26949 .display
26950 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26951 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26952 .endd
26953
26954
26955 .section "Choosing which retry rule to use for address errors" "SECID159"
26956 When Exim is looking for a retry rule after a routing attempt has failed (for
26957 example, after a DNS timeout), each line in the retry configuration is tested
26958 against the complete address only if &%retry_use_local_part%& is set for the
26959 router. Otherwise, only the domain is used, except when matching against a
26960 regular expression, when the local part of the address is replaced with &"*"&.
26961 A domain on its own can match a domain pattern, or a pattern that starts with
26962 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26963 &%check_local_user%& is true, and false for other routers.
26964
26965 Similarly, when Exim is looking for a retry rule after a local delivery has
26966 failed (for example, after a mailbox full error), each line in the retry
26967 configuration is tested against the complete address only if
26968 &%retry_use_local_part%& is set for the transport (it defaults true for all
26969 local transports).
26970
26971 .cindex "4&'xx'& responses" "retry rules for"
26972 However, when Exim is looking for a retry rule after a remote delivery attempt
26973 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26974 whole address is always used as the key when searching the retry rules. The
26975 rule that is found is used to create a retry time for the combination of the
26976 failing address and the message's sender. It is the combination of sender and
26977 recipient that is delayed in subsequent queue runs until its retry time is
26978 reached. You can delay the recipient without regard to the sender by setting
26979 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26980 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26981 commands.
26982
26983
26984
26985 .section "Choosing which retry rule to use for host and message errors" &&&
26986          "SECID160"
26987 For a temporary error that is not related to an individual address (for
26988 example, a connection timeout), each line in the retry configuration is checked
26989 twice. First, the name of the remote host is used as a domain name (preceded by
26990 &"*@"& when matching a regular expression). If this does not match the line,
26991 the domain from the email address is tried in a similar fashion. For example,
26992 suppose the MX records for &'a.b.c.example'& are
26993 .code
26994 a.b.c.example  MX  5  x.y.z.example
26995                MX  6  p.q.r.example
26996                MX  7  m.n.o.example
26997 .endd
26998 and the retry rules are
26999 .code
27000 p.q.r.example    *      F,24h,30m;
27001 a.b.c.example    *      F,4d,45m;
27002 .endd
27003 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
27004 first rule matches neither the host nor the domain, so Exim looks at the second
27005 rule. This does not match the host, but it does match the domain, so it is used
27006 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
27007 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
27008 first retry rule is used, because it matches the host.
27009
27010 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
27011 first rule to determine retry times, but for all the other hosts for the domain
27012 &'a.b.c.example'&, the second rule is used. The second rule is also used if
27013 routing to &'a.b.c.example'& suffers a temporary failure.
27014
27015 &*Note*&: The host name is used when matching the patterns, not its IP address.
27016 However, if a message is routed directly to an IP address without the use of a
27017 host name, for example, if a &(manualroute)& router contains a setting such as:
27018 .code
27019 route_list = *.a.example  192.168.34.23
27020 .endd
27021 then the &"host name"& that is used when searching for a retry rule is the
27022 textual form of the IP address.
27023
27024 .section "Retry rules for specific errors" "SECID161"
27025 .cindex "retry" "specific errors; specifying"
27026 The second field in a retry rule is the name of a particular error, or an
27027 asterisk, which matches any error. The errors that can be tested for are:
27028
27029 .vlist
27030 .vitem &%auth_failed%&
27031 Authentication failed when trying to send to a host in the
27032 &%hosts_require_auth%& list in an &(smtp)& transport.
27033
27034 .vitem &%data_4xx%&
27035 A 4&'xx'& error was received for an outgoing DATA command, either immediately
27036 after the command, or after sending the message's data.
27037
27038 .vitem &%mail_4xx%&
27039 A 4&'xx'& error was received for an outgoing MAIL command.
27040
27041 .vitem &%rcpt_4xx%&
27042 A 4&'xx'& error was received for an outgoing RCPT command.
27043 .endlist
27044
27045 For the three 4&'xx'& errors, either the first or both of the x's can be given
27046 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
27047 recognize 452 errors given to RCPT commands for addresses in a certain domain,
27048 and have retries every ten minutes with a one-hour timeout, you could set up a
27049 retry rule of this form:
27050 .code
27051 the.domain.name  rcpt_452   F,1h,10m
27052 .endd
27053 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
27054 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
27055
27056 .vlist
27057 .vitem &%lost_connection%&
27058 A server unexpectedly closed the SMTP connection. There may, of course,
27059 legitimate reasons for this (host died, network died), but if it repeats a lot
27060 for the same host, it indicates something odd.
27061
27062 .vitem &%lookup%&
27063 A DNS lookup for a host failed.
27064 Note that a &%dnslookup%& router will need to have matched
27065 its &%fail_defer_domains%& option for this retry type to be usable.
27066 Also note that a &%manualroute%& router will probably need
27067 its &%host_find_failed%& option set to &%defer%&.
27068
27069 .vitem &%refused_MX%&
27070 A connection to a host obtained from an MX record was refused.
27071
27072 .vitem &%refused_A%&
27073 A connection to a host not obtained from an MX record was refused.
27074
27075 .vitem &%refused%&
27076 A connection was refused.
27077
27078 .vitem &%timeout_connect_MX%&
27079 A connection attempt to a host obtained from an MX record timed out.
27080
27081 .vitem &%timeout_connect_A%&
27082 A connection attempt to a host not obtained from an MX record timed out.
27083
27084 .vitem &%timeout_connect%&
27085 A connection attempt timed out.
27086
27087 .vitem &%timeout_MX%&
27088 There was a timeout while connecting or during an SMTP session with a host
27089 obtained from an MX record.
27090
27091 .vitem &%timeout_A%&
27092 There was a timeout while connecting or during an SMTP session with a host not
27093 obtained from an MX record.
27094
27095 .vitem &%timeout%&
27096 There was a timeout while connecting or during an SMTP session.
27097
27098 .vitem &%tls_required%&
27099 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27100 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27101 to STARTTLS, or there was a problem setting up the TLS connection.
27102
27103 .vitem &%quota%&
27104 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27105 transport.
27106
27107 .vitem &%quota_%&<&'time'&>
27108 .cindex "quota" "error testing in retry rule"
27109 .cindex "retry" "quota error testing"
27110 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27111 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27112 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27113 for four days.
27114 .endlist
27115
27116 .cindex "mailbox" "time of last read"
27117 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27118 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27119 it should be based on the last time that the user accessed the mailbox.
27120 However, it is not always possible to determine this. Exim uses the following
27121 heuristic rules:
27122
27123 .ilist
27124 If the mailbox is a single file, the time of last access (the &"atime"&) is
27125 used. As no new messages are being delivered (because the mailbox is over
27126 quota), Exim does not access the file, so this is the time of last user access.
27127 .next
27128 .cindex "maildir format" "time of last read"
27129 For a maildir delivery, the time of last modification of the &_new_&
27130 subdirectory is used. As the mailbox is over quota, no new files are created in
27131 the &_new_& subdirectory, because no new messages are being delivered. Any
27132 change to the &_new_& subdirectory is therefore assumed to be the result of an
27133 MUA moving a new message to the &_cur_& directory when it is first read. The
27134 time that is used is therefore the last time that the user read a new message.
27135 .next
27136 For other kinds of multi-file mailbox, the time of last access cannot be
27137 obtained, so a retry rule that uses this type of error field is never matched.
27138 .endlist
27139
27140 The quota errors apply both to system-enforced quotas and to Exim's own quota
27141 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27142 when a local delivery is deferred because a partition is full (the ENOSPC
27143 error).
27144
27145
27146
27147 .section "Retry rules for specified senders" "SECID162"
27148 .cindex "retry" "rules; sender-specific"
27149 You can specify retry rules that apply only when the failing message has a
27150 specific sender. In particular, this can be used to define retry rules that
27151 apply only to bounce messages. The third item in a retry rule can be of this
27152 form:
27153 .display
27154 &`senders=`&<&'address list'&>
27155 .endd
27156 The retry timings themselves are then the fourth item. For example:
27157 .code
27158 *   rcpt_4xx   senders=:   F,1h,30m
27159 .endd
27160 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27161 host. If the address list contains white space, it must be enclosed in quotes.
27162 For example:
27163 .code
27164 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27165 .endd
27166 &*Warning*&: This facility can be unhelpful if it is used for host errors
27167 (which do not depend on the recipient). The reason is that the sender is used
27168 only to match the retry rule. Once the rule has been found for a host error,
27169 its contents are used to set a retry time for the host, and this will apply to
27170 all messages, not just those with specific senders.
27171
27172 When testing retry rules using &%-brt%&, you can supply a sender using the
27173 &%-f%& command line option, like this:
27174 .code
27175 exim -f "" -brt user@dom.ain
27176 .endd
27177 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27178 list is never matched.
27179
27180
27181
27182
27183
27184 .section "Retry parameters" "SECID163"
27185 .cindex "retry" "parameters in rules"
27186 The third (or fourth, if a senders list is present) field in a retry rule is a
27187 sequence of retry parameter sets, separated by semicolons. Each set consists of
27188 .display
27189 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27190 .endd
27191 The letter identifies the algorithm for computing a new retry time; the cutoff
27192 time is the time beyond which this algorithm no longer applies, and the
27193 arguments vary the algorithm's action. The cutoff time is measured from the
27194 time that the first failure for the domain (combined with the local part if
27195 relevant) was detected, not from the time the message was received.
27196
27197 .cindex "retry" "algorithms"
27198 .cindex "retry" "fixed intervals"
27199 .cindex "retry" "increasing intervals"
27200 .cindex "retry" "random intervals"
27201 The available algorithms are:
27202
27203 .ilist
27204 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27205 the interval.
27206 .next
27207 &'G'&: retry at geometrically increasing intervals. The first argument
27208 specifies a starting value for the interval, and the second a multiplier, which
27209 is used to increase the size of the interval at each retry.
27210 .next
27211 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27212 retry, the previous interval is multiplied by the factor in order to get a
27213 maximum for the next interval. The minimum interval is the first argument of
27214 the parameter, and an actual interval is chosen randomly between them. Such a
27215 rule has been found to be helpful in cluster configurations when all the
27216 members of the cluster restart at once, and may therefore synchronize their
27217 queue processing times.
27218 .endlist
27219
27220 When computing the next retry time, the algorithm definitions are scanned in
27221 order until one whose cutoff time has not yet passed is reached. This is then
27222 used to compute a new retry time that is later than the current time. In the
27223 case of fixed interval retries, this simply means adding the interval to the
27224 current time. For geometrically increasing intervals, retry intervals are
27225 computed from the rule's parameters until one that is greater than the previous
27226 interval is found. The main configuration variable
27227 .cindex "limit" "retry interval"
27228 .cindex "retry" "interval, maximum"
27229 .oindex "&%retry_interval_max%&"
27230 &%retry_interval_max%& limits the maximum interval between retries. It
27231 cannot be set greater than &`24h`&, which is its default value.
27232
27233 A single remote domain may have a number of hosts associated with it, and each
27234 host may have more than one IP address. Retry algorithms are selected on the
27235 basis of the domain name, but are applied to each IP address independently. If,
27236 for example, a host has two IP addresses and one is unusable, Exim will
27237 generate retry times for it and will not try to use it until its next retry
27238 time comes. Thus the good IP address is likely to be tried first most of the
27239 time.
27240
27241 .cindex "hints database" "use for retrying"
27242 Retry times are hints rather than promises. Exim does not make any attempt to
27243 run deliveries exactly at the computed times. Instead, a queue runner process
27244 starts delivery processes for delayed messages periodically, and these attempt
27245 new deliveries only for those addresses that have passed their next retry time.
27246 If a new message arrives for a deferred address, an immediate delivery attempt
27247 occurs only if the address has passed its retry time. In the absence of new
27248 messages, the minimum time between retries is the interval between queue runner
27249 processes. There is not much point in setting retry times of five minutes if
27250 your queue runners happen only once an hour, unless there are a significant
27251 number of incoming messages (which might be the case on a system that is
27252 sending everything to a smart host, for example).
27253
27254 The data in the retry hints database can be inspected by using the
27255 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27256 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27257 &'exinext'& utility script can be used to find out what the next retry times
27258 are for the hosts associated with a particular mail domain, and also for local
27259 deliveries that have been deferred.
27260
27261
27262 .section "Retry rule examples" "SECID164"
27263 Here are some example retry rules:
27264 .code
27265 alice@wonderland.fict.example quota_5d  F,7d,3h
27266 wonderland.fict.example       quota_5d
27267 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27268 lookingglass.fict.example     *         F,24h,30m;
27269 *                 refused_A   F,2h,20m;
27270 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27271 .endd
27272 The first rule sets up special handling for mail to
27273 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27274 mailbox has not been read for at least 5 days. Retries continue every three
27275 hours for 7 days. The second rule handles over-quota errors for all other local
27276 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27277 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27278 fail are bounced immediately if the mailbox has not been read for at least 5
27279 days.
27280
27281 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27282 happen every 15 minutes for an hour, then with geometrically increasing
27283 intervals until two days have passed since a delivery first failed. After the
27284 first hour there is a delay of one hour, then two hours, then four hours, and
27285 so on (this is a rather extreme example).
27286
27287 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27288 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27289 all other domains, with special action for connection refusal from hosts that
27290 were not obtained from an MX record.
27291
27292 The final rule in a retry configuration should always have asterisks in the
27293 first two fields so as to provide a general catch-all for any addresses that do
27294 not have their own special handling. This example tries every 15 minutes for 2
27295 hours, then with intervals starting at one hour and increasing by a factor of
27296 1.5 up to 16 hours, then every 8 hours up to 5 days.
27297
27298
27299
27300 .section "Timeout of retry data" "SECID165"
27301 .cindex "timeout" "of retry data"
27302 .oindex "&%retry_data_expire%&"
27303 .cindex "hints database" "data expiry"
27304 .cindex "retry" "timeout of data"
27305 Exim timestamps the data that it writes to its retry hints database. When it
27306 consults the data during a delivery it ignores any that is older than the value
27307 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27308 been tried for 7 days, Exim will try to deliver to it immediately a message
27309 arrives, and if that fails, it will calculate a retry time as if it were
27310 failing for the first time.
27311
27312 This improves the behaviour for messages routed to rarely-used hosts such as MX
27313 backups. If such a host was down at one time, and happens to be down again when
27314 Exim tries a month later, using the old retry data would imply that it had been
27315 down all the time, which is not a justified assumption.
27316
27317 If a host really is permanently dead, this behaviour causes a burst of retries
27318 every now and again, but only if messages routed to it are rare. If there is a
27319 message at least once every 7 days the retry data never expires.
27320
27321
27322
27323
27324 .section "Long-term failures" "SECID166"
27325 .cindex "delivery failure, long-term"
27326 .cindex "retry" "after long-term failure"
27327 Special processing happens when an email address has been failing for so long
27328 that the cutoff time for the last algorithm is reached. For example, using the
27329 default retry rule:
27330 .code
27331 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27332 .endd
27333 the cutoff time is four days. Reaching the retry cutoff is independent of how
27334 long any specific message has been failing; it is the length of continuous
27335 failure for the recipient address that counts.
27336
27337 When the cutoff time is reached for a local delivery, or for all the IP
27338 addresses associated with a remote delivery, a subsequent delivery failure
27339 causes Exim to give up on the address, and a bounce message is generated.
27340 In order to cater for new messages that use the failing address, a next retry
27341 time is still computed from the final algorithm, and is used as follows:
27342
27343 For local deliveries, one delivery attempt is always made for any subsequent
27344 messages. If this delivery fails, the address fails immediately. The
27345 post-cutoff retry time is not used.
27346
27347 .cindex "final cutoff" "retries, controlling"
27348 .cindex retry "final cutoff"
27349 If the delivery is remote, there are two possibilities, controlled by the
27350 .oindex "&%delay_after_cutoff%&"
27351 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27352 default. Until the post-cutoff retry time for one of the IP addresses,
27353 as set by the &%retry_data_expire%& option, is
27354 reached, the failing email address is bounced immediately, without a delivery
27355 attempt taking place. After that time, one new delivery attempt is made to
27356 those IP addresses that are past their retry times, and if that still fails,
27357 the address is bounced and new retry times are computed.
27358
27359 In other words, when all the hosts for a given email address have been failing
27360 for a long time, Exim bounces rather then defers until one of the hosts' retry
27361 times is reached. Then it tries once, and bounces if that attempt fails. This
27362 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27363 to a broken destination, but if the host does recover, Exim will eventually
27364 notice.
27365
27366 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27367 addresses are past their final cutoff time, Exim tries to deliver to those IP
27368 addresses that have not been tried since the message arrived. If there are
27369 no suitable IP addresses, or if they all fail, the address is bounced. In other
27370 words, it does not delay when a new message arrives, but tries the expired
27371 addresses immediately, unless they have been tried since the message arrived.
27372 If there is a continuous stream of messages for the failing domains, setting
27373 &%delay_after_cutoff%& false means that there will be many more attempts to
27374 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27375 true.
27376
27377 .section "Deliveries that work intermittently" "SECID167"
27378 .cindex "retry" "intermittently working deliveries"
27379 Some additional logic is needed to cope with cases where a host is
27380 intermittently available, or when a message has some attribute that prevents
27381 its delivery when others to the same address get through. In this situation,
27382 because some messages are successfully delivered, the &"retry clock"& for the
27383 host or address keeps getting reset by the successful deliveries, and so
27384 failing messages remain in the queue for ever because the cutoff time is never
27385 reached.
27386
27387 Two exceptional actions are applied to prevent this happening. The first
27388 applies to errors that are related to a message rather than a remote host.
27389 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27390 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27391 commands, and quota failures. For this type of error, if a message's arrival
27392 time is earlier than the &"first failed"& time for the error, the earlier time
27393 is used when scanning the retry rules to decide when to try next and when to
27394 time out the address.
27395
27396 The exceptional second action applies in all cases. If a message has been on
27397 the queue for longer than the cutoff time of any applicable retry rule for a
27398 given address, a delivery is attempted for that address, even if it is not yet
27399 time, and if this delivery fails, the address is timed out. A new retry time is
27400 not computed in this case, so that other messages for the same address are
27401 considered immediately.
27402 .ecindex IIDretconf1
27403 .ecindex IIDregconf2
27404
27405
27406
27407
27408
27409
27410 . ////////////////////////////////////////////////////////////////////////////
27411 . ////////////////////////////////////////////////////////////////////////////
27412
27413 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27414 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27415 .scindex IIDauthconf2 "authentication"
27416 The &"authenticators"& section of Exim's runtime configuration is concerned
27417 with SMTP authentication. This facility is an extension to the SMTP protocol,
27418 described in RFC 2554, which allows a client SMTP host to authenticate itself
27419 to a server. This is a common way for a server to recognize clients that are
27420 permitted to use it as a relay. SMTP authentication is not of relevance to the
27421 transfer of mail between servers that have no managerial connection with each
27422 other.
27423
27424 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27425 prior to Exim 4.95 names would be silently truncated at this length, but now
27426 it is enforced.
27427
27428 .cindex "AUTH" "description of"
27429 .cindex "ESMTP extensions" AUTH
27430 Very briefly, the way SMTP authentication works is as follows:
27431
27432 .olist
27433 The server advertises a number of authentication &'mechanisms'& in response to
27434 the client's EHLO command.
27435 .next
27436 The client issues an AUTH command, naming a specific mechanism. The command
27437 may, optionally, contain some authentication data.
27438 .next
27439 The server may issue one or more &'challenges'&, to which the client must send
27440 appropriate responses. In simple authentication mechanisms, the challenges are
27441 just prompts for user names and passwords. The server does not have to issue
27442 any challenges &-- in some mechanisms the relevant data may all be transmitted
27443 with the AUTH command.
27444 .next
27445 The server either accepts or denies authentication.
27446 .next
27447 If authentication succeeds, the client may optionally make use of the AUTH
27448 option on the MAIL command to pass an authenticated sender in subsequent
27449 mail transactions. Authentication lasts for the remainder of the SMTP
27450 connection.
27451 .next
27452 If authentication fails, the client may give up, or it may try a different
27453 authentication mechanism, or it may try transferring mail over the
27454 unauthenticated connection.
27455 .endlist
27456
27457 If you are setting up a client, and want to know which authentication
27458 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27459 SMTP port) on the server, and issue an EHLO command. The response to this
27460 includes the list of supported mechanisms. For example:
27461 .display
27462 &`$ `&&*&`telnet server.example 25`&*&
27463 &`Trying 192.168.34.25...`&
27464 &`Connected to server.example.`&
27465 &`Escape character is &#x0027;^]&#x0027;.`&
27466 &`220 server.example ESMTP Exim 4.20 ...`&
27467 &*&`ehlo client.example`&*&
27468 &`250-server.example Hello client.example [10.8.4.5]`&
27469 &`250-SIZE 52428800`&
27470 &`250-PIPELINING`&
27471 &`250-AUTH PLAIN`&
27472 &`250 HELP`&
27473 .endd
27474 The second-last line of this example output shows that the server supports
27475 authentication using the PLAIN mechanism. In Exim, the different authentication
27476 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27477 routers and transports, which authenticators are included in the binary is
27478 controlled by build-time definitions. The following are currently available,
27479 included by setting
27480 .code
27481 AUTH_CRAM_MD5=yes
27482 AUTH_CYRUS_SASL=yes
27483 AUTH_DOVECOT=yes
27484 AUTH_EXTERNAL=yes
27485 AUTH_GSASL=yes
27486 AUTH_HEIMDAL_GSSAPI=yes
27487 AUTH_PLAINTEXT=yes
27488 AUTH_SPA=yes
27489 AUTH_TLS=yes
27490 .endd
27491 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27492 authentication mechanism (RFC 2195), and the second provides an interface to
27493 the Cyrus SASL authentication library.
27494 The third is an interface to Dovecot's authentication system, delegating the
27495 work via a socket interface.
27496 The fourth provides for negotiation of authentication done via non-SMTP means,
27497 as defined by RFC 4422 Appendix A.
27498 The fifth provides an interface to the GNU SASL authentication library, which
27499 provides mechanisms but typically not data sources.
27500 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27501 supporting setting a server keytab.
27502 The seventh can be configured to support
27503 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27504 not formally documented, but used by several MUAs.
27505 The eighth authenticator
27506 supports Microsoft's &'Secure Password Authentication'& mechanism.
27507 The last is an Exim authenticator but not an SMTP one;
27508 instead it can use information from a TLS negotiation.
27509
27510 The authenticators are configured using the same syntax as other drivers (see
27511 section &<<SECTfordricon>>&). If no authenticators are required, no
27512 authentication section need be present in the configuration file. Each
27513 authenticator can in principle have both server and client functions. When Exim
27514 is receiving SMTP mail, it is acting as a server; when it is sending out
27515 messages over SMTP, it is acting as a client. Authenticator configuration
27516 options are provided for use in both these circumstances.
27517
27518 To make it clear which options apply to which situation, the prefixes
27519 &%server_%& and &%client_%& are used on option names that are specific to
27520 either the server or the client function, respectively. Server and client
27521 functions are disabled if none of their options are set. If an authenticator is
27522 to be used for both server and client functions, a single definition, using
27523 both sets of options, is required. For example:
27524 .code
27525 cram:
27526   driver = cram_md5
27527   public_name = CRAM-MD5
27528   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27529   client_name = ph10
27530   client_secret = secret2
27531 .endd
27532 The &%server_%& option is used when Exim is acting as a server, and the
27533 &%client_%& options when it is acting as a client.
27534
27535 Descriptions of the individual authenticators are given in subsequent chapters.
27536 The remainder of this chapter covers the generic options for the
27537 authenticators, followed by general discussion of the way authentication works
27538 in Exim.
27539
27540 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27541 per-mechanism basis.  Please read carefully to determine which variables hold
27542 account labels such as usercodes and which hold passwords or other
27543 authenticating data.
27544
27545 Note that some mechanisms support two different identifiers for accounts: the
27546 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27547 and &'authz'& are commonly encountered.  The American spelling is standard here.
27548 Conceptually, authentication data such as passwords are tied to the identifier
27549 used to authenticate; servers may have rules to permit one user to act as a
27550 second user, so that after login the session is treated as though that second
27551 user had logged in.  That second user is the &'authorization id'&.  A robust
27552 configuration might confirm that the &'authz'& field is empty or matches the
27553 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27554 as verified data, the &'authz'& as an unverified request which the server might
27555 choose to honour.
27556
27557 A &'realm'& is a text string, typically a domain name, presented by a server
27558 to a client to help it select an account and credentials to use.  In some
27559 mechanisms, the client and server provably agree on the realm, but clients
27560 typically can not treat the realm as secure data to be blindly trusted.
27561
27562
27563
27564 .section "Generic options for authenticators" "SECID168"
27565 .cindex "authentication" "generic options"
27566 .cindex "options" "generic; for authenticators"
27567
27568 .option client_condition authenticators string&!! unset
27569 When Exim is authenticating as a client, it skips any authenticator whose
27570 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27571 used, for example, to skip plain text authenticators when the connection is not
27572 encrypted by a setting such as:
27573 .code
27574 client_condition = ${if !eq{$tls_out_cipher}{}}
27575 .endd
27576
27577
27578 .option client_set_id authenticators string&!! unset
27579 When client authentication succeeds, this condition is expanded; the
27580 result is used in the log lines for outbound messages.
27581 Typically it will be the user name used for authentication.
27582
27583
27584 .option driver authenticators string unset
27585 This option must always be set. It specifies which of the available
27586 authenticators is to be used.
27587
27588
27589 .option public_name authenticators string unset
27590 This option specifies the name of the authentication mechanism that the driver
27591 implements, and by which it is known to the outside world. These names should
27592 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27593 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27594 defaults to the driver's instance name.
27595
27596
27597 .option server_advertise_condition authenticators string&!! unset
27598 When a server is about to advertise an authentication mechanism, the condition
27599 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27600 mechanism is not advertised.
27601 If the expansion fails, the mechanism is not advertised. If the failure was not
27602 forced, and was not caused by a lookup defer, the incident is logged.
27603 See section &<<SECTauthexiser>>& below for further discussion.
27604
27605
27606 .option server_condition authenticators string&!! unset
27607 This option must be set for a &%plaintext%& server authenticator, where it
27608 is used directly to control authentication. See section &<<SECTplainserver>>&
27609 for details.
27610
27611 For the &(gsasl)& authenticator, this option is required for various
27612 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27613
27614 For the other authenticators, &%server_condition%& can be used as an additional
27615 authentication or authorization mechanism that is applied after the other
27616 authenticator conditions succeed. If it is set, it is expanded when the
27617 authenticator would otherwise return a success code. If the expansion is forced
27618 to fail, authentication fails. Any other expansion failure causes a temporary
27619 error code to be returned. If the result of a successful expansion is an empty
27620 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27621 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27622 other result, a temporary error code is returned, with the expanded string as
27623 the error text.
27624
27625
27626 .option server_debug_print authenticators string&!! unset
27627 If this option is set and authentication debugging is enabled (see the &%-d%&
27628 command line option), the string is expanded and included in the debugging
27629 output when the authenticator is run as a server. This can help with checking
27630 out the values of variables.
27631 If expansion of the string fails, the error message is written to the debugging
27632 output, and Exim carries on processing.
27633
27634
27635 .option server_set_id authenticators string&!! unset
27636 .vindex "&$authenticated_id$&"
27637 .vindex "&$authenticated_fail_id$&"
27638 When an Exim server successfully authenticates a client, this string is
27639 expanded using data from the authentication, and preserved for any incoming
27640 messages in the variable &$authenticated_id$&. It is also included in the log
27641 lines for incoming messages. For example, a user/password authenticator
27642 configuration might preserve the user name that was used to authenticate, and
27643 refer to it subsequently during delivery of the message.
27644 On a failing authentication the expansion result is instead saved in
27645 the &$authenticated_fail_id$& variable.
27646 If expansion fails, the option is ignored.
27647
27648
27649 .option server_mail_auth_condition authenticators string&!! unset
27650 This option allows a server to discard authenticated sender addresses supplied
27651 as part of MAIL commands in SMTP connections that are authenticated by the
27652 driver on which &%server_mail_auth_condition%& is set. The option is not used
27653 as part of the authentication process; instead its (unexpanded) value is
27654 remembered for later use.
27655 How it is used is described in the following section.
27656
27657
27658
27659
27660
27661 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27662 .cindex "authentication" "sender; authenticated"
27663 .cindex "AUTH" "on MAIL command"
27664 When a client supplied an AUTH= item on a MAIL command, Exim applies
27665 the following checks before accepting it as the authenticated sender of the
27666 message:
27667
27668 .ilist
27669 If the connection is not using extended SMTP (that is, HELO was used rather
27670 than EHLO), the use of AUTH= is a syntax error.
27671 .next
27672 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27673 .next
27674 .vindex "&$authenticated_sender$&"
27675 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27676 running, the value of &$authenticated_sender$& is set to the value obtained
27677 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27678 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27679 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27680 given for the MAIL command.
27681 .next
27682 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27683 is accepted and placed in &$authenticated_sender$& only if the client has
27684 authenticated.
27685 .next
27686 If the AUTH= value was accepted by either of the two previous rules, and
27687 the client has authenticated, and the authenticator has a setting for the
27688 &%server_mail_auth_condition%&, the condition is checked at this point. The
27689 valued that was saved from the authenticator is expanded. If the expansion
27690 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27691 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27692 the value of &$authenticated_sender$& is retained and passed on with the
27693 message.
27694 .endlist
27695
27696
27697 When &$authenticated_sender$& is set for a message, it is passed on to other
27698 hosts to which Exim authenticates as a client. Do not confuse this value with
27699 &$authenticated_id$&, which is a string obtained from the authentication
27700 process, and which is not usually a complete email address.
27701
27702 .vindex "&$sender_address$&"
27703 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27704 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27705 therefore make use of &$authenticated_sender$&. The converse is not true: the
27706 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27707 ACL is run.
27708
27709
27710
27711 .section "Authentication on an Exim server" "SECTauthexiser"
27712 .cindex "authentication" "on an Exim server"
27713 When Exim receives an EHLO command, it advertises the public names of those
27714 authenticators that are configured as servers, subject to the following
27715 conditions:
27716
27717 .ilist
27718 The client host must match &%auth_advertise_hosts%& (default *).
27719 .next
27720 If the &%server_advertise_condition%& option is set, its expansion must not
27721 yield the empty string, &"0"&, &"no"&, or &"false"&.
27722 .endlist
27723
27724 The order in which the authenticators are defined controls the order in which
27725 the mechanisms are advertised.
27726
27727 Some mail clients (for example, some versions of Netscape) require the user to
27728 provide a name and password for authentication whenever AUTH is advertised,
27729 even though authentication may not in fact be needed (for example, Exim may be
27730 set up to allow unconditional relaying from the client by an IP address check).
27731 You can make such clients more friendly by not advertising AUTH to them.
27732 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27733 that runs for RCPT) to relay without authentication, you should set
27734 .code
27735 auth_advertise_hosts = ! 10.9.8.0/24
27736 .endd
27737 so that no authentication mechanisms are advertised to them.
27738
27739 The &%server_advertise_condition%& controls the advertisement of individual
27740 authentication mechanisms. For example, it can be used to restrict the
27741 advertisement of a particular mechanism to encrypted connections, by a setting
27742 such as:
27743 .code
27744 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27745 .endd
27746 .vindex "&$tls_in_cipher$&"
27747 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27748 yields &"yes"&, which allows the advertisement to happen.
27749
27750 When an Exim server receives an AUTH command from a client, it rejects it
27751 immediately if AUTH was not advertised in response to an earlier EHLO
27752 command. This is the case if
27753
27754 .ilist
27755 The client host does not match &%auth_advertise_hosts%&; or
27756 .next
27757 No authenticators are configured with server options; or
27758 .next
27759 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27760 server authenticators.
27761 .endlist
27762
27763
27764 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27765 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27766 AUTH is accepted from any client host.
27767
27768 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27769 server authentication mechanism that was advertised in response to EHLO and
27770 that matches the one named in the AUTH command. If it finds one, it runs
27771 the appropriate authentication protocol, and authentication either succeeds or
27772 fails. If there is no matching advertised mechanism, the AUTH command is
27773 rejected with a 504 error.
27774
27775 .vindex "&$received_protocol$&"
27776 .vindex "&$sender_host_authenticated$&"
27777 When a message is received from an authenticated host, the value of
27778 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27779 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27780 public name) of the authenticator driver that successfully authenticated the
27781 client from which the message was received. This variable is empty if there was
27782 no successful authentication.
27783
27784 .cindex authentication "expansion item"
27785 Successful authentication sets up information used by the
27786 &%authresults%& expansion item.
27787
27788 .cindex authentication "failure event, server"
27789 If an authenticator is run and does not succeed,
27790 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27791 While the event is being processed the variables
27792 &$sender_host_authenticated$& (with the authenticator name)
27793 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27794 will be valid.
27795 If the event is serviced and a string is returned then the string will be logged
27796 instead of the default log line.
27797 See <<CHAPevents>> for details on events.
27798
27799
27800 .section "Testing server authentication" "SECID169"
27801 .cindex "authentication" "testing a server"
27802 .cindex "AUTH" "testing a server"
27803 .cindex "base64 encoding" "creating authentication test data"
27804 Exim's &%-bh%& option can be useful for testing server authentication
27805 configurations. The data for the AUTH command has to be sent using base64
27806 encoding. A quick way to produce such data for testing is the following Perl
27807 script:
27808 .code
27809 use MIME::Base64;
27810 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27811 .endd
27812 .cindex "binary zero" "in authentication data"
27813 This interprets its argument as a Perl string, and then encodes it. The
27814 interpretation as a Perl string allows binary zeros, which are required for
27815 some kinds of authentication, to be included in the data. For example, a
27816 command line to run this script on such data might be
27817 .code
27818 encode '\0user\0password'
27819 .endd
27820 Note the use of single quotes to prevent the shell interpreting the
27821 backslashes, so that they can be interpreted by Perl to specify characters
27822 whose code value is zero.
27823
27824 &*Warning 1*&: If either of the user or password strings starts with an octal
27825 digit, you must use three zeros instead of one after the leading backslash. If
27826 you do not, the octal digit that starts your string will be incorrectly
27827 interpreted as part of the code for the first character.
27828
27829 &*Warning 2*&: If there are characters in the strings that Perl interprets
27830 specially, you must use a Perl escape to prevent them being misinterpreted. For
27831 example, a command such as
27832 .code
27833 encode '\0user@domain.com\0pas$$word'
27834 .endd
27835 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27836
27837 If you have the &%mimencode%& command installed, another way to produce
27838 base64-encoded strings is to run the command
27839 .code
27840 echo -e -n `\0user\0password' | mimencode
27841 .endd
27842 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27843 in the argument, and the &%-n%& option specifies no newline at the end of its
27844 output. However, not all versions of &%echo%& recognize these options, so you
27845 should check your version before relying on this suggestion.
27846
27847
27848
27849 .section "Authentication by an Exim client" "SECID170"
27850 .cindex "authentication" "on an Exim client"
27851 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27852 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27853 announces support for authentication, and the host matches an entry in either
27854 of these options, Exim (as a client) tries to authenticate as follows:
27855
27856 .ilist
27857 For each authenticator that is configured as a client, in the order in which
27858 they are defined in the configuration, it searches the authentication
27859 mechanisms announced by the server for one whose name matches the public name
27860 of the authenticator.
27861 .next
27862 .vindex "&$host$&"
27863 .vindex "&$host_address$&"
27864 When it finds one that matches, it runs the authenticator's client code. The
27865 variables &$host$& and &$host_address$& are available for any string expansions
27866 that the client might do. They are set to the server's name and IP address. If
27867 any expansion is forced to fail, the authentication attempt is abandoned, and
27868 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27869 delivery to be deferred.
27870 .next
27871 If the result of the authentication attempt is a temporary error or a timeout,
27872 Exim abandons trying to send the message to the host for the moment. It will
27873 try again later. If there are any backup hosts available, they are tried in the
27874 usual way.
27875
27876 .next
27877 .cindex authentication "failure event, client"
27878 If the response to authentication is a permanent error (5&'xx'& code),
27879 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27880 While the event is being processed the variable
27881 &$sender_host_authenticated$& (with the authenticator name)
27882 will be valid.
27883 If the event is serviced and a string is returned then the string will be logged.
27884 See <<CHAPevents>> for details on events.
27885
27886 .next
27887 If the response to authentication is a permanent error (5&'xx'& code), Exim
27888 carries on searching the list of authenticators and tries another one if
27889 possible. If all authentication attempts give permanent errors, or if there are
27890 no attempts because no mechanisms match (or option expansions force failure),
27891 what happens depends on whether the host matches &%hosts_require_auth%& or
27892 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27893 delivery is deferred. The error can be detected in the retry rules, and thereby
27894 turned into a permanent error if you wish. In the second case, Exim tries to
27895 deliver the message unauthenticated.
27896 .endlist
27897
27898 Note that the hostlist test for whether to do authentication can be
27899 confused if name-IP lookups change between the time the peer is decided
27900 upon and the time that the transport runs.  For example, with a manualroute
27901 router given a host name, and with DNS "round-robin" used by that name: if
27902 the local resolver cache times out between the router and the transport
27903 running, the transport may get an IP for the name for its authentication
27904 check which does not match the connection peer IP.
27905 No authentication will then be done, despite the names being identical.
27906
27907 For such cases use a separate transport which always authenticates.
27908
27909 .cindex "AUTH" "on MAIL command"
27910 When Exim has authenticated itself to a remote server, it adds the AUTH
27911 parameter to the MAIL commands it sends, if it has an authenticated sender for
27912 the message. If the message came from a remote host, the authenticated sender
27913 is the one that was receiving on an incoming MAIL command, provided that the
27914 incoming connection was authenticated and the &%server_mail_auth%& condition
27915 allowed the authenticated sender to be retained. If a local process calls Exim
27916 to send a message, the sender address that is built from the login name and
27917 &%qualify_domain%& is treated as authenticated. However, if the
27918 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27919 the authenticated sender that was received with the message.
27920 .ecindex IIDauthconf1
27921 .ecindex IIDauthconf2
27922
27923
27924
27925
27926
27927
27928 . ////////////////////////////////////////////////////////////////////////////
27929 . ////////////////////////////////////////////////////////////////////////////
27930
27931 .chapter "The plaintext authenticator" "CHAPplaintext"
27932 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27933 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27934 The &(plaintext)& authenticator can be configured to support the PLAIN and
27935 LOGIN authentication mechanisms, both of which transfer authentication data as
27936 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27937 security risk; you are strongly advised to insist on the use of SMTP encryption
27938 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27939 use unencrypted plain text, you should not use the same passwords for SMTP
27940 connections as you do for login accounts.
27941
27942 .section "Avoiding cleartext use" "SECTplain_TLS"
27943 The following generic option settings will disable &(plaintext)& authenticators when
27944 TLS is not being used:
27945 .code
27946   server_advertise_condition = ${if def:tls_in_cipher }
27947   client_condition =           ${if def:tls_out_cipher}
27948 .endd
27949
27950 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27951 but is still vulnerable to a Man In The Middle attack unless certificates
27952 (including their names) have been properly verified.
27953
27954 .section "Plaintext server options" "SECID171"
27955 .cindex "options" "&(plaintext)& authenticator (server)"
27956 When configured as a server, &(plaintext)& uses the following options:
27957
27958 .option server_condition authenticators string&!! unset
27959 This is actually a global authentication option, but it must be set in order to
27960 configure the &(plaintext)& driver as a server. Its use is described below.
27961
27962 .option server_prompts plaintext "string list&!!" unset
27963 The contents of this option, after expansion, must be a colon-separated list of
27964 prompt strings. If expansion fails, a temporary authentication rejection is
27965 given.
27966
27967 .section "Using plaintext in a server" "SECTplainserver"
27968 .cindex "AUTH" "in &(plaintext)& authenticator"
27969 .cindex "binary zero" "in &(plaintext)& authenticator"
27970 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27971         "in &(plaintext)& authenticator"
27972 .vindex "&$auth1$&, &$auth2$&, etc"
27973 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27974
27975 When running as a server, &(plaintext)& performs the authentication test by
27976 expanding a string. The data sent by the client with the AUTH command, or in
27977 response to subsequent prompts, is base64 encoded, and so may contain any byte
27978 values when decoded. If any data is supplied with the command, it is treated as
27979 a list of strings, separated by NULs (binary zeros), the first three of which
27980 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27981 (neither LOGIN nor PLAIN uses more than three strings).
27982
27983 For compatibility with previous releases of Exim, the values are also placed in
27984 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27985 variables for this purpose is now deprecated, as it can lead to confusion in
27986 string expansions that also use them for other things.
27987
27988 If there are more strings in &%server_prompts%& than the number of strings
27989 supplied with the AUTH command, the remaining prompts are used to obtain more
27990 data. Each response from the client may be a list of NUL-separated strings.
27991
27992 .vindex "&$authenticated_id$&"
27993 Once a sufficient number of data strings have been received,
27994 &%server_condition%& is expanded. If the expansion is forced to fail,
27995 authentication fails. Any other expansion failure causes a temporary error code
27996 to be returned. If the result of a successful expansion is an empty string,
27997 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27998 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27999 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28000 For any other result, a temporary error code is returned, with the expanded
28001 string as the error text.
28002
28003 &*Warning*&: If you use a lookup in the expansion to find the user's
28004 password, be sure to make the authentication fail if the user is unknown.
28005 There are good and bad examples at the end of the next section.
28006
28007
28008
28009 .section "The PLAIN authentication mechanism" "SECID172"
28010 .cindex "PLAIN authentication mechanism"
28011 .cindex authentication PLAIN
28012 .cindex "binary zero" "in &(plaintext)& authenticator"
28013 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
28014 sent as one item of data (that is, one combined string containing two NUL
28015 separators). The data is sent either as part of the AUTH command, or
28016 subsequently in response to an empty prompt from the server.
28017
28018 The second and third strings are a user name and a corresponding password.
28019 Using a single fixed user name and password as an example, this could be
28020 configured as follows:
28021 .code
28022 fixed_plain:
28023   driver = plaintext
28024   public_name = PLAIN
28025   server_prompts = :
28026   server_condition = \
28027     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
28028   server_set_id = $auth2
28029 .endd
28030 Note that the default result strings from &%if%& (&"true"& or an empty string)
28031 are exactly what we want here, so they need not be specified. Obviously, if the
28032 password contains expansion-significant characters such as dollar, backslash,
28033 or closing brace, they have to be escaped.
28034
28035 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
28036 the end of a string list are ignored). If all the data comes as part of the
28037 AUTH command, as is commonly the case, the prompt is not used. This
28038 authenticator is advertised in the response to EHLO as
28039 .code
28040 250-AUTH PLAIN
28041 .endd
28042 and a client host can authenticate itself by sending the command
28043 .code
28044 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
28045 .endd
28046 As this contains three strings (more than the number of prompts), no further
28047 data is required from the client. Alternatively, the client may just send
28048 .code
28049 AUTH PLAIN
28050 .endd
28051 to initiate authentication, in which case the server replies with an empty
28052 prompt. The client must respond with the combined data string.
28053
28054 The data string is base64 encoded, as required by the RFC. This example,
28055 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
28056 represents a zero byte. This is split up into three strings, the first of which
28057 is empty. The &%server_condition%& option in the authenticator checks that the
28058 second two are &`username`& and &`mysecret`& respectively.
28059
28060 Having just one fixed user name and password, as in this example, is not very
28061 realistic, though for a small organization with only a handful of
28062 authenticating clients it could make sense.
28063
28064 A more sophisticated instance of this authenticator could use the user name in
28065 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28066 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28067 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28068 This is an incorrect example:
28069 .code
28070 server_condition = \
28071   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28072 .endd
28073 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28074 which it then compares to the supplied password (&$auth3$&). Why is this example
28075 incorrect? It works fine for existing users, but consider what happens if a
28076 non-existent user name is given. The lookup fails, but as no success/failure
28077 strings are given for the lookup, it yields an empty string. Thus, to defeat
28078 the authentication, all a client has to do is to supply a non-existent user
28079 name and an empty password. The correct way of writing this test is:
28080 .code
28081 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28082   {${if eq{$value}{$auth3}}} {false}}
28083 .endd
28084 In this case, if the lookup succeeds, the result is checked; if the lookup
28085 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28086 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28087 always fails if its second argument is empty. However, the second way of
28088 writing the test makes the logic clearer.
28089
28090
28091 .section "The LOGIN authentication mechanism" "SECID173"
28092 .cindex "LOGIN authentication mechanism"
28093 .cindex authentication LOGIN
28094 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28095 in a number of programs. No data is sent with the AUTH command. Instead, a
28096 user name and password are supplied separately, in response to prompts. The
28097 plaintext authenticator can be configured to support this as in this example:
28098 .code
28099 fixed_login:
28100   driver = plaintext
28101   public_name = LOGIN
28102   server_prompts = User Name : Password
28103   server_condition = \
28104     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28105   server_set_id = $auth1
28106 .endd
28107 Because of the way plaintext operates, this authenticator accepts data supplied
28108 with the AUTH command (in contravention of the specification of LOGIN), but
28109 if the client does not supply it (as is the case for LOGIN clients), the prompt
28110 strings are used to obtain two data items.
28111
28112 Some clients are very particular about the precise text of the prompts. For
28113 example, Outlook Express is reported to recognize only &"Username:"& and
28114 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28115 strings. It uses the &%ldapauth%& expansion condition to check the user
28116 name and password by binding to an LDAP server:
28117 .code
28118 login:
28119   driver = plaintext
28120   public_name = LOGIN
28121   server_prompts = Username:: : Password::
28122   server_condition = ${if and{{ \
28123     !eq{}{$auth1} }{ \
28124     ldapauth{\
28125       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28126       pass=${quote:$auth2} \
28127       ldap://ldap.example.org/} }} }
28128   server_set_id = uid=$auth1,ou=people,o=example.org
28129 .endd
28130 We have to check that the username is not empty before using it, because LDAP
28131 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28132 operator to correctly quote the DN for authentication. However, the basic
28133 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28134 correct one to use for the password, because quoting is needed only to make
28135 the password conform to the Exim syntax. At the LDAP level, the password is an
28136 uninterpreted string.
28137
28138
28139 .section "Support for different kinds of authentication" "SECID174"
28140 A number of string expansion features are provided for the purpose of
28141 interfacing to different ways of user authentication. These include checking
28142 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28143 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28144 &<<SECTexpcond>>&.
28145
28146
28147
28148
28149 .section "Using plaintext in a client" "SECID175"
28150 .cindex "options" "&(plaintext)& authenticator (client)"
28151 The &(plaintext)& authenticator has two client options:
28152
28153 .option client_ignore_invalid_base64 plaintext boolean false
28154 If the client receives a server prompt that is not a valid base64 string,
28155 authentication is abandoned by default. However, if this option is set true,
28156 the error in the challenge is ignored and the client sends the response as
28157 usual.
28158
28159 .option client_send plaintext string&!! unset
28160 The string is a colon-separated list of authentication data strings. Each
28161 string is independently expanded before being sent to the server. The first
28162 string is sent with the AUTH command; any more strings are sent in response
28163 to prompts from the server. Before each string is expanded, the value of the
28164 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28165 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28166 way. Thus, the prompt that is received in response to sending the first string
28167 (with the AUTH command) can be used in the expansion of the second string, and
28168 so on. If an invalid base64 string is received when
28169 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28170 &$auth$&<&'n'&> variable.
28171
28172 &*Note*&: You cannot use expansion to create multiple strings, because
28173 splitting takes priority and happens first.
28174
28175 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28176 the data, further processing is applied to each string before it is sent. If
28177 there are any single circumflex characters in the string, they are converted to
28178 NULs. Should an actual circumflex be required as data, it must be doubled in
28179 the string.
28180
28181 This is an example of a client configuration that implements the PLAIN
28182 authentication mechanism with a fixed user name and password:
28183 .code
28184 fixed_plain:
28185   driver = plaintext
28186   public_name = PLAIN
28187   client_send = ^username^mysecret
28188 .endd
28189 The lack of colons means that the entire text is sent with the AUTH
28190 command, with the circumflex characters converted to NULs.
28191 Note that due to the ambiguity of parsing three consectutive circumflex characters
28192 there is no way to provide a password having a leading circumflex.
28193
28194
28195 A similar example
28196 that uses the LOGIN mechanism is:
28197 .code
28198 fixed_login:
28199   driver = plaintext
28200   public_name = LOGIN
28201   client_send = : username : mysecret
28202 .endd
28203 The initial colon means that the first string is empty, so no data is sent with
28204 the AUTH command itself. The remaining strings are sent in response to
28205 prompts.
28206 .ecindex IIDplaiauth1
28207 .ecindex IIDplaiauth2
28208
28209
28210
28211
28212 . ////////////////////////////////////////////////////////////////////////////
28213 . ////////////////////////////////////////////////////////////////////////////
28214
28215 .chapter "The cram_md5 authenticator" "CHID9"
28216 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28217 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28218 .cindex "CRAM-MD5 authentication mechanism"
28219 .cindex authentication CRAM-MD5
28220 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28221 sends a challenge string to the client, and the response consists of a user
28222 name and the CRAM-MD5 digest of the challenge string combined with a secret
28223 string (password) which is known to both server and client. Thus, the secret
28224 is not sent over the network as plain text, which makes this authenticator more
28225 secure than &(plaintext)&. However, the downside is that the secret has to be
28226 available in plain text at either end.
28227
28228
28229 .section "Using cram_md5 as a server" "SECID176"
28230 .cindex "options" "&(cram_md5)& authenticator (server)"
28231 This authenticator has one server option, which must be set to configure the
28232 authenticator as a server:
28233
28234 .option server_secret cram_md5 string&!! unset
28235 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28236 When the server receives the client's response, the user name is placed in
28237 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28238 obtain the password for that user. The server then computes the CRAM-MD5 digest
28239 that the client should have sent, and checks that it received the correct
28240 string. If the expansion of &%server_secret%& is forced to fail, authentication
28241 fails. If the expansion fails for some other reason, a temporary error code is
28242 returned to the client.
28243
28244 For compatibility with previous releases of Exim, the user name is also placed
28245 in &$1$&. However, the use of this variables for this purpose is now
28246 deprecated, as it can lead to confusion in string expansions that also use
28247 numeric variables for other things.
28248
28249 For example, the following authenticator checks that the user name given by the
28250 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28251 user name, authentication fails.
28252 .code
28253 fixed_cram:
28254   driver = cram_md5
28255   public_name = CRAM-MD5
28256   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28257   server_set_id = $auth1
28258 .endd
28259 .vindex "&$authenticated_id$&"
28260 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28261 name in &$authenticated_id$&. A more typical configuration might look up the
28262 secret string in a file, using the user name as the key. For example:
28263 .code
28264 lookup_cram:
28265   driver = cram_md5
28266   public_name = CRAM-MD5
28267   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28268                   {$value}fail}
28269   server_set_id = $auth1
28270 .endd
28271 Note that this expansion explicitly forces failure if the lookup fails
28272 because &$auth1$& contains an unknown user name.
28273
28274 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28275 using the relevant libraries, you need to know the realm to specify in the
28276 lookup and then ask for the &"userPassword"& attribute for that user in that
28277 realm, with:
28278 .code
28279 cyrusless_crammd5:
28280   driver = cram_md5
28281   public_name = CRAM-MD5
28282   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28283                   dbmjz{/etc/sasldb2}{$value}fail}
28284   server_set_id = $auth1
28285 .endd
28286
28287 .section "Using cram_md5 as a client" "SECID177"
28288 .cindex "options" "&(cram_md5)& authenticator (client)"
28289 When used as a client, the &(cram_md5)& authenticator has two options:
28290
28291
28292
28293 .option client_name cram_md5 string&!! "the primary host name"
28294 This string is expanded, and the result used as the user name data when
28295 computing the response to the server's challenge.
28296
28297
28298 .option client_secret cram_md5 string&!! unset
28299 This option must be set for the authenticator to work as a client. Its value is
28300 expanded and the result used as the secret string when computing the response.
28301
28302
28303 .vindex "&$host$&"
28304 .vindex "&$host_address$&"
28305 Different user names and secrets can be used for different servers by referring
28306 to &$host$& or &$host_address$& in the options. Forced failure of either
28307 expansion string is treated as an indication that this authenticator is not
28308 prepared to handle this case. Exim moves on to the next configured client
28309 authenticator. Any other expansion failure causes Exim to give up trying to
28310 send the message to the current server.
28311
28312 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28313 strings, is:
28314 .code
28315 fixed_cram:
28316   driver = cram_md5
28317   public_name = CRAM-MD5
28318   client_name = ph10
28319   client_secret = secret
28320 .endd
28321 .ecindex IIDcramauth1
28322 .ecindex IIDcramauth2
28323
28324
28325
28326 . ////////////////////////////////////////////////////////////////////////////
28327 . ////////////////////////////////////////////////////////////////////////////
28328
28329 .chapter "The cyrus_sasl authenticator" "CHID10"
28330 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28331 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28332 .cindex "Cyrus" "SASL library"
28333 .cindex "Kerberos"
28334 The code for this authenticator was provided by Matthew Byng-Maddick while
28335 at A L Digital Ltd.
28336
28337 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28338 library implementation of the RFC 2222 (&"Simple Authentication and Security
28339 Layer"&). This library supports a number of authentication mechanisms,
28340 including PLAIN and LOGIN, but also several others that Exim does not support
28341 directly. In particular, there is support for Kerberos authentication.
28342
28343 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28344 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28345 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28346 name of the driver to determine which mechanism to support.
28347
28348 Where access to some kind of secret file is required, for example, in GSSAPI
28349 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28350 user, and that the Cyrus SASL library has no way of escalating privileges
28351 by default. You may also find you need to set environment variables,
28352 depending on the driver you are using.
28353
28354 The application name provided by Exim is &"exim"&, so various SASL options may
28355 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28356 Kerberos, note that because of limitations in the GSSAPI interface,
28357 changing the server keytab might need to be communicated down to the Kerberos
28358 layer independently. The mechanism for doing so is dependent upon the Kerberos
28359 implementation.
28360
28361 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28362 may be set to point to an alternative keytab file. Exim will pass this
28363 variable through from its own inherited environment when started as root or the
28364 Exim user. The keytab file needs to be readable by the Exim user.
28365 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28366 environment variable.  In practice, for those releases, the Cyrus authenticator
28367 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28368 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28369
28370
28371 .section "Using cyrus_sasl as a server" "SECID178"
28372 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28373 (on a successful authentication) into &$auth1$&. For compatibility with
28374 previous releases of Exim, the username is also placed in &$1$&. However, the
28375 use of this variable for this purpose is now deprecated, as it can lead to
28376 confusion in string expansions that also use numeric variables for other
28377 things.
28378
28379
28380 .option server_hostname cyrus_sasl string&!! "see below"
28381 This option selects the hostname that is used when communicating with the
28382 library. The default value is &`$primary_hostname`&. It is up to the underlying
28383 SASL plug-in what it does with this data.
28384
28385
28386 .option server_mech cyrus_sasl string "see below"
28387 This option selects the authentication mechanism this driver should use. The
28388 default is the value of the generic &%public_name%& option. This option allows
28389 you to use a different underlying mechanism from the advertised name. For
28390 example:
28391 .code
28392 sasl:
28393   driver = cyrus_sasl
28394   public_name = X-ANYTHING
28395   server_mech = CRAM-MD5
28396   server_set_id = $auth1
28397 .endd
28398
28399 .option server_realm cyrus_sasl string&!! unset
28400 This specifies the SASL realm that the server claims to be in.
28401
28402
28403 .option server_service cyrus_sasl string &`smtp`&
28404 This is the SASL service that the server claims to implement.
28405
28406
28407 For straightforward cases, you do not need to set any of the authenticator's
28408 private options. All you need to do is to specify an appropriate mechanism as
28409 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28410 PLAIN, you could have two authenticators as follows:
28411 .code
28412 sasl_cram_md5:
28413   driver = cyrus_sasl
28414   public_name = CRAM-MD5
28415   server_set_id = $auth1
28416
28417 sasl_plain:
28418   driver = cyrus_sasl
28419   public_name = PLAIN
28420   server_set_id = $auth2
28421 .endd
28422 Cyrus SASL does implement the LOGIN authentication method, even though it is
28423 not a standard method. It is disabled by default in the source distribution,
28424 but it is present in many binary distributions.
28425 .ecindex IIDcyrauth1
28426 .ecindex IIDcyrauth2
28427
28428
28429
28430
28431 . ////////////////////////////////////////////////////////////////////////////
28432 . ////////////////////////////////////////////////////////////////////////////
28433 .chapter "The dovecot authenticator" "CHAPdovecot"
28434 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28435 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28436 This authenticator is an interface to the authentication facility of the
28437 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28438 Note that Dovecot must be configured to use auth-client not auth-userdb.
28439 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28440 to use the same mechanisms for SMTP authentication. This is a server
28441 authenticator only. There is only one non-generic option:
28442
28443 .option server_socket dovecot string unset
28444
28445 This option must specify the UNIX socket that is the interface to Dovecot
28446 authentication. The &%public_name%& option must specify an authentication
28447 mechanism that Dovecot is configured to support. You can have several
28448 authenticators for different mechanisms. For example:
28449 .code
28450 dovecot_plain:
28451   driver = dovecot
28452   public_name = PLAIN
28453   server_advertise_condition = ${if def:tls_in_cipher}
28454   server_socket = /var/run/dovecot/auth-client
28455   server_set_id = $auth1
28456
28457 dovecot_ntlm:
28458   driver = dovecot
28459   public_name = NTLM
28460   server_socket = /var/run/dovecot/auth-client
28461   server_set_id = $auth1
28462 .endd
28463
28464 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28465 should not be advertised on cleartext SMTP connections.
28466 See the discussion in section &<<SECTplain_TLS>>&.
28467
28468 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28469 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28470 option is passed in the Dovecot authentication command. If, for a TLS
28471 connection, a client certificate has been verified, the &"valid-client-cert"&
28472 option is passed. When authentication succeeds, the identity of the user
28473 who authenticated is placed in &$auth1$&.
28474
28475 The Dovecot configuration to match the above will look
28476 something like:
28477 .code
28478 conf.d/10-master.conf :-
28479
28480 service auth {
28481 ...
28482 #SASL
28483   unix_listener auth-client {
28484     mode = 0660
28485     user = mail
28486   }
28487 ...
28488 }
28489
28490 conf.d/10-auth.conf :-
28491
28492 auth_mechanisms = plain login ntlm
28493 .endd
28494
28495 .ecindex IIDdcotauth1
28496 .ecindex IIDdcotauth2
28497
28498
28499 . ////////////////////////////////////////////////////////////////////////////
28500 . ////////////////////////////////////////////////////////////////////////////
28501 .chapter "The gsasl authenticator" "CHAPgsasl"
28502 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28503 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28504 .cindex "authentication" "GNU SASL"
28505 .cindex "authentication" "SASL"
28506 .cindex "authentication" "EXTERNAL"
28507 .cindex "authentication" "ANONYMOUS"
28508 .cindex "authentication" "PLAIN"
28509 .cindex "authentication" "LOGIN"
28510 .cindex "authentication" "DIGEST-MD5"
28511 .cindex "authentication" "CRAM-MD5"
28512 .cindex "authentication" "SCRAM family"
28513 The &(gsasl)& authenticator provides integration for the GNU SASL
28514 library and the mechanisms it provides.  This is new as of the 4.80 release
28515 and there are a few areas where the library does not let Exim smoothly
28516 scale to handle future authentication mechanisms, so no guarantee can be
28517 made that any particular new authentication mechanism will be supported
28518 without code changes in Exim.
28519
28520 The library is expected to add support in an upcoming
28521 realease for the SCRAM-SHA-256 method.
28522 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28523 when this happens.
28524
28525 To see the list of mechanisms supported by the library run Exim with "auth" debug
28526 enabled and look for a line containing "GNU SASL supports".
28527 Note however that some may not have been tested from Exim.
28528
28529
28530 .option client_authz gsasl string&!! unset
28531 This option can be used to supply an &'authorization id'&
28532 which is different to the &'authentication_id'& provided
28533 by &%client_username%& option.
28534 If unset or (after expansion) empty it is not used,
28535 which is the common case.
28536
28537 .option client_channelbinding gsasl boolean false
28538 See &%server_channelbinding%& below.
28539
28540 .option client_password gsasl string&!! unset
28541 This option is exapanded before use, and should result in
28542 the password to be used, in clear.
28543
28544 .option client_username gsasl string&!! unset
28545 This option is exapanded before use, and should result in
28546 the account name to be used.
28547
28548
28549 .option client_spassword gsasl string&!! unset
28550 This option is only supported for library versions 1.9.1 and greater.
28551 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28552
28553 If a SCRAM mechanism is being used and this option is set
28554 and correctly sized
28555 it is used in preference to &%client_password%&.
28556 The value after expansion should be
28557 a 40 (for SHA-1) or 64 (for SHA-256) character string
28558 with the PBKDF2-prepared password, hex-encoded.
28559
28560 Note that this value will depend on the salt and iteration-count
28561 supplied by the server.
28562 The option is expanded before use.
28563 During the expansion &$auth1$& is set with the client username,
28564 &$auth2$& with the iteration count, and
28565 &$auth3$& with the salt.
28566
28567 The intent of this option
28568 is to support clients that can cache thes salted password
28569 to save on recalculation costs.
28570 The cache lookup should return an unusable value
28571 (eg. an empty string)
28572 if the salt or iteration count has changed
28573
28574 If the authentication succeeds then the above variables are set,
28575 .vindex "&$auth4$&"
28576 plus the calculated salted password value value in &$auth4$&,
28577 during the expansion of the &%client_set_id%& option.
28578 A side-effect of this expansion can be used to prime the cache.
28579
28580
28581 .option server_channelbinding gsasl boolean false
28582 Some authentication mechanisms are able to use external context at both ends
28583 of the session to bind the authentication to that context, and fail the
28584 authentication process if that context differs.  Specifically, some TLS
28585 ciphersuites can provide identifying information about the cryptographic
28586 context.
28587
28588 This should have meant that certificate identity and verification becomes a
28589 non-issue, as a man-in-the-middle attack will cause the correct client and
28590 server to see different identifiers and authentication will fail.
28591
28592 This is
28593 only usable by mechanisms which support "channel binding"; at time of
28594 writing, that's the SCRAM family.
28595 When using this feature the "-PLUS" variants of the method names need to be used.
28596
28597 This defaults off to ensure smooth upgrade across Exim releases, in case
28598 this option causes some clients to start failing.  Some future release
28599 of Exim might have switched the default to be true.
28600
28601 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28602 . Do not plan to rely upon this feature for security, ever, without consulting
28603 . with a subject matter expert (a cryptographic engineer).
28604
28605 This option was deprecated in previous releases due to doubts over
28606 the "Triple Handshake" vulnerability.
28607 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28608 Session Resumption was used) for safety.
28609
28610
28611 .option server_hostname gsasl string&!! "see below"
28612 This option selects the hostname that is used when communicating with the
28613 library. The default value is &`$primary_hostname`&.
28614 Some mechanisms will use this data.
28615
28616
28617 .option server_mech gsasl string "see below"
28618 This option selects the authentication mechanism this driver should use. The
28619 default is the value of the generic &%public_name%& option. This option allows
28620 you to use a different underlying mechanism from the advertised name. For
28621 example:
28622 .code
28623 sasl:
28624   driver = gsasl
28625   public_name = X-ANYTHING
28626   server_mech = CRAM-MD5
28627   server_set_id = $auth1
28628 .endd
28629
28630
28631 .option server_password gsasl string&!! unset
28632 Various mechanisms need access to the cleartext password on the server, so
28633 that proof-of-possession can be demonstrated on the wire, without sending
28634 the password itself.
28635
28636 The data available for lookup varies per mechanism.
28637 In all cases, &$auth1$& is set to the &'authentication id'&.
28638 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28639 if available, else the empty string.
28640 The &$auth3$& variable will always be the &'realm'& if available,
28641 else the empty string.
28642
28643 A forced failure will cause authentication to defer.
28644
28645 If using this option, it may make sense to set the &%server_condition%&
28646 option to be simply "true".
28647
28648
28649 .option server_realm gsasl string&!! unset
28650 This specifies the SASL realm that the server claims to be in.
28651 Some mechanisms will use this data.
28652
28653
28654 .option server_scram_iter gsasl string&!! 4096
28655 This option provides data for the SCRAM family of mechanisms.
28656 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28657 when this option is expanded.
28658
28659 The result of expansion should be a decimal number,
28660 and represents both a lower-bound on the security, and
28661 a compute cost factor imposed on the client
28662 (if it does not cache results, or the server changes
28663 either the iteration count or the salt).
28664 A minimum value of 4096 is required by the standards
28665 for all current SCRAM mechanism variants.
28666
28667 .option server_scram_salt gsasl string&!! unset
28668 This option provides data for the SCRAM family of mechanisms.
28669 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28670 when this option is expanded.
28671 The value should be a base64-encoded string,
28672 of random data typically 4-to-16 bytes long.
28673 If unset or empty after expansion the library will provides a value for the
28674 protocol conversation.
28675
28676
28677 .option server_key gsasl string&!! unset
28678 .option server_skey gsasl string&!! unset
28679 These options can be used for the SCRAM family of mechanisms
28680 to provide stored information related to a password,
28681 the storage of which is preferable to plaintext.
28682
28683 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28684 &%server_skey%& is StoredKey.
28685
28686 They are only available for version 1.9.0 (or later) of the gsasl library.
28687 When this is so, the macros
28688 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28689 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28690 will be defined.
28691
28692 The &$authN$& variables are available when these options are expanded.
28693
28694 If set, the results of expansion should for each
28695 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28696 of base64-coded data, and will be used in preference to the
28697 &%server_password%& option.
28698 If unset or not of the right length, &%server_password%& will be used.
28699
28700 The libgsasl library release includes a utility &'gsasl'& which can be used
28701 to generate these values.
28702
28703
28704 .option server_service gsasl string &`smtp`&
28705 This is the SASL service that the server claims to implement.
28706 Some mechanisms will use this data.
28707
28708
28709 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28710 .vindex "&$auth1$&, &$auth2$&, etc"
28711 These may be set when evaluating specific options, as detailed above.
28712 They will also be set when evaluating &%server_condition%&.
28713
28714 Unless otherwise stated below, the &(gsasl)& integration will use the following
28715 meanings for these variables:
28716
28717 .ilist
28718 .vindex "&$auth1$&"
28719 &$auth1$&: the &'authentication id'&
28720 .next
28721 .vindex "&$auth2$&"
28722 &$auth2$&: the &'authorization id'&
28723 .next
28724 .vindex "&$auth3$&"
28725 &$auth3$&: the &'realm'&
28726 .endlist
28727
28728 On a per-mechanism basis:
28729
28730 .ilist
28731 .cindex "authentication" "EXTERNAL"
28732 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28733 the &%server_condition%& option must be present.
28734 .next
28735 .cindex "authentication" "ANONYMOUS"
28736 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28737 the &%server_condition%& option must be present.
28738 .next
28739 .cindex "authentication" "GSSAPI"
28740 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28741 &$auth2$& will be set to the &'authorization id'&,
28742 the &%server_condition%& option must be present.
28743 .endlist
28744
28745 An &'anonymous token'& is something passed along as an unauthenticated
28746 identifier; this is analogous to FTP anonymous authentication passing an
28747 email address, or software-identifier@, as the "password".
28748
28749
28750 An example showing the password having the realm specified in the callback
28751 and demonstrating a Cyrus SASL to GSASL migration approach is:
28752 .code
28753 gsasl_cyrusless_crammd5:
28754   driver = gsasl
28755   public_name = CRAM-MD5
28756   server_realm = imap.example.org
28757   server_password = ${lookup{$auth1:$auth3:userPassword}\
28758                     dbmjz{/etc/sasldb2}{$value}fail}
28759   server_set_id = ${quote:$auth1}
28760   server_condition = yes
28761 .endd
28762
28763
28764 . ////////////////////////////////////////////////////////////////////////////
28765 . ////////////////////////////////////////////////////////////////////////////
28766
28767 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28768 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28769 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28770 .cindex "authentication" "GSSAPI"
28771 .cindex "authentication" "Kerberos"
28772 The &(heimdal_gssapi)& authenticator provides server integration for the
28773 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28774 reliably.
28775
28776 .option server_hostname heimdal_gssapi string&!! "see below"
28777 This option selects the hostname that is used, with &%server_service%&,
28778 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28779 identifier.  The default value is &`$primary_hostname`&.
28780
28781 .option server_keytab heimdal_gssapi string&!! unset
28782 If set, then Heimdal will not use the system default keytab (typically
28783 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28784 The value should be a pathname, with no &"file:"& prefix.
28785
28786 .option server_service heimdal_gssapi string&!! "smtp"
28787 This option specifies the service identifier used, in conjunction with
28788 &%server_hostname%&, for building the identifier for finding credentials
28789 from the keytab.
28790
28791
28792 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28793 Beware that these variables will typically include a realm, thus will appear
28794 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28795 not verified, so a malicious client can set it to anything.
28796
28797 The &$auth1$& field should be safely trustable as a value from the Key
28798 Distribution Center.  Note that these are not quite email addresses.
28799 Each identifier is for a role, and so the left-hand-side may include a
28800 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28801
28802 .vindex "&$auth1$&, &$auth2$&, etc"
28803 .ilist
28804 .vindex "&$auth1$&"
28805 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28806 .next
28807 .vindex "&$auth2$&"
28808 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28809 authentication.  If that was empty, this will also be set to the
28810 GSS Display Name.
28811 .endlist
28812
28813
28814 . ////////////////////////////////////////////////////////////////////////////
28815 . ////////////////////////////////////////////////////////////////////////////
28816
28817 .chapter "The spa authenticator" "CHAPspa"
28818 .scindex IIDspaauth1 "&(spa)& authenticator"
28819 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28820 .cindex "authentication" "Microsoft Secure Password"
28821 .cindex "authentication" "NTLM"
28822 .cindex "Microsoft Secure Password Authentication"
28823 .cindex "NTLM authentication"
28824 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28825 Password Authentication'& mechanism,
28826 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28827 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28828 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28829 server side was subsequently contributed by Tom Kistner. The mechanism works as
28830 follows:
28831
28832 .ilist
28833 After the AUTH command has been accepted, the client sends an SPA
28834 authentication request based on the user name and optional domain.
28835 .next
28836 The server sends back a challenge.
28837 .next
28838 The client builds a challenge response which makes use of the user's password
28839 and sends it to the server, which then accepts or rejects it.
28840 .endlist
28841
28842 Encryption is used to protect the password in transit.
28843
28844
28845
28846 .section "Using spa as a server" "SECID179"
28847 .cindex "options" "&(spa)& authenticator (server)"
28848 The &(spa)& authenticator has just one server option:
28849
28850 .option server_password spa string&!! unset
28851 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28852 This option is expanded, and the result must be the cleartext password for the
28853 authenticating user, whose name is at this point in &$auth1$&. For
28854 compatibility with previous releases of Exim, the user name is also placed in
28855 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28856 it can lead to confusion in string expansions that also use numeric variables
28857 for other things. For example:
28858 .code
28859 spa:
28860   driver = spa
28861   public_name = NTLM
28862   server_password = \
28863     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28864 .endd
28865 If the expansion is forced to fail, authentication fails. Any other expansion
28866 failure causes a temporary error code to be returned.
28867
28868
28869
28870
28871
28872 .section "Using spa as a client" "SECID180"
28873 .cindex "options" "&(spa)& authenticator (client)"
28874 The &(spa)& authenticator has the following client options:
28875
28876
28877
28878 .option client_domain spa string&!! unset
28879 This option specifies an optional domain for the authentication.
28880
28881
28882 .option client_password spa string&!! unset
28883 This option specifies the user's password, and must be set.
28884
28885
28886 .option client_username spa string&!! unset
28887 This option specifies the user name, and must be set. Here is an example of a
28888 configuration of this authenticator for use with the mail servers at
28889 &'msn.com'&:
28890 .code
28891 msn:
28892   driver = spa
28893   public_name = MSN
28894   client_username = msn/msn_username
28895   client_password = msn_plaintext_password
28896   client_domain = DOMAIN_OR_UNSET
28897 .endd
28898 .ecindex IIDspaauth1
28899 .ecindex IIDspaauth2
28900
28901
28902
28903
28904
28905 . ////////////////////////////////////////////////////////////////////////////
28906 . ////////////////////////////////////////////////////////////////////////////
28907
28908 .chapter "The external authenticator" "CHAPexternauth"
28909 .scindex IIDexternauth1 "&(external)& authenticator"
28910 .scindex IIDexternauth2 "authenticators" "&(external)&"
28911 .cindex "authentication" "Client Certificate"
28912 .cindex "authentication" "X509"
28913 .cindex "Certificate-based authentication"
28914 The &(external)& authenticator provides support for
28915 authentication based on non-SMTP information.
28916 The specification is in RFC 4422 Appendix A
28917 (&url(https://tools.ietf.org/html/rfc4422)).
28918 It is only a transport and negotiation mechanism;
28919 the process of authentication is entirely controlled
28920 by the server configuration.
28921
28922 The client presents an identity in-clear.
28923 It is probably wise for a server to only advertise,
28924 and for clients to only attempt,
28925 this authentication method on a secure (eg. under TLS) connection.
28926
28927 One possible use, compatible with the
28928 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28929 is for using X509 client certificates.
28930
28931 It thus overlaps in function with the TLS authenticator
28932 (see &<<CHAPtlsauth>>&)
28933 but is a full SMTP SASL authenticator
28934 rather than being implicit for TLS-connection carried
28935 client certificates only.
28936
28937 The examples and discussion in this chapter assume that
28938 client-certificate authentication is being done.
28939
28940 The client must present a certificate,
28941 for which it must have been requested via the
28942 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28943 (see &<<CHAPTLS>>&).
28944 For authentication to be effective the certificate should be
28945 verifiable against a trust-anchor certificate known to the server.
28946
28947 .section "External options" "SECTexternsoptions"
28948 .cindex "options" "&(external)& authenticator (server)"
28949 The &(external)& authenticator has two server options:
28950
28951 .option server_param2 external string&!! unset
28952 .option server_param3 external string&!! unset
28953 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28954 These options are expanded before the &%server_condition%& option
28955 and the result are placed in &$auth2$& and &$auth3$& resectively.
28956 If the expansion is forced to fail, authentication fails. Any other expansion
28957 failure causes a temporary error code to be returned.
28958
28959 They can be used to clarify the coding of a complex &%server_condition%&.
28960
28961 .section "Using external in a server" "SECTexternserver"
28962 .cindex "AUTH" "in &(external)& authenticator"
28963 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28964         "in &(external)& authenticator"
28965 .vindex "&$auth1$&, &$auth2$&, etc"
28966 .cindex "base64 encoding" "in &(external)& authenticator"
28967
28968 When running as a server, &(external)& performs the authentication test by
28969 expanding a string. The data sent by the client with the AUTH command, or in
28970 response to subsequent prompts, is base64 encoded, and so may contain any byte
28971 values when decoded. The decoded value is treated as
28972 an identity for authentication and
28973 placed in the expansion variable &$auth1$&.
28974
28975 For compatibility with previous releases of Exim, the value is also placed in
28976 the expansion variable &$1$&. However, the use of this
28977 variable for this purpose is now deprecated, as it can lead to confusion in
28978 string expansions that also use them for other things.
28979
28980 .vindex "&$authenticated_id$&"
28981 Once an identity has been received,
28982 &%server_condition%& is expanded. If the expansion is forced to fail,
28983 authentication fails. Any other expansion failure causes a temporary error code
28984 to be returned. If the result of a successful expansion is an empty string,
28985 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28986 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28987 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28988 For any other result, a temporary error code is returned, with the expanded
28989 string as the error text.
28990
28991 Example:
28992 .code
28993 ext_ccert_san_mail:
28994   driver =            external
28995   public_name =       EXTERNAL
28996
28997   server_advertise_condition = $tls_in_certificate_verified
28998   server_param2 =     ${certextract {subj_altname,mail,>:} \
28999                                     {$tls_in_peercert}}
29000   server_condition =  ${if forany {$auth2} \
29001                             {eq {$item}{$auth1}}}
29002   server_set_id =     $auth1
29003 .endd
29004 This accepts a client certificate that is verifiable against any
29005 of your configured trust-anchors
29006 (which usually means the full set of public CAs)
29007 and which has a mail-SAN matching the claimed identity sent by the client.
29008
29009 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
29010 The account name is therefore guessable by an opponent.
29011 TLS 1.3 protects both server and client certificates, and is not vulnerable
29012 in this way.
29013
29014
29015 .section "Using external in a client" "SECTexternclient"
29016 .cindex "options" "&(external)& authenticator (client)"
29017 The &(external)& authenticator has one client option:
29018
29019 .option client_send external string&!! unset
29020 This option is expanded and sent with the AUTH command as the
29021 identity being asserted.
29022
29023 Example:
29024 .code
29025 ext_ccert:
29026   driver =      external
29027   public_name = EXTERNAL
29028
29029   client_condition = ${if !eq{$tls_out_cipher}{}}
29030   client_send = myaccount@smarthost.example.net
29031 .endd
29032
29033
29034 .ecindex IIDexternauth1
29035 .ecindex IIDexternauth2
29036
29037
29038
29039
29040
29041 . ////////////////////////////////////////////////////////////////////////////
29042 . ////////////////////////////////////////////////////////////////////////////
29043
29044 .chapter "The tls authenticator" "CHAPtlsauth"
29045 .scindex IIDtlsauth1 "&(tls)& authenticator"
29046 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
29047 .cindex "authentication" "Client Certificate"
29048 .cindex "authentication" "X509"
29049 .cindex "Certificate-based authentication"
29050 The &(tls)& authenticator provides server support for
29051 authentication based on client certificates.
29052
29053 It is not an SMTP authentication mechanism and is not
29054 advertised by the server as part of the SMTP EHLO response.
29055 It is an Exim authenticator in the sense that it affects
29056 the protocol element of the log line, can be tested for
29057 by the &%authenticated%& ACL condition, and can set
29058 the &$authenticated_id$& variable.
29059
29060 The client must present a verifiable certificate,
29061 for which it must have been requested via the
29062 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29063 (see &<<CHAPTLS>>&).
29064
29065 If an authenticator of this type is configured it is
29066 run immediately after a TLS connection being negotiated
29067 (due to either STARTTLS or TLS-on-connect)
29068 and can authenticate the connection.
29069 If it does, SMTP authentication is not subsequently offered.
29070
29071 A maximum of one authenticator of this type may be present.
29072
29073
29074 .cindex "options" "&(tls)& authenticator (server)"
29075 The &(tls)& authenticator has three server options:
29076
29077 .option server_param1 tls string&!! unset
29078 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29079 This option is expanded after the TLS negotiation and
29080 the result is placed in &$auth1$&.
29081 If the expansion is forced to fail, authentication fails. Any other expansion
29082 failure causes a temporary error code to be returned.
29083
29084 .option server_param2 tls string&!! unset
29085 .option server_param3 tls string&!! unset
29086 As above, for &$auth2$& and &$auth3$&.
29087
29088 &%server_param1%& may also be spelled &%server_param%&.
29089
29090
29091 Example:
29092 .code
29093 tls:
29094   driver = tls
29095   server_param1 =     ${certextract {subj_altname,mail,>:} \
29096                                     {$tls_in_peercert}}
29097   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29098                                  {forany {$auth1} \
29099                             {!= {0} \
29100                                 {${lookup ldap{ldap:///\
29101                          mailname=${quote_ldap_dn:${lc:$item}},\
29102                          ou=users,LDAP_DC?mailid} {$value}{0} \
29103                        }    }  } }}}
29104   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29105 .endd
29106 This accepts a client certificate that is verifiable against any
29107 of your configured trust-anchors
29108 (which usually means the full set of public CAs)
29109 and which has a SAN with a good account name.
29110
29111 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29112 The account name is therefore guessable by an opponent.
29113 TLS 1.3 protects both server and client certificates, and is not vulnerable
29114 in this way.
29115 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29116
29117 . An alternative might use
29118 . .code
29119 .   server_param1 = ${sha256:$tls_in_peercert}
29120 . .endd
29121 . to require one of a set of specific certs that define a given account
29122 . (the verification is still required, but mostly irrelevant).
29123 . This would help for per-device use.
29124 .
29125 . However, for the future we really need support for checking a
29126 . user cert in LDAP - which probably wants a base-64 DER.
29127
29128 .ecindex IIDtlsauth1
29129 .ecindex IIDtlsauth2
29130
29131
29132 Note that because authentication is traditionally an SMTP operation,
29133 the &%authenticated%& ACL condition cannot be used in
29134 a connect- or helo-ACL.
29135
29136
29137
29138 . ////////////////////////////////////////////////////////////////////////////
29139 . ////////////////////////////////////////////////////////////////////////////
29140
29141 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29142          "Encrypted SMTP connections"
29143 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29144 .scindex IIDencsmtp2 "SMTP" "encryption"
29145 .cindex "TLS" "on SMTP connection"
29146 .cindex "OpenSSL"
29147 .cindex "GnuTLS"
29148 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29149 Sockets Layer), is implemented by making use of the OpenSSL library or the
29150 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29151 cryptographic code in the Exim distribution itself for implementing TLS. In
29152 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29153 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29154 You also need to understand the basic concepts of encryption at a managerial
29155 level, and in particular, the way that public keys, private keys, and
29156 certificates are used.
29157
29158 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29159 connection is established, the client issues a STARTTLS command. If the
29160 server accepts this, the client and the server negotiate an encryption
29161 mechanism. If the negotiation succeeds, the data that subsequently passes
29162 between them is encrypted.
29163
29164 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29165 and if so, what cipher suite is in use, whether the client supplied a
29166 certificate, and whether or not that certificate was verified. This makes it
29167 possible for an Exim server to deny or accept certain commands based on the
29168 encryption state.
29169
29170 &*Warning*&: Certain types of firewall and certain anti-virus products can
29171 disrupt TLS connections. You need to turn off SMTP scanning for these products
29172 in order to get TLS to work.
29173
29174
29175
29176 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29177          "SECID284"
29178 .cindex "submissions protocol"
29179 .cindex "ssmtp protocol"
29180 .cindex "smtps protocol"
29181 .cindex "SMTP" "submissions protocol"
29182 .cindex "SMTP" "ssmtp protocol"
29183 .cindex "SMTP" "smtps protocol"
29184 The history of port numbers for TLS in SMTP is a little messy and has been
29185 contentious.  As of RFC 8314, the common practice of using the historically
29186 allocated port 465 for "email submission but with TLS immediately upon connect
29187 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29188 by them in preference to STARTTLS.
29189
29190 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29191 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29192 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29193
29194 This approach was, for a while, officially abandoned when encrypted SMTP was
29195 standardized, but many clients kept using it, even as the TCP port number was
29196 reassigned for other use.
29197 Thus you may encounter guidance claiming that you shouldn't enable use of
29198 this port.
29199 In practice, a number of mail-clients have only ever supported submissions,
29200 not submission with STARTTLS upgrade.
29201 Ideally, offer both submission (587) and submissions (465) service.
29202
29203 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29204 global option. Its value must be a list of port numbers;
29205 the most common use is expected to be:
29206 .code
29207 tls_on_connect_ports = 465
29208 .endd
29209 The port numbers specified by this option apply to all SMTP connections, both
29210 via the daemon and via &'inetd'&. You still need to specify all the ports that
29211 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29212 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29213 an extra port &-- rather, it specifies different behaviour on a port that is
29214 defined elsewhere.
29215
29216 There is also a &%-tls-on-connect%& command line option. This overrides
29217 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29218
29219
29220
29221
29222
29223
29224 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29225 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29226 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29227 To build Exim to use OpenSSL you need to set
29228 .code
29229 USE_OPENSSL=yes
29230 .endd
29231 in Local/Makefile.
29232
29233 To build Exim to use GnuTLS, you need to set
29234 .code
29235 USE_GNUTLS=yes
29236 .endd
29237 in Local/Makefile.
29238
29239 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29240 include files and libraries for GnuTLS can be found.
29241
29242 There are some differences in usage when using GnuTLS instead of OpenSSL:
29243
29244 .ilist
29245 The &%tls_verify_certificates%& option
29246 cannot be the path of a directory
29247 for GnuTLS versions before 3.3.6
29248 (for later versions, or OpenSSL, it can be either).
29249 .next
29250 The default value for &%tls_dhparam%& differs for historical reasons.
29251 .next
29252 .vindex "&$tls_in_peerdn$&"
29253 .vindex "&$tls_out_peerdn$&"
29254 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29255 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29256 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29257 .next
29258 OpenSSL identifies cipher suites using hyphens as separators, for example:
29259 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29260 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29261 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29262 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29263 to handle its own older variants) when processing lists of cipher suites in the
29264 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29265 option).
29266 .next
29267 The &%tls_require_ciphers%& options operate differently, as described in the
29268 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29269 .next
29270 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29271 When using OpenSSL, this option is ignored.
29272 (If an API is found to let OpenSSL be configured in this way,
29273 let the Exim Maintainers know and we'll likely use it).
29274 .next
29275 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option,
29276 it must be ordered to match the &%tls_certificate%& list.
29277 .next
29278 Some other recently added features may only be available in one or the other.
29279 This should be documented with the feature.  If the documentation does not
29280 explicitly state that the feature is infeasible in the other TLS
29281 implementation, then patches are welcome.
29282 .next
29283 The output from "exim -bV" will show which (if any) support was included
29284 in the build.
29285 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29286 .endlist
29287
29288
29289 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29290 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29291 an explicit path; if the latter, then the text about generation still applies,
29292 but not the chosen filename.
29293 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29294 See the documentation of &%tls_dhparam%& for more information.
29295
29296 GnuTLS uses D-H parameters that may take a substantial amount of time
29297 to compute. It is unreasonable to re-compute them for every TLS session.
29298 Therefore, Exim keeps this data in a file in its spool directory, called
29299 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29300 of bits requested.
29301 The file is owned by the Exim user and is readable only by
29302 its owner. Every Exim process that start up GnuTLS reads the D-H
29303 parameters from this file. If the file does not exist, the first Exim process
29304 that needs it computes the data and writes it to a temporary file which is
29305 renamed once it is complete. It does not matter if several Exim processes do
29306 this simultaneously (apart from wasting a few resources). Once a file is in
29307 place, new Exim processes immediately start using it.
29308
29309 For maximum security, the parameters that are stored in this file should be
29310 recalculated periodically, the frequency depending on your paranoia level.
29311 If you are avoiding using the fixed D-H primes published in RFCs, then you
29312 are concerned about some advanced attacks and will wish to do this; if you do
29313 not regenerate then you might as well stick to the standard primes.
29314
29315 Arranging this is easy in principle; just delete the file when you want new
29316 values to be computed. However, there may be a problem. The calculation of new
29317 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29318 If the system is not very active, &_/dev/random_& may delay returning data
29319 until enough randomness (entropy) is available. This may cause Exim to hang for
29320 a substantial amount of time, causing timeouts on incoming connections.
29321
29322 The solution is to generate the parameters externally to Exim. They are stored
29323 in &_gnutls-params-N_& in PEM format, which means that they can be
29324 generated externally using the &(certtool)& command that is part of GnuTLS.
29325
29326 To replace the parameters with new ones, instead of deleting the file
29327 and letting Exim re-create it, you can generate new parameters using
29328 &(certtool)& and, when this has been done, replace Exim's cache file by
29329 renaming. The relevant commands are something like this:
29330 .code
29331 # ls
29332 [ look for file; assume gnutls-params-2236 is the most recent ]
29333 # rm -f new-params
29334 # touch new-params
29335 # chown exim:exim new-params
29336 # chmod 0600 new-params
29337 # certtool --generate-dh-params --bits 2236 >>new-params
29338 # openssl dhparam -noout -text -in new-params | head
29339 [ check the first line, make sure it's not more than 2236;
29340   if it is, then go back to the start ("rm") and repeat
29341   until the size generated is at most the size requested ]
29342 # chmod 0400 new-params
29343 # mv new-params gnutls-params-2236
29344 .endd
29345 If Exim never has to generate the parameters itself, the possibility of
29346 stalling is removed.
29347
29348 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29349 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29350 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29351 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29352 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29353 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29354 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29355 which applies to all D-H usage, client or server.  If the value returned by
29356 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29357 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29358 limit, which is still much higher than Exim historically used.
29359
29360 The filename and bits used will change as the GnuTLS maintainers change the
29361 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29362 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29363 2432 bits, while NSS is limited to 2236 bits.
29364
29365 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29366 increase the chance of the generated prime actually being within acceptable
29367 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29368 procedure above.  There is no sane procedure available to Exim to double-check
29369 the size of the generated prime, so it might still be too large.
29370
29371
29372 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29373 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29374 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29375 There is a function in the OpenSSL library that can be passed a list of cipher
29376 suites before the cipher negotiation takes place. This specifies which ciphers
29377 are acceptable for TLS versions prior to 1.3.
29378 The list is colon separated and may contain names like
29379 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29380 directly to this function call.
29381 Many systems will install the OpenSSL manual-pages, so you may have
29382 &'ciphers(1)'& available to you.
29383 The following quotation from the OpenSSL
29384 documentation specifies what forms of item are allowed in the cipher string:
29385
29386 .ilist
29387 It can consist of a single cipher suite such as RC4-SHA.
29388 .next
29389 It can represent a list of cipher suites containing a certain algorithm,
29390 or cipher suites of a certain type. For example SHA1 represents all
29391 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29392 SSL v3 algorithms.
29393 .next
29394 Lists of cipher suites can be combined in a single cipher string using
29395 the + character. This is used as a logical and operation. For example
29396 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29397 algorithms.
29398 .endlist
29399
29400 Each cipher string can be optionally preceded by one of the characters &`!`&,
29401 &`-`& or &`+`&.
29402 .ilist
29403 If &`!`& is used, the ciphers are permanently deleted from the list. The
29404 ciphers deleted can never reappear in the list even if they are explicitly
29405 stated.
29406 .next
29407 If &`-`& is used, the ciphers are deleted from the list, but some or all
29408 of the ciphers can be added again by later options.
29409 .next
29410 If &`+`& is used, the ciphers are moved to the end of the list. This
29411 option does not add any new ciphers; it just moves matching existing ones.
29412 .endlist
29413
29414 If none of these characters is present, the string is interpreted as
29415 a list of ciphers to be appended to the current preference list. If the list
29416 includes any ciphers already present they will be ignored: that is, they will
29417 not be moved to the end of the list.
29418 .endlist
29419
29420 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29421 string:
29422 .code
29423 # note single-quotes to get ! past any shell history expansion
29424 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29425 .endd
29426
29427 This example will let the library defaults be permitted on the MX port, where
29428 there's probably no identity verification anyway, but ups the ante on the
29429 submission ports where the administrator might have some influence on the
29430 choice of clients used:
29431 .code
29432 # OpenSSL variant; see man ciphers(1)
29433 tls_require_ciphers = ${if =={$received_port}{25}\
29434                            {DEFAULT}\
29435                            {HIGH:!MD5:!SHA1}}
29436 .endd
29437
29438 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29439 .code
29440 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29441 .endd
29442
29443 For TLS version 1.3 the control available is less fine-grained
29444 and Exim does not provide access to it at present.
29445 The value of the &%tls_require_ciphers%& option is ignored when
29446 TLS version 1.3 is negotiated.
29447
29448 As of writing the library default cipher suite list for TLSv1.3 is
29449 .code
29450 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29451 .endd
29452
29453
29454 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29455          "SECTreqciphgnu"
29456 .cindex "GnuTLS" "specifying parameters for"
29457 .cindex "TLS" "specifying ciphers (GnuTLS)"
29458 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29459 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29460 .cindex "TLS" "specifying protocols (GnuTLS)"
29461 .cindex "TLS" "specifying priority string (GnuTLS)"
29462 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29463 The GnuTLS library allows the caller to provide a "priority string", documented
29464 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29465 ciphersuite specification in OpenSSL.
29466
29467 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29468 and controls both protocols and ciphers.
29469
29470 The &%tls_require_ciphers%& option is available both as an global option,
29471 controlling how Exim behaves as a server, and also as an option of the
29472 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29473 the value is string expanded.  The resulting string is not an Exim list and
29474 the string is given to the GnuTLS library, so that Exim does not need to be
29475 aware of future feature enhancements of GnuTLS.
29476
29477 Documentation of the strings accepted may be found in the GnuTLS manual, under
29478 "Priority strings".  This is online as
29479 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29480 but beware that this relates to GnuTLS 3, which may be newer than the version
29481 installed on your system.  If you are using GnuTLS 3,
29482 then the example code
29483 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29484 on that site can be used to test a given string.
29485
29486 For example:
29487 .code
29488 # Disable older versions of protocols
29489 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29490 .endd
29491
29492 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29493 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29494 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29495
29496 This example will let the library defaults be permitted on the MX port, where
29497 there's probably no identity verification anyway, and lowers security further
29498 by increasing compatibility; but this ups the ante on the submission ports
29499 where the administrator might have some influence on the choice of clients
29500 used:
29501 .code
29502 # GnuTLS variant
29503 tls_require_ciphers = ${if =={$received_port}{25}\
29504                            {NORMAL:%COMPAT}\
29505                            {SECURE128}}
29506 .endd
29507
29508
29509 .section "Configuring an Exim server to use TLS" "SECID182"
29510 .cindex "TLS" "configuring an Exim server"
29511 .cindex "ESMTP extensions" STARTTLS
29512 When Exim has been built with TLS support, it advertises the availability of
29513 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29514 but not to any others. The default value of this option is *, which means
29515 that STARTTLS is always advertised.  Set it to blank to never advertise;
29516 this is reasonable for systems that want to use TLS only as a client.
29517
29518 If STARTTLS is to be used you
29519 need to set some other options in order to make TLS available.
29520
29521 If a client issues a STARTTLS command and there is some configuration
29522 problem in the server, the command is rejected with a 454 error. If the client
29523 persists in trying to issue SMTP commands, all except QUIT are rejected
29524 with the error
29525 .code
29526 554 Security failure
29527 .endd
29528 If a STARTTLS command is issued within an existing TLS session, it is
29529 rejected with a 554 error code.
29530
29531 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29532 must be set to match some hosts. The default is * which matches all hosts.
29533
29534 If this is all you do, TLS encryption will be enabled but not authentication -
29535 meaning that the peer has no assurance it is actually you he is talking to.
29536 You gain protection from a passive sniffer listening on the wire but not
29537 from someone able to intercept the communication.
29538
29539 Further protection requires some further configuration at the server end.
29540
29541 To make TLS work you need to set, in the server,
29542 .code
29543 tls_certificate = /some/file/name
29544 tls_privatekey = /some/file/name
29545 .endd
29546 These options are, in fact, expanded strings, so you can make them depend on
29547 the identity of the client that is connected if you wish. The first file
29548 contains the server's X509 certificate, and the second contains the private key
29549 that goes with it. These files need to be
29550 PEM format and readable by the Exim user, and must
29551 always be given as full path names.
29552 The key must not be password-protected.
29553 They can be the same file if both the
29554 certificate and the key are contained within it. If &%tls_privatekey%& is not
29555 set, or if its expansion is forced to fail or results in an empty string, this
29556 is assumed to be the case. The certificate file may also contain intermediate
29557 certificates that need to be sent to the client to enable it to authenticate
29558 the server's certificate.
29559
29560 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29561 colon-separated lists of file paths.  Ciphers using given authentication
29562 algorithms require the presence of a suitable certificate to supply the
29563 public-key.  The server selects among the certificates to present to the
29564 client depending on the selected cipher, hence the priority ordering for
29565 ciphers will affect which certificate is used.
29566
29567 If you do not understand about certificates and keys, please try to find a
29568 source of this background information, which is not Exim-specific. (There are a
29569 few comments below in section &<<SECTcerandall>>&.)
29570
29571 &*Note*&: These options do not apply when Exim is operating as a client &--
29572 they apply only in the case of a server. If you need to use a certificate in an
29573 Exim client, you must set the options of the same names in an &(smtp)&
29574 transport.
29575
29576 With just these options, an Exim server will be able to use TLS. It does not
29577 require the client to have a certificate (but see below for how to insist on
29578 this). There is one other option that may be needed in other situations. If
29579 .code
29580 tls_dhparam = /some/file/name
29581 .endd
29582 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29583 with the parameters contained in the file.
29584 Set this to &`none`& to disable use of DH entirely, by making no prime
29585 available:
29586 .code
29587 tls_dhparam = none
29588 .endd
29589 This may also be set to a string identifying a standard prime to be used for
29590 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29591 used is &`ike23`&.  There are a few standard primes available, see the
29592 documentation for &%tls_dhparam%& for the complete list.
29593
29594 See the command
29595 .code
29596 openssl dhparam
29597 .endd
29598 for a way of generating file data.
29599
29600 The strings supplied for these three options are expanded every time a client
29601 host connects. It is therefore possible to use different certificates and keys
29602 for different hosts, if you so wish, by making use of the client's IP address
29603 in &$sender_host_address$& to control the expansion. If a string expansion is
29604 forced to fail, Exim behaves as if the option is not set.
29605
29606 .cindex "cipher" "logging"
29607 .cindex "log" "TLS cipher"
29608 .vindex "&$tls_in_cipher$&"
29609 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29610 an incoming TLS connection. It is included in the &'Received:'& header of an
29611 incoming message (by default &-- you can, of course, change this), and it is
29612 also included in the log line that records a message's arrival, keyed by
29613 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29614 condition can be used to test for specific cipher suites in ACLs.
29615
29616 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29617 can check the name of the cipher suite and vary their actions accordingly. The
29618 cipher suite names vary, depending on which TLS library is being used. For
29619 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29620 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29621 documentation for more details.
29622
29623 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29624 (again depending on the &%tls_cipher%& log selector).
29625
29626
29627 .subsection "Requesting and verifying client certificates"
29628 .cindex "certificate" "verification of client"
29629 .cindex "TLS" "client certificate verification"
29630 If you want an Exim server to request a certificate when negotiating a TLS
29631 session with a client, you must set either &%tls_verify_hosts%& or
29632 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29633 apply to all TLS connections. For any host that matches one of these options,
29634 Exim requests a certificate as part of the setup of the TLS session. The
29635 contents of the certificate are verified by comparing it with a list of
29636 expected trust-anchors or certificates.
29637 These may be the system default set (depending on library version),
29638 an explicit file or,
29639 depending on library version, a directory, identified by
29640 &%tls_verify_certificates%&.
29641
29642 A file can contain multiple certificates, concatenated end to end. If a
29643 directory is used
29644 (OpenSSL only),
29645 each certificate must be in a separate file, with a name (or a symbolic link)
29646 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29647 certificate. You can compute the relevant hash by running the command
29648 .code
29649 openssl x509 -hash -noout -in /cert/file
29650 .endd
29651 where &_/cert/file_& contains a single certificate.
29652
29653 There is no checking of names of the client against the certificate
29654 Subject Name or Subject Alternate Names.
29655
29656 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29657 what happens if the client does not supply a certificate, or if the certificate
29658 does not match any of the certificates in the collection named by
29659 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29660 attempt to set up a TLS session is aborted, and the incoming connection is
29661 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29662 session continues. ACLs that run for subsequent SMTP commands can detect the
29663 fact that no certificate was verified, and vary their actions accordingly. For
29664 example, you can insist on a certificate before accepting a message for
29665 relaying, but not when the message is destined for local delivery.
29666
29667 .vindex "&$tls_in_peerdn$&"
29668 When a client supplies a certificate (whether it verifies or not), the value of
29669 the Distinguished Name of the certificate is made available in the variable
29670 &$tls_in_peerdn$& during subsequent processing of the message.
29671
29672 .cindex "log" "distinguished name"
29673 Because it is often a long text string, it is not included in the log line or
29674 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29675 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29676 &%received_header_text%& to change the &'Received:'& header. When no
29677 certificate is supplied, &$tls_in_peerdn$& is empty.
29678
29679
29680 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29681 .cindex certificate caching
29682 .cindex privatekey caching
29683 .cindex crl caching
29684 .cindex ocsp caching
29685 .cindex ciphers caching
29686 .cindex "CA bundle" caching
29687 .cindex "certificate authorities" caching
29688 .cindex tls_certificate caching
29689 .cindex tls_privatekey caching
29690 .cindex tls_crl caching
29691 .cindex tls_ocsp_file caching
29692 .cindex tls_require_ciphers caching
29693 .cindex tls_verify_certificate caching
29694 .cindex caching certificate
29695 .cindex caching privatekey
29696 .cindex caching crl
29697 .cindex caching ocsp
29698 .cindex caching ciphers
29699 .cindex caching "certificate authorities
29700 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29701 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29702 expandable elements,
29703 then the associated information is loaded at daemon startup.
29704 It is made available
29705 to child processes forked for handling received SMTP connections.
29706
29707 This caching is currently only supported under Linux and FreeBSD.
29708
29709 If caching is not possible, for example if an item has to be dependent
29710 on the peer host so contains a &$sender_host_name$& expansion, the load
29711 of the associated information is done at the startup of the TLS connection.
29712
29713 The cache is invalidated and reloaded after any changes to the directories
29714 containing files specified by these options.
29715
29716 The information specified by the main option &%tls_verify_certificates%&
29717 is similarly cached so long as it specifies files explicitly
29718 or (under GnuTLS) is the string &"system,cache"&.
29719 The latter case is not automatically invalidated;
29720 it is the operator's responsibility to arrange for a daemon restart
29721 any time the system certificate authority bundle is updated.
29722 A HUP signal is sufficient for this.
29723 The value &"system"& results in no caching under GnuTLS.
29724
29725 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29726 is acceptable in configurations for the Exim executable.
29727
29728 Caching of the system Certificate Authorities bundle can
29729 save significant time and processing on every TLS connection
29730 accepted by Exim.
29731
29732
29733
29734
29735 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29736 .cindex "cipher" "logging"
29737 .cindex "log" "TLS cipher"
29738 .cindex "log" "distinguished name"
29739 .cindex "TLS" "configuring an Exim client"
29740 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29741 deliveries as well as to incoming, the latter one causing logging of the
29742 server certificate's DN. The remaining client configuration for TLS is all
29743 within the &(smtp)& transport.
29744
29745 .cindex "ESMTP extensions" STARTTLS
29746 It is not necessary to set any options to have TLS work in the &(smtp)&
29747 transport. If Exim is built with TLS support, and TLS is advertised by a
29748 server, the &(smtp)& transport always tries to start a TLS session. However,
29749 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29750 transport) to a list of server hosts for which TLS should not be used.
29751
29752 If you do not want Exim to attempt to send messages unencrypted when an attempt
29753 to set up an encrypted connection fails in any way, you can set
29754 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29755 those hosts, delivery is always deferred if an encrypted connection cannot be
29756 set up. If there are any other hosts for the address, they are tried in the
29757 usual way.
29758
29759 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29760 the message unencrypted. It always does this if the response to STARTTLS is
29761 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29762 session after a success response code, what happens is controlled by the
29763 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29764 delivery to this host is deferred, and other hosts (if available) are tried. If
29765 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29766 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29767 negotiation fails, Exim closes the current connection (because it is in an
29768 unknown state), opens a new one to the same host, and then tries the delivery
29769 unencrypted.
29770
29771 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29772 transport provide the client with a certificate, which is passed to the server
29773 if it requests it.
29774 This is an optional thing for TLS connections, although either end
29775 may insist on it.
29776 If the server is Exim, it will request a certificate only if
29777 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29778
29779 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29780 for client use (they are usable for server use).
29781 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29782 in failed connections.
29783
29784 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29785 specifies a collection of expected server certificates.
29786 These may be
29787 the system default set (depending on library version),
29788 a file,
29789 or (depending on library version) a directory.
29790 The client verifies the server's certificate
29791 against this collection, taking into account any revoked certificates that are
29792 in the list defined by &%tls_crl%&.
29793 Failure to verify fails the TLS connection unless either of the
29794 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29795
29796 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29797 certificate verification to the listed servers.  Verification either must
29798 or need not succeed respectively.
29799
29800 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29801 name checks are made on the server certificate.
29802 The match against this list is, as per other Exim usage, the
29803 IP for the host.  That is most closely associated with the
29804 name on the DNS A (or AAAA) record for the host.
29805 However, the name that needs to be in the certificate
29806 is the one at the head of any CNAME chain leading to the A record.
29807 The option defaults to always checking.
29808
29809 The &(smtp)& transport has two OCSP-related options:
29810 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29811 is requested and required for the connection to proceed.  The default
29812 value is empty.
29813 &%hosts_request_ocsp%&; a host-list for which (additionally)
29814 a Certificate Status is requested (but not necessarily verified).  The default
29815 value is "*" meaning that requests are made unless configured
29816 otherwise.
29817
29818 The host(s) should also be in &%hosts_require_tls%&, and
29819 &%tls_verify_certificates%& configured for the transport,
29820 for OCSP to be relevant.
29821
29822 If
29823 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29824 list of permitted cipher suites. If either of these checks fails, delivery to
29825 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29826 alternative hosts, if any.
29827
29828  &*Note*&:
29829 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29830 is operating as a client. Exim does not assume that a server certificate (set
29831 by the global options of the same name) should also be used when operating as a
29832 client.
29833
29834 .vindex "&$host$&"
29835 .vindex "&$host_address$&"
29836 All the TLS options in the &(smtp)& transport are expanded before use, with
29837 &$host$& and &$host_address$& containing the name and address of the server to
29838 which the client is connected. Forced failure of an expansion causes Exim to
29839 behave as if the relevant option were unset.
29840
29841 .vindex &$tls_out_bits$&
29842 .vindex &$tls_out_cipher$&
29843 .vindex &$tls_out_peerdn$&
29844 .vindex &$tls_out_sni$&
29845 Before an SMTP connection is established, the
29846 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29847 variables are emptied. (Until the first connection, they contain the values
29848 that were set when the message was received.) If STARTTLS is subsequently
29849 successfully obeyed, these variables are set to the relevant values for the
29850 outgoing connection.
29851
29852
29853
29854 .subsection "Caching of static client configuration items" SECTclientTLScache
29855 .cindex certificate caching
29856 .cindex privatekey caching
29857 .cindex crl caching
29858 .cindex ciphers caching
29859 .cindex "CA bundle" caching
29860 .cindex "certificate authorities" caching
29861 .cindex tls_certificate caching
29862 .cindex tls_privatekey caching
29863 .cindex tls_crl caching
29864 .cindex tls_require_ciphers caching
29865 .cindex tls_verify_certificate caching
29866 .cindex caching certificate
29867 .cindex caching privatekey
29868 .cindex caching crl
29869 .cindex caching ciphers
29870 .cindex caching "certificate authorities
29871 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29872 and &%tls_crl%& have values with no
29873 expandable elements,
29874 then the associated information is loaded per smtp transport
29875 at daemon startup, at the start of a queue run, or on a
29876 command-line specified message delivery.
29877 It is made available
29878 to child processes forked for handling making SMTP connections.
29879
29880 This caching is currently only supported under Linux.
29881
29882 If caching is not possible, the load
29883 of the associated information is done at the startup of the TLS connection.
29884
29885 The cache is invalidated in the daemon
29886 and reloaded after any changes to the directories
29887 containing files specified by these options.
29888
29889 The information specified by the main option &%tls_verify_certificates%&
29890 is similarly cached so long as it specifies files explicitly
29891 or (under GnuTLS) is the string &"system,cache"&.
29892 The latter case is not automatically invaludated;
29893 it is the operator's responsibility to arrange for a daemon restart
29894 any time the system certificate authority bundle is updated.
29895 A HUP signal is sufficient for this.
29896 The value &"system"& results in no caching under GnuTLS.
29897
29898 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29899 is acceptable in configurations for the Exim executable.
29900
29901 Caching of the system Certificate Authorities bundle can
29902 save significant time and processing on every TLS connection
29903 initiated by Exim.
29904
29905
29906
29907
29908 .section "Use of TLS Server Name Indication" "SECTtlssni"
29909 .cindex "TLS" "Server Name Indication"
29910 .cindex "TLS" SNI
29911 .cindex SNI
29912 .vindex "&$tls_in_sni$&"
29913 .oindex "&%tls_in_sni%&"
29914 With TLS1.0 or above, there is an extension mechanism by which extra
29915 information can be included at various points in the protocol.  One of these
29916 extensions, documented in RFC 6066 (and before that RFC 4366) is
29917 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29918 client in the initial handshake, so that the server can examine the servername
29919 within and possibly choose to use different certificates and keys (and more)
29920 for this session.
29921
29922 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29923 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29924 address.
29925
29926 With SMTP to MX, there are the same problems here as in choosing the identity
29927 against which to validate a certificate: you can't rely on insecure DNS to
29928 provide the identity which you then cryptographically verify.  So this will
29929 be of limited use in that environment.
29930
29931 With SMTP to Submission, there is a well-defined hostname which clients are
29932 connecting to and can validate certificates against.  Thus clients &*can*&
29933 choose to include this information in the TLS negotiation.  If this becomes
29934 wide-spread, then hosters can choose to present different certificates to
29935 different clients.  Or even negotiate different cipher suites.
29936
29937 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29938 if not empty, will be sent on a TLS session as part of the handshake.  There's
29939 nothing more to it.  Choosing a sensible value not derived insecurely is the
29940 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29941 for the lifetime of the client connection (including during authentication).
29942
29943 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29944 is forced to the name of the destination host, after any MX- or CNAME-following.
29945
29946 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29947 received from a client.
29948 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29949
29950 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29951 option (prior to expansion) then the following options will be re-expanded
29952 during TLS session handshake, to permit alternative values to be chosen:
29953
29954 .ilist
29955 &%tls_certificate%&
29956 .next
29957 &%tls_crl%&
29958 .next
29959 &%tls_privatekey%&
29960 .next
29961 &%tls_verify_certificates%&
29962 .next
29963 &%tls_ocsp_file%&
29964 .endlist
29965
29966 Great care should be taken to deal with matters of case, various injection
29967 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29968 can always be referenced; it is important to remember that &$tls_in_sni$& is
29969 arbitrary unverified data provided prior to authentication.
29970 Further, the initial certificate is loaded before SNI has arrived, so
29971 an expansion for &%tls_certificate%& must have a default which is used
29972 when &$tls_in_sni$& is empty.
29973
29974 The Exim developers are proceeding cautiously and so far no other TLS options
29975 are re-expanded.
29976
29977 When Exim is built against OpenSSL, OpenSSL must have been built with support
29978 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29979 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29980 see &`-servername`& in the output, then OpenSSL has support.
29981
29982 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29983 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29984 built, then you have SNI support).
29985
29986 .subsection ALPN
29987 .cindex TLS ALPN
29988 .cindex ALPN "general information"
29989 .cindex TLS "Application Layer Protocol Names"
29990 There is a TLS feature related to SNI
29991 called Application Layer Protocol Name (ALPN).
29992 This is intended to declare, or select, what protocol layer will be using a TLS
29993 connection.
29994 The client for the connection proposes a set of protocol names, and
29995 the server responds with a selected one.
29996 It is not, as of 2021, commonly used for SMTP connections.
29997 However, to guard against misdirected or malicious use of web clients
29998 (which often do use ALPN) against MTA ports, Exim by default check that
29999 there is no incompatible ALPN specified by a client for a TLS connection.
30000 If there is, the connection is rejected.
30001
30002 As a client Exim does not supply ALPN by default.
30003 The behaviour of both client and server can be configured using the options
30004 &%tls_alpn%& and &%hosts_require_alpn%&.
30005 There are no variables providing observability.
30006 Some feature-specific logging may appear on denied connections, but this
30007 depends on the behaviour of the peer
30008 (not all peers can send a feature-specific TLS Alert).
30009
30010 This feature is available when Exim is built with
30011 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
30012 the macro _HAVE_TLS_ALPN will be defined when this is so.
30013
30014
30015
30016 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
30017          "SECTmulmessam"
30018 .cindex "multiple SMTP deliveries with TLS"
30019 .cindex "TLS" "multiple message deliveries"
30020 Exim sends multiple messages down the same TCP/IP connection by starting up
30021 an entirely new delivery process for each message, passing the socket from
30022 one process to the next. This implementation does not fit well with the use
30023 of TLS, because there is quite a lot of state information associated with a TLS
30024 connection, not just a socket identification. Passing all the state information
30025 to a new process is not feasible. Consequently, for sending using TLS Exim
30026 starts an additional proxy process for handling the encryption, piping the
30027 unencrypted data stream from and to the delivery processes.
30028
30029 An older mode of operation can be enabled on a per-host basis by the
30030 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
30031 this list the proxy process described above is not used; instead Exim
30032 shuts down an existing TLS session being run by the delivery process
30033 before passing the socket to a new process. The new process may then
30034 try to start a new TLS session, and if successful, may try to re-authenticate
30035 if AUTH is in use, before sending the next message.
30036
30037 The RFC is not clear as to whether or not an SMTP session continues in clear
30038 after TLS has been shut down, or whether TLS may be restarted again later, as
30039 just described. However, if the server is Exim, this shutdown and
30040 reinitialization works. It is not known which (if any) other servers operate
30041 successfully if the client closes a TLS session and continues with unencrypted
30042 SMTP, but there are certainly some that do not work. For such servers, Exim
30043 should not pass the socket to another process, because the failure of the
30044 subsequent attempt to use it would cause Exim to record a temporary host error,
30045 and delay other deliveries to that host.
30046
30047 To test for this case, Exim sends an EHLO command to the server after
30048 closing down the TLS session. If this fails in any way, the connection is
30049 closed instead of being passed to a new delivery process, but no retry
30050 information is recorded.
30051
30052 There is also a manual override; you can set &%hosts_nopass_tls%& on the
30053 &(smtp)& transport to match those hosts for which Exim should not pass
30054 connections to new processes if TLS has been used.
30055
30056
30057
30058
30059 .section "Certificates and all that" "SECTcerandall"
30060 .cindex "certificate" "references to discussion"
30061 In order to understand fully how TLS works, you need to know about
30062 certificates, certificate signing, and certificate authorities.
30063 This is a large topic and an introductory guide is unsuitable for the Exim
30064 reference manual, so instead we provide pointers to existing documentation.
30065
30066 The Apache web-server was for a long time the canonical guide, so their
30067 documentation is a good place to start; their SSL module's Introduction
30068 document is currently at
30069 .display
30070 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30071 .endd
30072 and their FAQ is at
30073 .display
30074 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30075 .endd
30076
30077 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30078 0-201-61598-3) in 2001, contains both introductory and more in-depth
30079 descriptions.
30080 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30081 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30082 Ivan is the author of the popular TLS testing tools at
30083 &url(https://www.ssllabs.com/).
30084
30085
30086 .subsection "Certificate chains" SECID186
30087 A file named by &%tls_certificate%& may contain more than one
30088 certificate. This is useful in the case where the certificate that is being
30089 sent is validated by an intermediate certificate which the other end does
30090 not have. Multiple certificates must be in the correct order in the file.
30091 First the host's certificate itself, then the first intermediate
30092 certificate to validate the issuer of the host certificate, then the next
30093 intermediate certificate to validate the issuer of the first intermediate
30094 certificate, and so on, until finally (optionally) the root certificate.
30095 The root certificate must already be trusted by the recipient for
30096 validation to succeed, of course, but if it's not preinstalled, sending the
30097 root certificate along with the rest makes it available for the user to
30098 install if the receiving end is a client MUA that can interact with a user.
30099
30100 Note that certificates using MD5 are unlikely to work on today's Internet;
30101 even if your libraries allow loading them for use in Exim when acting as a
30102 server, increasingly clients will not accept such certificates.  The error
30103 diagnostics in such a case can be frustratingly vague.
30104
30105
30106
30107 .subsection "Self-signed certificates" SECID187
30108 .cindex "certificate" "self-signed"
30109 You can create a self-signed certificate using the &'req'& command provided
30110 with OpenSSL, like this:
30111 . ==== Do not shorten the duration here without reading and considering
30112 . ==== the text below.  Please leave it at 9999 days.
30113 .code
30114 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30115             -days 9999 -nodes
30116 .endd
30117 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30118 delimited and so can be identified independently. The &%-days%& option
30119 specifies a period for which the certificate is valid. The &%-nodes%& option is
30120 important: if you do not set it, the key is encrypted with a passphrase
30121 that you are prompted for, and any use that is made of the key causes more
30122 prompting for the passphrase. This is not helpful if you are going to use
30123 this certificate and key in an MTA, where prompting is not possible.
30124
30125 . ==== I expect to still be working 26 years from now.  The less technical
30126 . ==== debt I create, in terms of storing up trouble for my later years, the
30127 . ==== happier I will be then.  We really have reached the point where we
30128 . ==== should start, at the very least, provoking thought and making folks
30129 . ==== pause before proceeding, instead of leaving all the fixes until two
30130 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30131 . ==== -pdp, 2012
30132 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30133 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30134 the above command might produce a date in the past.  Think carefully about
30135 the lifetime of the systems you're deploying, and either reduce the duration
30136 of the certificate or reconsider your platform deployment.  (At time of
30137 writing, reducing the duration is the most likely choice, but the inexorable
30138 progression of time takes us steadily towards an era where this will not
30139 be a sensible resolution).
30140
30141 A self-signed certificate made in this way is sufficient for testing, and
30142 may be adequate for all your requirements if you are mainly interested in
30143 encrypting transfers, and not in secure identification.
30144
30145 However, many clients require that the certificate presented by the server be a
30146 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30147 certificate. In this situation, the self-signed certificate described above
30148 must be installed on the client host as a trusted root &'certification
30149 authority'& (CA), and the certificate used by Exim must be a user certificate
30150 signed with that self-signed certificate.
30151
30152 For information on creating self-signed CA certificates and using them to sign
30153 user certificates, see the &'General implementation overview'& chapter of the
30154 Open-source PKI book, available online at
30155 &url(https://sourceforge.net/projects/ospkibook/).
30156
30157
30158 .subsection "Revoked certificates"
30159 .cindex "TLS" "revoked certificates"
30160 .cindex "revocation list"
30161 .cindex "certificate" "revocation list"
30162 .cindex "OCSP" "stapling"
30163 There are three ways for a certificate to be made unusable
30164 before its expiry.
30165
30166 .ilist
30167 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30168 certificates are revoked. If you have such a list, you can pass it to an Exim
30169 server using the global option called &%tls_crl%& and to an Exim client using
30170 an identically named option for the &(smtp)& transport. In each case, the value
30171 of the option is expanded and must then be the name of a file that contains a
30172 CRL in PEM format.
30173 The downside is that clients have to periodically re-download a potentially huge
30174 file from every certificate authority they know of.
30175
30176 .next
30177 The way with most moving parts at query time is Online Certificate
30178 Status Protocol (OCSP), where the client verifies the certificate
30179 against an OCSP server run by the CA.  This lets the CA track all
30180 usage of the certs.  It requires running software with access to the
30181 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30182 is based on HTTP and can be proxied accordingly.
30183
30184 The only widespread OCSP server implementation (known to this writer)
30185 comes as part of OpenSSL and aborts on an invalid request, such as
30186 connecting to the port and then disconnecting.  This requires
30187 re-entering the passphrase each time some random client does this.
30188
30189 .next
30190 The third way is OCSP Stapling; in this, the server using a certificate
30191 issued by the CA periodically requests an OCSP proof of validity from
30192 the OCSP server, then serves it up inline as part of the TLS
30193 negotiation.   This approach adds no extra round trips, does not let the
30194 CA track users, scales well with number of certs issued by the CA and is
30195 resilient to temporary OCSP server failures, as long as the server
30196 starts retrying to fetch an OCSP proof some time before its current
30197 proof expires.  The downside is that it requires server support.
30198
30199 Unless Exim is built with the support disabled,
30200 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30201 support for OCSP stapling is included.
30202
30203 There is a global option called &%tls_ocsp_file%&.
30204 The file specified therein is expected to be in DER format, and contain
30205 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30206 option will be re-expanded for SNI, if the &%tls_certificate%& option
30207 contains &`tls_in_sni`&, as per other TLS options.
30208
30209 Exim does not at this time implement any support for fetching a new OCSP
30210 proof.  The burden is on the administrator to handle this, outside of
30211 Exim.  The file specified should be replaced atomically, so that the
30212 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30213 on each connection, so a new file will be handled transparently on the
30214 next connection.
30215
30216 When built with OpenSSL Exim will check for a valid next update timestamp
30217 in the OCSP proof; if not present, or if the proof has expired, it will be
30218 ignored.
30219
30220 For the client to be able to verify the stapled OCSP the server must
30221 also supply, in its stapled information, any intermediate
30222 certificates for the chain leading to the OCSP proof from the signer
30223 of the server certificate.  There may be zero or one such. These
30224 intermediate certificates should be added to the server OCSP stapling
30225 file named by &%tls_ocsp_file%&.
30226
30227 Note that the proof only covers the terminal server certificate,
30228 not any of the chain from CA to it.
30229
30230 There is no current way to staple a proof for a client certificate.
30231
30232 .code
30233   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30234   OCSP server is supplied.  The server URL may be included in the
30235   server certificate, if the CA is helpful.
30236
30237   One failure mode seen was the OCSP Signer cert expiring before the end
30238   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30239   noted this as invalid overall, but the re-fetch script did not.
30240 .endd
30241 .endlist
30242
30243
30244 .ecindex IIDencsmtp1
30245 .ecindex IIDencsmtp2
30246
30247
30248 .section "TLS Resumption" "SECTresumption"
30249 .cindex TLS resumption
30250 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30251 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30252 (or later).
30253
30254 Session resumption (this is the "stateless" variant) involves the server sending
30255 a "session ticket" to the client on one connection, which can be stored by the
30256 client and used for a later session.  The ticket contains sufficient state for
30257 the server to reconstruct the TLS session, avoiding some expensive crypto
30258 calculation and (on TLS1.2) one full packet roundtrip time.
30259
30260 .ilist
30261 Operational cost/benefit:
30262
30263  The extra data being transmitted costs a minor amount, and the client has
30264  extra costs in storing and retrieving the data.
30265
30266  In the Exim/Gnutls implementation the extra cost on an initial connection
30267  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30268  The saved cost on a subsequent connection is about 4ms; three or more
30269  connections become a net win.  On longer network paths, two or more
30270  connections will have an average lower startup time thanks to the one
30271  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30272  packet roundtrips.
30273
30274 .cindex "hints database" tls
30275  Since a new hints DB is used on the TLS client,
30276  the hints DB maintenance should be updated to additionally handle "tls".
30277
30278 .next
30279 Security aspects:
30280
30281  The session ticket is encrypted, but is obviously an additional security
30282  vulnarability surface.  An attacker able to decrypt it would have access
30283  all connections using the resumed session.
30284  The session ticket encryption key is not committed to storage by the server
30285  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30286  overlap; GnuTLS 6hr but does not specify any overlap).
30287  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30288  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30289
30290  There is a question-mark over the security of the Diffie-Helman parameters
30291  used for session negotiation.
30292
30293 .next
30294 Observability:
30295
30296  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30297  element.
30298
30299  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30300  have bits 0-4 indicating respectively
30301  support built, client requested ticket, client offered session,
30302  server issued ticket, resume used.  A suitable decode list is provided
30303  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30304
30305 .next
30306 Control:
30307
30308 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30309 exim, operating as a server, will offer resumption to clients.
30310 Current best practice is to not offer the feature to MUA connection.
30311 Commonly this can be done like this:
30312 .code
30313 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30314 .endd
30315 If the peer host matches the list after expansion then resumption
30316 is offered and/or accepted.
30317
30318 The &%tls_resumption_hosts%& smtp transport option performs the
30319 equivalent function for operation as a client.
30320 If the peer host matches the list after expansion then resumption
30321 is attempted (if a stored session is available) or the information
30322 stored (if supplied by the peer).
30323
30324
30325 .next
30326 Issues:
30327
30328  In a resumed session:
30329 .ilist
30330   The variables &$tls_{in,out}_cipher$& will have values different
30331  to the original (under GnuTLS).
30332 .next
30333   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30334  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30335 . XXX need to do something with that hosts_require_ocsp
30336 .endlist
30337
30338 .endlist
30339
30340
30341 .section DANE "SECDANE"
30342 .cindex DANE
30343 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30344 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30345 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30346 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30347 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30348 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30349
30350 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30351 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30352 by (a) is thought to be smaller than that of the set of root CAs.
30353
30354 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30355 fail to pass on a server's STARTTLS.
30356
30357 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30358 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30359 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30360
30361 DANE requires a server operator to do three things:
30362 .olist
30363 Run DNSSEC.  This provides assurance to clients
30364 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30365 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30366 DNSSEC.
30367 .next
30368 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30369 .next
30370 Offer a server certificate, or certificate chain, in TLS connections which is anchored by one of the TLSA records.
30371 .endlist
30372
30373 There are no changes to Exim specific to server-side operation of DANE.
30374 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30375 in &_Local/Makefile_&.
30376 If it has been included, the macro "_HAVE_DANE" will be defined.
30377
30378 .subsection "DNS records"
30379 A TLSA record consist of 4 fields, the "Certificate Usage", the
30380 "Selector", the "Matching type", and the "Certificate Association Data".
30381 For a detailed description of the TLSA record see
30382 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30383
30384 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30385 These are the "Trust Anchor" and "End Entity" variants.
30386 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30387 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30388 this is appropriate for a single system, using a self-signed certificate.
30389 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30390 well-known one.
30391 A private CA at simplest is just a self-signed certificate (with certain
30392 attributes) which is used to sign server certificates, but running one securely
30393 does require careful arrangement.
30394 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30395 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30396 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30397 all of which point to a single TLSA record.
30398 DANE-TA and DANE-EE can both be used together.
30399
30400 Our recommendation is to use DANE with a certificate from a public CA,
30401 because this enables a variety of strategies for remote clients to verify
30402 your certificate.
30403 You can then publish information both via DANE and another technology,
30404 "MTA-STS", described below.
30405
30406 When you use DANE-TA to publish trust anchor information, you ask entities
30407 outside your administrative control to trust the Certificate Authority for
30408 connections to you.
30409 If using a private CA then you should expect others to still apply the
30410 technical criteria they'd use for a public CA to your certificates.
30411 In particular, you should probably try to follow current best practices for CA
30412 operation around hash algorithms and key sizes.
30413 Do not expect other organizations to lower their security expectations just
30414 because a particular profile might be reasonable for your own internal use.
30415
30416 When this text was last updated, this in practice means to avoid use of SHA-1
30417 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30418 than 4096, for interoperability); to use keyUsage fields correctly; to use
30419 random serial numbers.
30420 The list of requirements is subject to change as best practices evolve.
30421 If you're not already using a private CA, or it doesn't meet these
30422 requirements, then we encourage you to avoid all these issues and use a public
30423 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30424
30425 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30426 a "Matching Type" (3rd) field of SHA2-512(2).
30427
30428 For the "Certificate Authority Data" (4th) field, commands like
30429
30430 .code
30431   openssl x509 -pubkey -noout <certificate.pem \
30432   | openssl rsa -outform der -pubin 2>/dev/null \
30433   | openssl sha512 \
30434   | awk '{print $2}'
30435 .endd
30436
30437 are workable to create a hash of the certificate's public key.
30438
30439 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30440
30441 .code
30442   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30443 .endd
30444
30445 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30446 is useful for quickly generating TLSA records.
30447
30448
30449 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30450
30451 The Certificate issued by the CA published in the DANE-TA model should be
30452 issued using a strong hash algorithm.
30453 Exim, and importantly various other MTAs sending to you, will not
30454 re-enable hash algorithms which have been disabled by default in TLS
30455 libraries.
30456 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30457 interoperability (and probably the maximum too, in 2018).
30458
30459 .subsection "Interaction with OCSP"
30460 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30461 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30462 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30463
30464 .code
30465   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30466                                  {= {4}{$tls_out_tlsa_usage}} } \
30467                          {*}{}}
30468 .endd
30469
30470 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30471 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30472 found. If the definition of &%hosts_request_ocsp%& includes the
30473 string "tls_out_tlsa_usage", they are re-expanded in time to
30474 control the OCSP request.
30475
30476 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30477 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30478
30479
30480 .subsection "Client configuration"
30481 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30482 and &%dane_require_tls_ciphers%&.
30483 The &"require"& variant will result in failure if the target host is not
30484 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30485 the &%dnssec_request_domains%& router or transport option.
30486
30487 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30488
30489 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30490 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30491 will be required for the host.  If it does not, the host will not
30492 be used; there is no fallback to non-DANE or non-TLS.
30493
30494 If DANE is requested and usable, then the TLS cipher list configuration
30495 prefers to use the option &%dane_require_tls_ciphers%& and falls
30496 back to &%tls_require_ciphers%& only if that is unset.
30497 This lets you configure "decent crypto" for DANE and "better than nothing
30498 crypto" as the default.  Note though that while GnuTLS lets the string control
30499 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30500 limited to ciphersuite constraints.
30501
30502 If DANE is requested and useable (see above) the following transport options are ignored:
30503 .code
30504   hosts_require_tls
30505   tls_verify_hosts
30506   tls_try_verify_hosts
30507   tls_verify_certificates
30508   tls_crl
30509   tls_verify_cert_hostnames
30510   tls_sni
30511 .endd
30512
30513 If DANE is not usable, whether requested or not, and CA-anchored
30514 verification evaluation is wanted, the above variables should be set appropriately.
30515
30516 The router and transport option &%dnssec_request_domains%& must not be
30517 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30518
30519 .subsection Observability
30520 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30521
30522 There is a new variable &$tls_out_dane$& which will have "yes" if
30523 verification succeeded using DANE and "no" otherwise (only useful
30524 in combination with events; see &<<CHAPevents>>&),
30525 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30526
30527 .cindex DANE reporting
30528 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30529 to achieve DANE-verified connection, if one was either requested and offered, or
30530 required.  This is intended to support TLS-reporting as defined in
30531 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30532 The &$event_data$& will be one of the Result Types defined in
30533 Section 4.3 of that document.
30534
30535 .subsection General
30536 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30537
30538 DANE is specified in published RFCs and decouples certificate authority trust
30539 selection from a "race to the bottom" of "you must trust everything for mail
30540 to get through".
30541 There is an alternative technology called MTA-STS, which
30542 instead publishes MX trust anchor information on an HTTPS website.  At the
30543 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30544 Exim has no support for MTA-STS as a client, but Exim mail server operators
30545 can choose to publish information describing their TLS configuration using
30546 MTA-STS to let those clients who do use that protocol derive trust
30547 information.
30548
30549 The MTA-STS design requires a certificate from a public Certificate Authority
30550 which is recognized by clients sending to you.
30551 That selection of which CAs are trusted by others is outside your control.
30552
30553 The most interoperable course of action is probably to use
30554 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30555 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30556 records for DANE clients (such as Exim and Postfix) and to publish anchor
30557 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30558 domain itself (with caveats around occasionally broken MTA-STS because of
30559 incompatible specification changes prior to reaching RFC status).
30560
30561
30562
30563 . ////////////////////////////////////////////////////////////////////////////
30564 . ////////////////////////////////////////////////////////////////////////////
30565
30566 .chapter "Access control lists" "CHAPACL"
30567 .scindex IIDacl "&ACL;" "description"
30568 .cindex "control of incoming mail"
30569 .cindex "message" "controlling incoming"
30570 .cindex "policy control" "access control lists"
30571 Access Control Lists (ACLs) are defined in a separate section of the runtime
30572 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30573 name, terminated by a colon. Here is a complete ACL section that contains just
30574 one very small ACL:
30575 .code
30576 begin acl
30577 small_acl:
30578   accept   hosts = one.host.only
30579 .endd
30580 You can have as many lists as you like in the ACL section, and the order in
30581 which they appear does not matter. The lists are self-terminating.
30582
30583 The majority of ACLs are used to control Exim's behaviour when it receives
30584 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30585 when a local process submits a message using SMTP by specifying the &%-bs%&
30586 option. The most common use is for controlling which recipients are accepted
30587 in incoming messages. In addition, you can define an ACL that is used to check
30588 local non-SMTP messages. The default configuration file contains an example of
30589 a realistic ACL for checking RCPT commands. This is discussed in chapter
30590 &<<CHAPdefconfil>>&.
30591
30592
30593 .section "Testing ACLs" "SECID188"
30594 The &%-bh%& command line option provides a way of testing your ACL
30595 configuration locally by running a fake SMTP session with which you interact.
30596
30597
30598 .section "Specifying when ACLs are used" "SECID189"
30599 .cindex "&ACL;" "options for specifying"
30600 In order to cause an ACL to be used, you have to name it in one of the relevant
30601 options in the main part of the configuration. These options are:
30602 .cindex "AUTH" "ACL for"
30603 .cindex "DATA" "ACLs for"
30604 .cindex "ETRN" "ACL for"
30605 .cindex "EXPN" "ACL for"
30606 .cindex "HELO" "ACL for"
30607 .cindex "EHLO" "ACL for"
30608 .cindex "DKIM" "ACL for"
30609 .cindex "MAIL" "ACL for"
30610 .cindex "QUIT, ACL for"
30611 .cindex "RCPT" "ACL for"
30612 .cindex "STARTTLS, ACL for"
30613 .cindex "VRFY" "ACL for"
30614 .cindex "SMTP" "connection, ACL for"
30615 .cindex "non-SMTP messages" "ACLs for"
30616 .cindex "MIME content scanning" "ACL for"
30617 .cindex "PRDR" "ACL for"
30618
30619 .table2 140pt
30620 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30621 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30622 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30623 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30624 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30625 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30626 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30627 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30628 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30629 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30630 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30631 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30632 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30633 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30634 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30635 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30636 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30637 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30638 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30639 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30640 .endtable
30641
30642 For example, if you set
30643 .code
30644 acl_smtp_rcpt = small_acl
30645 .endd
30646 the little ACL defined above is used whenever Exim receives a RCPT command
30647 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30648 done when RCPT commands arrive. A rejection of RCPT should cause the
30649 sending MTA to give up on the recipient address contained in the RCPT
30650 command, whereas rejection at other times may cause the client MTA to keep on
30651 trying to deliver the message. It is therefore recommended that you do as much
30652 testing as possible at RCPT time.
30653
30654
30655 .subsection "The non-SMTP ACLs" SECID190
30656 .cindex "non-SMTP messages" "ACLs for"
30657 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30658 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30659 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30660 the state of the SMTP connection such as encryption and authentication) are not
30661 relevant and are forbidden in these ACLs. However, the sender and recipients
30662 are known, so the &%senders%& and &%sender_domains%& conditions and the
30663 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30664 &$authenticated_sender$& are also available. You can specify added header lines
30665 in any of these ACLs.
30666
30667 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30668 non-SMTP message, before any of the message has been read. (This is the
30669 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30670 batched SMTP input, it runs after the DATA command has been reached. The
30671 result of this ACL is ignored; it cannot be used to reject a message. If you
30672 really need to, you could set a value in an ACL variable here and reject based
30673 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30674 controls, and in particular, it can be used to set
30675 .code
30676 control = suppress_local_fixups
30677 .endd
30678 This cannot be used in the other non-SMTP ACLs because by the time they are
30679 run, it is too late.
30680
30681 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30682 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30683
30684 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30685 kind of rejection is treated as permanent, because there is no way of sending a
30686 temporary error for these kinds of message.
30687
30688
30689 .subsection "The SMTP connect ACL" SECID191
30690 .cindex "SMTP" "connection, ACL for"
30691 .oindex &%smtp_banner%&
30692 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30693 session, after the test specified by &%host_reject_connection%& (which is now
30694 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30695 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30696 the message override the banner message that is otherwise specified by the
30697 &%smtp_banner%& option.
30698
30699 For tls-on-connect connections, the ACL is run before the TLS connection
30700 is accepted; if the ACL does not accept then the TCP connection is dropped without
30701 any TLS startup attempt and without any SMTP response being transmitted.
30702
30703
30704 .subsection "The EHLO/HELO ACL" SECID192
30705 .cindex "EHLO" "ACL for"
30706 .cindex "HELO" "ACL for"
30707 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30708 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30709 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30710 Note that a client may issue more than one EHLO or HELO command in an SMTP
30711 session, and indeed is required to issue a new EHLO or HELO after successfully
30712 setting up encryption following a STARTTLS command.
30713
30714 Note also that a deny neither forces the client to go away nor means that
30715 mail will be refused on the connection.  Consider checking for
30716 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30717
30718 If the command is accepted by an &%accept%& verb that has a &%message%&
30719 modifier, the message may not contain more than one line (it will be truncated
30720 at the first newline and a panic logged if it does). Such a message cannot
30721 affect the EHLO options that are listed on the second and subsequent lines of
30722 an EHLO response.
30723
30724
30725 .subsection "The DATA ACLs" SECID193
30726 .cindex "DATA" "ACLs for"
30727 Two ACLs are associated with the DATA command, because it is two-stage
30728 command, with two responses being sent to the client.
30729 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30730 is obeyed. This gives you control after all the RCPT commands, but before
30731 the message itself is received. It offers the opportunity to give a negative
30732 response to the DATA command before the data is transmitted. Header lines
30733 added by MAIL or RCPT ACLs are not visible at this time, but any that
30734 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30735
30736 You cannot test the contents of the message, for example, to verify addresses
30737 in the headers, at RCPT time or when the DATA command is received. Such
30738 tests have to appear in the ACL that is run after the message itself has been
30739 received, before the final response to the DATA command is sent. This is
30740 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30741 associated with the DATA command.
30742
30743 .cindex CHUNKING "BDAT command"
30744 .cindex BDAT "SMTP command"
30745 .cindex "RFC 3030" CHUNKING
30746 If CHUNKING was advertised and a BDAT command sequence is received,
30747 the &%acl_smtp_predata%& ACL is not run.
30748 . XXX why not?  It should be possible, for the first BDAT.
30749 The &%acl_smtp_data%& is run after the last BDAT command and all of
30750 the data specified is received.
30751
30752 For both of these ACLs, it is not possible to reject individual recipients. An
30753 error response rejects the entire message. Unfortunately, it is known that some
30754 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30755 before or after the data) correctly &-- they keep the message on their queues
30756 and try again later, but that is their problem, though it does waste some of
30757 your resources.
30758
30759 The &%acl_smtp_data%& ACL is run after
30760 the &%acl_smtp_data_prdr%&,
30761 the &%acl_smtp_dkim%&
30762 and the &%acl_smtp_mime%& ACLs.
30763
30764 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30765 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30766 enabled (which is the default).
30767
30768 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30769 received, and is executed for each DKIM signature found in a message.  If not
30770 otherwise specified, the default action is to accept.
30771
30772 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30773
30774 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30775
30776
30777 .subsection "The SMTP MIME ACL" SECID194
30778 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30779 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30780
30781 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30782
30783
30784 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30785 .cindex "PRDR" "ACL for"
30786 .oindex "&%prdr_enable%&"
30787 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30788 with PRDR support enabled (which is the default).
30789 It becomes active only when the PRDR feature is negotiated between
30790 client and server for a message, and more than one recipient
30791 has been accepted.
30792
30793 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30794 has been received, and is executed once for each recipient of the message
30795 with &$local_part$& and &$domain$& valid.
30796 The test may accept, defer or deny for individual recipients.
30797 The &%acl_smtp_data%& will still be called after this ACL and
30798 can reject the message overall, even if this ACL has accepted it
30799 for some or all recipients.
30800
30801 PRDR may be used to support per-user content filtering.  Without it
30802 one must defer any recipient after the first that has a different
30803 content-filter configuration.  With PRDR, the RCPT-time check
30804 .cindex "PRDR" "variable for"
30805 for this can be disabled when the variable &$prdr_requested$&
30806 is &"yes"&.
30807 Any required difference in behaviour of the main DATA-time
30808 ACL should however depend on the PRDR-time ACL having run, as Exim
30809 will avoid doing so in some situations (e.g. single-recipient mails).
30810
30811 See also the &%prdr_enable%& global option
30812 and the &%hosts_try_prdr%& smtp transport option.
30813
30814 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30815 If the ACL is not defined, processing completes as if
30816 the feature was not requested by the client.
30817
30818 .subsection "The QUIT ACL" SECTQUITACL
30819 .cindex "QUIT, ACL for"
30820 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30821 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30822 does not in fact control any access.
30823 For this reason, it may only accept
30824 or warn as its final result.
30825
30826 This ACL can be used for tasks such as custom logging at the end of an SMTP
30827 session. For example, you can use ACL variables in other ACLs to count
30828 messages, recipients, etc., and log the totals at QUIT time using one or
30829 more &%logwrite%& modifiers on a &%warn%& verb.
30830
30831 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30832 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30833
30834 You do not need to have a final &%accept%&, but if you do, you can use a
30835 &%message%& modifier to specify custom text that is sent as part of the 221
30836 response to QUIT.
30837
30838 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30839 failure (for example, failure to open a log file, or when Exim is bombing out
30840 because it has detected an unrecoverable error), all SMTP commands from the
30841 client are given temporary error responses until QUIT is received or the
30842 connection is closed. In these special cases, the QUIT ACL does not run.
30843
30844
30845 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30846 .vindex &$acl_smtp_notquit$&
30847 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30848 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30849 trouble, such as being unable to write to its log files, this ACL is not run,
30850 because it might try to do things (such as write to log files) that make the
30851 situation even worse.
30852
30853 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30854 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30855 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30856 and &%warn%&.
30857
30858 .vindex &$smtp_notquit_reason$&
30859 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30860 to a string that indicates the reason for the termination of the SMTP
30861 connection. The possible values are:
30862 .table2
30863 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30864 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30865 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30866 .irow &`connection-lost`&          "The SMTP connection has been lost"
30867 .irow &`data-timeout`&             "Timeout while reading message data"
30868 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30869 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30870 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30871 .irow &`synchronization-error`&    "SMTP synchronization error"
30872 .irow &`tls-failed`&               "TLS failed to start"
30873 .endtable
30874 In most cases when an SMTP connection is closed without having received QUIT,
30875 Exim sends an SMTP response message before actually closing the connection.
30876 With the exception of the &`acl-drop`& case, the default message can be
30877 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30878 &%drop%& verb in another ACL, it is the message from the other ACL that is
30879 used.
30880
30881
30882 .section "Finding an ACL to use" "SECID195"
30883 .cindex "&ACL;" "finding which to use"
30884 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30885 you can use different ACLs in different circumstances. For example,
30886 .code
30887 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30888                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30889 .endd
30890 In the default configuration file there are some example settings for
30891 providing an RFC 4409 message &"submission"& service on port 587 and
30892 an RFC 8314 &"submissions"& service on port 465. You can use a string
30893 expansion like this to choose an ACL for MUAs on these ports which is
30894 more appropriate for this purpose than the default ACL on port 25.
30895
30896 The expanded string does not have to be the name of an ACL in the
30897 configuration file; there are other possibilities. Having expanded the
30898 string, Exim searches for an ACL as follows:
30899
30900 .ilist
30901 If the string begins with a slash, Exim uses it as a filename, and reads its
30902 contents as an ACL. The lines are processed in the same way as lines in the
30903 Exim configuration file. In particular, continuation lines are supported, blank
30904 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30905 If the file does not exist or cannot be read, an error occurs (typically
30906 causing a temporary failure of whatever caused the ACL to be run). For example:
30907 .code
30908 acl_smtp_data = /etc/acls/\
30909   ${lookup{$sender_host_address}lsearch\
30910   {/etc/acllist}{$value}{default}}
30911 .endd
30912 This looks up an ACL file to use on the basis of the host's IP address, falling
30913 back to a default if the lookup fails. If an ACL is successfully read from a
30914 file, it is retained in memory for the duration of the Exim process, so that it
30915 can be re-used without having to re-read the file.
30916 .next
30917 If the string does not start with a slash, and does not contain any spaces,
30918 Exim searches the ACL section of the configuration for an ACL whose name
30919 matches the string.
30920 .next
30921 If no named ACL is found, or if the string contains spaces, Exim parses
30922 the string as an inline ACL. This can save typing in cases where you just
30923 want to have something like
30924 .code
30925 acl_smtp_vrfy = accept
30926 .endd
30927 in order to allow free use of the VRFY command. Such a string may contain
30928 newlines; it is processed in the same way as an ACL that is read from a file.
30929 .endlist
30930
30931
30932
30933
30934 .section "ACL return codes" "SECID196"
30935 .cindex "&ACL;" "return codes"
30936 Except for the QUIT ACL, which does not affect the SMTP return code (see
30937 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30938 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30939 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30940 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30941 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30942 This also causes a 4&'xx'& return code.
30943
30944 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30945 &"deny"&, because there is no mechanism for passing temporary errors to the
30946 submitters of non-SMTP messages.
30947
30948
30949 ACLs that are relevant to message reception may also return &"discard"&. This
30950 has the effect of &"accept"&, but causes either the entire message or an
30951 individual recipient address to be discarded. In other words, it is a
30952 blackholing facility. Use it with care.
30953
30954 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30955 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30956 RCPT ACL is to discard just the one recipient address. If there are no
30957 recipients left when the message's data is received, the DATA ACL is not
30958 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30959 remaining recipients. The &"discard"& return is not permitted for the
30960 &%acl_smtp_predata%& ACL.
30961
30962 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30963 is done on the address and the result determines the SMTP response.
30964
30965
30966 .cindex "&[local_scan()]& function" "when all recipients discarded"
30967 The &[local_scan()]& function is always run, even if there are no remaining
30968 recipients; it may create new recipients.
30969
30970
30971
30972 .section "Unset ACL options" "SECID197"
30973 .cindex "&ACL;" "unset options"
30974 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30975 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30976 not defined at all. For any defined ACL, the default action when control
30977 reaches the end of the ACL statements is &"deny"&.
30978
30979 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30980 these two are ACLs that are used only for their side effects. They cannot be
30981 used to accept or reject anything.
30982
30983 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30984 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30985 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30986 when the ACL is not defined is &"accept"&.
30987
30988 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30989 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30990 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30991 messages over an SMTP connection. For an example, see the ACL in the default
30992 configuration file.
30993
30994
30995
30996
30997 .section "Data for message ACLs" "SECID198"
30998 .cindex "&ACL;" "data for message ACL"
30999 .vindex &$domain$&
31000 .vindex &$local_part$&
31001 .vindex &$sender_address$&
31002 .vindex &$sender_host_address$&
31003 .vindex &$smtp_command$&
31004 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
31005 that contain information about the host and the message's sender (for example,
31006 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
31007 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
31008 &$local_part$& are set from the argument address. The entire SMTP command
31009 is available in &$smtp_command$&.
31010
31011 When an ACL for the AUTH parameter of MAIL is running, the variables that
31012 contain information about the host are set, but &$sender_address$& is not yet
31013 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
31014 how it is used.
31015
31016 .vindex "&$message_size$&"
31017 The &$message_size$& variable is set to the value of the SIZE parameter on
31018 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
31019 that parameter is not given. The value is updated to the true message size by
31020 the time the final DATA ACL is run (after the message data has been
31021 received).
31022
31023 .vindex "&$rcpt_count$&"
31024 .vindex "&$recipients_count$&"
31025 The &$rcpt_count$& variable increases by one for each RCPT command received.
31026 The &$recipients_count$& variable increases by one each time a RCPT command is
31027 accepted, so while an ACL for RCPT is being processed, it contains the number
31028 of previously accepted recipients. At DATA time (for both the DATA ACLs),
31029 &$rcpt_count$& contains the total number of RCPT commands, and
31030 &$recipients_count$& contains the total number of accepted recipients.
31031
31032
31033
31034
31035
31036 .section "Data for non-message ACLs" "SECTdatfornon"
31037 .cindex "&ACL;" "data for non-message ACL"
31038 .vindex &$smtp_command_argument$&
31039 .vindex &$smtp_command$&
31040 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
31041 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
31042 and the entire SMTP command is available in &$smtp_command$&.
31043 These variables can be tested using a &%condition%& condition. For example,
31044 here is an ACL for use with AUTH, which insists that either the session is
31045 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
31046 does not permit authentication methods that use cleartext passwords on
31047 unencrypted connections.
31048 .code
31049 acl_check_auth:
31050   accept encrypted = *
31051   accept condition = ${if eq{${uc:$smtp_command_argument}}\
31052                      {CRAM-MD5}}
31053   deny   message   = TLS encryption or CRAM-MD5 required
31054 .endd
31055 (Another way of applying this restriction is to arrange for the authenticators
31056 that use cleartext passwords not to be advertised when the connection is not
31057 encrypted. You can use the generic &%server_advertise_condition%& authenticator
31058 option to do this.)
31059
31060
31061
31062 .section "Format of an ACL" "SECID199"
31063 .cindex "&ACL;" "format of"
31064 .cindex "&ACL;" "verbs, definition of"
31065 An individual ACL consists of a number of statements. Each statement starts
31066 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31067 Modifiers can change the way the verb operates, define error and log messages,
31068 set variables, insert delays, and vary the processing of accepted messages.
31069
31070 If all the conditions are met, the verb is obeyed. The same condition may be
31071 used (with different arguments) more than once in the same statement. This
31072 provides a means of specifying an &"and"& conjunction between conditions. For
31073 example:
31074 .code
31075 deny  dnslists = list1.example
31076       dnslists = list2.example
31077 .endd
31078 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31079 the conditions and modifiers when it reaches a condition that fails. What
31080 happens then depends on the verb (and in one case, on a special modifier). Not
31081 all the conditions make sense at every testing point. For example, you cannot
31082 test a sender address in the ACL that is run for a VRFY command.
31083
31084
31085 .section "ACL verbs" "SECID200"
31086 The ACL verbs are as follows:
31087
31088 .ilist
31089 .cindex "&%accept%& ACL verb"
31090 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31091 of the conditions are not met, what happens depends on whether &%endpass%&
31092 appears among the conditions (for syntax see below). If the failing condition
31093 is before &%endpass%&, control is passed to the next ACL statement; if it is
31094 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31095 check a RCPT command:
31096 .code
31097 accept domains = +local_domains
31098        endpass
31099        verify = recipient
31100 .endd
31101 If the recipient domain does not match the &%domains%& condition, control
31102 passes to the next statement. If it does match, the recipient is verified, and
31103 the command is accepted if verification succeeds. However, if verification
31104 fails, the ACL yields &"deny"&, because the failing condition is after
31105 &%endpass%&.
31106
31107 The &%endpass%& feature has turned out to be confusing to many people, so its
31108 use is not recommended nowadays. It is always possible to rewrite an ACL so
31109 that &%endpass%& is not needed, and it is no longer used in the default
31110 configuration.
31111
31112 .cindex "&%message%& ACL modifier" "with &%accept%&"
31113 If a &%message%& modifier appears on an &%accept%& statement, its action
31114 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31115 (when an &%accept%& verb either accepts or passes control to the next
31116 statement), &%message%& can be used to vary the message that is sent when an
31117 SMTP command is accepted. For example, in a RCPT ACL you could have:
31118 .display
31119 &`accept  `&<&'some conditions'&>
31120 &`        message = OK, I will allow you through today`&
31121 .endd
31122 You can specify an SMTP response code, optionally followed by an &"extended
31123 response code"& at the start of the message, but the first digit must be the
31124 same as would be sent by default, which is 2 for an &%accept%& verb.
31125
31126 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31127 an error message that is used when access is denied. This behaviour is retained
31128 for backward compatibility, but current &"best practice"& is to avoid the use
31129 of &%endpass%&.
31130
31131
31132 .next
31133 .cindex "&%defer%& ACL verb"
31134 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31135 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31136 &%defer%& is the same as &%deny%&, because there is no way of sending a
31137 temporary error. For a RCPT command, &%defer%& is much the same as using a
31138 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31139 be used in any ACL, and even for a recipient it might be a simpler approach.
31140
31141
31142 .next
31143 .cindex "&%deny%& ACL verb"
31144 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31145 the conditions are not met, control is passed to the next ACL statement. For
31146 example,
31147 .code
31148 deny dnslists = blackholes.mail-abuse.org
31149 .endd
31150 rejects commands from hosts that are on a DNS black list.
31151
31152
31153 .next
31154 .cindex "&%discard%& ACL verb"
31155 &%discard%&: This verb behaves like &%accept%&, except that it returns
31156 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31157 that are concerned with receiving messages. When all the conditions are true,
31158 the sending entity receives a &"success"& response. However, &%discard%& causes
31159 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31160 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31161 message's recipients are discarded. Recipients that are discarded before DATA
31162 do not appear in the log line when the &%received_recipients%& log selector is set.
31163
31164 If the &%log_message%& modifier is set when &%discard%& operates,
31165 its contents are added to the line that is automatically written to the log.
31166 The &%message%& modifier operates exactly as it does for &%accept%&.
31167
31168
31169 .next
31170 .cindex "&%drop%& ACL verb"
31171 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31172 forcibly closed after the 5&'xx'& error message has been sent. For example:
31173 .code
31174 drop   condition = ${if > {$rcpt_count}{20}}
31175        message   = I don't take more than 20 RCPTs
31176 .endd
31177 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31178 The connection is always dropped after sending a 550 response.
31179
31180 .next
31181 .cindex "&%require%& ACL verb"
31182 &%require%&: If all the conditions are met, control is passed to the next ACL
31183 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31184 example, when checking a RCPT command,
31185 .code
31186 require message = Sender did not verify
31187         verify  = sender
31188 .endd
31189 passes control to subsequent statements only if the message's sender can be
31190 verified. Otherwise, it rejects the command. Note the positioning of the
31191 &%message%& modifier, before the &%verify%& condition. The reason for this is
31192 discussed in section &<<SECTcondmodproc>>&.
31193
31194 .next
31195 .cindex "&%warn%& ACL verb"
31196 &%warn%&: If all the conditions are true, a line specified by the
31197 &%log_message%& modifier is written to Exim's main log. Control always passes
31198 to the next ACL statement. If any condition is false, the log line is not
31199 written. If an identical log line is requested several times in the same
31200 message, only one copy is actually written to the log. If you want to force
31201 duplicates to be written, use the &%logwrite%& modifier instead.
31202
31203 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31204 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31205 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31206 first failing condition. There is more about adding header lines in section
31207 &<<SECTaddheadacl>>&.
31208
31209 If any condition on a &%warn%& statement cannot be completed (that is, there is
31210 some sort of defer), the log line specified by &%log_message%& is not written.
31211 This does not include the case of a forced failure from a lookup, which
31212 is considered to be a successful completion. After a defer, no further
31213 conditions or modifiers in the &%warn%& statement are processed. The incident
31214 is logged, and the ACL continues to be processed, from the next statement
31215 onwards.
31216
31217
31218 .vindex "&$acl_verify_message$&"
31219 When one of the &%warn%& conditions is an address verification that fails, the
31220 text of the verification failure message is in &$acl_verify_message$&. If you
31221 want this logged, you must set it up explicitly. For example:
31222 .code
31223 warn   !verify = sender
31224        log_message = sender verify failed: $acl_verify_message
31225 .endd
31226 .endlist
31227
31228 At the end of each ACL there is an implicit unconditional &%deny%&.
31229
31230 As you can see from the examples above, the conditions and modifiers are
31231 written one to a line, with the first one on the same line as the verb, and
31232 subsequent ones on following lines. If you have a very long condition, you can
31233 continue it onto several physical lines by the usual backslash continuation
31234 mechanism. It is conventional to align the conditions vertically.
31235
31236
31237
31238 .section "ACL variables" "SECTaclvariables"
31239 .cindex "&ACL;" "variables"
31240 There are some special variables that can be set during ACL processing. They
31241 can be used to pass information between different ACLs, different invocations
31242 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31243 transports, and filters that are used to deliver a message. The names of these
31244 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31245 an underscore, but the remainder of the name can be any sequence of
31246 alphanumeric characters and underscores that you choose. There is no limit on
31247 the number of ACL variables. The two sets act as follows:
31248 .ilist
31249 The values of those variables whose names begin with &$acl_c$& persist
31250 throughout an SMTP connection. They are never reset. Thus, a value that is set
31251 while receiving one message is still available when receiving the next message
31252 on the same SMTP connection.
31253 .next
31254 The values of those variables whose names begin with &$acl_m$& persist only
31255 while a message is being received. They are reset afterwards. They are also
31256 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31257 .endlist
31258
31259 When a message is accepted, the current values of all the ACL variables are
31260 preserved with the message and are subsequently made available at delivery
31261 time. The ACL variables are set by a modifier called &%set%&. For example:
31262 .code
31263 accept hosts = whatever
31264        set acl_m4 = some value
31265 accept authenticated = *
31266        set acl_c_auth = yes
31267 .endd
31268 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31269 be set. If you want to set a variable without taking any action, you can use a
31270 &%warn%& verb without any other modifiers or conditions.
31271
31272 .oindex &%strict_acl_vars%&
31273 What happens if a syntactically valid but undefined ACL variable is
31274 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31275 false (the default), an empty string is substituted; if it is true, an
31276 error is generated.
31277
31278 Versions of Exim before 4.64 have a limited set of numbered variables, but
31279 their names are compatible, so there is no problem with upgrading.
31280
31281
31282 .section "Condition and modifier processing" "SECTcondmodproc"
31283 .cindex "&ACL;" "conditions; processing"
31284 .cindex "&ACL;" "modifiers; processing"
31285 An exclamation mark preceding a condition negates its result. For example:
31286 .code
31287 deny   domains = *.dom.example
31288       !verify  = recipient
31289 .endd
31290 causes the ACL to return &"deny"& if the recipient domain ends in
31291 &'dom.example'& and the recipient address cannot be verified. Sometimes
31292 negation can be used on the right-hand side of a condition. For example, these
31293 two statements are equivalent:
31294 .code
31295 deny  hosts = !192.168.3.4
31296 deny !hosts =  192.168.3.4
31297 .endd
31298 However, for many conditions (&%verify%& being a good example), only left-hand
31299 side negation of the whole condition is possible.
31300
31301 The arguments of conditions and modifiers are expanded. A forced failure
31302 of an expansion causes a condition to be ignored, that is, it behaves as if the
31303 condition is true. Consider these two statements:
31304 .code
31305 accept  senders = ${lookup{$host_name}lsearch\
31306                   {/some/file}{$value}fail}
31307 accept  senders = ${lookup{$host_name}lsearch\
31308                   {/some/file}{$value}{}}
31309 .endd
31310 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31311 the returned list is searched, but if the lookup fails the behaviour is
31312 different in the two cases. The &%fail%& in the first statement causes the
31313 condition to be ignored, leaving no further conditions. The &%accept%& verb
31314 therefore succeeds. The second statement, however, generates an empty list when
31315 the lookup fails. No sender can match an empty list, so the condition fails,
31316 and therefore the &%accept%& also fails.
31317
31318 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31319 specify actions that are taken as the conditions for a statement are checked;
31320 others specify text for messages that are used when access is denied or a
31321 warning is generated. The &%control%& modifier affects the way an incoming
31322 message is handled.
31323
31324 The positioning of the modifiers in an ACL statement is important, because the
31325 processing of a verb ceases as soon as its outcome is known. Only those
31326 modifiers that have already been encountered will take effect. For example,
31327 consider this use of the &%message%& modifier:
31328 .code
31329 require message = Can't verify sender
31330         verify  = sender
31331         message = Can't verify recipient
31332         verify  = recipient
31333         message = This message cannot be used
31334 .endd
31335 If sender verification fails, Exim knows that the result of the statement is
31336 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31337 so its text is used as the error message. If sender verification succeeds, but
31338 recipient verification fails, the second message is used. If recipient
31339 verification succeeds, the third message becomes &"current"&, but is never used
31340 because there are no more conditions to cause failure.
31341
31342 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31343 modifier that is used, because all the conditions must be true for rejection to
31344 happen. Specifying more than one &%message%& modifier does not make sense, and
31345 the message can even be specified after all the conditions. For example:
31346 .code
31347 deny   hosts = ...
31348       !senders = *@my.domain.example
31349        message = Invalid sender from client host
31350 .endd
31351 The &"deny"& result does not happen until the end of the statement is reached,
31352 by which time Exim has set up the message.
31353
31354
31355
31356 .section "ACL modifiers" "SECTACLmodi"
31357 .cindex "&ACL;" "modifiers; list of"
31358 The ACL modifiers are as follows:
31359
31360 .vlist
31361 .vitem &*add_header*&&~=&~<&'text'&>
31362 This modifier specifies one or more header lines that are to be added to an
31363 incoming message, assuming, of course, that the message is ultimately
31364 accepted. For details, see section &<<SECTaddheadacl>>&.
31365
31366 .vitem &*continue*&&~=&~<&'text'&>
31367 .cindex "&%continue%& ACL modifier"
31368 .cindex "database" "updating in ACL"
31369 This modifier does nothing of itself, and processing of the ACL always
31370 continues with the next condition or modifier. The value of &%continue%& is in
31371 the side effects of expanding its argument. Typically this could be used to
31372 update a database. It is really just a syntactic tidiness, to avoid having to
31373 write rather ugly lines like this:
31374 .display
31375 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31376 .endd
31377 Instead, all you need is
31378 .display
31379 &`continue = `&<&'some expansion'&>
31380 .endd
31381
31382 .vitem &*control*&&~=&~<&'text'&>
31383 .cindex "&%control%& ACL modifier"
31384 This modifier affects the subsequent processing of the SMTP connection or of an
31385 incoming message that is accepted. The effect of the first type of control
31386 lasts for the duration of the connection, whereas the effect of the second type
31387 lasts only until the current message has been received. The message-specific
31388 controls always apply to the whole message, not to individual recipients,
31389 even if the &%control%& modifier appears in a RCPT ACL.
31390
31391 As there are now quite a few controls that can be applied, they are described
31392 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31393 in several different ways. For example:
31394
31395 . ==== As this is a nested list, any displays it contains must be indented
31396 . ==== as otherwise they are too far to the left. That comment applies only
31397 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31398 . ==== way.
31399
31400 .ilist
31401 It can be at the end of an &%accept%& statement:
31402 .code
31403     accept  ...some conditions
31404             control = queue
31405 .endd
31406 In this case, the control is applied when this statement yields &"accept"&, in
31407 other words, when the conditions are all true.
31408
31409 .next
31410 It can be in the middle of an &%accept%& statement:
31411 .code
31412     accept  ...some conditions...
31413             control = queue
31414             ...some more conditions...
31415 .endd
31416 If the first set of conditions are true, the control is applied, even if the
31417 statement does not accept because one of the second set of conditions is false.
31418 In this case, some subsequent statement must yield &"accept"& for the control
31419 to be relevant.
31420
31421 .next
31422 It can be used with &%warn%& to apply the control, leaving the
31423 decision about accepting or denying to a subsequent verb. For
31424 example:
31425 .code
31426     warn    ...some conditions...
31427             control = freeze
31428     accept  ...
31429 .endd
31430 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31431 &%logwrite%&, so it does not add anything to the message and does not write a
31432 log entry.
31433
31434 .next
31435 If you want to apply a control unconditionally, you can use it with a
31436 &%require%& verb. For example:
31437 .code
31438     require  control = no_multiline_responses
31439 .endd
31440 .endlist
31441
31442 .vitem &*delay*&&~=&~<&'time'&>
31443 .cindex "&%delay%& ACL modifier"
31444 .oindex "&%-bh%&"
31445 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31446 the time interval before proceeding. However, when testing Exim using the
31447 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31448 output instead). The time is given in the usual Exim notation, and the delay
31449 happens as soon as the modifier is processed. In an SMTP session, pending
31450 output is flushed before the delay is imposed.
31451
31452 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31453 example:
31454 .code
31455 deny    ...some conditions...
31456         delay = 30s
31457 .endd
31458 The delay happens if all the conditions are true, before the statement returns
31459 &"deny"&. Compare this with:
31460 .code
31461 deny    delay = 30s
31462         ...some conditions...
31463 .endd
31464 which waits for 30s before processing the conditions. The &%delay%& modifier
31465 can also be used with &%warn%& and together with &%control%&:
31466 .code
31467 warn    ...some conditions...
31468         delay = 2m
31469         control = freeze
31470 accept  ...
31471 .endd
31472
31473 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31474 responses to several commands are no longer buffered and sent in one packet (as
31475 they would normally be) because all output is flushed before imposing the
31476 delay. This optimization is disabled so that a number of small delays do not
31477 appear to the client as one large aggregated delay that might provoke an
31478 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31479 using a &%control%& modifier to set &%no_delay_flush%&.
31480
31481
31482 .vitem &*endpass*&
31483 .cindex "&%endpass%& ACL modifier"
31484 This modifier, which has no argument, is recognized only in &%accept%& and
31485 &%discard%& statements. It marks the boundary between the conditions whose
31486 failure causes control to pass to the next statement, and the conditions whose
31487 failure causes the ACL to return &"deny"&. This concept has proved to be
31488 confusing to some people, so the use of &%endpass%& is no longer recommended as
31489 &"best practice"&. See the description of &%accept%& above for more details.
31490
31491
31492 .vitem &*log_message*&&~=&~<&'text'&>
31493 .cindex "&%log_message%& ACL modifier"
31494 This modifier sets up a message that is used as part of the log message if the
31495 ACL denies access or a &%warn%& statement's conditions are true. For example:
31496 .code
31497 require log_message = wrong cipher suite $tls_in_cipher
31498         encrypted   = DES-CBC3-SHA
31499 .endd
31500 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31501 example:
31502 .display
31503 &`discard `&<&'some conditions'&>
31504 &`        log_message = Discarded $local_part@$domain because...`&
31505 .endd
31506 When access is denied, &%log_message%& adds to any underlying error message
31507 that may exist because of a condition failure. For example, while verifying a
31508 recipient address, a &':fail:'& redirection might have already set up a
31509 message.
31510
31511 The message may be defined before the conditions to which it applies, because
31512 the string expansion does not happen until Exim decides that access is to be
31513 denied. This means that any variables that are set by the condition are
31514 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31515 variables are set after a DNS black list lookup succeeds. If the expansion of
31516 &%log_message%& fails, or if the result is an empty string, the modifier is
31517 ignored.
31518
31519 .vindex "&$acl_verify_message$&"
31520 If you want to use a &%warn%& statement to log the result of an address
31521 verification, you can use &$acl_verify_message$& to include the verification
31522 error message.
31523
31524 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31525 the start of the logged message. If the same warning log message is requested
31526 more than once while receiving  a single email message, only one copy is
31527 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31528 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31529 is logged for a successful &%warn%& statement.
31530
31531 If &%log_message%& is not present and there is no underlying error message (for
31532 example, from the failure of address verification), but &%message%& is present,
31533 the &%message%& text is used for logging rejections. However, if any text for
31534 logging contains newlines, only the first line is logged. In the absence of
31535 both &%log_message%& and &%message%&, a default built-in message is used for
31536 logging rejections.
31537
31538
31539 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31540 .cindex "&%log_reject_target%& ACL modifier"
31541 .cindex "logging in ACL" "specifying which log"
31542 This modifier makes it possible to specify which logs are used for messages
31543 about ACL rejections. Its argument is a colon-separated list of words that can
31544 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31545 may be empty, in which case a rejection is not logged at all. For example, this
31546 ACL fragment writes no logging information when access is denied:
31547 .display
31548 &`deny `&<&'some conditions'&>
31549 &`     log_reject_target =`&
31550 .endd
31551 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31552 permanent and temporary rejections. Its effect lasts for the rest of the
31553 current ACL.
31554
31555
31556 .vitem &*logwrite*&&~=&~<&'text'&>
31557 .cindex "&%logwrite%& ACL modifier"
31558 .cindex "logging in ACL" "immediate"
31559 This modifier writes a message to a log file as soon as it is encountered when
31560 processing an ACL. (Compare &%log_message%&, which, except in the case of
31561 &%warn%& and &%discard%&, is used only if the ACL statement denies
31562 access.) The &%logwrite%& modifier can be used to log special incidents in
31563 ACLs. For example:
31564 .display
31565 &`accept `&<&'some special conditions'&>
31566 &`       control  = freeze`&
31567 &`       logwrite = froze message because ...`&
31568 .endd
31569 By default, the message is written to the main log. However, it may begin
31570 with a colon, followed by a comma-separated list of log names, and then
31571 another colon, to specify exactly which logs are to be written. For
31572 example:
31573 .code
31574 logwrite = :main,reject: text for main and reject logs
31575 logwrite = :panic: text for panic log only
31576 .endd
31577
31578
31579 .vitem &*message*&&~=&~<&'text'&>
31580 .cindex "&%message%& ACL modifier"
31581 This modifier sets up a text string that is expanded and used as a response
31582 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31583 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31584 there is some complication if &%endpass%& is involved; see the description of
31585 &%accept%& for details.)
31586
31587 The expansion of the message happens at the time Exim decides that the ACL is
31588 to end, not at the time it processes &%message%&. If the expansion fails, or
31589 generates an empty string, the modifier is ignored. Here is an example where
31590 &%message%& must be specified first, because the ACL ends with a rejection if
31591 the &%hosts%& condition fails:
31592 .code
31593 require  message = Host not recognized
31594          hosts = 10.0.0.0/8
31595 .endd
31596 (Once a condition has failed, no further conditions or modifiers are
31597 processed.)
31598
31599 .cindex "SMTP" "error codes"
31600 .oindex "&%smtp_banner%&
31601 For ACLs that are triggered by SMTP commands, the message is returned as part
31602 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31603 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31604 is accepted. In the case of the connect ACL, accepting with a message modifier
31605 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31606 accept message may not contain more than one line (otherwise it will be
31607 truncated at the first newline and a panic logged), and it cannot affect the
31608 EHLO options.
31609
31610 When SMTP is involved, the message may begin with an overriding response code,
31611 consisting of three digits optionally followed by an &"extended response code"&
31612 of the form &'n.n.n'&, each code being followed by a space. For example:
31613 .code
31614 deny  message = 599 1.2.3 Host not welcome
31615       hosts = 192.168.34.0/24
31616 .endd
31617 The first digit of the supplied response code must be the same as would be sent
31618 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31619 access, but for the predata ACL, note that the default success code is 354, not
31620 2&'xx'&.
31621
31622 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31623 the message modifier cannot override the 221 response code.
31624
31625 The text in a &%message%& modifier is literal; any quotes are taken as
31626 literals, but because the string is expanded, backslash escapes are processed
31627 anyway.
31628 If the message contains newlines, this gives rise to a multi-line SMTP
31629 response.
31630 A long message line will also be split into multi-line SMTP responses,
31631 on word boundaries if possible.
31632
31633 .vindex "&$acl_verify_message$&"
31634 While the text is being expanded, the &$acl_verify_message$& variable
31635 contains any message previously set.
31636 Afterwards, &$acl_verify_message$& is cleared.
31637
31638 If &%message%& is used on a statement that verifies an address, the message
31639 specified overrides any message that is generated by the verification process.
31640 However, the original message is available in the variable
31641 &$acl_verify_message$&, so you can incorporate it into your message if you
31642 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31643 routers to be passed back as part of the SMTP response, you should either not
31644 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31645
31646 For compatibility with previous releases of Exim, a &%message%& modifier that
31647 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31648 modifier, but this usage is now deprecated. However, &%message%& acts only when
31649 all the conditions are true, wherever it appears in an ACL command, whereas
31650 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31651 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31652 effect.
31653
31654
31655 .vitem &*queue*&&~=&~<&'text'&>
31656 .cindex "&%queue%& ACL modifier"
31657 .cindex "named queues" "selecting in ACL"
31658 This modifier specifies the use of a named queue for spool files
31659 for the message.
31660 It can only be used before the message is received (i.e. not in
31661 the DATA ACL).
31662 This could be used, for example, for known high-volume burst sources
31663 of traffic, or for quarantine of messages.
31664 Separate queue-runner processes will be needed for named queues.
31665 If the text after expansion is empty, the default queue is used.
31666
31667
31668 .vitem &*remove_header*&&~=&~<&'text'&>
31669 This modifier specifies one or more header names in a colon-separated list
31670  that are to be removed from an incoming message, assuming, of course, that
31671 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31672
31673
31674 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31675 .cindex "&%set%& ACL modifier"
31676 This modifier puts a value into one of the ACL variables (see section
31677 &<<SECTaclvariables>>&).
31678
31679
31680 .vitem &*udpsend*&&~=&~<&'parameters'&>
31681 .cindex "UDP communications"
31682 This modifier sends a UDP packet, for purposes such as statistics
31683 collection or behaviour monitoring. The parameters are expanded, and
31684 the result of the expansion must be a colon-separated list consisting
31685 of a destination server, port number, and the packet contents. The
31686 server can be specified as a host name or IPv4 or IPv6 address. The
31687 separator can be changed with the usual angle bracket syntax. For
31688 example, you might want to collect information on which hosts connect
31689 when:
31690 .code
31691 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31692              $tod_zulu $sender_host_address
31693 .endd
31694 .endlist
31695
31696
31697
31698
31699 .section "Use of the control modifier" "SECTcontrols"
31700 .cindex "&%control%& ACL modifier"
31701 The &%control%& modifier supports the following settings:
31702
31703 .vlist
31704 .vitem &*control&~=&~allow_auth_unadvertised*&
31705 This modifier allows a client host to use the SMTP AUTH command even when it
31706 has not been advertised in response to EHLO. Furthermore, because there are
31707 apparently some really broken clients that do this, Exim will accept AUTH after
31708 HELO (rather than EHLO) when this control is set. It should be used only if you
31709 really need it, and you should limit its use to those broken clients that do
31710 not work without it. For example:
31711 .code
31712 warn hosts   = 192.168.34.25
31713      control = allow_auth_unadvertised
31714 .endd
31715 Normally, when an Exim server receives an AUTH command, it checks the name of
31716 the authentication mechanism that is given in the command to ensure that it
31717 matches an advertised mechanism. When this control is set, the check that a
31718 mechanism has been advertised is bypassed. Any configured mechanism can be used
31719 by the client. This control is permitted only in the connection and HELO ACLs.
31720
31721
31722 .vitem &*control&~=&~caseful_local_part*& &&&
31723        &*control&~=&~caselower_local_part*&
31724 .cindex "&ACL;" "case of local part in"
31725 .cindex "case of local parts"
31726 .vindex "&$local_part$&"
31727 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31728 (that is, during RCPT processing). By default, the contents of &$local_part$&
31729 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31730 any uppercase letters in the original local part are restored in &$local_part$&
31731 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31732 is encountered.
31733
31734 These controls affect only the current recipient. Moreover, they apply only to
31735 local part handling that takes place directly in the ACL (for example, as a key
31736 in lookups). If a test to verify the recipient is obeyed, the case-related
31737 handling of the local part during the verification is controlled by the router
31738 configuration (see the &%caseful_local_part%& generic router option).
31739
31740 This facility could be used, for example, to add a spam score to local parts
31741 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31742 spam score:
31743 .code
31744 warn  control = caseful_local_part
31745       set acl_m4 = ${eval:\
31746                      $acl_m4 + \
31747                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31748                     }
31749       control = caselower_local_part
31750 .endd
31751 Notice that we put back the lower cased version afterwards, assuming that
31752 is what is wanted for subsequent tests.
31753
31754
31755 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31756 .cindex "&ACL;" "cutthrough routing"
31757 .cindex "cutthrough" "requesting"
31758 This option requests delivery be attempted while the item is being received.
31759
31760 The option is usable in the RCPT ACL.
31761 If enabled for a message received via smtp and routed to an smtp transport,
31762 and only one transport, interface, destination host and port combination
31763 is used for all recipients of the message,
31764 then the delivery connection is made while the receiving connection is open
31765 and data is copied from one to the other.
31766
31767 An attempt to set this option for any recipient but the first
31768 for a mail will be quietly ignored.
31769 If a recipient-verify callout
31770 (with use_sender)
31771 connection is subsequently
31772 requested in the same ACL it is held open and used for
31773 any subsequent recipients and the data,
31774 otherwise one is made after the initial RCPT ACL completes.
31775
31776 Note that routers are used in verify mode,
31777 and cannot depend on content of received headers.
31778 Note also that headers cannot be
31779 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31780 Headers may be modified by routers (subject to the above) and transports.
31781 The &'Received-By:'& header is generated as soon as the body reception starts,
31782 rather than the traditional time after the full message is received;
31783 this will affect the timestamp.
31784
31785 All the usual ACLs are called; if one results in the message being
31786 rejected, all effort spent in delivery (including the costs on
31787 the ultimate destination) will be wasted.
31788 Note that in the case of data-time ACLs this includes the entire
31789 message body.
31790
31791 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31792 of outgoing messages is done, because it sends data to the ultimate destination
31793 before the entire message has been received from the source.
31794 It is not supported for messages received with the SMTP PRDR
31795 or CHUNKING
31796 options in use.
31797
31798 Should the ultimate destination system positively accept or reject the mail,
31799 a corresponding indication is given to the source system and nothing is queued.
31800 If the item is successfully delivered in cutthrough mode
31801 the delivery log lines are tagged with ">>" rather than "=>" and appear
31802 before the acceptance "<=" line.
31803
31804 If there is a temporary error the item is queued for later delivery in the
31805 usual fashion.
31806 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31807 to the control; the default value is &"spool"& and the alternate value
31808 &"pass"& copies an SMTP defer response from the target back to the initiator
31809 and does not queue the message.
31810 Note that this is independent of any recipient verify conditions in the ACL.
31811
31812 Delivery in this mode avoids the generation of a bounce mail to a
31813 (possibly faked)
31814 sender when the destination system is doing content-scan based rejection.
31815
31816
31817 .vitem &*control&~=&~debug/*&<&'options'&>
31818 .cindex "&ACL;" "enabling debug logging"
31819 .cindex "debugging" "enabling from an ACL"
31820 This control turns on debug logging, almost as though Exim had been invoked
31821 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31822 by default called &'debuglog'&.
31823
31824 Logging set up by the control will be maintained across spool residency.
31825
31826 Options are a slash-separated list.
31827 If an option takes an argument, the option name and argument are separated by
31828 an equals character.
31829 Several options are supported:
31830 .display
31831 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31832                      The argument, which may access any variables already defined,
31833                      is appended to the default name.
31834
31835 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31836                      using the same values as the &`-d`& command-line option.
31837
31838 stop                 Logging started with this control may be
31839                      stopped by using this option.
31840
31841 kill                 Logging started with this control may be
31842                      stopped by using this option.
31843                      Additionally the debug file will be removed,
31844                      providing one means for speculative debug tracing.
31845
31846 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31847                      for pre-trigger debug capture.
31848                      Debug lines are recorded in the buffer until
31849                      and if) a trigger occurs; at which time they are
31850                      dumped to the debug file.  Newer lines displace the
31851                      oldest if the buffer is full.  After a trigger,
31852                      immediate writes to file are done as normal.
31853
31854 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31855                      see above) to be copied to file.  A reason of &*now*&
31856                      take effect immediately; one of &*paniclog*& triggers
31857                      on a write to the panic log.
31858 .endd
31859
31860 Some examples (which depend on variables that don't exist in all
31861 contexts):
31862 .code
31863       control = debug
31864       control = debug/tag=.$sender_host_address
31865       control = debug/opts=+expand+acl
31866       control = debug/tag=.$message_exim_id/opts=+expand
31867       control = debug/kill
31868       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31869       control = debug/trigger=now
31870 .endd
31871
31872
31873 .vitem &*control&~=&~dkim_disable_verify*&
31874 .cindex "disable DKIM verify"
31875 .cindex "DKIM" "disable verify"
31876 This control turns off DKIM verification processing entirely.  For details on
31877 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31878
31879
31880 .vitem &*control&~=&~dmarc_disable_verify*&
31881 .cindex "disable DMARC verify"
31882 .cindex "DMARC" "disable verify"
31883 This control turns off DMARC verification processing entirely.  For details on
31884 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31885
31886
31887 .vitem &*control&~=&~dscp/*&<&'value'&>
31888 .cindex "&ACL;" "setting DSCP value"
31889 .cindex "DSCP" "inbound"
31890 This option causes the DSCP value associated with the socket for the inbound
31891 connection to be adjusted to a given value, given as one of a number of fixed
31892 strings or to numeric value.
31893 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31894 Common values include &`throughput`&, &`mincost`&, and on newer systems
31895 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31896
31897 The outbound packets from Exim will be marked with this value in the header
31898 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31899 that these values will have any effect, not be stripped by networking
31900 equipment, or do much of anything without cooperation with your Network
31901 Engineer and those of all network operators between the source and destination.
31902
31903
31904 .vitem &*control&~=&~enforce_sync*& &&&
31905        &*control&~=&~no_enforce_sync*&
31906 .cindex "SMTP" "synchronization checking"
31907 .cindex "synchronization checking in SMTP"
31908 These controls make it possible to be selective about when SMTP synchronization
31909 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31910 state of the switch (it is true by default). See the description of this option
31911 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31912
31913 The effect of these two controls lasts for the remainder of the SMTP
31914 connection. They can appear in any ACL except the one for the non-SMTP
31915 messages. The most straightforward place to put them is in the ACL defined by
31916 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31917 before the first synchronization check. The expected use is to turn off the
31918 synchronization checks for badly-behaved hosts that you nevertheless need to
31919 work with.
31920
31921
31922 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31923 .cindex "fake defer"
31924 .cindex "defer, fake"
31925 .cindex fakedefer
31926 This control works in exactly the same way as &%fakereject%& (described below)
31927 except that it causes an SMTP 450 response after the message data instead of a
31928 550 response. You must take care when using &%fakedefer%& because it causes the
31929 messages to be duplicated when the sender retries. Therefore, you should not
31930 use &%fakedefer%& if the message is to be delivered normally.
31931
31932 .vitem &*control&~=&~fakereject/*&<&'message'&>
31933 .cindex "fake rejection"
31934 .cindex "rejection, fake"
31935 .cindex fakereject
31936 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31937 words, only when an SMTP message is being received. If Exim accepts the
31938 message, instead the final 250 response, a 550 rejection message is sent.
31939 However, Exim proceeds to deliver the message as normal. The control applies
31940 only to the current message, not to any subsequent ones that may be received in
31941 the same SMTP connection.
31942
31943 The text for the 550 response is taken from the &%control%& modifier. If no
31944 message is supplied, the following is used:
31945 .code
31946 550-Your message has been rejected but is being
31947 550-kept for evaluation.
31948 550-If it was a legitimate message, it may still be
31949 550 delivered to the target recipient(s).
31950 .endd
31951 This facility should be used with extreme caution.
31952
31953 .vitem &*control&~=&~freeze*&
31954 .cindex "frozen messages" "forcing in ACL"
31955 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31956 other words, only when a message is being received. If the message is accepted,
31957 it is placed on Exim's queue and frozen. The control applies only to the
31958 current message, not to any subsequent ones that may be received in the same
31959 SMTP connection.
31960
31961 This modifier can optionally be followed by &`/no_tell`&. If the global option
31962 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31963 is told about the freezing), provided all the &*control=freeze*& modifiers that
31964 are obeyed for the current message have the &`/no_tell`& option.
31965
31966 .vitem &*control&~=&~no_delay_flush*&
31967 .cindex "SMTP" "output flushing, disabling for delay"
31968 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31969 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31970 use. This control, as long as it is encountered before the &%delay%& modifier,
31971 disables such output flushing.
31972
31973 .vitem &*control&~=&~no_callout_flush*&
31974 .cindex "SMTP" "output flushing, disabling for callout"
31975 Exim normally flushes SMTP output before performing a callout in an ACL, to
31976 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31977 use. This control, as long as it is encountered before the &%verify%& condition
31978 that causes the callout, disables such output flushing.
31979
31980 .vitem &*control&~=&~no_mbox_unspool*&
31981 This control is available when Exim is compiled with the content scanning
31982 extension. Content scanning may require a copy of the current message, or parts
31983 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31984 or spam scanner. Normally, such copies are deleted when they are no longer
31985 needed. If this control is set, the copies are not deleted. The control applies
31986 only to the current message, not to any subsequent ones that may be received in
31987 the same SMTP connection. It is provided for debugging purposes and is unlikely
31988 to be useful in production.
31989
31990 .vitem &*control&~=&~no_multiline_responses*&
31991 .cindex "multiline responses, suppressing"
31992 This control is permitted for any ACL except the one for non-SMTP messages.
31993 It seems that there are broken clients in use that cannot handle multiline
31994 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31995
31996 If this control is set, multiline SMTP responses from ACL rejections are
31997 suppressed. One way of doing this would have been to put out these responses as
31998 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31999 (&"use multiline responses for more"& it says &-- ha!), and some of the
32000 responses might get close to that. So this facility, which is after all only a
32001 sop to broken clients, is implemented by doing two very easy things:
32002
32003 .ilist
32004 Extra information that is normally output as part of a rejection caused by
32005 sender verification failure is omitted. Only the final line (typically &"sender
32006 verification failed"&) is sent.
32007 .next
32008 If a &%message%& modifier supplies a multiline response, only the first
32009 line is output.
32010 .endlist
32011
32012 The setting of the switch can, of course, be made conditional on the
32013 calling host. Its effect lasts until the end of the SMTP connection.
32014
32015 .vitem &*control&~=&~no_pipelining*&
32016 .cindex "PIPELINING" "suppressing advertising"
32017 .cindex "ESMTP extensions" PIPELINING
32018 This control turns off the advertising of the PIPELINING extension to SMTP in
32019 the current session. To be useful, it must be obeyed before Exim sends its
32020 response to an EHLO command. Therefore, it should normally appear in an ACL
32021 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
32022 &%pipelining_advertise_hosts%&.
32023
32024 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
32025        &*control&~=&~queue_only*&
32026 .oindex "&%queue%&"
32027 .oindex "&%queue_only%&"
32028 .cindex "queueing incoming messages"
32029 .cindex queueing "forcing in ACL"
32030 .cindex "first pass routing"
32031 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
32032 other words, only when a message is being received. If the message is accepted,
32033 it is placed on Exim's queue and left there for delivery by a subsequent queue
32034 runner.
32035 If used with no options set,
32036 no immediate delivery process is started. In other words, it has the
32037 effect as the &%queue_only%& global option or &'-odq'& command-line option.
32038
32039 If the &'first_pass_route'& option is given then
32040 the behaviour is like the command-line &'-oqds'& option;
32041 a delivery process is started which stops short of making
32042 any SMTP delivery.  The benefit is that the hints database will be updated for
32043 the message being waiting for a specific host, and a later queue run will be
32044 able to send all such messages on a single connection.
32045
32046 The control only applies to the current message, not to any subsequent ones that
32047  may be received in the same SMTP connection.
32048
32049 .vitem &*control&~=&~submission/*&<&'options'&>
32050 .cindex "message" "submission"
32051 .cindex "submission mode"
32052 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
32053 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
32054 the current message is a submission from a local MUA. In this case, Exim
32055 operates in &"submission mode"&, and applies certain fixups to the message if
32056 necessary. For example, it adds a &'Date:'& header line if one is not present.
32057 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
32058 late (the message has already been created).
32059
32060 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
32061 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
32062 submission mode; the available options for this control are described there.
32063 The control applies only to the current message, not to any subsequent ones
32064 that may be received in the same SMTP connection.
32065
32066 .vitem &*control&~=&~suppress_local_fixups*&
32067 .cindex "submission fixups, suppressing"
32068 This control applies to locally submitted (non TCP/IP) messages, and is the
32069 complement of &`control = submission`&. It disables the fixups that are
32070 normally applied to locally-submitted messages. Specifically:
32071
32072 .ilist
32073 Any &'Sender:'& header line is left alone (in this respect, it is a
32074 dynamic version of &%local_sender_retain%&).
32075 .next
32076 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32077 .next
32078 There is no check that &'From:'& corresponds to the actual sender.
32079 .endlist ilist
32080
32081 This control may be useful when a remotely-originated message is accepted,
32082 passed to some scanning program, and then re-submitted for delivery. It can be
32083 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32084 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32085 data is read.
32086
32087 &*Note:*& This control applies only to the current message, not to any others
32088 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32089
32090 .vitem &*control&~=&~utf8_downconvert*&
32091 This control enables conversion of UTF-8 in message envelope addresses
32092 to a-label form.
32093 For details see section &<<SECTi18nMTA>>&.
32094 .endlist vlist
32095
32096
32097 .section "Summary of message fixup control" "SECTsummesfix"
32098 All four possibilities for message fixups can be specified:
32099
32100 .ilist
32101 Locally submitted, fixups applied: the default.
32102 .next
32103 Locally submitted, no fixups applied: use
32104 &`control = suppress_local_fixups`&.
32105 .next
32106 Remotely submitted, no fixups applied: the default.
32107 .next
32108 Remotely submitted, fixups applied: use &`control = submission`&.
32109 .endlist
32110
32111
32112
32113 .section "Adding header lines in ACLs" "SECTaddheadacl"
32114 .cindex "header lines" "adding in an ACL"
32115 .cindex "header lines" "position of added lines"
32116 .cindex "&%add_header%& ACL modifier"
32117 The &%add_header%& modifier can be used to add one or more extra header lines
32118 to an incoming message, as in this example:
32119 .code
32120 warn dnslists = sbl.spamhaus.org : \
32121                 dialup.mail-abuse.org
32122      add_header = X-blacklisted-at: $dnslist_domain
32123 .endd
32124 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32125 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32126 receiving a message). The message must ultimately be accepted for
32127 &%add_header%& to have any significant effect. You can use &%add_header%& with
32128 any ACL verb, including &%deny%& (though this is potentially useful only in a
32129 RCPT ACL).
32130
32131 Headers will not be added to the message if the modifier is used in
32132 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32133
32134 Leading and trailing newlines are removed from
32135 the data for the &%add_header%& modifier; if it then
32136 contains one or more newlines that
32137 are not followed by a space or a tab, it is assumed to contain multiple header
32138 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32139 front of any line that is not a valid header line.
32140
32141 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32142 They are added to the message before processing the DATA and MIME ACLs.
32143 However, if an identical header line is requested more than once, only one copy
32144 is actually added to the message. Further header lines may be accumulated
32145 during the DATA and MIME ACLs, after which they are added to the message, again
32146 with duplicates suppressed. Thus, it is possible to add two identical header
32147 lines to an SMTP message, but only if one is added before DATA and one after.
32148 In the case of non-SMTP messages, new headers are accumulated during the
32149 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32150 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32151 are included in the entry that is written to the reject log.
32152
32153 .cindex "header lines" "added; visibility of"
32154 Header lines are not visible in string expansions
32155 of message headers
32156 until they are added to the
32157 message. It follows that header lines defined in the MAIL, RCPT, and predata
32158 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32159 header lines that are added by the DATA or MIME ACLs are not visible in those
32160 ACLs. Because of this restriction, you cannot use header lines as a way of
32161 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32162 this, you can use ACL variables, as described in section
32163 &<<SECTaclvariables>>&.
32164
32165 The list of headers yet to be added is given by the &%$headers_added%& variable.
32166
32167 The &%add_header%& modifier acts immediately as it is encountered during the
32168 processing of an ACL. Notice the difference between these two cases:
32169 .display
32170 &`accept add_header = ADDED: some text`&
32171 &`       `&<&'some condition'&>
32172
32173 &`accept `&<&'some condition'&>
32174 &`       add_header = ADDED: some text`&
32175 .endd
32176 In the first case, the header line is always added, whether or not the
32177 condition is true. In the second case, the header line is added only if the
32178 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32179 ACL statement. All those that are encountered before a condition fails are
32180 honoured.
32181
32182 .cindex "&%warn%& ACL verb"
32183 For compatibility with previous versions of Exim, a &%message%& modifier for a
32184 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32185 effect only if all the conditions are true, even if it appears before some of
32186 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32187 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32188 are present on a &%warn%& verb, both are processed according to their
32189 specifications.
32190
32191 By default, new header lines are added to a message at the end of the existing
32192 header lines. However, you can specify that any particular header line should
32193 be added right at the start (before all the &'Received:'& lines), immediately
32194 after the first block of &'Received:'& lines, or immediately before any line
32195 that is not a &'Received:'& or &'Resent-something:'& header.
32196
32197 This is done by specifying &":at_start:"&, &":after_received:"&, or
32198 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32199 header line, respectively. (Header text cannot start with a colon, as there has
32200 to be a header name first.) For example:
32201 .code
32202 warn add_header = \
32203        :after_received:X-My-Header: something or other...
32204 .endd
32205 If more than one header line is supplied in a single &%add_header%& modifier,
32206 each one is treated independently and can therefore be placed differently. If
32207 you add more than one line at the start, or after the Received: block, they end
32208 up in reverse order.
32209
32210 &*Warning*&: This facility currently applies only to header lines that are
32211 added in an ACL. It does NOT work for header lines that are added in a
32212 system filter or in a router or transport.
32213
32214
32215
32216 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32217 .cindex "header lines" "removing in an ACL"
32218 .cindex "header lines" "position of removed lines"
32219 .cindex "&%remove_header%& ACL modifier"
32220 The &%remove_header%& modifier can be used to remove one or more header lines
32221 from an incoming message, as in this example:
32222 .code
32223 warn   message        = Remove internal headers
32224        remove_header  = x-route-mail1 : x-route-mail2
32225 .endd
32226 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32227 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32228 receiving a message). The message must ultimately be accepted for
32229 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32230 with any ACL verb, including &%deny%&, though this is really not useful for
32231 any verb that doesn't result in a delivered message.
32232
32233 Headers will not be removed from the message if the modifier is used in
32234 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32235
32236 More than one header can be removed at the same time by using a colon separated
32237 list of header specifiers.
32238 If a specifier does not start with a circumflex (^)
32239 then it is treated as a header name.
32240 The header name matching is case insensitive.
32241 If it does, then it is treated as a (front-anchored)
32242 regular expression applied to the whole header.
32243
32244 &*Note*&: The colon terminating a header name will need to be doubled
32245 if used in an RE, and there can legitimately be whitepace before it.
32246
32247 Example:
32248 .code
32249 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32250 .endd
32251
32252 List expansion is not performed, so you cannot use hostlists to
32253 create a list of headers, however both connection and message variable expansion
32254 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32255 .code
32256 warn   hosts           = +internal_hosts
32257        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32258 warn   message         = Remove internal headers
32259        remove_header   = $acl_c_ihdrs
32260 .endd
32261 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32262 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32263 If multiple header lines match, all are removed.
32264 There is no harm in attempting to remove the same header twice nor in removing
32265 a non-existent header. Further header specifiers for removal may be accumulated
32266 during the DATA and MIME ACLs, after which matching headers are removed
32267 if present. In the case of non-SMTP messages, remove specifiers are
32268 accumulated during the non-SMTP ACLs, and are acted on after
32269 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32270 ACL, there really is no effect because there is no logging of what headers
32271 would have been removed.
32272
32273 .cindex "header lines" "removed; visibility of"
32274 Header lines are not visible in string expansions until the DATA phase when it
32275 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32276 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32277 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32278 this restriction, you cannot use header lines as a way of controlling data
32279 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32280 you should instead use ACL variables, as described in section
32281 &<<SECTaclvariables>>&.
32282
32283 The &%remove_header%& modifier acts immediately as it is encountered during the
32284 processing of an ACL. Notice the difference between these two cases:
32285 .display
32286 &`accept remove_header = X-Internal`&
32287 &`       `&<&'some condition'&>
32288
32289 &`accept `&<&'some condition'&>
32290 &`       remove_header = X-Internal`&
32291 .endd
32292 In the first case, the header line is always removed, whether or not the
32293 condition is true. In the second case, the header line is removed only if the
32294 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32295 same ACL statement. All those that are encountered before a condition fails
32296 are honoured.
32297
32298 &*Warning*&: This facility currently applies only to header lines that are
32299 present during ACL processing. It does NOT remove header lines that are added
32300 in a system filter or in a router or transport.
32301
32302
32303
32304
32305 .section "ACL conditions" "SECTaclconditions"
32306 .cindex "&ACL;" "conditions; list of"
32307 Some of the conditions listed in this section are available only when Exim is
32308 compiled with the content-scanning extension. They are included here briefly
32309 for completeness. More detailed descriptions can be found in the discussion on
32310 content scanning in chapter &<<CHAPexiscan>>&.
32311
32312 Not all conditions are relevant in all circumstances. For example, testing
32313 senders and recipients does not make sense in an ACL that is being run as the
32314 result of the arrival of an ETRN command, and checks on message headers can be
32315 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32316 can use the same condition (with different parameters) more than once in the
32317 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32318 The conditions are as follows:
32319
32320
32321 .vlist
32322 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32323 .cindex "&ACL;" "nested"
32324 .cindex "&ACL;" "indirect"
32325 .cindex "&ACL;" "arguments"
32326 .cindex "&%acl%& ACL condition"
32327 The possible values of the argument are the same as for the
32328 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32329 &"accept"& the condition is true; if it returns &"deny"& the condition is
32330 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32331 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32332 condition false. This means that further processing of the &%warn%& verb
32333 ceases, but processing of the ACL continues.
32334
32335 If the argument is a named ACL, up to nine space-separated optional values
32336 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32337 and $acl_narg is set to the count of values.
32338 Previous values of these variables are restored after the call returns.
32339 The name and values are expanded separately.
32340 Note that spaces in complex expansions which are used as arguments
32341 will act as argument separators.
32342
32343 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32344 the connection is dropped. If it returns &"discard"&, the verb must be
32345 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32346 conditions are tested.
32347
32348 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32349 loops. This condition allows you to use different ACLs in different
32350 circumstances. For example, different ACLs can be used to handle RCPT commands
32351 for different local users or different local domains.
32352
32353 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32354 .cindex "&%authenticated%& ACL condition"
32355 .cindex "authentication" "ACL checking"
32356 .cindex "&ACL;" "testing for authentication"
32357 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32358 the name of the authenticator is tested against the list. To test for
32359 authentication by any authenticator, you can set
32360 .code
32361 authenticated = *
32362 .endd
32363
32364 .vitem &*condition&~=&~*&<&'string'&>
32365 .cindex "&%condition%& ACL condition"
32366 .cindex "customizing" "ACL condition"
32367 .cindex "&ACL;" "customized test"
32368 .cindex "&ACL;" "testing, customized"
32369 This feature allows you to make up custom conditions. If the result of
32370 expanding the string is an empty string, the number zero, or one of the strings
32371 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32372 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32373 any other value, some error is assumed to have occurred, and the ACL returns
32374 &"defer"&. However, if the expansion is forced to fail, the condition is
32375 ignored. The effect is to treat it as true, whether it is positive or
32376 negative.
32377
32378 .vitem &*decode&~=&~*&<&'location'&>
32379 .cindex "&%decode%& ACL condition"
32380 This condition is available only when Exim is compiled with the
32381 content-scanning extension, and it is allowed only in the ACL defined by
32382 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32383 If all goes well, the condition is true. It is false only if there are
32384 problems such as a syntax error or a memory shortage. For more details, see
32385 chapter &<<CHAPexiscan>>&.
32386
32387 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32388 .cindex "&%dnslists%& ACL condition"
32389 .cindex "DNS list" "in ACL"
32390 .cindex "black list (DNS)"
32391 .cindex "&ACL;" "testing a DNS list"
32392 This condition checks for entries in DNS black lists. These are also known as
32393 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32394 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32395 different variants of this condition to describe briefly here. See sections
32396 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32397
32398 .vitem &*domains&~=&~*&<&'domain&~list'&>
32399 .cindex "&%domains%& ACL condition"
32400 .cindex "domain" "ACL checking"
32401 .cindex "&ACL;" "testing a recipient domain"
32402 .vindex "&$domain_data$&"
32403 This condition is relevant only in a RCPT ACL. It checks that the domain
32404 of the recipient address is in the domain list. If percent-hack processing is
32405 enabled, it is done before this test is done. If the check succeeds with a
32406 lookup, the result of the lookup is placed in &$domain_data$& until the next
32407 &%domains%& test.
32408
32409 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32410 use &%domains%& in a DATA ACL.
32411
32412
32413 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32414 .cindex "&%encrypted%& ACL condition"
32415 .cindex "encryption" "checking in an ACL"
32416 .cindex "&ACL;" "testing for encryption"
32417 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32418 name of the cipher suite in use is tested against the list. To test for
32419 encryption without testing for any specific cipher suite(s), set
32420 .code
32421 encrypted = *
32422 .endd
32423
32424
32425 .vitem &*hosts&~=&~*&<&'host&~list'&>
32426 .cindex "&%hosts%& ACL condition"
32427 .cindex "host" "ACL checking"
32428 .cindex "&ACL;" "testing the client host"
32429 This condition tests that the calling host matches the host list. If you have
32430 name lookups or wildcarded host names and IP addresses in the same host list,
32431 you should normally put the IP addresses first. For example, you could have:
32432 .code
32433 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32434 .endd
32435 The lookup in this example uses the host name for its key. This is implied by
32436 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32437 and it wouldn't matter which way round you had these two items.)
32438
32439 The reason for the problem with host names lies in the left-to-right way that
32440 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32441 but when it reaches an item that requires a host name, it fails if it cannot
32442 find a host name to compare with the pattern. If the above list is given in the
32443 opposite order, the &%accept%& statement fails for a host whose name cannot be
32444 found, even if its IP address is 10.9.8.7.
32445
32446 If you really do want to do the name check first, and still recognize the IP
32447 address even if the name lookup fails, you can rewrite the ACL like this:
32448 .code
32449 accept hosts = dbm;/etc/friendly/hosts
32450 accept hosts = 10.9.8.7
32451 .endd
32452 The default action on failing to find the host name is to assume that the host
32453 is not in the list, so the first &%accept%& statement fails. The second
32454 statement can then check the IP address.
32455
32456 .vindex "&$host_data$&"
32457 If a &%hosts%& condition is satisfied by means of a lookup, the result
32458 of the lookup is made available in the &$host_data$& variable. This
32459 allows you, for example, to set up a statement like this:
32460 .code
32461 deny  hosts = net-lsearch;/some/file
32462       message = $host_data
32463 .endd
32464 which gives a custom error message for each denied host.
32465
32466 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32467 .cindex "&%local_parts%& ACL condition"
32468 .cindex "local part" "ACL checking"
32469 .cindex "&ACL;" "testing a local part"
32470 .vindex "&$local_part_data$&"
32471 This condition is relevant only in a RCPT ACL. It checks that the local
32472 part of the recipient address is in the list. If percent-hack processing is
32473 enabled, it is done before this test. If the check succeeds with a lookup, the
32474 result of the lookup is placed in &$local_part_data$&, which remains set until
32475 the next &%local_parts%& test.
32476
32477 .vitem &*malware&~=&~*&<&'option'&>
32478 .cindex "&%malware%& ACL condition"
32479 .cindex "&ACL;" "virus scanning"
32480 .cindex "&ACL;" "scanning for viruses"
32481 This condition is available only when Exim is compiled with the
32482 content-scanning extension
32483 and only after a DATA command.
32484 It causes the incoming message to be scanned for
32485 viruses. For details, see chapter &<<CHAPexiscan>>&.
32486
32487 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32488 .cindex "&%mime_regex%& ACL condition"
32489 .cindex "&ACL;" "testing by regex matching"
32490 This condition is available only when Exim is compiled with the
32491 content-scanning extension, and it is allowed only in the ACL defined by
32492 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32493 with any of the regular expressions. For details, see chapter
32494 &<<CHAPexiscan>>&.
32495
32496 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32497 .cindex "rate limiting"
32498 This condition can be used to limit the rate at which a user or host submits
32499 messages. Details are given in section &<<SECTratelimiting>>&.
32500
32501 .vitem &*recipients&~=&~*&<&'address&~list'&>
32502 .cindex "&%recipients%& ACL condition"
32503 .cindex "recipient" "ACL checking"
32504 .cindex "&ACL;" "testing a recipient"
32505 This condition is relevant only in a RCPT ACL. It checks the entire
32506 recipient address against a list of recipients.
32507
32508 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32509 .cindex "&%regex%& ACL condition"
32510 .cindex "&ACL;" "testing by regex matching"
32511 This condition is available only when Exim is compiled with the
32512 content-scanning extension, and is available only in the DATA, MIME, and
32513 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32514 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32515
32516 .vitem &*seen&~=&~*&<&'parameters'&>
32517 .cindex "&%seen%& ACL condition"
32518 This condition can be used to test if a situation has been previously met,
32519 for example for greylisting.
32520 Details are given in section &<<SECTseen>>&.
32521
32522 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32523 .cindex "&%sender_domains%& ACL condition"
32524 .cindex "sender" "ACL checking"
32525 .cindex "&ACL;" "testing a sender domain"
32526 .vindex "&$domain$&"
32527 .vindex "&$sender_address_domain$&"
32528 This condition tests the domain of the sender of the message against the given
32529 domain list. &*Note*&: The domain of the sender address is in
32530 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32531 of this condition. This is an exception to the general rule for testing domain
32532 lists. It is done this way so that, if this condition is used in an ACL for a
32533 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32534 influence the sender checking.
32535
32536 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32537 relaying, because sender addresses are easily, and commonly, forged.
32538
32539 .vitem &*senders&~=&~*&<&'address&~list'&>
32540 .cindex "&%senders%& ACL condition"
32541 .cindex "sender" "ACL checking"
32542 .cindex "&ACL;" "testing a sender"
32543 This condition tests the sender of the message against the given list. To test
32544 for a bounce message, which has an empty sender, set
32545 .code
32546 senders = :
32547 .endd
32548 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32549 relaying, because sender addresses are easily, and commonly, forged.
32550
32551 .vitem &*spam&~=&~*&<&'username'&>
32552 .cindex "&%spam%& ACL condition"
32553 .cindex "&ACL;" "scanning for spam"
32554 This condition is available only when Exim is compiled with the
32555 content-scanning extension. It causes the incoming message to be scanned by
32556 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32557
32558 .vitem &*verify&~=&~certificate*&
32559 .cindex "&%verify%& ACL condition"
32560 .cindex "TLS" "client certificate verification"
32561 .cindex "certificate" "verification of client"
32562 .cindex "&ACL;" "certificate verification"
32563 .cindex "&ACL;" "testing a TLS certificate"
32564 This condition is true in an SMTP session if the session is encrypted, and a
32565 certificate was received from the client, and the certificate was verified. The
32566 server requests a certificate only if the client matches &%tls_verify_hosts%&
32567 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32568
32569 .vitem &*verify&~=&~csa*&
32570 .cindex "CSA verification"
32571 This condition checks whether the sending host (the client) is authorized to
32572 send email. Details of how this works are given in section
32573 &<<SECTverifyCSA>>&.
32574
32575 .vitem &*verify&~=&~header_names_ascii*&
32576 .cindex "&%verify%& ACL condition"
32577 .cindex "&ACL;" "verifying header names only ASCII"
32578 .cindex "header lines" "verifying header names only ASCII"
32579 .cindex "verifying" "header names only ASCII"
32580 This condition is relevant only in an ACL that is run after a message has been
32581 received.
32582 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32583 It checks all header names (not the content) to make sure
32584 there are no non-ASCII characters, also excluding control characters.  The
32585 allowable characters are decimal ASCII values 33 through 126.
32586
32587 Exim itself will handle headers with non-ASCII characters, but it can cause
32588 problems for downstream applications, so this option will allow their
32589 detection and rejection in the DATA ACL's.
32590
32591 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32592 .cindex "&%verify%& ACL condition"
32593 .cindex "&ACL;" "verifying sender in the header"
32594 .cindex "header lines" "verifying the sender in"
32595 .cindex "sender" "verifying in header"
32596 .cindex "verifying" "sender in header"
32597 This condition is relevant only in an ACL that is run after a message has been
32598 received, that is, in an ACL specified by &%acl_smtp_data%& or
32599 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32600 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32601 is loosely thought of as a &"sender"& address (hence the name of the test).
32602 However, an address that appears in one of these headers need not be an address
32603 that accepts bounce messages; only sender addresses in envelopes are required
32604 to accept bounces. Therefore, if you use the callout option on this check, you
32605 might want to arrange for a non-empty address in the MAIL command.
32606
32607 Details of address verification and the options are given later, starting at
32608 section &<<SECTaddressverification>>& (callouts are described in section
32609 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32610 condition to restrict it to bounce messages only:
32611 .code
32612 deny    senders = :
32613        !verify  = header_sender
32614         message = A valid sender header is required for bounces
32615 .endd
32616
32617 .vitem &*verify&~=&~header_syntax*&
32618 .cindex "&%verify%& ACL condition"
32619 .cindex "&ACL;" "verifying header syntax"
32620 .cindex "header lines" "verifying syntax"
32621 .cindex "verifying" "header syntax"
32622 This condition is relevant only in an ACL that is run after a message has been
32623 received, that is, in an ACL specified by &%acl_smtp_data%& or
32624 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32625 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32626 and &'Bcc:'&), returning true if there are no problems.
32627 Unqualified addresses (local parts without domains) are
32628 permitted only in locally generated messages and from hosts that match
32629 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32630 appropriate.
32631
32632 Note that this condition is a syntax check only. However, a common spamming
32633 ploy used to be to send syntactically invalid headers such as
32634 .code
32635 To: @
32636 .endd
32637 and this condition can be used to reject such messages, though they are not as
32638 common as they used to be.
32639
32640 .vitem &*verify&~=&~helo*&
32641 .cindex "&%verify%& ACL condition"
32642 .cindex "&ACL;" "verifying HELO/EHLO"
32643 .cindex "HELO" "verifying"
32644 .cindex "EHLO" "verifying"
32645 .cindex "verifying" "EHLO"
32646 .cindex "verifying" "HELO"
32647 This condition is true if a HELO or EHLO command has been received from the
32648 client host, and its contents have been verified. If there has been no previous
32649 attempt to verify the HELO/EHLO contents, it is carried out when this
32650 condition is encountered. See the description of the &%helo_verify_hosts%& and
32651 &%helo_try_verify_hosts%& options for details of how to request verification
32652 independently of this condition, and for detail of the verification.
32653
32654 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32655 option), this condition is always true.
32656
32657
32658 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32659 .cindex "verifying" "not blind"
32660 .cindex "bcc recipients, verifying none"
32661 This condition checks that there are no blind (bcc) recipients in the message.
32662 Every envelope recipient must appear either in a &'To:'& header line or in a
32663 &'Cc:'& header line for this condition to be true. Local parts are checked
32664 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32665 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32666 used only in a DATA or non-SMTP ACL.
32667
32668 There is one possible option, &`case_insensitive`&.  If this is present then
32669 local parts are checked case-insensitively.
32670
32671 There are, of course, many legitimate messages that make use of blind (bcc)
32672 recipients. This check should not be used on its own for blocking messages.
32673
32674
32675 .vitem &*verify&~=&~recipient/*&<&'options'&>
32676 .cindex "&%verify%& ACL condition"
32677 .cindex "&ACL;" "verifying recipient"
32678 .cindex "recipient" "verifying"
32679 .cindex "verifying" "recipient"
32680 .vindex "&$address_data$&"
32681 This condition is relevant only after a RCPT command. It verifies the current
32682 recipient. Details of address verification are given later, starting at section
32683 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32684 of &$address_data$& is the last value that was set while routing the address.
32685 This applies even if the verification fails. When an address that is being
32686 verified is redirected to a single address, verification continues with the new
32687 address, and in that case, the subsequent value of &$address_data$& is the
32688 value for the child address.
32689
32690 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32691 .cindex "&%verify%& ACL condition"
32692 .cindex "&ACL;" "verifying host reverse lookup"
32693 .cindex "host" "verifying reverse lookup"
32694 This condition ensures that a verified host name has been looked up from the IP
32695 address of the client host. (This may have happened already if the host name
32696 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32697 Verification ensures that the host name obtained from a reverse DNS lookup, or
32698 one of its aliases, does, when it is itself looked up in the DNS, yield the
32699 original IP address.
32700
32701 There is one possible option, &`defer_ok`&.  If this is present and a
32702 DNS operation returns a temporary error, the verify condition succeeds.
32703
32704 If this condition is used for a locally generated message (that is, when there
32705 is no client host involved), it always succeeds.
32706
32707 .vitem &*verify&~=&~sender/*&<&'options'&>
32708 .cindex "&%verify%& ACL condition"
32709 .cindex "&ACL;" "verifying sender"
32710 .cindex "sender" "verifying"
32711 .cindex "verifying" "sender"
32712 This condition is relevant only after a MAIL or RCPT command, or after a
32713 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32714 the message's sender is empty (that is, this is a bounce message), the
32715 condition is true. Otherwise, the sender address is verified.
32716
32717 .vindex "&$address_data$&"
32718 .vindex "&$sender_address_data$&"
32719 If there is data in the &$address_data$& variable at the end of routing, its
32720 value is placed in &$sender_address_data$& at the end of verification. This
32721 value can be used in subsequent conditions and modifiers in the same ACL
32722 statement. It does not persist after the end of the current statement. If you
32723 want to preserve the value for longer, you can save it in an ACL variable.
32724
32725 Details of verification are given later, starting at section
32726 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32727 to avoid doing it more than once per message.
32728
32729 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32730 .cindex "&%verify%& ACL condition"
32731 This is a variation of the previous option, in which a modified address is
32732 verified as a sender.
32733
32734 Note that '/' is legal in local-parts; if the address may have such
32735 (eg. is generated from the received message)
32736 they must be protected from the options parsing by doubling:
32737 .code
32738 verify = sender=${listquote{/}{${address:$h_sender:}}}
32739 .endd
32740 .endlist
32741
32742
32743
32744 .section "Using DNS lists" "SECTmorednslists"
32745 .cindex "DNS list" "in ACL"
32746 .cindex "black list (DNS)"
32747 .cindex "&ACL;" "testing a DNS list"
32748 In its simplest form, the &%dnslists%& condition tests whether the calling host
32749 is on at least one of a number of DNS lists by looking up the inverted IP
32750 address in one or more DNS domains. (Note that DNS list domains are not mail
32751 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32752 special options instead.) For example, if the calling host's IP
32753 address is 192.168.62.43, and the ACL statement is
32754 .code
32755 deny dnslists = blackholes.mail-abuse.org : \
32756                 dialups.mail-abuse.org
32757 .endd
32758 the following records are looked up:
32759 .code
32760 43.62.168.192.blackholes.mail-abuse.org
32761 43.62.168.192.dialups.mail-abuse.org
32762 .endd
32763 As soon as Exim finds an existing DNS record, processing of the list stops.
32764 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32765 to test that a host is on more than one list (an &"and"& conjunction), you can
32766 use two separate conditions:
32767 .code
32768 deny dnslists = blackholes.mail-abuse.org
32769      dnslists = dialups.mail-abuse.org
32770 .endd
32771 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32772 behaves as if the host does not match the list item, that is, as if the DNS
32773 record does not exist. If there are further items in the DNS list, they are
32774 processed.
32775
32776 This is usually the required action when &%dnslists%& is used with &%deny%&
32777 (which is the most common usage), because it prevents a DNS failure from
32778 blocking mail. However, you can change this behaviour by putting one of the
32779 following special items in the list:
32780 .itable none 0 0 2 25* left 75* left
32781 .irow "+include_unknown"   "behave as if the item is on the list"
32782 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32783 .irow "+defer_unknown  "   "give a temporary error"
32784 .endtable
32785 .cindex "&`+include_unknown`&"
32786 .cindex "&`+exclude_unknown`&"
32787 .cindex "&`+defer_unknown`&"
32788 Each of these applies to any subsequent items on the list. For example:
32789 .code
32790 deny dnslists = +defer_unknown : foo.bar.example
32791 .endd
32792 Testing the list of domains stops as soon as a match is found. If you want to
32793 warn for one list and block for another, you can use two different statements:
32794 .code
32795 deny  dnslists = blackholes.mail-abuse.org
32796 warn  dnslists = dialups.mail-abuse.org
32797       message  = X-Warn: sending host is on dialups list
32798 .endd
32799 .cindex caching "of dns lookup"
32800 .cindex DNS TTL
32801 DNS list lookups are cached by Exim for the duration of the SMTP session
32802 (but limited by the DNS return TTL value),
32803 so a lookup based on the IP address is done at most once for any incoming
32804 connection (assuming long-enough TTL).
32805 Exim does not share information between multiple incoming
32806 connections (but your local name server cache should be active).
32807
32808 There are a number of DNS lists to choose from, some commercial, some free,
32809 or free for small deployments.  An overview can be found at
32810 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32811
32812
32813
32814 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32815 .cindex "DNS list" "keyed by explicit IP address"
32816 By default, the IP address that is used in a DNS list lookup is the IP address
32817 of the calling host. However, you can specify another IP address by listing it
32818 after the domain name, introduced by a slash. For example:
32819 .code
32820 deny dnslists = black.list.tld/192.168.1.2
32821 .endd
32822 This feature is not very helpful with explicit IP addresses; it is intended for
32823 use with IP addresses that are looked up, for example, the IP addresses of the
32824 MX hosts or nameservers of an email sender address. For an example, see section
32825 &<<SECTmulkeyfor>>& below.
32826
32827
32828
32829
32830 .subsection "DNS lists keyed on domain names" SECID202
32831 .cindex "DNS list" "keyed by domain name"
32832 There are some lists that are keyed on domain names rather than inverted IP
32833 addresses (see, e.g., the &'domain based zones'& link at
32834 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32835 with these lists. You can change the name that is looked up in a DNS list by
32836 listing it after the domain name, introduced by a slash. For example,
32837 .code
32838 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32839       message  = Sender's domain is listed at $dnslist_domain
32840 .endd
32841 This particular example is useful only in ACLs that are obeyed after the
32842 RCPT or DATA commands, when a sender address is available. If (for
32843 example) the message's sender is &'user@tld.example'& the name that is looked
32844 up by this example is
32845 .code
32846 tld.example.dsn.rfc-ignorant.org
32847 .endd
32848 A single &%dnslists%& condition can contain entries for both names and IP
32849 addresses. For example:
32850 .code
32851 deny dnslists = sbl.spamhaus.org : \
32852                 dsn.rfc-ignorant.org/$sender_address_domain
32853 .endd
32854 The first item checks the sending host's IP address; the second checks a domain
32855 name. The whole condition is true if either of the DNS lookups succeeds.
32856
32857
32858
32859
32860 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32861 .cindex "DNS list" "multiple keys for"
32862 The syntax described above for looking up explicitly-defined values (either
32863 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32864 name for the DNS list, what follows the slash can in fact be a list of items.
32865 As with all lists in Exim, the default separator is a colon. However, because
32866 this is a sublist within the list of DNS blacklist domains, it is necessary
32867 either to double the separators like this:
32868 .code
32869 dnslists = black.list.tld/name.1::name.2
32870 .endd
32871 or to change the separator character, like this:
32872 .code
32873 dnslists = black.list.tld/<;name.1;name.2
32874 .endd
32875 If an item in the list is an IP address, it is inverted before the DNS
32876 blacklist domain is appended. If it is not an IP address, no inversion
32877 occurs. Consider this condition:
32878 .code
32879 dnslists = black.list.tld/<;192.168.1.2;a.domain
32880 .endd
32881 The DNS lookups that occur are:
32882 .code
32883 2.1.168.192.black.list.tld
32884 a.domain.black.list.tld
32885 .endd
32886 Once a DNS record has been found (that matches a specific IP return
32887 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32888 are done. If there is a temporary DNS error, the rest of the sublist of domains
32889 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32890 only if no other DNS lookup in this sublist succeeds. In other words, a
32891 successful lookup for any of the items in the sublist overrides a temporary
32892 error for a previous item.
32893
32894 The ability to supply a list of items after the slash is in some sense just a
32895 syntactic convenience. These two examples have the same effect:
32896 .code
32897 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32898 dnslists = black.list.tld/a.domain::b.domain
32899 .endd
32900 However, when the data for the list is obtained from a lookup, the second form
32901 is usually much more convenient. Consider this example:
32902 .code
32903 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32904                                    ${lookup dnsdb {>|mxh=\
32905                                    $sender_address_domain} }} }
32906      message  = The mail servers for the domain \
32907                 $sender_address_domain \
32908                 are listed at $dnslist_domain ($dnslist_value); \
32909                 see $dnslist_text.
32910 .endd
32911 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32912 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32913 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32914 of expanding the condition might be something like this:
32915 .code
32916 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32917 .endd
32918 Thus, this example checks whether or not the IP addresses of the sender
32919 domain's mail servers are on the Spamhaus black list.
32920
32921 The key that was used for a successful DNS list lookup is put into the variable
32922 &$dnslist_matched$& (see section &<<SECID204>>&).
32923
32924
32925
32926
32927 .subsection "Data returned by DNS lists" SECID203
32928 .cindex "DNS list" "data returned from"
32929 DNS lists are constructed using address records in the DNS. The original RBL
32930 just used the address 127.0.0.1 on the right hand side of each record, but the
32931 RBL+ list and some other lists use a number of values with different meanings.
32932 The values used on the RBL+ list are:
32933 .itable none 0 0 2 20* left 80* left
32934 .irow 127.1.0.1  "RBL"
32935 .irow 127.1.0.2  "DUL"
32936 .irow 127.1.0.3  "DUL and RBL"
32937 .irow 127.1.0.4  "RSS"
32938 .irow 127.1.0.5  "RSS and RBL"
32939 .irow 127.1.0.6  "RSS and DUL"
32940 .irow 127.1.0.7  "RSS and DUL and RBL"
32941 .endtable
32942 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32943 different values. Some DNS lists may return more than one address record;
32944 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32945
32946 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32947 range. If a DNSBL operator loses control of the domain, lookups on it
32948 may start returning other addresses.  Because of this, Exim now ignores
32949 returned values outside the 127/8 region.
32950
32951
32952 .subsection "Variables set from DNS lists" SECID204
32953 .cindex "expansion" "variables, set from DNS list"
32954 .cindex "DNS list" "variables set from"
32955 .vindex "&$dnslist_domain$&"
32956 .vindex "&$dnslist_matched$&"
32957 .vindex "&$dnslist_text$&"
32958 .vindex "&$dnslist_value$&"
32959 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32960 the name of the overall domain that matched (for example,
32961 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32962 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32963 the DNS record. When the key is an IP address, it is not reversed in
32964 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32965 cases, for example:
32966 .code
32967 deny dnslists = spamhaus.example
32968 .endd
32969 the key is also available in another variable (in this case,
32970 &$sender_host_address$&). In more complicated cases, however, this is not true.
32971 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32972 might generate a dnslists lookup like this:
32973 .code
32974 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32975 .endd
32976 If this condition succeeds, the value in &$dnslist_matched$& might be
32977 &`192.168.6.7`& (for example).
32978
32979 If more than one address record is returned by the DNS lookup, all the IP
32980 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32981 The variable &$dnslist_text$& contains the contents of any associated TXT
32982 record. For lists such as RBL+ the TXT record for a merged entry is often not
32983 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32984 information.
32985
32986 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32987 &-- even if these appear before the condition in the ACL, they are not
32988 expanded until after it has failed. For example:
32989 .code
32990 deny    hosts = !+local_networks
32991         message = $sender_host_address is listed \
32992                   at $dnslist_domain
32993         dnslists = rbl-plus.mail-abuse.example
32994 .endd
32995
32996
32997
32998 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32999 .cindex "DNS list" "matching specific returned data"
33000 You can add an equals sign and an IP address after a &%dnslists%& domain name
33001 in order to restrict its action to DNS records with a matching right hand side.
33002 For example,
33003 .code
33004 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
33005 .endd
33006 rejects only those hosts that yield 127.0.0.2. Without this additional data,
33007 any address record is considered to be a match. For the moment, we assume
33008 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
33009 describes how multiple records are handled.
33010
33011 More than one IP address may be given for checking, using a comma as a
33012 separator. These are alternatives &-- if any one of them matches, the
33013 &%dnslists%& condition is true. For example:
33014 .code
33015 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33016 .endd
33017 If you want to specify a constraining address list and also specify names or IP
33018 addresses to be looked up, the constraining address list must be specified
33019 first. For example:
33020 .code
33021 deny dnslists = dsn.rfc-ignorant.org\
33022                 =127.0.0.2/$sender_address_domain
33023 .endd
33024
33025 If the character &`&&`& is used instead of &`=`&, the comparison for each
33026 listed IP address is done by a bitwise &"and"& instead of by an equality test.
33027 In other words, the listed addresses are used as bit masks. The comparison is
33028 true if all the bits in the mask are present in the address that is being
33029 tested. For example:
33030 .code
33031 dnslists = a.b.c&0.0.0.3
33032 .endd
33033 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
33034 want to test whether one bit or another bit is present (as opposed to both
33035 being present), you must use multiple values. For example:
33036 .code
33037 dnslists = a.b.c&0.0.0.1,0.0.0.2
33038 .endd
33039 matches if the final component of the address is an odd number or two times
33040 an odd number.
33041
33042
33043
33044 .subsection "Negated DNS matching conditions" SECID205
33045 You can supply a negative list of IP addresses as part of a &%dnslists%&
33046 condition. Whereas
33047 .code
33048 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
33049 .endd
33050 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33051 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
33052 .code
33053 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
33054 .endd
33055 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
33056 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
33057 words, the result of the test is inverted if an exclamation mark appears before
33058 the &`=`& (or the &`&&`&) sign.
33059
33060 &*Note*&: This kind of negation is not the same as negation in a domain,
33061 host, or address list (which is why the syntax is different).
33062
33063 If you are using just one list, the negation syntax does not gain you much. The
33064 previous example is precisely equivalent to
33065 .code
33066 deny  dnslists = a.b.c
33067      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33068 .endd
33069 However, if you are using multiple lists, the negation syntax is clearer.
33070 Consider this example:
33071 .code
33072 deny  dnslists = sbl.spamhaus.org : \
33073                  list.dsbl.org : \
33074                  dnsbl.njabl.org!=127.0.0.3 : \
33075                  relays.ordb.org
33076 .endd
33077 Using only positive lists, this would have to be:
33078 .code
33079 deny  dnslists = sbl.spamhaus.org : \
33080                  list.dsbl.org
33081 deny  dnslists = dnsbl.njabl.org
33082      !dnslists = dnsbl.njabl.org=127.0.0.3
33083 deny  dnslists = relays.ordb.org
33084 .endd
33085 which is less clear, and harder to maintain.
33086
33087 Negation can also be used with a bitwise-and restriction.
33088 The dnslists condition with only be trus if a result is returned
33089 by the lookup which, anded with the restriction, is all zeroes.
33090 For example:
33091 .code
33092 deny dnslists = zen.spamhaus.org!&0.255.255.0
33093 .endd
33094
33095
33096
33097
33098 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33099 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33100 thereby providing more than one IP address. When an item in a &%dnslists%& list
33101 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33102 the match to specific results from the DNS lookup, there are two ways in which
33103 the checking can be handled. For example, consider the condition:
33104 .code
33105 dnslists = a.b.c=127.0.0.1
33106 .endd
33107 What happens if the DNS lookup for the incoming IP address yields both
33108 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33109 condition true because at least one given value was found, or is it false
33110 because at least one of the found values was not listed? And how does this
33111 affect negated conditions? Both possibilities are provided for with the help of
33112 additional separators &`==`& and &`=&&`&.
33113
33114 .ilist
33115 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33116 IP addresses matches one of the listed addresses. For the example above, the
33117 condition is true because 127.0.0.1 matches.
33118 .next
33119 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33120 looked up IP addresses matches one of the listed addresses. If the condition is
33121 changed to:
33122 .code
33123 dnslists = a.b.c==127.0.0.1
33124 .endd
33125 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33126 false because 127.0.0.2 is not listed. You would need to have:
33127 .code
33128 dnslists = a.b.c==127.0.0.1,127.0.0.2
33129 .endd
33130 for the condition to be true.
33131 .endlist
33132
33133 When &`!`& is used to negate IP address matching, it inverts the result, giving
33134 the precise opposite of the behaviour above. Thus:
33135 .ilist
33136 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33137 addresses matches one of the listed addresses. Consider:
33138 .code
33139 dnslists = a.b.c!&0.0.0.1
33140 .endd
33141 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33142 false because 127.0.0.1 matches.
33143 .next
33144 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33145 looked up IP address that does not match. Consider:
33146 .code
33147 dnslists = a.b.c!=&0.0.0.1
33148 .endd
33149 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33150 true, because 127.0.0.2 does not match. You would need to have:
33151 .code
33152 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33153 .endd
33154 for the condition to be false.
33155 .endlist
33156 When the DNS lookup yields only a single IP address, there is no difference
33157 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33158
33159
33160
33161
33162 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33163 .cindex "DNS list" "information from merged"
33164 When the facility for restricting the matching IP values in a DNS list is used,
33165 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33166 the true reason for rejection. This happens when lists are merged and the IP
33167 address in the A record is used to distinguish them; unfortunately there is
33168 only one TXT record. One way round this is not to use merged lists, but that
33169 can be inefficient because it requires multiple DNS lookups where one would do
33170 in the vast majority of cases when the host of interest is not on any of the
33171 lists.
33172
33173 A less inefficient way of solving this problem is available. If
33174 two domain names, comma-separated, are given, the second is used first to
33175 do an initial check, making use of any IP value restrictions that are set.
33176 If there is a match, the first domain is used, without any IP value
33177 restrictions, to get the TXT record. As a byproduct of this, there is also
33178 a check that the IP being tested is indeed on the first list. The first
33179 domain is the one that is put in &$dnslist_domain$&. For example:
33180 .code
33181 deny   dnslists = \
33182          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33183          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33184        message  = \
33185          rejected because $sender_host_address is blacklisted \
33186          at $dnslist_domain\n$dnslist_text
33187 .endd
33188 For the first blacklist item, this starts by doing a lookup in
33189 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33190 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33191 value, and as long as something is found, it looks for the corresponding TXT
33192 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33193 The second blacklist item is processed similarly.
33194
33195 If you are interested in more than one merged list, the same list must be
33196 given several times, but because the results of the DNS lookups are cached,
33197 the DNS calls themselves are not repeated. For example:
33198 .code
33199 deny dnslists = \
33200          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33201          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33202          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33203          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33204 .endd
33205 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33206 values matches (or if no record is found), this is the only lookup that is
33207 done. Only if there is a match is one of the more specific lists consulted.
33208
33209
33210
33211 .subsection "DNS lists and IPv6" SECTmorednslistslast
33212 .cindex "IPv6" "DNS black lists"
33213 .cindex "DNS list" "IPv6 usage"
33214 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33215 nibble by nibble. For example, if the calling host's IP address is
33216 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33217 .code
33218 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33219   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33220 .endd
33221 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33222 lists contain wildcard records, intended for IPv4, that interact badly with
33223 IPv6. For example, the DNS entry
33224 .code
33225 *.3.some.list.example.    A    127.0.0.1
33226 .endd
33227 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33228 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33229
33230 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33231 &%condition%& condition, as in this example:
33232 .code
33233 deny   condition = ${if isip4{$sender_host_address}}
33234        dnslists  = some.list.example
33235 .endd
33236
33237 If an explicit key is being used for a DNS lookup and it may be an IPv6
33238 address you should specify alternate list separators for both the outer
33239 (DNS list name) list and inner (lookup keys) list:
33240 .code
33241        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33242 .endd
33243
33244
33245 .section "Previously seen user and hosts" "SECTseen"
33246 .cindex "&%seen%& ACL condition"
33247 .cindex greylisting
33248 The &%seen%& ACL condition can be used to test whether a
33249 situation has been previously met.
33250 It uses a hints database to record a timestamp against a key.
33251 The syntax of the condition is:
33252 .display
33253 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33254 .endd
33255
33256 For example,
33257 .code
33258 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33259 .endd
33260 in a RCPT ACL will implement simple greylisting.
33261
33262 The parameters for the condition are
33263 a possible minus sign,
33264 then an interval,
33265 then, slash-separated, a list of options.
33266 The interval is taken as an offset before the current time,
33267 and used for the test.
33268 If the interval is preceded by a minus sign then the condition returns
33269 whether a record is found which is before the test time.
33270 Otherwise, the condition returns whether one is found which is since the
33271 test time.
33272
33273 Options are read in order with later ones overriding earlier ones.
33274
33275 The default key is &$sender_host_address$&.
33276 An explicit key can be set using a &%key=value%& option.
33277
33278 If a &%readonly%& option is given then
33279 no record create or update is done.
33280 If a &%write%& option is given then
33281 a record create or update is always done.
33282 An update is done if the test is for &"since"&.
33283 If none of those hold and there was no existing record,
33284 a record is created.
33285
33286 Creates and updates are marked with the current time.
33287
33288 Finally, a &"before"& test which succeeds, and for which the record
33289 is old enough, will be refreshed with a timestamp of the test time.
33290 This can prevent tidying of the database from removing the entry.
33291 The interval for this is, by default, 10 days.
33292 An explicit interval can be set using a
33293 &%refresh=value%& option.
33294
33295 Note that &"seen"& should be added to the list of hints databases
33296 for maintenance if this ACL condition is used.
33297
33298
33299 .section "Rate limiting incoming messages" "SECTratelimiting"
33300 .cindex "rate limiting" "client sending"
33301 .cindex "limiting client sending rates"
33302 .oindex "&%smtp_ratelimit_*%&"
33303 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33304 which clients can send email. This is more powerful than the
33305 &%smtp_ratelimit_*%& options, because those options control the rate of
33306 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33307 works across all connections (concurrent and sequential) from the same client
33308 host. The syntax of the &%ratelimit%& condition is:
33309 .display
33310 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33311 .endd
33312 If the average client sending rate is less than &'m'& messages per time
33313 period &'p'& then the condition is false; otherwise it is true.
33314
33315 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33316 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33317 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33318 of &'p'&.
33319
33320 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33321 time interval, for example, &`8h`& for eight hours. A larger time constant
33322 means that it takes Exim longer to forget a client's past behaviour. The
33323 parameter &'m'& is the maximum number of messages that a client is permitted to
33324 send in each time interval. It also specifies the number of messages permitted
33325 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33326 constant, you can allow a client to send more messages in a burst without
33327 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33328 both small, messages must be sent at an even rate.
33329
33330 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33331 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33332 when deploying the &%ratelimit%& ACL condition. The script prints usage
33333 instructions when it is run with no arguments.
33334
33335 The key is used to look up the data for calculating the client's average
33336 sending rate. This data is stored in Exim's spool directory, alongside the
33337 retry and other hints databases. The default key is &$sender_host_address$&,
33338 which means Exim computes the sending rate of each client host IP address.
33339 By changing the key you can change how Exim identifies clients for the purpose
33340 of ratelimiting. For example, to limit the sending rate of each authenticated
33341 user, independent of the computer they are sending from, set the key to
33342 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33343 example, &$authenticated_id$& is only meaningful if the client has
33344 authenticated (which you can check with the &%authenticated%& ACL condition).
33345
33346 The lookup key does not have to identify clients: If you want to limit the
33347 rate at which a recipient receives messages, you can use the key
33348 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33349 ACL.
33350
33351 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33352 specifies what Exim measures the rate of, for example, messages or recipients
33353 or bytes. You can adjust the measurement using the &%unique=%& and/or
33354 &%count=%& options. You can also control when Exim updates the recorded rate
33355 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33356 separated by a slash, like the other parameters. They may appear in any order.
33357
33358 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33359 any options that alter the meaning of the stored data. The limit &'m'& is not
33360 stored, so you can alter the configured maximum rate and Exim will still
33361 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33362 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33363 behaviour. The lookup key is not affected by changes to the update mode and
33364 the &%count=%& option.
33365
33366
33367 .subsection "Ratelimit options for what is being measured" ratoptmea
33368 .cindex "rate limiting" "per_* options"
33369 .vlist
33370 .vitem per_conn
33371 .cindex "rate limiting" per_conn
33372 This option limits the client's connection rate. It is not
33373 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33374 &%acl_not_smtp_start%& ACLs.
33375
33376 .vitem per_mail
33377 .cindex "rate limiting" per_conn
33378 This option limits the client's rate of sending messages. This is
33379 the default if none of the &%per_*%& options is specified. It can be used in
33380 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33381 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33382
33383 .vitem per_byte
33384 .cindex "rate limiting" per_conn
33385 This option limits the sender's email bandwidth. It can be used in
33386 the same ACLs as the &%per_mail%& option, though it is best to use this option
33387 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33388 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33389 in its MAIL command, which may be inaccurate or completely missing. You can
33390 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33391 in kilobytes, megabytes, or gigabytes, respectively.
33392
33393 .vitem per_rcpt
33394 .cindex "rate limiting" per_rcpt
33395 This option causes Exim to limit the rate at which recipients are
33396 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33397 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33398 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33399 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33400 in either case the rate limiting engine will see a message with many
33401 recipients as a large high-speed burst.
33402
33403 .vitem per_addr
33404 .cindex "rate limiting" per_addr
33405 This option is like the &%per_rcpt%& option, except it counts the
33406 number of different recipients that the client has sent messages to in the
33407 last time period. That is, if the client repeatedly sends messages to the same
33408 recipient, its measured rate is not increased. This option can only be used in
33409 &%acl_smtp_rcpt%&.
33410
33411 .vitem per_cmd
33412 .cindex "rate limiting" per_cmd
33413 This option causes Exim to recompute the rate every time the
33414 condition is processed. This can be used to limit the rate of any SMTP
33415 command. If it is used in multiple ACLs it can limit the aggregate rate of
33416 multiple different commands.
33417
33418 .vitem count
33419 .cindex "rate limiting" count
33420 This option can be used to alter how much Exim adds to the client's
33421 measured rate.
33422 A value is required, after an equals sign.
33423 For example, the &%per_byte%& option is equivalent to
33424 &`per_mail/count=$message_size`&.
33425 If there is no &%count=%& option, Exim
33426 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33427 other than &%acl_smtp_rcpt%&).
33428 The count does not have to be an integer.
33429
33430 .vitem unique
33431 .cindex "rate limiting" unique
33432 This option is described in section &<<ratoptuniq>>& below.
33433 .endlist
33434
33435
33436 .subsection "Ratelimit update modes" ratoptupd
33437 .cindex "rate limiting" "reading data without updating"
33438 You can specify one of three options with the &%ratelimit%& condition to
33439 control when its database is updated. This section describes the &%readonly%&
33440 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33441
33442 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33443 previously-computed rate to check against the limit.
33444
33445 For example, you can test the client's sending rate and deny it access (when
33446 it is too fast) in the connect ACL. If the client passes this check then it
33447 can go on to send a message, in which case its recorded rate will be updated
33448 in the MAIL ACL. Subsequent connections from the same client will check this
33449 new rate.
33450 .code
33451 acl_check_connect:
33452  deny ratelimit = 100 / 5m / readonly
33453       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33454                   (max $sender_rate_limit)
33455 # ...
33456 acl_check_mail:
33457  warn ratelimit = 100 / 5m / strict
33458       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33459                   (max $sender_rate_limit)
33460 .endd
33461
33462 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33463 processing a message then it may increase the client's measured rate more than
33464 it should. For example, this will happen if you check the &%per_rcpt%& option
33465 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33466 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33467 multiple update problems by using the &%readonly%& option on later ratelimit
33468 checks.
33469
33470 The &%per_*%& options described above do not make sense in some ACLs. If you
33471 use a &%per_*%& option in an ACL where it is not normally permitted then the
33472 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33473 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33474 next section) so you must specify the &%readonly%& option explicitly.
33475
33476
33477 .subsection "Ratelimit options for handling fast clients" ratoptfast
33478 .cindex "rate limiting" "strict and leaky modes"
33479 If a client's average rate is greater than the maximum, the rate limiting
33480 engine can react in two possible ways, depending on the presence of the
33481 &%strict%& or &%leaky%& update modes. This is independent of the other
33482 counter-measures (such as rejecting the message) that may be specified by the
33483 rest of the ACL.
33484
33485 The &%leaky%& (default) option means that the client's recorded rate is not
33486 updated if it is above the limit. The effect of this is that Exim measures the
33487 client's average rate of successfully sent email,
33488 up to the given limit.
33489 This is appropriate if the countermeasure when the condition is true
33490 consists of refusing the message, and
33491 is generally the better choice if you have clients that retry automatically.
33492 If the action when true is anything more complex then this option is
33493 likely not what is wanted.
33494
33495 The &%strict%& option means that the client's recorded rate is always
33496 updated. The effect of this is that Exim measures the client's average rate
33497 of attempts to send email, which can be much higher than the maximum it is
33498 actually allowed. If the client is over the limit it may be subjected to
33499 counter-measures by the ACL. It must slow down and allow sufficient time to
33500 pass that its computed rate falls below the maximum before it can send email
33501 again. The time (the number of smoothing periods) it must wait and not
33502 attempt to send mail can be calculated with this formula:
33503 .code
33504         ln(peakrate/maxrate)
33505 .endd
33506
33507
33508 .subsection "Limiting the rate of different events" ratoptuniq
33509 .cindex "rate limiting" "counting unique events"
33510 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33511 rate of different events. For example, the &%per_addr%& option uses this
33512 mechanism to count the number of different recipients that the client has
33513 sent messages to in the last time period; it is equivalent to
33514 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33515 measure the rate that a client uses different sender addresses with the
33516 options &`per_mail/unique=$sender_address`&.
33517
33518 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33519 has seen for that key. The whole set is thrown away when it is older than the
33520 rate smoothing period &'p'&, so each different event is counted at most once
33521 per period. In the &%leaky%& update mode, an event that causes the client to
33522 go over the limit is not added to the set, in the same way that the client's
33523 recorded rate is not updated in the same situation.
33524
33525 When you combine the &%unique=%& and &%readonly%& options, the specific
33526 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33527 rate.
33528
33529 The &%unique=%& mechanism needs more space in the ratelimit database than the
33530 other &%ratelimit%& options in order to store the event set. The number of
33531 unique values is potentially as large as the rate limit, so the extra space
33532 required increases with larger limits.
33533
33534 The uniqueification is not perfect: there is a small probability that Exim
33535 will think a new event has happened before. If the sender's rate is less than
33536 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33537 the measured rate can go above the limit, in which case Exim may under-count
33538 events by a significant margin. Fortunately, if the rate is high enough (2.7
33539 times the limit) that the false positive rate goes above 9%, then Exim will
33540 throw away the over-full event set before the measured rate falls below the
33541 limit. Therefore the only harm should be that exceptionally high sending rates
33542 are logged incorrectly; any countermeasures you configure will be as effective
33543 as intended.
33544
33545
33546 .subsection "Using rate limiting" useratlim
33547 Exim's other ACL facilities are used to define what counter-measures are taken
33548 when the rate limit is exceeded. This might be anything from logging a warning
33549 (for example, while measuring existing sending rates in order to define
33550 policy), through time delays to slow down fast senders, up to rejecting the
33551 message. For example:
33552 .code
33553 # Log all senders' rates
33554 warn ratelimit = 0 / 1h / strict
33555      log_message = Sender rate $sender_rate / $sender_rate_period
33556
33557 # Slow down fast senders; note the need to truncate $sender_rate
33558 # at the decimal point.
33559 warn ratelimit = 100 / 1h / per_rcpt / strict
33560      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33561                    $sender_rate_limit }s
33562
33563 # Keep authenticated users under control
33564 deny authenticated = *
33565      ratelimit = 100 / 1d / strict / $authenticated_id
33566
33567 # System-wide rate limit
33568 defer ratelimit = 10 / 1s / $primary_hostname
33569       message = Sorry, too busy. Try again later.
33570
33571 # Restrict incoming rate from each host, with a default
33572 # set using a macro and special cases looked up in a table.
33573 defer ratelimit = ${lookup {$sender_host_address} \
33574                    cdb {DB/ratelimits.cdb} \
33575                    {$value} {RATELIMIT} }
33576       message = Sender rate exceeds $sender_rate_limit \
33577                messages per $sender_rate_period
33578 .endd
33579 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33580 especially with the &%per_rcpt%& option, you may suffer from a performance
33581 bottleneck caused by locking on the ratelimit hints database. Apart from
33582 making your ACLs less complicated, you can reduce the problem by using a
33583 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33584 this means that Exim will lose its hints data after a reboot (including retry
33585 hints, the callout cache, and ratelimit data).
33586
33587
33588
33589 .section "Address verification" "SECTaddressverification"
33590 .cindex "verifying address" "options for"
33591 .cindex "policy control" "address verification"
33592 Several of the &%verify%& conditions described in section
33593 &<<SECTaclconditions>>& cause addresses to be verified. Section
33594 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33595 The verification conditions can be followed by options that modify the
33596 verification process. The options are separated from the keyword and from each
33597 other by slashes, and some of them contain parameters. For example:
33598 .code
33599 verify = sender/callout
33600 verify = recipient/defer_ok/callout=10s,defer_ok
33601 .endd
33602 The first stage of address verification, which always happens, is to run the
33603 address through the routers, in &"verify mode"&. Routers can detect the
33604 difference between verification and routing for delivery, and their actions can
33605 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33606 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33607 The available options are as follows:
33608
33609 .ilist
33610 If the &%callout%& option is specified, successful routing to one or more
33611 remote hosts is followed by a &"callout"& to those hosts as an additional
33612 check. Callouts and their sub-options are discussed in the next section.
33613 .next
33614 If there is a defer error while doing verification routing, the ACL
33615 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33616 options, the condition is forced to be true instead. Note that this is a main
33617 verification option as well as a suboption for callouts.
33618 .next
33619 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33620 discusses the reporting of sender address verification failures.
33621 .next
33622 The &%success_on_redirect%& option causes verification always to succeed
33623 immediately after a successful redirection. By default, if a redirection
33624 generates just one address, that address is also verified. See further
33625 discussion in section &<<SECTredirwhilveri>>&.
33626 .next
33627 If the &%quota%& option is specified for recipient verify,
33628 successful routing to an appendfile transport is followed by a call into
33629 the transport to evaluate the quota status for the recipient.
33630 No actual delivery is done, but verification will succeed if the quota
33631 is sufficient for the message (if the sender gave a message size) or
33632 not already exceeded (otherwise).
33633 .endlist
33634
33635 .cindex "verifying address" "differentiating failures"
33636 .vindex "&$recipient_verify_failure$&"
33637 .vindex "&$sender_verify_failure$&"
33638 .vindex "&$acl_verify_message$&"
33639 After an address verification failure, &$acl_verify_message$& contains the
33640 error message that is associated with the failure. It can be preserved by
33641 coding like this:
33642 .code
33643 warn  !verify = sender
33644        set acl_m0 = $acl_verify_message
33645 .endd
33646 If you are writing your own custom rejection message or log message when
33647 denying access, you can use this variable to include information about the
33648 verification failure.
33649 This variable is cleared at the end of processing the ACL verb.
33650
33651 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33652 appropriate) contains one of the following words:
33653
33654 .ilist
33655 &%qualify%&: The address was unqualified (no domain), and the message
33656 was neither local nor came from an exempted host.
33657 .next
33658 &%route%&: Routing failed.
33659 .next
33660 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33661 occurred at or before the MAIL command (that is, on initial
33662 connection, HELO, or MAIL).
33663 .next
33664 &%recipient%&: The RCPT command in a callout was rejected.
33665 .next
33666 &%postmaster%&: The postmaster check in a callout was rejected.
33667 .next
33668 &%quota%&: The quota check for a local recipient did non pass.
33669 .endlist
33670
33671 The main use of these variables is expected to be to distinguish between
33672 rejections of MAIL and rejections of RCPT in callouts.
33673
33674 The above variables may also be set after a &*successful*&
33675 address verification to:
33676
33677 .ilist
33678 &%random%&: A random local-part callout succeeded
33679 .endlist
33680
33681
33682
33683
33684 .section "Callout verification" "SECTcallver"
33685 .cindex "verifying address" "by callout"
33686 .cindex "callout" "verification"
33687 .cindex "SMTP" "callout verification"
33688 For non-local addresses, routing verifies the domain, but is unable to do any
33689 checking of the local part. There are situations where some means of verifying
33690 the local part is desirable. One way this can be done is to make an SMTP
33691 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33692 a subsequent host for a recipient address, to see if the host accepts the
33693 address. We use the term &'callout'& to cover both cases. Note that for a
33694 sender address, the callback is not to the client host that is trying to
33695 deliver the message, but to one of the hosts that accepts incoming mail for the
33696 sender's domain.
33697
33698 Exim does not do callouts by default. If you want them to happen, you must
33699 request them by setting appropriate options on the &%verify%& condition, as
33700 described below. This facility should be used with care, because it can add a
33701 lot of resource usage to the cost of verifying an address. However, Exim does
33702 cache the results of callouts, which helps to reduce the cost. Details of
33703 caching are in section &<<SECTcallvercache>>&.
33704
33705 Recipient callouts are usually used only between hosts that are controlled by
33706 the same administration. For example, a corporate gateway host could use
33707 callouts to check for valid recipients on an internal mailserver. A successful
33708 callout does not guarantee that a real delivery to the address would succeed;
33709 on the other hand, a failing callout does guarantee that a delivery would fail.
33710
33711 If the &%callout%& option is present on a condition that verifies an address, a
33712 second stage of verification occurs if the address is successfully routed to
33713 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33714 &(manualroute)& router, where the router specifies the hosts. However, if a
33715 router that does not set up hosts routes to an &(smtp)& transport with a
33716 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33717 &%hosts_override%& set, its hosts are always used, whether or not the router
33718 supplies a host list.
33719 Callouts are only supported on &(smtp)& transports.
33720
33721 The port that is used is taken from the transport, if it is specified and is a
33722 remote transport. (For routers that do verification only, no transport need be
33723 specified.) Otherwise, the default SMTP port is used. If a remote transport
33724 specifies an outgoing interface, this is used; otherwise the interface is not
33725 specified. Likewise, the text that is used for the HELO command is taken from
33726 the transport's &%helo_data%& option; if there is no transport, the value of
33727 &$smtp_active_hostname$& is used.
33728
33729 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33730 test whether a bounce message could be delivered to the sender address. The
33731 following SMTP commands are sent:
33732 .display
33733 &`HELO `&<&'local host name'&>
33734 &`MAIL FROM:<>`&
33735 &`RCPT TO:`&<&'the address to be tested'&>
33736 &`QUIT`&
33737 .endd
33738 LHLO is used instead of HELO if the transport's &%protocol%& option is
33739 set to &"lmtp"&.
33740
33741 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33742 settings.
33743
33744 A recipient callout check is similar. By default, it also uses an empty address
33745 for the sender. This default is chosen because most hosts do not make use of
33746 the sender address when verifying a recipient. Using the same address means
33747 that a single cache entry can be used for each recipient. Some sites, however,
33748 do make use of the sender address when verifying. These are catered for by the
33749 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33750
33751 If the response to the RCPT command is a 2&'xx'& code, the verification
33752 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33753 Exim tries the next host, if any. If there is a problem with all the remote
33754 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33755 &%callout%& option is given, in which case the condition is forced to succeed.
33756
33757 .cindex "SMTP" "output flushing, disabling for callout"
33758 A callout may take a little time. For this reason, Exim normally flushes SMTP
33759 output before performing a callout in an ACL, to avoid unexpected timeouts in
33760 clients when the SMTP PIPELINING extension is in use. The flushing can be
33761 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33762
33763 .cindex "tainted data" "de-tainting"
33764 .cindex "de-tainting" "using recipient verify"
33765 A recipient callout which gets a 2&'xx'& code
33766 will assign untainted values to the
33767 &$domain_data$& and &$local_part_data$& variables,
33768 corresponding to the domain and local parts of the recipient address.
33769
33770
33771
33772
33773 .subsection "Additional parameters for callouts" CALLaddparcall
33774 .cindex "callout" "additional parameters for"
33775 The &%callout%& option can be followed by an equals sign and a number of
33776 optional parameters, separated by commas. For example:
33777 .code
33778 verify = recipient/callout=10s,defer_ok
33779 .endd
33780 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33781 separate verify options, is retained for backwards compatibility, but is now
33782 deprecated. The additional parameters for &%callout%& are as follows:
33783
33784
33785 .vlist
33786 .vitem <&'a&~time&~interval'&>
33787 .cindex "callout" "timeout, specifying"
33788 This specifies the timeout that applies for the callout attempt to each host.
33789 For example:
33790 .code
33791 verify = sender/callout=5s
33792 .endd
33793 The default is 30 seconds. The timeout is used for each response from the
33794 remote host. It is also used for the initial connection, unless overridden by
33795 the &%connect%& parameter.
33796
33797
33798 .vitem &*connect&~=&~*&<&'time&~interval'&>
33799 .cindex "callout" "connection timeout, specifying"
33800 This parameter makes it possible to set a different (usually smaller) timeout
33801 for making the SMTP connection. For example:
33802 .code
33803 verify = sender/callout=5s,connect=1s
33804 .endd
33805 If not specified, this timeout defaults to the general timeout value.
33806
33807 .vitem &*defer_ok*&
33808 .cindex "callout" "defer, action on"
33809 When this parameter is present, failure to contact any host, or any other kind
33810 of temporary error, is treated as success by the ACL. However, the cache is not
33811 updated in this circumstance.
33812
33813 .vitem &*fullpostmaster*&
33814 .cindex "callout" "full postmaster check"
33815 This operates like the &%postmaster%& option (see below), but if the check for
33816 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33817 accordance with the specification in RFC 2821. The RFC states that the
33818 unqualified address &'postmaster'& should be accepted.
33819
33820
33821 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33822 .cindex "callout" "sender when verifying header"
33823 When verifying addresses in header lines using the &%header_sender%&
33824 verification option, Exim behaves by default as if the addresses are envelope
33825 sender addresses from a message. Callout verification therefore tests to see
33826 whether a bounce message could be delivered, by using an empty address in the
33827 MAIL command. However, it is arguable that these addresses might never be used
33828 as envelope senders, and could therefore justifiably reject bounce messages
33829 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33830 address to use in the MAIL command. For example:
33831 .code
33832 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33833 .endd
33834 This parameter is available only for the &%header_sender%& verification option.
33835
33836
33837 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33838 .cindex "callout" "overall timeout, specifying"
33839 This parameter sets an overall timeout for performing a callout verification.
33840 For example:
33841 .code
33842 verify = sender/callout=5s,maxwait=30s
33843 .endd
33844 This timeout defaults to four times the callout timeout for individual SMTP
33845 commands. The overall timeout applies when there is more than one host that can
33846 be tried. The timeout is checked before trying the next host. This prevents
33847 very long delays if there are a large number of hosts and all are timing out
33848 (for example, when network connections are timing out).
33849
33850
33851 .vitem &*no_cache*&
33852 .cindex "callout" "cache, suppressing"
33853 .cindex "caching callout, suppressing"
33854 When this parameter is given, the callout cache is neither read nor updated.
33855
33856 .vitem &*postmaster*&
33857 .cindex "callout" "postmaster; checking"
33858 When this parameter is set, a successful callout check is followed by a similar
33859 check for the local part &'postmaster'& at the same domain. If this address is
33860 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33861 the postmaster check is recorded in a cache record; if it is a failure, this is
33862 used to fail subsequent callouts for the domain without a connection being
33863 made, until the cache record expires.
33864
33865 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33866 The postmaster check uses an empty sender in the MAIL command by default.
33867 You can use this parameter to do a postmaster check using a different address.
33868 For example:
33869 .code
33870 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33871 .endd
33872 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33873 one overrides. The &%postmaster%& parameter is equivalent to this example:
33874 .code
33875 require  verify = sender/callout=postmaster_mailfrom=
33876 .endd
33877 &*Warning*&: The caching arrangements for postmaster checking do not take
33878 account of the sender address. It is assumed that either the empty address or
33879 a fixed non-empty address will be used. All that Exim remembers is that the
33880 postmaster check for the domain succeeded or failed.
33881
33882
33883 .vitem &*random*&
33884 .cindex "callout" "&""random""& check"
33885 When this parameter is set, before doing the normal callout check, Exim does a
33886 check for a &"random"& local part at the same domain. The local part is not
33887 really random &-- it is defined by the expansion of the option
33888 &%callout_random_local_part%&, which defaults to
33889 .code
33890 $primary_hostname-$tod_epoch-testing
33891 .endd
33892 The idea here is to try to determine whether the remote host accepts all local
33893 parts without checking. If it does, there is no point in doing callouts for
33894 specific local parts. If the &"random"& check succeeds, the result is saved in
33895 a cache record, and used to force the current and subsequent callout checks to
33896 succeed without a connection being made, until the cache record expires.
33897
33898 .vitem &*use_postmaster*&
33899 .cindex "callout" "sender for recipient check"
33900 This parameter applies to recipient callouts only. For example:
33901 .code
33902 deny  !verify = recipient/callout=use_postmaster
33903 .endd
33904 .vindex "&$qualify_domain$&"
33905 It causes a non-empty postmaster address to be used in the MAIL command when
33906 performing the callout for the recipient, and also for a &"random"& check if
33907 that is configured. The local part of the address is &`postmaster`& and the
33908 domain is the contents of &$qualify_domain$&.
33909
33910 .vitem &*use_sender*&
33911 This option applies to recipient callouts only. For example:
33912 .code
33913 require  verify = recipient/callout=use_sender
33914 .endd
33915 It causes the message's actual sender address to be used in the MAIL
33916 command when performing the callout, instead of an empty address. There is no
33917 need to use this option unless you know that the called hosts make use of the
33918 sender when checking recipients. If used indiscriminately, it reduces the
33919 usefulness of callout caching.
33920
33921 .vitem &*hold*&
33922 This option applies to recipient callouts only. For example:
33923 .code
33924 require  verify = recipient/callout=use_sender,hold
33925 .endd
33926 It causes the connection to be held open and used for any further recipients
33927 and for eventual delivery (should that be done quickly).
33928 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33929 when that is used for the connections.
33930 The advantage is only gained if there are no callout cache hits
33931 (which could be enforced by the no_cache option),
33932 if the use_sender option is used,
33933 if neither the random nor the use_postmaster option is used,
33934 and if no other callouts intervene.
33935 .endlist
33936
33937 If you use any of the parameters that set a non-empty sender for the MAIL
33938 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33939 &%use_sender%&), you should think about possible loops. Recipient checking is
33940 usually done between two hosts that are under the same management, and the host
33941 that receives the callouts is not normally configured to do callouts itself.
33942 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33943 these circumstances.
33944
33945 However, if you use a non-empty sender address for a callout to an arbitrary
33946 host, there is the likelihood that the remote host will itself initiate a
33947 callout check back to your host. As it is checking what appears to be a message
33948 sender, it is likely to use an empty address in MAIL, thus avoiding a
33949 callout loop. However, to be on the safe side it would be best to set up your
33950 own ACLs so that they do not do sender verification checks when the recipient
33951 is the address you use for header sender or postmaster callout checking.
33952
33953 Another issue to think about when using non-empty senders for callouts is
33954 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33955 by the sender/recipient combination; thus, for any given recipient, many more
33956 actual callouts are performed than when an empty sender or postmaster is used.
33957
33958
33959
33960
33961 .subsection "Callout caching" SECTcallvercache
33962 .cindex "hints database" "callout cache"
33963 .cindex "callout" "cache, description of"
33964 .cindex "caching" "callout"
33965 Exim caches the results of callouts in order to reduce the amount of resources
33966 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33967 option. A hints database called &"callout"& is used for the cache. Two
33968 different record types are used: one records the result of a callout check for
33969 a specific address, and the other records information that applies to the
33970 entire domain (for example, that it accepts the local part &'postmaster'&).
33971
33972 When an original callout fails, a detailed SMTP error message is given about
33973 the failure. However, for subsequent failures that use the cache data, this message
33974 is not available.
33975
33976 The expiry times for negative and positive address cache records are
33977 independent, and can be set by the global options &%callout_negative_expire%&
33978 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33979
33980 If a host gives a negative response to an SMTP connection, or rejects any
33981 commands up to and including
33982 .code
33983 MAIL FROM:<>
33984 .endd
33985 (but not including the MAIL command with a non-empty address),
33986 any callout attempt is bound to fail. Exim remembers such failures in a
33987 domain cache record, which it uses to fail callouts for the domain without
33988 making new connections, until the domain record times out. There are two
33989 separate expiry times for domain cache records:
33990 &%callout_domain_negative_expire%& (default 3h) and
33991 &%callout_domain_positive_expire%& (default 7d).
33992
33993 Domain records expire when the negative expiry time is reached if callouts
33994 cannot be made for the domain, or if the postmaster check failed.
33995 Otherwise, they expire when the positive expiry time is reached. This
33996 ensures that, for example, a host that stops accepting &"random"& local parts
33997 will eventually be noticed.
33998
33999 The callout caching mechanism is based on the domain of the address that is
34000 being tested. If the domain routes to several hosts, it is assumed that their
34001 behaviour will be the same.
34002
34003
34004
34005 .section "Quota caching" "SECTquotacache"
34006 .cindex "hints database" "quota cache"
34007 .cindex "quota" "cache, description of"
34008 .cindex "caching" "quota"
34009 Exim caches the results of quota verification
34010 in order to reduce the amount of resources used.
34011 The &"callout"& hints database is used.
34012
34013 The default cache periods are five minutes for a positive (good) result
34014 and one hour for a negative result.
34015 To change the periods the &%quota%& option can be followed by an equals sign
34016 and a number of optional paramemters, separated by commas.
34017 For example:
34018 .code
34019 verify = recipient/quota=cachepos=1h,cacheneg=1d
34020 .endd
34021 Possible parameters are:
34022 .vlist
34023 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
34024 .cindex "quota cache" "positive entry expiry, specifying"
34025 Set the lifetime for a positive cache entry.
34026 A value of zero seconds is legitimate.
34027
34028 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
34029 .cindex "quota cache" "negative entry expiry, specifying"
34030 As above, for a negative entry.
34031
34032 .vitem &*no_cache*&
34033 Set both positive and negative lifetimes to zero.
34034
34035 .section "Sender address verification reporting" "SECTsenaddver"
34036 .cindex "verifying" "suppressing error details"
34037 See section &<<SECTaddressverification>>& for a general discussion of
34038 verification. When sender verification fails in an ACL, the details of the
34039 failure are given as additional output lines before the 550 response to the
34040 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
34041 you might see:
34042 .code
34043 MAIL FROM:<xyz@abc.example>
34044 250 OK
34045 RCPT TO:<pqr@def.example>
34046 550-Verification failed for <xyz@abc.example>
34047 550-Called:   192.168.34.43
34048 550-Sent:     RCPT TO:<xyz@abc.example>
34049 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
34050 550 Sender verification failed
34051 .endd
34052 If more than one RCPT command fails in the same way, the details are given
34053 only for the first of them. However, some administrators do not want to send
34054 out this much information. You can suppress the details by adding
34055 &`/no_details`& to the ACL statement that requests sender verification. For
34056 example:
34057 .code
34058 verify = sender/no_details
34059 .endd
34060
34061 .section "Redirection while verifying" "SECTredirwhilveri"
34062 .cindex "verifying" "redirection while"
34063 .cindex "address redirection" "while verifying"
34064 A dilemma arises when a local address is redirected by aliasing or forwarding
34065 during verification: should the generated addresses themselves be verified,
34066 or should the successful expansion of the original address be enough to verify
34067 it? By default, Exim takes the following pragmatic approach:
34068
34069 .ilist
34070 When an incoming address is redirected to just one child address, verification
34071 continues with the child address, and if that fails to verify, the original
34072 verification also fails.
34073 .next
34074 When an incoming address is redirected to more than one child address,
34075 verification does not continue. A success result is returned.
34076 .endlist
34077
34078 This seems the most reasonable behaviour for the common use of aliasing as a
34079 way of redirecting different local parts to the same mailbox. It means, for
34080 example, that a pair of alias entries of the form
34081 .code
34082 A.Wol:   aw123
34083 aw123:   :fail: Gone away, no forwarding address
34084 .endd
34085 work as expected, with both local parts causing verification failure. When a
34086 redirection generates more than one address, the behaviour is more like a
34087 mailing list, where the existence of the alias itself is sufficient for
34088 verification to succeed.
34089
34090 It is possible, however, to change the default behaviour so that all successful
34091 redirections count as successful verifications, however many new addresses are
34092 generated. This is specified by the &%success_on_redirect%& verification
34093 option. For example:
34094 .code
34095 require verify = recipient/success_on_redirect/callout=10s
34096 .endd
34097 In this example, verification succeeds if a router generates a new address, and
34098 the callout does not occur, because no address was routed to a remote host.
34099
34100 When verification is being tested via the &%-bv%& option, the treatment of
34101 redirections is as just described, unless the &%-v%& or any debugging option is
34102 also specified. In that case, full verification is done for every generated
34103 address and a report is output for each of them.
34104
34105
34106
34107 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34108 .cindex "CSA" "verifying"
34109 Client SMTP Authorization is a system that allows a site to advertise
34110 which machines are and are not permitted to send email. This is done by placing
34111 special SRV records in the DNS; these are looked up using the client's HELO
34112 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34113 Authorization checks in Exim are performed by the ACL condition:
34114 .code
34115 verify = csa
34116 .endd
34117 This fails if the client is not authorized. If there is a DNS problem, or if no
34118 valid CSA SRV record is found, or if the client is authorized, the condition
34119 succeeds. These three cases can be distinguished using the expansion variable
34120 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34121 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34122 be likely to cause problems for legitimate email.
34123
34124 The error messages produced by the CSA code include slightly more
34125 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34126 looking up the CSA SRV record, or problems looking up the CSA target
34127 address record. There are four reasons for &$csa_status$& being &"fail"&:
34128
34129 .ilist
34130 The client's host name is explicitly not authorized.
34131 .next
34132 The client's IP address does not match any of the CSA target IP addresses.
34133 .next
34134 The client's host name is authorized but it has no valid target IP addresses
34135 (for example, the target's addresses are IPv6 and the client is using IPv4).
34136 .next
34137 The client's host name has no CSA SRV record but a parent domain has asserted
34138 that all subdomains must be explicitly authorized.
34139 .endlist
34140
34141 The &%csa%& verification condition can take an argument which is the domain to
34142 use for the DNS query. The default is:
34143 .code
34144 verify = csa/$sender_helo_name
34145 .endd
34146 This implementation includes an extension to CSA. If the query domain
34147 is an address literal such as [192.0.2.95], or if it is a bare IP
34148 address, Exim searches for CSA SRV records in the reverse DNS as if
34149 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34150 meaningful to say:
34151 .code
34152 verify = csa/$sender_host_address
34153 .endd
34154 In fact, this is the check that Exim performs if the client does not say HELO.
34155 This extension can be turned off by setting the main configuration option
34156 &%dns_csa_use_reverse%& to be false.
34157
34158 If a CSA SRV record is not found for the domain itself, a search
34159 is performed through its parent domains for a record which might be
34160 making assertions about subdomains. The maximum depth of this search is limited
34161 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34162 default. Exim does not look for CSA SRV records in a top level domain, so the
34163 default settings handle HELO domains as long as seven
34164 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34165 of legitimate HELO domains.
34166
34167 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34168 direct SRV lookups, this is not sufficient because of the extra parent domain
34169 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34170 addresses into lookups in the reverse DNS space. The result of a successful
34171 lookup such as:
34172 .code
34173 ${lookup dnsdb {csa=$sender_helo_name}}
34174 .endd
34175 has two space-separated fields: an authorization code and a target host name.
34176 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34177 authorization required but absent, or &"?"& for unknown.
34178
34179
34180
34181
34182 .section "Bounce address tag validation" "SECTverifyPRVS"
34183 .cindex "BATV, verifying"
34184 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34185 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34186 Genuine incoming bounce messages should therefore always be addressed to
34187 recipients that have a valid tag. This scheme is a way of detecting unwanted
34188 bounce messages caused by sender address forgeries (often called &"collateral
34189 spam"&), because the recipients of such messages do not include valid tags.
34190
34191 There are two expansion items to help with the implementation of the BATV
34192 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34193 the original envelope sender address by using a simple key to add a hash of the
34194 address and some time-based randomizing information. The &%prvs%& expansion
34195 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34196 The syntax of these expansion items is described in section
34197 &<<SECTexpansionitems>>&.
34198 The validity period on signed addresses is seven days.
34199
34200 As an example, suppose the secret per-address keys are stored in an MySQL
34201 database. A query to look up the key for an address could be defined as a macro
34202 like this:
34203 .code
34204 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34205                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34206                 }{$value}}
34207 .endd
34208 Suppose also that the senders who make use of BATV are defined by an address
34209 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34210 use this:
34211 .code
34212 # Bounces: drop unsigned addresses for BATV senders
34213 deny senders = :
34214      recipients = +batv_senders
34215      message = This address does not send an unsigned reverse path
34216
34217 # Bounces: In case of prvs-signed address, check signature.
34218 deny senders = :
34219      condition  = ${prvscheck {$local_part@$domain}\
34220                   {PRVSCHECK_SQL}{1}}
34221      !condition = $prvscheck_result
34222      message = Invalid reverse path signature.
34223 .endd
34224 The first statement rejects recipients for bounce messages that are addressed
34225 to plain BATV sender addresses, because it is known that BATV senders do not
34226 send out messages with plain sender addresses. The second statement rejects
34227 recipients that are prvs-signed, but with invalid signatures (either because
34228 the key is wrong, or the signature has timed out).
34229
34230 A non-prvs-signed address is not rejected by the second statement, because the
34231 &%prvscheck%& expansion yields an empty string if its first argument is not a
34232 prvs-signed address, thus causing the &%condition%& condition to be false. If
34233 the first argument is a syntactically valid prvs-signed address, the yield is
34234 the third string (in this case &"1"&), whether or not the cryptographic and
34235 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34236 of the checks (empty for failure, &"1"& for success).
34237
34238 There is one more issue you must consider when implementing prvs-signing:
34239 you have to ensure that the routers accept prvs-signed addresses and
34240 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34241 router to remove the signature with a configuration along these lines:
34242 .code
34243 batv_redirect:
34244   driver = redirect
34245   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34246 .endd
34247 This works because, if the third argument of &%prvscheck%& is empty, the result
34248 of the expansion of a prvs-signed address is the decoded value of the original
34249 address. This router should probably be the first of your routers that handles
34250 local addresses.
34251
34252 To create BATV-signed addresses in the first place, a transport of this form
34253 can be used:
34254 .code
34255 external_smtp_batv:
34256   driver = smtp
34257   return_path = ${prvs {$return_path} \
34258                        {${lookup mysql{SELECT \
34259                        secret FROM batv_prvs WHERE \
34260                        sender='${quote_mysql:$sender_address}'} \
34261                        {$value}fail}}}
34262 .endd
34263 If no key can be found for the existing return path, no signing takes place.
34264
34265
34266
34267 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34268 .cindex "&ACL;" "relay control"
34269 .cindex "relaying" "control by ACL"
34270 .cindex "policy control" "relay control"
34271 An MTA is said to &'relay'& a message if it receives it from some host and
34272 delivers it directly to another host as a result of a remote address contained
34273 within it. Redirecting a local address via an alias or forward file and then
34274 passing the message on to another host is not relaying,
34275 .cindex "&""percent hack""&"
34276 but a redirection as a result of the &"percent hack"& is.
34277
34278 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34279 A host which is acting as a gateway or an MX backup is concerned with incoming
34280 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34281 a host which is acting as a smart host for a number of clients is concerned
34282 with outgoing relaying from those clients to the Internet at large. Often the
34283 same host is fulfilling both functions,
34284 . ///
34285 . as illustrated in the diagram below,
34286 . ///
34287 but in principle these two kinds of relaying are entirely independent. What is
34288 not wanted is the transmission of mail from arbitrary remote hosts through your
34289 system to arbitrary domains.
34290
34291
34292 You can implement relay control by means of suitable statements in the ACL that
34293 runs for each RCPT command. For convenience, it is often easiest to use
34294 Exim's named list facility to define the domains and hosts involved. For
34295 example, suppose you want to do the following:
34296
34297 .ilist
34298 Deliver a number of domains to mailboxes on the local host (or process them
34299 locally in some other way). Let's say these are &'my.dom1.example'& and
34300 &'my.dom2.example'&.
34301 .next
34302 Relay mail for a number of other domains for which you are the secondary MX.
34303 These might be &'friend1.example'& and &'friend2.example'&.
34304 .next
34305 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34306 Suppose your LAN is 192.168.45.0/24.
34307 .endlist
34308
34309
34310 In the main part of the configuration, you put the following definitions:
34311 .code
34312 domainlist local_domains    = my.dom1.example : my.dom2.example
34313 domainlist relay_to_domains = friend1.example : friend2.example
34314 hostlist   relay_from_hosts = 192.168.45.0/24
34315 .endd
34316 Now you can use these definitions in the ACL that is run for every RCPT
34317 command:
34318 .code
34319 acl_check_rcpt:
34320   accept domains = +local_domains : +relay_to_domains
34321   accept hosts   = +relay_from_hosts
34322 .endd
34323 The first statement accepts any RCPT command that contains an address in
34324 the local or relay domains. For any other domain, control passes to the second
34325 statement, which accepts the command only if it comes from one of the relay
34326 hosts. In practice, you will probably want to make your ACL more sophisticated
34327 than this, for example, by including sender and recipient verification. The
34328 default configuration includes a more comprehensive example, which is described
34329 in chapter &<<CHAPdefconfil>>&.
34330
34331
34332
34333 .section "Checking a relay configuration" "SECTcheralcon"
34334 .cindex "relaying" "checking control of"
34335 You can check the relay characteristics of your configuration in the same way
34336 that you can test any ACL behaviour for an incoming SMTP connection, by using
34337 the &%-bh%& option to run a fake SMTP session with which you interact.
34338 .ecindex IIDacl
34339
34340
34341
34342 . ////////////////////////////////////////////////////////////////////////////
34343 . ////////////////////////////////////////////////////////////////////////////
34344
34345 .chapter "Content scanning at ACL time" "CHAPexiscan"
34346 .scindex IIDcosca "content scanning" "at ACL time"
34347 The extension of Exim to include content scanning at ACL time, formerly known
34348 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34349 was integrated into the main source for Exim release 4.50, and Tom continues to
34350 maintain it. Most of the wording of this chapter is taken from Tom's
34351 specification.
34352
34353 It is also possible to scan the content of messages at other times. The
34354 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34355 scanning after all the ACLs have run. A transport filter can be used to scan
34356 messages at delivery time (see the &%transport_filter%& option, described in
34357 chapter &<<CHAPtransportgeneric>>&).
34358
34359 If you want to include the ACL-time content-scanning features when you compile
34360 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34361 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34362
34363 .ilist
34364 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34365 for all MIME parts for SMTP and non-SMTP messages, respectively.
34366 .next
34367 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34368 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34369 run at the end of message reception (the &%acl_smtp_data%& ACL).
34370 .next
34371 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34372 of messages, or parts of messages, for debugging purposes.
34373 .next
34374 Additional expansion variables that are set in the new ACL and by the new
34375 conditions.
34376 .next
34377 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34378 .endlist
34379
34380 Content-scanning is continually evolving, and new features are still being
34381 added. While such features are still unstable and liable to incompatible
34382 changes, they are made available in Exim by setting options whose names begin
34383 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34384 this manual. You can find out about them by reading the file called
34385 &_doc/experimental.txt_&.
34386
34387 All the content-scanning facilities work on a MBOX copy of the message that is
34388 temporarily created in a file called:
34389 .display
34390 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34391 .endd
34392 The &_.eml_& extension is a friendly hint to virus scanners that they can
34393 expect an MBOX-like structure inside that file. The file is created when the
34394 first content scanning facility is called. Subsequent calls to content
34395 scanning conditions open the same file again. The directory is recursively
34396 removed when the &%acl_smtp_data%& ACL has finished running, unless
34397 .code
34398 control = no_mbox_unspool
34399 .endd
34400 has been encountered. When the MIME ACL decodes files, they are put into the
34401 same directory by default.
34402
34403
34404
34405 .section "Scanning for viruses" "SECTscanvirus"
34406 .cindex "virus scanning"
34407 .cindex "content scanning" "for viruses"
34408 .cindex "content scanning" "the &%malware%& condition"
34409 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34410 It supports a &"generic"& interface to scanners called via the shell, and
34411 specialized interfaces for &"daemon"& type virus scanners, which are resident
34412 in memory and thus are much faster.
34413
34414 Since message data needs to have arrived,
34415 the condition may be only called in ACL defined by
34416 &%acl_smtp_data%&,
34417 &%acl_smtp_data_prdr%&,
34418 &%acl_smtp_mime%& or
34419 &%acl_smtp_dkim%&
34420
34421 A timeout of 2 minutes is applied to a scanner call (by default);
34422 if it expires then a defer action is taken.
34423
34424 .oindex "&%av_scanner%&"
34425 You can set the &%av_scanner%& option in the main part of the configuration
34426 to specify which scanner to use, together with any additional options that
34427 are needed. The basic syntax is as follows:
34428 .display
34429 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34430 .endd
34431 If you do not set &%av_scanner%&, it defaults to
34432 .code
34433 av_scanner = sophie:/var/run/sophie
34434 .endd
34435 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34436 before use.
34437 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34438 The following scanner types are supported in this release,
34439 though individual ones can be included or not at build time:
34440
34441 .vlist
34442 .vitem &%avast%&
34443 .cindex "virus scanners" "avast"
34444 This is the scanner daemon of Avast. It has been tested with Avast Core
34445 Security (currently at version 2.2.0).
34446 You can get a trial version at &url(https://www.avast.com) or for Linux
34447 at &url(https://www.avast.com/linux-server-antivirus).
34448 This scanner type takes one option,
34449 which can be either a full path to a UNIX socket,
34450 or host and port specifiers separated by white space.
34451 The host may be a name or an IP address; the port is either a
34452 single number or a pair of numbers with a dash between.
34453 A list of options may follow. These options are interpreted on the
34454 Exim's side of the malware scanner, or are given on separate lines to
34455 the daemon as options before the main scan command.
34456
34457 .cindex &`pass_unscanned`& "avast"
34458 If &`pass_unscanned`&
34459 is set, any files the Avast scanner can't scan (e.g.
34460 decompression bombs, or invalid archives) are considered clean. Use with
34461 care.
34462
34463 For example:
34464 .code
34465 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34466 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34467 av_scanner = avast:192.168.2.22 5036
34468 .endd
34469 If you omit the argument, the default path
34470 &_/var/run/avast/scan.sock_&
34471 is used.
34472 If you use a remote host,
34473 you need to make Exim's spool directory available to it,
34474 as the scanner is passed a file path, not file contents.
34475 For information about available commands and their options you may use
34476 .code
34477 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34478     FLAGS
34479     SENSITIVITY
34480     PACK
34481 .endd
34482
34483 If the scanner returns a temporary failure (e.g. license issues, or
34484 permission problems), the message is deferred and a paniclog entry is
34485 written.  The usual &`defer_ok`& option is available.
34486
34487 .vitem &%aveserver%&
34488 .cindex "virus scanners" "Kaspersky"
34489 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34490 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34491 which is the path to the daemon's UNIX socket. The default is shown in this
34492 example:
34493 .code
34494 av_scanner = aveserver:/var/run/aveserver
34495 .endd
34496
34497
34498 .vitem &%clamd%&
34499 .cindex "virus scanners" "clamd"
34500 This daemon-type scanner is GPL and free. You can get it at
34501 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34502 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34503 in the MIME ACL. This is no longer believed to be necessary.
34504
34505 The options are a list of server specifiers, which may be
34506 a UNIX socket specification,
34507 a TCP socket specification,
34508 or a (global) option.
34509
34510 A socket specification consists of a space-separated list.
34511 For a Unix socket the first element is a full path for the socket,
34512 for a TCP socket the first element is the IP address
34513 and the second a port number,
34514 Any further elements are per-server (non-global) options.
34515 These per-server options are supported:
34516 .code
34517 retry=<timespec>        Retry on connect fail
34518 .endd
34519
34520 The &`retry`& option specifies a time after which a single retry for
34521 a failed connect is made.  The default is to not retry.
34522
34523 If a Unix socket file is specified, only one server is supported.
34524
34525 Examples:
34526 .code
34527 av_scanner = clamd:/opt/clamd/socket
34528 av_scanner = clamd:192.0.2.3 1234
34529 av_scanner = clamd:192.0.2.3 1234:local
34530 av_scanner = clamd:192.0.2.3 1234 retry=10s
34531 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34532 .endd
34533 If the value of av_scanner points to a UNIX socket file or contains the
34534 &`local`&
34535 option, then the ClamAV interface will pass a filename containing the data
34536 to be scanned, which should normally result in less I/O happening and be
34537 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34538 Exim does not assume that there is a common filesystem with the remote host.
34539
34540 The final example shows that multiple TCP targets can be specified.  Exim will
34541 randomly use one for each incoming email (i.e. it load balances them).  Note
34542 that only TCP targets may be used if specifying a list of scanners; a UNIX
34543 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34544 unavailable, Exim will try the remaining one(s) until it finds one that works.
34545 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34546 not keep track of scanner state between multiple messages, and the scanner
34547 selection is random, so the message will get logged in the mainlog for each
34548 email that the down scanner gets chosen first (message wrapped to be readable):
34549 .code
34550 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34551    clamd: connection to localhost, port 3310 failed
34552    (Connection refused)
34553 .endd
34554
34555 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34556 contributing the code for this scanner.
34557
34558 .vitem &%cmdline%&
34559 .cindex "virus scanners" "command line interface"
34560 This is the keyword for the generic command line scanner interface. It can be
34561 used to attach virus scanners that are invoked from the shell. This scanner
34562 type takes 3 mandatory options:
34563
34564 .olist
34565 The full path and name of the scanner binary, with all command line options,
34566 and a placeholder (&`%s`&) for the directory to scan.
34567
34568 .next
34569 A regular expression to match against the STDOUT and STDERR output of the
34570 virus scanner. If the expression matches, a virus was found. You must make
34571 absolutely sure that this expression matches on &"virus found"&. This is called
34572 the &"trigger"& expression.
34573
34574 .next
34575 Another regular expression, containing exactly one pair of parentheses, to
34576 match the name of the virus found in the scanners output. This is called the
34577 &"name"& expression.
34578 .endlist olist
34579
34580 For example, Sophos Sweep reports a virus on a line like this:
34581 .code
34582 Virus 'W32/Magistr-B' found in file ./those.bat
34583 .endd
34584 For the trigger expression, we can match the phrase &"found in file"&. For the
34585 name expression, we want to extract the W32/Magistr-B string, so we can match
34586 for the single quotes left and right of it. Altogether, this makes the
34587 configuration setting:
34588 .code
34589 av_scanner = cmdline:\
34590              /path/to/sweep -ss -all -rec -archive %s:\
34591              found in file:'(.+)'
34592 .endd
34593 .vitem &%drweb%&
34594 .cindex "virus scanners" "DrWeb"
34595 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34596 takes one option,
34597 either a full path to a UNIX socket,
34598 or host and port specifiers separated by white space.
34599 The host may be a name or an IP address; the port is either a
34600 single number or a pair of numbers with a dash between.
34601 For example:
34602 .code
34603 av_scanner = drweb:/var/run/drwebd.sock
34604 av_scanner = drweb:192.168.2.20 31337
34605 .endd
34606 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34607 is used. Thanks to Alex Miller for contributing the code for this scanner.
34608
34609 .vitem &%f-protd%&
34610 .cindex "virus scanners" "f-protd"
34611 The f-protd scanner is accessed via HTTP over TCP.
34612 One argument is taken, being a space-separated hostname and port number
34613 (or port-range).
34614 For example:
34615 .code
34616 av_scanner = f-protd:localhost 10200-10204
34617 .endd
34618 If you omit the argument, the default values shown above are used.
34619
34620 .vitem &%f-prot6d%&
34621 .cindex "virus scanners" "f-prot6d"
34622 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34623 One argument is taken, being a space-separated hostname and port number.
34624 For example:
34625 .code
34626 av_scanner = f-prot6d:localhost 10200
34627 .endd
34628 If you omit the argument, the default values show above are used.
34629
34630 .vitem &%fsecure%&
34631 .cindex "virus scanners" "F-Secure"
34632 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34633 argument which is the path to a UNIX socket. For example:
34634 .code
34635 av_scanner = fsecure:/path/to/.fsav
34636 .endd
34637 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34638 Thelmen for contributing the code for this scanner.
34639
34640 .vitem &%kavdaemon%&
34641 .cindex "virus scanners" "Kaspersky"
34642 This is the scanner daemon of Kaspersky Version 4. This version of the
34643 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34644 scanner type takes one option, which is the path to the daemon's UNIX socket.
34645 For example:
34646 .code
34647 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34648 .endd
34649 The default path is &_/var/run/AvpCtl_&.
34650
34651 .vitem &%mksd%&
34652 .cindex "virus scanners" "mksd"
34653 This was a daemon type scanner that is aimed mainly at Polish users,
34654 though some documentation was available in English.
34655 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34656 and this appears to be a candidate for removal from Exim, unless
34657 we are informed of other virus scanners which use the same protocol
34658 to integrate.
34659 The only option for this scanner type is
34660 the maximum number of processes used simultaneously to scan the attachments,
34661 provided that mksd has
34662 been run with at least the same number of child processes. For example:
34663 .code
34664 av_scanner = mksd:2
34665 .endd
34666 You can safely omit this option (the default value is 1).
34667
34668 .vitem &%sock%&
34669 .cindex "virus scanners" "simple socket-connected"
34670 This is a general-purpose way of talking to simple scanner daemons
34671 running on the local machine.
34672 There are four options:
34673 an address (which may be an IP address and port, or the path of a Unix socket),
34674 a commandline to send (may include a single %s which will be replaced with
34675 the path to the mail file to be scanned),
34676 an RE to trigger on from the returned data,
34677 and an RE to extract malware_name from the returned data.
34678 For example:
34679 .code
34680 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34681 .endd
34682 Note that surrounding whitespace is stripped from each option, meaning
34683 there is no way to specify a trailing newline.
34684 The socket specifier and both regular-expressions are required.
34685 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34686 specify an empty element to get this.
34687
34688 .vitem &%sophie%&
34689 .cindex "virus scanners" "Sophos and Sophie"
34690 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34691 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34692 for this scanner type is the path to the UNIX socket that Sophie uses for
34693 client communication. For example:
34694 .code
34695 av_scanner = sophie:/tmp/sophie
34696 .endd
34697 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34698 the option.
34699 .endlist
34700
34701 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34702 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34703 ACL.
34704
34705 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34706 makes it possible to use different scanners. See further below for an example.
34707 The &%malware%& condition caches its results, so when you use it multiple times
34708 for the same message, the actual scanning process is only carried out once.
34709 However, using expandable items in &%av_scanner%& disables this caching, in
34710 which case each use of the &%malware%& condition causes a new scan of the
34711 message.
34712
34713 The &%malware%& condition takes a right-hand argument that is expanded before
34714 use and taken as a list, slash-separated by default.
34715 The first element can then be one of
34716
34717 .ilist
34718 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34719 The condition succeeds if a virus was found, and fail otherwise. This is the
34720 recommended usage.
34721 .next
34722 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34723 the condition fails immediately.
34724 .next
34725 A regular expression, in which case the message is scanned for viruses. The
34726 condition succeeds if a virus is found and its name matches the regular
34727 expression. This allows you to take special actions on certain types of virus.
34728 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34729 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34730 .endlist
34731
34732 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34733 messages even if there is a problem with the virus scanner.
34734 Otherwise, such a problem causes the ACL to defer.
34735
34736 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34737 specify a non-default timeout.  The default is two minutes.
34738 For example:
34739 .code
34740 malware = * / defer_ok / tmo=10s
34741 .endd
34742 A timeout causes the ACL to defer.
34743
34744 .vindex "&$callout_address$&"
34745 When a connection is made to the scanner the expansion variable &$callout_address$&
34746 is set to record the actual address used.
34747
34748 .vindex "&$malware_name$&"
34749 When a virus is found, the condition sets up an expansion variable called
34750 &$malware_name$& that contains the name of the virus. You can use it in a
34751 &%message%& modifier that specifies the error returned to the sender, and/or in
34752 logging data.
34753
34754 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34755 imposed by your anti-virus scanner.
34756
34757 Here is a very simple scanning example:
34758 .code
34759 deny malware = *
34760      message = This message contains malware ($malware_name)
34761 .endd
34762 The next example accepts messages when there is a problem with the scanner:
34763 .code
34764 deny malware = */defer_ok
34765      message = This message contains malware ($malware_name)
34766 .endd
34767 The next example shows how to use an ACL variable to scan with both sophie and
34768 aveserver. It assumes you have set:
34769 .code
34770 av_scanner = $acl_m0
34771 .endd
34772 in the main Exim configuration.
34773 .code
34774 deny set acl_m0 = sophie
34775      malware = *
34776      message = This message contains malware ($malware_name)
34777
34778 deny set acl_m0 = aveserver
34779      malware = *
34780      message = This message contains malware ($malware_name)
34781 .endd
34782
34783
34784 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34785 .cindex "content scanning" "for spam"
34786 .cindex "spam scanning"
34787 .cindex "SpamAssassin"
34788 .cindex "Rspamd"
34789 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34790 score and a report for the message.
34791 Support is also provided for Rspamd.
34792
34793 For more information about installation and configuration of SpamAssassin or
34794 Rspamd refer to their respective websites at
34795 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34796
34797 SpamAssassin can be installed with CPAN by running:
34798 .code
34799 perl -MCPAN -e 'install Mail::SpamAssassin'
34800 .endd
34801 SpamAssassin has its own set of configuration files. Please review its
34802 documentation to see how you can tweak it. The default installation should work
34803 nicely, however.
34804
34805 .oindex "&%spamd_address%&"
34806 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34807 intend to use an instance running on the local host you do not need to set
34808 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34809 you must set the &%spamd_address%& option in the global part of the Exim
34810 configuration as follows (example):
34811 .code
34812 spamd_address = 192.168.99.45 783
34813 .endd
34814 The SpamAssassin protocol relies on a TCP half-close from the client.
34815 If your SpamAssassin client side is running a Linux system with an
34816 iptables firewall, consider setting
34817 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34818 timeout, Exim uses when waiting for a response from the SpamAssassin
34819 server (currently defaulting to 120s).  With a lower value the Linux
34820 connection tracking may consider your half-closed connection as dead too
34821 soon.
34822
34823
34824 To use Rspamd (which by default listens on all local addresses
34825 on TCP port 11333)
34826 you should add &%variant=rspamd%& after the address/port pair, for example:
34827 .code
34828 spamd_address = 127.0.0.1 11333 variant=rspamd
34829 .endd
34830
34831 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34832 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34833 filename instead of an address/port pair:
34834 .code
34835 spamd_address = /var/run/spamd_socket
34836 .endd
34837 You can have multiple &%spamd%& servers to improve scalability. These can
34838 reside on other hardware reachable over the network. To specify multiple
34839 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34840 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34841 .code
34842 spamd_address = 192.168.2.10 783 : \
34843                 192.168.2.11 783 : \
34844                 192.168.2.12 783
34845 .endd
34846 Up to 32 &%spamd%& servers are supported.
34847 When a server fails to respond to the connection attempt, all other
34848 servers are tried until one succeeds. If no server responds, the &%spam%&
34849 condition defers.
34850
34851 Unix and TCP socket specifications may be mixed in any order.
34852 Each element of the list is a list itself, space-separated by default
34853 and changeable in the usual way (&<<SECTlistsepchange>>&);
34854 take care to not double the separator.
34855
34856 For TCP socket specifications a host name or IP (v4 or v6, but
34857 subject to list-separator quoting rules) address can be used,
34858 and the port can be one or a dash-separated pair.
34859 In the latter case, the range is tried in strict order.
34860
34861 Elements after the first for Unix sockets, or second for TCP socket,
34862 are options.
34863 The supported options are:
34864 .code
34865 pri=<priority>      Selection priority
34866 weight=<value>      Selection bias
34867 time=<start>-<end>  Use only between these times of day
34868 retry=<timespec>    Retry on connect fail
34869 tmo=<timespec>      Connection time limit
34870 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34871 .endd
34872
34873 The &`pri`& option specifies a priority for the server within the list,
34874 higher values being tried first.
34875 The default priority is 1.
34876
34877 The &`weight`& option specifies a selection bias.
34878 Within a priority set
34879 servers are queried in a random fashion, weighted by this value.
34880 The default value for selection bias is 1.
34881
34882 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34883 in the local time zone; each element being one or more digits.
34884 Either the seconds or both minutes and seconds, plus the leading &`.`&
34885 characters, may be omitted and will be taken as zero.
34886
34887 Timeout specifications for the &`retry`& and &`tmo`& options
34888 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34889
34890 The &`tmo`& option specifies an overall timeout for communication.
34891 The default value is two minutes.
34892
34893 The &`retry`& option specifies a time after which a single retry for
34894 a failed connect is made.
34895 The default is to not retry.
34896
34897 The &%spamd_address%& variable is expanded before use if it starts with
34898 a dollar sign. In this case, the expansion may return a string that is
34899 used as the list so that multiple spamd servers can be the result of an
34900 expansion.
34901
34902 .vindex "&$callout_address$&"
34903 When a connection is made to the server the expansion variable &$callout_address$&
34904 is set to record the actual address used.
34905
34906 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34907 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34908 .code
34909 deny spam = joe
34910      message = This message was classified as SPAM
34911 .endd
34912 The right-hand side of the &%spam%& condition specifies a name. This is
34913 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34914 to scan using a specific profile, but rather use the SpamAssassin system-wide
34915 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34916 Rspamd does not use this setting. However, you must put something on the
34917 right-hand side.
34918
34919 The name allows you to use per-domain or per-user antispam profiles in
34920 principle, but this is not straightforward in practice, because a message may
34921 have multiple recipients, not necessarily all in the same domain. Because the
34922 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34923 read the contents of the message, the variables &$local_part$& and &$domain$&
34924 are not set.
34925 Careful enforcement of single-recipient messages
34926 (e.g. by responding with defer in the recipient ACL for all recipients
34927 after the first),
34928 or the use of PRDR,
34929 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34930 are needed to use this feature.
34931
34932 The right-hand side of the &%spam%& condition is expanded before being used, so
34933 you can put lookups or conditions there. When the right-hand side evaluates to
34934 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34935
34936
34937 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34938 large ones may cause significant performance degradation. As most spam messages
34939 are quite small, it is recommended that you do not scan the big ones. For
34940 example:
34941 .code
34942 deny condition = ${if < {$message_size}{10K}}
34943      spam = nobody
34944      message = This message was classified as SPAM
34945 .endd
34946
34947 The &%spam%& condition returns true if the threshold specified in the user's
34948 SpamAssassin profile has been matched or exceeded. If you want to use the
34949 &%spam%& condition for its side effects (see the variables below), you can make
34950 it always return &"true"& by appending &`:true`& to the username.
34951
34952 .cindex "spam scanning" "returned variables"
34953 When the &%spam%& condition is run, it sets up a number of expansion
34954 variables.
34955 Except for &$spam_report$&,
34956 these variables are saved with the received message so are
34957 available for use at delivery time.
34958
34959 .vlist
34960 .vitem &$spam_score$&
34961 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34962 for inclusion in log or reject messages.
34963
34964 .vitem &$spam_score_int$&
34965 The spam score of the message, multiplied by ten, as an integer value. For
34966 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34967 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34968 The integer value is useful for numeric comparisons in conditions.
34969
34970 .vitem &$spam_bar$&
34971 A string consisting of a number of &"+"& or &"-"& characters, representing the
34972 integer part of the spam score value. A spam score of 4.4 would have a
34973 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34974 headers, since MUAs can match on such strings. The maximum length of the
34975 spam bar is 50 characters.
34976
34977 .vitem &$spam_report$&
34978 A multiline text table, containing the full SpamAssassin report for the
34979 message. Useful for inclusion in headers or reject messages.
34980 This variable is only usable in a DATA-time ACL.
34981 Beware that SpamAssassin may return non-ASCII characters, especially
34982 when running in country-specific locales, which are not legal
34983 unencoded in headers.
34984
34985 .vitem &$spam_action$&
34986 For SpamAssassin either 'reject' or 'no action' depending on the
34987 spam score versus threshold.
34988 For Rspamd, the recommended action.
34989
34990 .endlist
34991
34992 The &%spam%& condition caches its results unless expansion in
34993 spamd_address was used. If you call it again with the same user name, it
34994 does not scan again, but rather returns the same values as before.
34995
34996 The &%spam%& condition returns DEFER if there is any error while running
34997 the message through SpamAssassin or if the expansion of spamd_address
34998 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34999 statement block), append &`/defer_ok`& to the right-hand side of the
35000 spam condition, like this:
35001 .code
35002 deny spam    = joe/defer_ok
35003      message = This message was classified as SPAM
35004 .endd
35005 This causes messages to be accepted even if there is a problem with &%spamd%&.
35006
35007 Here is a longer, commented example of the use of the &%spam%&
35008 condition:
35009 .code
35010 # put headers in all messages (no matter if spam or not)
35011 warn  spam = nobody:true
35012       add_header = X-Spam-Score: $spam_score ($spam_bar)
35013       add_header = X-Spam-Report: $spam_report
35014
35015 # add second subject line with *SPAM* marker when message
35016 # is over threshold
35017 warn  spam = nobody
35018       add_header = Subject: *SPAM* $h_Subject:
35019
35020 # reject spam at high scores (> 12)
35021 deny  spam = nobody:true
35022       condition = ${if >{$spam_score_int}{120}{1}{0}}
35023       message = This message scored $spam_score spam points.
35024 .endd
35025
35026
35027
35028 .section "Scanning MIME parts" "SECTscanmimepart"
35029 .cindex "content scanning" "MIME parts"
35030 .cindex "MIME content scanning"
35031 .oindex "&%acl_smtp_mime%&"
35032 .oindex "&%acl_not_smtp_mime%&"
35033 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
35034 each MIME part of an SMTP message, including multipart types, in the sequence
35035 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
35036 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
35037 options may both refer to the same ACL if you want the same processing in both
35038 cases.
35039
35040 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
35041 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
35042 the case of a non-SMTP message. However, a MIME ACL is called only if the
35043 message contains a &'Content-Type:'& header line. When a call to a MIME
35044 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
35045 result code is sent to the client. In the case of an SMTP message, the
35046 &%acl_smtp_data%& ACL is not called when this happens.
35047
35048 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
35049 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
35050 condition to match against the raw MIME part. You can also use the
35051 &%mime_regex%& condition to match against the decoded MIME part (see section
35052 &<<SECTscanregex>>&).
35053
35054 At the start of a MIME ACL, a number of variables are set from the header
35055 information for the relevant MIME part. These are described below. The contents
35056 of the MIME part are not by default decoded into a disk file except for MIME
35057 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
35058 part into a disk file, you can use the &%decode%& condition. The general
35059 syntax is:
35060 .display
35061 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
35062 .endd
35063 The right hand side is expanded before use. After expansion,
35064 the value can be:
35065
35066 .olist
35067 &"0"& or &"false"&, in which case no decoding is done.
35068 .next
35069 The string &"default"&. In that case, the file is put in the temporary
35070 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35071 a sequential filename consisting of the message id and a sequence number. The
35072 full path and name is available in &$mime_decoded_filename$& after decoding.
35073 .next
35074 A full path name starting with a slash. If the full name is an existing
35075 directory, it is used as a replacement for the default directory. The filename
35076 is then sequentially assigned. If the path does not exist, it is used as
35077 the full path and filename.
35078 .next
35079 If the string does not start with a slash, it is used as the
35080 filename, and the default path is then used.
35081 .endlist
35082 The &%decode%& condition normally succeeds. It is only false for syntax
35083 errors or unusual circumstances such as memory shortages. You can easily decode
35084 a file with its original, proposed filename using
35085 .code
35086 decode = $mime_filename
35087 .endd
35088 However, you should keep in mind that &$mime_filename$& might contain
35089 anything. If you place files outside of the default path, they are not
35090 automatically unlinked.
35091
35092 For RFC822 attachments (these are messages attached to messages, with a
35093 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35094 as for the primary message, only that the &$mime_is_rfc822$& expansion
35095 variable is set (see below). Attached messages are always decoded to disk
35096 before being checked, and the files are unlinked once the check is done.
35097
35098 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35099 used to match regular expressions against raw and decoded MIME parts,
35100 respectively. They are described in section &<<SECTscanregex>>&.
35101
35102 .cindex "MIME content scanning" "returned variables"
35103 The following list describes all expansion variables that are
35104 available in the MIME ACL:
35105
35106 .vlist
35107 .vitem &$mime_anomaly_level$& &&&
35108        &$mime_anomaly_text$&
35109 .vindex &$mime_anomaly_level$&
35110 .vindex &$mime_anomaly_text$&
35111 If there are problems decoding, these variables contain information on
35112 the detected issue.
35113
35114 .vitem &$mime_boundary$&
35115 .vindex &$mime_boundary$&
35116 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35117 have a boundary string, which is stored in this variable. If the current part
35118 has no boundary parameter in the &'Content-Type:'& header, this variable
35119 contains the empty string.
35120
35121 .vitem &$mime_charset$&
35122 .vindex &$mime_charset$&
35123 This variable contains the character set identifier, if one was found in the
35124 &'Content-Type:'& header. Examples for charset identifiers are:
35125 .code
35126 us-ascii
35127 gb2312 (Chinese)
35128 iso-8859-1
35129 .endd
35130 Please note that this value is not normalized, so you should do matches
35131 case-insensitively.
35132
35133 .vitem &$mime_content_description$&
35134 .vindex &$mime_content_description$&
35135 This variable contains the normalized content of the &'Content-Description:'&
35136 header. It can contain a human-readable description of the parts content. Some
35137 implementations repeat the filename for attachments here, but they are usually
35138 only used for display purposes.
35139
35140 .vitem &$mime_content_disposition$&
35141 .vindex &$mime_content_disposition$&
35142 This variable contains the normalized content of the &'Content-Disposition:'&
35143 header. You can expect strings like &"attachment"& or &"inline"& here.
35144
35145 .vitem &$mime_content_id$&
35146 .vindex &$mime_content_id$&
35147 This variable contains the normalized content of the &'Content-ID:'& header.
35148 This is a unique ID that can be used to reference a part from another part.
35149
35150 .vitem &$mime_content_size$&
35151 .vindex &$mime_content_size$&
35152 This variable is set only after the &%decode%& modifier (see above) has been
35153 successfully run. It contains the size of the decoded part in kilobytes. The
35154 size is always rounded up to full kilobytes, so only a completely empty part
35155 has a &$mime_content_size$& of zero.
35156
35157 .vitem &$mime_content_transfer_encoding$&
35158 .vindex &$mime_content_transfer_encoding$&
35159 This variable contains the normalized content of the
35160 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35161 type. Typical values are &"base64"& and &"quoted-printable"&.
35162
35163 .vitem &$mime_content_type$&
35164 .vindex &$mime_content_type$&
35165 If the MIME part has a &'Content-Type:'& header, this variable contains its
35166 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35167 are some examples of popular MIME types, as they may appear in this variable:
35168 .code
35169 text/plain
35170 text/html
35171 application/octet-stream
35172 image/jpeg
35173 audio/midi
35174 .endd
35175 If the MIME part has no &'Content-Type:'& header, this variable contains the
35176 empty string.
35177
35178 .vitem &$mime_decoded_filename$&
35179 .vindex &$mime_decoded_filename$&
35180 This variable is set only after the &%decode%& modifier (see above) has been
35181 successfully run. It contains the full path and filename of the file
35182 containing the decoded data.
35183 .endlist
35184
35185 .cindex "RFC 2047"
35186 .vlist
35187 .vitem &$mime_filename$&
35188 .vindex &$mime_filename$&
35189 This is perhaps the most important of the MIME variables. It contains a
35190 proposed filename for an attachment, if one was found in either the
35191 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35192 RFC2047
35193 or RFC2231
35194 decoded, but no additional sanity checks are done.
35195  If no filename was
35196 found, this variable contains the empty string.
35197
35198 .vitem &$mime_is_coverletter$&
35199 .vindex &$mime_is_coverletter$&
35200 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35201 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35202 content in the cover letter, while not restricting attachments at all.
35203
35204 The variable contains 1 (true) for a MIME part believed to be part of the
35205 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35206 follows:
35207
35208 .olist
35209 The outermost MIME part of a message is always a cover letter.
35210
35211 .next
35212 If a multipart/alternative or multipart/related MIME part is a cover letter,
35213 so are all MIME subparts within that multipart.
35214
35215 .next
35216 If any other multipart is a cover letter, the first subpart is a cover letter,
35217 and the rest are attachments.
35218
35219 .next
35220 All parts contained within an attachment multipart are attachments.
35221 .endlist olist
35222
35223 As an example, the following will ban &"HTML mail"& (including that sent with
35224 alternative plain text), while allowing HTML files to be attached. HTML
35225 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35226 .code
35227 deny !condition = $mime_is_rfc822
35228      condition = $mime_is_coverletter
35229      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35230      message = HTML mail is not accepted here
35231 .endd
35232
35233 .vitem &$mime_is_multipart$&
35234 .vindex &$mime_is_multipart$&
35235 This variable has the value 1 (true) when the current part has the main type
35236 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35237 Since multipart entities only serve as containers for other parts, you may not
35238 want to carry out specific actions on them.
35239
35240 .vitem &$mime_is_rfc822$&
35241 .vindex &$mime_is_rfc822$&
35242 This variable has the value 1 (true) if the current part is not a part of the
35243 checked message itself, but part of an attached message. Attached message
35244 decoding is fully recursive.
35245
35246 .vitem &$mime_part_count$&
35247 .vindex &$mime_part_count$&
35248 This variable is a counter that is raised for each processed MIME part. It
35249 starts at zero for the very first part (which is usually a multipart). The
35250 counter is per-message, so it is reset when processing RFC822 attachments (see
35251 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35252 complete, so you can use it in the DATA ACL to determine the number of MIME
35253 parts of a message. For non-MIME messages, this variable contains the value -1.
35254 .endlist
35255
35256
35257
35258 .section "Scanning with regular expressions" "SECTscanregex"
35259 .cindex "content scanning" "with regular expressions"
35260 .cindex "regular expressions" "content scanning with"
35261 You can specify your own custom regular expression matches on the full body of
35262 the message, or on individual MIME parts.
35263
35264 The &%regex%& condition takes one or more regular expressions as arguments and
35265 matches them against the full message (when called in the DATA ACL) or a raw
35266 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35267 linewise, with a maximum line length of 32K characters. That means you cannot
35268 have multiline matches with the &%regex%& condition.
35269
35270 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35271 to 32K of decoded content (the whole content at once, not linewise). If the
35272 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35273 is decoded automatically when &%mime_regex%& is executed (using default path
35274 and filename values). If the decoded data is larger than  32K, only the first
35275 32K characters are checked.
35276
35277 The regular expressions are passed as a colon-separated list. To include a
35278 literal colon, you must double it. Since the whole right-hand side string is
35279 expanded before being used, you must also escape dollar signs and backslashes
35280 with more backslashes, or use the &`\N`& facility to disable expansion.
35281 Here is a simple example that contains two regular expressions:
35282 .code
35283 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35284      message = contains blacklisted regex ($regex_match_string)
35285 .endd
35286 The conditions returns true if any one of the regular expressions matches. The
35287 &$regex_match_string$& expansion variable is then set up and contains the
35288 matching regular expression.
35289 The expansion variables &$regex1$& &$regex2$& etc
35290 are set to any substrings captured by the regular expression.
35291
35292 &*Warning*&: With large messages, these conditions can be fairly
35293 CPU-intensive.
35294
35295 .ecindex IIDcosca
35296
35297
35298
35299
35300 . ////////////////////////////////////////////////////////////////////////////
35301 . ////////////////////////////////////////////////////////////////////////////
35302
35303 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35304          "Local scan function"
35305 .scindex IIDlosca "&[local_scan()]& function" "description of"
35306 .cindex "customizing" "input scan using C function"
35307 .cindex "policy control" "by local scan function"
35308 In these days of email worms, viruses, and ever-increasing spam, some sites
35309 want to apply a lot of checking to messages before accepting them.
35310
35311 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35312 passing messages to external virus and spam scanning software. You can also do
35313 a certain amount in Exim itself through string expansions and the &%condition%&
35314 condition in the ACL that runs after the SMTP DATA command or the ACL for
35315 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35316
35317 To allow for further customization to a site's own requirements, there is the
35318 possibility of linking Exim with a private message scanning function, written
35319 in C. If you want to run code that is written in something other than C, you
35320 can of course use a little C stub to call it.
35321
35322 The local scan function is run once for every incoming message, at the point
35323 when Exim is just about to accept the message.
35324 It can therefore be used to control non-SMTP messages from local processes as
35325 well as messages arriving via SMTP.
35326
35327 Exim applies a timeout to calls of the local scan function, and there is an
35328 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35329 Zero means &"no timeout"&.
35330 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35331 before calling the local scan function, so that the most common types of crash
35332 are caught. If the timeout is exceeded or one of those signals is caught, the
35333 incoming message is rejected with a temporary error if it is an SMTP message.
35334 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35335 code. The incident is logged on the main and reject logs.
35336
35337
35338
35339 .section "Building Exim to use a local scan function" "SECID207"
35340 .cindex "&[local_scan()]& function" "building Exim to use"
35341 To make use of the local scan function feature, you must tell Exim where your
35342 function is before building Exim, by setting
35343 both HAVE_LOCAL_SCAN and
35344 LOCAL_SCAN_SOURCE in your
35345 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35346 directory, so you might set
35347 .code
35348 HAVE_LOCAL_SCAN=yes
35349 LOCAL_SCAN_SOURCE=Local/local_scan.c
35350 .endd
35351 for example. The function must be called &[local_scan()]&;
35352 the source file(s) for it should first #define LOCAL_SCAN
35353 and then #include "local_scan.h".
35354 It is called by
35355 Exim after it has received a message, when the success return code is about to
35356 be sent. This is after all the ACLs have been run. The return code from your
35357 function controls whether the message is actually accepted or not. There is a
35358 commented template function (that just accepts the message) in the file
35359 _src/local_scan.c_.
35360
35361 If you want to make use of Exim's runtime configuration file to set options
35362 for your &[local_scan()]& function, you must also set
35363 .code
35364 LOCAL_SCAN_HAS_OPTIONS=yes
35365 .endd
35366 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35367
35368
35369
35370
35371 .section "API for local_scan()" "SECTapiforloc"
35372 .cindex "&[local_scan()]& function" "API description"
35373 .cindex &%dlfunc%& "API description"
35374 You must include this line near the start of your code:
35375 .code
35376 #define LOCAL_SCAN
35377 #include "local_scan.h"
35378 .endd
35379 This header file defines a number of variables and other values, and the
35380 prototype for the function itself. Exim is coded to use unsigned char values
35381 almost exclusively, and one of the things this header defines is a shorthand
35382 for &`unsigned char`& called &`uschar`&.
35383 It also makes available the following macro definitions, to simplify casting character
35384 strings and pointers to character strings:
35385 .code
35386 #define CS   (char *)
35387 #define CCS  (const char *)
35388 #define CSS  (char **)
35389 #define US   (unsigned char *)
35390 #define CUS  (const unsigned char *)
35391 #define USS  (unsigned char **)
35392 .endd
35393 The function prototype for &[local_scan()]& is:
35394 .code
35395 extern int local_scan(int fd, uschar **return_text);
35396 .endd
35397 The arguments are as follows:
35398
35399 .ilist
35400 &%fd%& is a file descriptor for the file that contains the body of the message
35401 (the -D file). The file is open for reading and writing, but updating it is not
35402 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35403
35404 The descriptor is positioned at character 26 of the file, which is the first
35405 character of the body itself, because the first 26 characters (19 characters
35406 before Exim  4.97) are the message id followed by &`-D`& and a newline.
35407 If you rewind the file, you should use the
35408 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35409 case this changes in some future version.
35410 .next
35411 &%return_text%& is an address which you can use to return a pointer to a text
35412 string at the end of the function. The value it points to on entry is NULL.
35413 .endlist
35414
35415 The function must return an &%int%& value which is one of the following macros:
35416
35417 .vlist
35418 .vitem &`LOCAL_SCAN_ACCEPT`&
35419 .vindex "&$local_scan_data$&"
35420 The message is accepted. If you pass back a string of text, it is saved with
35421 the message, and made available in the variable &$local_scan_data$&. No
35422 newlines are permitted (if there are any, they are turned into spaces) and the
35423 maximum length of text is 1000 characters.
35424
35425 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35426 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35427 queued without immediate delivery, and is frozen.
35428
35429 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35430 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35431 queued without immediate delivery.
35432
35433 .vitem &`LOCAL_SCAN_REJECT`&
35434 The message is rejected; the returned text is used as an error message which is
35435 passed back to the sender and which is also logged. Newlines are permitted &--
35436 they cause a multiline response for SMTP rejections, but are converted to
35437 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35438 used.
35439
35440 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35441 The message is temporarily rejected; the returned text is used as an error
35442 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35443 problem"& is used.
35444
35445 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35446 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35447 message is not written to the reject log. It has the effect of unsetting the
35448 &%rejected_header%& log selector for just this rejection. If
35449 &%rejected_header%& is already unset (see the discussion of the
35450 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35451 same as LOCAL_SCAN_REJECT.
35452
35453 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35454 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35455 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35456 .endlist
35457
35458 If the message is not being received by interactive SMTP, rejections are
35459 reported by writing to &%stderr%& or by sending an email, as configured by the
35460 &%-oe%& command line options.
35461
35462
35463
35464 .section "Configuration options for local_scan()" "SECTconoptloc"
35465 .cindex "&[local_scan()]& function" "configuration options"
35466 It is possible to have option settings in the main configuration file
35467 that set values in static variables in the &[local_scan()]& module. If you
35468 want to do this, you must have the line
35469 .code
35470 LOCAL_SCAN_HAS_OPTIONS=yes
35471 .endd
35472 in your &_Local/Makefile_& when you build Exim. (This line is in
35473 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35474 file, you must define static variables to hold the option values, and a table
35475 to define them.
35476
35477 The table must be a vector called &%local_scan_options%&, of type
35478 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35479 and a pointer to the variable that holds the value. The entries must appear in
35480 alphabetical order. Following &%local_scan_options%& you must also define a
35481 variable called &%local_scan_options_count%& that contains the number of
35482 entries in the table. Here is a short example, showing two kinds of option:
35483 .code
35484 static int my_integer_option = 42;
35485 static uschar *my_string_option = US"a default string";
35486
35487 optionlist local_scan_options[] = {
35488   { "my_integer", opt_int,       &my_integer_option },
35489   { "my_string",  opt_stringptr, &my_string_option }
35490 };
35491
35492 int local_scan_options_count =
35493   sizeof(local_scan_options)/sizeof(optionlist);
35494 .endd
35495 The values of the variables can now be changed from Exim's runtime
35496 configuration file by including a local scan section as in this example:
35497 .code
35498 begin local_scan
35499 my_integer = 99
35500 my_string = some string of text...
35501 .endd
35502 The available types of option data are as follows:
35503
35504 .vlist
35505 .vitem &*opt_bool*&
35506 This specifies a boolean (true/false) option. The address should point to a
35507 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35508 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35509 whether such a variable has been set at all, you can initialize it to
35510 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35511 values.)
35512
35513 .vitem &*opt_fixed*&
35514 This specifies a fixed point number, such as is used for load averages.
35515 The address should point to a variable of type &`int`&. The value is stored
35516 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35517
35518 .vitem &*opt_int*&
35519 This specifies an integer; the address should point to a variable of type
35520 &`int`&. The value may be specified in any of the integer formats accepted by
35521 Exim.
35522
35523 .vitem &*opt_mkint*&
35524 This is the same as &%opt_int%&, except that when such a value is output in a
35525 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35526 printed with the suffix K or M.
35527
35528 .vitem &*opt_octint*&
35529 This also specifies an integer, but the value is always interpreted as an
35530 octal integer, whether or not it starts with the digit zero, and it is
35531 always output in octal.
35532
35533 .vitem &*opt_stringptr*&
35534 This specifies a string value; the address must be a pointer to a
35535 variable that points to a string (for example, of type &`uschar *`&).
35536
35537 .vitem &*opt_time*&
35538 This specifies a time interval value. The address must point to a variable of
35539 type &`int`&. The value that is placed there is a number of seconds.
35540 .endlist
35541
35542 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35543 out the values of all the &[local_scan()]& options.
35544
35545
35546
35547 .section "Available Exim variables" "SECID208"
35548 .cindex "&[local_scan()]& function" "available Exim variables"
35549 The header &_local_scan.h_& gives you access to a number of C variables. These
35550 are the only ones that are guaranteed to be maintained from release to release.
35551 Note, however, that you can obtain the value of any Exim expansion variable,
35552 including &$recipients$&, by calling &'expand_string()'&. The exported
35553 C variables are as follows:
35554
35555 .vlist
35556 .vitem &*int&~body_linecount*&
35557 This variable contains the number of lines in the message's body.
35558 It is not valid if the &%spool_wireformat%& option is used.
35559
35560 .vitem &*int&~body_zerocount*&
35561 This variable contains the number of binary zero bytes in the message's body.
35562 It is not valid if the &%spool_wireformat%& option is used.
35563
35564 .vitem &*unsigned&~int&~debug_selector*&
35565 This variable is set to zero when no debugging is taking place. Otherwise, it
35566 is a bitmap of debugging selectors. Two bits are identified for use in
35567 &[local_scan()]&; they are defined as macros:
35568
35569 .ilist
35570 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35571 testing option that is not privileged &-- any caller may set it. All the
35572 other selector bits can be set only by admin users.
35573
35574 .next
35575 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35576 by the &`+local_scan`& debug selector. It is not included in the default set
35577 of debugging bits.
35578 .endlist ilist
35579
35580 Thus, to write to the debugging output only when &`+local_scan`& has been
35581 selected, you should use code like this:
35582 .code
35583 if ((debug_selector & D_local_scan) != 0)
35584   debug_printf("xxx", ...);
35585 .endd
35586 .vitem &*uschar&~*expand_string_message*&
35587 After a failing call to &'expand_string()'& (returned value NULL), the
35588 variable &%expand_string_message%& contains the error message, zero-terminated.
35589
35590 .vitem &*header_line&~*header_list*&
35591 A pointer to a chain of header lines. The &%header_line%& structure is
35592 discussed below.
35593
35594 .vitem &*header_line&~*header_last*&
35595 A pointer to the last of the header lines.
35596
35597 .vitem &*const&~uschar&~*headers_charset*&
35598 The value of the &%headers_charset%& configuration option.
35599
35600 .vitem &*BOOL&~host_checking*&
35601 This variable is TRUE during a host checking session that is initiated by the
35602 &%-bh%& command line option.
35603
35604 .vitem &*uschar&~*interface_address*&
35605 The IP address of the interface that received the message, as a string. This
35606 is NULL for locally submitted messages.
35607
35608 .vitem &*int&~interface_port*&
35609 The port on which this message was received. When testing with the &%-bh%&
35610 command line option, the value of this variable is -1 unless a port has been
35611 specified via the &%-oMi%& option.
35612
35613 .vitem &*uschar&~*message_id*&
35614 This variable contains Exim's message id for the incoming message (the value of
35615 &$message_exim_id$&) as a zero-terminated string.
35616
35617 .vitem &*uschar&~*received_protocol*&
35618 The name of the protocol by which the message was received.
35619
35620 .vitem &*int&~recipients_count*&
35621 The number of accepted recipients.
35622
35623 .vitem &*recipient_item&~*recipients_list*&
35624 .cindex "recipient" "adding in local scan"
35625 .cindex "recipient" "removing in local scan"
35626 The list of accepted recipients, held in a vector of length
35627 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35628 can add additional recipients by calling &'receive_add_recipient()'& (see
35629 below). You can delete recipients by removing them from the vector and
35630 adjusting the value in &%recipients_count%&. In particular, by setting
35631 &%recipients_count%& to zero you remove all recipients. If you then return the
35632 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35633 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35634 and then call &'receive_add_recipient()'& as often as needed.
35635
35636 .vitem &*uschar&~*sender_address*&
35637 The envelope sender address. For bounce messages this is the empty string.
35638
35639 .vitem &*uschar&~*sender_host_address*&
35640 The IP address of the sending host, as a string. This is NULL for
35641 locally-submitted messages.
35642
35643 .vitem &*uschar&~*sender_host_authenticated*&
35644 The name of the authentication mechanism that was used, or NULL if the message
35645 was not received over an authenticated SMTP connection.
35646
35647 .vitem &*uschar&~*sender_host_name*&
35648 The name of the sending host, if known.
35649
35650 .vitem &*int&~sender_host_port*&
35651 The port on the sending host.
35652
35653 .vitem &*BOOL&~smtp_input*&
35654 This variable is TRUE for all SMTP input, including BSMTP.
35655
35656 .vitem &*BOOL&~smtp_batched_input*&
35657 This variable is TRUE for BSMTP input.
35658
35659 .vitem &*int&~store_pool*&
35660 The contents of this variable control which pool of memory is used for new
35661 requests. See section &<<SECTmemhanloc>>& for details.
35662 .endlist
35663
35664
35665 .section "Structure of header lines" "SECID209"
35666 The &%header_line%& structure contains the members listed below.
35667 You can add additional header lines by calling the &'header_add()'& function
35668 (see below). You can cause header lines to be ignored (deleted) by setting
35669 their type to *.
35670
35671
35672 .vlist
35673 .vitem &*struct&~header_line&~*next*&
35674 A pointer to the next header line, or NULL for the last line.
35675
35676 .vitem &*int&~type*&
35677 A code identifying certain headers that Exim recognizes. The codes are printing
35678 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35679 Notice in particular that any header line whose type is * is not transmitted
35680 with the message. This flagging is used for header lines that have been
35681 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35682 lines.) Effectively, * means &"deleted"&.
35683
35684 .vitem &*int&~slen*&
35685 The number of characters in the header line, including the terminating and any
35686 internal newlines.
35687
35688 .vitem &*uschar&~*text*&
35689 A pointer to the text of the header. It always ends with a newline, followed by
35690 a zero byte. Internal newlines are preserved.
35691 .endlist
35692
35693
35694
35695 .section "Structure of recipient items" "SECID210"
35696 The &%recipient_item%& structure contains these members:
35697
35698 .vlist
35699 .vitem &*uschar&~*address*&
35700 This is a pointer to the recipient address as it was received.
35701
35702 .vitem &*int&~pno*&
35703 This is used in later Exim processing when top level addresses are created by
35704 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35705 and must always contain -1 at this stage.
35706
35707 .vitem &*uschar&~*errors_to*&
35708 If this value is not NULL, bounce messages caused by failing to deliver to the
35709 recipient are sent to the address it contains. In other words, it overrides the
35710 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35711 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35712 an unqualified address, Exim qualifies it using the domain from
35713 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35714 is NULL for all recipients.
35715 .endlist
35716
35717
35718
35719 .section "Available Exim functions" "SECID211"
35720 .cindex "&[local_scan()]& function" "available Exim functions"
35721 The header &_local_scan.h_& gives you access to a number of Exim functions.
35722 These are the only ones that are guaranteed to be maintained from release to
35723 release:
35724
35725 .vlist
35726 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35727        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35728
35729 This function creates a child process that runs the command specified by
35730 &%argv%&. The environment for the process is specified by &%envp%&, which can
35731 be NULL if no environment variables are to be passed. A new umask is supplied
35732 for the process in &%newumask%&.
35733
35734 Pipes to the standard input and output of the new process are set up
35735 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35736 standard error is cloned to the standard output. If there are any file
35737 descriptors &"in the way"& in the new process, they are closed. If the final
35738 argument is TRUE, the new process is made into a process group leader.
35739
35740 The function returns the pid of the new process, or -1 if things go wrong.
35741
35742 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35743 This function waits for a child process to terminate, or for a timeout (in
35744 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35745 return value is as follows:
35746
35747 .ilist
35748 >= 0
35749
35750 The process terminated by a normal exit and the value is the process
35751 ending status.
35752
35753 .next
35754 < 0 and > &--256
35755
35756 The process was terminated by a signal and the value is the negation of the
35757 signal number.
35758
35759 .next
35760 &--256
35761
35762 The process timed out.
35763 .next
35764 &--257
35765
35766 The was some other error in wait(); &%errno%& is still set.
35767 .endlist
35768
35769 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35770 This function provide you with a means of submitting a new message to
35771 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35772 want, but this packages it all up for you.) The function creates a pipe,
35773 forks a subprocess that is running
35774 .code
35775 exim -t -oem -oi -f <>
35776 .endd
35777 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35778 that is connected to the standard input. The yield of the function is the PID
35779 of the subprocess. You can then write a message to the file descriptor, with
35780 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35781
35782 When you have finished, call &'child_close()'& to wait for the process to
35783 finish and to collect its ending status. A timeout value of zero is usually
35784 fine in this circumstance. Unless you have made a mistake with the recipient
35785 addresses, you should get a return code of zero.
35786
35787
35788 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35789        *sender_authentication)*&
35790 This function is a more sophisticated version of &'child_open()'&. The command
35791 that it runs is:
35792 .display
35793 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35794 .endd
35795 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35796
35797
35798 .vitem &*void&~debug_printf(char&~*,&~...)*&
35799 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35800 output is written to the standard error stream. If no debugging is selected,
35801 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35802 conditional on the &`local_scan`& debug selector by coding like this:
35803 .code
35804 if ((debug_selector & D_local_scan) != 0)
35805   debug_printf("xxx", ...);
35806 .endd
35807
35808 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35809 This is an interface to Exim's string expansion code. The return value is the
35810 expanded string, or NULL if there was an expansion failure.
35811 The C variable &%expand_string_message%& contains an error message after an
35812 expansion failure. If expansion does not change the string, the return value is
35813 the pointer to the input string. Otherwise, the return value points to a new
35814 block of memory that was obtained by a call to &'store_get()'&. See section
35815 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35816
35817 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35818 This function allows you to an add additional header line at the end of the
35819 existing ones. The first argument is the type, and should normally be a space
35820 character. The second argument is a format string and any number of
35821 substitution arguments as for &[sprintf()]&. You may include internal newlines
35822 if you want, and you must ensure that the string ends with a newline.
35823
35824 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35825         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35826 This function adds a new header line at a specified point in the header
35827 chain. The header itself is specified as for &'header_add()'&.
35828
35829 If &%name%& is NULL, the new header is added at the end of the chain if
35830 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35831 NULL, the header lines are searched for the first non-deleted header that
35832 matches the name. If one is found, the new header is added before it if
35833 &%after%& is false. If &%after%& is true, the new header is added after the
35834 found header and any adjacent subsequent ones with the same name (even if
35835 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35836 option controls where the header is added. If it is true, addition is at the
35837 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35838 headers, or at the top if there are no &'Received:'& headers, you could use
35839 .code
35840 header_add_at_position(TRUE, US"Received", TRUE,
35841   ' ', "X-xxx: ...");
35842 .endd
35843 Normally, there is always at least one non-deleted &'Received:'& header, but
35844 there may not be if &%received_header_text%& expands to an empty string.
35845
35846
35847 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35848 This function removes header lines. If &%occurrence%& is zero or negative, all
35849 occurrences of the header are removed. If occurrence is greater than zero, that
35850 particular instance of the header is removed. If no header(s) can be found that
35851 match the specification, the function does nothing.
35852
35853
35854 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35855         int&~length,&~BOOL&~notdel)*&"
35856 This function tests whether the given header has the given name. It is not just
35857 a string comparison, because white space is permitted between the name and the
35858 colon. If the &%notdel%& argument is true, a false return is forced for all
35859 &"deleted"& headers; otherwise they are not treated specially. For example:
35860 .code
35861 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35862 .endd
35863 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35864 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35865 This function base64-encodes a string, which is passed by address and length.
35866 The text may contain bytes of any value, including zero. The result is passed
35867 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35868 zero-terminated.
35869
35870 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35871 This function decodes a base64-encoded string. Its arguments are a
35872 zero-terminated base64-encoded string and the address of a variable that is set
35873 to point to the result, which is in dynamic memory. The length of the decoded
35874 string is the yield of the function. If the input is invalid base64 data, the
35875 yield is -1. A zero byte is added to the end of the output string to make it
35876 easy to interpret as a C string (assuming it contains no zeros of its own). The
35877 added zero byte is not included in the returned count.
35878
35879 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35880 This function checks for a match in a domain list. Domains are always
35881 matched caselessly. The return value is one of the following:
35882 .itable none 0 0 2 15* left 85* left
35883 .irow &`OK`&    "match succeeded"
35884 .irow &`FAIL`&  "match failed"
35885 .irow &`DEFER`& "match deferred"
35886 .endtable
35887 DEFER is usually caused by some kind of lookup defer, such as the
35888 inability to contact a database.
35889
35890 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35891         BOOL&~caseless)*&"
35892 This function checks for a match in a local part list. The third argument
35893 controls case-sensitivity. The return values are as for
35894 &'lss_match_domain()'&.
35895
35896 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35897         BOOL&~caseless)*&"
35898 This function checks for a match in an address list. The third argument
35899 controls the case-sensitivity of the local part match. The domain is always
35900 matched caselessly. The return values are as for &'lss_match_domain()'&.
35901
35902 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35903         uschar&~*list)*&"
35904 This function checks for a match in a host list. The most common usage is
35905 expected to be
35906 .code
35907 lss_match_host(sender_host_name, sender_host_address, ...)
35908 .endd
35909 .vindex "&$sender_host_address$&"
35910 An empty address field matches an empty item in the host list. If the host name
35911 is NULL, the name corresponding to &$sender_host_address$& is automatically
35912 looked up if a host name is required to match an item in the list. The return
35913 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35914 returns ERROR in the case when it had to look up a host name, but the lookup
35915 failed.
35916
35917 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35918         *format,&~...)*&"
35919 This function writes to Exim's log files. The first argument should be zero (it
35920 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35921 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35922 them. It specifies to which log or logs the message is written. The remaining
35923 arguments are a format and relevant insertion arguments. The string should not
35924 contain any newlines, not even at the end.
35925
35926
35927 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35928 This function adds an additional recipient to the message. The first argument
35929 is the recipient address. If it is unqualified (has no domain), it is qualified
35930 with the &%qualify_recipient%& domain. The second argument must always be -1.
35931
35932 This function does not allow you to specify a private &%errors_to%& address (as
35933 described with the structure of &%recipient_item%& above), because it pre-dates
35934 the addition of that field to the structure. However, it is easy to add such a
35935 value afterwards. For example:
35936 .code
35937  receive_add_recipient(US"monitor@mydom.example", -1);
35938  recipients_list[recipients_count-1].errors_to =
35939    US"postmaster@mydom.example";
35940 .endd
35941
35942 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35943 This is a convenience function to remove a named recipient from the list of
35944 recipients. It returns true if a recipient was removed, and false if no
35945 matching recipient could be found. The argument must be a complete email
35946 address.
35947 .endlist
35948
35949
35950 .cindex "RFC 2047"
35951 .vlist
35952 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35953   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35954 This function decodes strings that are encoded according to RFC 2047. Typically
35955 these are the contents of header lines. First, each &"encoded word"& is decoded
35956 from the Q or B encoding into a byte-string. Then, if provided with the name of
35957 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35958 made  to translate the result to the named character set. If this fails, the
35959 binary string is returned with an error message.
35960
35961 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35962 maximum MIME word length is enforced. The third argument is the target
35963 encoding, or NULL if no translation is wanted.
35964
35965 .cindex "binary zero" "in RFC 2047 decoding"
35966 .cindex "RFC 2047" "binary zero in"
35967 If a binary zero is encountered in the decoded string, it is replaced by the
35968 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35969 not be 0 because header lines are handled as zero-terminated strings.
35970
35971 The function returns the result of processing the string, zero-terminated; if
35972 &%lenptr%& is not NULL, the length of the result is set in the variable to
35973 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35974
35975 If an error is encountered, the function returns NULL and uses the &%error%&
35976 argument to return an error message. The variable pointed to by &%error%& is
35977 set to NULL if there is no error; it may be set non-NULL even when the function
35978 returns a non-NULL value if decoding was successful, but there was a problem
35979 with translation.
35980
35981
35982 .vitem &*int&~smtp_fflush(void)*&
35983 This function is used in conjunction with &'smtp_printf()'&, as described
35984 below.
35985
35986 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35987 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35988 output stream. You should use this function only when there is an SMTP output
35989 stream, that is, when the incoming message is being received via interactive
35990 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35991 is FALSE. If you want to test for an incoming message from another host (as
35992 opposed to a local process that used the &%-bs%& command line option), you can
35993 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35994 is involved.
35995
35996 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35997 output function, so it can be used for all forms of SMTP connection.
35998
35999 The second argument is used to request that the data be buffered
36000 (when TRUE) or flushed (along with any previously buffered, when FALSE).
36001 This is advisory only, but likely to save on system-calls and packets
36002 sent when a sequence of calls to the function are made.
36003
36004 The argument was added in Exim version 4.90 - changing the API/ABI.
36005 Nobody noticed until 4.93 was imminent, at which point the
36006 ABI version number was incremented.
36007
36008 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
36009 must start with an appropriate response code: 550 if you are going to return
36010 LOCAL_SCAN_REJECT, 451 if you are going to return
36011 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
36012 initial lines of a multi-line response, the code must be followed by a hyphen
36013 to indicate that the line is not the final response line. You must also ensure
36014 that the lines you write terminate with CRLF. For example:
36015 .code
36016 smtp_printf("550-this is some extra info\r\n");
36017 return LOCAL_SCAN_REJECT;
36018 .endd
36019 Note that you can also create multi-line responses by including newlines in
36020 the data returned via the &%return_text%& argument. The added value of using
36021 &'smtp_printf()'& is that, for instance, you could introduce delays between
36022 multiple output lines.
36023
36024 The &'smtp_printf()'& function does not return any error indication, because it
36025 does not
36026 guarantee a flush of
36027 pending output, and therefore does not test
36028 the state of the stream. (In the main code of Exim, flushing and error
36029 detection is done when Exim is ready for the next SMTP input command.) If
36030 you want to flush the output and check for an error (for example, the
36031 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
36032 arguments. It flushes the output stream, and returns a non-zero value if there
36033 is an error.
36034
36035 .vitem &*void&~*store_get(int,BOOL)*&
36036 This function accesses Exim's internal store (memory) manager. It gets a new
36037 chunk of memory whose size is given by the first argument.
36038 The second argument should be given as TRUE if the memory will be used for
36039 data possibly coming from an attacker (eg. the message content),
36040 FALSE if it is locally-sourced.
36041 Exim bombs out if it ever
36042 runs out of memory. See the next section for a discussion of memory handling.
36043
36044 .vitem &*void&~*store_get_perm(int,BOOL)*&
36045 This function is like &'store_get()'&, but it always gets memory from the
36046 permanent pool. See the next section for a discussion of memory handling.
36047
36048 .vitem &*uschar&~*string_copy(uschar&~*string)*&
36049 See below.
36050
36051 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
36052 See below.
36053
36054 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
36055 These three functions create strings using Exim's dynamic memory facilities.
36056 The first makes a copy of an entire string. The second copies up to a maximum
36057 number of characters, indicated by the second argument. The third uses a format
36058 and insertion arguments to create a new string. In each case, the result is a
36059 pointer to a new string in the current memory pool. See the next section for
36060 more discussion.
36061 .endlist
36062
36063
36064
36065 .section "More about Exim's memory handling" "SECTmemhanloc"
36066 .cindex "&[local_scan()]& function" "memory handling"
36067 No function is provided for freeing memory, because that is never needed.
36068 The dynamic memory that Exim uses when receiving a message is automatically
36069 recycled if another message is received by the same process (this applies only
36070 to incoming SMTP connections &-- other input methods can supply only one
36071 message at a time). After receiving the last message, a reception process
36072 terminates.
36073
36074 Because it is recycled, the normal dynamic memory cannot be used for holding
36075 data that must be preserved over a number of incoming messages on the same SMTP
36076 connection. However, Exim in fact uses two pools of dynamic memory; the second
36077 one is not recycled, and can be used for this purpose.
36078
36079 If you want to allocate memory that remains available for subsequent messages
36080 in the same SMTP connection, you should set
36081 .code
36082 store_pool = POOL_PERM
36083 .endd
36084 before calling the function that does the allocation. There is no need to
36085 restore the value if you do not need to; however, if you do want to revert to
36086 the normal pool, you can either restore the previous value of &%store_pool%& or
36087 set it explicitly to POOL_MAIN.
36088
36089 The pool setting applies to all functions that get dynamic memory, including
36090 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36091 There is also a convenience function called &'store_get_perm()'& that gets a
36092 block of memory from the permanent pool while preserving the value of
36093 &%store_pool%&.
36094 .ecindex IIDlosca
36095
36096
36097
36098
36099 . ////////////////////////////////////////////////////////////////////////////
36100 . ////////////////////////////////////////////////////////////////////////////
36101
36102 .chapter "System-wide message filtering" "CHAPsystemfilter"
36103 .scindex IIDsysfil1 "filter" "system filter"
36104 .scindex IIDsysfil2 "filtering all mail"
36105 .scindex IIDsysfil3 "system filter"
36106 The previous chapters (on ACLs and the local scan function) describe checks
36107 that can be applied to messages before they are accepted by a host. There is
36108 also a mechanism for checking messages once they have been received, but before
36109 they are delivered. This is called the &'system filter'&.
36110
36111 The system filter operates in a similar manner to users' filter files, but it
36112 is run just once per message (however many recipients the message has).
36113 It should not normally be used as a substitute for routing, because &%deliver%&
36114 commands in a system router provide new envelope recipient addresses.
36115 The system filter must be an Exim filter. It cannot be a Sieve filter.
36116
36117 The system filter is run at the start of a delivery attempt, before any routing
36118 is done. If a message fails to be completely delivered at the first attempt,
36119 the system filter is run again at the start of every retry.
36120 If you want your filter to do something only once per message, you can make use
36121 .cindex retry condition
36122 of the &%first_delivery%& condition in an &%if%& command in the filter to
36123 prevent it happening on retries.
36124
36125 .vindex "&$domain$&"
36126 .vindex "&$local_part$&"
36127 &*Warning*&: Because the system filter runs just once, variables that are
36128 specific to individual recipient addresses, such as &$local_part$& and
36129 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36130 you want to run a centrally-specified filter for each recipient address
36131 independently, you can do so by setting up a suitable &(redirect)& router, as
36132 described in section &<<SECTperaddfil>>& below.
36133
36134
36135 .section "Specifying a system filter" "SECID212"
36136 .cindex "uid (user id)" "system filter"
36137 .cindex "gid (group id)" "system filter"
36138 The name of the file that contains the system filter must be specified by
36139 setting &%system_filter%&. If you want the filter to run under a uid and gid
36140 other than root, you must also set &%system_filter_user%& and
36141 &%system_filter_group%& as appropriate. For example:
36142 .code
36143 system_filter = /etc/mail/exim.filter
36144 system_filter_user = exim
36145 .endd
36146 If a system filter generates any deliveries directly to files or pipes (via the
36147 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36148 specified by setting &%system_filter_file_transport%& and
36149 &%system_filter_pipe_transport%&, respectively. Similarly,
36150 &%system_filter_reply_transport%& must be set to handle any messages generated
36151 by the &%reply%& command.
36152
36153
36154 .section "Testing a system filter" "SECID213"
36155 You can run simple tests of a system filter in the same way as for a user
36156 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36157 are permitted only in system filters are recognized.
36158
36159 If you want to test the combined effect of a system filter and a user filter,
36160 you can use both &%-bF%& and &%-bf%& on the same command line.
36161
36162
36163
36164 .section "Contents of a system filter" "SECID214"
36165 The language used to specify system filters is the same as for users' filter
36166 files. It is described in the separate end-user document &'Exim's interface to
36167 mail filtering'&. However, there are some additional features that are
36168 available only in system filters; these are described in subsequent sections.
36169 If they are encountered in a user's filter file or when testing with &%-bf%&,
36170 they cause errors.
36171
36172 .cindex "frozen messages" "manual thaw; testing in filter"
36173 There are two special conditions which, though available in users' filter
36174 files, are designed for use in system filters. The condition &%first_delivery%&
36175 is true only for the first attempt at delivering a message, and
36176 &%manually_thawed%& is true only if the message has been frozen, and
36177 subsequently thawed by an admin user. An explicit forced delivery counts as a
36178 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36179
36180 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36181 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36182 succeed, it will not be tried again.
36183 If you want Exim to retry an unseen delivery until it succeeds, you should
36184 arrange to set it up every time the filter runs.
36185
36186 When a system filter finishes running, the values of the variables &$n0$& &--
36187 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36188 users' filter files. Thus a system filter can, for example, set up &"scores"&
36189 to which users' filter files can refer.
36190
36191
36192
36193 .section "Additional variable for system filters" "SECID215"
36194 .vindex "&$recipients$&"
36195 The expansion variable &$recipients$&, containing a list of all the recipients
36196 of the message (separated by commas and white space), is available in system
36197 filters. It is not available in users' filters for privacy reasons.
36198
36199
36200
36201 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36202 .cindex "freezing messages"
36203 .cindex "message" "freezing"
36204 .cindex "message" "forced failure"
36205 .cindex "&%fail%&" "in system filter"
36206 .cindex "&%freeze%& in system filter"
36207 .cindex "&%defer%& in system filter"
36208 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36209 always available in system filters, but are not normally enabled in users'
36210 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36211 for the &(redirect)& router.) These commands can optionally be followed by the
36212 word &%text%& and a string containing an error message, for example:
36213 .code
36214 fail text "this message looks like spam to me"
36215 .endd
36216 The keyword &%text%& is optional if the next character is a double quote.
36217
36218 The &%defer%& command defers delivery of the original recipients of the
36219 message. The &%fail%& command causes all the original recipients to be failed,
36220 and a bounce message to be created. The &%freeze%& command suspends all
36221 delivery attempts for the original recipients. In all cases, any new deliveries
36222 that are specified by the filter are attempted as normal after the filter has
36223 run.
36224
36225 The &%freeze%& command is ignored if the message has been manually unfrozen and
36226 not manually frozen since. This means that automatic freezing by a system
36227 filter can be used as a way of checking out suspicious messages. If a message
36228 is found to be all right, manually unfreezing it allows it to be delivered.
36229
36230 .cindex "log" "&%fail%& command log line"
36231 .cindex "&%fail%&" "log line; reducing"
36232 The text given with a fail command is used as part of the bounce message as
36233 well as being written to the log. If the message is quite long, this can fill
36234 up a lot of log space when such failures are common. To reduce the size of the
36235 log message, Exim interprets the text in a special way if it starts with the
36236 two characters &`<<`& and contains &`>>`& later. The text between these two
36237 strings is written to the log, and the rest of the text is used in the bounce
36238 message. For example:
36239 .code
36240 fail "<<filter test 1>>Your message is rejected \
36241      because it contains attachments that we are \
36242      not prepared to receive."
36243 .endd
36244
36245 .cindex "loop" "caused by &%fail%&"
36246 Take great care with the &%fail%& command when basing the decision to fail on
36247 the contents of the message, because the bounce message will of course include
36248 the contents of the original message and will therefore trigger the &%fail%&
36249 command again (causing a mail loop) unless steps are taken to prevent this.
36250 Testing the &%error_message%& condition is one way to prevent this. You could
36251 use, for example
36252 .code
36253 if $message_body contains "this is spam" and not error_message
36254 then fail text "spam is not wanted here" endif
36255 .endd
36256 though of course that might let through unwanted bounce messages. The
36257 alternative is clever checking of the body and/or headers to detect bounces
36258 generated by the filter.
36259
36260 The interpretation of a system filter file ceases after a
36261 &%defer%&,
36262 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36263 set up earlier in the filter file are honoured, so you can use a sequence such
36264 as
36265 .code
36266 mail ...
36267 freeze
36268 .endd
36269 to send a specified message when the system filter is freezing (or deferring or
36270 failing) a message. The normal deliveries for the message do not, of course,
36271 take place.
36272
36273
36274
36275 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36276 .cindex "header lines" "adding; in system filter"
36277 .cindex "header lines" "removing; in system filter"
36278 .cindex "filter" "header lines; adding/removing"
36279 Two filter commands that are available only in system filters are:
36280 .code
36281 headers add <string>
36282 headers remove <string>
36283 .endd
36284 The argument for the &%headers add%& is a string that is expanded and then
36285 added to the end of the message's headers. It is the responsibility of the
36286 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36287 space is ignored, and if the string is otherwise empty, or if the expansion is
36288 forced to fail, the command has no effect.
36289
36290 You can use &"\n"& within the string, followed by white space, to specify
36291 continued header lines. More than one header may be added in one command by
36292 including &"\n"& within the string without any following white space. For
36293 example:
36294 .code
36295 headers add "X-header-1: ....\n  \
36296              continuation of X-header-1 ...\n\
36297              X-header-2: ...."
36298 .endd
36299 Note that the header line continuation white space after the first newline must
36300 be placed before the backslash that continues the input string, because white
36301 space after input continuations is ignored.
36302
36303 The argument for &%headers remove%& is a colon-separated list of header names.
36304 This command applies only to those headers that are stored with the message;
36305 those that are added at delivery time (such as &'Envelope-To:'& and
36306 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36307 header with the same name, they are all removed.
36308
36309 The &%headers%& command in a system filter makes an immediate change to the set
36310 of header lines that was received with the message (with possible additions
36311 from ACL processing). Subsequent commands in the system filter operate on the
36312 modified set, which also forms the basis for subsequent message delivery.
36313 Unless further modified during routing or transporting, this set of headers is
36314 used for all recipients of the message.
36315
36316 During routing and transporting, the variables that refer to the contents of
36317 header lines refer only to those lines that are in this set. Thus, header lines
36318 that are added by a system filter are visible to users' filter files and to all
36319 routers and transports. This contrasts with the manipulation of header lines by
36320 routers and transports, which is not immediate, but which instead is saved up
36321 until the message is actually being written (see section
36322 &<<SECTheadersaddrem>>&).
36323
36324 If the message is not delivered at the first attempt, header lines that were
36325 added by the system filter are stored with the message, and so are still
36326 present at the next delivery attempt. Header lines that were removed are still
36327 present, but marked &"deleted"& so that they are not transported with the
36328 message. For this reason, it is usual to make the &%headers%& command
36329 conditional on &%first_delivery%& so that the set of header lines is not
36330 modified more than once.
36331
36332 Because header modification in a system filter acts immediately, you have to
36333 use an indirect approach if you want to modify the contents of a header line.
36334 For example:
36335 .code
36336 headers add "Old-Subject: $h_subject:"
36337 headers remove "Subject"
36338 headers add "Subject: new subject (was: $h_old-subject:)"
36339 headers remove "Old-Subject"
36340 .endd
36341
36342
36343
36344 .section "Setting an errors address in a system filter" "SECID217"
36345 .cindex "envelope from"
36346 .cindex "envelope sender"
36347 In a system filter, if a &%deliver%& command is followed by
36348 .code
36349 errors_to <some address>
36350 .endd
36351 in order to change the envelope sender (and hence the error reporting) for that
36352 delivery, any address may be specified. (In a user filter, only the current
36353 user's address can be set.) For example, if some mail is being monitored, you
36354 might use
36355 .code
36356 unseen deliver monitor@spying.example errors_to root@local.example
36357 .endd
36358 to take a copy which would not be sent back to the normal error reporting
36359 address if its delivery failed.
36360
36361
36362
36363 .section "Per-address filtering" "SECTperaddfil"
36364 .vindex "&$domain_data$&"
36365 .vindex "&$local_part_data$&"
36366 In contrast to the system filter, which is run just once per message for each
36367 delivery attempt, it is also possible to set up a system-wide filtering
36368 operation that runs once for each recipient address. In this case, variables
36369 such as &$local_part_data$& and &$domain_data$& can be used,
36370 and indeed, the choice of filter file could be made dependent on them.
36371 This is an example of a router which implements such a filter:
36372 .code
36373 central_filter:
36374   check_local_user
36375   driver = redirect
36376   domains = +local_domains
36377   file = /central/filters/$local_part_data
36378   no_verify
36379   allow_filter
36380   allow_freeze
36381 .endd
36382 The filter is run in a separate process under its own uid. Therefore, either
36383 &%check_local_user%& must be set (as above), in which case the filter is run as
36384 the local user, or the &%user%& option must be used to specify which user to
36385 use. If both are set, &%user%& overrides.
36386
36387 Care should be taken to ensure that none of the commands in the filter file
36388 specify a significant delivery if the message is to go on to be delivered to
36389 its intended recipient. The router will not then claim to have dealt with the
36390 address, so it will be passed on to subsequent routers to be delivered in the
36391 normal way.
36392 .ecindex IIDsysfil1
36393 .ecindex IIDsysfil2
36394 .ecindex IIDsysfil3
36395
36396
36397
36398
36399
36400
36401 . ////////////////////////////////////////////////////////////////////////////
36402 . ////////////////////////////////////////////////////////////////////////////
36403
36404 .chapter "Message processing" "CHAPmsgproc"
36405 .scindex IIDmesproc "message" "general processing"
36406 Exim performs various transformations on the sender and recipient addresses of
36407 all messages that it handles, and also on the messages' header lines. Some of
36408 these are optional and configurable, while others always take place. All of
36409 this processing, except rewriting as a result of routing, and the addition or
36410 removal of header lines while delivering, happens when a message is received,
36411 before it is placed on Exim's queue.
36412
36413 Some of the automatic processing takes place by default only for
36414 &"locally-originated"& messages. This adjective is used to describe messages
36415 that are not received over TCP/IP, but instead are passed to an Exim process on
36416 its standard input. This includes the interactive &"local SMTP"& case that is
36417 set up by the &%-bs%& command line option.
36418
36419 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36420 or ::1) are not considered to be locally-originated. Exim does not treat the
36421 loopback interface specially in any way.
36422
36423 If you want the loopback interface to be treated specially, you must ensure
36424 that there are appropriate entries in your ACLs.
36425
36426
36427
36428
36429 .section "Submission mode for non-local messages" "SECTsubmodnon"
36430 .cindex "message" "submission"
36431 .cindex "submission mode"
36432 Processing that happens automatically for locally-originated messages (unless
36433 &%suppress_local_fixups%& is set) can also be requested for messages that are
36434 received over TCP/IP. The term &"submission mode"& is used to describe this
36435 state. Submission mode is set by the modifier
36436 .code
36437 control = submission
36438 .endd
36439 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36440 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36441 a local submission, and is normally used when the source of the message is
36442 known to be an MUA running on a client host (as opposed to an MTA). For
36443 example, to set submission mode for messages originating on the IPv4 loopback
36444 interface, you could include the following in the MAIL ACL:
36445 .code
36446 warn  hosts = 127.0.0.1
36447       control = submission
36448 .endd
36449 .cindex "&%sender_retain%& submission option"
36450 There are some options that can be used when setting submission mode. A slash
36451 is used to separate options. For example:
36452 .code
36453 control = submission/sender_retain
36454 .endd
36455 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36456 true and &%local_from_check%& false for the current incoming message. The first
36457 of these allows an existing &'Sender:'& header in the message to remain, and
36458 the second suppresses the check to ensure that &'From:'& matches the
36459 authenticated sender. With this setting, Exim still fixes up messages by adding
36460 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36461 attempt to check sender authenticity in header lines.
36462
36463 When &%sender_retain%& is not set, a submission mode setting may specify a
36464 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36465 example:
36466 .code
36467 control = submission/domain=some.domain
36468 .endd
36469 The domain may be empty. How this value is used is described in sections
36470 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36471 that allows you to specify the user's full name for inclusion in a created
36472 &'Sender:'& or &'From:'& header line. For example:
36473 .code
36474 accept authenticated = *
36475        control = submission/domain=wonderland.example/\
36476                             name=${lookup {$authenticated_id} \
36477                                    lsearch {/etc/exim/namelist}}
36478 .endd
36479 Because the name may contain any characters, including slashes, the &%name%&
36480 option must be given last. The remainder of the string is used as the name. For
36481 the example above, if &_/etc/exim/namelist_& contains:
36482 .code
36483 bigegg:  Humpty Dumpty
36484 .endd
36485 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36486 line would be:
36487 .code
36488 Sender: Humpty Dumpty <bigegg@wonderland.example>
36489 .endd
36490 .cindex "return path" "in submission mode"
36491 By default, submission mode forces the return path to the same address as is
36492 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36493 specified, the return path is also left unchanged.
36494
36495 &*Note*&: The changes caused by submission mode take effect after the predata
36496 ACL. This means that any sender checks performed before the fix-ups use the
36497 untrusted sender address specified by the user, not the trusted sender address
36498 specified by submission mode. Although this might be slightly unexpected, it
36499 does mean that you can configure ACL checks to spot that a user is trying to
36500 spoof another's address.
36501
36502 .section "Line endings" "SECTlineendings"
36503 .cindex "line endings"
36504 .cindex "carriage return"
36505 .cindex "linefeed"
36506 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36507 linefeed) is the line ending for messages transmitted over the Internet using
36508 SMTP over TCP/IP. However, within individual operating systems, different
36509 conventions are used. For example, Unix-like systems use just LF, but others
36510 use CRLF or just CR.
36511
36512 Exim was designed for Unix-like systems, and internally, it stores messages
36513 using the system's convention of a single LF as a line terminator. When
36514 receiving a message, all line endings are translated to this standard format.
36515 Originally, it was thought that programs that passed messages directly to an
36516 MTA within an operating system would use that system's convention. Experience
36517 has shown that this is not the case; for example, there are Unix applications
36518 that use CRLF in this circumstance. For this reason, and for compatibility with
36519 other MTAs, the way Exim handles line endings for all messages is now as
36520 follows:
36521
36522 .ilist
36523 CR is treated as a line ending; if it is immediately followed by LF, the LF
36524 is ignored.
36525 .next
36526 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36527 nor a local message in the state where a line containing only a dot is a
36528 terminator.
36529 .next
36530 If a bare CR is encountered within a header line, an extra space is added after
36531 the line terminator so as not to end the header line. The reasoning behind this
36532 is that bare CRs in header lines are most likely either to be mistakes, or
36533 people trying to play silly games.
36534 .next
36535 If the first header line received in a message ends with CRLF, a subsequent
36536 bare LF in a header line is treated in the same way as a bare CR in a header
36537 line and a bare LF in a body line is replaced with a space.
36538 .next
36539 If the first header line received in a message does not end with CRLF, a subsequent
36540 LF not preceded by CR is treated as a line ending.
36541 .endlist
36542
36543
36544
36545
36546
36547 .section "Unqualified addresses" "SECID218"
36548 .cindex "unqualified addresses"
36549 .cindex "address" "qualification"
36550 By default, Exim expects every envelope address it receives from an external
36551 host to be fully qualified. Unqualified addresses cause negative responses to
36552 SMTP commands. However, because SMTP is used as a means of transporting
36553 messages from MUAs running on personal workstations, there is sometimes a
36554 requirement to accept unqualified addresses from specific hosts or IP networks.
36555
36556 Exim has two options that separately control which hosts may send unqualified
36557 sender or recipient addresses in SMTP commands, namely
36558 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36559 cases, if an unqualified address is accepted, it is qualified by adding the
36560 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36561
36562 .oindex "&%qualify_domain%&"
36563 .oindex "&%qualify_recipient%&"
36564 Unqualified addresses in header lines are automatically qualified for messages
36565 that are locally originated, unless the &%-bnq%& option is given on the command
36566 line. For messages received over SMTP, unqualified addresses in header lines
36567 are qualified only if unqualified addresses are permitted in SMTP commands. In
36568 other words, such qualification is also controlled by
36569 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36570
36571
36572
36573
36574 .section "The UUCP From line" "SECID219"
36575 .cindex "&""From""& line"
36576 .cindex "UUCP" "&""From""& line"
36577 .cindex "sender" "address"
36578 .oindex "&%uucp_from_pattern%&"
36579 .oindex "&%uucp_from_sender%&"
36580 .cindex "envelope from"
36581 .cindex "envelope sender"
36582 .cindex "Sendmail compatibility" "&""From""& line"
36583 Messages that have come from UUCP (and some other applications) often begin
36584 with a line containing the envelope sender and a timestamp, following the word
36585 &"From"&. Examples of two common formats are:
36586 .code
36587 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36588 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36589 .endd
36590 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36591 Exim recognizes such lines at the start of messages that are submitted to it
36592 via the command line (that is, on the standard input). It does not recognize
36593 such lines in incoming SMTP messages, unless the sending host matches
36594 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36595 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36596 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36597 default value matches the two common cases shown above and puts the address
36598 that follows &"From"& into &$1$&.
36599
36600 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36601 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36602 a trusted user, the message's sender address is constructed by expanding the
36603 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36604 then parsed as an RFC 2822 address. If there is no domain, the local part is
36605 qualified with &%qualify_domain%& unless it is the empty string. However, if
36606 the command line &%-f%& option is used, it overrides the &"From"& line.
36607
36608 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36609 sender address is not changed. This is also the case for incoming SMTP messages
36610 that are permitted to contain &"From"& lines.
36611
36612 Only one &"From"& line is recognized. If there is more than one, the second is
36613 treated as a data line that starts the body of the message, as it is not valid
36614 as a header line. This also happens if a &"From"& line is present in an
36615 incoming SMTP message from a source that is not permitted to send them.
36616
36617
36618
36619 .section "Header lines"
36620 .subsection "Resent- header lines" SECID220
36621 .chindex Resent-
36622 RFC 2822 makes provision for sets of header lines starting with the string
36623 &`Resent-`& to be added to a message when it is resent by the original
36624 recipient to somebody else. These headers are &'Resent-Date:'&,
36625 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36626 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36627
36628 .blockquote
36629 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36630 processing of replies or other such automatic actions on messages.'&
36631 .endblockquote
36632
36633 This leaves things a bit vague as far as other processing actions such as
36634 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36635 follows:
36636
36637 .ilist
36638 A &'Resent-From:'& line that just contains the login id of the submitting user
36639 is automatically rewritten in the same way as &'From:'& (see below).
36640 .next
36641 If there's a rewriting rule for a particular header line, it is also applied to
36642 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36643 &'From:'& also rewrites &'Resent-From:'&.
36644 .next
36645 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36646 also removed.
36647 .next
36648 For a locally-submitted message,
36649 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36650 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36651 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36652 included in log lines in this case.
36653 .next
36654 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36655 &%Resent-%& header lines are present.
36656 .endlist
36657
36658
36659
36660
36661 .subsection Auto-Submitted: SECID221
36662 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36663 includes the header line:
36664 .code
36665 Auto-Submitted: auto-replied
36666 .endd
36667
36668 .subsection Bcc: SECID222
36669 .cindex "&'Bcc:'& header line"
36670 If Exim is called with the &%-t%& option, to take recipient addresses from a
36671 message's header, it removes any &'Bcc:'& header line that may exist (after
36672 extracting its addresses). If &%-t%& is not present on the command line, any
36673 existing &'Bcc:'& is not removed.
36674
36675
36676 .subsection Date: SECID223
36677 .cindex Date:
36678 If a locally-generated or submission-mode message has no &'Date:'& header line,
36679 Exim adds one, using the current date and time, unless the
36680 &%suppress_local_fixups%& control has been specified.
36681
36682 .subsection Delivery-date: SECID224
36683 .cindex "&'Delivery-date:'& header line"
36684 .oindex "&%delivery_date_remove%&"
36685 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36686 set. Exim can be configured to add them to the final delivery of messages. (See
36687 the generic &%delivery_date_add%& transport option.) They should not be present
36688 in messages in transit. If the &%delivery_date_remove%& configuration option is
36689 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36690 messages.
36691
36692
36693 .subsection Envelope-to: SECID225
36694 .chindex Envelope-to:
36695 .oindex "&%envelope_to_remove%&"
36696 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36697 Exim can be configured to add them to the final delivery of messages. (See the
36698 generic &%envelope_to_add%& transport option.) They should not be present in
36699 messages in transit. If the &%envelope_to_remove%& configuration option is set
36700 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36701 messages.
36702
36703
36704 .subsection From: SECTthefrohea
36705 .chindex From:
36706 .cindex "Sendmail compatibility" "&""From""& line"
36707 .cindex "message" "submission"
36708 .cindex "submission mode"
36709 If a submission-mode message does not contain a &'From:'& header line, Exim
36710 adds one if either of the following conditions is true:
36711
36712 .ilist
36713 The envelope sender address is not empty (that is, this is not a bounce
36714 message). The added header line copies the envelope sender address.
36715 .next
36716 .vindex "&$authenticated_id$&"
36717 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36718 .olist
36719 .vindex "&$qualify_domain$&"
36720 If no domain is specified by the submission control, the local part is
36721 &$authenticated_id$& and the domain is &$qualify_domain$&.
36722 .next
36723 If a non-empty domain is specified by the submission control, the local
36724 part is &$authenticated_id$&, and the domain is the specified domain.
36725 .next
36726 If an empty domain is specified by the submission control,
36727 &$authenticated_id$& is assumed to be the complete address.
36728 .endlist
36729 .endlist
36730
36731 A non-empty envelope sender takes precedence.
36732
36733 If a locally-generated incoming message does not contain a &'From:'& header
36734 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36735 containing the sender's address. The calling user's login name and full name
36736 are used to construct the address, as described in section &<<SECTconstr>>&.
36737 They are obtained from the password data by calling &[getpwuid()]& (but see the
36738 &%unknown_login%& configuration option). The address is qualified with
36739 &%qualify_domain%&.
36740
36741 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36742 &'From:'& header line containing just the unqualified login name of the calling
36743 user, this is replaced by an address containing the user's login name and full
36744 name as described in section &<<SECTconstr>>&.
36745
36746
36747 .subsection Message-ID: SECID226
36748 .chindex Message-ID:
36749 .cindex "message" "submission"
36750 .oindex "&%message_id_header_text%&"
36751 If a locally-generated or submission-mode incoming message does not contain a
36752 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36753 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36754 to the message. If there are any &'Resent-:'& headers in the message, it
36755 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36756 message id, preceded by the letter E to ensure it starts with a letter, and
36757 followed by @ and the primary host name. Additional information can be included
36758 in this header line by setting the &%message_id_header_text%& and/or
36759 &%message_id_header_domain%& options.
36760
36761
36762 .subsection Received: SECID227
36763 .chindex Received:
36764 A &'Received:'& header line is added at the start of every message. The
36765 contents are defined by the &%received_header_text%& configuration option, and
36766 Exim automatically adds a semicolon and a timestamp to the configured string.
36767
36768 The &'Received:'& header is generated as soon as the message's header lines
36769 have been received. At this stage, the timestamp in the &'Received:'& header
36770 line is the time that the message started to be received. This is the value
36771 that is seen by the DATA ACL and by the &[local_scan()]& function.
36772
36773 Once a message is accepted, the timestamp in the &'Received:'& header line is
36774 changed to the time of acceptance, which is (apart from a small delay while the
36775 -H spool file is written) the earliest time at which delivery could start.
36776
36777
36778 .subsection References: SECID228
36779 .chindex References:
36780 Messages created by the &(autoreply)& transport include a &'References:'&
36781 header line. This is constructed according to the rules that are described in
36782 section 3.64 of RFC 2822 (which states that replies should contain such a
36783 header line), and section 3.14 of RFC 3834 (which states that automatic
36784 responses are not different in this respect). However, because some mail
36785 processing software does not cope well with very long header lines, no more
36786 than 12 message IDs are copied from the &'References:'& header line in the
36787 incoming message. If there are more than 12, the first one and then the final
36788 11 are copied, before adding the message ID of the incoming message.
36789
36790
36791
36792 .subsection Return-path: SECID229
36793 .chindex Return-path:
36794 .oindex "&%return_path_remove%&"
36795 &'Return-path:'& header lines are defined as something an MTA may insert when
36796 it does the final delivery of messages. (See the generic &%return_path_add%&
36797 transport option.) Therefore, they should not be present in messages in
36798 transit. If the &%return_path_remove%& configuration option is set (the
36799 default), Exim removes &'Return-path:'& header lines from incoming messages.
36800
36801
36802
36803 .subsection Sender: SECTthesenhea
36804 .cindex "&'Sender:'& header line"
36805 .cindex "message" "submission"
36806 .chindex Sender:
36807 For a locally-originated message from an untrusted user, Exim may remove an
36808 existing &'Sender:'& header line, and it may add a new one. You can modify
36809 these actions by setting the &%local_sender_retain%& option true, the
36810 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36811 control setting.
36812
36813 When a local message is received from an untrusted user and
36814 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36815 control has not been set, a check is made to see if the address given in the
36816 &'From:'& header line is the correct (local) sender of the message. The address
36817 that is expected has the login name as the local part and the value of
36818 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36819 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36820 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36821 line is added to the message.
36822
36823 If you set &%local_from_check%& false, this checking does not occur. However,
36824 the removal of an existing &'Sender:'& line still happens, unless you also set
36825 &%local_sender_retain%& to be true. It is not possible to set both of these
36826 options true at the same time.
36827
36828 .cindex "submission mode"
36829 By default, no processing of &'Sender:'& header lines is done for messages
36830 received over TCP/IP or for messages submitted by trusted users. However, when
36831 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36832 not specified on the submission control, the following processing takes place:
36833
36834 .vindex "&$authenticated_id$&"
36835 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36836 authenticated, and &$authenticated_id$& is not empty, a sender address is
36837 created as follows:
36838
36839 .ilist
36840 .vindex "&$qualify_domain$&"
36841 If no domain is specified by the submission control, the local part is
36842 &$authenticated_id$& and the domain is &$qualify_domain$&.
36843 .next
36844 If a non-empty domain is specified by the submission control, the local part
36845 is &$authenticated_id$&, and the domain is the specified domain.
36846 .next
36847 If an empty domain is specified by the submission control,
36848 &$authenticated_id$& is assumed to be the complete address.
36849 .endlist
36850
36851 This address is compared with the address in the &'From:'& header line. If they
36852 are different, a &'Sender:'& header line containing the created address is
36853 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36854 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36855
36856 .cindex "return path" "created from &'Sender:'&"
36857 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36858 the message (the envelope sender address) is changed to be the same address,
36859 except in the case of submission mode when &%sender_retain%& is specified.
36860
36861
36862
36863 .section "Adding and removing header lines in routers and transports" &&&
36864          "SECTheadersaddrem"
36865 .cindex "header lines" "adding; in router or transport"
36866 .cindex "header lines" "removing; in router or transport"
36867 When a message is delivered, the addition and removal of header lines can be
36868 specified in a system filter, or on any of the routers and transports that
36869 process the message. Section &<<SECTaddremheasys>>& contains details about
36870 modifying headers in a system filter. Header lines can also be added in an ACL
36871 as a message is received (see section &<<SECTaddheadacl>>&).
36872
36873 In contrast to what happens in a system filter, header modifications that are
36874 specified on routers and transports apply only to the particular recipient
36875 addresses that are being processed by those routers and transports. These
36876 changes do not actually take place until a copy of the message is being
36877 transported. Therefore, they do not affect the basic set of header lines, and
36878 they do not affect the values of the variables that refer to header lines.
36879
36880 &*Note*&: In particular, this means that any expansions in the configuration of
36881 the transport cannot refer to the modified header lines, because such
36882 expansions all occur before the message is actually transported.
36883
36884 For both routers and transports, the argument of a &%headers_add%&
36885 option must be in the form of one or more RFC 2822 header lines, separated by
36886 newlines (coded as &"\n"&). For example:
36887 .code
36888 headers_add = X-added-header: added by $primary_hostname\n\
36889               X-added-second: another added header line
36890 .endd
36891 Exim does not check the syntax of these added header lines.
36892
36893 Multiple &%headers_add%& options for a single router or transport can be
36894 specified; the values will append to a single list of header lines.
36895 Each header-line is separately expanded.
36896
36897 The argument of a &%headers_remove%& option must consist of a colon-separated
36898 list of header names. This is confusing, because header names themselves are
36899 often terminated by colons. In this case, the colons are the list separators,
36900 not part of the names. For example:
36901 .code
36902 headers_remove = return-receipt-to:acknowledge-to
36903 .endd
36904
36905 Multiple &%headers_remove%& options for a single router or transport can be
36906 specified; the arguments will append to a single header-names list.
36907 Each item is separately expanded.
36908 Note that colons in complex expansions which are used to
36909 form all or part of a &%headers_remove%& list
36910 will act as list separators.
36911
36912 When &%headers_add%& or &%headers_remove%& is specified on a router,
36913 items are expanded at routing time,
36914 and then associated with all addresses that are
36915 accepted by that router, and also with any new addresses that it generates. If
36916 an address passes through several routers as a result of aliasing or
36917 forwarding, the changes are cumulative.
36918
36919 .oindex "&%unseen%&"
36920 However, this does not apply to multiple routers that result from the use of
36921 the &%unseen%& option. Any header modifications that were specified by the
36922 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36923
36924 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36925 settings cannot be delivered together in a batch, so a transport is always
36926 dealing with a set of addresses that have the same header-processing
36927 requirements.
36928
36929 The transport starts by writing the original set of header lines that arrived
36930 with the message, possibly modified by the system filter. As it writes out
36931 these lines, it consults the list of header names that were attached to the
36932 recipient address(es) by &%headers_remove%& options in routers, and it also
36933 consults the transport's own &%headers_remove%& option. Header lines whose
36934 names are on either of these lists are not written out. If there are multiple
36935 instances of any listed header, they are all skipped.
36936
36937 After the remaining original header lines have been written, new header
36938 lines that were specified by routers' &%headers_add%& options are written, in
36939 the order in which they were attached to the address. These are followed by any
36940 header lines specified by the transport's &%headers_add%& option.
36941
36942 This way of handling header line modifications in routers and transports has
36943 the following consequences:
36944
36945 .ilist
36946 The original set of header lines, possibly modified by the system filter,
36947 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36948 to it, at all times.
36949 .next
36950 Header lines that are added by a router's
36951 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36952 expansion syntax in subsequent routers or the transport.
36953 .next
36954 Conversely, header lines that are specified for removal by &%headers_remove%&
36955 in a router remain visible to subsequent routers and the transport.
36956 .next
36957 Headers added to an address by &%headers_add%& in a router cannot be removed by
36958 a later router or by a transport.
36959 .next
36960 An added header can refer to the contents of an original header that is to be
36961 removed, even it has the same name as the added header. For example:
36962 .code
36963 headers_remove = subject
36964 headers_add = Subject: new subject (was: $h_subject:)
36965 .endd
36966 .endlist
36967
36968 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36969 for a &(redirect)& router that has the &%one_time%& option set.
36970
36971
36972
36973
36974
36975 .section "Constructed addresses" "SECTconstr"
36976 .cindex "address" "constructed"
36977 .cindex "constructed address"
36978 When Exim constructs a sender address for a locally-generated message, it uses
36979 the form
36980 .display
36981 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36982 .endd
36983 For example:
36984 .code
36985 Zaphod Beeblebrox <zaphod@end.univ.example>
36986 .endd
36987 The user name is obtained from the &%-F%& command line option if set, or
36988 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36989 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36990 ampersand character, this is replaced by the login name with the first letter
36991 upper cased, as is conventional in a number of operating systems. See the
36992 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36993 The &%unknown_username%& option can be used to specify user names in cases when
36994 there is no password file entry.
36995
36996 .cindex "RFC 2047"
36997 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36998 parts of it if necessary. In addition, if it contains any non-printing
36999 characters, it is encoded as described in RFC 2047, which defines a way of
37000 including non-ASCII characters in header lines. The value of the
37001 &%headers_charset%& option specifies the name of the encoding that is used (the
37002 characters are assumed to be in this encoding). The setting of
37003 &%print_topbitchars%& controls whether characters with the top bit set (that
37004 is, with codes greater than 127) count as printing characters or not.
37005
37006
37007
37008 .section "Case of local parts" "SECID230"
37009 .cindex "case of local parts"
37010 .cindex "local part" "case of"
37011 RFC 2822 states that the case of letters in the local parts of addresses cannot
37012 be assumed to be non-significant. Exim preserves the case of local parts of
37013 addresses, but by default it uses a lower-cased form when it is routing,
37014 because on most Unix systems, usernames are in lower case and case-insensitive
37015 routing is required. However, any particular router can be made to use the
37016 original case for local parts by setting the &%caseful_local_part%& generic
37017 router option.
37018
37019 .cindex "mixed-case login names"
37020 If you must have mixed-case user names on your system, the best way to proceed,
37021 assuming you want case-independent handling of incoming email, is to set up
37022 your first router to convert incoming local parts in your domains to the
37023 correct case by means of a file lookup. For example:
37024 .code
37025 correct_case:
37026   driver = redirect
37027   domains = +local_domains
37028   data = ${lookup{$local_part}cdb\
37029               {/etc/usercased.cdb}{$value}fail}\
37030               @$domain
37031 .endd
37032 For this router, the local part is forced to lower case by the default action
37033 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
37034 up a new local part in the correct case. If you then set &%caseful_local_part%&
37035 on any subsequent routers which process your domains, they will operate on
37036 local parts with the correct case in a case-sensitive manner.
37037
37038
37039
37040 .section "Dots in local parts" "SECID231"
37041 .cindex "dot" "in local part"
37042 .cindex "local part" "dots in"
37043 RFC 2822 forbids empty components in local parts. That is, an unquoted local
37044 part may not begin or end with a dot, nor have two consecutive dots in the
37045 middle. However, it seems that many MTAs do not enforce this, so Exim permits
37046 empty components for compatibility.
37047
37048
37049
37050 .section "Rewriting addresses" "SECID232"
37051 .cindex "rewriting" "addresses"
37052 Rewriting of sender and recipient addresses, and addresses in headers, can
37053 happen automatically, or as the result of configuration options, as described
37054 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
37055 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
37056
37057 Automatic rewriting includes qualification, as mentioned above. The other case
37058 in which it can happen is when an incomplete non-local domain is given. The
37059 routing process may cause this to be expanded into the full domain name. For
37060 example, a header such as
37061 .code
37062 To: hare@teaparty
37063 .endd
37064 might get rewritten as
37065 .code
37066 To: hare@teaparty.wonderland.fict.example
37067 .endd
37068 Rewriting as a result of routing is the one kind of message processing that
37069 does not happen at input time, as it cannot be done until the address has
37070 been routed.
37071
37072 Strictly, one should not do &'any'& deliveries of a message until all its
37073 addresses have been routed, in case any of the headers get changed as a
37074 result of routing. However, doing this in practice would hold up many
37075 deliveries for unreasonable amounts of time, just because one address could not
37076 immediately be routed. Exim therefore does not delay other deliveries when
37077 routing of one or more addresses is deferred.
37078 .ecindex IIDmesproc
37079
37080
37081
37082 . ////////////////////////////////////////////////////////////////////////////
37083 . ////////////////////////////////////////////////////////////////////////////
37084
37085 .chapter "SMTP processing" "CHAPSMTP"
37086 .scindex IIDsmtpproc1 "SMTP" "processing details"
37087 .scindex IIDsmtpproc2 "LMTP" "processing details"
37088 Exim supports a number of different ways of using the SMTP protocol, and its
37089 LMTP variant, which is an interactive protocol for transferring messages into a
37090 closed mail store application. This chapter contains details of how SMTP is
37091 processed. For incoming mail, the following are available:
37092
37093 .ilist
37094 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37095 .next
37096 SMTP over the standard input and output (the &%-bs%& option);
37097 .next
37098 Batched SMTP on the standard input (the &%-bS%& option).
37099 .endlist
37100
37101 For mail delivery, the following are available:
37102
37103 .ilist
37104 SMTP over TCP/IP (the &(smtp)& transport);
37105 .next
37106 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37107 &"lmtp"&);
37108 .next
37109 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37110 transport);
37111 .next
37112 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37113 the &%use_bsmtp%& option set).
37114 .endlist
37115
37116 &'Batched SMTP'& is the name for a process in which batches of messages are
37117 stored in or read from files (or pipes), in a format in which SMTP commands are
37118 used to contain the envelope information.
37119
37120
37121
37122 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37123 .cindex "SMTP" "outgoing over TCP/IP"
37124 .cindex "outgoing SMTP over TCP/IP"
37125 .cindex "LMTP" "over TCP/IP"
37126 .cindex "outgoing LMTP over TCP/IP"
37127 .cindex "EHLO"
37128 .cindex "HELO"
37129 .cindex "SIZE" "option on MAIL command"
37130 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37131 The &%protocol%& option selects which protocol is to be used, but the actual
37132 processing is the same in both cases.
37133
37134 .cindex "ESMTP extensions" SIZE
37135 If, in response to its EHLO command, Exim is told that the SIZE
37136 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37137 command. The value of <&'n'&> is the message size plus the value of the
37138 &%size_addition%& option (default 1024) to allow for additions to the message
37139 such as per-transport header lines, or changes made in a
37140 .cindex "transport" "filter"
37141 .cindex "filter" "transport filter"
37142 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37143 suppressed.
37144
37145 If the remote server advertises support for PIPELINING, Exim uses the
37146 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37147 required for the transaction.
37148
37149 If the remote server advertises support for the STARTTLS command, and Exim
37150 was built to support TLS encryption, it tries to start a TLS session unless the
37151 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37152 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37153 is called for verification.
37154
37155 If the remote server advertises support for the AUTH command, Exim scans
37156 the authenticators configuration for any suitable client settings, as described
37157 in chapter &<<CHAPSMTPAUTH>>&.
37158
37159 .cindex "carriage return"
37160 .cindex "linefeed"
37161 Responses from the remote host are supposed to be terminated by CR followed by
37162 LF. However, there are known to be hosts that do not send CR characters, so in
37163 order to be able to interwork with such hosts, Exim treats LF on its own as a
37164 line terminator.
37165
37166 If a message contains a number of different addresses, all those with the same
37167 characteristics (for example, the same envelope sender) that resolve to the
37168 same set of hosts, in the same order, are sent in a single SMTP transaction,
37169 even if they are for different domains, unless there are more than the setting
37170 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37171 they are split into groups containing no more than &%max_rcpt%&s addresses
37172 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37173 in parallel sessions. The order of hosts with identical MX values is not
37174 significant when checking whether addresses can be batched in this way.
37175
37176 When the &(smtp)& transport suffers a temporary failure that is not
37177 message-related, Exim updates its transport-specific database, which contains
37178 records indexed by host name that remember which messages are waiting for each
37179 particular host. It also updates the retry database with new retry times.
37180
37181 .cindex "hints database" "retry keys"
37182 Exim's retry hints are based on host name plus IP address, so if one address of
37183 a multi-homed host is broken, it will soon be skipped most of the time.
37184 See the next section for more detail about error handling.
37185
37186 .cindex "SMTP" "passed connection"
37187 .cindex "SMTP" "batching over TCP/IP"
37188 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37189 looks in the hints database for the transport to see if there are any queued
37190 messages waiting for the host to which it is connected. If it finds one, it
37191 creates a new Exim process using the &%-MC%& option (which can only be used by
37192 a process running as root or the Exim user) and passes the TCP/IP socket to it
37193 so that it can deliver another message using the same socket. The new process
37194 does only those deliveries that are routed to the connected host, and may in
37195 turn pass the socket on to a third process, and so on.
37196
37197 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37198 limit the number of messages sent down a single TCP/IP connection.
37199
37200 .cindex "asterisk" "after IP address"
37201 The second and subsequent messages delivered down an existing connection are
37202 identified in the main log by the addition of an asterisk after the closing
37203 square bracket of the IP address.
37204
37205
37206
37207
37208 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37209 .cindex "error" "in outgoing SMTP"
37210 .cindex "SMTP" "errors in outgoing"
37211 .cindex "host" "error"
37212 Three different kinds of error are recognized for outgoing SMTP: host errors,
37213 message errors, and recipient errors.
37214
37215 .vlist
37216 .vitem "&*Host errors*&"
37217 A host error is not associated with a particular message or with a
37218 particular recipient of a message. The host errors are:
37219
37220 .ilist
37221 Connection refused or timed out,
37222 .next
37223 Any error response code on connection,
37224 .next
37225 Any error response code to EHLO or HELO,
37226 .next
37227 Loss of connection at any time, except after &"."&,
37228 .next
37229 I/O errors at any time,
37230 .next
37231 Timeouts during the session, other than in response to MAIL, RCPT or
37232 the &"."& at the end of the data.
37233 .endlist ilist
37234
37235 For a host error, a permanent error response on connection, or in response to
37236 EHLO, causes all addresses routed to the host to be failed. Any other host
37237 error causes all addresses to be deferred, and retry data to be created for the
37238 host. It is not tried again, for any message, until its retry time arrives. If
37239 the current set of addresses are not all delivered in this run (to some
37240 alternative host), the message is added to the list of those waiting for this
37241 host, so if it is still undelivered when a subsequent successful delivery is
37242 made to the host, it will be sent down the same SMTP connection.
37243
37244 .vitem "&*Message errors*&"
37245 .cindex "message" "error"
37246 A message error is associated with a particular message when sent to a
37247 particular host, but not with a particular recipient of the message. The
37248 message errors are:
37249
37250 .ilist
37251 Any error response code to MAIL, DATA, or the &"."& that terminates
37252 the data,
37253 .next
37254 Timeout after MAIL,
37255 .next
37256 Timeout or loss of connection after the &"."& that terminates the data. A
37257 timeout after the DATA command itself is treated as a host error, as is loss of
37258 connection at any other time.
37259 .endlist ilist
37260
37261 For a message error, a permanent error response (5&'xx'&) causes all addresses
37262 to be failed, and a delivery error report to be returned to the sender. A
37263 temporary error response (4&'xx'&), or one of the timeouts, causes all
37264 addresses to be deferred. Retry data is not created for the host, but instead,
37265 a retry record for the combination of host plus message id is created. The
37266 message is not added to the list of those waiting for this host. This ensures
37267 that the failing message will not be sent to this host again until the retry
37268 time arrives. However, other messages that are routed to the host are not
37269 affected, so if it is some property of the message that is causing the error,
37270 it will not stop the delivery of other mail.
37271
37272 If the remote host specified support for the SIZE parameter in its response
37273 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37274 over-large message will cause a message error because the error arrives as a
37275 response to MAIL.
37276
37277 .vitem "&*Recipient errors*&"
37278 .cindex "recipient" "error"
37279 A recipient error is associated with a particular recipient of a message. The
37280 recipient errors are:
37281
37282 .ilist
37283 Any error response to RCPT,
37284 .next
37285 Timeout after RCPT.
37286 .endlist
37287
37288 For a recipient error, a permanent error response (5&'xx'&) causes the
37289 recipient address to be failed, and a bounce message to be returned to the
37290 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37291 address to be deferred, and routing retry data to be created for it. This is
37292 used to delay processing of the address in subsequent queue runs, until its
37293 routing retry time arrives. This applies to all messages, but because it
37294 operates only in queue runs, one attempt will be made to deliver a new message
37295 to the failing address before the delay starts to operate. This ensures that,
37296 if the failure is really related to the message rather than the recipient
37297 (&"message too big for this recipient"& is a possible example), other messages
37298 have a chance of getting delivered. If a delivery to the address does succeed,
37299 the retry information gets cleared, so all stuck messages get tried again, and
37300 the retry clock is reset.
37301
37302 The message is not added to the list of those waiting for this host. Use of the
37303 host for other messages is unaffected, and except in the case of a timeout,
37304 other recipients are processed independently, and may be successfully delivered
37305 in the current SMTP session. After a timeout it is of course impossible to
37306 proceed with the session, so all addresses get deferred. However, those other
37307 than the one that failed do not suffer any subsequent retry delays. Therefore,
37308 if one recipient is causing trouble, the others have a chance of getting
37309 through when a subsequent delivery attempt occurs before the failing
37310 recipient's retry time.
37311 .endlist
37312
37313 In all cases, if there are other hosts (or IP addresses) available for the
37314 current set of addresses (for example, from multiple MX records), they are
37315 tried in this run for any undelivered addresses, subject of course to their
37316 own retry data. In other words, recipient error retry data does not take effect
37317 until the next delivery attempt.
37318
37319 Some hosts have been observed to give temporary error responses to every
37320 MAIL command at certain times (&"insufficient space"& has been seen). It
37321 would be nice if such circumstances could be recognized, and defer data for the
37322 host itself created, but this is not possible within the current Exim design.
37323 What actually happens is that retry data for every (host, message) combination
37324 is created.
37325
37326 The reason that timeouts after MAIL and RCPT are treated specially is that
37327 these can sometimes arise as a result of the remote host's verification
37328 procedures. Exim makes this assumption, and treats them as if a temporary error
37329 response had been received. A timeout after &"."& is treated specially because
37330 it is known that some broken implementations fail to recognize the end of the
37331 message if the last character of the last line is a binary zero. Thus, it is
37332 helpful to treat this case as a message error.
37333
37334 Timeouts at other times are treated as host errors, assuming a problem with the
37335 host, or the connection to it. If a timeout after MAIL, RCPT,
37336 or &"."& is really a connection problem, the assumption is that at the next try
37337 the timeout is likely to occur at some other point in the dialogue, causing it
37338 then to be treated as a host error.
37339
37340 There is experimental evidence that some MTAs drop the connection after the
37341 terminating &"."& if they do not like the contents of the message for some
37342 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37343 should be given. That is why Exim treats this case as a message rather than a
37344 host error, in order not to delay other messages to the same host.
37345
37346
37347
37348
37349 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37350 .cindex "SMTP" "incoming over TCP/IP"
37351 .cindex "incoming SMTP over TCP/IP"
37352 .cindex "inetd"
37353 .cindex "daemon"
37354 Incoming SMTP messages can be accepted in one of two ways: by running a
37355 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37356 &_/etc/inetd.conf_& should be like this:
37357 .code
37358 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37359 .endd
37360 Exim distinguishes between this case and the case of a locally running user
37361 agent using the &%-bs%& option by checking whether or not the standard input is
37362 a socket. When it is, either the port must be privileged (less than 1024), or
37363 the caller must be root or the Exim user. If any other user passes a socket
37364 with an unprivileged port number, Exim prints a message on the standard error
37365 stream and exits with an error code.
37366
37367 By default, Exim does not make a log entry when a remote host connects or
37368 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37369 unexpected. It can be made to write such log entries by setting the
37370 &%smtp_connection%& log selector.
37371
37372 .cindex "carriage return"
37373 .cindex "linefeed"
37374 Commands from the remote host are supposed to be terminated by CR followed by
37375 LF. However, there are known to be hosts that do not send CR characters. In
37376 order to be able to interwork with such hosts, Exim treats LF on its own as a
37377 line terminator.
37378 Furthermore, because common code is used for receiving messages from all
37379 sources, a CR on its own is also interpreted as a line terminator. However, the
37380 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37381
37382 .cindex "EHLO" "invalid data"
37383 .cindex "HELO" "invalid data"
37384 One area that sometimes gives rise to problems concerns the EHLO or
37385 HELO commands. Some clients send syntactically invalid versions of these
37386 commands, which Exim rejects by default. (This is nothing to do with verifying
37387 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37388 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37389 match the broken hosts that send invalid commands.
37390
37391 .cindex "SIZE option on MAIL command"
37392 .cindex "MAIL" "SIZE option"
37393 The amount of disk space available is checked whenever SIZE is received on
37394 a MAIL command, independently of whether &%message_size_limit%& or
37395 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37396 false. A temporary error is given if there is not enough space. If
37397 &%check_spool_space%& is set, the check is for that amount of space plus the
37398 value given with SIZE, that is, it checks that the addition of the incoming
37399 message will not reduce the space below the threshold.
37400
37401 When a message is successfully received, Exim includes the local message id in
37402 its response to the final &"."& that terminates the data. If the remote host
37403 logs this text it can help with tracing what has happened to a message.
37404
37405 The Exim daemon can limit the number of simultaneous incoming connections it is
37406 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37407 number of simultaneous incoming connections from a single remote host (see the
37408 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37409 rejected using the SMTP temporary error code 421.
37410
37411 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37412 subprocess has finished, as this can get lost at busy times. Instead, it looks
37413 for completed subprocesses every time it wakes up. Provided there are other
37414 things happening (new incoming calls, starts of queue runs), completed
37415 processes will be noticed and tidied away. On very quiet systems you may
37416 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37417 it will be noticed when the daemon next wakes up.
37418
37419 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37420 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37421 high system load &-- for details see the &%smtp_accept_reserve%&,
37422 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37423 applies in both the daemon and &'inetd'& cases.
37424
37425 Exim normally starts a delivery process for each message received, though this
37426 can be varied by means of the &%-odq%& command line option and the
37427 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37428 number of simultaneously running delivery processes started in this way from
37429 SMTP input can be limited by the &%smtp_accept_queue%& and
37430 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37431 subsequently received messages are just put on the input queue without starting
37432 a delivery process.
37433
37434 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37435 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37436 started up from the &'inetd'& daemon, because in that case each connection is
37437 handled by an entirely independent Exim process. Control by load average is,
37438 however, available with &'inetd'&.
37439
37440 Exim can be configured to verify addresses in incoming SMTP commands as they
37441 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37442 to rewrite addresses at this time &-- before any syntax checking is done. See
37443 section &<<SSECTrewriteS>>&.
37444
37445 Exim can also be configured to limit the rate at which a client host submits
37446 MAIL and RCPT commands in a single SMTP session. See the
37447 &%smtp_ratelimit_hosts%& option.
37448
37449
37450
37451 .subsection "Unrecognized SMTP commands" SECID234
37452 .cindex "SMTP" "unrecognized commands"
37453 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37454 commands during a single SMTP connection, it drops the connection after sending
37455 the error response to the last command. The default value for
37456 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37457 abuse that subvert web servers into making connections to SMTP ports; in these
37458 circumstances, a number of non-SMTP lines are sent first.
37459
37460
37461 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37462 .cindex "SMTP" "syntax errors"
37463 .cindex "SMTP" "protocol errors"
37464 A syntax error is detected if an SMTP command is recognized, but there is
37465 something syntactically wrong with its data, for example, a malformed email
37466 address in a RCPT command. Protocol errors include invalid command
37467 sequencing such as RCPT before MAIL. If Exim receives more than
37468 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37469 drops the connection after sending the error response to the last command. The
37470 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37471 broken clients that loop sending bad commands (yes, it has been seen).
37472
37473
37474
37475 .subsection "Use of non-mail SMTP commands" SECID236
37476 .cindex "SMTP" "non-mail commands"
37477 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37478 DATA. Exim counts such commands, and drops the connection if there are too
37479 many of them in a single SMTP session. This action catches some
37480 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37481 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37482 defines what &"too many"& means. Its default value is 10.
37483
37484 When a new message is expected, one occurrence of RSET is not counted. This
37485 allows a client to send one RSET between messages (this is not necessary,
37486 but some clients do it). Exim also allows one uncounted occurrence of HELO
37487 or EHLO, and one occurrence of STARTTLS between messages. After
37488 starting up a TLS session, another EHLO is expected, and so it too is not
37489 counted.
37490
37491 The first occurrence of AUTH in a connection, or immediately following
37492 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37493 RCPT, DATA, and QUIT are counted.
37494
37495 You can control which hosts are subject to the limit set by
37496 &%smtp_accept_max_nonmail%& by setting
37497 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37498 the limit apply to all hosts. This option means that you can exclude any
37499 specific badly-behaved hosts that you have to live with.
37500
37501
37502
37503
37504 .subsection "The VRFY and EXPN commands" SECID237
37505 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37506 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37507 appropriate) in order to decide whether the command should be accepted or not.
37508
37509 .cindex "VRFY" "processing"
37510 When no ACL is defined for VRFY, or if it rejects without
37511 setting an explicit response code, the command is accepted
37512 (with a 252 SMTP response code)
37513 in order to support awkward clients that do a VRFY before every RCPT.
37514 When VRFY is accepted, it runs exactly the same code as when Exim is
37515 called with the &%-bv%& option, and returns 250/451/550
37516 SMTP response codes.
37517
37518 .cindex "EXPN" "processing"
37519 If no ACL for EXPN is defined, the command is rejected.
37520 When EXPN is accepted, a single-level expansion of the address is done.
37521 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37522 than a verification (the &%-bv%& option). If an unqualified local part is given
37523 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37524 of VRFY and EXPN commands are logged on the main and reject logs, and
37525 VRFY verification failures are logged in the main log for consistency with
37526 RCPT failures.
37527
37528
37529
37530 .subsection "The ETRN command" SECTETRN
37531 .cindex "ETRN" "processing"
37532 .cindex "ESMTP extensions" ETRN
37533 RFC 1985 describes an ESMTP command called ETRN that is designed to
37534 overcome the security problems of the TURN command (which has fallen into
37535 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37536 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37537 should be accepted or not. If no ACL is defined, the command is rejected.
37538
37539 The ETRN command is concerned with &"releasing"& messages that are awaiting
37540 delivery to certain hosts. As Exim does not organize its message queue by host,
37541 the only form of ETRN that is supported by default is the one where the
37542 text starts with the &"#"& prefix, in which case the remainder of the text is
37543 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37544 the &%-R%& option to happen, with the remainder of the ETRN text as its
37545 argument. For example,
37546 .code
37547 ETRN #brigadoon
37548 .endd
37549 runs the command
37550 .code
37551 exim -R brigadoon
37552 .endd
37553 which causes a delivery attempt on all messages with undelivered addresses
37554 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37555 default), Exim prevents the simultaneous execution of more than one queue run
37556 for the same argument string as a result of an ETRN command. This stops
37557 a misbehaving client from starting more than one queue runner at once.
37558
37559 .cindex "hints database" "ETRN serialization"
37560 Exim implements the serialization by means of a hints database in which a
37561 record is written whenever a process is started by ETRN, and deleted when
37562 the process completes. However, Exim does not keep the SMTP session waiting for
37563 the ETRN process to complete. Once ETRN is accepted, the client is sent
37564 a &"success"& return code. Obviously there is scope for hints records to get
37565 left lying around if there is a system or program crash. To guard against this,
37566 Exim ignores any records that are more than six hours old.
37567
37568 .oindex "&%smtp_etrn_command%&"
37569 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37570 used. This specifies a command that is run whenever ETRN is received,
37571 whatever the form of its argument. For
37572 example:
37573 .code
37574 smtp_etrn_command = /etc/etrn_command $domain \
37575                     $sender_host_address
37576 .endd
37577 .vindex "&$domain$&"
37578 The string is split up into arguments which are independently expanded. The
37579 expansion variable &$domain$& is set to the argument of the ETRN command,
37580 and no syntax checking is done on the contents of this argument. Exim does not
37581 wait for the command to complete, so its status code is not checked. Exim runs
37582 under its own uid and gid when receiving incoming SMTP, so it is not possible
37583 for it to change them before running the command.
37584
37585
37586
37587 .section "Incoming local SMTP" "SECID238"
37588 .cindex "SMTP" "local incoming"
37589 Some user agents use SMTP to pass messages to their local MTA using the
37590 standard input and output, as opposed to passing the envelope on the command
37591 line and writing the message to the standard input. This is supported by the
37592 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37593 messages over TCP/IP (including the use of ACLs), except that the envelope
37594 sender given in a MAIL command is ignored unless the caller is trusted. In
37595 an ACL you can detect this form of SMTP input by testing for an empty host
37596 identification. It is common to have this as the first line in the ACL that
37597 runs for RCPT commands:
37598 .code
37599 accept hosts = :
37600 .endd
37601 This accepts SMTP messages from local processes without doing any other tests.
37602
37603
37604
37605 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37606 .cindex "SMTP" "batched outgoing"
37607 .cindex "batched SMTP output"
37608 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37609 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37610 be output in BSMTP format. No SMTP responses are possible for this form of
37611 delivery. All it is doing is using SMTP commands as a way of transmitting the
37612 envelope along with the message.
37613
37614 The message is written to the file or pipe preceded by the SMTP commands
37615 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37616 the message that start with a dot have an extra dot added. The SMTP command
37617 HELO is not normally used. If it is required, the &%message_prefix%& option
37618 can be used to specify it.
37619
37620 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37621 one recipient address at a time by default. However, you can arrange for them
37622 to handle several addresses at once by setting the &%batch_max%& option. When
37623 this is done for BSMTP, messages may contain multiple RCPT commands. See
37624 chapter &<<CHAPbatching>>& for more details.
37625
37626 .vindex "&$host$&"
37627 When one or more addresses are routed to a BSMTP transport by a router that
37628 sets up a host list, the name of the first host on the list is available to the
37629 transport in the variable &$host$&. Here is an example of such a transport and
37630 router:
37631 .code
37632 begin routers
37633 route_append:
37634   driver = manualroute
37635   transport = smtp_appendfile
37636   route_list = domain.example  batch.host.example
37637
37638 begin transports
37639 smtp_appendfile:
37640   driver = appendfile
37641   directory = /var/bsmtp/$host
37642   batch_max = 1000
37643   use_bsmtp
37644   user = exim
37645 .endd
37646 This causes messages addressed to &'domain.example'& to be written in BSMTP
37647 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37648 message (unless there are more than 1000 recipients).
37649
37650
37651
37652 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37653 .cindex "SMTP" "batched incoming"
37654 .cindex "batched SMTP input"
37655 The &%-bS%& command line option causes Exim to accept one or more messages by
37656 reading SMTP on the standard input, but to generate no responses. If the caller
37657 is trusted, the senders in the MAIL commands are believed; otherwise the
37658 sender is always the caller of Exim. Unqualified senders and receivers are not
37659 rejected (there seems little point) but instead just get qualified. HELO
37660 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37661 as NOOP; QUIT quits.
37662
37663 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37664 ACL is run in the same way as for non-SMTP local input.
37665
37666 If an error is detected while reading a message, including a missing &"."& at
37667 the end, Exim gives up immediately. It writes details of the error to the
37668 standard output in a stylized way that the calling program should be able to
37669 make some use of automatically, for example:
37670 .code
37671 554 Unexpected end of file
37672 Transaction started in line 10
37673 Error detected in line 14
37674 .endd
37675 It writes a more verbose version, for human consumption, to the standard error
37676 file, for example:
37677 .code
37678 An error was detected while processing a file of BSMTP input.
37679 The error message was:
37680
37681 501 '>' missing at end of address
37682
37683 The SMTP transaction started in line 10.
37684 The error was detected in line 12.
37685 The SMTP command at fault was:
37686
37687 rcpt to:<malformed@in.com.plete
37688
37689 1 previous message was successfully processed.
37690 The rest of the batch was abandoned.
37691 .endd
37692 The return code from Exim is zero only if there were no errors. It is 1 if some
37693 messages were accepted before an error was detected, and 2 if no messages were
37694 accepted.
37695 .ecindex IIDsmtpproc1
37696 .ecindex IIDsmtpproc2
37697
37698
37699
37700 . ////////////////////////////////////////////////////////////////////////////
37701 . ////////////////////////////////////////////////////////////////////////////
37702
37703 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37704          "Customizing messages"
37705 When a message fails to be delivered, or remains in the queue for more than a
37706 configured amount of time, Exim sends a message to the original sender, or
37707 to an alternative configured address. The text of these messages is built into
37708 the code of Exim, but it is possible to change it, either by adding a single
37709 string, or by replacing each of the paragraphs by text supplied in a file.
37710
37711 The &'From:'& and &'To:'& header lines are automatically generated; you can
37712 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37713 option. Exim also adds the line
37714 .code
37715 Auto-Submitted: auto-generated
37716 .endd
37717 to all warning and bounce messages,
37718
37719
37720 .section "Customizing bounce messages" "SECID239"
37721 .cindex "customizing" "bounce message"
37722 .cindex "bounce message" "customizing"
37723 If &%bounce_message_text%& is set, its contents are included in the default
37724 message immediately after &"This message was created automatically by mail
37725 delivery software."& The string is not expanded. It is not used if
37726 &%bounce_message_file%& is set.
37727
37728 When &%bounce_message_file%& is set, it must point to a template file for
37729 constructing error messages. The file consists of a series of text items,
37730 separated by lines consisting of exactly four asterisks. If the file cannot be
37731 opened, default text is used and a message is written to the main and panic
37732 logs. If any text item in the file is empty, default text is used for that
37733 item.
37734
37735 .vindex "&$bounce_recipient$&"
37736 .vindex "&$bounce_return_size_limit$&"
37737 Each item of text that is read from the file is expanded, and there are two
37738 expansion variables which can be of use here: &$bounce_recipient$& is set to
37739 the recipient of an error message while it is being created, and
37740 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37741 option, rounded to a whole number.
37742
37743 The items must appear in the file in the following order:
37744
37745 .ilist
37746 The first item is included in the headers, and should include at least a
37747 &'Subject:'& header. Exim does not check the syntax of these headers.
37748 .next
37749 The second item forms the start of the error message. After it, Exim lists the
37750 failing addresses with their error messages.
37751 .next
37752 The third item is used to introduce any text from pipe transports that is to be
37753 returned to the sender. It is omitted if there is no such text.
37754 .next
37755 The fourth, fifth and sixth items will be ignored and may be empty.
37756 The fields exist for back-compatibility
37757 .endlist
37758
37759 The default state (&%bounce_message_file%& unset) is equivalent to the
37760 following file, in which the sixth item is empty. The &'Subject:'& and some
37761 other lines have been split in order to fit them on the page:
37762 .code
37763 Subject: Mail delivery failed
37764   ${if eq{$sender_address}{$bounce_recipient}
37765   {: returning message to sender}}
37766 ****
37767 This message was created automatically by mail delivery software.
37768
37769 A message ${if eq{$sender_address}{$bounce_recipient}
37770   {that you sent }{sent by
37771
37772 <$sender_address>
37773
37774 }}could not be delivered to all of its recipients.
37775 This is a permanent error. The following address(es) failed:
37776 ****
37777 The following text was generated during the delivery attempt(s):
37778 ****
37779 ------ This is a copy of the message, including all the headers.
37780   ------
37781 ****
37782 ------ The body of the message is $message_size characters long;
37783   only the first
37784 ------ $bounce_return_size_limit or so are included here.
37785 ****
37786 .endd
37787 .section "Customizing warning messages" "SECTcustwarn"
37788 .cindex "customizing" "warning message"
37789 .cindex "warning of delay" "customizing the message"
37790 The option &%warn_message_file%& can be pointed at a template file for use when
37791 warnings about message delays are created. In this case there are only three
37792 text sections:
37793
37794 .ilist
37795 The first item is included in the headers, and should include at least a
37796 &'Subject:'& header. Exim does not check the syntax of these headers.
37797 .next
37798 The second item forms the start of the warning message. After it, Exim lists
37799 the delayed addresses.
37800 .next
37801 The third item then ends the message.
37802 .endlist
37803
37804 The default state is equivalent to the following file, except that some lines
37805 have been split here, in order to fit them on the page:
37806 .code
37807 Subject: Warning: message $message_exim_id delayed
37808   $warn_message_delay
37809 ****
37810 This message was created automatically by mail delivery software.
37811
37812 A message ${if eq{$sender_address}{$warn_message_recipients}
37813 {that you sent }{sent by
37814
37815 <$sender_address>
37816
37817 }}has not been delivered to all of its recipients after
37818 more than $warn_message_delay in the queue on $primary_hostname.
37819
37820 The message identifier is:     $message_exim_id
37821 The subject of the message is: $h_subject
37822 The date of the message is:    $h_date
37823
37824 The following address(es) have not yet been delivered:
37825 ****
37826 No action is required on your part. Delivery attempts will
37827 continue for some time, and this warning may be repeated at
37828 intervals if the message remains undelivered. Eventually the
37829 mail delivery software will give up, and when that happens,
37830 the message will be returned to you.
37831 .endd
37832 .vindex "&$warn_message_delay$&"
37833 .vindex "&$warn_message_recipients$&"
37834 However, in the default state the subject and date lines are omitted if no
37835 appropriate headers exist. During the expansion of this file,
37836 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37837 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37838 of recipients for the warning message. There may be more than one if there are
37839 multiple addresses with different &%errors_to%& settings on the routers that
37840 handled them.
37841
37842
37843
37844
37845 . ////////////////////////////////////////////////////////////////////////////
37846 . ////////////////////////////////////////////////////////////////////////////
37847
37848 .chapter "Some common configuration settings" "CHAPcomconreq"
37849 This chapter discusses some configuration settings that seem to be fairly
37850 common. More examples and discussion can be found in the Exim book.
37851
37852
37853
37854 .section "Sending mail to a smart host" "SECID240"
37855 .cindex "smart host" "example router"
37856 If you want to send all mail for non-local domains to a &"smart host"&, you
37857 should replace the default &(dnslookup)& router with a router which does the
37858 routing explicitly:
37859 .code
37860 send_to_smart_host:
37861   driver = manualroute
37862   route_list = !+local_domains smart.host.name
37863   transport = remote_smtp
37864 .endd
37865 You can use the smart host's IP address instead of the name if you wish.
37866 If you are using Exim only to submit messages to a smart host, and not for
37867 receiving incoming messages, you can arrange for it to do the submission
37868 synchronously by setting the &%mua_wrapper%& option (see chapter
37869 &<<CHAPnonqueueing>>&).
37870
37871
37872
37873
37874 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37875 .cindex "mailing lists"
37876 Exim can be used to run simple mailing lists, but for large and/or complicated
37877 requirements, the use of additional specialized mailing list software such as
37878 Majordomo or Mailman is recommended.
37879
37880 The &(redirect)& router can be used to handle mailing lists where each list
37881 is maintained in a separate file, which can therefore be managed by an
37882 independent manager. The &%domains%& router option can be used to run these
37883 lists in a separate domain from normal mail. For example:
37884 .code
37885 lists:
37886   driver = redirect
37887   domains = lists.example
37888   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37889   forbid_pipe
37890   forbid_file
37891   errors_to = ${quote_local_part:$local_part-request}@lists.example
37892   no_more
37893 .endd
37894 This router is skipped for domains other than &'lists.example'&. For addresses
37895 in that domain, it looks for a file that matches the local part. If there is no
37896 such file, the router declines, but because &%no_more%& is set, no subsequent
37897 routers are tried, and so the whole delivery fails.
37898
37899 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37900 expanded into a filename or a pipe delivery, which is usually inappropriate in
37901 a mailing list.
37902
37903 .oindex "&%errors_to%&"
37904 The &%errors_to%& option specifies that any delivery errors caused by addresses
37905 taken from a mailing list are to be sent to the given address rather than the
37906 original sender of the message. However, before acting on this, Exim verifies
37907 the error address, and ignores it if verification fails.
37908
37909 For example, using the configuration above, mail sent to
37910 &'dicts@lists.example'& is passed on to those addresses contained in
37911 &_/usr/lists/dicts_&, with error reports directed to
37912 &'dicts-request@lists.example'&, provided that this address can be verified.
37913 There could be a file called &_/usr/lists/dicts-request_& containing
37914 the address(es) of this particular list's manager(s), but other approaches,
37915 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37916 or &%local_part_suffix%& options) to handle addresses of the form
37917 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37918
37919
37920
37921 .section "Syntax errors in mailing lists" "SECID241"
37922 .cindex "mailing lists" "syntax errors in"
37923 If an entry in redirection data contains a syntax error, Exim normally defers
37924 delivery of the original address. That means that a syntax error in a mailing
37925 list holds up all deliveries to the list. This may not be appropriate when a
37926 list is being maintained automatically from data supplied by users, and the
37927 addresses are not rigorously checked.
37928
37929 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37930 entries that fail to parse, noting the incident in the log. If in addition
37931 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37932 whenever a broken address is skipped. It is usually appropriate to set
37933 &%syntax_errors_to%& to the same address as &%errors_to%&.
37934
37935
37936
37937 .section "Re-expansion of mailing lists" "SECID242"
37938 .cindex "mailing lists" "re-expansion of"
37939 Exim remembers every individual address to which a message has been delivered,
37940 in order to avoid duplication, but it normally stores only the original
37941 recipient addresses with a message. If all the deliveries to a mailing list
37942 cannot be done at the first attempt, the mailing list is re-expanded when the
37943 delivery is next tried. This means that alterations to the list are taken into
37944 account at each delivery attempt, so addresses that have been added to
37945 the list since the message arrived will therefore receive a copy of the
37946 message, even though it pre-dates their subscription.
37947
37948 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37949 on the &(redirect)& router. If this is done, any addresses generated by the
37950 router that fail to deliver at the first attempt are added to the message as
37951 &"top level"& addresses, and the parent address that generated them is marked
37952 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37953 subsequent delivery attempts. The disadvantage of this is that if any of the
37954 failing addresses are incorrect, correcting them in the file has no effect on
37955 pre-existing messages.
37956
37957 The original top-level address is remembered with each of the generated
37958 addresses, and is output in any log messages. However, any intermediate parent
37959 addresses are not recorded. This makes a difference to the log only if the
37960 &%all_parents%& selector is set, but for mailing lists there is normally only
37961 one level of expansion anyway.
37962
37963
37964
37965 .section "Closed mailing lists" "SECID243"
37966 .cindex "mailing lists" "closed"
37967 The examples so far have assumed open mailing lists, to which anybody may
37968 send mail. It is also possible to set up closed lists, where mail is accepted
37969 from specified senders only. This is done by making use of the generic
37970 &%senders%& option to restrict the router that handles the list.
37971
37972 The following example uses the same file as a list of recipients and as a list
37973 of permitted senders. It requires three routers:
37974 .code
37975 lists_request:
37976   driver = redirect
37977   domains = lists.example
37978   local_part_suffix = -request
37979   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37980   file = /usr/lists/${local_part_data}-request
37981   no_more
37982
37983 lists_post:
37984   driver = redirect
37985   domains = lists.example
37986   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37987   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37988   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37989   forbid_pipe
37990   forbid_file
37991   errors_to = ${quote_local_part:$local_part-request}@lists.example
37992   no_more
37993
37994 lists_closed:
37995   driver = redirect
37996   domains = lists.example
37997   allow_fail
37998   data = :fail: $local_part@lists.example is a closed mailing list
37999 .endd
38000 All three routers have the same &%domains%& setting, so for any other domains,
38001 they are all skipped. The first router runs only if the local part ends in
38002 &%-request%&. It handles messages to the list manager(s) by means of an open
38003 mailing list.
38004
38005 The second router runs only if the &%senders%& precondition is satisfied. It
38006 checks for the existence of a list that corresponds to the local part, and then
38007 checks that the sender is on the list by means of a linear search. It is
38008 necessary to check for the existence of the file before trying to search it,
38009 because otherwise Exim thinks there is a configuration error. If the file does
38010 not exist, the expansion of &%senders%& is *, which matches all senders. This
38011 means that the router runs, but because there is no list, declines, and
38012 &%no_more%& ensures that no further routers are run. The address fails with an
38013 &"unrouteable address"& error.
38014
38015 The third router runs only if the second router is skipped, which happens when
38016 a mailing list exists, but the sender is not on it. This router forcibly fails
38017 the address, giving a suitable error message.
38018
38019
38020
38021
38022 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
38023 .cindex "VERP"
38024 .cindex "Variable Envelope Return Paths"
38025 .cindex "envelope from"
38026 .cindex "envelope sender"
38027 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
38028 are a way of helping mailing list administrators discover which subscription
38029 address is the cause of a particular delivery failure. The idea is to encode
38030 the original recipient address in the outgoing envelope sender address, so that
38031 if the message is forwarded by another host and then subsequently bounces, the
38032 original recipient can be extracted from the recipient address of the bounce.
38033
38034 .oindex &%errors_to%&
38035 .oindex &%return_path%&
38036 Envelope sender addresses can be modified by Exim using two different
38037 facilities: the &%errors_to%& option on a router (as shown in previous mailing
38038 list examples), or the &%return_path%& option on a transport. The second of
38039 these is effective only if the message is successfully delivered to another
38040 host; it is not used for errors detected on the local host (see the description
38041 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
38042 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
38043 .code
38044 verp_smtp:
38045   driver = smtp
38046   max_rcpt = 1
38047   return_path = \
38048     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38049       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38050 .endd
38051 This has the effect of rewriting the return path (envelope sender) on outgoing
38052 SMTP messages, if the local part of the original return path ends in
38053 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
38054 local part and domain of the recipient into the return path. Suppose, for
38055 example, that a message whose return path has been set to
38056 &'somelist-request@your.dom.example'& is sent to
38057 &'subscriber@other.dom.example'&. In the transport, the return path is
38058 rewritten as
38059 .code
38060 somelist-request+subscriber=other.dom.example@your.dom.example
38061 .endd
38062 .vindex "&$local_part$&"
38063 For this to work, you must tell Exim to send multiple copies of messages that
38064 have more than one recipient, so that each copy has just one recipient. This is
38065 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38066 might be sent to several different recipients in the same domain, in which case
38067 &$local_part$& is not available in the transport, because it is not unique.
38068
38069 Unless your host is doing nothing but mailing list deliveries, you should
38070 probably use a separate transport for the VERP deliveries, so as not to use
38071 extra resources in making one-per-recipient copies for other deliveries. This
38072 can easily be done by expanding the &%transport%& option in the router:
38073 .code
38074 dnslookup:
38075   driver = dnslookup
38076   domains = ! +local_domains
38077   transport = \
38078     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38079       {verp_smtp}{remote_smtp}}
38080   no_more
38081 .endd
38082 If you want to change the return path using &%errors_to%& in a router instead
38083 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38084 routers that handle mailing list addresses. This will ensure that all delivery
38085 errors, including those detected on the local host, are sent to the VERP
38086 address.
38087
38088 On a host that does no local deliveries and has no manual routing, only the
38089 &(dnslookup)& router needs to be changed. A special transport is not needed for
38090 SMTP deliveries. Every mailing list recipient has its own return path value,
38091 and so Exim must hand them to the transport one at a time. Here is an example
38092 of a &(dnslookup)& router that implements VERP:
38093 .code
38094 verp_dnslookup:
38095   driver = dnslookup
38096   domains = ! +local_domains
38097   transport = remote_smtp
38098   errors_to = \
38099     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38100      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38101   no_more
38102 .endd
38103 Before you start sending out messages with VERPed return paths, you must also
38104 configure Exim to accept the bounce messages that come back to those paths.
38105 Typically this is done by setting a &%local_part_suffix%& option for a
38106 router, and using this to route the messages to wherever you want to handle
38107 them.
38108
38109 The overhead incurred in using VERP depends very much on the size of the
38110 message, the number of recipient addresses that resolve to the same remote
38111 host, and the speed of the connection over which the message is being sent. If
38112 a lot of addresses resolve to the same host and the connection is slow, sending
38113 a separate copy of the message for each address may take substantially longer
38114 than sending a single copy with many recipients (for which VERP cannot be
38115 used).
38116
38117
38118
38119
38120
38121
38122 .section "Virtual domains" "SECTvirtualdomains"
38123 .cindex "virtual domains"
38124 .cindex "domain" "virtual"
38125 The phrase &'virtual domain'& is unfortunately used with two rather different
38126 meanings:
38127
38128 .ilist
38129 A domain for which there are no real mailboxes; all valid local parts are
38130 aliases for other email addresses. Common examples are organizational
38131 top-level domains and &"vanity"& domains.
38132 .next
38133 One of a number of independent domains that are all handled by the same host,
38134 with mailboxes on that host, but where the mailbox owners do not necessarily
38135 have login accounts on that host.
38136 .endlist
38137
38138 The first usage is probably more common, and does seem more &"virtual"& than
38139 the second. This kind of domain can be handled in Exim with a straightforward
38140 aliasing router. One approach is to create a separate alias file for each
38141 virtual domain. Exim can test for the existence of the alias file to determine
38142 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38143 to a router of this form:
38144 .code
38145 virtual:
38146   driver = redirect
38147   domains = dsearch;/etc/mail/virtual
38148   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38149   no_more
38150 .endd
38151 The &%domains%& option specifies that the router is to be skipped, unless there
38152 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38153 domain that is being processed.
38154 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38155 being placed into the &$domain_data$& variable.
38156
38157 When the router runs, it looks up the local
38158 part in the file to find a new address (or list of addresses). The &%no_more%&
38159 setting ensures that if the lookup fails (leading to &%data%& being an empty
38160 string), Exim gives up on the address without trying any subsequent routers.
38161
38162 This one router can handle all the virtual domains because the alias filenames
38163 follow a fixed pattern. Permissions can be arranged so that appropriate people
38164 can edit the different alias files. A successful aliasing operation results in
38165 a new envelope recipient address, which is then routed from scratch.
38166
38167 The other kind of &"virtual"& domain can also be handled in a straightforward
38168 way. One approach is to create a file for each domain containing a list of
38169 valid local parts, and use it in a router like this:
38170 .code
38171 my_domains:
38172   driver = accept
38173   domains = dsearch;/etc/mail/domains
38174   local_parts = lsearch;/etc/mail/domains/$domain
38175   transport = my_mailboxes
38176 .endd
38177 The address is accepted if there is a file for the domain, and the local part
38178 can be found in the file. The &%domains%& option is used to check for the
38179 file's existence because &%domains%& is tested before the &%local_parts%&
38180 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38181 because that option is tested after &%local_parts%&. The transport is as
38182 follows:
38183 .code
38184 my_mailboxes:
38185   driver = appendfile
38186   file = /var/mail/$domain_data/$local_part_data
38187   user = mail
38188 .endd
38189 This uses a directory of mailboxes for each domain. The &%user%& setting is
38190 required, to specify which uid is to be used for writing to the mailboxes.
38191
38192 The configuration shown here is just one example of how you might support this
38193 requirement. There are many other ways this kind of configuration can be set
38194 up, for example, by using a database instead of separate files to hold all the
38195 information about the domains.
38196
38197
38198
38199 .section "Multiple user mailboxes" "SECTmulbox"
38200 .cindex "multiple mailboxes"
38201 .cindex "mailbox" "multiple"
38202 .cindex "local part" "prefix"
38203 .cindex "local part" "suffix"
38204 Heavy email users often want to operate with multiple mailboxes, into which
38205 incoming mail is automatically sorted. A popular way of handling this is to
38206 allow users to use multiple sender addresses, so that replies can easily be
38207 identified. Users are permitted to add prefixes or suffixes to their local
38208 parts for this purpose. The wildcard facility of the generic router options
38209 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38210 example, consider this router:
38211 .code
38212 userforward:
38213   driver = redirect
38214   check_local_user
38215   file = $home/.forward
38216   local_part_suffix = -*
38217   local_part_suffix_optional
38218   allow_filter
38219 .endd
38220 .vindex "&$local_part_suffix$&"
38221 It runs a user's &_.forward_& file for all local parts of the form
38222 &'username-*'&. Within the filter file the user can distinguish different
38223 cases by testing the variable &$local_part_suffix$&. For example:
38224 .code
38225 if $local_part_suffix contains -special then
38226 save /home/$local_part_data/Mail/special
38227 endif
38228 .endd
38229 If the filter file does not exist, or does not deal with such addresses, they
38230 fall through to subsequent routers, and, assuming no subsequent use of the
38231 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38232 control over which suffixes are valid.
38233
38234 Alternatively, a suffix can be used to trigger the use of a different
38235 &_.forward_& file &-- which is the way a similar facility is implemented in
38236 another MTA:
38237 .code
38238 userforward:
38239   driver = redirect
38240   check_local_user
38241   local_part_suffix = -*
38242   local_part_suffix_optional
38243   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38244   allow_filter
38245 .endd
38246 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38247 example, &_.forward-special_& is used. Once again, if the appropriate file
38248 does not exist, or does not deal with the address, it is passed on to
38249 subsequent routers, which could, if required, look for an unqualified
38250 &_.forward_& file to use as a default.
38251
38252
38253
38254 .section "Simplified vacation processing" "SECID244"
38255 .cindex "vacation processing"
38256 The traditional way of running the &'vacation'& program is for a user to set up
38257 a pipe command in a &_.forward_& file
38258 (see section &<<SECTspecitredli>>& for syntax details).
38259 This is prone to error by inexperienced users. There are two features of Exim
38260 that can be used to make this process simpler for users:
38261
38262 .ilist
38263 A local part prefix such as &"vacation-"& can be specified on a router which
38264 can cause the message to be delivered directly to the &'vacation'& program, or
38265 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38266 &_.forward_& file are then much simpler. For example:
38267 .code
38268 spqr, vacation-spqr
38269 .endd
38270 .next
38271 The &%require_files%& generic router option can be used to trigger a
38272 vacation delivery by checking for the existence of a certain file in the
38273 user's home directory. The &%unseen%& generic option should also be used, to
38274 ensure that the original delivery also proceeds. In this case, all the user has
38275 to do is to create a file called, say, &_.vacation_&, containing a vacation
38276 message.
38277 .endlist
38278
38279 Another advantage of both these methods is that they both work even when the
38280 use of arbitrary pipes by users is locked out.
38281
38282
38283
38284 .section "Taking copies of mail" "SECID245"
38285 .cindex "message" "copying every"
38286 Some installations have policies that require archive copies of all messages to
38287 be made. A single copy of each message can easily be taken by an appropriate
38288 command in a system filter, which could, for example, use a different file for
38289 each day's messages.
38290
38291 There is also a shadow transport mechanism that can be used to take copies of
38292 messages that are successfully delivered by local transports, one copy per
38293 delivery. This could be used, &'inter alia'&, to implement automatic
38294 notification of delivery by sites that insist on doing such things.
38295
38296
38297
38298 .section "Intermittently connected hosts" "SECID246"
38299 .cindex "intermittently connected hosts"
38300 It has become quite common (because it is cheaper) for hosts to connect to the
38301 Internet periodically rather than remain connected all the time. The normal
38302 arrangement is that mail for such hosts accumulates on a system that is
38303 permanently connected.
38304
38305 Exim was designed for use on permanently connected hosts, and so it is not
38306 particularly well-suited to use in an intermittently connected environment.
38307 Nevertheless there are some features that can be used.
38308
38309
38310 .section "Exim on the upstream server host" "SECID247"
38311 It is tempting to arrange for incoming mail for the intermittently connected
38312 host to remain in Exim's queue until the client connects. However, this
38313 approach does not scale very well. Two different kinds of waiting message are
38314 being mixed up in the same queue &-- those that cannot be delivered because of
38315 some temporary problem, and those that are waiting for their destination host
38316 to connect. This makes it hard to manage the queue, as well as wasting
38317 resources, because each queue runner scans the entire queue.
38318
38319 A better approach is to separate off those messages that are waiting for an
38320 intermittently connected host. This can be done by delivering these messages
38321 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38322 format, from where they are transmitted by other software when their
38323 destination connects. This makes it easy to collect all the mail for one host
38324 in a single directory, and to apply local timeout rules on a per-message basis
38325 if required.
38326
38327 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38328 you are doing this, you should configure Exim with a long retry period for the
38329 intermittent host. For example:
38330 .code
38331 cheshire.wonderland.fict.example    *   F,5d,24h
38332 .endd
38333 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38334 which messages it has queued up for that host. Once the intermittent host comes
38335 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38336 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38337 causes all the queued up messages to be delivered, often down a single SMTP
38338 connection. While the host remains connected, any new messages get delivered
38339 immediately.
38340
38341 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38342 issued with a different IP address each time it connects, Exim's retry
38343 mechanisms on the holding host get confused, because the IP address is normally
38344 used as part of the key string for holding retry information. This can be
38345 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38346 Since this has disadvantages for permanently connected hosts, it is best to
38347 arrange a separate transport for the intermittently connected ones.
38348
38349
38350
38351 .section "Exim on the intermittently connected client host" "SECID248"
38352 The value of &%smtp_accept_queue_per_connection%& should probably be
38353 increased, or even set to zero (that is, disabled) on the intermittently
38354 connected host, so that all incoming messages down a single connection get
38355 delivered immediately.
38356
38357 .cindex "SMTP" "passed connection"
38358 .cindex "SMTP" "multiple deliveries"
38359 .cindex "multiple SMTP deliveries"
38360 .cindex "first pass routing"
38361 Mail waiting to be sent from an intermittently connected host will probably
38362 not have been routed, because without a connection DNS lookups are not
38363 possible. This means that if a normal queue run is done at connection time,
38364 each message is likely to be sent in a separate SMTP session. This can be
38365 avoided by starting the queue run with a command line option beginning with
38366 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38367 first pass, routing is done but no deliveries take place. The second pass is a
38368 normal queue run; since all the messages have been previously routed, those
38369 destined for the same host are likely to get sent as multiple deliveries in a
38370 single SMTP connection.
38371
38372
38373
38374 . ////////////////////////////////////////////////////////////////////////////
38375 . ////////////////////////////////////////////////////////////////////////////
38376
38377 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38378          "Exim as a non-queueing client"
38379 .cindex "client, non-queueing"
38380 .cindex "smart host" "suppressing queueing"
38381 On a personal computer, it is a common requirement for all
38382 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38383 configured to operate that way, for all the popular operating systems.
38384 However, there are some MUAs for Unix-like systems that cannot be so
38385 configured: they submit messages using the command line interface of
38386 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38387 messages this way.
38388
38389 If the personal computer runs continuously, there is no problem, because it can
38390 run a conventional MTA that handles delivery to the smart host, and deal with
38391 any delays via its queueing mechanism. However, if the computer does not run
38392 continuously or runs different operating systems at different times, queueing
38393 email is not desirable.
38394
38395 There is therefore a requirement for something that can provide the
38396 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38397 any queueing or retrying facilities. Furthermore, the delivery to the smart
38398 host should be synchronous, so that if it fails, the sending MUA is immediately
38399 informed. In other words, we want something that extends an MUA that submits
38400 to a local MTA via the command line so that it behaves like one that submits
38401 to a remote smart host using TCP/SMTP.
38402
38403 There are a number of applications (for example, there is one called &'ssmtp'&)
38404 that do this job. However, people have found them to be lacking in various
38405 ways. For instance, you might want to allow aliasing and forwarding to be done
38406 before sending a message to the smart host.
38407
38408 Exim already had the necessary infrastructure for doing this job. Just a few
38409 tweaks were needed to make it behave as required, though it is somewhat of an
38410 overkill to use a fully-featured MTA for this purpose.
38411
38412 .oindex "&%mua_wrapper%&"
38413 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38414 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38415 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38416 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38417 compatible router and transport configuration. Typically there will be just one
38418 router and one transport, sending everything to a smart host.
38419
38420 When run in MUA wrapping mode, the behaviour of Exim changes in the
38421 following ways:
38422
38423 .ilist
38424 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38425 In other words, the only way to submit messages is via the command line.
38426 .next
38427 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38428 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38429 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38430 does not finish until the delivery attempt is complete. If the delivery is
38431 successful, a zero return code is given.
38432 .next
38433 Address redirection is permitted, but the final routing for all addresses must
38434 be to the same remote transport, and to the same list of hosts. Furthermore,
38435 the return address (envelope sender) must be the same for all recipients, as
38436 must any added or deleted header lines. In other words, it must be possible to
38437 deliver the message in a single SMTP transaction, however many recipients there
38438 are.
38439 .next
38440 If these conditions are not met, or if routing any address results in a
38441 failure or defer status, or if Exim is unable to deliver all the recipients
38442 successfully to one of the smart hosts, delivery of the entire message fails.
38443 .next
38444 Because no queueing is allowed, all failures are treated as permanent; there
38445 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38446 smart host. Furthermore, because only a single yes/no response can be given to
38447 the caller, it is not possible to deliver to some recipients and not others. If
38448 there is an error (temporary or permanent) for any recipient, all are failed.
38449 .next
38450 If more than one smart host is listed, Exim will try another host after a
38451 connection failure or a timeout, in the normal way. However, if this kind of
38452 failure happens for all the hosts, the delivery fails.
38453 .next
38454 When delivery fails, an error message is written to the standard error stream
38455 (as well as to Exim's log), and Exim exits to the caller with a return code
38456 value 1. The message is expunged from Exim's spool files. No bounce messages
38457 are ever generated.
38458 .next
38459 No retry data is maintained, and any retry rules are ignored.
38460 .next
38461 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38462 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38463 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38464 .endlist
38465
38466 The overall effect is that Exim makes a single synchronous attempt to deliver
38467 the message, failing if there is any kind of problem. Because no local
38468 deliveries are done and no daemon can be run, Exim does not need root
38469 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38470 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38471 the advantages and disadvantages of running without root privilege.
38472
38473
38474
38475
38476 . ////////////////////////////////////////////////////////////////////////////
38477 . ////////////////////////////////////////////////////////////////////////////
38478
38479 .chapter "Log files" "CHAPlog"
38480 .scindex IIDloggen "log" "general description"
38481 .cindex "log" "types of"
38482 Exim writes three different logs, referred to as the main log, the reject log,
38483 and the panic log:
38484
38485 .ilist
38486 .cindex "main log"
38487 The main log records the arrival of each message and each delivery in a single
38488 line in each case. The format is as compact as possible, in an attempt to keep
38489 down the size of log files. Two-character flag sequences make it easy to pick
38490 out these lines. A number of other events are recorded in the main log. Some of
38491 them are optional, in which case the &%log_selector%& option controls whether
38492 they are included or not. A Perl script called &'eximstats'&, which does simple
38493 analysis of main log files, is provided in the Exim distribution (see section
38494 &<<SECTmailstat>>&).
38495 .next
38496 .cindex "reject log"
38497 The reject log records information from messages that are rejected as a result
38498 of a configuration option (that is, for policy reasons).
38499 The first line of each rejection is a copy of the line that is also written to
38500 the main log. Then, if the message's header has been read at the time the log
38501 is written, its contents are written to this log. Only the original header
38502 lines are available; header lines added by ACLs are not logged. You can use the
38503 reject log to check that your policy controls are working correctly; on a busy
38504 host this may be easier than scanning the main log for rejection messages. You
38505 can suppress the writing of the reject log by setting &%write_rejectlog%&
38506 false.
38507 .next
38508 .cindex "panic log"
38509 .cindex "system log"
38510 When certain serious errors occur, Exim writes entries to its panic log. If the
38511 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38512 are usually written to the main log as well, but can get lost amid the mass of
38513 other entries. The panic log should be empty under normal circumstances. It is
38514 therefore a good idea to check it (or to have a &'cron'& script check it)
38515 regularly, in order to become aware of any problems. When Exim cannot open its
38516 panic log, it tries as a last resort to write to the system log (syslog). This
38517 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38518 message itself is written at priority LOG_CRIT.
38519 .endlist
38520
38521 Every log line starts with a timestamp, in the format shown in the following
38522 example. Note that many of the examples shown in this chapter are line-wrapped.
38523 In the log file, this would be all on one line:
38524 .code
38525 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38526   by QUIT
38527 .endd
38528 By default, the timestamps are in the local timezone. There are two
38529 ways of changing this:
38530
38531 .ilist
38532 You can set the &%timezone%& option to a different time zone; in particular, if
38533 you set
38534 .code
38535 timezone = UTC
38536 .endd
38537 the timestamps will be in UTC (aka GMT).
38538 .next
38539 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38540 example:
38541 .code
38542 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38543 .endd
38544 .endlist
38545
38546 .cindex "log" "process ids in"
38547 .cindex "pid (process id)" "in log lines"
38548 Exim does not include its process id in log lines by default, but you can
38549 request that it does so by specifying the &`pid`& log selector (see section
38550 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38551 brackets, immediately after the time and date.
38552
38553
38554
38555
38556 .section "Where the logs are written" "SECTwhelogwri"
38557 .cindex "log" "destination"
38558 .cindex "log" "to file"
38559 .cindex "log" "to syslog"
38560 .cindex "syslog"
38561 The logs may be written to local files, or to syslog, or both. However, it
38562 should be noted that many syslog implementations use UDP as a transport, and
38563 are therefore unreliable in the sense that messages are not guaranteed to
38564 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38565 It has also been reported that on large log files (tens of megabytes) you may
38566 need to tweak syslog to prevent it syncing the file with each write &-- on
38567 Linux this has been seen to make syslog take 90% plus of CPU time.
38568
38569 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38570 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38571 configuration. This latter string is expanded, so it can contain, for example,
38572 references to the host name:
38573 .code
38574 log_file_path = /var/log/$primary_hostname/exim_%slog
38575 .endd
38576 It is generally advisable, however, to set the string in &_Local/Makefile_&
38577 rather than at runtime, because then the setting is available right from the
38578 start of Exim's execution. Otherwise, if there's something it wants to log
38579 before it has read the configuration file (for example, an error in the
38580 configuration file) it will not use the path you want, and may not be able to
38581 log at all.
38582
38583 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38584 list, currently limited to at most two items. This is one option where the
38585 facility for changing a list separator may not be used. The list must always be
38586 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38587 otherwise the item must either be an absolute path, containing &`%s`& at the
38588 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38589 implying the use of a default path.
38590
38591 When Exim encounters an empty item in the list, it searches the list defined by
38592 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38593 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38594 mean &"use the path specified at build time"&. If no such item exists, log
38595 files are written in the &_log_& subdirectory of the spool directory. This is
38596 equivalent to the configuration file setting:
38597 .code
38598 log_file_path = $spool_directory/log/%slog
38599 .endd
38600 If you do not specify anything at build time or runtime,
38601 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38602 that is where the logs are written.
38603
38604 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38605 are in use &-- see section &<<SECTdatlogfil>>& below.
38606
38607 Here are some examples of possible Makefile settings:
38608 .display
38609 &`LOG_FILE_PATH=syslog                    `& syslog only
38610 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38611 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38612 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38613 .endd
38614 If there are more than two paths in the list, the first is used and a panic
38615 error is logged.
38616
38617
38618
38619 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38620 .cindex "log" "cycling local files"
38621 .cindex "cycling logs"
38622 .cindex "&'exicyclog'&"
38623 .cindex "log" "local files; writing to"
38624 Some operating systems provide centralized and standardized methods for cycling
38625 log files. For those that do not, a utility script called &'exicyclog'& is
38626 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38627 main and reject logs each time it is called. The maximum number of old logs to
38628 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38629
38630 An Exim delivery process opens the main log when it first needs to write to it,
38631 and it keeps the file open in case subsequent entries are required &-- for
38632 example, if a number of different deliveries are being done for the same
38633 message. However, remote SMTP deliveries can take a long time, and this means
38634 that the file may be kept open long after it is renamed if &'exicyclog'& or
38635 something similar is being used to rename log files on a regular basis. To
38636 ensure that a switch of log files is noticed as soon as possible, Exim calls
38637 &[stat()]& on the main log's name before reusing an open file, and if the file
38638 does not exist, or its inode has changed, the old file is closed and Exim
38639 tries to open the main log from scratch. Thus, an old log file may remain open
38640 for quite some time, but no Exim processes should write to it once it has been
38641 renamed.
38642
38643
38644
38645 .section "Datestamped log files" "SECTdatlogfil"
38646 .cindex "log" "datestamped files"
38647 Instead of cycling the main and reject log files by renaming them
38648 periodically, some sites like to use files whose names contain a datestamp,
38649 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38650 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38651 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38652 point where the datestamp is required. For example:
38653 .code
38654 log_file_path = /var/spool/exim/log/%slog-%D
38655 log_file_path = /var/log/exim-%s-%D.log
38656 log_file_path = /var/spool/exim/log/%D-%slog
38657 log_file_path = /var/log/exim/%s.%M
38658 .endd
38659 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38660 examples of names generated by the above examples:
38661 .code
38662 /var/spool/exim/log/mainlog-20021225
38663 /var/log/exim-reject-20021225.log
38664 /var/spool/exim/log/20021225-mainlog
38665 /var/log/exim/main.200212
38666 .endd
38667 When this form of log file is specified, Exim automatically switches to new
38668 files at midnight. It does not make any attempt to compress old logs; you
38669 will need to write your own script if you require this. You should not
38670 run &'exicyclog'& with this form of logging.
38671
38672 The location of the panic log is also determined by &%log_file_path%&, but it
38673 is not datestamped, because rotation of the panic log does not make sense.
38674 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38675 the string. In addition, if it immediately follows a slash, a following
38676 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38677 character is removed. Thus, the four examples above would give these panic
38678 log names:
38679 .code
38680 /var/spool/exim/log/paniclog
38681 /var/log/exim-panic.log
38682 /var/spool/exim/log/paniclog
38683 /var/log/exim/panic
38684 .endd
38685
38686
38687 .section "Logging to syslog" "SECID249"
38688 .cindex "log" "syslog; writing to"
38689 The use of syslog does not change what Exim logs or the format of its messages,
38690 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38691 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38692 that, the same strings are written to syslog as to log files. The syslog
38693 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38694 by default, but you can change these by setting the &%syslog_facility%& and
38695 &%syslog_processname%& options, respectively. If Exim was compiled with
38696 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38697 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38698 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38699 the time and host name to each line.
38700 The three log streams are mapped onto syslog priorities as follows:
38701
38702 .ilist
38703 &'mainlog'& is mapped to LOG_INFO
38704 .next
38705 &'rejectlog'& is mapped to LOG_NOTICE
38706 .next
38707 &'paniclog'& is mapped to LOG_ALERT
38708 .endlist
38709
38710 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38711 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38712 these are routed by syslog to the same place. You can suppress this duplication
38713 by setting &%syslog_duplication%& false.
38714
38715 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38716 entries contain multiple lines when headers are included. To cope with both
38717 these cases, entries written to syslog are split into separate &[syslog()]&
38718 calls at each internal newline, and also after a maximum of
38719 870 data characters. (This allows for a total syslog line length of 1024, when
38720 additions such as timestamps are added.) If you are running a syslog
38721 replacement that can handle lines longer than the 1024 characters allowed by
38722 RFC 3164, you should set
38723 .code
38724 SYSLOG_LONG_LINES=yes
38725 .endd
38726 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38727 lines, but it still splits at internal newlines in &'reject'& log entries.
38728
38729 To make it easy to re-assemble split lines later, each component of a split
38730 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38731 where <&'n'&> is the component number and <&'m'&> is the total number of
38732 components in the entry. The / delimiter is used when the line was split
38733 because it was too long; if it was split because of an internal newline, the \
38734 delimiter is used. For example, supposing the length limit to be 50 instead of
38735 870, the following would be the result of a typical rejection message to
38736 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38737 name, and pid as added by syslog:
38738 .code
38739 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38740 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38741 [3/5]  when scanning for sender: missing or malformed lo
38742 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38743 [5/5] mple>)
38744 .endd
38745 The same error might cause the following lines to be written to &"rejectlog"&
38746 (LOG_NOTICE):
38747 .code
38748 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38749 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38750 [3/18] er when scanning for sender: missing or malformed
38751 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38752 [5\18] .example>)
38753 [6\18] Recipients: ph10@some.domain.cam.example
38754 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38755 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38756 [9\18]        id 16RdAL-0006pc-00
38757 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38758 [11\18] 09:43 +0100
38759 [12\18] F From: <>
38760 [13\18]   Subject: this is a test header
38761 [18\18]   X-something: this is another header
38762 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38763 [16\18] le>
38764 [17\18] B Bcc:
38765 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38766 .endd
38767 Log lines that are neither too long nor contain newlines are written to syslog
38768 without modification.
38769
38770 If only syslog is being used, the Exim monitor is unable to provide a log tail
38771 display, unless syslog is routing &'mainlog'& to a file on the local host and
38772 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38773 where it is.
38774
38775
38776
38777 .section "Log line flags" "SECID250"
38778 One line is written to the main log for each message received, and for each
38779 successful, unsuccessful, and delayed delivery. These lines can readily be
38780 picked out by the distinctive two-character flags that immediately follow the
38781 timestamp. The flags are:
38782 .itable none 0 0 2 10* left 90* left
38783 .irow &%<=%&     "message arrival"
38784 .irow &%(=%&     "message fakereject"
38785 .irow &%=>%&     "normal message delivery"
38786 .irow &%->%&     "additional address in same delivery"
38787 .irow &%>>%&     "cutthrough message delivery"
38788 .irow &%*>%&     "delivery suppressed by &%-N%&"
38789 .irow &%**%&     "delivery failed; address bounced"
38790 .irow &%==%&     "delivery deferred; temporary problem"
38791 .endtable
38792
38793
38794 .section "Logging message reception" "SECID251"
38795 .cindex "log" "reception line"
38796 The format of the single-line entry in the main log that is written for every
38797 message received is shown in the basic example below, which is split over
38798 several lines in order to fit it on the page:
38799 .code
38800 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38801   H=mailer.fict.example [192.168.123.123] U=exim
38802   P=smtp S=5678 id=<incoming message id>
38803 .endd
38804 The address immediately following &"<="& is the envelope sender address. A
38805 bounce message is shown with the sender address &"<>"&, and if it is locally
38806 generated, this is followed by an item of the form
38807 .code
38808 R=<message id>
38809 .endd
38810 which is a reference to the message that caused the bounce to be sent.
38811
38812 .cindex "HELO"
38813 .cindex "EHLO"
38814 For messages from other hosts, the H and U fields identify the remote host and
38815 record the RFC 1413 identity of the user that sent the message, if one was
38816 received. The number given in square brackets is the IP address of the sending
38817 host. If there is a single, unparenthesized  host name in the H field, as
38818 above, it has been verified to correspond to the IP address (see the
38819 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38820 by the remote host in the SMTP HELO or EHLO command, and has not been
38821 verified. If verification yields a different name to that given for HELO or
38822 EHLO, the verified name appears first, followed by the HELO or EHLO
38823 name in parentheses.
38824
38825 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38826 without brackets, in the HELO or EHLO command, leading to entries in
38827 the log containing text like these examples:
38828 .code
38829 H=(10.21.32.43) [192.168.8.34]
38830 H=([10.21.32.43]) [192.168.8.34]
38831 .endd
38832 This can be confusing. Only the final address in square brackets can be relied
38833 on.
38834
38835 For locally generated messages (that is, messages not received over TCP/IP),
38836 the H field is omitted, and the U field contains the login name of the caller
38837 of Exim.
38838
38839 .cindex "authentication" "logging"
38840 .cindex "AUTH" "logging"
38841 For all messages, the P field specifies the protocol used to receive the
38842 message. This is the value that is stored in &$received_protocol$&. In the case
38843 of incoming SMTP messages, the value indicates whether or not any SMTP
38844 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38845 session was encrypted, there is an additional X field that records the cipher
38846 suite that was used.
38847
38848 .cindex log protocol
38849 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38850 hosts that have authenticated themselves using the SMTP AUTH command. The first
38851 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38852 there is an additional item A= followed by the name of the authenticator that
38853 was used. If an authenticated identification was set up by the authenticator's
38854 &%server_set_id%& option, this is logged too, separated by a colon from the
38855 authenticator name.
38856
38857 .cindex "size" "of message"
38858 The id field records the existing message id, if present. The size of the
38859 received message is given by the S field. When the message is delivered,
38860 headers may be removed or added, so that the size of delivered copies of the
38861 message may not correspond with this value (and indeed may be different to each
38862 other).
38863
38864 The &%log_selector%& option can be used to request the logging of additional
38865 data when a message is received. See section &<<SECTlogselector>>& below.
38866
38867
38868
38869 .section "Logging deliveries" "SECID252"
38870 .cindex "log" "delivery line"
38871 The format of the single-line entry in the main log that is written for every
38872 delivery is shown in one of the examples below, for local and remote
38873 deliveries, respectively. Each example has been split into multiple lines in order
38874 to fit it on the page:
38875 .code
38876 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38877   <marv@hitch.fict.example> R=localuser T=local_delivery
38878 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38879   monk@holistic.fict.example R=dnslookup T=remote_smtp
38880   H=holistic.fict.example [192.168.234.234]
38881 .endd
38882 For ordinary local deliveries, the original address is given in angle brackets
38883 after the final delivery address, which might be a pipe or a file. If
38884 intermediate address(es) exist between the original and the final address, the
38885 last of these is given in parentheses after the final address. The R and T
38886 fields record the router and transport that were used to process the address.
38887
38888 If SMTP AUTH was used for the delivery there is an additional item A=
38889 followed by the name of the authenticator that was used.
38890 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38891 option, this is logged too, as a second colon-separated list item.
38892 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38893
38894 If a shadow transport was run after a successful local delivery, the log line
38895 for the successful delivery has an item added on the end, of the form
38896 .display
38897 &`ST=<`&&'shadow transport name'&&`>`&
38898 .endd
38899 If the shadow transport did not succeed, the error message is put in
38900 parentheses afterwards.
38901
38902 .cindex "asterisk" "after IP address"
38903 When more than one address is included in a single delivery (for example, two
38904 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38905 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38906 down a single SMTP connection, an asterisk follows the
38907 remote IP address (and port if enabled)
38908 in the log lines for the second and subsequent messages.
38909 When two or more messages are delivered down a single TLS connection, the
38910 DNS and some TLS-related information logged for the first message delivered
38911 will not be present in the log lines for the second and subsequent messages.
38912 TLS cipher information is still available.
38913
38914 .cindex "delivery" "cutthrough; logging"
38915 .cindex "cutthrough" "logging"
38916 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38917 line precedes the reception line, since cutthrough waits for a possible
38918 rejection from the destination in case it can reject the sourced item.
38919
38920 The generation of a reply message by a filter file gets logged as a
38921 &"delivery"& to the addressee, preceded by &">"&.
38922
38923 The &%log_selector%& option can be used to request the logging of additional
38924 data when a message is delivered. See section &<<SECTlogselector>>& below.
38925
38926
38927 .section "Discarded deliveries" "SECID253"
38928 .cindex "discarded messages"
38929 .cindex "message" "discarded"
38930 .cindex "delivery" "discarded; logging"
38931 When a message is discarded as a result of the command &"seen finish"& being
38932 obeyed in a filter file which generates no deliveries, a log entry of the form
38933 .code
38934 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38935   <low.club@bridge.example> R=userforward
38936 .endd
38937 is written, to record why no deliveries are logged. When a message is discarded
38938 because it is aliased to &":blackhole:"& the log line is like this:
38939 .code
38940 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38941   <hole@nowhere.example> R=blackhole_router
38942 .endd
38943
38944
38945 .section "Deferred deliveries" "SECID254"
38946 When a delivery is deferred, a line of the following form is logged:
38947 .code
38948 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38949   R=dnslookup T=smtp defer (146): Connection refused
38950 .endd
38951 In the case of remote deliveries, the error is the one that was given for the
38952 last IP address that was tried. Details of individual SMTP failures are also
38953 written to the log, so the above line would be preceded by something like
38954 .code
38955 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38956   mail1.endrest.example [192.168.239.239]: Connection refused
38957 .endd
38958 When a deferred address is skipped because its retry time has not been reached,
38959 a message is written to the log, but this can be suppressed by setting an
38960 appropriate value in &%log_selector%&.
38961
38962
38963
38964 .section "Delivery failures" "SECID255"
38965 .cindex "delivery" "failure; logging"
38966 If a delivery fails because an address cannot be routed, a line of the
38967 following form is logged:
38968 .code
38969 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38970   <jim@trek99.example>: unknown mail domain
38971 .endd
38972 If a delivery fails at transport time, the router and transport are shown, and
38973 the response from the remote host is included, as in this example:
38974 .code
38975 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38976   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38977   after pipelined RCPT TO:<ace400@pb.example>: host
38978   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38979   <ace400@pb.example>...Addressee unknown
38980 .endd
38981 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38982 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38983 disabling PIPELINING. The log lines for all forms of delivery failure are
38984 flagged with &`**`&.
38985
38986
38987
38988 .section "Fake deliveries" "SECID256"
38989 .cindex "delivery" "fake; logging"
38990 If a delivery does not actually take place because the &%-N%& option has been
38991 used to suppress it, a normal delivery line is written to the log, except that
38992 &"=>"& is replaced by &"*>"&.
38993
38994
38995
38996 .section "Completion" "SECID257"
38997 A line of the form
38998 .code
38999 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
39000 .endd
39001 is written to the main log when a message is about to be removed from the spool
39002 at the end of its processing.
39003
39004
39005
39006
39007 .section "Summary of Fields in Log Lines" "SECID258"
39008 .cindex "log" "summary of fields"
39009 A summary of the field identifiers that are used in log lines is shown in
39010 the following table:
39011 .display
39012 &`A   `&        authenticator name (and optional id and sender)
39013 &`C   `&        SMTP confirmation on delivery
39014 &`Ci  `&        connection identifier
39015 &`    `&        command list for &"no mail in SMTP session"&
39016 &`CV  `&        certificate verification status
39017 &`D   `&        duration of &"no mail in SMTP session"&
39018 &`DKIM`&        domain verified in incoming message
39019 &`DN  `&        distinguished name from peer certificate
39020 &`DS  `&        DNSSEC secured lookups
39021 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
39022 &`F   `&        sender address (on delivery lines)
39023 &`H   `&        host name and IP address
39024 &`I   `&        local interface used
39025 &`id  `&        message id (from header) for incoming message
39026 &`K   `&        CHUNKING extension used
39027 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
39028 &`M8S `&        8BITMIME status for incoming message
39029 &`P   `&        on &`<=`& lines: protocol used
39030 &`    `&        on &`=>`& and &`**`& lines: return path
39031 &`PRDR`&        PRDR extension used
39032 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
39033 &`Q   `&        alternate queue name
39034 &`QT  `&        on &`=>`& lines: time spent on queue so far
39035 &`    `&        on &"Completed"& lines: time spent on queue
39036 &`R   `&        on &`<=`& lines: reference for local bounce
39037 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
39038 &`RT  `&        on &`<=`& lines: time taken for reception
39039 &`S   `&        size of message in bytes
39040 &`SNI `&        server name indication from TLS client hello
39041 &`ST  `&        shadow transport name
39042 &`T   `&        on &`<=`& lines: message subject (topic)
39043 &`TFO `&        connection took advantage of TCP Fast Open
39044 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
39045 &`U   `&        local user or RFC 1413 identity
39046 &`X   `&        TLS cipher suite
39047 .endd
39048
39049
39050 .section "Other log entries" "SECID259"
39051 Various other types of log entry are written from time to time. Most should be
39052 self-explanatory. Among the more common are:
39053
39054 .ilist
39055 .cindex "retry" "time not reached"
39056 &'retry time not reached'&&~&~An address previously suffered a temporary error
39057 during routing or local delivery, and the time to retry has not yet arrived.
39058 This message is not written to an individual message log file unless it happens
39059 during the first delivery attempt.
39060 .next
39061 &'retry time not reached for any host'&&~&~An address previously suffered
39062 temporary errors during remote delivery, and the retry time has not yet arrived
39063 for any of the hosts to which it is routed.
39064 .next
39065 .cindex "spool directory" "file locked"
39066 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39067 some other Exim process is already working on the message. This can be quite
39068 common if queue running processes are started at frequent intervals. The
39069 &'exiwhat'& utility script can be used to find out what Exim processes are
39070 doing.
39071 .next
39072 .cindex "error" "ignored"
39073 &'error ignored'&&~&~There are several circumstances that give rise to this
39074 message:
39075 .olist
39076 Exim failed to deliver a bounce message whose age was greater than
39077 &%ignore_bounce_errors_after%&. The bounce was discarded.
39078 .next
39079 A filter file set up a delivery using the &"noerror"& option, and the delivery
39080 failed. The delivery was discarded.
39081 .next
39082 A delivery set up by a router configured with
39083 . ==== As this is a nested list, any displays it contains must be indented
39084 . ==== as otherwise they are too far to the left.
39085 .code
39086     errors_to = <>
39087 .endd
39088 failed. The delivery was discarded.
39089 .endlist olist
39090 .next
39091 .cindex DKIM "log line"
39092 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39093 logging and the message has a DKIM signature header.
39094 .endlist ilist
39095
39096
39097
39098
39099
39100 .section "Reducing or increasing what is logged" "SECTlogselector"
39101 .cindex "log" "selectors"
39102 By setting the &%log_selector%& global option, you can disable some of Exim's
39103 default logging to the main log, or you can request additional logging. The value of
39104 &%log_selector%& is made up of names preceded by plus or minus characters. For
39105 example:
39106 .code
39107 log_selector = +arguments -retry_defer
39108 .endd
39109 The list of optional log items is in the following table, with the default
39110 selection marked by asterisks:
39111 .itable none 0 0 3 2.8in left 10pt center 3in left
39112 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39113 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39114 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39115 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39116 .irow &`arguments`&                     &nbsp; "command line arguments"
39117 .irow &`connection_id`&                 &nbsp;  "connection identifier"
39118 .irow &`connection_reject`&             *       "connection rejections"
39119 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39120 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39121 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39122 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39123 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature; DKIM signing"
39124 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39125 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39126 .irow &`etrn`&                          *       "ETRN commands"
39127 .irow &`host_lookup_failed`&            *       "as it says"
39128 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39129 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39130 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39131 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39132 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39133 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39134 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39135 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39136 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39137 .irow &`queue_run`&                     *       "start and end queue runs"
39138 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39139 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39140 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39141 .irow &`pid`&                           &nbsp; "Exim process id"
39142 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39143 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39144 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39145 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39146 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39147 .irow &`rejected_header`&               *       "header contents on reject log"
39148 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39149 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39150 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39151 .irow &`sender_verify_fail`&            *       "sender verification failures"
39152 .irow &`size_reject`&                   *       "rejection because too big"
39153 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39154 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39155 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39156 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39157 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39158 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39159 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39160 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39161 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39162 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39163 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39164 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39165 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39166 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39167 .irow &`unknown_in_list`&               &nbsp; "lookup failed in list match"
39168 .irow &`all`&                           &nbsp; "&*all of the above*&"
39169 .endtable
39170 See also the &%slow_lookup_log%& main configuration option,
39171 section &<<SECID99>>&
39172
39173 More details on each of these items follows:
39174
39175 .ilist
39176 .cindex "8BITMIME"
39177 .cindex "log" "8BITMIME"
39178 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39179 which may help in tracking down interoperability issues with ancient MTAs
39180 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39181 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39182 &`7BIT`& and &`8BITMIME`& respectively.
39183 .next
39184 .cindex "&%warn%& ACL verb" "log when skipping"
39185 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39186 its conditions cannot be evaluated, a log line to this effect is written if
39187 this log selector is set.
39188 .next
39189 .cindex "log" "rewriting"
39190 .cindex "rewriting" "logging"
39191 &%address_rewrite%&: This applies both to global rewrites and per-transport
39192 rewrites, but not to rewrites in filters run as an unprivileged user (because
39193 such users cannot access the log).
39194 .next
39195 .cindex "log" "full parentage"
39196 &%all_parents%&: Normally only the original and final addresses are logged on
39197 delivery lines; with this selector, intermediate parents are given in
39198 parentheses between them.
39199 .next
39200 .cindex "log" "Exim arguments"
39201 .cindex "Exim arguments, logging"
39202 &%arguments%&: This causes Exim to write the arguments with which it was called
39203 to the main log, preceded by the current working directory. This is a debugging
39204 feature, added to make it easier to find out how certain MUAs call
39205 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39206 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39207 that are empty or that contain white space are quoted. Non-printing characters
39208 are shown as escape sequences. This facility cannot log unrecognized arguments,
39209 because the arguments are checked before the configuration file is read. The
39210 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39211 between the caller and Exim.
39212 .next
39213 .cindex "log" "connection identifier"
39214 &%connection_identifier%&: An identifier for the accepted connection is added to
39215 connection start and end lines and to message accept lines.
39216 The identifier is tagged by Ci=.
39217 The value is PID-based, so will reset on reboot and will wrap.
39218 .next
39219 .cindex "log" "connection rejections"
39220 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39221 connection is rejected, for whatever reason.
39222 .next
39223 .cindex "log" "delayed delivery"
39224 .cindex "delayed delivery, logging"
39225 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39226 started for an incoming message because the load is too high or too many
39227 messages were received on one connection. Logging does not occur if no delivery
39228 process is started because &%queue_only%& is set or &%-odq%& was used.
39229 .next
39230 .cindex "log" "delivery duration"
39231 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39232 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39233 If millisecond logging is enabled, short times will be shown with greater
39234 precision, eg. &`DT=0.304s`&.
39235 .next
39236 .cindex "log" "message size on delivery"
39237 .cindex "size" "of message"
39238 &%delivery_size%&: For each delivery, the size of message delivered is added to
39239 the &"=>"& line, tagged with S=.
39240 .next
39241 .cindex log "DKIM verification"
39242 .cindex DKIM "verification logging"
39243 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39244 verifies successfully a tag of DKIM is added, with one of the verified domains.
39245 .next
39246 .cindex log "DKIM verification"
39247 .cindex DKIM "verification logging"
39248 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39249 .new
39250 Also, on message delivery lines signing information (domain and selector)
39251 is added, tagged with DKIM=.
39252 .wen
39253 .next
39254 .cindex "log" "dnslist defer"
39255 .cindex "DNS list" "logging defer"
39256 .cindex "black list (DNS)"
39257 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39258 DNS black list suffers a temporary error.
39259 .next
39260 .cindex log dnssec
39261 .cindex dnssec logging
39262 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39263 dns lookups gave secure results a tag of DS is added.
39264 For acceptance this covers the reverse and forward lookups for host name verification.
39265 It does not cover helo-name verification.
39266 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39267 .next
39268 .cindex "log" "ETRN commands"
39269 .cindex "ETRN" "logging"
39270 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39271 is run to determine whether or not it is actually accepted. An invalid ETRN
39272 command, or one received within a message transaction is not logged by this
39273 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39274 .next
39275 .cindex "log" "host lookup failure"
39276 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39277 any addresses, or when a lookup of an IP address fails to find a host name, a
39278 log line is written. This logging does not apply to direct DNS lookups when
39279 routing email addresses, but it does apply to &"byname"& lookups.
39280 .next
39281 .cindex "log" "ident timeout"
39282 .cindex "RFC 1413" "logging timeout"
39283 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39284 client's ident port times out.
39285 .next
39286 .cindex "log" "incoming interface"
39287 .cindex "log" "outgoing interface"
39288 .cindex "log" "local interface"
39289 .cindex "log" "local address and port"
39290 .cindex "TCP/IP" "logging local address and port"
39291 .cindex "interface" "logging"
39292 &%incoming_interface%&: The interface on which a message was received is added
39293 to the &"<="& line as an IP address in square brackets, tagged by I= and
39294 followed by a colon and the port number. The local interface and port are also
39295 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39296 rejection lines, and (despite the name) to outgoing
39297 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39298 The latter can be disabled by turning off the &%outgoing_interface%& option.
39299 .next
39300 .cindex log "incoming proxy address"
39301 .cindex proxy "logging proxy address"
39302 .cindex "TCP/IP" "logging proxy address"
39303 &%proxy%&: The internal (closest to the system running Exim) IP address
39304 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39305 on a proxied connection
39306 or the &"=>"& line for a message delivered on a proxied connection.
39307 See &<<SECTproxyInbound>>& for more information.
39308 .next
39309 .cindex "log" "incoming remote port"
39310 .cindex "port" "logging remote"
39311 .cindex "TCP/IP" "logging incoming remote port"
39312 .vindex "&$sender_fullhost$&"
39313 .vindex "&$sender_rcvhost$&"
39314 &%incoming_port%&: The remote port number from which a message was received is
39315 added to log entries and &'Received:'& header lines, following the IP address
39316 in square brackets, and separated from it by a colon. This is implemented by
39317 changing the value that is put in the &$sender_fullhost$& and
39318 &$sender_rcvhost$& variables. Recording the remote port number has become more
39319 important with the widening use of NAT (see RFC 2505).
39320 .next
39321 .cindex "log" "dropped connection"
39322 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39323 connection is unexpectedly dropped.
39324 .next
39325 .cindex "log" "millisecond timestamps"
39326 .cindex millisecond logging
39327 .cindex timestamps "millisecond, in logs"
39328 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39329 appended to the seconds value.
39330 .next
39331 .cindex "log" "message id"
39332 &%msg_id%&: The value of the Message-ID: header.
39333 .next
39334 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39335 This will be either because the message is a bounce, or was submitted locally
39336 (submission mode) without one.
39337 The field identifier will have an asterix appended: &"id*="&.
39338 .next
39339 .cindex "log" "outgoing interface"
39340 .cindex "log" "local interface"
39341 .cindex "log" "local address and port"
39342 .cindex "TCP/IP" "logging local address and port"
39343 .cindex "interface" "logging"
39344 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39345 interface on which a message was sent is added to delivery lines as an I= tag
39346 followed by IP address in square brackets. You can disable this by turning
39347 off the &%outgoing_interface%& option.
39348 .next
39349 .cindex "log" "outgoing remote port"
39350 .cindex "port" "logging outgoing remote"
39351 .cindex "TCP/IP" "logging outgoing remote port"
39352 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39353 containing => tags) following the IP address.
39354 The local port is also added if &%incoming_interface%& and
39355 &%outgoing_interface%& are both enabled.
39356 This option is not included in the default setting, because for most ordinary
39357 configurations, the remote port number is always 25 (the SMTP port), and the
39358 local port is a random ephemeral port.
39359 .next
39360 .cindex "log" "process ids in"
39361 .cindex "pid (process id)" "in log lines"
39362 &%pid%&: The current process id is added to every log line, in square brackets,
39363 immediately after the time and date.
39364 .next
39365 .cindex log pipelining
39366 .cindex pipelining "logging outgoing"
39367 &%pipelining%&: A field is added to delivery and accept
39368 log lines when the ESMTP PIPELINING extension was used.
39369 The field is a single "L".
39370
39371 On accept lines, where PIPELINING was offered but not used by the client,
39372 the field has a minus appended.
39373
39374 .cindex "pipelining" "early connection"
39375 If Exim is built without the DISABLE_PIPE_CONNECT build option
39376 accept "L" fields have a period appended if the feature was
39377 offered but not used, or an asterisk appended if used.
39378 Delivery "L" fields have an asterisk appended if used.
39379
39380 .next
39381 .cindex "log" "queue run"
39382 .cindex "queue runner" "logging"
39383 &%queue_run%&: The start and end of every queue run are logged.
39384 .next
39385 .cindex "log" "queue time"
39386 &%queue_time%&: The amount of time the message has been in the queue on the
39387 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39388 &`QT=3m45s`&.
39389 If millisecond logging is enabled, short times will be shown with greater
39390 precision, eg. &`QT=1.578s`&.
39391 .next
39392 &%queue_time_overall%&: The amount of time the message has been in the queue on
39393 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39394 example, &`QT=3m45s`&.
39395 .next
39396 .cindex "log" "receive duration"
39397 &%receive_time%&: For each message, the amount of real time it has taken to
39398 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39399 If millisecond logging is enabled, short times will be shown with greater
39400 precision, eg. &`RT=0.204s`&.
39401 .next
39402 .cindex "log" "recipients"
39403 &%received_recipients%&: The recipients of a message are listed in the main log
39404 as soon as the message is received. The list appears at the end of the log line
39405 that is written when a message is received, preceded by the word &"for"&. The
39406 addresses are listed after they have been qualified, but before any rewriting
39407 has taken place.
39408 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39409 in the list.
39410 .next
39411 .cindex "log" "sender reception"
39412 &%received_sender%&: The unrewritten original sender of a message is added to
39413 the end of the log line that records the message's arrival, after the word
39414 &"from"& (before the recipients if &%received_recipients%& is also set).
39415 .next
39416 .cindex "log" "header lines for rejection"
39417 &%rejected_header%&: If a message's header has been received at the time a
39418 rejection is written to the reject log, the complete header is added to the
39419 log. Header logging can be turned off individually for messages that are
39420 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39421 .next
39422 .cindex "log" "retry defer"
39423 &%retry_defer%&: A log line is written if a delivery is deferred because a
39424 retry time has not yet been reached. However, this &"retry time not reached"&
39425 message is always omitted from individual message logs after the first delivery
39426 attempt.
39427 .next
39428 .cindex "log" "return path"
39429 &%return_path_on_delivery%&: The return path that is being transmitted with
39430 the message is included in delivery and bounce lines, using the tag P=.
39431 This is omitted if no delivery actually happens, for example, if routing fails,
39432 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39433 .next
39434 .cindex "log" "sender on delivery"
39435 &%sender_on_delivery%&: The message's sender address is added to every delivery
39436 and bounce line, tagged by F= (for &"from"&).
39437 This is the original sender that was received with the message; it is not
39438 necessarily the same as the outgoing return path.
39439 .next
39440 .cindex "log" "sender verify failure"
39441 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39442 gives details of a sender verification failure is not written. Log lines for
39443 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39444 detail is lost.
39445 .next
39446 .cindex "log" "size rejection"
39447 &%size_reject%&: A log line is written whenever a message is rejected because
39448 it is too big.
39449 .next
39450 .cindex "log" "frozen messages; skipped"
39451 .cindex "frozen messages" "logging skipping"
39452 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39453 queue run because it another process is already delivering it or because
39454 it is frozen.
39455 .cindex "&""spool file is locked""&"
39456 .cindex "&""message is frozen""&"
39457 The message that is written is either &"spool file is locked"& or
39458 &"message is frozen"&.
39459 .next
39460 .cindex "log" "smtp confirmation"
39461 .cindex "SMTP" "logging confirmation"
39462 .cindex "LMTP" "logging confirmation"
39463 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39464 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39465 A number of MTAs (including Exim) return an identifying string in this
39466 response.
39467 .next
39468 .cindex "log" "SMTP connections"
39469 .cindex "SMTP" "logging connections"
39470 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39471 established or closed, unless the connection is from a host that matches
39472 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39473 only when the closure is unexpected.) This applies to connections from local
39474 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39475 dropped in the middle of a message, a log line is always written, whether or
39476 not this selector is set, but otherwise nothing is written at the start and end
39477 of connections unless this selector is enabled.
39478
39479 For TCP/IP connections to an Exim daemon, the current number of connections is
39480 included in the log message for each new connection, but note that the count is
39481 reset if the daemon is restarted.
39482 Also, because connections are closed (and the closure is logged) in
39483 subprocesses, the count may not include connections that have been closed but
39484 whose termination the daemon has not yet noticed. Thus, while it is possible to
39485 match up the opening and closing of connections in the log, the value of the
39486 logged counts may not be entirely accurate.
39487 .next
39488 .cindex "log" "SMTP transaction; incomplete"
39489 .cindex "SMTP" "logging incomplete transactions"
39490 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39491 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39492 and the message sender plus any accepted recipients are included in the log
39493 line. This can provide evidence of dictionary attacks.
39494 .next
39495 .cindex "log" "non-MAIL SMTP sessions"
39496 .cindex "MAIL" "logging session without"
39497 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39498 connection terminates without having issued a MAIL command. This includes both
39499 the case when the connection is dropped, and the case when QUIT is used. It
39500 does not include cases where the connection is rejected right at the start (by
39501 an ACL, or because there are too many connections, or whatever). These cases
39502 already have their own log lines.
39503
39504 The log line that is written contains the identity of the client in the usual
39505 way, followed by D= and a time, which records the duration of the connection.
39506 If the connection was authenticated, this fact is logged exactly as it is for
39507 an incoming message, with an A= item. If the connection was encrypted, CV=,
39508 DN=, and X= items may appear as they do for an incoming message, controlled by
39509 the same logging options.
39510
39511 Finally, if any SMTP commands were issued during the connection, a C= item
39512 is added to the line, listing the commands that were used. For example,
39513 .code
39514 C=EHLO,QUIT
39515 .endd
39516 shows that the client issued QUIT straight after EHLO. If there were fewer
39517 than 20 commands, they are all listed. If there were more than 20 commands,
39518 the last 20 are listed, preceded by &"..."&. However, with the default
39519 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39520 have been aborted before 20 non-mail commands are processed.
39521 .next
39522 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39523 colon-separated, is appended to the A= item for a message arrival or delivery
39524 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39525 was accepted or used.
39526 .next
39527 .cindex "log" "SMTP protocol error"
39528 .cindex "SMTP" "logging protocol error"
39529 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39530 encountered. Exim does not have perfect detection of all protocol errors
39531 because of transmission delays and the use of pipelining. If PIPELINING has
39532 been advertised to a client, an Exim server assumes that the client will use
39533 it, and therefore it does not count &"expected"& errors (for example, RCPT
39534 received after rejecting MAIL) as protocol errors.
39535 .next
39536 .cindex "SMTP" "logging syntax errors"
39537 .cindex "SMTP" "syntax errors; logging"
39538 .cindex "SMTP" "unknown command; logging"
39539 .cindex "log" "unknown SMTP command"
39540 .cindex "log" "SMTP syntax error"
39541 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39542 encountered. An unrecognized command is treated as a syntax error. For an
39543 external connection, the host identity is given; for an internal connection
39544 using &%-bs%& the sender identification (normally the calling user) is given.
39545 .next
39546 .cindex "log" "subject"
39547 .cindex "subject, logging"
39548 &%subject%&: The subject of the message is added to the arrival log line,
39549 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39550 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39551 specifies whether characters with values greater than 127 should be logged
39552 unchanged, or whether they should be rendered as escape sequences.
39553 .next
39554 .cindex "log" "certificate verification"
39555 .cindex log DANE
39556 .cindex DANE logging
39557 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39558 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39559 verified
39560 using a CA trust anchor,
39561 &`CV=dane`& if using a DNS trust anchor,
39562 and &`CV=no`& if not.
39563 .next
39564 .cindex "log" "TLS cipher"
39565 .cindex "TLS" "logging cipher"
39566 &%tls_cipher%&: When a message is sent or received over an encrypted
39567 connection, the cipher suite used is added to the log line, preceded by X=.
39568 .next
39569 .cindex "log" "TLS peer DN"
39570 .cindex "TLS" "logging peer DN"
39571 &%tls_peerdn%&: When a message is sent or received over an encrypted
39572 connection, and a certificate is supplied by the remote host, the peer DN is
39573 added to the log line, preceded by DN=.
39574 .next
39575 .cindex "log" "TLS resumption"
39576 .cindex "TLS" "logging session resumption"
39577 &%tls_resumption%&: When a message is sent or received over an encrypted
39578 connection and the TLS session resumed one used on a previous TCP connection,
39579 an asterisk is appended to the X= cipher field in the log line.
39580 .next
39581 .cindex "log" "TLS SNI"
39582 .cindex "TLS" "logging SNI"
39583 .cindex SNI logging
39584 &%tls_sni%&: When a message is received over an encrypted connection, and
39585 the remote host provided the Server Name Indication extension, the SNI is
39586 added to the log line, preceded by SNI=.
39587 .next
39588 .cindex "log" "DNS failure in list"
39589 &%unknown_in_list%&: This setting causes a log entry to be written when the
39590 result of a list match is failure because a DNS lookup failed, or because
39591 a bad IP address was in the list.
39592 .endlist
39593
39594
39595 .section "Message log" "SECID260"
39596 .cindex "message" "log file for"
39597 .cindex "log" "message log; description of"
39598 .cindex "&_msglog_& directory"
39599 .oindex "&%preserve_message_logs%&"
39600 In addition to the general log files, Exim writes a log file for each message
39601 that it handles. The names of these per-message logs are the message ids, and
39602 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39603 message log contains copies of the log lines that apply to the message. This
39604 makes it easier to inspect the status of an individual message without having
39605 to search the main log. A message log is deleted when processing of the message
39606 is complete, unless &%preserve_message_logs%& is set, but this should be used
39607 only with great care because they can fill up your disk very quickly.
39608
39609 On a heavily loaded system, it may be desirable to disable the use of
39610 per-message logs, in order to reduce disk I/O. This can be done by setting the
39611 &%message_logs%& option false.
39612 .ecindex IIDloggen
39613
39614
39615
39616
39617 . ////////////////////////////////////////////////////////////////////////////
39618 . ////////////////////////////////////////////////////////////////////////////
39619
39620 .chapter "Exim utilities" "CHAPutils"
39621 .scindex IIDutils "utilities"
39622 A number of utility scripts and programs are supplied with Exim and are
39623 described in this chapter. There is also the Exim Monitor, which is covered in
39624 the next chapter. The utilities described here are:
39625
39626 .itable none 0 0 3  7* left  15* left  40* left
39627 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39628   "list what Exim processes are doing"
39629 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39630 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39631 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39632 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39633                                                 various criteria"
39634 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39635 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39636   "extract statistics from the log"
39637 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39638   "check address acceptance from given IP"
39639 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39640 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39641 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39642 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39643 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39644 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39645 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39646 .endtable
39647
39648 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39649 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39650 &url(https://duncanthrax.net/exilog/) for details.
39651
39652
39653
39654
39655 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39656 .cindex "&'exiwhat'&"
39657 .cindex "process, querying"
39658 .cindex "SIGUSR1"
39659 On operating systems that can restart a system call after receiving a signal
39660 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39661 a line describing what it is doing to the file &_exim-process.info_& in the
39662 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39663 processes it can find, having first emptied the file. It then waits for one
39664 second to allow the Exim processes to react before displaying the results. In
39665 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39666 send the signal to the Exim processes, so it is normally run as root.
39667
39668 &*Warning*&: This is not an efficient process. It is intended for occasional
39669 use by system administrators. It is not sensible, for example, to set up a
39670 script that sends SIGUSR1 signals to Exim processes at short intervals.
39671
39672
39673 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39674 varies in different operating systems. Not only are different options used,
39675 but the format of the output is different. For this reason, there are some
39676 system configuration options that configure exactly how &'exiwhat'& works. If
39677 it doesn't seem to be working for you, check the following compile-time
39678 options:
39679 .itable none 0 0 2 30* left 70* left
39680 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39681 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39682 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39683 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39684 .endtable
39685 An example of typical output from &'exiwhat'& is
39686 .code
39687 164 daemon: -q1h, listening on port 25
39688 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39689 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39690   [10.19.42.42] (editor@ref.example)
39691 10592 handling incoming call from [192.168.243.242]
39692 10628 accepting a local non-SMTP message
39693 .endd
39694 The first number in the output line is the process number. The third line has
39695 been split here, in order to fit it on the page.
39696
39697
39698
39699 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39700 .cindex "&'exiqgrep'&"
39701 .cindex "queue" "grepping"
39702 This utility is a Perl script contributed by Matt Hubbard. It runs
39703 .code
39704 exim -bpu
39705 .endd
39706 or (in case &*-a*& switch is specified)
39707 .code
39708 exim -bp
39709 .endd
39710 to obtain a queue listing, and then greps the output to select messages
39711 that match given criteria. The following selection options are available:
39712
39713 .vlist
39714 .vitem &*-f*&&~<&'regex'&>
39715 Match the sender address using a case-insensitive search. The field that is
39716 tested is enclosed in angle brackets, so you can test for bounce messages with
39717 .code
39718 exiqgrep -f '^<>$'
39719 .endd
39720 .vitem &*-r*&&~<&'regex'&>
39721 Match a recipient address using a case-insensitive search. The field that is
39722 tested is not enclosed in angle brackets.
39723
39724 .vitem &*-s*&&~<&'regex'&>
39725 Match against the size field.
39726
39727 .vitem &*-y*&&~<&'seconds'&>
39728 Match messages that are younger than the given time.
39729
39730 .vitem &*-o*&&~<&'seconds'&>
39731 Match messages that are older than the given time.
39732
39733 .vitem &*-z*&
39734 Match only frozen messages.
39735
39736 .vitem &*-x*&
39737 Match only non-frozen messages.
39738
39739 .vitem &*-G*&&~<&'queuename'&>
39740 Match only messages in the given queue.  Without this, the default queue is searched.
39741 .endlist
39742
39743 The following options control the format of the output:
39744
39745 .vlist
39746 .vitem &*-c*&
39747 Display only the count of matching messages.
39748
39749 .vitem &*-l*&
39750 Long format &-- display the full message information as output by Exim. This is
39751 the default.
39752
39753 .vitem &*-i*&
39754 Display message ids only.
39755
39756 .vitem &*-b*&
39757 Brief format &-- one line per message.
39758
39759 .vitem &*-R*&
39760 Display messages in reverse order.
39761
39762 .vitem &*-a*&
39763 Include delivered recipients in queue listing.
39764 .endlist
39765
39766 The following options give alternates for configuration:
39767
39768 .vlist
39769 .vitem &*-C*&&~<&'config&~file'&>
39770 is used to specify an alternate &_exim.conf_& which might
39771 contain alternate exim configuration the queue management might be using.
39772
39773 .vitem &*-E*&&~<&'path'&>
39774 can be used to specify a path for the exim binary,
39775 overriding the built-in one.
39776 .endlist
39777
39778 There is one more option, &%-h%&, which outputs a list of options.
39779 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39780
39781
39782
39783 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39784 .cindex "&'exiqsumm'&"
39785 .cindex "queue" "summary"
39786 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39787 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39788 running a command such as
39789 .code
39790 exim -bp | exiqsumm
39791 .endd
39792 The output consists of one line for each domain that has messages waiting for
39793 it, as in the following example:
39794 .code
39795 3   2322   74m   66m  msn.com.example
39796 .endd
39797 Each line lists the number of pending deliveries for a domain, their total
39798 volume, and the length of time that the oldest and the newest messages have
39799 been waiting. Note that the number of pending deliveries is greater than the
39800 number of messages when messages have more than one recipient.
39801
39802 A summary line is output at the end. By default the output is sorted on the
39803 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39804 the output to be sorted by oldest message and by count of messages,
39805 respectively. There are also three options that split the messages for each
39806 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39807 separates frozen messages, and &%-s%& separates messages according to their
39808 sender.
39809
39810 The output of &'exim -bp'& contains the original addresses in the message, so
39811 this also applies to the output from &'exiqsumm'&. No domains from addresses
39812 generated by aliasing or forwarding are included (unless the &%one_time%&
39813 option of the &(redirect)& router has been used to convert them into &"top
39814 level"& addresses).
39815
39816
39817
39818
39819 .section "Extracting specific information from the log (exigrep)" &&&
39820          "SECTextspeinf"
39821 .cindex "&'exigrep'&"
39822 .cindex "log" "extracts; grepping for"
39823 The &'exigrep'& utility is a Perl script that searches one or more main log
39824 files for entries that match a given pattern. When it finds a match, it
39825 extracts all the log entries for the relevant message, not just those that
39826 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39827 given message, or all mail for a given user, or for a given host, for example.
39828 The input files can be in Exim log format or syslog format.
39829 If a matching log line is not associated with a specific message, it is
39830 included in &'exigrep'&'s output without any additional lines. The usage is:
39831 .display
39832 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39833 .endd
39834 If no log filenames are given on the command line, the standard input is read.
39835
39836 The &%-t%& argument specifies a number of seconds. It adds an additional
39837 condition for message selection. Messages that are complete are shown only if
39838 they spent more than <&'n'&> seconds in the queue.
39839
39840 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39841 makes it case-sensitive. This may give a performance improvement when searching
39842 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39843 option; with &%-I%& they do not. In both cases it is possible to change the
39844 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39845
39846 The &%-l%& option means &"literal"&, that is, treat all characters in the
39847 pattern as standing for themselves. Otherwise the pattern must be a Perl
39848 regular expression.
39849
39850 The &%-v%& option inverts the matching condition. That is, a line is selected
39851 if it does &'not'& match the pattern.
39852
39853 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39854 that are generated as a result/response to a message that &'exigrep'& matched
39855 normally.
39856
39857 Example of &%-M%&:
39858 user_a sends a message to user_b, which generates a bounce back to user_b. If
39859 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39860 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39861 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39862 when searching for &"user_a"& will show both messages since the bounce is
39863 &"related"& to or a &"result"& of the first message that was found by the
39864 search term.
39865
39866 If the location of a &'zcat'& command is known from the definition of
39867 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39868 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39869 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39870 autodetection of some well known compression extensions.
39871
39872
39873 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39874 .cindex "&'exipick'&"
39875 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39876 lists messages from the queue according to a variety of criteria. For details
39877 of &'exipick'&'s facilities, run &'exipick'& with
39878 the &%--help%& option.
39879
39880
39881 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39882 .cindex "log" "cycling local files"
39883 .cindex "cycling logs"
39884 .cindex "&'exicyclog'&"
39885 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39886 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39887 you are using log files with datestamps in their names (see section
39888 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39889 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39890 There are two command line options for &'exicyclog'&:
39891 .ilist
39892 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39893 default that is set when Exim is built. The default default is 10.
39894 .next
39895 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39896 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39897 overriding the script's default, which is to find the setting from Exim's
39898 configuration.
39899 .endlist
39900
39901 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39902 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39903 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39904 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39905 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39906 logs are handled similarly.
39907
39908 If the limit is greater than 99, the script uses 3-digit numbers such as
39909 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39910 to one that is greater, or &'vice versa'&, you will have to fix the names of
39911 any existing log files.
39912
39913 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39914 the end are deleted. All files with numbers greater than 01 are compressed,
39915 using a compression command which is configured by the COMPRESS_COMMAND
39916 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39917 root &%crontab%& entry of the form
39918 .code
39919 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39920 .endd
39921 assuming you have used the name &"exim"& for the Exim user. You can run
39922 &'exicyclog'& as root if you wish, but there is no need.
39923
39924
39925
39926 .section "Mail statistics (eximstats)" "SECTmailstat"
39927 .cindex "statistics"
39928 .cindex "&'eximstats'&"
39929 A Perl script called &'eximstats'& is provided for extracting statistical
39930 information from log files. The output is either plain text, or HTML.
39931 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39932 . --- 404 error and everything else points to that.
39933
39934 The &'eximstats'& script has been hacked about quite a bit over time. The
39935 latest version is the result of some extensive revision by Steve Campbell. A
39936 lot of information is given by default, but there are options for suppressing
39937 various parts of it. Following any options, the arguments to the script are a
39938 list of files, which should be main log files. For example:
39939 .code
39940 eximstats -nr /var/spool/exim/log/mainlog.01
39941 .endd
39942 By default, &'eximstats'& extracts information about the number and volume of
39943 messages received from or delivered to various hosts. The information is sorted
39944 both by message count and by volume, and the top fifty hosts in each category
39945 are listed on the standard output. Similar information, based on email
39946 addresses or domains instead of hosts can be requested by means of various
39947 options. For messages delivered and received locally, similar statistics are
39948 also produced per user.
39949
39950 The output also includes total counts and statistics about delivery errors, and
39951 histograms showing the number of messages received and deliveries made in each
39952 hour of the day. A delivery with more than one address in its envelope (for
39953 example, an SMTP transaction with more than one RCPT command) is counted
39954 as a single delivery by &'eximstats'&.
39955
39956 Though normally more deliveries than receipts are reported (as messages may
39957 have multiple recipients), it is possible for &'eximstats'& to report more
39958 messages received than delivered, even though the queue is empty at the start
39959 and end of the period in question. If an incoming message contains no valid
39960 recipients, no deliveries are recorded for it. A bounce message is handled as
39961 an entirely separate message.
39962
39963 &'eximstats'& always outputs a grand total summary giving the volume and number
39964 of messages received and deliveries made, and the number of hosts involved in
39965 each case. It also outputs the number of messages that were delayed (that is,
39966 not completely delivered at the first attempt), and the number that had at
39967 least one address that failed.
39968
39969 The remainder of the output is in sections that can be independently disabled
39970 or modified by various options. It consists of a summary of deliveries by
39971 transport, histograms of messages received and delivered per time interval
39972 (default per hour), information about the time messages spent in the queue,
39973 a list of relayed messages, lists of the top fifty sending hosts, local
39974 senders, destination hosts, and destination local users by count and by volume,
39975 and a list of delivery errors that occurred.
39976
39977 The relay information lists messages that were actually relayed, that is, they
39978 came from a remote host and were directly delivered to some other remote host,
39979 without being processed (for example, for aliasing or forwarding) locally.
39980
39981 There are quite a few options for &'eximstats'& to control exactly what it
39982 outputs. These are documented in the Perl script itself, and can be extracted
39983 by running the command &(perldoc)& on the script. For example:
39984 .code
39985 perldoc /usr/exim/bin/eximstats
39986 .endd
39987
39988 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39989 .cindex "&'exim_checkaccess'&"
39990 .cindex "policy control" "checking access"
39991 .cindex "checking access"
39992 The &%-bh%& command line argument allows you to run a fake SMTP session with
39993 debugging output, in order to check what Exim is doing when it is applying
39994 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39995 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39996 sometimes you just want to answer the question &"Does this address have
39997 access?"& without bothering with any further details.
39998
39999 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
40000 two arguments, an IP address and an email address:
40001 .code
40002 exim_checkaccess 10.9.8.7 A.User@a.domain.example
40003 .endd
40004 The utility runs a call to Exim with the &%-bh%& option, to test whether the
40005 given email address would be accepted in a RCPT command in a TCP/IP
40006 connection from the host with the given IP address. The output of the utility
40007 is either the word &"accepted"&, or the SMTP error response, for example:
40008 .code
40009 Rejected:
40010 550 Relay not permitted
40011 .endd
40012 When running this test, the utility uses &`<>`& as the envelope sender address
40013 for the MAIL command, but you can change this by providing additional
40014 options. These are passed directly to the Exim command. For example, to specify
40015 that the test is to be run with the sender address &'himself@there.example'&
40016 you can use:
40017 .code
40018 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
40019                  -f himself@there.example
40020 .endd
40021 Note that these additional Exim command line items must be given after the two
40022 mandatory arguments.
40023
40024 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
40025 while running its checks. You can run checks that include callouts by using
40026 &%-bhc%&, but this is not yet available in a &"packaged"& form.
40027
40028
40029
40030 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
40031 .cindex "DBM" "building dbm files"
40032 .cindex "building DBM files"
40033 .cindex "&'exim_dbmbuild'&"
40034 .cindex "lower casing"
40035 .cindex "binary zero" "in lookup key"
40036 The &'exim_dbmbuild'& program reads an input file containing keys and data in
40037 the format used by the &(lsearch)& lookup (see section
40038 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
40039 names as keys and the remainder of the information as data. The lower-casing
40040 can be prevented by calling the program with the &%-nolc%& option.
40041
40042 A terminating zero is included as part of the key string. This is expected by
40043 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
40044 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
40045 strings or the data strings. The &(dbmnz)& lookup type can be used with such
40046 files.
40047
40048 The program requires two arguments: the name of the input file (which can be a
40049 single hyphen to indicate the standard input), and the name of the output file.
40050 It creates the output under a temporary name, and then renames it if all went
40051 well.
40052
40053 .cindex "USE_DB"
40054 If the native DB interface is in use (USE_DB is set in a compile-time
40055 configuration file &-- this is common in free versions of Unix) the two
40056 filenames must be different, because in this mode the Berkeley DB functions
40057 create a single output file using exactly the name given. For example,
40058 .code
40059 exim_dbmbuild /etc/aliases /etc/aliases.db
40060 .endd
40061 reads the system alias file and creates a DBM version of it in
40062 &_/etc/aliases.db_&.
40063
40064 In systems that use the &'ndbm'& routines (mostly proprietary versions of
40065 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
40066 environment, the suffixes are added to the second argument of
40067 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
40068 when the Berkeley functions are used in compatibility mode (though this is not
40069 recommended), because in that case it adds a &_.db_& suffix to the filename.
40070
40071 If a duplicate key is encountered, the program outputs a warning, and when it
40072 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
40073 option is used. By default, only the first of a set of duplicates is used &--
40074 this makes it compatible with &(lsearch)& lookups. There is an option
40075 &%-lastdup%& which causes it to use the data for the last duplicate instead.
40076 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
40077 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40078 return code is 2.
40079
40080
40081
40082
40083 .section "Finding individual retry times (exinext)" "SECTfinindret"
40084 .cindex "retry" "times"
40085 .cindex "&'exinext'&"
40086 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40087 fish specific information out of the retry database. Given a mail domain (or a
40088 complete address), it looks up the hosts for that domain, and outputs any retry
40089 information for the hosts or for the domain. At present, the retry information
40090 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40091 output. For example:
40092 .code
40093 $ exinext piglet@milne.fict.example
40094 kanga.milne.example:192.168.8.1 error 146: Connection refused
40095   first failed: 21-Feb-1996 14:57:34
40096   last tried:   21-Feb-1996 14:57:34
40097   next try at:  21-Feb-1996 15:02:34
40098 roo.milne.example:192.168.8.3 error 146: Connection refused
40099   first failed: 20-Jan-1996 13:12:08
40100   last tried:   21-Feb-1996 11:42:03
40101   next try at:  21-Feb-1996 19:42:03
40102   past final cutoff time
40103 .endd
40104 You can also give &'exinext'& a local part, without a domain, and it
40105 will give any retry information for that local part in your default domain.
40106 A message id can be used to obtain retry information pertaining to a specific
40107 message. This exists only when an attempt to deliver a message to a remote host
40108 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40109 &'exinext'& is not particularly efficient, but then it is not expected to be
40110 run very often.
40111
40112 The &'exinext'& utility calls Exim to find out information such as the location
40113 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40114 passed on to the &'exim'& commands. The first specifies an alternate Exim
40115 configuration file, and the second sets macros for use within the configuration
40116 file. These features are mainly to help in testing, but might also be useful in
40117 environments where more than one configuration file is in use.
40118
40119
40120
40121 .section "Hints database maintenance" "SECThindatmai"
40122 .cindex "hints database" "maintenance"
40123 .cindex "maintaining Exim's hints database"
40124 Three utility programs are provided for maintaining the DBM files that Exim
40125 uses to contain its delivery hint information. Each program requires two
40126 arguments. The first specifies the name of Exim's spool directory, and the
40127 second is the name of the database it is to operate on. These are as follows:
40128
40129 .ilist
40130 &'retry'&: the database of retry information
40131 .next
40132 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40133 for remote hosts
40134 .next
40135 &'callout'&: the callout cache
40136 .next
40137 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40138 .next
40139 &'tls'&: TLS session resumption data
40140 .next
40141 &'misc'&: other hints data
40142 .endlist
40143
40144 The &'misc'& database is used for
40145
40146 .ilist
40147 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40148 .next
40149 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40150 &(smtp)& transport)
40151 .next
40152 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40153 in a transport)
40154 .next
40155 Recording EHLO-time facilities advertised by hosts
40156 .endlist
40157
40158
40159
40160 .section "exim_dumpdb" "SECTdumpdb"
40161 .cindex "&'exim_dumpdb'&"
40162 The entire contents of a database are written to the standard output by the
40163 &'exim_dumpdb'& program,
40164 taking as arguments the spool and database names.
40165 An option &'-z'& may be given to request times in UTC;
40166 otherwise times are in the local timezone.
40167 An option &'-k'& may be given to dump only the record keys.
40168 For example, to dump the retry database:
40169 .code
40170 exim_dumpdb /var/spool/exim retry
40171 .endd
40172 For the retry database
40173 two lines of output are produced for each entry:
40174 .code
40175 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40176 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40177 .endd
40178 The first item on the first line is the key of the record. It starts with one
40179 of the letters R, or T, depending on whether it refers to a routing or
40180 transport retry. For a local delivery, the next part is the local address; for
40181 a remote delivery it is the name of the remote host, followed by its failing IP
40182 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40183 transport). If the remote port is not the standard one (port 25), it is added
40184 to the IP address. Then there follows an error code, an additional error code,
40185 and a textual description of the error.
40186
40187 The three times on the second line are the time of first failure, the time of
40188 the last delivery attempt, and the computed time for the next attempt. The line
40189 ends with an asterisk if the cutoff time for the last retry rule has been
40190 exceeded.
40191
40192 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40193 consists of a host name followed by a list of ids for messages that are or were
40194 waiting to be delivered to that host. If there are a very large number for any
40195 one host, continuation records, with a sequence number added to the host name,
40196 may be seen. The data in these records is often out of date, because a message
40197 may be routed to several alternative hosts, and Exim makes no effort to keep
40198 cross-references.
40199
40200
40201
40202 .section "exim_tidydb" "SECTtidydb"
40203 .cindex "&'exim_tidydb'&"
40204 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40205 database. If run with no options, it removes all records that are more than 30
40206 days old. The age is calculated from the date and time that the record was last
40207 updated. Note that, in the case of the retry database, it is &'not'& the time
40208 since the first delivery failure. Information about a host that has been down
40209 for more than 30 days will remain in the database, provided that the record is
40210 updated sufficiently often.
40211
40212 The cutoff date can be altered by means of the &%-t%& option, which must be
40213 followed by a time. For example, to remove all records older than a week from
40214 the retry database:
40215 .code
40216 exim_tidydb -t 7d /var/spool/exim retry
40217 .endd
40218 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40219 message ids. In the former these appear as data in records keyed by host &--
40220 they were messages that were waiting for that host &-- and in the latter they
40221 are the keys for retry information for messages that have suffered certain
40222 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40223 message ids in database records are those of messages that are still on the
40224 queue. Message ids for messages that no longer exist are removed from
40225 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40226 For the &'retry'& database, records whose keys are non-existent message ids are
40227 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40228 whenever it removes information from the database.
40229
40230 Certain records are automatically removed by Exim when they are no longer
40231 needed, but others are not. For example, if all the MX hosts for a domain are
40232 down, a retry record is created for each one. If the primary MX host comes back
40233 first, its record is removed when Exim successfully delivers to it, but the
40234 records for the others remain because Exim has not tried to use those hosts.
40235
40236 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40237 hints databases. You should do this at a quiet time of day, because it requires
40238 a database to be locked (and therefore inaccessible to Exim) while it does its
40239 work. Removing records from a DBM file does not normally make the file smaller,
40240 but all the common DBM libraries are able to re-use the space that is released.
40241 After an initial phase of increasing in size, the databases normally reach a
40242 point at which they no longer get any bigger, as long as they are regularly
40243 tidied.
40244
40245 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40246 databases is likely to keep on increasing.
40247
40248
40249
40250
40251 .section "exim_fixdb" "SECTfixdb"
40252 .cindex "&'exim_fixdb'&"
40253 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40254 Its main use is for testing Exim, but it might also be occasionally useful for
40255 getting round problems in a live system. Its interface
40256 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40257 key of a database record can then be entered, and the data for that record is
40258 displayed.
40259
40260 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40261 except the &'retry'& database, that is the only operation that can be carried
40262 out. For the &'retry'& database, each field is output preceded by a number, and
40263 data for individual fields can be changed by typing the field number followed
40264 by new data, for example:
40265 .code
40266 > 4 951102:1000
40267 .endd
40268 resets the time of the next delivery attempt. Time values are given as a
40269 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40270 used as optional separators.
40271
40272 Both displayed and input times are in the local timezone by default.
40273 If an option &'-z'& is used on the command line, displayed times
40274 are in UTC.
40275
40276
40277
40278
40279 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40280 .cindex "mailbox" "maintenance"
40281 .cindex "&'exim_lock'&"
40282 .cindex "locking mailboxes"
40283 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40284 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40285 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40286 a user agent while investigating a problem. The utility requires the name of
40287 the file as its first argument. If the locking is successful, the second
40288 argument is run as a command (using C's &[system()]& function); if there is no
40289 second argument, the value of the SHELL environment variable is used; if this
40290 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40291 is unlocked and the utility ends. The following options are available:
40292
40293 .vlist
40294 .vitem &%-fcntl%&
40295 Use &[fcntl()]& locking on the open mailbox.
40296
40297 .vitem &%-flock%&
40298 Use &[flock()]& locking on the open mailbox, provided the operating system
40299 supports it.
40300
40301 .vitem &%-interval%&
40302 This must be followed by a number, which is a number of seconds; it sets the
40303 interval to sleep between retries (default 3).
40304
40305 .vitem &%-lockfile%&
40306 Create a lock file before opening the mailbox.
40307
40308 .vitem &%-mbx%&
40309 Lock the mailbox using MBX rules.
40310
40311 .vitem &%-q%&
40312 Suppress verification output.
40313
40314 .vitem &%-retries%&
40315 This must be followed by a number; it sets the number of times to try to get
40316 the lock (default 10).
40317
40318 .vitem &%-restore_time%&
40319 This option causes &%exim_lock%& to restore the modified and read times to the
40320 locked file before exiting. This allows you to access a locked mailbox (for
40321 example, to take a backup copy) without disturbing the times that the user
40322 subsequently sees.
40323
40324 .vitem &%-timeout%&
40325 This must be followed by a number, which is a number of seconds; it sets a
40326 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40327 default), a non-blocking call is used.
40328
40329 .vitem &%-v%&
40330 Generate verbose output.
40331 .endlist
40332
40333 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40334 default is to create a lock file and also to use &[fcntl()]& locking on the
40335 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40336 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40337 requires that the directory containing the file be writeable. Locking by lock
40338 file does not last forever; Exim assumes that a lock file is expired if it is
40339 more than 30 minutes old.
40340
40341 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40342 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40343 to be taken out on the open mailbox, and an exclusive lock on the file
40344 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40345 number of the mailbox file. When the locking is released, if an exclusive lock
40346 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40347
40348 The default output contains verification of the locking that takes place. The
40349 &%-v%& option causes some additional information to be given. The &%-q%& option
40350 suppresses all output except error messages.
40351
40352 A command such as
40353 .code
40354 exim_lock /var/spool/mail/spqr
40355 .endd
40356 runs an interactive shell while the file is locked, whereas
40357 .display
40358 &`exim_lock -q /var/spool/mail/spqr <<End`&
40359 <&'some commands'&>
40360 &`End`&
40361 .endd
40362 runs a specific non-interactive sequence of commands while the file is locked,
40363 suppressing all verification output. A single command can be run by a command
40364 such as
40365 .code
40366 exim_lock -q /var/spool/mail/spqr \
40367   "cp /var/spool/mail/spqr /some/where"
40368 .endd
40369 Note that if a command is supplied, it must be entirely contained within the
40370 second argument &-- hence the quotes.
40371
40372
40373 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40374 .cindex "exim_msgdate"
40375 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40376 This Perl script converts an Exim Mesage ID back into a human readable form.
40377 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40378
40379 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40380 .ecindex IIDutils
40381 . ////////////////////////////////////////////////////////////////////////////
40382 . ////////////////////////////////////////////////////////////////////////////
40383
40384 .chapter "The Exim monitor" "CHAPeximon"
40385 .scindex IIDeximon "Exim monitor" "description"
40386 .cindex "X-windows"
40387 .cindex "&'eximon'&"
40388 .cindex "Local/eximon.conf"
40389 .cindex "&_exim_monitor/EDITME_&"
40390 The Exim monitor is an application which displays in an X window information
40391 about the state of Exim's queue and what Exim is doing. An admin user can
40392 perform certain operations on messages from this GUI interface; however all
40393 such facilities are also available from the command line, and indeed, the
40394 monitor itself makes use of the command line to perform any actions requested.
40395
40396
40397
40398 .section "Running the monitor" "SECID264"
40399 The monitor is started by running the script called &'eximon'&. This is a shell
40400 script that sets up a number of environment variables, and then runs the
40401 binary called &_eximon.bin_&. The default appearance of the monitor window can
40402 be changed by editing the &_Local/eximon.conf_& file created by editing
40403 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40404 parameters are for.
40405
40406 The parameters that get built into the &'eximon'& script can be overridden for
40407 a particular invocation by setting up environment variables of the same names,
40408 preceded by &`EXIMON_`&. For example, a shell command such as
40409 .code
40410 EXIMON_LOG_DEPTH=400 eximon
40411 .endd
40412 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40413 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40414 overrides the Exim log file configuration. This makes it possible to have
40415 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40416 syslog messages are routed to a file on the local host.
40417
40418 X resources can be used to change the appearance of the window in the normal
40419 way. For example, a resource setting of the form
40420 .code
40421 Eximon*background: gray94
40422 .endd
40423 changes the colour of the background to light grey rather than white. The
40424 stripcharts are drawn with both the data lines and the reference lines in
40425 black. This means that the reference lines are not visible when on top of the
40426 data. However, their colour can be changed by setting a resource called
40427 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40428 For example, if your X server is running Unix, you could set up lighter
40429 reference lines in the stripcharts by obeying
40430 .code
40431 xrdb -merge <<End
40432 Eximon*highlight: gray
40433 End
40434 .endd
40435 .cindex "admin user"
40436 In order to see the contents of messages in the queue, and to operate on them,
40437 &'eximon'& must either be run as root or by an admin user.
40438
40439 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40440 contain X11 resource parameters interpreted by the X11 library.  In addition,
40441 if the first parameter starts with the string "gdb" then it is removed and the
40442 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40443 versioned variants of gdb can be invoked).
40444
40445 The monitor's window is divided into three parts. The first contains one or
40446 more stripcharts and two action buttons, the second contains a &"tail"& of the
40447 main log file, and the third is a display of the queue of messages awaiting
40448 delivery, with two more action buttons. The following sections describe these
40449 different parts of the display.
40450
40451
40452
40453
40454 .section "The stripcharts" "SECID265"
40455 .cindex "stripchart"
40456 The first stripchart is always a count of messages in the queue. Its name can
40457 be configured by setting QUEUE_STRIPCHART_NAME in the
40458 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40459 configuration script by regular expression matches on log file entries, making
40460 it possible to display, for example, counts of messages delivered to certain
40461 hosts or using certain transports. The supplied defaults display counts of
40462 received and delivered messages, and of local and SMTP deliveries. The default
40463 period between stripchart updates is one minute; this can be adjusted by a
40464 parameter in the &_Local/eximon.conf_& file.
40465
40466 The stripchart displays rescale themselves automatically as the value they are
40467 displaying changes. There are always 10 horizontal lines in each chart; the
40468 title string indicates the value of each division when it is greater than one.
40469 For example, &"x2"& means that each division represents a value of 2.
40470
40471 It is also possible to have a stripchart which shows the percentage fullness of
40472 a particular disk partition, which is useful when local deliveries are confined
40473 to a single partition.
40474
40475 .cindex "&%statvfs%& function"
40476 This relies on the availability of the &[statvfs()]& function or equivalent in
40477 the operating system. Most, but not all versions of Unix that support Exim have
40478 this. For this particular stripchart, the top of the chart always represents
40479 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40480 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40481 &_Local/eximon.conf_& file.
40482
40483
40484
40485
40486 .section "Main action buttons" "SECID266"
40487 .cindex "size" "of monitor window"
40488 .cindex "Exim monitor" "window size"
40489 .cindex "window size"
40490 Below the stripcharts there is an action button for quitting the monitor. Next
40491 to this is another button marked &"Size"&. They are placed here so that
40492 shrinking the window to its default minimum size leaves just the queue count
40493 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40494 the window to expand to its maximum size, unless it is already at the maximum,
40495 in which case it is reduced to its minimum.
40496
40497 When expanding to the maximum, if the window cannot be fully seen where it
40498 currently is, it is moved back to where it was the last time it was at full
40499 size. When it is expanding from its minimum size, the old position is
40500 remembered, and next time it is reduced to the minimum it is moved back there.
40501
40502 The idea is that you can keep a reduced window just showing one or two
40503 stripcharts at a convenient place on your screen, easily expand it to show
40504 the full window when required, and just as easily put it back to what it was.
40505 The idea is copied from what the &'twm'& window manager does for its
40506 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40507 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40508
40509 Normally, the monitor starts up with the window at its full size, but it can be
40510 built so that it starts up with the window at its smallest size, by setting
40511 START_SMALL=yes in &_Local/eximon.conf_&.
40512
40513
40514
40515 .section "The log display" "SECID267"
40516 .cindex "log" "tail of; in monitor"
40517 The second section of the window is an area in which a display of the tail of
40518 the main log is maintained.
40519 To save space on the screen, the timestamp on each log line is shortened by
40520 removing the date and, if &%log_timezone%& is set, the timezone.
40521 The log tail is not available when the only destination for logging data is
40522 syslog, unless the syslog lines are routed to a local file whose name is passed
40523 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40524
40525 The log sub-window has a scroll bar at its lefthand side which can be used to
40526 move back to look at earlier text, and the up and down arrow keys also have a
40527 scrolling effect. The amount of log that is kept depends on the setting of
40528 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40529 to use. When this is full, the earlier 50% of data is discarded &-- this is
40530 much more efficient than throwing it away line by line. The sub-window also has
40531 a horizontal scroll bar for accessing the ends of long log lines. This is the
40532 only means of horizontal scrolling; the right and left arrow keys are not
40533 available. Text can be cut from this part of the window using the mouse in the
40534 normal way. The size of this subwindow is controlled by parameters in the
40535 configuration file &_Local/eximon.conf_&.
40536
40537 Searches of the text in the log window can be carried out by means of the ^R
40538 and ^S keystrokes, which default to a reverse and a forward search,
40539 respectively. The search covers only the text that is displayed in the window.
40540 It cannot go further back up the log.
40541
40542 The point from which the search starts is indicated by a caret marker. This is
40543 normally at the end of the text in the window, but can be positioned explicitly
40544 by pointing and clicking with the left mouse button, and is moved automatically
40545 by a successful search. If new text arrives in the window when it is scrolled
40546 back, the caret remains where it is, but if the window is not scrolled back,
40547 the caret is moved to the end of the new text.
40548
40549 Pressing ^R or ^S pops up a window into which the search text can be typed.
40550 There are buttons for selecting forward or reverse searching, for carrying out
40551 the search, and for cancelling. If the &"Search"& button is pressed, the search
40552 happens and the window remains so that further searches can be done. If the
40553 &"Return"& key is pressed, a single search is done and the window is closed. If
40554 ^C is typed the search is cancelled.
40555
40556 The searching facility is implemented using the facilities of the Athena text
40557 widget. By default this pops up a window containing both &"search"& and
40558 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40559 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40560 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40561 provided version of &%TextPop%& when the remaining parts of the text widget
40562 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40563 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40564 on these systems, at the expense of having unwanted items in the search popup
40565 window.
40566
40567
40568
40569 .section "The queue display" "SECID268"
40570 .cindex "queue" "display in monitor"
40571 The bottom section of the monitor window contains a list of all messages that
40572 are in the queue, which includes those currently being received or delivered,
40573 as well as those awaiting delivery. The size of this subwindow is controlled by
40574 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40575 at which it is updated is controlled by another parameter in the same file &--
40576 the default is 5 minutes, since queue scans can be quite expensive. However,
40577 there is an &"Update"& action button just above the display which can be used
40578 to force an update of the queue display at any time.
40579
40580 When a host is down for some time, a lot of pending mail can build up for it,
40581 and this can make it hard to deal with other messages in the queue. To help
40582 with this situation there is a button next to &"Update"& called &"Hide"&. If
40583 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40584 type anything in here and press &"Return"&, the text is added to a chain of
40585 such texts, and if every undelivered address in a message matches at least one
40586 of the texts, the message is not displayed.
40587
40588 If there is an address that does not match any of the texts, all the addresses
40589 are displayed as normal. The matching happens on the ends of addresses so, for
40590 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40591 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40592 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40593 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40594 a hide request is automatically cancelled after one hour.
40595
40596 While the dialogue box is displayed, you can't press any buttons or do anything
40597 else to the monitor window. For this reason, if you want to cut text from the
40598 queue display to use in the dialogue box, you have to do the cutting before
40599 pressing the &"Hide"& button.
40600
40601 The queue display contains, for each unhidden queued message, the length of
40602 time it has been in the queue, the size of the message, the message id, the
40603 message sender, and the first undelivered recipient, all on one line. If it is
40604 a bounce message, the sender is shown as &"<>"&. If there is more than one
40605 recipient to which the message has not yet been delivered, subsequent ones are
40606 listed on additional lines, up to a maximum configured number, following which
40607 an ellipsis is displayed. Recipients that have already received the message are
40608 not shown.
40609
40610 .cindex "frozen messages" "display"
40611 If a message is frozen, an asterisk is displayed at the left-hand side.
40612
40613 The queue display has a vertical scroll bar, and can also be scrolled by means
40614 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40615 The text searching facilities, as described above for the log window, are also
40616 available, but the caret is always moved to the end of the text when the queue
40617 display is updated.
40618
40619
40620
40621 .section "The queue menu" "SECID269"
40622 .cindex "queue" "menu in monitor"
40623 If the &%shift%& key is held down and the left button is clicked when the mouse
40624 pointer is over the text for any message, an action menu pops up, and the first
40625 line of the queue display for the message is highlighted. This does not affect
40626 any selected text.
40627
40628 If you want to use some other event for popping up the menu, you can set the
40629 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40630 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40631 value set in this parameter is a standard X event description. For example, to
40632 run eximon using &%ctrl%& rather than &%shift%& you could use
40633 .code
40634 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40635 .endd
40636 The title of the menu is the message id, and it contains entries which act as
40637 follows:
40638
40639 .ilist
40640 &'message log'&: The contents of the message log for the message are displayed
40641 in a new text window.
40642 .next
40643 &'headers'&: Information from the spool file that contains the envelope
40644 information and headers is displayed in a new text window. See chapter
40645 &<<CHAPspool>>& for a description of the format of spool files.
40646 .next
40647 &'body'&: The contents of the spool file containing the body of the message are
40648 displayed in a new text window. There is a default limit of 20,000 bytes to the
40649 amount of data displayed. This can be changed by setting the BODY_MAX
40650 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40651 .next
40652 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40653 delivery of the message. This causes an automatic thaw if the message is
40654 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40655 a new text window. The delivery is run in a separate process, to avoid holding
40656 up the monitor while the delivery proceeds.
40657 .next
40658 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40659 that the message be frozen.
40660 .next
40661 .cindex "thawing messages"
40662 .cindex "unfreezing messages"
40663 .cindex "frozen messages" "thawing"
40664 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40665 that the message be thawed.
40666 .next
40667 .cindex "delivery" "forcing failure"
40668 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40669 that Exim gives up trying to deliver the message. A bounce message is generated
40670 for any remaining undelivered addresses.
40671 .next
40672 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40673 that the message be deleted from the system without generating a bounce
40674 message.
40675 .next
40676 &'add recipient'&: A dialog box is displayed into which a recipient address can
40677 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40678 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40679 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40680 causes a call to Exim to be made using the &%-Mar%& option to request that an
40681 additional recipient be added to the message, unless the entry box is empty, in
40682 which case no action is taken.
40683 .next
40684 &'mark delivered'&: A dialog box is displayed into which a recipient address
40685 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40686 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40687 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40688 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40689 recipient address as already delivered, unless the entry box is empty, in which
40690 case no action is taken.
40691 .next
40692 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40693 mark all recipient addresses as already delivered.
40694 .next
40695 &'edit sender'&: A dialog box is displayed initialized with the current
40696 sender's address. Pressing RETURN causes a call to Exim to be made using the
40697 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40698 in which case no action is taken. If you want to set an empty sender (as in
40699 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40700 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40701 the address is qualified with that domain.
40702 .endlist
40703
40704 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40705 other cases when a call to Exim is made, if there is any output from Exim (in
40706 particular, if the command fails) a window containing the command and the
40707 output is displayed. Otherwise, the results of the action are normally apparent
40708 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40709 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40710 if no output is generated.
40711
40712 The queue display is automatically updated for actions such as freezing and
40713 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40714 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40715 force an update of the display after one of these actions.
40716
40717 In any text window that is displayed as result of a menu action, the normal
40718 cut-and-paste facility is available, and searching can be carried out using ^R
40719 and ^S, as described above for the log tail window.
40720 .ecindex IIDeximon
40721
40722
40723
40724
40725
40726 . ////////////////////////////////////////////////////////////////////////////
40727 . ////////////////////////////////////////////////////////////////////////////
40728
40729 .chapter "Security considerations" "CHAPsecurity"
40730 .scindex IIDsecurcon "security" "discussion of"
40731 This chapter discusses a number of issues concerned with security, some of
40732 which are also covered in other parts of this manual.
40733
40734 For reasons that this author does not understand, some people have promoted
40735 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40736 existence of this chapter in the documentation. However, the intent of the
40737 chapter is simply to describe the way Exim works in relation to certain
40738 security concerns, not to make any specific claims about the effectiveness of
40739 its security as compared with other MTAs.
40740
40741 What follows is a description of the way Exim is supposed to be. Best efforts
40742 have been made to try to ensure that the code agrees with the theory, but an
40743 absence of bugs can never be guaranteed. Any that are reported will get fixed
40744 as soon as possible.
40745
40746
40747 .section "Building a more &""hardened""& Exim" "SECID286"
40748 .cindex "security" "build-time features"
40749 There are a number of build-time options that can be set in &_Local/Makefile_&
40750 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40751 Exim administrator who does not have the root password, or by someone who has
40752 penetrated the Exim (but not the root) account. These options are as follows:
40753
40754 .ilist
40755 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40756 start of any filenames used with the &%-C%& option. When it is set, these
40757 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40758 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40759 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40760 default setting for &%ALT_CONFIG_PREFIX%&.
40761
40762 If the permitted configuration files are confined to a directory to
40763 which only root has access, this guards against someone who has broken
40764 into the Exim account from running a privileged Exim with an arbitrary
40765 configuration file, and using it to break into other accounts.
40766 .next
40767
40768 If a non-trusted configuration file (i.e. not the default configuration file
40769 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40770 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40771 the next item), then root privilege is retained only if the caller of Exim is
40772 root. This locks out the possibility of testing a configuration using &%-C%&
40773 right through message reception and delivery, even if the caller is root. The
40774 reception works, but by that time, Exim is running as the Exim user, so when
40775 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40776 privilege to be lost. However, root can test reception and delivery using two
40777 separate commands.
40778
40779 .next
40780 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40781 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40782 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40783 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40784 the restrictive side.  Requiring build-time selection of safe macros is onerous
40785 but this option is intended solely as a transition mechanism to permit
40786 previously-working configurations to continue to work after release 4.73.
40787 .next
40788 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40789 is disabled.
40790 .next
40791 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40792 never to be used for any deliveries. This is like the &%never_users%& runtime
40793 option, but it cannot be overridden; the runtime option adds additional users
40794 to the list. The default setting is &"root"&; this prevents a non-root user who
40795 is permitted to modify the runtime file from using Exim as a way to get root.
40796 .endlist
40797
40798
40799
40800 .section "Root privilege" "SECID270"
40801 .cindex "setuid"
40802 .cindex "root privilege"
40803 The Exim binary is normally setuid to root, which means that it gains root
40804 privilege (runs as root) when it starts execution. In some special cases (for
40805 example, when the daemon is not in use and there are no local deliveries), it
40806 may be possible to run Exim setuid to some user other than root. This is
40807 discussed in the next section. However, in most installations, root privilege
40808 is required for two things:
40809
40810 .ilist
40811 To set up a socket connected to the standard SMTP port (25) when initialising
40812 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40813 not required.
40814 .next
40815 To be able to change uid and gid in order to read users' &_.forward_& files and
40816 perform local deliveries as the receiving user or as specified in the
40817 configuration.
40818 .endlist
40819
40820 It is not necessary to be root to do any of the other things Exim does, such as
40821 receiving messages and delivering them externally over SMTP, and it is
40822 obviously more secure if Exim does not run as root except when necessary.
40823 For this reason, a user and group for Exim to use must be defined in
40824 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40825 group"&. Their values can be changed by the runtime configuration, though this
40826 is not recommended. Often a user called &'exim'& is used, but some sites use
40827 &'mail'& or another user name altogether.
40828
40829 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40830 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40831 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40832
40833 After a new Exim process has interpreted its command line options, it changes
40834 uid and gid in the following cases:
40835
40836 .ilist
40837 .oindex "&%-C%&"
40838 .oindex "&%-D%&"
40839 If the &%-C%& option is used to specify an alternate configuration file, or if
40840 the &%-D%& option is used to define macro values for the configuration, and the
40841 calling process is not running as root, the uid and gid are changed to those of
40842 the calling process.
40843 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40844 option may not be used at all.
40845 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40846 can be supplied if the calling process is running as root, the Exim run-time
40847 user or CONFIGURE_OWNER, if defined.
40848 .next
40849 .oindex "&%-be%&"
40850 .oindex "&%-bf%&"
40851 .oindex "&%-bF%&"
40852 If the expansion test option (&%-be%&) or one of the filter testing options
40853 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40854 calling process.
40855 .next
40856 If the process is not a daemon process or a queue runner process or a delivery
40857 process or a process for testing address routing (started with &%-bt%&), the
40858 uid and gid are changed to the Exim user and group. This means that Exim always
40859 runs under its own uid and gid when receiving messages. This also applies when
40860 testing address verification
40861 .oindex "&%-bv%&"
40862 .oindex "&%-bh%&"
40863 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40864 option).
40865 .next
40866 For a daemon, queue runner, delivery, or address testing process, the uid
40867 remains as root at this stage, but the gid is changed to the Exim group.
40868 .endlist
40869
40870 The processes that initially retain root privilege behave as follows:
40871
40872 .ilist
40873 A daemon process changes the gid to the Exim group and the uid to the Exim
40874 user after setting up one or more listening sockets. The &[initgroups()]&
40875 function is called, so that if the Exim user is in any additional groups, they
40876 will be used during message reception.
40877 .next
40878 A queue runner process retains root privilege throughout its execution. Its
40879 job is to fork a controlled sequence of delivery processes.
40880 .next
40881 A delivery process retains root privilege throughout most of its execution,
40882 but any actual deliveries (that is, the transports themselves) are run in
40883 subprocesses which always change to a non-root uid and gid. For local
40884 deliveries this is typically the uid and gid of the owner of the mailbox; for
40885 remote deliveries, the Exim uid and gid are used. Once all the delivery
40886 subprocesses have been run, a delivery process changes to the Exim uid and gid
40887 while doing post-delivery tidying up such as updating the retry database and
40888 generating bounce and warning messages.
40889
40890 While the recipient addresses in a message are being routed, the delivery
40891 process runs as root. However, if a user's filter file has to be processed,
40892 this is done in a subprocess that runs under the individual user's uid and
40893 gid. A system filter is run as root unless &%system_filter_user%& is set.
40894 .next
40895 A process that is testing addresses (the &%-bt%& option) runs as root so that
40896 the routing is done in the same environment as a message delivery.
40897 .endlist
40898
40899
40900
40901
40902 .section "Running Exim without privilege" "SECTrunexiwitpri"
40903 .cindex "privilege, running without"
40904 .cindex "unprivileged running"
40905 .cindex "root privilege" "running without"
40906 Some installations like to run Exim in an unprivileged state for more of its
40907 operation, for added security. Support for this mode of operation is provided
40908 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40909 gid are changed to the Exim user and group at the start of a delivery process
40910 (and also queue runner and address testing processes). This means that address
40911 routing is no longer run as root, and the deliveries themselves cannot change
40912 to any other uid.
40913
40914 .cindex SIGHUP
40915 .cindex "daemon" "restarting"
40916 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40917 that the daemon can still be started in the usual way, and it can respond
40918 correctly to SIGHUP because the re-invocation regains root privilege.
40919
40920 An alternative approach is to make Exim setuid to the Exim user and also setgid
40921 to the Exim group. If you do this, the daemon must be started from a root
40922 process. (Calling Exim from a root process makes it behave in the way it does
40923 when it is setuid root.) However, the daemon cannot restart itself after a
40924 SIGHUP signal because it cannot regain privilege.
40925
40926 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40927 stops Exim from trying to re-invoke itself to do a delivery after a message has
40928 been received. Such a re-invocation is a waste of resources because it has no
40929 effect.
40930
40931 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40932 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40933 to the Exim user seems a clean approach, but there is one complication:
40934
40935 In this style of operation, Exim is running with the real uid and gid set to
40936 those of the calling process, and the effective uid/gid set to Exim's values.
40937 Ideally, any association with the calling process' uid/gid should be dropped,
40938 that is, the real uid/gid should be reset to the effective values so as to
40939 discard any privileges that the caller may have. While some operating systems
40940 have a function that permits this action for a non-root effective uid, quite a
40941 number of them do not. Because of this lack of standardization, Exim does not
40942 address this problem at this time.
40943
40944 For this reason, the recommended approach for &"mostly unprivileged"& running
40945 is to keep the Exim binary setuid to root, and to set
40946 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40947 be used in the most straightforward way.
40948
40949 If you configure Exim not to run delivery processes as root, there are a
40950 number of restrictions on what you can do:
40951
40952 .ilist
40953 You can deliver only as the Exim user/group. You should  explicitly use the
40954 &%user%& and &%group%& options to override routers or local transports that
40955 normally deliver as the recipient. This makes sure that configurations that
40956 work in this mode function the same way in normal mode. Any implicit or
40957 explicit specification of another user causes an error.
40958 .next
40959 Use of &_.forward_& files is severely restricted, such that it is usually
40960 not worthwhile to include them in the configuration.
40961 .next
40962 Users who wish to use &_.forward_& would have to make their home directory and
40963 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40964 and their equivalents in Exim filters, cannot be used. While they could be
40965 enabled in the Exim user's name, that would be insecure and not very useful.
40966 .next
40967 Unless the local user mailboxes are all owned by the Exim user (possible in
40968 some POP3 or IMAP-only environments):
40969
40970 .olist
40971 They must be owned by the Exim group and be writeable by that group. This
40972 implies you must set &%mode%& in the appendfile configuration, as well as the
40973 mode of the mailbox files themselves.
40974 .next
40975 You must set &%no_check_owner%&, since most or all of the files will not be
40976 owned by the Exim user.
40977 .next
40978 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40979 on a newly created mailbox when unprivileged. This also implies that new
40980 mailboxes need to be created manually.
40981 .endlist olist
40982 .endlist ilist
40983
40984
40985 These restrictions severely restrict what can be done in local deliveries.
40986 However, there are no restrictions on remote deliveries. If you are running a
40987 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40988 gives more security at essentially no cost.
40989
40990 If you are using the &%mua_wrapper%& facility (see chapter
40991 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40992
40993
40994
40995
40996 .section "Delivering to local files" "SECID271"
40997 Full details of the checks applied by &(appendfile)& before it writes to a file
40998 are given in chapter &<<CHAPappendfile>>&.
40999
41000
41001
41002 .section "Running local commands" "SECTsecconslocalcmds"
41003 .cindex "security" "local commands"
41004 .cindex "security" "command injection attacks"
41005 There are a number of ways in which an administrator can configure Exim to run
41006 commands based upon received, untrustworthy, data. Further, in some
41007 configurations a user who can control a &_.forward_& file can also arrange to
41008 run commands. Configuration to check includes, but is not limited to:
41009
41010 .ilist
41011 Use of &%use_shell%& in the pipe transport: various forms of shell command
41012 injection may be possible with this option present. It is dangerous and should
41013 be used only with considerable caution. Consider constraints which whitelist
41014 allowed characters in a variable which is to be used in a pipe transport that
41015 has &%use_shell%& enabled.
41016 .next
41017 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
41018 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
41019 &_.forward_& files in a redirect router. If Exim is running on a central mail
41020 hub to which ordinary users do not have shell access, but home directories are
41021 NFS mounted (for instance) then administrators should review the list of these
41022 forbid options available, and should bear in mind that the options that may
41023 need forbidding can change as new features are added between releases.
41024 .next
41025 The &%${run...}%& expansion item does not use a shell by default, but
41026 administrators can configure use of &_/bin/sh_& as part of the command.
41027 Such invocations should be viewed with prejudicial suspicion.
41028 .next
41029 Administrators who use embedded Perl are advised to explore how Perl's
41030 taint checking might apply to their usage.
41031 .next
41032 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
41033 administrators are well advised to view its use with suspicion, in case (for
41034 instance) it allows a local-part to contain embedded Exim directives.
41035 .next
41036 Use of &%${match_local_part...}%& and friends becomes more dangerous if
41037 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
41038 each can reference arbitrary lists and files, rather than just being a list
41039 of opaque strings.
41040 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
41041 real-world security vulnerabilities caused by its use with untrustworthy data
41042 injected in, for SQL injection attacks.
41043 Consider the use of the &%inlisti%& expansion condition instead.
41044 .endlist
41045
41046
41047
41048
41049 .section "Trust in configuration data" "SECTsecconfdata"
41050 .cindex "security" "data sources"
41051 .cindex "security" "regular expressions"
41052 .cindex "regular expressions" "security"
41053 .cindex "PCRE2" "security"
41054 If configuration data for Exim can come from untrustworthy sources, there
41055 are some issues to be aware of:
41056
41057 .ilist
41058 Use of &%${expand...}%& may provide a path for shell injection attacks.
41059 .next
41060 Letting untrusted data provide a regular expression is unwise.
41061 .next
41062 Using &%${match...}%& to apply a fixed regular expression against untrusted
41063 data may result in pathological behaviour within PCRE2.  Be aware of what
41064 "backtracking" means and consider options for being more strict with a regular
41065 expression. Avenues to explore include limiting what can match (avoiding &`.`&
41066 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
41067 possessive quantifiers or just not using regular expressions against untrusted
41068 data.
41069 .next
41070 It can be important to correctly use &%${quote:...}%&,
41071 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
41072 items to ensure that data is correctly constructed.
41073 .next
41074 Some lookups might return multiple results, even though normal usage is only
41075 expected to yield one result.
41076 .endlist
41077
41078
41079
41080
41081 .section "IPv4 source routing" "SECID272"
41082 .cindex "source routing" "in IP packets"
41083 .cindex "IP source routing"
41084 Many operating systems suppress IP source-routed packets in the kernel, but
41085 some cannot be made to do this, so Exim does its own check. It logs incoming
41086 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41087 IPv6. No special checking is currently done.
41088
41089
41090
41091 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41092 Support for these SMTP commands is disabled by default. If required, they can
41093 be enabled by defining suitable ACLs.
41094
41095
41096
41097
41098 .section "Privileged users" "SECID274"
41099 .cindex "trusted users"
41100 .cindex "admin user"
41101 .cindex "privileged user"
41102 .cindex "user" "trusted"
41103 .cindex "user" "admin"
41104 Exim recognizes two sets of users with special privileges. Trusted users are
41105 able to submit new messages to Exim locally, but supply their own sender
41106 addresses and information about a sending host. For other users submitting
41107 local messages, Exim sets up the sender address from the uid, and doesn't
41108 permit a remote host to be specified.
41109
41110 .oindex "&%-f%&"
41111 However, an untrusted user is permitted to use the &%-f%& command line option
41112 in the special form &%-f <>%& to indicate that a delivery failure for the
41113 message should not cause an error report. This affects the message's envelope,
41114 but it does not affect the &'Sender:'& header. Untrusted users may also be
41115 permitted to use specific forms of address with the &%-f%& option by setting
41116 the &%untrusted_set_sender%& option.
41117
41118 Trusted users are used to run processes that receive mail messages from some
41119 other mail domain and pass them on to Exim for delivery either locally, or over
41120 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41121 as any user listed in the &%trusted_users%& configuration option, or under any
41122 group listed in the &%trusted_groups%& option.
41123
41124 Admin users are permitted to do things to the messages on Exim's queue. They
41125 can freeze or thaw messages, cause them to be returned to their senders, remove
41126 them entirely, or modify them in various ways. In addition, admin users can run
41127 the Exim monitor and see all the information it is capable of providing, which
41128 includes the contents of files on the spool.
41129
41130 .oindex "&%-M%&"
41131 .oindex "&%-q%&"
41132 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41133 delivery of messages on its queue is restricted to admin users. This
41134 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41135 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41136 queue is also restricted to admin users. This restriction can be relaxed by
41137 setting &%no_queue_list_requires_admin%&.
41138
41139 Exim recognizes an admin user if the calling process is running as root or as
41140 the Exim user or if any of the groups associated with the calling process is
41141 the Exim group. It is not necessary actually to be running under the Exim
41142 group. However, if admin users who are not root or the Exim user are to access
41143 the contents of files on the spool via the Exim monitor (which runs
41144 unprivileged), Exim must be built to allow group read access to its spool
41145 files.
41146
41147 By default, regular users are trusted to perform basic testing and
41148 introspection commands, as themselves.  This setting can be tightened by
41149 setting the &%commandline_checks_require_admin%& option.
41150 This affects most of the checking options,
41151 such as &%-be%& and anything else &%-b*%&.
41152
41153
41154 .section "Spool files" "SECID275"
41155 .cindex "spool directory" "files"
41156 Exim's spool directory and everything it contains is owned by the Exim user and
41157 set to the Exim group. The mode for spool files is defined in the
41158 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41159 any user who is a member of the Exim group can access these files.
41160
41161
41162
41163 .section "Use of argv[0]" "SECID276"
41164 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41165 of specific strings, Exim assumes certain options. For example, calling Exim
41166 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41167 to calling it with the option &%-bS%&. There are no security implications in
41168 this.
41169
41170
41171
41172 .section "Use of %f formatting" "SECID277"
41173 The only use made of &"%f"& by Exim is in formatting load average values. These
41174 are actually stored in integer variables as 1000 times the load average.
41175 Consequently, their range is limited and so therefore is the length of the
41176 converted output.
41177
41178
41179
41180 .section "Embedded Exim path" "SECID278"
41181 Exim uses its own path name, which is embedded in the code, only when it needs
41182 to re-exec in order to regain root privilege. Therefore, it is not root when it
41183 does so. If some bug allowed the path to get overwritten, it would lead to an
41184 arbitrary program's being run as exim, not as root.
41185
41186
41187
41188 .section "Dynamic module directory" "SECTdynmoddir"
41189 Any dynamically loadable modules must be installed into the directory
41190 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41191 loading it.
41192
41193
41194 .section "Use of sprintf()" "SECID279"
41195 .cindex "&[sprintf()]&"
41196 A large number of occurrences of &"sprintf"& in the code are actually calls to
41197 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41198 The intermediate formatting is done into a large fixed buffer by a function
41199 that runs through the format string itself, and checks the length of each
41200 conversion before performing it, thus preventing buffer overruns.
41201
41202 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41203 the output buffer is known to be sufficiently long to contain the converted
41204 string.
41205
41206
41207
41208 .section "Use of debug_printf() and log_write()" "SECID280"
41209 Arbitrary strings are passed to both these functions, but they do their
41210 formatting by calling the function &'string_vformat()'&, which runs through
41211 the format string itself, and checks the length of each conversion.
41212
41213
41214
41215 .section "Use of strcat() and strcpy()" "SECID281"
41216 These are used only in cases where the output buffer is known to be large
41217 enough to hold the result.
41218 .ecindex IIDsecurcon
41219
41220
41221
41222
41223 . ////////////////////////////////////////////////////////////////////////////
41224 . ////////////////////////////////////////////////////////////////////////////
41225
41226 .chapter "Format of spool files" "CHAPspool"
41227 .scindex IIDforspo1 "format" "spool files"
41228 .scindex IIDforspo2 "spool directory" "format of files"
41229 .scindex IIDforspo3 "spool files" "format of"
41230 .cindex "spool files" "editing"
41231 A message on Exim's queue consists of two files, whose names are the message id
41232 followed by -D and -H, respectively. The data portion of the message is kept in
41233 the -D file on its own. The message's envelope, status, and headers are all
41234 kept in the -H file, whose format is described in this chapter. Each of these
41235 two files contains the final component of its own name as its first line. This
41236 is insurance against disk crashes where the directory is lost but the files
41237 themselves are recoverable.
41238
41239 The file formats may be changed, or new formats added, at any release.
41240 Spool files are not intended as an interface to other programs
41241 and should not be used as such.
41242
41243 Some people are tempted into editing -D files in order to modify messages. You
41244 need to be extremely careful if you do this; it is not recommended and you are
41245 on your own if you do it. Here are some of the pitfalls:
41246
41247 .ilist
41248 You must ensure that Exim does not try to deliver the message while you are
41249 fiddling with it. The safest way is to take out a write lock on the -D file,
41250 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41251 place, the lock will be retained. If you write a new file and rename it, the
41252 lock will be lost at the instant of rename.
41253 .next
41254 .vindex "&$body_linecount$&"
41255 If you change the number of lines in the file, the value of
41256 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41257 cause incomplete transmission of messages or undeliverable messages.
41258 .next
41259 If the message is in MIME format, you must take care not to break it.
41260 .next
41261 If the message is cryptographically signed, any change will invalidate the
41262 signature.
41263 .endlist
41264 All in all, modifying -D files is fraught with danger.
41265
41266 Files whose names end with -J may also be seen in the &_input_& directory (or
41267 its subdirectories when &%split_spool_directory%& is set). These are journal
41268 files, used to record addresses to which the message has been delivered during
41269 the course of a delivery attempt. If there are still undelivered recipients at
41270 the end, the -H file is updated, and the -J file is deleted. If, however, there
41271 is some kind of crash (for example, a power outage) before this happens, the -J
41272 file remains in existence. When Exim next processes the message, it notices the
41273 -J file and uses it to update the -H file before starting the next delivery
41274 attempt.
41275
41276 Files whose names end with -K or .eml may also be seen in the spool.
41277 These are temporaries used for DKIM or malware processing, when that is used.
41278 They should be tidied up by normal operations; any old ones are probably
41279 relics of crashes and can be removed.
41280
41281 .section "Format of the -H file" "SECID282"
41282 .cindex "uid (user id)" "in spool file"
41283 .cindex "gid (group id)" "in spool file"
41284 The second line of the -H file contains the login name for the uid of the
41285 process that called Exim to read the message, followed by the numerical uid and
41286 gid. For a locally generated message, this is normally the user who sent the
41287 message. For a message received over TCP/IP via the daemon, it is
41288 normally the Exim user.
41289
41290 The third line of the file contains the address of the message's sender as
41291 transmitted in the envelope, contained in angle brackets. The sender address is
41292 empty for bounce messages. For incoming SMTP mail, the sender address is given
41293 in the MAIL command. For locally generated mail, the sender address is
41294 created by Exim from the login name of the current user and the configured
41295 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41296 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41297 &"<>"& or an address that matches &%untrusted_set_senders%&.
41298
41299 The fourth line contains two numbers. The first is the time that the message
41300 was received, in the conventional Unix form &-- the number of seconds since the
41301 start of the epoch. The second number is a count of the number of messages
41302 warning of delayed delivery that have been sent to the sender.
41303
41304 There follow a number of lines starting with a hyphen.
41305 These contain variables, can appear in any
41306 order, and are omitted when not relevant.
41307
41308 If there is a second hyphen after the first,
41309 the corresponding data is tainted.
41310 If there is a value in parentheses, the data is quoted for a lookup.
41311
41312 The following word specifies a variable,
41313 and the remainder of the item depends on the variable.
41314
41315 .vlist
41316 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41317 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41318 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41319 recognized, to provide backward compatibility. In the old format, a line of
41320 this form is present for every ACL variable that is not empty. The number
41321 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41322 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41323 the data string for the variable. The string itself starts at the beginning of
41324 the next line, and is followed by a newline character. It may contain internal
41325 newlines.
41326
41327 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41328 A line of this form is present for every ACL connection variable that is
41329 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41330 The length is the length of the data string for the variable. The string itself
41331 starts at the beginning of the next line, and is followed by a newline
41332 character. It may contain internal newlines.
41333
41334 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41335 A line of this form is present for every ACL message variable that is defined.
41336 Note that there is a space between &%-aclm%& and the rest of the name. The
41337 length is the length of the data string for the variable. The string itself
41338 starts at the beginning of the next line, and is followed by a newline
41339 character. It may contain internal newlines.
41340
41341 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41342 This is present if, when the message was received over SMTP, the value of
41343 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41344
41345 .vitem &%-allow_unqualified_recipient%&
41346 This is present if unqualified recipient addresses are permitted in header
41347 lines (to stop such addresses from being qualified if rewriting occurs at
41348 transport time). Local messages that were input using &%-bnq%& and remote
41349 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41350
41351 .vitem &%-allow_unqualified_sender%&
41352 This is present if unqualified sender addresses are permitted in header lines
41353 (to stop such addresses from being qualified if rewriting occurs at transport
41354 time). Local messages that were input using &%-bnq%& and remote messages from
41355 hosts that match &%sender_unqualified_hosts%& set this flag.
41356
41357 .vitem "&%-auth_id%&&~<&'text'&>"
41358 The id information for a message received on an authenticated SMTP connection
41359 &-- the value of the &$authenticated_id$& variable.
41360
41361 .vitem "&%-auth_sender%&&~<&'address'&>"
41362 The address of an authenticated sender &-- the value of the
41363 &$authenticated_sender$& variable.
41364
41365 .vitem "&%-body_linecount%&&~<&'number'&>"
41366 This records the number of lines in the body of the message, and is
41367 present unless &%-spool_file_wireformat%& is.
41368
41369 .vitem "&%-body_zerocount%&&~<&'number'&>"
41370 This records the number of binary zero bytes in the body of the message, and is
41371 present if the number is greater than zero.
41372
41373 .vitem &%-deliver_firsttime%&
41374 This is written when a new message is first added to the spool. When the spool
41375 file is updated after a deferral, it is omitted.
41376
41377 .vitem "&%-frozen%&&~<&'time'&>"
41378 .cindex "frozen messages" "spool data"
41379 The message is frozen, and the freezing happened at <&'time'&>.
41380
41381 .vitem "&%-helo_name%&&~<&'text'&>"
41382 This records the host name as specified by a remote host in a HELO or EHLO
41383 command.
41384
41385 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41386 This records the IP address of the host from which the message was received and
41387 the remote port number that was used. It is omitted for locally generated
41388 messages.
41389
41390 .vitem "&%-host_auth%&&~<&'text'&>"
41391 If the message was received on an authenticated SMTP connection, this records
41392 the name of the authenticator &-- the value of the
41393 &$sender_host_authenticated$& variable.
41394
41395 .vitem &%-host_lookup_failed%&
41396 This is present if an attempt to look up the sending host's name from its IP
41397 address failed. It corresponds to the &$host_lookup_failed$& variable.
41398
41399 .vitem "&%-host_name%&&~<&'text'&>"
41400 .cindex "reverse DNS lookup"
41401 .cindex "DNS" "reverse lookup"
41402 This records the name of the remote host from which the message was received,
41403 if the host name was looked up from the IP address when the message was being
41404 received. It is not present if no reverse lookup was done.
41405
41406 .vitem "&%-ident%&&~<&'text'&>"
41407 For locally submitted messages, this records the login of the originating user,
41408 unless it was a trusted user and the &%-oMt%& option was used to specify an
41409 ident value. For messages received over TCP/IP, this records the ident string
41410 supplied by the remote host, if any.
41411
41412 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41413 This records the IP address of the local interface and the port number through
41414 which a message was received from a remote host. It is omitted for locally
41415 generated messages.
41416
41417 .vitem &%-local%&
41418 The message is from a local sender.
41419
41420 .vitem &%-localerror%&
41421 The message is a locally-generated bounce message.
41422
41423 .vitem "&%-local_scan%&&~<&'string'&>"
41424 This records the data string that was returned by the &[local_scan()]& function
41425 when the message was received &-- the value of the &$local_scan_data$&
41426 variable. It is omitted if no data was returned.
41427
41428 .vitem &%-manual_thaw%&
41429 The message was frozen but has been thawed manually, that is, by an explicit
41430 Exim command rather than via the auto-thaw process.
41431
41432 .vitem &%-N%&
41433 A testing delivery process was started using the &%-N%& option to suppress any
41434 actual deliveries, but delivery was deferred. At any further delivery attempts,
41435 &%-N%& is assumed.
41436
41437 .vitem &%-received_protocol%&
41438 This records the value of the &$received_protocol$& variable, which contains
41439 the name of the protocol by which the message was received.
41440
41441 .vitem &%-sender_set_untrusted%&
41442 The envelope sender of this message was set by an untrusted local caller (used
41443 to ensure that the caller is displayed in queue listings).
41444
41445 .vitem "&%-spam_score_int%&&~<&'number'&>"
41446 If a message was scanned by SpamAssassin, this is present. It records the value
41447 of &$spam_score_int$&.
41448
41449 .vitem &%-spool_file_wireformat%&
41450 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41451 rather than Unix-format.
41452 The line-ending is CRLF rather than newline.
41453 There is still, however, no leading-dot-stuffing.
41454
41455 .vitem &%-tls_certificate_verified%&
41456 A TLS certificate was received from the client that sent this message, and the
41457 certificate was verified by the server.
41458
41459 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41460 When the message was received over an encrypted connection, this records the
41461 name of the cipher suite that was used.
41462
41463 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41464 When the message was received over an encrypted connection, and a certificate
41465 was received from the client, this records the Distinguished Name from that
41466 certificate.
41467 .endlist
41468
41469 Following the options there is a list of those addresses to which the message
41470 is not to be delivered. This set of addresses is initialized from the command
41471 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41472 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41473 the address is added to this set. The addresses are kept internally as a
41474 balanced binary tree, and it is a representation of that tree which is written
41475 to the spool file. If an address is expanded via an alias or forward file, the
41476 original address is added to the tree when deliveries to all its child
41477 addresses are complete.
41478
41479 If the tree is empty, there is a single line in the spool file containing just
41480 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41481 Y or N, followed by an address. The address is the value for the node of the
41482 tree, and the letters indicate whether the node has a left branch and/or a
41483 right branch attached to it, respectively. If branches exist, they immediately
41484 follow. Here is an example of a three-node tree:
41485 .code
41486 YY darcy@austen.fict.example
41487 NN alice@wonderland.fict.example
41488 NN editor@thesaurus.ref.example
41489 .endd
41490 After the non-recipients tree, there is a list of the message's recipients.
41491 This is a simple list, preceded by a count. It includes all the original
41492 recipients of the message, including those to whom the message has already been
41493 delivered. In the simplest case, the list contains one address per line. For
41494 example:
41495 .code
41496 4
41497 editor@thesaurus.ref.example
41498 darcy@austen.fict.example
41499 rdo@foundation
41500 alice@wonderland.fict.example
41501 .endd
41502 However, when a child address has been added to the top-level addresses as a
41503 result of the use of the &%one_time%& option on a &(redirect)& router, each
41504 line is of the following form:
41505 .display
41506 <&'top-level address'&> <&'errors_to address'&> &&&
41507   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41508 .endd
41509 The 01 flag bit indicates the presence of the three other fields that follow
41510 the top-level address. Other bits may be used in future to support additional
41511 fields. The <&'parent number'&> is the offset in the recipients list of the
41512 original parent of the &"one time"& address. The first two fields are the
41513 envelope sender that is associated with this address and its length. If the
41514 length is zero, there is no special envelope sender (there are then two space
41515 characters in the line). A non-empty field can arise from a &(redirect)& router
41516 that has an &%errors_to%& setting.
41517
41518
41519 A blank line separates the envelope and status information from the headers
41520 which follow. A header may occupy several lines of the file, and to save effort
41521 when reading it in, each header is preceded by a number and an identifying
41522 character. The number is the number of characters in the header, including any
41523 embedded newlines and the terminating newline. The character is one of the
41524 following:
41525
41526 .table2 50pt
41527 .row <&'blank'&>         "header in which Exim has no special interest"
41528 .row &`B`&               "&'Bcc:'& header"
41529 .row &`C`&               "&'Cc:'& header"
41530 .row &`F`&               "&'From:'& header"
41531 .row &`I`&               "&'Message-id:'& header"
41532 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41533 .row &`R`&               "&'Reply-To:'& header"
41534 .row &`S`&               "&'Sender:'& header"
41535 .row &`T`&               "&'To:'& header"
41536 .row &`*`&               "replaced or deleted header"
41537 .endtable
41538
41539 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41540 purposes. They are not transmitted when the message is delivered. Here is a
41541 typical set of headers:
41542 .code
41543 111P Received: by hobbit.fict.example with local (Exim 4.00)
41544 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41545 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41546 038* X-rewrote-sender: bb@hobbit.fict.example
41547 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41548 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41549 099* To: alice@wonderland.fict.example, rdo@foundation,
41550 darcy@austen.fict.example, editor@thesaurus.ref.example
41551 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41552 darcy@austen.fict.example, editor@thesaurus.ref.example
41553 038  Date: Fri, 11 May 2001 10:28:59 +0100
41554 .endd
41555 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41556 &'To:'& header have been rewritten, the last one because routing expanded the
41557 unqualified domain &'foundation'&.
41558 .ecindex IIDforspo1
41559 .ecindex IIDforspo2
41560 .ecindex IIDforspo3
41561
41562 .section "Format of the -D file" "SECID282a"
41563 The data file is traditionally in Unix-standard format: lines are ended with
41564 an ASCII newline character.
41565 However, when the &%spool_wireformat%& main option is used some -D files
41566 can have an alternate format.
41567 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41568 The -D file lines (not including the first name-component line) are
41569 suitable for direct copying to the wire when transmitting using the
41570 ESMTP CHUNKING option, meaning lower processing overhead.
41571 Lines are terminated with an ASCII CRLF pair.
41572 There is no dot-stuffing (and no dot-termination).
41573
41574 . ////////////////////////////////////////////////////////////////////////////
41575 . ////////////////////////////////////////////////////////////////////////////
41576
41577 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41578          "DKIM, SPF, SRS and DMARC Support"
41579
41580 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41581 .cindex "DKIM"
41582
41583 DKIM is a mechanism by which messages sent by some entity can be provably
41584 linked to a domain which that entity controls.  It permits reputation to
41585 be tracked on a per-domain basis, rather than merely upon source IP address.
41586 DKIM is documented in RFC 6376.
41587
41588 As DKIM relies on the message being unchanged in transit, messages handled
41589 by a mailing-list (which traditionally adds to the message) will not match
41590 any original DKIM signature.
41591
41592 DKIM support is compiled into Exim by default if TLS support is present.
41593 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41594
41595 Exim's DKIM implementation allows for
41596 .olist
41597 Signing outgoing messages: This function is implemented in the SMTP transport.
41598 It can co-exist with all other Exim features
41599 (including transport filters)
41600 except cutthrough delivery.
41601 .next
41602 Verifying signatures in incoming messages: This is implemented by an additional
41603 ACL (acl_smtp_dkim), which can be called several times per message, with
41604 different signature contexts.
41605 .endlist
41606
41607 In typical Exim style, the verification implementation does not include any
41608 default "policy". Instead it enables you to build your own policy using
41609 Exim's standard controls.
41610
41611 Please note that verification of DKIM signatures in incoming mail is turned
41612 on by default for logging (in the <= line) purposes.
41613
41614 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41615 When set, for each signature in incoming email,
41616 exim will log a line displaying the most important signature details, and the
41617 signature status. Here is an example (with line-breaks added for clarity):
41618 .code
41619 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41620     d=facebookmail.com s=q1-2009b
41621     c=relaxed/relaxed a=rsa-sha1
41622     i=@facebookmail.com t=1252484542 [verification succeeded]
41623 .endd
41624
41625 You might want to turn off DKIM verification processing entirely for internal
41626 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41627 control modifier. This should typically be done in the RCPT ACL, at points
41628 where you accept mail from relay sources (internal hosts or authenticated
41629 senders).
41630
41631
41632 .subsection "Signing outgoing messages" SECDKIMSIGN
41633 .cindex DKIM signing
41634
41635 For signing to be usable you must have published a DKIM record in DNS.
41636 Note that RFC 8301 (which does not cover EC keys) says:
41637 .code
41638 rsa-sha1 MUST NOT be used for signing or verifying.
41639
41640 Signers MUST use RSA keys of at least 1024 bits for all keys.
41641 Signers SHOULD use RSA keys of at least 2048 bits.
41642 .endd
41643
41644 Note also that the key content (the 'p=' field)
41645 in the DNS record is different between RSA and EC keys;
41646 for the former it is the base64 of the ASN.1 for the RSA public key
41647 (equivalent to the private-key .pem with the header/trailer stripped)
41648 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41649
41650 Signing is enabled by setting private options on the SMTP transport.
41651 These options take (expandable) strings as arguments.
41652
41653 .option dkim_domain smtp "string list&!!" unset
41654 The domain(s) you want to sign with.
41655 After expansion, this can be a list.
41656 Each element in turn,
41657 lowercased,
41658 .vindex "&$dkim_domain$&"
41659 is put into the &%$dkim_domain%& expansion variable
41660 while expanding the remaining signing options.
41661 If it is empty after expansion, DKIM signing is not done,
41662 and no error will result even if &%dkim_strict%& is set.
41663
41664 .option dkim_selector smtp "string list&!!" unset
41665 This sets the key selector string.
41666 After expansion, which can use &$dkim_domain$&, this can be a list.
41667 Each element in turn is put in the expansion
41668 .vindex "&$dkim_selector$&"
41669 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41670 option along with &%$dkim_domain%&.
41671 If the option is empty after expansion, DKIM signing is not done for this domain,
41672 and no error will result even if &%dkim_strict%& is set.
41673
41674 To do, for example, dual-signing with RSA and EC keys
41675 this could be be used:
41676 .code
41677 dkim_selector = ec_sel : rsa_sel
41678 dkim_private_key = KEYS_DIR/$dkim_selector
41679 .endd
41680
41681 .option dkim_private_key smtp string&!! unset
41682 This sets the private key to use.
41683 You can use the &%$dkim_domain%& and
41684 &%$dkim_selector%& expansion variables to determine the private key to use.
41685 The result can either
41686 .ilist
41687 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41688 .next
41689 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41690 be a valid Ed25519 private key (same format as above)
41691 .next
41692 start with a slash, in which case it is treated as a file that contains
41693 the private key
41694 .next
41695 be "0", "false" or the empty string, in which case the message will not
41696 be signed. This case will not result in an error, even if &%dkim_strict%&
41697 is set.
41698 .endlist
41699
41700 To generate keys under OpenSSL:
41701 .code
41702 openssl genrsa -out dkim_rsa.private 2048
41703 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41704 .endd
41705 The result file from the first command should be retained, and
41706 this option set to use it.
41707 Take the base-64 lines from the output of the second command, concatenated,
41708 for the DNS TXT record.
41709 See section 3.6 of RFC6376 for the record specification.
41710
41711 Under GnuTLS:
41712 .code
41713 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41714 certtool --load-privkey=dkim_rsa.private --pubkey-info
41715 .endd
41716
41717 Note that RFC 8301 says:
41718 .code
41719 Signers MUST use RSA keys of at least 1024 bits for all keys.
41720 Signers SHOULD use RSA keys of at least 2048 bits.
41721 .endd
41722
41723 EC keys for DKIM are defined by RFC 8463.
41724 They are considerably smaller than RSA keys for equivalent protection.
41725 As they are a recent development, users should consider dual-signing
41726 (by setting a list of selectors, and an expansion for this option)
41727 for some transition period.
41728 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41729 for EC keys.
41730
41731 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41732 .code
41733 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41734 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41735 .endd
41736
41737 To produce the required public key value for a DNS record:
41738 .code
41739 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41740 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41741 .endd
41742
41743 Exim also supports an alternate format
41744 of Ed25519 keys in DNS which was a candidate during development
41745 of the standard, but not adopted.
41746 A future release will probably drop that support.
41747
41748 .option dkim_hash smtp string&!! sha256
41749 Can be set to any one of the supported hash methods, which are:
41750 .ilist
41751 &`sha1`& &-- should not be used, is old and insecure
41752 .next
41753 &`sha256`& &-- the default
41754 .next
41755 &`sha512`& &-- possibly more secure but less well supported
41756 .endlist
41757
41758 Note that RFC 8301 says:
41759 .code
41760 rsa-sha1 MUST NOT be used for signing or verifying.
41761 .endd
41762
41763 .option dkim_identity smtp string&!! unset
41764 If set after expansion, the value is used to set an "i=" tag in
41765 the signing header.  The DKIM standards restrict the permissible
41766 syntax of this optional tag to a mail address, with possibly-empty
41767 local part, an @, and a domain identical to or subdomain of the "d="
41768 tag value.  Note that Exim does not check the value.
41769
41770 .option dkim_canon smtp string&!! unset
41771 This option sets the canonicalization method used when signing a message.
41772 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41773 The option defaults to "relaxed" when unset. Note: the current implementation
41774 only supports signing with the same canonicalization method for both headers and body.
41775
41776 .option dkim_strict smtp string&!! unset
41777 This  option  defines  how  Exim  behaves  when  signing a message that
41778 should be signed fails for some reason.  When the expansion evaluates to
41779 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41780 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41781 variables here.
41782
41783 .option dkim_sign_headers smtp string&!! "see below"
41784 If set, this option must expand to a colon-separated
41785 list of header names.
41786 Headers with these names, or the absence of such a header, will be included
41787 in the message signature.
41788 When unspecified, the header names listed in RFC4871 will be used,
41789 whether or not each header is present in the message.
41790 The default list is available for the expansion in the macro
41791 &"_DKIM_SIGN_HEADERS"&
41792 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41793
41794 If a name is repeated, multiple headers by that name (or the absence thereof)
41795 will be signed.  The textually later headers in the headers part of the
41796 message are signed first, if there are multiples.
41797
41798 A name can be prefixed with either an &"="& or a &"+"& character.
41799 If an &"="& prefix is used, all headers that are present with this name
41800 will be signed.
41801 If a &"+"& prefix if used, all headers that are present with this name
41802 will be signed, and one signature added for a missing header with the
41803 name will be appended.
41804
41805 .option dkim_timestamps smtp integer&!! unset
41806 This option controls the inclusion of timestamp information in the signature.
41807 If not set, no such information will be included.
41808 .new
41809 Otherwise, must be an unsigned number giving an offset in seconds from the
41810 current time for the expiry tag (e.g. 1209600 for two weeks); both creation
41811 (t=) and expiry (x=) tags will be included unless the offset is 0 (no expiry).
41812 .wen
41813
41814 RFC 6376 lists these tags as RECOMMENDED.
41815
41816
41817 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41818 .cindex DKIM verification
41819
41820 Verification of DKIM signatures in SMTP incoming email is done for all
41821 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41822
41823 .cindex DKIM "selecting signature algorithms"
41824 Individual classes of DKIM signature algorithm can be ignored by changing
41825 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41826 The &%dkim_verify_minimal%& option can be set to cease verification
41827 processing for a message once the first passing signature is found.
41828
41829 .cindex authentication "expansion item"
41830 Performing verification sets up information used by the
41831 &%authresults%& expansion item.
41832
41833 For most purposes the default option settings suffice and the remainder
41834 of this section can be ignored.
41835
41836 The results of verification are made available to the
41837 &%acl_smtp_dkim%& ACL, which (for complex needs) can examine and modify them.
41838 A missing ACL definition defaults to accept.
41839 By default, the ACL is called once for each
41840 syntactically(!) correct signature in the incoming message.
41841 If any ACL call does not accept, the message is not accepted.
41842 If a cutthrough delivery was in progress for the message, that is
41843 summarily dropped (having wasted the transmission effort).
41844
41845 To evaluate the verification result in the ACL
41846 a large number of expansion variables
41847 containing the signature status and its details are set up during the
41848 runtime of the ACL.
41849
41850 Calling the ACL only for existing signatures is not sufficient to build
41851 more advanced policies. For that reason, the main option
41852 &%dkim_verify_signers%&, and an expansion variable
41853 &%$dkim_signers%& exist.
41854
41855 The main option &%dkim_verify_signers%& can be set to a colon-separated
41856 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41857 called. It is expanded when the message has been received. At this point,
41858 the expansion variable &%$dkim_signers%& already contains a colon-separated
41859 list of signer domains and identities for the message. When
41860 &%dkim_verify_signers%& is not specified in the main configuration,
41861 it defaults as:
41862 .code
41863 dkim_verify_signers = $dkim_signers
41864 .endd
41865 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41866 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41867 call the ACL for known domains or identities. This would be achieved as follows:
41868 .code
41869 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41870 .endd
41871 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41872 and "ebay.com", plus all domains and identities that have signatures in the message.
41873 You can also be more creative in constructing your policy. For example:
41874 .code
41875 dkim_verify_signers = $sender_address_domain:$dkim_signers
41876 .endd
41877
41878 If a domain or identity is listed several times in the (expanded) value of
41879 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41880
41881 Note that if the option is set using untrustworthy data
41882 (such as the From: header)
41883 care should be taken to force lowercase for domains
41884 and for the domain part if identities.
41885 The default setting can be regarded as trustworthy in this respect.
41886
41887 If multiple signatures match a domain (or identity), the ACL is called once
41888 for each matching signature.
41889
41890
41891 Inside the DKIM ACL, the following expansion variables are
41892 available (from most to least important):
41893
41894
41895 .vlist
41896 .vitem &%$dkim_cur_signer%&
41897 The signer that is being evaluated in this ACL run. This can be a domain or
41898 an identity. This is one of the list items from the expanded main option
41899 &%dkim_verify_signers%& (see above).
41900
41901 .vitem &%$dkim_verify_status%&
41902 So long as a DKIM ACL is defined
41903 (it need do no more than accept, which is the default),
41904 after all the DKIM ACL runs have completed, the value becomes a
41905 colon-separated list of the values after each run.
41906 The value is maintained for the MIME, PRDR and DATA ACLs.
41907
41908 Within the DKIM ACL,
41909 a string describing the general status of the signature. One of
41910 .ilist
41911 &%none%&: There is no signature in the message for the current domain or
41912 identity (as reflected by &%$dkim_cur_signer%&).
41913 .next
41914 &%invalid%&: The signature could not be verified due to a processing error.
41915 More detail is available in &%$dkim_verify_reason%&.
41916 .next
41917 &%fail%&: Verification of the signature failed.  More detail is
41918 available in &%$dkim_verify_reason%&.
41919 .next
41920 &%pass%&: The signature passed verification. It is valid.
41921 .endlist
41922
41923 This variable can be overwritten using an ACL 'set' modifier.
41924 This might, for instance, be done to enforce a policy restriction on
41925 hash-method or key-size:
41926 .code
41927   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41928        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41929        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41930                                   {< {$dkim_key_length}{1024}}}}
41931        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41932        set dkim_verify_status = fail
41933        set dkim_verify_reason = hash too weak or key too short
41934 .endd
41935
41936 .vitem &%$dkim_verify_reason%&
41937 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41938 "fail" or "invalid". One of
41939 .ilist
41940 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41941 key for the domain could not be retrieved. This may be a temporary problem.
41942 .next
41943 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41944 record for the domain is syntactically invalid.
41945 .next
41946 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41947 body hash does not match the one specified in the signature header. This
41948 means that the message body was modified in transit.
41949 .next
41950 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41951 could not be verified. This may mean that headers were modified,
41952 re-written or otherwise changed in a way which is incompatible with
41953 DKIM verification. It may of course also mean that the signature is forged.
41954 .endlist
41955
41956 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41957
41958 .vitem &%$dkim_domain%&
41959 The signing domain. IMPORTANT: This variable is only populated if there is
41960 an actual signature in the message for the current domain or identity (as
41961 reflected by &%$dkim_cur_signer%&).
41962
41963 .vitem &%$dkim_identity%&
41964 The signing identity, if present. IMPORTANT: This variable is only populated
41965 if there is an actual signature in the message for the current domain or
41966 identity (as reflected by &%$dkim_cur_signer%&).
41967
41968 .vitem &%$dkim_selector%&
41969 The key record selector string.
41970
41971 .vitem &%$dkim_algo%&
41972 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41973 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41974 may also be 'ed25519-sha256'.
41975 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41976 for EC keys.
41977
41978 Note that RFC 8301 says:
41979 .code
41980 rsa-sha1 MUST NOT be used for signing or verifying.
41981
41982 DKIM signatures identified as having been signed with historic
41983 algorithms (currently, rsa-sha1) have permanently failed evaluation
41984 .endd
41985
41986 To enforce this you must either have a DKIM ACL which checks this variable
41987 and overwrites the &$dkim_verify_status$& variable as discussed above,
41988 or have set the main option &%dkim_verify_hashes%& to exclude
41989 processing of such signatures.
41990
41991 .vitem &%$dkim_canon_body%&
41992 The body canonicalization method. One of 'relaxed' or 'simple'.
41993
41994 .vitem &%$dkim_canon_headers%&
41995 The header canonicalization method. One of 'relaxed' or 'simple'.
41996
41997 .vitem &%$dkim_copiedheaders%&
41998 A transcript of headers and their values which are included in the signature
41999 (copied from the 'z=' tag of the signature).
42000 Note that RFC6376 requires that verification fail if the From: header is
42001 not included in the signature.  Exim does not enforce this; sites wishing
42002 strict enforcement should code the check explicitly.
42003
42004 .vitem &%$dkim_bodylength%&
42005 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
42006 limit was set by the signer, "9999999999999" is returned. This makes sure
42007 that this variable always expands to an integer value.
42008 &*Note:*& The presence of the signature tag specifying a signing body length
42009 is one possible route to spoofing of valid DKIM signatures.
42010 A paranoid implementation might wish to regard signature where this variable
42011 shows less than the "no limit" return as being invalid.
42012
42013 .vitem &%$dkim_created%&
42014 UNIX timestamp reflecting the date and time when the signature was created.
42015 When this was not specified by the signer, "0" is returned.
42016
42017 .vitem &%$dkim_expires%&
42018 UNIX timestamp reflecting the date and time when the signer wants the
42019 signature to be treated as "expired". When this was not specified by the
42020 signer, "9999999999999" is returned. This makes it possible to do useful
42021 integer size comparisons against this value.
42022 Note that Exim does not check this value.
42023
42024 .vitem &%$dkim_headernames%&
42025 A colon-separated list of names of headers included in the signature.
42026
42027 .vitem &%$dkim_key_testing%&
42028 "1" if the key record has the "testing" flag set, "0" if not.
42029
42030 .vitem &%$dkim_key_nosubdomains%&
42031 "1" if the key record forbids subdomaining, "0" otherwise.
42032
42033 .vitem &%$dkim_key_srvtype%&
42034 Service type (tag s=) from the key record. Defaults to "*" if not specified
42035 in the key record.
42036
42037 .vitem &%$dkim_key_granularity%&
42038 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
42039 in the key record.
42040
42041 .vitem &%$dkim_key_notes%&
42042 Notes from the key record (tag n=).
42043
42044 .vitem &%$dkim_key_length%&
42045 Number of bits in the key.
42046 Valid only once the key is loaded, which is at the time the header signature
42047 is verified, which is after the body hash is.
42048
42049 Note that RFC 8301 says:
42050 .code
42051 Verifiers MUST NOT consider signatures using RSA keys of
42052 less than 1024 bits as valid signatures.
42053 .endd
42054
42055 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
42056 option.
42057
42058 .endlist
42059
42060 In addition, two ACL conditions are provided:
42061
42062 .vlist
42063 .vitem &%dkim_signers%&
42064 ACL condition that checks a colon-separated list of domains or identities
42065 for a match against the domain or identity that the ACL is currently verifying
42066 (reflected by &%$dkim_cur_signer%&).
42067 This condition is only usable in a DKIM ACL.
42068 This is typically used to restrict an ACL
42069 verb to a group of domains or identities. For example:
42070
42071 .code
42072 # Warn when Mail purportedly from GMail has no gmail signature
42073 warn sender_domains = gmail.com
42074      dkim_signers = gmail.com
42075      dkim_status = none
42076      log_message = GMail sender without gmail.com DKIM signature
42077 .endd
42078
42079 Note that the above does not check for a total lack of DKIM signing;
42080 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
42081
42082 .vitem &%dkim_status%&
42083 ACL condition that checks a colon-separated list of possible DKIM verification
42084 results against the actual result of verification,
42085 given by &$dkim_verify_status$& if that is non-empty or "none" if empty.
42086 .new
42087 This condition may be used in DKIM, MIME, PRDR and DATA ACLs.
42088 .wen
42089
42090 A basic verification might be:
42091 .code
42092 deny !dkim_status = pass:none:invalid
42093 .endd
42094
42095 A more complex use could be
42096 to restrict an ACL verb to a list of verification outcomes, for example:
42097
42098 .code
42099 deny sender_domains = paypal.com:paypal.de
42100      dkim_signers = paypal.com:paypal.de
42101      dkim_status = none:invalid:fail
42102      message = Mail from Paypal with invalid/missing signature
42103 .endd
42104
42105 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42106 see the documentation of the &%$dkim_verify_status%& expansion variable above
42107 for more information of what they mean.
42108
42109 The condition is true if the status
42110 .new
42111 (or any of the list of status values)
42112 .wen
42113 is any one of the supplied list.
42114 .endlist
42115
42116
42117
42118
42119 .section "SPF (Sender Policy Framework)" SECSPF
42120 .cindex SPF verification
42121
42122 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42123 messages with its domain in the envelope from, documented by RFC 7208.
42124 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42125 the &url(http://openspf.org).
42126 . --- 2019-10-28: still not https, open-spf.org is told to be a
42127 . --- web-archive copy of the now dead openspf.org site
42128 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42129 . --- discussion.
42130
42131 Messages sent by a system not authorised will fail checking of such assertions.
42132 This includes retransmissions done by traditional forwarders.
42133
42134 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42135 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42136 &url(https://www.libspf2.org/).
42137 There is no Exim involvement in the transmission of messages;
42138 publishing certain DNS records is all that is required.
42139
42140 For verification, an ACL condition and an expansion lookup are provided.
42141 .cindex authentication "expansion item"
42142 Performing verification sets up information used by the
42143 &%authresults%& expansion item.
42144
42145
42146 .cindex SPF "ACL condition"
42147 .cindex ACL "spf condition"
42148 The ACL condition "spf" can be used at or after the MAIL ACL.
42149 It takes as an argument a list of strings giving the outcome of the SPF check,
42150 and will succeed for any matching outcome.
42151 Valid strings are:
42152 .vlist
42153 .vitem &%pass%&
42154 The SPF check passed, the sending host is positively verified by SPF.
42155
42156 .vitem &%fail%&
42157 The SPF check failed, the sending host is NOT allowed to send mail for the
42158 domain in the envelope-from address.
42159
42160 .vitem &%softfail%&
42161 The SPF check failed, but the queried domain can't absolutely confirm that this
42162 is a forgery.
42163
42164 .vitem &%none%&
42165 The queried domain does not publish SPF records.
42166
42167 .vitem &%neutral%&
42168 The SPF check returned a "neutral" state.  This means the queried domain has
42169 published a SPF record, but wants to allow outside servers to send mail under
42170 its domain as well.  This should be treated like "none".
42171
42172 .vitem &%permerror%&
42173 This indicates a syntax error in the SPF record of the queried domain.
42174 You may deny messages when this occurs.
42175
42176 .vitem &%temperror%&
42177 This indicates a temporary error during all processing, including Exim's
42178 SPF processing.  You may defer messages when this occurs.
42179
42180 .vitem &%invalid%&
42181 There was an error during processing of the SPF lookup
42182 .endlist
42183
42184 You can prefix each string with an exclamation mark to  invert
42185 its meaning,  for example  "!fail" will  match all  results but
42186 "fail".  The  string  list is  evaluated  left-to-right,  in a
42187 short-circuit fashion.
42188
42189 Example:
42190 .code
42191 deny spf = fail
42192      message = $sender_host_address is not allowed to send mail from \
42193                ${if def:sender_address_domain \
42194                     {$sender_address_domain}{$sender_helo_name}}.  \
42195                Please see http://www.open-spf.org/Why;\
42196                identity=${if def:sender_address_domain \
42197                              {$sender_address}{$sender_helo_name}};\
42198                ip=$sender_host_address
42199 .endd
42200
42201 Note: The above mentioned URL may not be as helpful as expected. You are
42202 encouraged to replace the link with a link to a site with more
42203 explanations.
42204
42205 When the spf condition has run, it sets up several expansion
42206 variables:
42207
42208 .cindex SPF "verification variables"
42209 .vlist
42210 .vitem &$spf_header_comment$&
42211 .vindex &$spf_header_comment$&
42212   This contains a human-readable string describing the outcome
42213   of the SPF check. You can add it to a custom header or use
42214   it for logging purposes.
42215
42216 .vitem &$spf_received$&
42217 .vindex &$spf_received$&
42218   This contains a complete Received-SPF: header (name and
42219   content) that can be added to the message. Please note that
42220   according to the SPF draft, this header must be added at the
42221   top of the header list, i.e. with
42222 .code
42223 add_header = :at_start:$spf_received
42224 .endd
42225   See section &<<SECTaddheadacl>>& for further details.
42226
42227   Note: in case of "Best-guess" (see below), the convention is
42228   to put this string in a header called X-SPF-Guess: instead.
42229
42230 .vitem &$spf_result$&
42231 .vindex &$spf_result$&
42232   This contains the outcome of the SPF check in string form,
42233   currently one of pass, fail, softfail, none, neutral, permerror,
42234   temperror, or &"(invalid)"&.
42235
42236 .vitem &$spf_result_guessed$&
42237 .vindex &$spf_result_guessed$&
42238   This boolean is true only if a best-guess operation was used
42239   and required in order to obtain a result.
42240
42241 .vitem &$spf_smtp_comment$&
42242 .vindex &$spf_smtp_comment$&
42243 .vindex &%spf_smtp_comment_template%&
42244   This contains a string that can be used in a SMTP response
42245   to the calling party. Useful for "fail".
42246   The string is generated by the SPF library from the template configured in the main config
42247   option &%spf_smtp_comment_template%&.
42248 .endlist
42249
42250
42251 .cindex SPF "ACL condition"
42252 .cindex ACL "spf_guess condition"
42253 .cindex SPF "best guess"
42254 In addition to SPF, you can also perform checks for so-called
42255 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42256 SPF, but it is supported by the same framework that enables SPF
42257 capability.
42258 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42259 for a description of what it means.
42260 . --- 2019-10-28: still not https:
42261
42262 To access this feature, simply use the spf_guess condition in place
42263 of the spf one.  For example:
42264
42265 .code
42266 deny spf_guess = fail
42267      message = $sender_host_address doesn't look trustworthy to me
42268 .endd
42269
42270 In case you decide to reject messages based on this check, you
42271 should note that although it uses the same framework, "Best-guess"
42272 is not SPF, and therefore you should not mention SPF at all in your
42273 reject message.
42274
42275 When the spf_guess condition has run, it sets up the same expansion
42276 variables as when spf condition is run, described above.
42277
42278 Additionally, since Best-guess is not standardized, you may redefine
42279 what "Best-guess" means to you by redefining the main configuration
42280 &%spf_guess%& option.
42281 For example, the following:
42282
42283 .code
42284 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42285 .endd
42286
42287 would relax host matching rules to a broader network range.
42288
42289
42290 .cindex SPF "lookup expansion"
42291 .cindex lookup spf
42292 A lookup expansion is also available. It takes an email
42293 address as the key and an IP address
42294 (v4 or v6)
42295 as the database:
42296
42297 .code
42298   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42299 .endd
42300
42301 The lookup will return the same result strings as can appear in
42302 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42303
42304
42305
42306
42307
42308 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42309 .cindex SRS "sender rewriting scheme"
42310 .cindex VERP "variable envelope return path"
42311
42312 SRS can be used to modify sender addresses when forwarding so that
42313 SPF verification does not object to them.
42314 It can also be used to identify a received bounce message as
42315 likely (or not) having been trigged by a message from the
42316 local system, and for identifying dead addresses in mailing lists.
42317 It is one implementation of a VERP (Variable Envelope Return Path) method.
42318
42319 SRS operates by encoding the original envelope sender in a new
42320 sender local part and using a domain run by the forwarding site
42321 as the new domain for the sender.  Any DSN message should be returned
42322 to this new sender at the forwarding site, which can extract the
42323 original sender from the coded local part and forward the DSN to
42324 the originator.
42325
42326 This is a way of avoiding the breakage that SPF does to forwarding.
42327 The constructed local-part will be longer than the original,
42328 leading to possible problems with very long addresses.
42329 The changing of the sender address also hinders the tracing of mail
42330 problems.
42331
42332 Exim can be built to include native SRS support.  To do this
42333 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42334 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42335 will be defined.
42336 The support is limited to SRS0-encoding; SRS1 is not supported.
42337
42338 .cindex SRS excoding
42339 To encode an address use this expansion item:
42340 .vlist
42341 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42342 .cindex "&%srs_encode%& expansion item"
42343 .cindex SRS "expansion item"
42344 The first argument should be a secret known and used by all systems
42345 handling the recipient domain for the original message.
42346 There is no need to periodically change this key; a timestamp is also
42347 encoded.
42348 The second argument should be given as the envelope sender address before this
42349 encoding operation.
42350 If this value is empty the the expansion result will be empty.
42351 The third argument should be the recipient domain of the message when
42352 it arrived at this system.
42353 All arguments are expanded before use.
42354
42355 The result of the expansion is the replacement envelope-from (return path)
42356 to be used.
42357 .endlist
42358
42359 .cindex SRS decoding
42360 To decode an address use this expansion condition:
42361 .vlist
42362 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42363 The first argument should be the recipient local part as it was received.
42364 The second argument is the site secret.
42365 Both arguments are expanded before use.
42366
42367 If the messages is not for an SRS-encoded recipient the condition will
42368 return false.
42369 If it is, the condition will return true and the variable
42370 &$srs_recipient$& will be set to the decoded (original) value.
42371
42372 If the second argument is empty then the condition returns true if
42373 the first argument is in valid SRS formet, else false.
42374 The variable &$srs_recipient$& is not set for this case.
42375 .endlist
42376
42377 Example usage:
42378 .code
42379   #macro
42380   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42381
42382   #routers
42383
42384   outbound:
42385     driver =    dnslookup
42386     # if outbound, and forwarding has been done, use an alternate transport
42387     domains =   ! +my_domains
42388     transport = ${if eq {$local_part@$domain} \
42389                         {$original_local_part@$original_domain} \
42390                      {remote_smtp} {remote_forwarded_smtp}}
42391
42392   inbound_srs:
42393     driver =    redirect
42394     senders =   :
42395     domains =   +my_domains
42396     # detect inbound bounces which are SRS'd, and decode them
42397     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42398     data =      $srs_recipient
42399
42400   inbound_srs_failure:
42401     driver =    redirect
42402     senders =   :
42403     domains =   +my_domains
42404     # detect inbound bounces which look SRS'd but are invalid
42405     condition = ${if inbound_srs {$local_part} {}}
42406     allow_fail
42407     data =      :fail: Invalid SRS recipient address
42408
42409   #... further routers here
42410
42411
42412   # transport; should look like the non-forward outbound
42413   # one, plus the max_rcpt and return_path options
42414   remote_forwarded_smtp:
42415     driver =              smtp
42416     # single-recipient so that $original_domain is valid
42417     max_rcpt =            1
42418     # modify the envelope from, for mails that we forward
42419     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42420 .endd
42421
42422
42423
42424
42425
42426 .section DMARC SECDMARC
42427 .cindex DMARC verification
42428
42429 DMARC combines feedback from SPF, DKIM, and header From: in order
42430 to attempt to provide better indicators of the authenticity of an
42431 email.  This document does not explain the fundamentals; you
42432 should read and understand how it works by visiting the website at
42433 &url(http://www.dmarc.org/).
42434
42435 If Exim is built with DMARC support,
42436 the libopendmarc library is used.
42437
42438 For building Exim yourself, obtain the library from
42439 &url(http://sourceforge.net/projects/opendmarc/)
42440 to obtain a copy, or find it in your favorite package
42441 repository.  You will need to attend to the local/Makefile feature
42442 SUPPORT_DMARC and the associated LDFLAGS addition.
42443 This description assumes
42444 that headers will be in /usr/local/include, and that the libraries
42445 are in /usr/local/lib.
42446
42447 .subsection Configuration SSECDMARCCONFIG
42448 .cindex DMARC configuration
42449
42450 There are three main-configuration options:
42451 .cindex DMARC "configuration options"
42452
42453 The &%dmarc_tld_file%& option
42454 .oindex &%dmarc_tld_file%&
42455 defines the location of a text file of valid
42456 top level domains the opendmarc library uses
42457 during domain parsing. Maintained by Mozilla,
42458 the most current version can be downloaded
42459 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42460 See also the util/renew-opendmarc-tlds.sh script.
42461 The default for the option is unset.
42462 If not set, DMARC processing is disabled.
42463
42464
42465 The &%dmarc_history_file%& option, if set
42466 .oindex &%dmarc_history_file%&
42467 defines the location of a file to log results
42468 of dmarc verification on inbound emails. The
42469 contents are importable by the opendmarc tools
42470 which will manage the data, send out DMARC
42471 reports, and expire the data. Make sure the
42472 directory of this file is writable by the user
42473 exim runs as.
42474 The default is unset.
42475
42476 The &%dmarc_forensic_sender%& option
42477 .oindex &%dmarc_forensic_sender%&
42478 defines an alternate email address to use when sending a
42479 forensic report detailing alignment failures
42480 if a sender domain's dmarc record specifies it
42481 and you have configured Exim to send them.
42482 If set, this is expanded and used for the
42483 From: header line; the address is extracted
42484 from it and used for the envelope from.
42485 If not set (the default), the From: header is expanded from
42486 the dsn_from option, and <> is used for the
42487 envelope from.
42488
42489 .subsection Controls SSECDMARCCONTROLS
42490 .cindex DMARC controls
42491
42492 By default, the DMARC processing will run for any remote,
42493 non-authenticated user.  It makes sense to only verify DMARC
42494 status of messages coming from remote, untrusted sources.  You can
42495 use standard conditions such as hosts, senders, etc, to decide that
42496 DMARC verification should *not* be performed for them and disable
42497 DMARC with an ACL control modifier:
42498 .code
42499   control = dmarc_disable_verify
42500 .endd
42501 A DMARC record can also specify a "forensic address", which gives
42502 exim an email address to submit reports about failed alignment.
42503 Exim does not do this by default because in certain conditions it
42504 results in unintended information leakage (what lists a user might
42505 be subscribed to, etc).  You must configure exim to submit forensic
42506 reports to the owner of the domain.  If the DMARC record contains a
42507 forensic address and you specify the control statement below, then
42508 exim will send these forensic emails.  It is also advised that you
42509 configure a &%dmarc_forensic_sender%& because the default sender address
42510 construction might be inadequate.
42511 .code
42512   control = dmarc_enable_forensic
42513 .endd
42514 (AGAIN: You can choose not to send these forensic reports by simply
42515 not putting the dmarc_enable_forensic control line at any point in
42516 your exim config.  If you don't tell exim to send them, it will not
42517 send them.)
42518
42519 There are no options to either control.  Both must appear before
42520 the DATA acl.
42521
42522 .subsection ACL SSECDMARCACL
42523 .cindex DMARC "ACL condition"
42524
42525 DMARC checks can be run on incoming SMTP  messages by using the
42526 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42527 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42528 condition.  Putting this condition in the ACLs is required in order
42529 for a DMARC check to actually occur.  All of the variables are set
42530 up before the DATA ACL, but there is no actual DMARC check that
42531 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42532
42533 The &"dmarc_status"& condition takes a list of strings on its
42534 right-hand side.  These strings describe recommended action based
42535 on the DMARC check.  To understand what the policy recommendations
42536 mean, refer to the DMARC website above.  Valid strings are:
42537 .itable none 0 0 2 20* left 80* left
42538 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42539 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42540 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42541 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42542 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42543 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42544 .irow &'temperror'&     "Library error or dns error"
42545 .irow &'off'&           "The DMARC check was disabled for this email"
42546 .endtable
42547 You can prefix each string with an exclamation mark to invert its
42548 meaning, for example "!accept" will match all results but
42549 "accept".  The string list is evaluated left-to-right in a
42550 short-circuit fashion.  When a string matches the outcome of the
42551 DMARC check, the condition succeeds.  If none of the listed
42552 strings matches the outcome of the DMARC check, the condition
42553 fails.
42554
42555 Of course, you can also use any other lookup method that Exim
42556 supports, including LDAP, Postgres, MySQL, etc, as long as the
42557 result is a list of colon-separated strings.
42558
42559 Performing the check sets up information used by the
42560 &%authresults%& expansion item.
42561
42562 Several expansion variables are set before the DATA ACL is
42563 processed, and you can use them in this ACL.  The following
42564 expansion variables are available:
42565
42566 .vlist
42567 .vitem &$dmarc_status$&
42568 .vindex &$dmarc_status$&
42569 .cindex DMARC result
42570 A one word status indicating what the DMARC library
42571 thinks of the email.  It is a combination of the results of
42572 DMARC record lookup and the SPF/DKIM/DMARC processing results
42573 (if a DMARC record was found).  The actual policy declared
42574 in the DMARC record is in a separate expansion variable.
42575
42576 .vitem &$dmarc_status_text$&
42577 .vindex &$dmarc_status_text$&
42578 Slightly longer, human readable status.
42579
42580 .vitem &$dmarc_used_domain$&
42581 .vindex &$dmarc_used_domain$&
42582 The domain which DMARC used to look up the DMARC policy record.
42583
42584 .vitem &$dmarc_domain_policy$&
42585 .vindex &$dmarc_domain_policy$&
42586 The policy declared in the DMARC record.  Valid values
42587 are "none", "reject" and "quarantine".  It is blank when there
42588 is any error, including no DMARC record.
42589 .endlist
42590
42591 .subsection Logging SSECDMARCLOGGING
42592 .cindex DMARC logging
42593
42594 By default, Exim's DMARC configuration is intended to be
42595 non-intrusive and conservative.  To facilitate this, Exim will not
42596 create any type of logging files without explicit configuration by
42597 you, the admin.  Nor will Exim send out any emails/reports about
42598 DMARC issues without explicit configuration by you, the admin (other
42599 than typical bounce messages that may come about due to ACL
42600 processing or failure delivery issues).
42601
42602 In order to log statistics suitable to be imported by the opendmarc
42603 tools, you need to:
42604 .ilist
42605 Configure the global option &%dmarc_history_file%&
42606 .next
42607 Configure cron jobs to call the appropriate opendmarc history
42608 import scripts and truncating the dmarc_history_file
42609 .endlist
42610
42611 In order to send forensic reports, you need to:
42612 .ilist
42613 Configure the global option &%dmarc_forensic_sender%&
42614 .next
42615 Configure, somewhere before the DATA ACL, the control option to
42616 enable sending DMARC forensic reports
42617 .endlist
42618
42619 .subsection Example SSECDMARCEXAMPLE
42620 .cindex DMARC example
42621
42622 Example usage:
42623 .code
42624 (RCPT ACL)
42625   warn    domains        = +local_domains
42626           hosts          = +local_hosts
42627           control        = dmarc_disable_verify
42628
42629   warn    !domains       = +screwed_up_dmarc_records
42630           control        = dmarc_enable_forensic
42631
42632   warn    condition      = (lookup if destined to mailing list)
42633           set acl_m_mailing_list = 1
42634
42635 (DATA ACL)
42636   warn    dmarc_status   = accept : none : off
42637           !authenticated = *
42638           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42639
42640   warn    dmarc_status   = !accept
42641           !authenticated = *
42642           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42643
42644   warn    dmarc_status   = quarantine
42645           !authenticated = *
42646           set $acl_m_quarantine = 1
42647           # Do something in a transport with this flag variable
42648
42649   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42650           condition      = ${if eq{$acl_m_mailing_list}{1}}
42651           message        = Messages from $dmarc_used_domain break mailing lists
42652
42653   deny    dmarc_status   = reject
42654           !authenticated = *
42655           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42656
42657   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42658 .endd
42659
42660
42661
42662
42663
42664 . ////////////////////////////////////////////////////////////////////////////
42665 . ////////////////////////////////////////////////////////////////////////////
42666
42667 .chapter "Proxies" "CHAPproxies" &&&
42668          "Proxy support"
42669 .cindex "proxy support"
42670 .cindex "proxy" "access via"
42671
42672 A proxy is an intermediate system through which communication is passed.
42673 Proxies may provide a security, availability or load-distribution function.
42674
42675
42676 .section "Inbound proxies" SECTproxyInbound
42677 .cindex proxy inbound
42678 .cindex proxy "server side"
42679 .cindex proxy "Proxy protocol"
42680 .cindex "Proxy protocol" proxy
42681
42682 Exim has support for receiving inbound SMTP connections via a proxy
42683 that uses &"Proxy Protocol"& to speak to it.
42684 To include this support, include &"SUPPORT_PROXY=yes"&
42685 in Local/Makefile.
42686
42687 It was built on the HAProxy specification, found at
42688 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42689
42690 The purpose of this facility is so that an application load balancer,
42691 such as HAProxy, can sit in front of several Exim servers
42692 to distribute load.
42693 Exim uses the local protocol communication with the proxy to obtain
42694 the remote SMTP system IP address and port information.
42695 There is no logging if a host passes or
42696 fails Proxy Protocol negotiation, but it can easily be determined and
42697 recorded in an ACL (example is below).
42698
42699 Use of a proxy is enabled by setting the &%hosts_proxy%&
42700 main configuration option to a hostlist; connections from these
42701 hosts will use Proxy Protocol.
42702 Exim supports both version 1 and version 2 of the Proxy Protocol and
42703 automatically determines which version is in use.
42704
42705 The Proxy Protocol header is the first data received on a TCP connection
42706 and is inserted before any TLS-on-connect handshake from the client; Exim
42707 negotiates TLS between Exim-as-server and the remote client, not between
42708 Exim and the proxy server. The Proxy Protocol header must be received
42709 within &%proxy_protocol_timeout%&, which defaults to 3s.
42710
42711 The following expansion variables are usable
42712 (&"internal"& and &"external"& here refer to the interfaces
42713 of the proxy):
42714 .itable none 0 0 2 30* left 70* left
42715 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42716 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42717 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42718 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42719 .irow $proxy_session            "boolean: SMTP connection via proxy"
42720 .endtable
42721 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42722 there was a protocol error.
42723 The variables &$sender_host_address$& and &$sender_host_port$&
42724 will have values for the actual client system, not the proxy.
42725
42726 Since the real connections are all coming from the proxy, and the
42727 per host connection tracking is done before Proxy Protocol is
42728 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42729 handle all of the parallel volume you expect per inbound proxy.
42730 With the option set so high, you lose the ability
42731 to protect your server from many connections from one IP.
42732 In order to prevent your server from overload, you
42733 need to add a per connection ratelimit to your connect ACL.
42734 A possible solution is:
42735 .display
42736   # Set max number of connections per host
42737   LIMIT   = 5
42738   # Or do some kind of IP lookup in a flat file or database
42739   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42740
42741   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42742           message        = Too many connections from this IP right now
42743 .endd
42744
42745
42746
42747 .section "Outbound proxies" SECTproxySOCKS
42748 .cindex proxy outbound
42749 .cindex proxy "client side"
42750 .cindex proxy SOCKS
42751 .cindex SOCKS proxy
42752 Exim has support for sending outbound SMTP via a proxy
42753 using a protocol called SOCKS5 (defined by RFC1928).
42754 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42755 Local/Makefile.
42756
42757 Use of a proxy is enabled by setting the &%socks_proxy%& option
42758 on an smtp transport.
42759 The option value is expanded and should then be a list
42760 (colon-separated by default) of proxy specifiers.
42761 Each proxy specifier is a list
42762 (space-separated by default) where the initial element
42763 is an IP address and any subsequent elements are options.
42764
42765 Options are a string <name>=<value>.
42766 The list of options is in the following table:
42767 .itable none 0 0 2 10* left 90* left
42768 .irow &'auth'&  "authentication method"
42769 .irow &'name'&  "authentication username"
42770 .irow &'pass'&  "authentication password"
42771 .irow &'port'&  "tcp port"
42772 .irow &'tmo'&   "connection timeout"
42773 .irow &'pri'&   "priority"
42774 .irow &'weight'& "selection bias"
42775 .endtable
42776
42777 More details on each of these options follows:
42778
42779 .ilist
42780 .cindex authentication "to proxy"
42781 .cindex proxy authentication
42782 &%auth%&: Either &"none"& (default) or &"name"&.
42783 Using &"name"& selects username/password authentication per RFC 1929
42784 for access to the proxy.
42785 Default is &"none"&.
42786 .next
42787 &%name%&: sets the username for the &"name"& authentication method.
42788 Default is empty.
42789 .next
42790 &%pass%&: sets the password for the &"name"& authentication method.
42791 Default is empty.
42792 .next
42793 &%port%&: the TCP port number to use for the connection to the proxy.
42794 Default is 1080.
42795 .next
42796 &%tmo%&: sets a connection timeout in seconds for this proxy.
42797 Default is 5.
42798 .next
42799 &%pri%&: specifies a priority for the proxy within the list,
42800 higher values being tried first.
42801 The default priority is 1.
42802 .next
42803 &%weight%&: specifies a selection bias.
42804 Within a priority set servers are queried in a random fashion,
42805 weighted by this value.
42806 The default value for selection bias is 1.
42807 .endlist
42808
42809 Proxies from the list are tried according to their priority
42810 and weight settings until one responds.  The timeout for the
42811 overall connection applies to the set of proxied attempts.
42812
42813 .section Logging SECTproxyLog
42814 To log the (local) IP of a proxy in the incoming or delivery logline,
42815 add &"+proxy"& to the &%log_selector%& option.
42816 This will add a component tagged with &"PRX="& to the line.
42817
42818 . ////////////////////////////////////////////////////////////////////////////
42819 . ////////////////////////////////////////////////////////////////////////////
42820
42821 .chapter "Internationalisation" "CHAPi18n" &&&
42822          "Internationalisation""
42823 .cindex internationalisation "email address"
42824 .cindex EAI
42825 .cindex i18n
42826 .cindex utf8 "mail name handling"
42827
42828 Exim has support for Internationalised mail names.
42829 To include this it must be built with SUPPORT_I18N and the libidn library.
42830 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42831
42832 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42833 instead of it) then IDNA2008 is supported; this adds an extra library
42834 requirement, upon libidn2.
42835
42836 .section "MTA operations" SECTi18nMTA
42837 .cindex SMTPUTF8 "ESMTP option"
42838 .cindex "ESMTP extensions" SMTPUTF8
42839 The main configuration option &%smtputf8_advertise_hosts%& specifies
42840 a host list.  If this matches the sending host and
42841 accept_8bitmime is true (the default) then the ESMTP option
42842 SMTPUTF8 will be advertised.
42843
42844 If the sender specifies the SMTPUTF8 option on a MAIL command
42845 international handling for the message is enabled and
42846 the expansion variable &$message_smtputf8$& will have value TRUE.
42847
42848 The option &%allow_utf8_domains%& is set to true for this
42849 message. All DNS lookups are converted to a-label form
42850 whatever the setting of &%allow_utf8_domains%&
42851 when Exim is built with SUPPORT_I18N.
42852
42853 Both localparts and domain are maintained as the original
42854 UTF-8 form internally; any comparison or regular-expression use will
42855 require appropriate care.  Filenames created, eg. by
42856 the appendfile transport, will have UTF-8 names.
42857
42858 HELO names sent by the smtp transport will have any UTF-8
42859 components expanded to a-label form,
42860 and any certificate name checks will be done using the a-label
42861 form of the name.
42862
42863 .cindex log protocol
42864 .cindex SMTPUTF8 logging
42865 .cindex i18n logging
42866 Log lines and Received-by: header lines will acquire a "utf8"
42867 prefix on the protocol element, eg. utf8esmtp.
42868
42869 The following expansion operators can be used:
42870 .code
42871 ${utf8_domain_to_alabel:str}
42872 ${utf8_domain_from_alabel:str}
42873 ${utf8_localpart_to_alabel:str}
42874 ${utf8_localpart_from_alabel:str}
42875 .endd
42876
42877 .cindex utf8 "address downconversion"
42878 .cindex i18n "utf8 address downconversion"
42879 The RCPT ACL
42880 may use the following modifier:
42881 .display
42882 control = utf8_downconvert
42883 control = utf8_downconvert/<value>
42884 .endd
42885 This sets a flag requiring that envelope addresses are converted to
42886 a-label form before smtp delivery.
42887 This is usually for use in a Message Submission Agent context,
42888 but could be used for any message.
42889
42890 If a value is appended it may be:
42891 .itable none 0 0 2 5* right 95* left
42892 .irow &`1`&     "mandatory downconversion"
42893 .irow &`0`&     "no downconversion"
42894 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42895 .endtable
42896 If no value is given, 1 is used.
42897
42898 If mua_wrapper is set, the utf8_downconvert control
42899 is initially set to -1.
42900
42901 The smtp transport has an option &%utf8_downconvert%&.
42902 If set it must expand to one of the three values described above,
42903 or an empty string.
42904 If non-empty it overrides value previously set
42905 (due to mua_wrapper or by an ACL control).
42906
42907
42908 There is no explicit support for VRFY and EXPN.
42909 Configurations supporting these should inspect
42910 &$smtp_command_argument$& for an SMTPUTF8 argument.
42911
42912 There is no support for LMTP on Unix sockets.
42913 Using the "lmtp" protocol option on an smtp transport,
42914 for LMTP over TCP, should work as expected.
42915
42916 There is no support for DSN unitext handling,
42917 and no provision for converting logging from or to UTF-8.
42918
42919
42920
42921 .section "MDA operations" SECTi18nMDA
42922 To aid in constructing names suitable for IMAP folders
42923 the following expansion operator can be used:
42924 .code
42925 ${imapfolder {<string>} {<sep>} {<specials>}}
42926 .endd
42927
42928 The string is converted from the charset specified by
42929 the "headers charset" command (in a filter file)
42930 or &%headers_charset%& main configuration option (otherwise),
42931 to the
42932 modified UTF-7 encoding specified by RFC 2060,
42933 with the following exception: All occurrences of <sep>
42934 (which has to be a single character)
42935 are replaced with periods ("."), and all periods and slashes that are not
42936 <sep> and are not in the <specials> string are BASE64 encoded.
42937
42938 The third argument can be omitted, defaulting to an empty string.
42939 The second argument can be omitted, defaulting to "/".
42940
42941 This is the encoding used by Courier for Maildir names on disk, and followed
42942 by many other IMAP servers.
42943
42944 Examples:
42945 .display
42946 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42947 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42948 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42949 .endd
42950
42951 Note that the source charset setting is vital, and also that characters
42952 must be representable in UTF-16.
42953
42954
42955 . ////////////////////////////////////////////////////////////////////////////
42956 . ////////////////////////////////////////////////////////////////////////////
42957
42958 .chapter "Events" "CHAPevents" &&&
42959          "Events"
42960 .cindex events
42961
42962 The events mechanism in Exim can be used to intercept processing at a number
42963 of points.  It was originally invented to give a way to do customised logging
42964 actions (for example, to a database) but can also be used to modify some
42965 processing actions.
42966
42967 Most installations will never need to use Events.
42968 The support can be left out of a build by defining DISABLE_EVENT=yes
42969 in &_Local/Makefile_&.
42970
42971 There are two major classes of events: main and transport.
42972 The main configuration option &%event_action%& controls reception events;
42973 a transport option &%event_action%& controls delivery events.
42974
42975 Both options are a string which is expanded when the event fires.
42976 An example might look like:
42977 .cindex logging custom
42978 .code
42979 event_action = ${if eq {msg:delivery}{$event_name} \
42980 {${lookup pgsql {SELECT * FROM record_Delivery( \
42981     '${quote_pgsql:$sender_address_domain}',\
42982     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42983     '${quote_pgsql:$domain}', \
42984     '${quote_pgsql:${lc:$local_part}}', \
42985     '${quote_pgsql:$host_address}', \
42986     '${quote_pgsql:${lc:$host}}', \
42987     '${quote_pgsql:$message_exim_id}')}} \
42988 } {}}
42989 .endd
42990
42991 Events have names which correspond to the point in process at which they fire.
42992 The name is placed in the variable &$event_name$& and the event action
42993 expansion must check this, as it will be called for every possible event type.
42994
42995 The current list of events is:
42996 .itable all 0 0 4 25* left 10* center 15* center 50* left
42997 .row auth:fail              after    both       "per driver per authentication attempt"
42998 .row dane:fail              after    transport  "per connection"
42999 .row msg:complete           after    main       "per message"
43000 .row msg:defer              after    transport  "per message per delivery try"
43001 .row msg:delivery           after    transport  "per recipient"
43002 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
43003 .row msg:rcpt:defer         after    transport  "per recipient"
43004 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
43005 .row msg:fail:delivery      after    transport  "per recipient"
43006 .row msg:fail:internal      after    main       "per recipient"
43007 .row tcp:connect            before   transport  "per connection"
43008 .row tcp:close              after    transport  "per connection"
43009 .row tls:cert               before   both       "per certificate in verification chain"
43010 .row tls:fail:connect       after    main       "per connection"
43011 .row smtp:connect           after    transport  "per connection"
43012 .row smtp:ehlo              after    transport  "per connection"
43013 .endtable
43014 New event types may be added in future.
43015
43016 The event name is a colon-separated list, defining the type of
43017 event in a tree of possibilities.  It may be used as a list
43018 or just matched on as a whole.  There will be no spaces in the name.
43019
43020 The second column in the table above describes whether the event fires
43021 before or after the action is associates with.  Those which fire before
43022 can be used to affect that action (more on this below).
43023
43024 The third column in the table above says what section of the configuration
43025 should define the event action.
43026
43027 An additional variable, &$event_data$&, is filled with information varying
43028 with the event type:
43029 .itable all 0 0 2 20* left 80* left
43030 .row auth:fail            "smtp response"
43031 .row dane:fail            "failure reason"
43032 .row msg:defer            "error string"
43033 .row msg:delivery         "smtp confirmation message"
43034 .row msg:fail:internal    "failure reason"
43035 .row msg:fail:delivery    "smtp error message"
43036 .row msg:host:defer       "error string"
43037 .row msg:rcpt:host:defer  "error string"
43038 .row msg:rcpt:defer       "error string"
43039 .row tls:cert             "verification chain depth"
43040 .row tls:fail:connect     "error string"
43041 .row smtp:connect         "smtp banner"
43042 .row smtp:ehlo            "smtp ehlo response"
43043 .endtable
43044
43045 The :defer events populate one extra variable: &$event_defer_errno$&.
43046
43047 For complex operations an ACL expansion can be used in &%event_action%&,
43048 however due to the multiple contexts that Exim operates in during
43049 the course of its processing:
43050 .ilist
43051 variables set in transport events will not be visible outside that
43052 transport call
43053 .next
43054 acl_m variables in a server context are lost on a new connection,
43055 and after smtp helo/ehlo/mail/starttls/rset commands
43056 .endlist
43057 Using an ACL expansion with the logwrite modifier can be
43058 a useful way of writing to the main log.
43059
43060 The expansion of the event_action option should normally
43061 return an empty string.  Should it return anything else the
43062 following will be forced:
43063 .itable all 0 0 2 20* left 80* left
43064 .row auth:fail        "log information to write"
43065 .row tcp:connect      "do not connect"
43066 .row tls:cert         "refuse verification"
43067 .row smtp:connect     "close connection"
43068 .endtable
43069 All other message types ignore the result string, and
43070 no other use is made of it.
43071
43072 For a tcp:connect event, if the connection is being made to a proxy
43073 then the &$host_address$& and &$host_port$& variables
43074 will be that of the proxy and not the target system.
43075
43076 For tls:cert events, if GnuTLS is in use this will trigger only per
43077 chain element received on the connection.
43078 For OpenSSL it will trigger for every chain element including those
43079 loaded locally.
43080
43081 . ////////////////////////////////////////////////////////////////////////////
43082 . ////////////////////////////////////////////////////////////////////////////
43083
43084 .chapter "Adding new drivers or lookup types" "CHID13" &&&
43085          "Adding drivers or lookups"
43086 .cindex "adding drivers"
43087 .cindex "new drivers, adding"
43088 .cindex "drivers" "adding new"
43089 The following actions have to be taken in order to add a new router, transport,
43090 authenticator, or lookup type to Exim:
43091
43092 .olist
43093 Choose a name for the driver or lookup type that does not conflict with any
43094 existing name; I will use &"newdriver"& in what follows.
43095 .next
43096 Add to &_src/EDITME_& the line:
43097 .display
43098 <&'type'&>&`_NEWDRIVER=yes`&
43099 .endd
43100 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
43101 code is not to be included in the binary by default, comment this line out. You
43102 should also add any relevant comments about the driver or lookup type.
43103 .next
43104 Add to &_src/config.h.defaults_& the line:
43105 .code
43106 #define <type>_NEWDRIVER
43107 .endd
43108 .next
43109 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
43110 and create a table entry as is done for all the other drivers and lookup types.
43111 .next
43112 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
43113 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
43114 Add your &`NEWDRIVER`& to that list.
43115 As long as the dynamic module would be named &_newdriver.so_&, you can use the
43116 simple form that most lookups have.
43117 .next
43118 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43119 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43120 driver or lookup type and add it to the definition of OBJ.
43121 .next
43122 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43123 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43124 .next
43125 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43126 &_src_&.
43127 .next
43128 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43129 as for other drivers and lookups.
43130 .endlist
43131
43132 Then all you need to do is write the code! A good way to start is to make a
43133 proforma by copying an existing module of the same type, globally changing all
43134 occurrences of the name, and cutting out most of the code. Note that any
43135 options you create must be listed in alphabetical order, because the tables are
43136 searched using a binary chop procedure.
43137
43138 There is a &_README_& file in each of the sub-directories of &_src_& describing
43139 the interface that is expected.
43140
43141
43142
43143
43144 . ////////////////////////////////////////////////////////////////////////////
43145 . ////////////////////////////////////////////////////////////////////////////
43146
43147 . /////////////////////////////////////////////////////////////////////////////
43148 . These lines are processing instructions for the Simple DocBook Processor that
43149 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43150 . PDFs than using xmlto and fop. They will be ignored by all other XML
43151 . processors.
43152 . /////////////////////////////////////////////////////////////////////////////
43153
43154 .literal xml
43155 <?sdop
43156   format="newpage"
43157   foot_right_recto="&chaptertitle;"
43158   foot_right_verso="&chaptertitle;"
43159 ?>
43160 .literal off
43161
43162 .makeindex "Options index"   "option"
43163 .makeindex "Variables index" "variable"
43164 .makeindex "Concept index"   "concept"
43165
43166
43167 . /////////////////////////////////////////////////////////////////////////////
43168 . /////////////////////////////////////////////////////////////////////////////