2c90ec5f3ef4bf877f999beddf30fd60e5c9e688
[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 An older syntax places the servers specification before the query,
8160 semicolon separated:
8161 .code
8162 ${lookup mysql{servers=master; UPDATE ...} }
8163 .endd
8164 The new version avoids potential issues with tainted
8165 arguments in the query, for explicit expansion.
8166 &*Note*&: server specifications in list-style lookups are still problematic.
8167
8168
8169 .subsection "Special MySQL features" SECID73
8170 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8171 causes a connection to the server on the local host by means of a Unix domain
8172 socket. An alternate socket can be specified in parentheses.
8173 An option group name for MySQL option files can be specified in square brackets;
8174 the default value is &"exim"&.
8175 The full syntax of each item in &%mysql_servers%& is:
8176 .display
8177 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8178   <&'database'&>/<&'user'&>/<&'password'&>
8179 .endd
8180 Any of the four sub-parts of the first field can be omitted. For normal use on
8181 the local host it can be left blank or set to just &"localhost"&.
8182
8183 No database need be supplied &-- but if it is absent here, it must be given in
8184 the queries.
8185
8186 If a MySQL query is issued that does not request any data (an insert, update,
8187 or delete command), the result of the lookup is the number of rows affected.
8188
8189 &*Warning*&: This can be misleading. If an update does not actually change
8190 anything (for example, setting a field to the value it already has), the result
8191 is zero because no rows are affected.
8192
8193
8194 .subsection "Special PostgreSQL features" SECID74
8195 PostgreSQL lookups can also use Unix domain socket connections to the database.
8196 This is usually faster and costs less CPU time than a TCP/IP connection.
8197 However it can be used only if the mail server runs on the same machine as the
8198 database server. A configuration line for PostgreSQL via Unix domain sockets
8199 looks like this:
8200 .code
8201 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8202 .endd
8203 In other words, instead of supplying a host name, a path to the socket is
8204 given. The path name is enclosed in parentheses so that its slashes aren't
8205 visually confused with the delimiters for the other server parameters.
8206
8207 If a PostgreSQL query is issued that does not request any data (an insert,
8208 update, or delete command), the result of the lookup is the number of rows
8209 affected.
8210
8211 .subsection "More about SQLite" SECTsqlite
8212 .cindex "lookup" "SQLite"
8213 .cindex "sqlite lookup type"
8214 SQLite is different to the other SQL lookups because a filename is required in
8215 addition to the SQL query. An SQLite database is a single file, and there is no
8216 daemon as in the other SQL databases.
8217
8218 .oindex &%sqlite_dbfile%&
8219 There are two ways of
8220 specifying the file.
8221 The first is by using the &%sqlite_dbfile%& main option.
8222 The second, which allows separate files for each query,
8223 is to use an option appended, comma-separated, to the &"sqlite"&
8224 lookup type word.  The option is the word &"file"&, then an equals,
8225 then the filename.
8226 The filename in this case cannot contain whitespace or open-brace charachters.
8227
8228 A deprecated method is available, prefixing the query with the filename
8229 separated by white space.
8230 This means that
8231 .cindex "tainted data" "sqlite file"
8232 the query cannot use any tainted values, as that taints
8233 the entire query including the filename - resulting in a refusal to open
8234 the file.
8235
8236 In all the above cases the filename must be an absolute path.
8237
8238 Here is a lookup expansion example:
8239 .code
8240 sqlite_dbfile = /some/thing/sqlitedb
8241 ...
8242 ${lookup sqlite {select name from aliases where id='userx';}}
8243 .endd
8244 In a list, the syntax is similar. For example:
8245 .code
8246 domainlist relay_to_domains = sqlite;\
8247    select * from relays where ip='$sender_host_address';
8248 .endd
8249 The only character affected by the &%quote_sqlite%& operator is a single
8250 quote, which it doubles.
8251
8252 .cindex timeout SQLite
8253 .cindex sqlite "lookup timeout"
8254 The SQLite library handles multiple simultaneous accesses to the database
8255 internally. Multiple readers are permitted, but only one process can
8256 update at once. Attempts to access the database while it is being updated
8257 are rejected after a timeout period, during which the SQLite library
8258 waits for the lock to be released. In Exim, the default timeout is set
8259 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8260 option.
8261
8262 .subsection "More about Redis" SECTredis
8263 .cindex "lookup" "Redis"
8264 .cindex "redis lookup type"
8265 Redis is a non-SQL database. Commands are simple get and set.
8266 Examples:
8267 .code
8268 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8269 ${lookup redis{get keyname}}
8270 .endd
8271
8272 As of release 4.91, "lightweight" support for Redis Cluster is available.
8273 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8274 of which must be reachable from the running exim instance. If the cluster has
8275 master/slave replication, the list must contain all the master and slave
8276 servers.
8277
8278 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8279 immediately follow the redirection but treats the response as a DEFER, moving on
8280 to the next server in the &%redis_servers%& list until the correct server is
8281 reached.
8282
8283 .ecindex IIDfidalo1
8284 .ecindex IIDfidalo2
8285
8286
8287 . ////////////////////////////////////////////////////////////////////////////
8288 . ////////////////////////////////////////////////////////////////////////////
8289
8290 .chapter "Domain, host, address, and local part lists" &&&
8291          "CHAPdomhosaddlists" &&&
8292          "Domain, host, and address lists"
8293 .scindex IIDdohoadli "lists of domains; hosts; etc."
8294 A number of Exim configuration options contain lists of domains, hosts,
8295 email addresses, or local parts. For example, the &%hold_domains%& option
8296 contains a list of domains whose delivery is currently suspended. These lists
8297 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8298 arguments to expansion conditions such as &%match_domain%&.
8299
8300 Each item in one of these lists is a pattern to be matched against a domain,
8301 host, email address, or local part, respectively. In the sections below, the
8302 different types of pattern for each case are described, but first we cover some
8303 general facilities that apply to all four kinds of list.
8304
8305 Note that other parts of Exim use a &'string list'& which does not
8306 support all the complexity available in
8307 domain, host, address and local part lists.
8308
8309
8310
8311 .section "Results of list checking" SECTlistresults
8312 The primary result of doing a list check is a truth value.
8313 In some contexts additional information is stored
8314 about the list element that matched:
8315 .vlist
8316 .vitem hosts
8317 A &%hosts%& ACL condition
8318 will store a result in the &$host_data$& variable.
8319 .vitem local_parts
8320 A &%local_parts%& router option or &%local_parts%& ACL condition
8321 will store a result in the &$local_part_data$& variable.
8322 .vitem domains
8323 A &%domains%& router option or &%domains%& ACL condition
8324 will store a result in the &$domain_data$& variable.
8325 .vitem senders
8326 A &%senders%& router option or &%senders%& ACL condition
8327 will store a result in the &$sender_data$& variable.
8328 .vitem recipients
8329 A &%recipients%& ACL condition
8330 will store a result in the &$recipient_data$& variable.
8331 .endlist
8332
8333 The detail of the additional information depends on the
8334 type of match and is given below as the &*value*& information.
8335
8336
8337
8338
8339 .section "Expansion of lists" "SECTlistexpand"
8340 .cindex "expansion" "of lists"
8341 Each list is expanded as a single string before it is used.
8342
8343 &'Exception: the router headers_remove option, where list-item
8344 splitting is done before string-expansion.'&
8345
8346 The result of
8347 expansion must be a list, possibly containing empty items, which is split up
8348 into separate items for matching. By default, colon is the separator character,
8349 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8350 &<<SECTempitelis>>& for details of the list syntax; the second of these
8351 discusses the way to specify empty list items.
8352
8353
8354 If the string expansion is forced to fail, Exim behaves as if the item it is
8355 testing (domain, host, address, or local part) is not in the list. Other
8356 expansion failures cause temporary errors.
8357
8358 If an item in a list is a regular expression, backslashes, dollars and possibly
8359 other special characters in the expression must be protected against
8360 misinterpretation by the string expander. The easiest way to do this is to use
8361 the &`\N`& expansion feature to indicate that the contents of the regular
8362 expression should not be expanded. For example, in an ACL you might have:
8363 .code
8364 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8365                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8366 .endd
8367 The first item is a regular expression that is protected from expansion by
8368 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8369 senders based on the receiving domain.
8370
8371
8372
8373
8374 .subsection "Negated items in lists" SECID76
8375 .cindex "list" "negation"
8376 .cindex "negation" "in lists"
8377 Items in a list may be positive or negative. Negative items are indicated by a
8378 leading exclamation mark, which may be followed by optional white space. A list
8379 defines a set of items (domains, etc). When Exim processes one of these lists,
8380 it is trying to find out whether a domain, host, address, or local part
8381 (respectively) is in the set that is defined by the list. It works like this:
8382
8383 The list is scanned from left to right. If a positive item is matched, the
8384 subject that is being checked is in the set; if a negative item is matched, the
8385 subject is not in the set. If the end of the list is reached without the
8386 subject having matched any of the patterns, it is in the set if the last item
8387 was a negative one, but not if it was a positive one. For example, the list in
8388 .code
8389 domainlist relay_to_domains = !a.b.c : *.b.c
8390 .endd
8391 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8392 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8393 list is positive. However, if the setting were
8394 .code
8395 domainlist relay_to_domains = !a.b.c
8396 .endd
8397 then all domains other than &'a.b.c'& would match because the last item in the
8398 list is negative. In other words, a list that ends with a negative item behaves
8399 as if it had an extra item &`:*`& on the end.
8400
8401 Another way of thinking about positive and negative items in lists is to read
8402 the connector as &"or"& after a positive item and as &"and"& after a negative
8403 item.
8404
8405
8406
8407 .subsection "File names in lists" SECTfilnamlis
8408 .cindex "list" "filename in"
8409 If an item in a domain, host, address, or local part list is an absolute
8410 filename (beginning with a slash character), each line of the file is read and
8411 processed as if it were an independent item in the list, except that further
8412 filenames are not allowed,
8413 and no expansion of the data from the file takes place.
8414 Empty lines in the file are ignored, and the file may also contain comment
8415 lines:
8416
8417 .ilist
8418 For domain and host lists, if a # character appears anywhere in a line of the
8419 file, it and all following characters are ignored.
8420 .next
8421 Because local parts may legitimately contain # characters, a comment in an
8422 address list or local part list file is recognized only if # is preceded by
8423 white space or the start of the line. For example:
8424 .code
8425 not#comment@x.y.z   # but this is a comment
8426 .endd
8427 .endlist
8428
8429 Putting a filename in a list has the same effect as inserting each line of the
8430 file as an item in the list (blank lines and comments excepted). However, there
8431 is one important difference: the file is read each time the list is processed,
8432 so if its contents vary over time, Exim's behaviour changes.
8433
8434 If a filename is preceded by an exclamation mark, the sense of any match
8435 within the file is inverted. For example, if
8436 .code
8437 hold_domains = !/etc/nohold-domains
8438 .endd
8439 and the file contains the lines
8440 .code
8441 !a.b.c
8442 *.b.c
8443 .endd
8444 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8445 any domain matching &`*.b.c`& is not.
8446
8447
8448
8449 .subsection "An lsearch file is not an out-of-line list" SECID77
8450 As will be described in the sections that follow, lookups can be used in lists
8451 to provide indexed methods of checking list membership. There has been some
8452 confusion about the way &(lsearch)& lookups work in lists. Because
8453 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8454 sometimes thought that it is allowed to contain wild cards and other kinds of
8455 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8456 always fixed strings, just as for any other single-key lookup type.
8457
8458 If you want to use a file to contain wild-card patterns that form part of a
8459 list, just give the filename on its own, without a search type, as described
8460 in the previous section. You could also use the &(wildlsearch)& or
8461 &(nwildlsearch)&, but there is no advantage in doing this.
8462
8463
8464
8465
8466 .subsection "Named lists" SECTnamedlists
8467 .cindex "named lists"
8468 .cindex "list" "named"
8469 A list of domains, hosts, email addresses, or local parts can be given a name
8470 which is then used to refer to the list elsewhere in the configuration. This is
8471 particularly convenient if the same list is required in several different
8472 places. It also allows lists to be given meaningful names, which can improve
8473 the readability of the configuration. For example, it is conventional to define
8474 a domain list called &'local_domains'& for all the domains that are handled
8475 locally on a host, using a configuration line such as
8476 .code
8477 domainlist local_domains = localhost:my.dom.example
8478 .endd
8479 Named lists are referenced by giving their name preceded by a plus sign, so,
8480 for example, a router that is intended to handle local domains would be
8481 configured with the line
8482 .code
8483 domains = +local_domains
8484 .endd
8485 The first router in a configuration is often one that handles all domains
8486 except the local ones, using a configuration with a negated item like this:
8487 .code
8488 dnslookup:
8489   driver = dnslookup
8490   domains = ! +local_domains
8491   transport = remote_smtp
8492   no_more
8493 .endd
8494 The four kinds of named list are created by configuration lines starting with
8495 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8496 respectively. Then there follows the name that you are defining, followed by an
8497 equals sign and the list itself. For example:
8498 .code
8499 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8500 addresslist bad_senders = cdb;/etc/badsenders
8501 .endd
8502 A named list may refer to other named lists:
8503 .code
8504 domainlist  dom1 = first.example : second.example
8505 domainlist  dom2 = +dom1 : third.example
8506 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8507 .endd
8508 &*Warning*&: If the last item in a referenced list is a negative one, the
8509 effect may not be what you intended, because the negation does not propagate
8510 out to the higher level. For example, consider:
8511 .code
8512 domainlist  dom1 = !a.b
8513 domainlist  dom2 = +dom1 : *.b
8514 .endd
8515 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8516 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8517 means it matches the second list as well. The effect is not the same as
8518 .code
8519 domainlist  dom2 = !a.b : *.b
8520 .endd
8521 where &'x.y'& does not match. It's best to avoid negation altogether in
8522 referenced lists if you can.
8523
8524 .cindex "hiding named list values"
8525 .cindex "named lists" "hiding value of"
8526 Some named list definitions may contain sensitive data, for example, passwords for
8527 accessing databases. To stop non-admin users from using the &%-bP%& command
8528 line option to read these values, you can precede the definition with the
8529 word &"hide"&. For example:
8530 .code
8531 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8532 .endd
8533
8534
8535 Named lists may have a performance advantage. When Exim is routing an
8536 address or checking an incoming message, it caches the result of tests on named
8537 lists. So, if you have a setting such as
8538 .code
8539 domains = +local_domains
8540 .endd
8541 on several of your routers
8542 or in several ACL statements,
8543 the actual test is done only for the first one. However, the caching works only
8544 if there are no expansions within the list itself or any sublists that it
8545 references. In other words, caching happens only for lists that are known to be
8546 the same each time they are referenced.
8547
8548 By default, there may be up to 16 named lists of each type. This limit can be
8549 extended by changing a compile-time variable. The use of domain and host lists
8550 is recommended for concepts such as local domains, relay domains, and relay
8551 hosts. The default configuration is set up like this.
8552
8553
8554
8555 .subsection "Named lists compared with macros" SECID78
8556 .cindex "list" "named compared with macro"
8557 .cindex "macro" "compared with named list"
8558 At first sight, named lists might seem to be no different from macros in the
8559 configuration file. However, macros are just textual substitutions. If you
8560 write
8561 .code
8562 ALIST = host1 : host2
8563 auth_advertise_hosts = !ALIST
8564 .endd
8565 it probably won't do what you want, because that is exactly the same as
8566 .code
8567 auth_advertise_hosts = !host1 : host2
8568 .endd
8569 Notice that the second host name is not negated. However, if you use a host
8570 list, and write
8571 .code
8572 hostlist alist = host1 : host2
8573 auth_advertise_hosts = ! +alist
8574 .endd
8575 the negation applies to the whole list, and so that is equivalent to
8576 .code
8577 auth_advertise_hosts = !host1 : !host2
8578 .endd
8579
8580
8581 .subsection "Named list caching" SECID79
8582 .cindex "list" "caching of named"
8583 .cindex "caching" "named lists"
8584 While processing a message, Exim caches the result of checking a named list if
8585 it is sure that the list is the same each time. In practice, this means that
8586 the cache operates only if the list contains no $ characters, which guarantees
8587 that it will not change when it is expanded. Sometimes, however, you may have
8588 an expanded list that you know will be the same each time within a given
8589 message. For example:
8590 .code
8591 domainlist special_domains = \
8592            ${lookup{$sender_host_address}cdb{/some/file}}
8593 .endd
8594 This provides a list of domains that depends only on the sending host's IP
8595 address. If this domain list is referenced a number of times (for example,
8596 in several ACL lines, or in several routers) the result of the check is not
8597 cached by default, because Exim does not know that it is going to be the
8598 same list each time.
8599
8600 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8601 cache the result anyway. For example:
8602 .code
8603 domainlist_cache special_domains = ${lookup{...
8604 .endd
8605 If you do this, you should be absolutely sure that caching is going to do
8606 the right thing in all cases. When in doubt, leave it out.
8607
8608
8609
8610 .section "Domain lists" "SECTdomainlist"
8611 .cindex "domain list" "patterns for"
8612 .cindex "list" "domain list"
8613 Domain lists contain patterns that are to be matched against a mail domain.
8614 The following types of item may appear in domain lists:
8615
8616 .ilist
8617 .cindex "primary host name"
8618 .cindex "host name" "matched in domain list"
8619 .oindex "&%primary_hostname%&"
8620 .cindex "domain list" "matching primary host name"
8621 .cindex "@ in a domain list"
8622 If a pattern consists of a single @ character, it matches the local host name,
8623 as set by the &%primary_hostname%& option (or defaulted). This makes it
8624 possible to use the same configuration file on several different hosts that
8625 differ only in their names.
8626
8627 The value for a match will be the primary host name.
8628
8629
8630 .next
8631 .cindex "@[] in a domain list"
8632 .cindex "domain list" "matching local IP interfaces"
8633 .cindex "domain literal"
8634 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8635 in square brackets (as in an email address that contains a domain literal), but
8636 only if that IP address is recognized as local for email routing purposes. The
8637 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8638 control which of a host's several IP addresses are treated as local.
8639 In today's Internet, the use of domain literals is controversial;
8640 see the &%allow_domain_literals%& main option.
8641
8642 The value for a match will be the string &`@[]`&.
8643
8644
8645 .next
8646 .cindex "@mx_any"
8647 .cindex "@mx_primary"
8648 .cindex "@mx_secondary"
8649 .cindex "domain list" "matching MX pointers to local host"
8650 If a pattern consists of the string &`@mx_any`& it matches any domain that
8651 has an MX record pointing to the local host or to any host that is listed in
8652 .oindex "&%hosts_treat_as_local%&"
8653 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8654 are similar, except that the first matches only when a primary MX target is the
8655 local host, and the second only when no primary MX target is the local host,
8656 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8657 preference value &-- there may of course be more than one of them.
8658
8659 The MX lookup that takes place when matching a pattern of this type is
8660 performed with the resolver options for widening names turned off. Thus, for
8661 example, a single-component domain will &'not'& be expanded by adding the
8662 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8663 options of the &(dnslookup)& router for a discussion of domain widening.
8664
8665 Sometimes you may want to ignore certain IP addresses when using one of these
8666 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8667 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8668 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8669 on a router). For example:
8670 .code
8671 domains = @mx_any/ignore=127.0.0.1
8672 .endd
8673 This example matches any domain that has an MX record pointing to one of
8674 the local host's IP addresses other than 127.0.0.1.
8675
8676 The list of IP addresses is in fact processed by the same code that processes
8677 host lists, so it may contain CIDR-coded network specifications and it may also
8678 contain negative items.
8679
8680 Because the list of IP addresses is a sublist within a domain list, you have to
8681 be careful about delimiters if there is more than one address. Like any other
8682 list, the default delimiter can be changed. Thus, you might have:
8683 .code
8684 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8685           an.other.domain : ...
8686 .endd
8687 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8688 involved, it is easiest to change the delimiter for the main list as well:
8689 .code
8690 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8691           an.other.domain ? ...
8692 .endd
8693 The value for a match will be the list element string (starting &`@mx_`&).
8694
8695
8696 .next
8697 .cindex "asterisk" "in domain list"
8698 .cindex "domain list" "asterisk in"
8699 .cindex "domain list" "matching &""ends with""&"
8700 If a pattern starts with an asterisk, the remaining characters of the pattern
8701 are compared with the terminating characters of the domain. The use of &"*"& in
8702 domain lists differs from its use in partial matching lookups. In a domain
8703 list, the character following the asterisk need not be a dot, whereas partial
8704 matching works only in terms of dot-separated components. For example, a domain
8705 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8706 &'cipher.key.ex'&.
8707
8708 The value for a match will be the list element string (starting with the asterisk).
8709 Additionally, &$0$& will be set to the matched string
8710 and &$1$& to the variable portion which the asterisk matched.
8711
8712 .next
8713 .cindex "regular expressions" "in domain list"
8714 .cindex "domain list" "matching regular expression"
8715 If a pattern starts with a circumflex character, it is treated as a regular
8716 expression, and matched against the domain using a regular expression matching
8717 function. The circumflex is treated as part of the regular expression.
8718 Email domains are case-independent, so this regular expression match is by
8719 default case-independent, but you can make it case-dependent by starting it
8720 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8721 are given in chapter &<<CHAPregexp>>&.
8722
8723 &*Warning*&: Because domain lists are expanded before being processed, you
8724 must escape any backslash and dollar characters in the regular expression, or
8725 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8726 it is not to be expanded (unless you really do want to build a regular
8727 expression by expansion, of course).
8728
8729 The value for a match will be the list element string (starting with the circumflex).
8730 Additionally, &$0$& will be set to the string matching the regular expression,
8731 and &$1$& (onwards) to any submatches identified by parentheses.
8732
8733
8734
8735 .next
8736 .cindex "lookup" "in domain list"
8737 .cindex "domain list" "matching by lookup"
8738 If a pattern starts with the name of a single-key lookup type followed by a
8739 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8740 must be a filename in a suitable format for the lookup type. For example, for
8741 &"cdb;"& it must be an absolute path:
8742 .code
8743 domains = cdb;/etc/mail/local_domains.cdb
8744 .endd
8745 The appropriate type of lookup is done on the file using the domain name as the
8746 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8747 only in whether or not the key is present in the file. However, when a lookup
8748 is used for the &%domains%& option on a router
8749 or a &%domains%& condition in an ACL statement, the value is preserved in the
8750 &$domain_data$& variable and can be referred to in other router options or
8751 other statements in the same ACL.
8752 .cindex "tainted data" "de-tainting"
8753 .cindex "de-tainting" "using ACL domains condition"
8754 The value will be untainted.
8755
8756 &*Note*&: If the data result of the lookup (as opposed to the key)
8757 is empty, then this empty value is stored in &$domain_data$&.
8758 The option to return the key for the lookup, as the value,
8759 may be what is wanted.
8760
8761
8762 .next
8763 Any of the single-key lookup type names may be preceded by
8764 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8765 .code
8766 domains = partial-dbm;/partial/domains
8767 .endd
8768 This causes partial matching logic to be invoked; a description of how this
8769 works is given in section &<<SECTpartiallookup>>&.
8770
8771 .next
8772 .cindex "asterisk" "in lookup type"
8773 Any of the single-key lookup types may be followed by an asterisk. This causes
8774 a default lookup for a key consisting of a single asterisk to be done if the
8775 original lookup fails. This is not a useful feature when using a domain list to
8776 select particular domains (because any domain would match), but it might have
8777 value if the result of the lookup is being used via the &$domain_data$&
8778 expansion variable.
8779
8780 .next
8781 If the pattern starts with the name of a query-style lookup type followed by a
8782 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8783 pattern must be an appropriate query for the lookup type, as described in
8784 chapter &<<CHAPfdlookup>>&. For example:
8785 .code
8786 hold_domains = mysql;select domain from holdlist \
8787   where domain = '${quote_mysql:$domain}';
8788 .endd
8789 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8790 example, it doesn't matter what field you select). Exim is interested only in
8791 whether or not the query succeeds. However, when a lookup is used for the
8792 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8793 variable and can be referred to in other options.
8794 .cindex "tainted data" "de-tainting"
8795 .cindex "de-tainting" "using router domains option"
8796 The value will be untainted.
8797
8798 .next
8799 If the pattern starts with the name of a lookup type
8800 of either kind (single-key or query-style) it may be
8801 followed by a comma and options,
8802 The options are lookup-type specific and consist of a comma-separated list.
8803 Each item starts with a tag and and equals "=" sign.
8804
8805 .next
8806 .cindex "domain list" "matching literal domain name"
8807 If none of the above cases apply, a caseless textual comparison is made
8808 between the pattern and the domain.
8809
8810 The value for a match will be the list element string.
8811 .cindex "tainted data" "de-tainting"
8812 Note that this is commonly untainted
8813 (depending on the way the list was created).
8814 Specifically, explicit text in the configuration file in not tainted.
8815 This is a useful way of obtaining an untainted equivalent to
8816 the domain, for later operations.
8817
8818 However if the list (including one-element lists)
8819 is created by expanding a variable containing tainted data,
8820 it is tainted and so will the match value be.
8821 .endlist
8822
8823
8824 Here is an example that uses several different kinds of pattern:
8825 .code
8826 domainlist funny_domains = \
8827   @ : \
8828   lib.unseen.edu : \
8829   *.foundation.fict.example : \
8830   \N^[1-2]\d{3}\.fict\.example$\N : \
8831   partial-dbm;/opt/data/penguin/book : \
8832   nis;domains.byname : \
8833   nisplus;[name=$domain,status=local],domains.org_dir
8834 .endd
8835 There are obvious processing trade-offs among the various matching modes. Using
8836 an asterisk is faster than a regular expression, and listing a few names
8837 explicitly probably is too. The use of a file or database lookup is expensive,
8838 but may be the only option if hundreds of names are required. Because the
8839 patterns are tested in order, it makes sense to put the most commonly matched
8840 patterns earlier.
8841
8842
8843
8844 .section "Host lists" "SECThostlist"
8845 .cindex "host list" "patterns in"
8846 .cindex "list" "host list"
8847 Host lists are used to control what remote hosts are allowed to do. For
8848 example, some hosts may be allowed to use the local host as a relay, and some
8849 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8850 two different ways, by name or by IP address. In a host list, some types of
8851 pattern are matched to a host name, and some are matched to an IP address.
8852 You need to be particularly careful with this when single-key lookups are
8853 involved, to ensure that the right value is being used as the key.
8854
8855
8856 .subsection "Special host list patterns" SECID80
8857 .cindex "empty item in hosts list"
8858 .cindex "host list" "empty string in"
8859 If a host list item is the empty string, it matches only when no remote host is
8860 involved. This is the case when a message is being received from a local
8861 process using SMTP on the standard input, that is, when a TCP/IP connection is
8862 not used.
8863
8864 .cindex "asterisk" "in host list"
8865 The special pattern &"*"& in a host list matches any host or no host. Neither
8866 the IP address nor the name is actually inspected.
8867
8868
8869
8870 .subsection "Host list patterns that match by IP address" SECThoslispatip
8871 .cindex "host list" "matching IP addresses"
8872 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8873 the incoming address actually appears in the IPv6 host as
8874 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8875 list, it is converted into a traditional IPv4 address first. (Not all operating
8876 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8877 concerns.)
8878
8879 The following types of pattern in a host list check the remote host by
8880 inspecting its IP address:
8881
8882 .ilist
8883 If the pattern is a plain domain name (not a regular expression, not starting
8884 with *, not a lookup of any kind), Exim calls the operating system function
8885 to find the associated IP address(es). Exim uses the newer
8886 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8887 This typically causes a forward DNS lookup of the name. The result is compared
8888 with the IP address of the subject host.
8889
8890 If there is a temporary problem (such as a DNS timeout) with the host name
8891 lookup, a temporary error occurs. For example, if the list is being used in an
8892 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8893 temporary SMTP error code. If no IP address can be found for the host name,
8894 what happens is described in section &<<SECTbehipnot>>& below.
8895
8896 .next
8897 .cindex "@ in a host list"
8898 If the pattern is &"@"&, the primary host name is substituted and used as a
8899 domain name, as just described.
8900
8901 .next
8902 If the pattern is an IP address, it is matched against the IP address of the
8903 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8904 IPv6 addresses can be given in colon-separated format, but the colons have to
8905 be doubled so as not to be taken as item separators when the default list
8906 separator is used. IPv6 addresses are recognized even when Exim is compiled
8907 without IPv6 support. This means that if they appear in a host list on an
8908 IPv4-only host, Exim will not treat them as host names. They are just addresses
8909 that can never match a client host.
8910
8911 .next
8912 .cindex "@[] in a host list"
8913 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8914 the local host. For example, if the local host is an IPv4 host with one
8915 interface address 10.45.23.56, these two ACL statements have the same effect:
8916 .code
8917 accept hosts = 127.0.0.1 : 10.45.23.56
8918 accept hosts = @[]
8919 .endd
8920 .next
8921 .cindex "CIDR notation"
8922 If the pattern is an IP address followed by a slash and a mask length, for
8923 example
8924 .code
8925 10.11.42.0/24
8926 .endd
8927 , it is matched against the IP address of the subject
8928 host under the given mask. This allows an entire network of hosts to be
8929 included (or excluded) by a single item. The mask uses CIDR notation; it
8930 specifies the number of address bits that must match, starting from the most
8931 significant end of the address.
8932
8933 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8934 of a range of addresses. It is the number of bits in the network portion of the
8935 address. The above example specifies a 24-bit netmask, so it matches all 256
8936 addresses in the 10.11.42.0 network. An item such as
8937 .code
8938 192.168.23.236/31
8939 .endd
8940 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8941 32 for an IPv4 address is the same as no mask at all; just a single address
8942 matches.
8943
8944 Here is another example which shows an IPv4 and an IPv6 network:
8945 .code
8946 recipient_unqualified_hosts = 192.168.0.0/16: \
8947                               3ffe::ffff::836f::::/48
8948 .endd
8949 The doubling of list separator characters applies only when these items
8950 appear inline in a host list. It is not required when indirecting via a file.
8951 For example:
8952 .code
8953 recipient_unqualified_hosts = /opt/exim/unqualnets
8954 .endd
8955 could make use of a file containing
8956 .code
8957 172.16.0.0/12
8958 3ffe:ffff:836f::/48
8959 .endd
8960 to have exactly the same effect as the previous example. When listing IPv6
8961 addresses inline, it is usually more convenient to use the facility for
8962 changing separator characters. This list contains the same two networks:
8963 .code
8964 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8965                                  3ffe:ffff:836f::/48
8966 .endd
8967 The separator is changed to semicolon by the leading &"<;"& at the start of the
8968 list.
8969 .endlist
8970
8971
8972
8973 .subsection "Host list patterns for single-key lookups by host address" &&&
8974          SECThoslispatsikey
8975 .cindex "host list" "lookup of IP address"
8976 When a host is to be identified by a single-key lookup of its complete IP
8977 address, the pattern takes this form:
8978 .display
8979 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8980 .endd
8981 For example:
8982 .code
8983 hosts_lookup = net-cdb;/hosts-by-ip.db
8984 .endd
8985 The text form of the IP address of the subject host is used as the lookup key.
8986 IPv6 addresses are converted to an unabbreviated form, using lower case
8987 letters, with dots as separators because colon is the key terminator in
8988 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8989 quoting the keys, but this is a facility that was added later.] The data
8990 returned by the lookup is not used.
8991
8992 .cindex "IP address" "masking"
8993 .cindex "host list" "masked IP address"
8994 Single-key lookups can also be performed using masked IP addresses, using
8995 patterns of this form:
8996 .display
8997 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8998 .endd
8999 For example:
9000 .code
9001 net24-dbm;/networks.db
9002 .endd
9003 The IP address of the subject host is masked using <&'number'&> as the mask
9004 length. A textual string is constructed from the masked value, followed by the
9005 mask, and this is used as the lookup key. For example, if the host's IP address
9006 is 192.168.34.6, the key that is looked up for the above example is
9007 &"192.168.34.0/24"&.
9008
9009 When an IPv6 address is converted to a string, dots are normally used instead
9010 of colons, so that keys in &(lsearch)& files need not contain colons (which
9011 terminate &(lsearch)& keys). This was implemented some time before the ability
9012 to quote keys was made available in &(lsearch)& files. However, the more
9013 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9014 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9015 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9016 converted using colons and not dots.
9017 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9018 addresses are always used.
9019 The latter are converted to IPv4 addresses, in dotted-quad form.
9020
9021 Ideally, it would be nice to tidy up this anomalous situation by changing to
9022 colons in all cases, given that quoting is now available for &(lsearch)&.
9023 However, this would be an incompatible change that might break some existing
9024 configurations.
9025
9026 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9027 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9028 the former case the key strings include the mask value, whereas in the latter
9029 case the IP address is used on its own.
9030
9031
9032
9033 .subsection "Host list patterns that match by host name" SECThoslispatnam
9034 .cindex "host" "lookup failures"
9035 .cindex "unknown host name"
9036 .cindex "host list" "matching host name"
9037 There are several types of pattern that require Exim to know the name of the
9038 remote host. These are either wildcard patterns or lookups by name. (If a
9039 complete hostname is given without any wildcarding, it is used to find an IP
9040 address to match against, as described in section &<<SECThoslispatip>>&
9041 above.)
9042
9043 If the remote host name is not already known when Exim encounters one of these
9044 patterns, it has to be found from the IP address.
9045 Although many sites on the Internet are conscientious about maintaining reverse
9046 DNS data for their hosts, there are also many that do not do this.
9047 Consequently, a name cannot always be found, and this may lead to unwanted
9048 effects. Take care when configuring host lists with wildcarded name patterns.
9049 Consider what will happen if a name cannot be found.
9050
9051 Because of the problems of determining host names from IP addresses, matching
9052 against host names is not as common as matching against IP addresses.
9053
9054 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9055 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9056 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9057 are done can be changed by setting the &%host_lookup_order%& option. For
9058 security, once Exim has found one or more names, it looks up the IP addresses
9059 for these names and compares them with the IP address that it started with.
9060 Only those names whose IP addresses match are accepted. Any other names are
9061 discarded. If no names are left, Exim behaves as if the host name cannot be
9062 found. In the most common case there is only one name and one IP address.
9063
9064 There are some options that control what happens if a host name cannot be
9065 found. These are described in section &<<SECTbehipnot>>& below.
9066
9067 .cindex "host" "alias for"
9068 .cindex "alias for host"
9069 As a result of aliasing, hosts may have more than one name. When processing any
9070 of the following types of pattern, all the host's names are checked:
9071
9072 .ilist
9073 .cindex "asterisk" "in host list"
9074 If a pattern starts with &"*"& the remainder of the item must match the end of
9075 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9076 &'.b.c'&. This special simple form is provided because this is a very common
9077 requirement. Other kinds of wildcarding require the use of a regular
9078 expression.
9079 .next
9080 .cindex "regular expressions" "in host list"
9081 .cindex "host list" "regular expression in"
9082 If the item starts with &"^"& it is taken to be a regular expression which is
9083 matched against the host name. Host names are case-independent, so this regular
9084 expression match is by default case-independent, but you can make it
9085 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9086 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9087 example,
9088 .code
9089 ^(a|b)\.c\.d$
9090 .endd
9091 is a regular expression that matches either of the two hosts &'a.c.d'& or
9092 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9093 that backslash and dollar characters are not misinterpreted as part of the
9094 string expansion. The simplest way to do this is to use &`\N`& to mark that
9095 part of the string as non-expandable. For example:
9096 .code
9097 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9098 .endd
9099 &*Warning*&: If you want to match a complete host name, you must include the
9100 &`$`& terminating metacharacter in the regular expression, as in the above
9101 example. Without it, a match at the start of the host name is all that is
9102 required.
9103 .endlist
9104
9105
9106
9107
9108 .subsection "Behaviour when an IP address or name cannot be found" SECTbehipnot
9109 .cindex "host" "lookup failures, permanent"
9110 While processing a host list, Exim may need to look up an IP address from a
9111 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9112 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9113 behaviour when it fails to find the information it is seeking is the same.
9114
9115 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9116 apply to temporary DNS errors, whose handling is described in the next section.
9117
9118 .cindex "&`+include_unknown`&"
9119 .cindex "&`+ignore_unknown`&"
9120 Exim parses a host list from left to right. If it encounters a permanent
9121 lookup failure in any item in the host list before it has found a match,
9122 Exim treats it as a failure and the default behavior is as if the host
9123 does not match the list. This may not always be what you want to happen.
9124 To change Exim's behaviour, the special items &`+include_unknown`& or
9125 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9126 not recognized in an indirected file).
9127
9128 .ilist
9129 If any item that follows &`+include_unknown`& requires information that
9130 cannot found, Exim behaves as if the host does match the list. For example,
9131 .code
9132 host_reject_connection = +include_unknown:*.enemy.ex
9133 .endd
9134 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9135 any hosts whose name it cannot find.
9136
9137 .next
9138 If any item that follows &`+ignore_unknown`& requires information that cannot
9139 be found, Exim ignores that item and proceeds to the rest of the list. For
9140 example:
9141 .code
9142 accept hosts = +ignore_unknown : friend.example : \
9143                192.168.4.5
9144 .endd
9145 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9146 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9147 name can be found for 192.168.4.5, it is rejected.
9148 .endlist
9149
9150 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9151 list. The effect of each one lasts until the next, or until the end of the
9152 list.
9153
9154 .subsection "Mixing wildcarded host names and addresses in host lists" &&&
9155          SECTmixwilhos
9156 .cindex "host list" "mixing names and addresses in"
9157
9158 This section explains the host/ip processing logic with the same concepts
9159 as the previous section, but specifically addresses what happens when a
9160 wildcarded hostname is one of the items in the hostlist.
9161
9162 .ilist
9163 If you have name lookups or wildcarded host names and
9164 IP addresses in the same host list, you should normally put the IP
9165 addresses first. For example, in an ACL you could have:
9166 .code
9167 accept hosts = 10.9.8.7 : *.friend.example
9168 .endd
9169 The reason you normally would order it this way lies in the
9170 left-to-right way that Exim processes lists.  It can test IP addresses
9171 without doing any DNS lookups, but when it reaches an item that requires
9172 a host name, it fails if it cannot find a host name to compare with the
9173 pattern. If the above list is given in the opposite order, the
9174 &%accept%& statement fails for a host whose name cannot be found, even
9175 if its IP address is 10.9.8.7.
9176
9177 .next
9178 If you really do want to do the name check first, and still recognize the IP
9179 address, you can rewrite the ACL like this:
9180 .code
9181 accept hosts = *.friend.example
9182 accept hosts = 10.9.8.7
9183 .endd
9184 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9185 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9186 &`+ignore_unknown`&, which was discussed in depth in the first example in
9187 this section.
9188 .endlist
9189
9190
9191 .subsection "Temporary DNS errors when looking up host information" &&&
9192          SECTtemdnserr
9193 .cindex "host" "lookup failures, temporary"
9194 .cindex "&`+include_defer`&"
9195 .cindex "&`+ignore_defer`&"
9196 A temporary DNS lookup failure normally causes a defer action (except when
9197 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9198 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9199 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9200 section. These options should be used with care, probably only in non-critical
9201 host lists such as whitelists.
9202
9203
9204
9205 .subsection "Host list patterns for single-key lookups by host name" &&&
9206          SECThoslispatnamsk
9207 .cindex "unknown host name"
9208 .cindex "host list" "matching host name"
9209 If a pattern is of the form
9210 .display
9211 <&'single-key-search-type'&>;<&'search-data'&>
9212 .endd
9213 for example
9214 .code
9215 dbm;/host/accept/list
9216 .endd
9217 a single-key lookup is performed, using the host name as its key. If the
9218 lookup succeeds, the host matches the item. The actual data that is looked up
9219 is not used.
9220
9221 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9222 keys in the file, not IP addresses. If you want to do lookups based on IP
9223 addresses, you must precede the search type with &"net-"& (see section
9224 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9225 two items in the same list, one doing an address lookup and one doing a name
9226 lookup, both using the same file.
9227
9228
9229
9230 .subsection "Host list patterns for query-style lookups" SECID81
9231 If a pattern is of the form
9232 .display
9233 <&'query-style-search-type'&>;<&'query'&>
9234 .endd
9235 the query is obeyed, and if it succeeds, the host matches the item. The actual
9236 data that is looked up is not used. The variables &$sender_host_address$& and
9237 &$sender_host_name$& can be used in the query. For example:
9238 .code
9239 hosts_lookup = pgsql;\
9240   select ip from hostlist where ip='$sender_host_address'
9241 .endd
9242 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9243 can use the &%sg%& expansion item to change this if you need to. If you want to
9244 use masked IP addresses in database queries, you can use the &%mask%& expansion
9245 operator.
9246
9247 If the query contains a reference to &$sender_host_name$&, Exim automatically
9248 looks up the host name if it has not already done so. (See section
9249 &<<SECThoslispatnam>>& for comments on finding host names.)
9250
9251 Historical note: prior to release 4.30, Exim would always attempt to find a
9252 host name before running the query, unless the search type was preceded by
9253 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9254 still recognized for query-style lookups, but its presence or absence has no
9255 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9256 See section &<<SECThoslispatsikey>>&.)
9257
9258
9259
9260
9261
9262 .section "Address lists" "SECTaddresslist"
9263 .cindex "list" "address list"
9264 .cindex "address list" "empty item"
9265 .cindex "address list" "patterns"
9266 Address lists contain patterns that are matched against mail addresses. There
9267 is one special case to be considered: the sender address of a bounce message is
9268 always empty. You can test for this by providing an empty item in an address
9269 list. For example, you can set up a router to process bounce messages by
9270 using this option setting:
9271 .code
9272 senders = :
9273 .endd
9274 The presence of the colon creates an empty item. If you do not provide any
9275 data, the list is empty and matches nothing. The empty sender can also be
9276 detected by a regular expression that matches an empty string,
9277 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9278
9279 Non-empty items in an address list can be straightforward email addresses. For
9280 example:
9281 .code
9282 senders = jbc@askone.example : hs@anacreon.example
9283 .endd
9284 A certain amount of wildcarding is permitted. If a pattern contains an @
9285 character, but is not a regular expression and does not begin with a
9286 semicolon-terminated lookup type (described below), the local part of the
9287 subject address is compared with the local part of the pattern, which may start
9288 with an asterisk. If the local parts match, the domain is checked in exactly
9289 the same way as for a pattern in a domain list. For example, the domain can be
9290 wildcarded, refer to a named list, or be a lookup:
9291 .code
9292 deny senders = *@*.spamming.site:\
9293                *@+hostile_domains:\
9294                bozo@partial-lsearch;/list/of/dodgy/sites:\
9295                *@dbm;/bad/domains.db
9296 .endd
9297 .cindex "local part" "starting with !"
9298 .cindex "address list" "local part starting with !"
9299 If a local part that begins with an exclamation mark is required, it has to be
9300 specified using a regular expression, because otherwise the exclamation mark is
9301 treated as a sign of negation, as is standard in lists.
9302
9303 If a non-empty pattern that is not a regular expression or a lookup does not
9304 contain an @ character, it is matched against the domain part of the subject
9305 address. The only two formats that are recognized this way are a literal
9306 domain, or a domain pattern that starts with *. In both these cases, the effect
9307 is the same as if &`*@`& preceded the pattern. For example:
9308 .code
9309 deny senders = enemy.domain : *.enemy.domain
9310 .endd
9311
9312 The following kinds of more complicated address list pattern can match any
9313 address, including the empty address that is characteristic of bounce message
9314 senders:
9315
9316 .ilist
9317 .cindex "regular expressions" "in address list"
9318 .cindex "address list" "regular expression in"
9319 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9320 done against the complete address, with the pattern as the regular expression.
9321 You must take care that backslash and dollar characters are not misinterpreted
9322 as part of the string expansion. The simplest way to do this is to use &`\N`&
9323 to mark that part of the string as non-expandable. For example:
9324 .code
9325 deny senders = \N^.*this.*@example\.com$\N : \
9326                \N^\d{8}.+@spamhaus.example$\N : ...
9327 .endd
9328 The &`\N`& sequences are removed by the expansion, so these items do indeed
9329 start with &"^"& by the time they are being interpreted as address patterns.
9330
9331 .next
9332 .cindex "address list" "lookup for complete address"
9333 Complete addresses can be looked up by using a pattern that starts with a
9334 lookup type terminated by a semicolon, followed by the data for the lookup. For
9335 example:
9336 .code
9337 deny senders = cdb;/etc/blocked.senders : \
9338   mysql;select address from blocked where \
9339   address='${quote_mysql:$sender_address}'
9340 .endd
9341 Both query-style and single-key lookup types can be used. For a single-key
9342 lookup type, Exim uses the complete address as the key. However, empty keys are
9343 not supported for single-key lookups, so a match against the empty address
9344 always fails. This restriction does not apply to query-style lookups.
9345
9346 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9347 cannot be used, and is ignored if specified, with an entry being written to the
9348 panic log.
9349 .cindex "*@ with single-key lookup"
9350 However, you can configure lookup defaults, as described in section
9351 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9352 default. For example, with this lookup:
9353 .code
9354 accept senders = lsearch*@;/some/file
9355 .endd
9356 the file could contains lines like this:
9357 .code
9358 user1@domain1.example
9359 *@domain2.example
9360 .endd
9361 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9362 that are tried is:
9363 .code
9364 nimrod@jaeger.example
9365 *@jaeger.example
9366 *
9367 .endd
9368 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9369 would mean that every address matches, thus rendering the test useless.
9370
9371 &*Warning 2*&: Do not confuse these two kinds of item:
9372 .code
9373 deny recipients = dbm*@;/some/file
9374 deny recipients = *@dbm;/some/file
9375 .endd
9376 The first does a whole address lookup, with defaulting, as just described,
9377 because it starts with a lookup type. The second matches the local part and
9378 domain independently, as described in a bullet point below.
9379 .endlist
9380
9381
9382 The following kinds of address list pattern can match only non-empty addresses.
9383 If the subject address is empty, a match against any of these pattern types
9384 always fails.
9385
9386
9387 .ilist
9388 .cindex "@@ with single-key lookup"
9389 .cindex "address list" "@@ lookup type"
9390 .cindex "address list" "split local part and domain"
9391 If a pattern starts with &"@@"& followed by a single-key lookup item
9392 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9393 split into a local part and a domain. The domain is looked up in the file. If
9394 it is not found, there is no match. If it is found, the data that is looked up
9395 from the file is treated as a colon-separated list of local part patterns, each
9396 of which is matched against the subject local part in turn.
9397
9398 .cindex "asterisk" "in address list"
9399 The lookup may be a partial one, and/or one involving a search for a default
9400 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9401 patterns that are looked up can be regular expressions or begin with &"*"&, or
9402 even be further lookups. They may also be independently negated. For example,
9403 with
9404 .code
9405 deny senders = @@dbm;/etc/reject-by-domain
9406 .endd
9407 the data from which the DBM file is built could contain lines like
9408 .code
9409 baddomain.com:  !postmaster : *
9410 .endd
9411 to reject all senders except &%postmaster%& from that domain.
9412
9413 .cindex "local part" "starting with !"
9414 If a local part that actually begins with an exclamation mark is required, it
9415 has to be specified using a regular expression. In &(lsearch)& files, an entry
9416 may be split over several lines by indenting the second and subsequent lines,
9417 but the separating colon must still be included at line breaks. White space
9418 surrounding the colons is ignored. For example:
9419 .code
9420 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9421   spammer3 : spammer4
9422 .endd
9423 As in all colon-separated lists in Exim, a colon can be included in an item by
9424 doubling.
9425
9426 If the last item in the list starts with a right angle-bracket, the remainder
9427 of the item is taken as a new key to look up in order to obtain a continuation
9428 list of local parts. The new key can be any sequence of characters. Thus one
9429 might have entries like
9430 .code
9431 aol.com: spammer1 : spammer 2 : >*
9432 xyz.com: spammer3 : >*
9433 *:       ^\d{8}$
9434 .endd
9435 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9436 local parts for all domains, in addition to the specific local parts listed for
9437 each domain. Of course, using this feature costs another lookup each time a
9438 chain is followed, but the effort needed to maintain the data is reduced.
9439
9440 .cindex "loop" "in lookups"
9441 It is possible to construct loops using this facility, and in order to catch
9442 them, the chains may be no more than fifty items long.
9443
9444 .next
9445 The @@<&'lookup'&> style of item can also be used with a query-style
9446 lookup, but in this case, the chaining facility is not available. The lookup
9447 can only return a single list of local parts.
9448 .endlist
9449
9450 &*Warning*&: There is an important difference between the address list items
9451 in these two examples:
9452 .code
9453 senders = +my_list
9454 senders = *@+my_list
9455 .endd
9456 In the first one, &`my_list`& is a named address list, whereas in the second
9457 example it is a named domain list.
9458
9459
9460
9461
9462 .subsection "Case of letters in address lists" SECTcasletadd
9463 .cindex "case of local parts"
9464 .cindex "address list" "case forcing"
9465 .cindex "case forcing in address lists"
9466 Domains in email addresses are always handled caselessly, but for local parts
9467 case may be significant on some systems (see &%caseful_local_part%& for how
9468 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9469 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9470 blocking lists should be done in a case-independent manner. Since most address
9471 lists in Exim are used for this kind of control, Exim attempts to do this by
9472 default.
9473
9474 The domain portion of an address is always lowercased before matching it to an
9475 address list. The local part is lowercased by default, and any string
9476 comparisons that take place are done caselessly. This means that the data in
9477 the address list itself, in files included as plain filenames, and in any file
9478 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9479 keys in files that are looked up by a search type other than &(lsearch)& (which
9480 works caselessly) must be in lower case, because these lookups are not
9481 case-independent.
9482
9483 .cindex "&`+caseful`&"
9484 To allow for the possibility of caseful address list matching, if an item in
9485 an address list is the string &"+caseful"&, the original case of the local
9486 part is restored for any comparisons that follow, and string comparisons are no
9487 longer case-independent. This does not affect the domain, which remains in
9488 lower case. However, although independent matches on the domain alone are still
9489 performed caselessly, regular expressions that match against an entire address
9490 become case-sensitive after &"+caseful"& has been seen.
9491
9492
9493
9494 .section "Local part lists" "SECTlocparlis"
9495 .cindex "list" "local part list"
9496 .cindex "local part" "list"
9497 These behave in the same way as domain and host lists, with the following
9498 changes:
9499
9500 Case-sensitivity in local part lists is handled in the same way as for address
9501 lists, as just described. The &"+caseful"& item can be used if required. In a
9502 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9503 set false, the subject is lowercased and the matching is initially
9504 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9505 matching in the local part list, but not elsewhere in the router. If
9506 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9507 option is case-sensitive from the start.
9508
9509 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9510 comments are handled in the same way as address lists &-- they are recognized
9511 only if the # is preceded by white space or the start of the line.
9512 Otherwise, local part lists are matched in the same way as domain lists, except
9513 that the special items that refer to the local host (&`@`&, &`@[]`&,
9514 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9515 Refer to section &<<SECTdomainlist>>& for details of the other available item
9516 types.
9517 .ecindex IIDdohoadli
9518
9519
9520
9521
9522 . ////////////////////////////////////////////////////////////////////////////
9523 . ////////////////////////////////////////////////////////////////////////////
9524
9525 .chapter "String expansions" "CHAPexpand"
9526 .scindex IIDstrexp "expansion" "of strings"
9527 Many strings in Exim's runtime configuration are expanded before use. Some of
9528 them are expanded every time they are used; others are expanded only once.
9529
9530 When a string is being expanded it is copied verbatim from left to right except
9531 .cindex expansion "string concatenation"
9532 when a dollar or backslash character is encountered. A dollar specifies the
9533 start of a portion of the string that is interpreted and replaced as described
9534 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9535 escape character, as described in the following section.
9536
9537 Whether a string is expanded depends upon the context.  Usually this is solely
9538 dependent upon the option for which a value is sought; in this documentation,
9539 options for which string expansion is performed are marked with &dagger; after
9540 the data type.  ACL rules always expand strings.  A couple of expansion
9541 conditions do not expand some of the brace-delimited branches, for security
9542 reasons,
9543 .cindex "tainted data" expansion
9544 .cindex "tainted data" definition
9545 .cindex expansion "tainted data"
9546 and expansion of data deriving from the sender (&"tainted data"&)
9547 is not permitted (including acessing a file using a tainted name).
9548
9549 Common ways of obtaining untainted equivalents of variables with
9550 tainted values
9551 .cindex "tainted data" "de-tainting"
9552 come down to using the tainted value as a lookup key in a trusted database.
9553 This database could be the filesystem structure,
9554 or the password file,
9555 or accessed via a DBMS.
9556 Specific methods are indexed under &"de-tainting"&.
9557
9558
9559
9560 .section "Literal text in expanded strings" "SECTlittext"
9561 .cindex "expansion" "including literal text"
9562 An uninterpreted dollar can be included in an expanded string by putting a
9563 backslash in front of it. A backslash can be used to prevent any special
9564 character being treated specially in an expansion, including backslash itself.
9565 If the string appears in quotes in the configuration file, two backslashes are
9566 required because the quotes themselves cause interpretation of backslashes when
9567 the string is read in (see section &<<SECTstrings>>&).
9568
9569 .cindex "expansion" "non-expandable substrings"
9570 A portion of the string can specified as non-expandable by placing it between
9571 two occurrences of &`\N`&. This is particularly useful for protecting regular
9572 expressions, which often contain backslashes and dollar signs. For example:
9573 .code
9574 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9575 .endd
9576 On encountering the first &`\N`&, the expander copies subsequent characters
9577 without interpretation until it reaches the next &`\N`& or the end of the
9578 string.
9579
9580
9581
9582 .section "Character escape sequences in expanded strings" "SECID82"
9583 .cindex "expansion" "escape sequences"
9584 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9585 expanded string is recognized as an escape sequence for the character newline,
9586 carriage return, or tab, respectively. A backslash followed by up to three
9587 octal digits is recognized as an octal encoding for a single character, and a
9588 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9589 encoding.
9590
9591 These escape sequences are also recognized in quoted strings when they are read
9592 in. Their interpretation in expansions as well is useful for unquoted strings,
9593 and for other cases such as looked-up strings that are then expanded.
9594
9595
9596 .section "Testing string expansions" "SECID83"
9597 .cindex "expansion" "testing"
9598 .cindex "testing" "string expansion"
9599 .oindex "&%-be%&"
9600 Many expansions can be tested by calling Exim with the &%-be%& option. This
9601 takes the command arguments, or lines from the standard input if there are no
9602 arguments, runs them through the string expansion code, and writes the results
9603 to the standard output. Variables based on configuration values are set up, but
9604 since no message is being processed, variables such as &$local_part$& have no
9605 value. Nevertheless the &%-be%& option can be useful for checking out file and
9606 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9607 and &%nhash%&.
9608
9609 When reading lines from the standard input,
9610 macros can be defined and ACL variables can be set.
9611 For example:
9612 .code
9613 MY_MACRO = foo
9614 set acl_m_myvar = bar
9615 .endd
9616 Such macros and variables can then be used in later input lines.
9617
9618 Exim gives up its root privilege when it is called with the &%-be%& option, and
9619 instead runs under the uid and gid it was called with, to prevent users from
9620 using &%-be%& for reading files to which they do not have access.
9621
9622 .oindex "&%-bem%&"
9623 If you want to test expansions that include variables whose values are taken
9624 from a message, there are two other options that can be used. The &%-bem%&
9625 option is like &%-be%& except that it is followed by a filename. The file is
9626 read as a message before doing the test expansions. For example:
9627 .code
9628 exim -bem /tmp/test.message '$h_subject:'
9629 .endd
9630 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9631 Exim message identifier. For example:
9632 .code
9633 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9634 .endd
9635 This loads the message from Exim's spool before doing the test expansions, and
9636 is therefore restricted to admin users.
9637
9638
9639 .section "Forced expansion failure" "SECTforexpfai"
9640 .cindex "expansion" "forced failure"
9641 A number of expansions that are described in the following section have
9642 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9643 (which are sometimes called &"curly brackets"&). Which of the two strings is
9644 used depends on some condition that is evaluated as part of the expansion. If,
9645 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9646 the entire string expansion fails in a way that can be detected by the code
9647 that requested the expansion. This is called &"forced expansion failure"&, and
9648 its consequences depend on the circumstances. In some cases it is no different
9649 from any other expansion failure, but in others a different action may be
9650 taken. Such variations are mentioned in the documentation of the option that is
9651 being expanded.
9652
9653
9654
9655
9656 .section "Expansion items" "SECTexpansionitems"
9657 The following items are recognized in expanded strings. White space may be used
9658 between sub-items that are keywords or substrings enclosed in braces inside an
9659 outer set of braces, to improve readability. &*Warning*&: Within braces,
9660 white space is significant.
9661
9662 .vlist
9663 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9664 .cindex "expansion" "variables"
9665 Substitute the contents of the named variable, for example:
9666 .code
9667 $local_part
9668 ${domain}
9669 .endd
9670 The second form can be used to separate the name from subsequent alphanumeric
9671 characters. This form (using braces) is available only for variables; it does
9672 &'not'& apply to message headers. The names of the variables are given in
9673 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9674 given, the expansion fails.
9675
9676 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9677 .cindex "expansion" "operators"
9678 The string is first itself expanded, and then the operation specified by
9679 <&'op'&> is applied to it. For example:
9680 .code
9681 ${lc:$local_part}
9682 .endd
9683 The string starts with the first character after the colon, which may be
9684 leading white space. A list of operators is given in section &<<SECTexpop>>&
9685 below. The operator notation is used for simple expansion items that have just
9686 one argument, because it reduces the number of braces and therefore makes the
9687 string easier to understand.
9688
9689 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9690 This item inserts &"basic"& header lines. It is described with the &%header%&
9691 expansion item below.
9692
9693
9694 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9695 .cindex "expansion" "calling an acl"
9696 .cindex "&%acl%&" "call from expansion"
9697 The name and zero to nine argument strings are first expanded separately.  The expanded
9698 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9699 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9700 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9701 and may use the variables; if another acl expansion is used the values
9702 are restored after it returns.  If the ACL sets
9703 a value using a "message =" modifier and returns accept or deny, the value becomes
9704 the result of the expansion.
9705 If no message is set and the ACL returns accept or deny
9706 the expansion result is an empty string.
9707 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9708
9709
9710 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9711 .cindex authentication "results header"
9712 .chindex Authentication-Results:
9713 .cindex authentication "expansion item"
9714 This item returns a string suitable for insertion as an
9715 &'Authentication-Results:'&
9716 header line.
9717 The given <&'authserv-id'&> is included in the result; typically this
9718 will be a domain name identifying the system performing the authentications.
9719 Methods that might be present in the result include:
9720 .code
9721 none
9722 iprev
9723 auth
9724 spf
9725 dkim
9726 .endd
9727
9728 Example use (as an ACL modifier):
9729 .code
9730       add_header = :at_start:${authresults {$primary_hostname}}
9731 .endd
9732 This is safe even if no authentication results are available
9733 and would generally be placed in the DATA ACL.
9734
9735
9736 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9737        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9738 .cindex "expansion" "extracting certificate fields"
9739 .cindex "&%certextract%&" "certificate fields"
9740 .cindex "certificate" "extracting fields"
9741 The <&'certificate'&> must be a variable of type certificate.
9742 The field name is expanded and used to retrieve the relevant field from
9743 the certificate.  Supported fields are:
9744 .display
9745 &`version        `&
9746 &`serial_number  `&
9747 &`subject        `& RFC4514 DN
9748 &`issuer         `& RFC4514 DN
9749 &`notbefore      `& time
9750 &`notafter       `& time
9751 &`sig_algorithm  `&
9752 &`signature      `&
9753 &`subj_altname   `& tagged list
9754 &`ocsp_uri       `& list
9755 &`crl_uri        `& list
9756 .endd
9757 If the field is found,
9758 <&'string2'&> is expanded, and replaces the whole item;
9759 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9760 variable &$value$& contains the value that has been extracted. Afterwards, it
9761 is restored to any previous value it might have had.
9762
9763 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9764 key is not found. If {<&'string2'&>} is also omitted, the value that was
9765 extracted is used.
9766
9767 Some field names take optional modifiers, appended and separated by commas.
9768
9769 The field selectors marked as "RFC4514" above
9770 output a Distinguished Name string which is
9771 not quite
9772 parseable by Exim as a comma-separated tagged list
9773 (the exceptions being elements containing commas).
9774 RDN elements of a single type may be selected by
9775 a modifier of the type label; if so the expansion
9776 result is a list (newline-separated by default).
9777 The separator may be changed by another modifier of
9778 a right angle-bracket followed immediately by the new separator.
9779 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9780
9781 The field selectors marked as "time" above
9782 take an optional modifier of "int"
9783 for which the result is the number of seconds since epoch.
9784 Otherwise the result is a human-readable string
9785 in the timezone selected by the main "timezone" option.
9786
9787 The field selectors marked as "list" above return a list,
9788 newline-separated by default,
9789 (embedded separator characters in elements are doubled).
9790 The separator may be changed by a modifier of
9791 a right angle-bracket followed immediately by the new separator.
9792
9793 The field selectors marked as "tagged" above
9794 prefix each list element with a type string and an equals sign.
9795 Elements of only one type may be selected by a modifier
9796 which is one of "dns", "uri" or "mail";
9797 if so the element tags are omitted.
9798
9799 If not otherwise noted field values are presented in human-readable form.
9800
9801 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9802        {*&<&'arg'&>&*}...}*&"
9803 .cindex &%dlfunc%&
9804 This expansion dynamically loads and then calls a locally-written C function.
9805 This functionality is available only if Exim is compiled with
9806 .code
9807 EXPAND_DLFUNC=yes
9808 .endd
9809 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9810 object so that it doesn't reload the same object file in the same Exim process
9811 (but of course Exim does start new processes frequently).
9812
9813 There may be from zero to eight arguments to the function.
9814
9815 When compiling
9816 a local function that is to be called in this way,
9817 first &_DLFUNC_IMPL_& should be defined,
9818 and second &_local_scan.h_& should be included.
9819 The Exim variables and functions that are defined by that API
9820 are also available for dynamically loaded functions. The function itself
9821 must have the following type:
9822 .code
9823 int dlfunction(uschar **yield, int argc, uschar *argv[])
9824 .endd
9825 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9826 function should return one of the following values:
9827
9828 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9829 into the expanded string that is being built.
9830
9831 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9832 from &'yield'&, if it is set.
9833
9834 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9835 taken from &'yield'& if it is set.
9836
9837 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9838
9839 When compiling a function that is to be used in this way with gcc,
9840 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9841 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9842
9843
9844 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9845 .cindex "expansion" "extracting value from environment"
9846 .cindex "environment" "values from"
9847 The key is first expanded separately, and leading and trailing white space
9848 removed.
9849 This is then searched for as a name in the environment.
9850 If a variable is found then its value is placed in &$value$&
9851 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9852
9853 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9854 appear, for example:
9855 .code
9856 ${env{USER}{$value} fail }
9857 .endd
9858 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9859 {<&'string1'&>} must be present for &"fail"& to be recognized.
9860
9861 If {<&'string2'&>} is omitted an empty string is substituted on
9862 search failure.
9863 If {<&'string1'&>} is omitted the search result is substituted on
9864 search success.
9865
9866 The environment is adjusted by the &%keep_environment%& and
9867 &%add_environment%& main section options.
9868
9869
9870 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9871        {*&<&'string3'&>&*}}*&"
9872 .cindex "expansion" "extracting substrings by key"
9873 .cindex "&%extract%&" "substrings by key"
9874 The key and <&'string1'&> are first expanded separately. Leading and trailing
9875 white space is removed from the key (but not from any of the strings). The key
9876 must not be empty and must not consist entirely of digits.
9877 The expanded <&'string1'&> must be of the form:
9878 .display
9879 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9880 .endd
9881 .vindex "&$value$&"
9882 where the equals signs and spaces (but not both) are optional. If any of the
9883 values contain white space, they must be enclosed in double quotes, and any
9884 values that are enclosed in double quotes are subject to escape processing as
9885 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9886 for the value that corresponds to the key. The search is case-insensitive. If
9887 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9888 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9889 variable &$value$& contains the value that has been extracted. Afterwards, it
9890 is restored to any previous value it might have had.
9891
9892 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9893 key is not found. If {<&'string2'&>} is also omitted, the value that was
9894 extracted is used. Thus, for example, these two expansions are identical, and
9895 yield &"2001"&:
9896 .code
9897 ${extract{gid}{uid=1984 gid=2001}}
9898 ${extract{gid}{uid=1984 gid=2001}{$value}}
9899 .endd
9900 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9901 appear, for example:
9902 .code
9903 ${extract{Z}{A=... B=...}{$value} fail }
9904 .endd
9905 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9906 {<&'string2'&>} must be present for &"fail"& to be recognized.
9907
9908 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9909        {*&<&'string3'&>&*}}*&" &&&
9910        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9911        {*&<&'string3'&>&*}}*&"
9912 .cindex "expansion" "extracting from JSON object"
9913 .cindex JSON expansions
9914 The key and <&'string1'&> are first expanded separately. Leading and trailing
9915 white space is removed from the key (but not from any of the strings). The key
9916 must not be empty and must not consist entirely of digits.
9917 The expanded <&'string1'&> must be of the form:
9918 .display
9919 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9920 .endd
9921 .vindex "&$value$&"
9922 The braces, commas and colons, and the quoting of the member name are required;
9923 the spaces are optional.
9924 Matching of the key against the member names is done case-sensitively.
9925 For the &"json"& variant,
9926 if a returned value is a JSON string, it retains its leading and
9927 trailing quotes.
9928 For the &"jsons"& variant, which is intended for use with JSON strings, the
9929 leading and trailing quotes are removed from the returned value.
9930 . XXX should be a UTF-8 compare
9931
9932 The results of matching are handled as above.
9933
9934
9935 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9936         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9937 .cindex "expansion" "extracting substrings by number"
9938 .cindex "&%extract%&" "substrings by number"
9939 The <&'number'&> argument must consist entirely of decimal digits,
9940 apart from leading and trailing white space, which is ignored.
9941 This is what distinguishes this form of &%extract%& from the previous kind. It
9942 behaves in the same way, except that, instead of extracting a named field, it
9943 extracts from <&'string1'&> the field whose number is given as the first
9944 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9945 <&'string3'&> as before.
9946
9947 The fields in the string are separated by any one of the characters in the
9948 separator string. These may include space or tab characters.
9949 The first field is numbered one. If the number is negative, the fields are
9950 counted from the end of the string, with the rightmost one numbered -1. If the
9951 number given is zero, the entire string is returned. If the modulus of the
9952 number is greater than the number of fields in the string, the result is the
9953 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9954 provided. For example:
9955 .code
9956 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9957 .endd
9958 yields &"42"&, and
9959 .code
9960 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9961 .endd
9962 yields &"99"&. Two successive separators mean that the field between them is
9963 empty (for example, the fifth field above).
9964
9965
9966 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9967         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9968        "&*${extract jsons{*&<&'number'&>&*}}&&&
9969         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9970 .cindex "expansion" "extracting from JSON array"
9971 .cindex JSON expansions
9972 The <&'number'&> argument must consist entirely of decimal digits,
9973 apart from leading and trailing white space, which is ignored.
9974
9975 Field selection and result handling is as above;
9976 there is no choice of field separator.
9977 For the &"json"& variant,
9978 if a returned value is a JSON string, it retains its leading and
9979 trailing quotes.
9980 For the &"jsons"& variant, which is intended for use with JSON strings, the
9981 leading and trailing quotes are removed from the returned value.
9982
9983
9984 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9985 .cindex "list" "selecting by condition"
9986 .cindex "expansion" "selecting from list by condition"
9987 .vindex "&$item$&"
9988 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9989 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9990 For each item
9991 in this list, its value is placed in &$item$&, and then the condition is
9992 evaluated.
9993 Any modification of &$value$& by this evaluation is discarded.
9994 If the condition is true, &$item$& is added to the output as an
9995 item in a new list; if the condition is false, the item is discarded. The
9996 separator used for the output list is the same as the one used for the
9997 input, but a separator setting is not included in the output. For example:
9998 .code
9999 ${filter{a:b:c}{!eq{$item}{b}}}
10000 .endd
10001 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10002 to what it was before.
10003 See also the &%map%& and &%reduce%& expansion items.
10004
10005
10006 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10007 .cindex "hash function" "textual"
10008 .cindex "expansion" "textual hash"
10009 This is a textual hashing function, and was the first to be implemented in
10010 early versions of Exim. In current releases, there are other hashing functions
10011 (numeric, MD5, and SHA-1), which are described below.
10012
10013 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10014 <&'n'&>. If you are using fixed values for these numbers, that is, if
10015 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10016 use the simpler operator notation that avoids some of the braces:
10017 .code
10018 ${hash_<n>_<m>:<string>}
10019 .endd
10020 The second number is optional (in both notations). If <&'n'&> is greater than
10021 or equal to the length of the string, the expansion item returns the string.
10022 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10023 function to the string. The new string consists of characters taken from the
10024 first <&'m'&> characters of the string
10025 .code
10026 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10027 .endd
10028 If <&'m'&> is not present the value 26 is used, so that only lower case
10029 letters appear. For example:
10030 .display
10031 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10032 &`$hash{5}{monty}}           `&   yields  &`monty`&
10033 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10034 .endd
10035
10036 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10037         &*$h_*&<&'header&~name'&>&*:*&" &&&
10038        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10039         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10040        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10041         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10042        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10043         &*$rh_*&<&'header&~name'&>&*:*&"
10044 .cindex "expansion" "header insertion"
10045 .vindex "&$header_$&"
10046 .vindex "&$bheader_$&"
10047 .vindex "&$lheader_$&"
10048 .vindex "&$rheader_$&"
10049 .cindex "header lines" "in expansion strings"
10050 .cindex "header lines" "character sets"
10051 .cindex "header lines" "decoding"
10052 Substitute the contents of the named message header line, for example
10053 .code
10054 $header_reply-to:
10055 .endd
10056 The newline that terminates a header line is not included in the expansion, but
10057 internal newlines (caused by splitting the header line over several physical
10058 lines) may be present.
10059
10060 The difference between the four pairs of expansions is in the way
10061 the data in the header line is interpreted.
10062
10063 .ilist
10064 .cindex "white space" "in header lines"
10065 &%rheader%& gives the original &"raw"& content of the header line, with no
10066 processing at all, and without the removal of leading and trailing white space.
10067
10068 .next
10069 .cindex "list" "of header lines"
10070 &%lheader%& gives a colon-separated list, one element per header when there
10071 are multiple headers with a given name.
10072 Any embedded colon characters within an element are doubled, so normal Exim
10073 list-processing facilities can be used.
10074 The terminating newline of each element is removed; in other respects
10075 the content is &"raw"&.
10076
10077 .next
10078 .cindex "base64 encoding" "in header lines"
10079 &%bheader%& removes leading and trailing white space, and then decodes base64
10080 or quoted-printable MIME &"words"& within the header text, but does no
10081 character set translation. If decoding of what looks superficially like a MIME
10082 &"word"& fails, the raw string is returned. If decoding
10083 .cindex "binary zero" "in header line"
10084 produces a binary zero character, it is replaced by a question mark &-- this is
10085 what Exim does for binary zeros that are actually received in header lines.
10086
10087 .next
10088 &%header%& tries to translate the string as decoded by &%bheader%& to a
10089 standard character set. This is an attempt to produce the same string as would
10090 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10091 returned. Translation is attempted only on operating systems that support the
10092 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10093 a system Makefile or in &_Local/Makefile_&.
10094 .endlist ilist
10095
10096 In a filter file, the target character set for &%header%& can be specified by a
10097 command of the following form:
10098 .code
10099 headers charset "UTF-8"
10100 .endd
10101 This command affects all references to &$h_$& (or &$header_$&) expansions in
10102 subsequently obeyed filter commands. In the absence of this command, the target
10103 character set in a filter is taken from the setting of the &%headers_charset%&
10104 option in the runtime configuration. The value of this option defaults to the
10105 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10106 ISO-8859-1.
10107
10108 Header names follow the syntax of RFC 2822, which states that they may contain
10109 any printing characters except space and colon. Consequently, curly brackets
10110 &'do not'& terminate header names, and should not be used to enclose them as
10111 if they were variables. Attempting to do so causes a syntax error.
10112
10113 Only header lines that are common to all copies of a message are visible to
10114 this mechanism. These are the original header lines that are received with the
10115 message, and any that are added by an ACL statement or by a system
10116 filter. Header lines that are added to a particular copy of a message by a
10117 router or transport are not accessible.
10118
10119 For incoming SMTP messages, no header lines are visible in
10120 ACLs that are obeyed before the data phase completes,
10121 because the header structure is not set up until the message is received.
10122 They are visible in DKIM, PRDR and DATA ACLs.
10123 Header lines that are added in a RCPT ACL (for example)
10124 are saved until the message's incoming header lines are available, at which
10125 point they are added.
10126 When any of the above ACLs are
10127 running, however, header lines added by earlier ACLs are visible.
10128
10129 Upper case and lower case letters are synonymous in header names. If the
10130 following character is white space, the terminating colon may be omitted, but
10131 this is not recommended, because you may then forget it when it is needed. When
10132 white space terminates the header name, this white space is included in the
10133 expanded string.  If the message does not contain the given header, the
10134 expansion item is replaced by an empty string. (See the &%def%& condition in
10135 section &<<SECTexpcond>>& for a means of testing for the existence of a
10136 header.)
10137
10138 If there is more than one header with the same name, they are all concatenated
10139 to form the substitution string, up to a maximum length of 64K. Unless
10140 &%rheader%& is being used, leading and trailing white space is removed from
10141 each header before concatenation, and a completely empty header is ignored. A
10142 newline character is then inserted between non-empty headers, but there is no
10143 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10144 those headers that contain lists of addresses, a comma is also inserted at the
10145 junctions between headers. This does not happen for the &%rheader%& expansion.
10146
10147 .cindex "tainted data" "message headers"
10148 When the headers are from an incoming message,
10149 the result of expanding any of these variables is tainted.
10150
10151
10152 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10153 .cindex "expansion" "hmac hashing"
10154 .cindex &%hmac%&
10155 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10156 shared secret and some text into a message authentication code, as specified in
10157 RFC 2104. This differs from &`${md5:secret_text...}`& or
10158 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10159 cryptographic hash, allowing for authentication that is not possible with MD5
10160 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10161 present. For example:
10162 .code
10163 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10164 .endd
10165 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10166 produces:
10167 .code
10168 dd97e3ba5d1a61b5006108f8c8252953
10169 .endd
10170 As an example of how this might be used, you might put in the main part of
10171 an Exim configuration:
10172 .code
10173 SPAMSCAN_SECRET=cohgheeLei2thahw
10174 .endd
10175 In a router or a transport you could then have:
10176 .code
10177 headers_add = \
10178   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10179   ${hmac{md5}{SPAMSCAN_SECRET}\
10180   {${primary_hostname},${message_exim_id},$h_message-id:}}
10181 .endd
10182 Then given a message, you can check where it was scanned by looking at the
10183 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10184 this header line is authentic by recomputing the authentication code from the
10185 host name, message ID and the &'Message-id:'& header line. This can be done
10186 using Exim's &%-be%& option, or by other means, for example, by using the
10187 &'hmac_md5_hex()'& function in Perl.
10188
10189
10190 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10191 .cindex "expansion" "conditional"
10192 .cindex "&%if%&, expansion item"
10193 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10194 item; otherwise <&'string2'&> is used. The available conditions are described
10195 in section &<<SECTexpcond>>& below. For example:
10196 .code
10197 ${if eq {$local_part}{postmaster} {yes}{no} }
10198 .endd
10199 The second string need not be present; if it is not and the condition is not
10200 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10201 be present instead of the second string (without any curly brackets). In this
10202 case, the expansion is forced to fail if the condition is not true (see section
10203 &<<SECTforexpfai>>&).
10204
10205 If both strings are omitted, the result is the string &`true`& if the condition
10206 is true, and the empty string if the condition is false. This makes it less
10207 cumbersome to write custom ACL and router conditions. For example, instead of
10208 .code
10209 condition = ${if >{$acl_m4}{3}{true}{false}}
10210 .endd
10211 you can use
10212 .code
10213 condition = ${if >{$acl_m4}{3}}
10214 .endd
10215
10216
10217
10218 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10219 .cindex expansion "imap folder"
10220 .cindex "&%imapfolder%& expansion item"
10221 This item converts a (possibly multilevel, or with non-ASCII characters)
10222 folder specification to a Maildir name for filesystem use.
10223 For information on internationalisation support see &<<SECTi18nMDA>>&.
10224
10225
10226
10227 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10228 .cindex "expansion" "string truncation"
10229 .cindex "&%length%& expansion item"
10230 The &%length%& item is used to extract the initial portion of a string. Both
10231 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10232 you are using a fixed value for the number, that is, if <&'string1'&> does not
10233 change when expanded, you can use the simpler operator notation that avoids
10234 some of the braces:
10235 .code
10236 ${length_<n>:<string>}
10237 .endd
10238 The result of this item is either the first <&'n'&> bytes or the whole
10239 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10240 &%strlen%&, which gives the length of a string.
10241 All measurement is done in bytes and is not UTF-8 aware.
10242
10243
10244 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10245         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10246 .cindex "expansion" "extracting list elements by number"
10247 .cindex "&%listextract%&" "extract list elements by number"
10248 .cindex "list" "extracting elements by number"
10249 The <&'number'&> argument must consist entirely of decimal digits,
10250 apart from an optional leading minus,
10251 and leading and trailing white space (which is ignored).
10252
10253 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10254 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10255
10256 The first field of the list is numbered one.
10257 If the number is negative, the fields are
10258 counted from the end of the list, with the rightmost one numbered -1.
10259 The numbered element of the list is extracted and placed in &$value$&,
10260 then <&'string2'&> is expanded as the result.
10261
10262 If the modulus of the
10263 number is zero or greater than the number of fields in the string,
10264 the result is the expansion of <&'string3'&>.
10265
10266 For example:
10267 .code
10268 ${listextract{2}{x:42:99}}
10269 .endd
10270 yields &"42"&, and
10271 .code
10272 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10273 .endd
10274 yields &"result: 42"&.
10275
10276 If {<&'string3'&>} is omitted, an empty string is used for string3.
10277 If {<&'string2'&>} is also omitted, the value that was
10278 extracted is used.
10279 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10280
10281
10282 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10283 .cindex quoting "for list"
10284 .cindex list quoting
10285 This item doubles any occurrence of the separator character
10286 in the given string.
10287 An empty string is replaced with a single space.
10288 This converts the string into a safe form for use as a list element,
10289 in a list using the given separator.
10290
10291
10292 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10293         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10294        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10295         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10296 .cindex "expansion" "lookup in"
10297 .cindex "file" "lookups"
10298 .cindex "lookup" "in expanded string"
10299 The two forms of lookup item specify data lookups in files and databases, as
10300 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10301 lookups, and the second is used for query-style lookups. The <&'key'&>,
10302 <&'file'&>, and <&'query'&> strings are expanded before use.
10303
10304 If there is any white space in a lookup item which is part of a filter command,
10305 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10306 other place where white space is significant, the lookup item must be enclosed
10307 in double quotes. The use of data lookups in users' filter files may be locked
10308 out by the system administrator.
10309
10310 .vindex "&$value$&"
10311 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10312 During its expansion, the variable &$value$& contains the data returned by the
10313 lookup. Afterwards it reverts to the value it had previously (at the outer
10314 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10315 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10316 string on failure. If <&'string2'&> is provided, it can itself be a nested
10317 lookup, thus providing a mechanism for looking up a default value when the
10318 original lookup fails.
10319
10320 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10321 data for the outer lookup while the parameters of the second lookup are
10322 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10323 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10324 appear, and in this case, if the lookup fails, the entire expansion is forced
10325 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10326 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10327 successful lookup, and nothing in the case of failure.
10328
10329 For single-key lookups, the string &"partial"& is permitted to precede the
10330 search type in order to do partial matching, and * or *@ may follow a search
10331 type to request default lookups if the key does not match (see sections
10332 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10333
10334 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10335 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10336 and non-wild parts of the key during the expansion of the replacement text.
10337 They return to their previous values at the end of the lookup item.
10338
10339 This example looks up the postmaster alias in the conventional alias file:
10340 .code
10341 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10342 .endd
10343 This example uses NIS+ to look up the full name of the user corresponding to
10344 the local part of an address, forcing the expansion to fail if it is not found:
10345 .code
10346 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10347   {$value}fail}
10348 .endd
10349
10350
10351 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10352 .cindex "expansion" "list creation"
10353 .vindex "&$item$&"
10354 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10355 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10356 For each item
10357 in this list, its value is place in &$item$&, and then <&'string2'&> is
10358 expanded and added to the output as an item in a new list. The separator used
10359 for the output list is the same as the one used for the input, but a separator
10360 setting is not included in the output. For example:
10361 .code
10362 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10363 .endd
10364 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10365 value of &$item$& is restored to what it was before. See also the &%filter%&
10366 and &%reduce%& expansion items.
10367
10368 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10369 .cindex "expansion" "numeric hash"
10370 .cindex "hash function" "numeric"
10371 The three strings are expanded; the first two must yield numbers. Call them
10372 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10373 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10374 can use the simpler operator notation that avoids some of the braces:
10375 .code
10376 ${nhash_<n>_<m>:<string>}
10377 .endd
10378 The second number is optional (in both notations). If there is only one number,
10379 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10380 processed by a div/mod hash function that returns two numbers, separated by a
10381 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10382 example,
10383 .code
10384 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10385 .endd
10386 returns the string &"6/33"&.
10387
10388
10389
10390 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10391 .cindex "Perl" "use in expanded string"
10392 .cindex "expansion" "calling Perl from"
10393 This item is available only if Exim has been built to include an embedded Perl
10394 interpreter. The subroutine name and the arguments are first separately
10395 expanded, and then the Perl subroutine is called with those arguments. No
10396 additional arguments need be given; the maximum number permitted, including the
10397 name of the subroutine, is nine.
10398
10399 The return value of the subroutine is inserted into the expanded string, unless
10400 the return value is &%undef%&. In that case, the entire expansion is
10401 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10402 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10403 in a scalar context, thus the return value is a scalar.  For example, if you
10404 return a Perl vector, the return value is the size of the vector,
10405 not its contents.
10406
10407 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10408 with the error message that was passed to &%die%&. More details of the embedded
10409 Perl facility are given in chapter &<<CHAPperl>>&.
10410
10411 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10412 out the use of this expansion item in filter files.
10413
10414
10415 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10416 .cindex "&%prvs%& expansion item"
10417 The first argument is a complete email address and the second is secret
10418 keystring. The third argument, specifying a key number, is optional. If absent,
10419 it defaults to 0. The result of the expansion is a prvs-signed email address,
10420 to be typically used with the &%return_path%& option on an &(smtp)& transport
10421 as part of a bounce address tag validation (BATV) scheme. For more discussion
10422 and an example, see section &<<SECTverifyPRVS>>&.
10423
10424 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10425         {*&<&'string'&>&*}}*&"
10426 .cindex "&%prvscheck%& expansion item"
10427 This expansion item is the complement of the &%prvs%& item. It is used for
10428 checking prvs-signed addresses. If the expansion of the first argument does not
10429 yield a syntactically valid prvs-signed address, the whole item expands to the
10430 empty string. When the first argument does expand to a syntactically valid
10431 prvs-signed address, the second argument is expanded, with the prvs-decoded
10432 version of the address and the key number extracted from the address in the
10433 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10434
10435 These two variables can be used in the expansion of the second argument to
10436 retrieve the secret. The validity of the prvs-signed address is then checked
10437 against the secret. The result is stored in the variable &$prvscheck_result$&,
10438 which is empty for failure or &"1"& for success.
10439
10440 The third argument is optional; if it is missing, it defaults to an empty
10441 string. This argument is now expanded. If the result is an empty string, the
10442 result of the expansion is the decoded version of the address. This is the case
10443 whether or not the signature was valid. Otherwise, the result of the expansion
10444 is the expansion of the third argument.
10445
10446 All three variables can be used in the expansion of the third argument.
10447 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10448 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10449
10450 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10451 .cindex "expansion" "inserting an entire file"
10452 .cindex "file" "inserting into expansion"
10453 .cindex "&%readfile%& expansion item"
10454 The filename and end-of-line (eol) string are first expanded separately. The file is
10455 then read, and its contents replace the entire item. All newline characters in
10456 the file are replaced by the end-of-line string if it is present. Otherwise,
10457 newlines are left in the string.
10458 String expansion is not applied to the contents of the file. If you want this,
10459 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10460 the string expansion fails.
10461
10462 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10463 locks out the use of this expansion item in filter files.
10464
10465
10466
10467 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10468         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10469 .cindex "expansion" "inserting from a socket"
10470 .cindex "socket, use of in expansion"
10471 .cindex "&%readsocket%& expansion item"
10472 This item inserts data from a Unix domain or TCP socket into the expanded
10473 string. The minimal way of using it uses just two arguments, as in these
10474 examples:
10475 .code
10476 ${readsocket{/socket/name}{request string}}
10477 ${readsocket{inet:some.host:1234}{request string}}
10478 .endd
10479 For a Unix domain socket, the first substring must be the path to the socket.
10480 For an Internet socket, the first substring must contain &`inet:`& followed by
10481 a host name or IP address, followed by a colon and a port, which can be a
10482 number or the name of a TCP port in &_/etc/services_&. An IP address may
10483 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10484 example:
10485 .code
10486 ${readsocket{inet:[::1]:1234}{request string}}
10487 .endd
10488 Only a single host name may be given, but if looking it up yields more than
10489 one IP address, they are each tried in turn until a connection is made. For
10490 both kinds of socket, Exim makes a connection, writes the request string
10491 (unless it is an empty string; no terminating NUL is ever sent)
10492 and reads from the socket until an end-of-file
10493 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10494 extend what can be done. Firstly, you can vary the timeout. For example:
10495 .code
10496 ${readsocket{/socket/name}{request string}{3s}}
10497 .endd
10498
10499 The third argument is a list of options, of which the first element is the timeout
10500 and must be present if any options are given.
10501 Further elements are options of form &'name=value'&.
10502 Example:
10503 .code
10504 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10505 .endd
10506
10507 The following option names are recognised:
10508 .ilist
10509 &*cache*&
10510 Defines if the result data can be cached for use by a later identical
10511 request in the same process.
10512 Values are &"yes"& or &"no"& (the default).
10513 If not, all cached results for this connection specification
10514 will be invalidated.
10515
10516 .next
10517 &*shutdown*&
10518 Defines whether or not a write-shutdown is done on the connection after
10519 sending the request. Values are &"yes"& (the default) or &"no"&
10520 (preferred, eg. by some webservers).
10521
10522 .next
10523 &*sni*&
10524 Controls the use of Server Name Identification on the connection.
10525 Any nonempty value will be the SNI sent; TLS will be forced.
10526
10527 .next
10528 &*tls*&
10529 Controls the use of TLS on the connection.
10530 Values are &"yes"& or &"no"& (the default).
10531 If it is enabled, a shutdown as described above is never done.
10532 .endlist
10533
10534
10535 A fourth argument allows you to change any newlines that are in the data
10536 that is read, in the same way as for &%readfile%& (see above). This example
10537 turns them into spaces:
10538 .code
10539 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10540 .endd
10541 As with all expansions, the substrings are expanded before the processing
10542 happens. Errors in these sub-expansions cause the expansion to fail. In
10543 addition, the following errors can occur:
10544
10545 .ilist
10546 Failure to create a socket file descriptor;
10547 .next
10548 Failure to connect the socket;
10549 .next
10550 Failure to write the request string;
10551 .next
10552 Timeout on reading from the socket.
10553 .endlist
10554
10555 By default, any of these errors causes the expansion to fail. However, if
10556 you supply a fifth substring, it is expanded and used when any of the above
10557 errors occurs. For example:
10558 .code
10559 ${readsocket{/socket/name}{request string}{3s}{\n}\
10560   {socket failure}}
10561 .endd
10562 You can test for the existence of a Unix domain socket by wrapping this
10563 expansion in &`${if exists`&, but there is a race condition between that test
10564 and the actual opening of the socket, so it is safer to use the fifth argument
10565 if you want to be absolutely sure of avoiding an expansion error for a
10566 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10567
10568 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10569 locks out the use of this expansion item in filter files.
10570
10571
10572 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10573 .cindex "expansion" "reducing a list to a scalar"
10574 .cindex "list" "reducing to a scalar"
10575 .vindex "&$value$&"
10576 .vindex "&$item$&"
10577 This operation reduces a list to a single, scalar string. After expansion,
10578 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10579 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10580 Then <&'string2'&> is expanded and
10581 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10582 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10583 them. The result of that expansion is assigned to &$value$& before the next
10584 iteration. When the end of the list is reached, the final value of &$value$& is
10585 added to the expansion output. The &%reduce%& expansion item can be used in a
10586 number of ways. For example, to add up a list of numbers:
10587 .code
10588 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10589 .endd
10590 The result of that expansion would be &`6`&. The maximum of a list of numbers
10591 can be found:
10592 .code
10593 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10594 .endd
10595 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10596 restored to what they were before. See also the &%filter%& and &%map%&
10597 expansion items.
10598
10599 . A bit of a special-case logic error in writing an expansion;
10600 . probably not worth including in the mainline of documentation.
10601 . If only we had footnotes (the html output variant is the problem).
10602 .
10603 . .new
10604 . &*Note*&: if an &'expansion condition'& is used in <&'string3'&>
10605 . and that condition modifies &$value$&,
10606 . then the string expansions dependent on the condition cannot use
10607 . the &$value$& of the reduce iteration.
10608 . .wen
10609
10610 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10611 This item inserts &"raw"& header lines. It is described with the &%header%&
10612 expansion item in section &<<SECTexpansionitems>>& above.
10613
10614 .vitem "&*${run<&'options'&> {*&<&'command&~string'&>&*}{*&<&'string1'&>&*}&&&
10615         {*&<&'string2'&>&*}}*&"
10616 .cindex "expansion" "running a command"
10617 .cindex "&%run%& expansion item"
10618 This item runs an external command, as a subprocess.
10619 One option is supported after the word &'run'&, comma-separated
10620 and without whitespace.
10621
10622 If the option &'preexpand'& is not used,
10623 the command string before expansion is split into individual arguments by spaces
10624 and then each argument is separately expanded.
10625 Then the command is run
10626 in a separate process, but under the same uid and gid.  As in other command
10627 executions from Exim, a shell is not used by default. If the command requires
10628 a shell, you must explicitly code it.
10629 The command name may not be tainted, but the remaining arguments can be.
10630
10631 &*Note*&: if tainted arguments are used, they are supplied by a
10632 potential attacker;
10633 a careful assessment for security vulnerabilities should be done.
10634
10635 If the option &'preexpand'& is used,
10636 the command string is first expanded as a whole.
10637 The expansion result is split apart into individual arguments by spaces,
10638 and then the command is run as above.
10639 Since the arguments are split by spaces, when there is a variable expansion
10640 which has an empty result, it will cause the situation that the argument will
10641 simply be omitted when the program is actually executed by Exim. If the
10642 script/program requires a specific number of arguments and the expanded
10643 variable could possibly result in this empty expansion, the variable must be
10644 quoted. This is more difficult if the expanded variable itself could result
10645 in a string containing quotes, because it would interfere with the quotes
10646 around the command arguments. A possible guard against this is to wrap the
10647 variable in the &%sg%& operator to change any quote marks to some other
10648 character.
10649 Neither the command nor any argument may be tainted.
10650
10651 The standard input for the command exists, but is empty. The standard output
10652 and standard error are set to the same file descriptor.
10653 .cindex "return code" "from &%run%& expansion"
10654 .vindex "&$value$&"
10655 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10656 and replaces the entire item; during this expansion, the standard output/error
10657 from the command is in the variable &$value$&. If the command fails,
10658 <&'string2'&>, if present, is expanded and used. Once again, during the
10659 expansion, the standard output/error from the command is in the variable
10660 &$value$&.
10661
10662 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10663 can be the word &"fail"& (not in braces) to force expansion failure if the
10664 command does not succeed. If both strings are omitted, the result is contents
10665 of the standard output/error on success, and nothing on failure.
10666
10667 .vindex "&$run_in_acl$&"
10668 The standard output/error of the command is put in the variable &$value$&.
10669 In this ACL example, the output of a command is logged for the admin to
10670 troubleshoot:
10671 .code
10672 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10673       log_message  = Output of id: $value
10674 .endd
10675 If the command requires shell idioms, such as the > redirect operator, the
10676 shell must be invoked directly, such as with:
10677 .code
10678 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10679 .endd
10680 Note that &$value$& will not persist beyond the reception of a single message.
10681
10682 .vindex "&$runrc$&"
10683 The return code from the command is put in the variable &$runrc$&, and this
10684 remains set afterwards, so in a filter file you can do things like this:
10685 .code
10686 if "${run{x y z}{}}$runrc" is 1 then ...
10687   elif $runrc is 2 then ...
10688   ...
10689 endif
10690 .endd
10691 If execution of the command fails (for example, the command does not exist),
10692 the return code is 127 &-- the same code that shells use for non-existent
10693 commands.
10694
10695 &*Warning*&: In a router or transport, you cannot assume the order in which
10696 option values are expanded, except for those preconditions whose order of
10697 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10698 by the expansion of one option, and use it in another.
10699
10700 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10701 out the use of this expansion item in filter files.
10702
10703
10704 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10705 .cindex "expansion" "string substitution"
10706 .cindex "&%sg%& expansion item"
10707 This item works like Perl's substitution operator (s) with the global (/g)
10708 option; hence its name. However, unlike the Perl equivalent, Exim does not
10709 modify the subject string; instead it returns the modified string for insertion
10710 into the overall expansion. The item takes three arguments: the subject string,
10711 a regular expression, and a substitution string. For example:
10712 .code
10713 ${sg{abcdefabcdef}{abc}{xyz}}
10714 .endd
10715 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10716 if any $, } or \ characters are required in the regular expression or in the
10717 substitution string, they have to be escaped. For example:
10718 .code
10719 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10720 .endd
10721 yields &"defabc"&, and
10722 .code
10723 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10724 .endd
10725 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10726 the regular expression from string expansion.
10727
10728 The regular expression is compiled in 8-bit mode, working against bytes
10729 rather than any Unicode-aware character handling.
10730
10731
10732 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10733 .cindex sorting "a list"
10734 .cindex list sorting
10735 .cindex expansion "list sorting"
10736 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10737 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10738 The <&'comparator'&> argument is interpreted as the operator
10739 of a two-argument expansion condition.
10740 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10741 The comparison should return true when applied to two values
10742 if the first value should sort before the second value.
10743 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10744 the element being placed in &$item$&,
10745 to give values for comparison.
10746
10747 The item result is a sorted list,
10748 with the original list separator,
10749 of the list elements (in full) of the original.
10750
10751 Examples:
10752 .code
10753 ${sort{3:2:1:4}{<}{$item}}
10754 .endd
10755 sorts a list of numbers, and
10756 .code
10757 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10758 .endd
10759 will sort an MX lookup into priority order.
10760
10761
10762
10763 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10764 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10765
10766
10767
10768 .vitem &*${substr{*&<&'start'&>&*}{*&<&'len'&>&*}{*&<&'subject'&>&*}}*&
10769 .cindex "&%substr%& expansion item"
10770 .cindex "substring extraction"
10771 .cindex "expansion" "substring extraction"
10772 The three strings are expanded; the first two must yield numbers. Call them
10773 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10774 if <&'start'&> and <&'len'&> do not change when they are expanded, you
10775 can use the simpler operator notation that avoids some of the braces:
10776 .code
10777 ${substr_<n>_<m>:<subject>}
10778 .endd
10779 The second number is optional (in both notations).
10780 If it is absent in the simpler format, the preceding underscore must also be
10781 omitted.
10782
10783 The &%substr%& item can be used to extract more general substrings than
10784 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10785 length required. For example
10786 .code
10787 ${substr{3}{2}{$local_part}}
10788 .endd
10789 If the starting offset is greater than the string length the result is the
10790 null string; if the length plus starting offset is greater than the string
10791 length, the result is the right-hand part of the string, starting from the
10792 given offset. The first byte (character) in the string has offset zero.
10793
10794 The &%substr%& expansion item can take negative offset values to count
10795 from the right-hand end of its operand. The last byte (character) is offset -1,
10796 the second-last is offset -2, and so on. Thus, for example,
10797 .code
10798 ${substr{-5}{2}{1234567}}
10799 .endd
10800 yields &"34"&. If the absolute value of a negative offset is greater than the
10801 length of the string, the substring starts at the beginning of the string, and
10802 the length is reduced by the amount of overshoot. Thus, for example,
10803 .code
10804 ${substr{-5}{2}{12}}
10805 .endd
10806 yields an empty string, but
10807 .code
10808 ${substr{-3}{2}{12}}
10809 .endd
10810 yields &"1"&.
10811
10812 When the second number is omitted from &%substr%&, the remainder of the string
10813 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10814 string preceding the offset point are taken. For example, an offset of -1 and
10815 no length, as in these semantically identical examples:
10816 .code
10817 ${substr_-1:abcde}
10818 ${substr{-1}{abcde}}
10819 .endd
10820 yields all but the last character of the string, that is, &"abcd"&.
10821
10822 All measurement is done in bytes and is not UTF-8 aware.
10823
10824
10825
10826 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10827         {*&<&'replacements'&>&*}}*&"
10828 .cindex "expansion" "character translation"
10829 .cindex "&%tr%& expansion item"
10830 This item does single-character (in bytes) translation on its subject string. The second
10831 argument is a list of characters to be translated in the subject string. Each
10832 matching character is replaced by the corresponding character from the
10833 replacement list. For example
10834 .code
10835 ${tr{abcdea}{ac}{13}}
10836 .endd
10837 yields &`1b3de1`&. If there are duplicates in the second character string, the
10838 last occurrence is used. If the third string is shorter than the second, its
10839 last character is replicated. However, if it is empty, no translation takes
10840 place.
10841
10842 All character handling is done in bytes and is not UTF-8 aware.
10843
10844 .endlist
10845
10846
10847
10848 .section "Expansion operators" "SECTexpop"
10849 .cindex "expansion" "operators"
10850 For expansion items that perform transformations on a single argument string,
10851 the &"operator"& notation is used because it is simpler and uses fewer braces.
10852 The substring is first expanded before the operation is applied to it. The
10853 following operations can be performed:
10854
10855 .vlist
10856 .vitem &*${address:*&<&'string'&>&*}*&
10857 .cindex "expansion" "RFC 2822 address handling"
10858 .cindex "&%address%& expansion item"
10859 The string is interpreted as an RFC 2822 address, as it might appear in a
10860 header line, and the effective address is extracted from it. If the string does
10861 not parse successfully, the result is empty.
10862
10863 The parsing correctly handles SMTPUTF8 Unicode in the string.
10864
10865
10866 .vitem &*${addresses:*&<&'string'&>&*}*&
10867 .cindex "expansion" "RFC 2822 address handling"
10868 .cindex "&%addresses%& expansion item"
10869 The string (after expansion) is interpreted as a list of addresses in RFC
10870 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10871 operative address (&'local-part@domain'&) is extracted from each item, and the
10872 result of the expansion is a colon-separated list, with appropriate
10873 doubling of colons should any happen to be present in the email addresses.
10874 Syntactically invalid RFC2822 address items are omitted from the output.
10875
10876 It is possible to specify a character other than colon for the output
10877 separator by starting the string with > followed by the new separator
10878 character. For example:
10879 .code
10880 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10881 .endd
10882 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10883 first, so if the expanded string starts with >, it may change the output
10884 separator unintentionally. This can be avoided by setting the output
10885 separator explicitly:
10886 .code
10887 ${addresses:>:$h_from:}
10888 .endd
10889
10890 Compare the &%address%& (singular)
10891 expansion item, which extracts the working address from a single RFC2822
10892 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10893 processing lists.
10894
10895 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10896 a strict interpretation of header line formatting.  Exim parses the bare,
10897 unquoted portion of an email address and if it finds a comma, treats it as an
10898 email address separator. For the example header line:
10899 .code
10900 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10901 .endd
10902 The first example below demonstrates that Q-encoded email addresses are parsed
10903 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10904 It does not see the comma because it's still encoded as "=2C".  The second
10905 example below is passed the contents of &`$header_from:`&, meaning it gets
10906 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10907 The third example shows that the presence of a comma is skipped when it is
10908 quoted.  The fourth example shows SMTPUTF8 handling.
10909 .code
10910 # exim -be '${addresses:From: \
10911 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10912 user@example.com
10913 # exim -be '${addresses:From: Last, First <user@example.com>}'
10914 Last:user@example.com
10915 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10916 user@example.com
10917 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10918 フィリップ@example.jp
10919 .endd
10920
10921 .vitem &*${base32:*&<&'digits'&>&*}*&
10922 .cindex "&%base32%& expansion item"
10923 .cindex "expansion" "conversion to base 32"
10924 The string must consist entirely of decimal digits. The number is converted to
10925 base 32 and output as a (empty, for zero) string of characters.
10926 Only lowercase letters are used.
10927
10928 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10929 .cindex "&%base32d%& expansion item"
10930 .cindex "expansion" "conversion to base 32"
10931 The string must consist entirely of base-32 digits.
10932 The number is converted to decimal and output as a string.
10933
10934 .vitem &*${base62:*&<&'digits'&>&*}*&
10935 .cindex "&%base62%& expansion item"
10936 .cindex "expansion" "conversion to base 62"
10937 The string must consist entirely of decimal digits. The number is converted to
10938 base 62 and output as a string of six characters, including leading zeros. In
10939 the few operating environments where Exim uses base 36 instead of base 62 for
10940 its message identifiers (because those systems do not have case-sensitive
10941 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10942 to be absolutely clear: this is &'not'& base64 encoding.
10943
10944 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10945 .cindex "&%base62d%& expansion item"
10946 .cindex "expansion" "conversion to base 62"
10947 The string must consist entirely of base-62 digits, or, in operating
10948 environments where Exim uses base 36 instead of base 62 for its message
10949 identifiers, base-36 digits. The number is converted to decimal and output as a
10950 string.
10951
10952 .vitem &*${base64:*&<&'string'&>&*}*&
10953 .cindex "expansion" "base64 encoding"
10954 .cindex "base64 encoding" "in string expansion"
10955 .cindex "&%base64%& expansion item"
10956 .cindex certificate "base64 of DER"
10957 This operator converts a string into one that is base64 encoded.
10958
10959 If the string is a single variable of type certificate,
10960 returns the base64 encoding of the DER form of the certificate.
10961
10962
10963 .vitem &*${base64d:*&<&'string'&>&*}*&
10964 .cindex "expansion" "base64 decoding"
10965 .cindex "base64 decoding" "in string expansion"
10966 .cindex "&%base64d%& expansion item"
10967 This operator converts a base64-encoded string into the un-coded form.
10968
10969
10970 .vitem &*${domain:*&<&'string'&>&*}*&
10971 .cindex "domain" "extraction"
10972 .cindex "expansion" "domain extraction"
10973 The string is interpreted as an RFC 2822 address and the domain is extracted
10974 from it. If the string does not parse successfully, the result is empty.
10975
10976
10977 .vitem &*${escape:*&<&'string'&>&*}*&
10978 .cindex "expansion" "escaping non-printing characters"
10979 .cindex "&%escape%& expansion item"
10980 If the string contains any non-printing characters, they are converted to
10981 escape sequences starting with a backslash. Whether characters with the most
10982 significant bit set (so-called &"8-bit characters"&) count as printing or not
10983 is controlled by the &%print_topbitchars%& option.
10984
10985 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10986 .cindex "expansion" "escaping 8-bit characters"
10987 .cindex "&%escape8bit%& expansion item"
10988 If the string contains any characters with the most significant bit set,
10989 they are converted to escape sequences starting with a backslash.
10990 Backslashes and DEL characters are also converted.
10991
10992
10993 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10994 .cindex "expansion" "expression evaluation"
10995 .cindex "expansion" "arithmetic expression"
10996 .cindex "&%eval%& expansion item"
10997 These items supports simple arithmetic and bitwise logical operations in
10998 expansion strings. The string (after expansion) must be a conventional
10999 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11000 logical operators, and parentheses. All operations are carried out using
11001 integer arithmetic. The operator priorities are as follows (the same as in the
11002 C programming language):
11003 .table2 70pt 300pt
11004 .irow &'highest:'& "not (~), negate (-)"
11005 .irow ""   "multiply (*), divide (/), remainder (%)"
11006 .irow ""   "plus (+), minus (-)"
11007 .irow ""   "shift-left (<<), shift-right (>>)"
11008 .irow ""   "and (&&)"
11009 .irow ""   "xor (^)"
11010 .irow &'lowest:'&  "or (|)"
11011 .endtable
11012 Binary operators with the same priority are evaluated from left to right. White
11013 space is permitted before or after operators.
11014
11015 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11016 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11017 decimal, even if they start with a leading zero; hexadecimal numbers are not
11018 permitted. This can be useful when processing numbers extracted from dates or
11019 times, which often do have leading zeros.
11020
11021 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11022 or 1024*1024*1024,
11023 respectively. Negative numbers are supported. The result of the computation is
11024 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11025
11026 .display
11027 &`${eval:1+1}            `&  yields 2
11028 &`${eval:1+2*3}          `&  yields 7
11029 &`${eval:(1+2)*3}        `&  yields 9
11030 &`${eval:2+42%5}         `&  yields 4
11031 &`${eval:0xc&amp;5}          `&  yields 4
11032 &`${eval:0xc|5}          `&  yields 13
11033 &`${eval:0xc^5}          `&  yields 9
11034 &`${eval:0xc>>1}         `&  yields 6
11035 &`${eval:0xc<<1}         `&  yields 24
11036 &`${eval:~255&amp;0x1234}    `&  yields 4608
11037 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11038 .endd
11039
11040 As a more realistic example, in an ACL you might have
11041 .code
11042 deny   condition =                    \
11043          ${if and {                   \
11044            {>{$rcpt_count}{10}}       \
11045            {                          \
11046            <                          \
11047              {$recipients_count}      \
11048              {${eval:$rcpt_count/2}}  \
11049            }                          \
11050          }{yes}{no}}
11051        message = Too many bad recipients
11052 .endd
11053 The condition is true if there have been more than 10 RCPT commands and
11054 fewer than half of them have resulted in a valid recipient.
11055
11056
11057 .vitem &*${expand:*&<&'string'&>&*}*&
11058 .cindex "expansion" "re-expansion of substring"
11059 The &%expand%& operator causes a string to be expanded for a second time. For
11060 example,
11061 .code
11062 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11063 .endd
11064 first looks up a string in a file while expanding the operand for &%expand%&,
11065 and then re-expands what it has found.
11066
11067
11068 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11069 .cindex "Unicode"
11070 .cindex "UTF-8" "conversion from"
11071 .cindex "expansion" "UTF-8 conversion"
11072 .cindex "&%from_utf8%& expansion item"
11073 The world is slowly moving towards Unicode, although there are no standards for
11074 email yet. However, other applications (including some databases) are starting
11075 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11076 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11077 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11078 the result is an undefined sequence of bytes.
11079
11080 Unicode code points with values less than 256 are compatible with ASCII and
11081 ISO-8859-1 (also known as Latin-1).
11082 For example, character 169 is the copyright symbol in both cases, though the
11083 way it is encoded is different. In UTF-8, more than one byte is needed for
11084 characters with code values greater than 127, whereas ISO-8859-1 is a
11085 single-byte encoding (but thereby limited to 256 characters). This makes
11086 translation from UTF-8 to ISO-8859-1 straightforward.
11087
11088
11089 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11090 .cindex "hash function" "textual"
11091 .cindex "expansion" "textual hash"
11092 The &%hash%& operator is a simpler interface to the hashing function that can
11093 be used when the two parameters are fixed numbers (as opposed to strings that
11094 change when expanded). The effect is the same as
11095 .code
11096 ${hash{<n>}{<m>}{<string>}}
11097 .endd
11098 See the description of the general &%hash%& item above for details. The
11099 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11100
11101
11102
11103 .vitem &*${headerwrap_*&<&'cols'&>&*_*&<&'limit'&>&*:*&<&'string'&>&*}*&
11104 .cindex header "wrapping operator"
11105 .cindex expansion "header wrapping"
11106 This operator line-wraps its argument in a way useful for headers.
11107 The &'cols'& value gives the column number to wrap after,
11108 the &'limit'& gives a limit number of result characters to truncate at.
11109 Either just the &'limit'& and the preceding underbar, or both, can be omitted;
11110 the defaults are 80 and 998.
11111 Wrapping will be inserted at a space if possible before the
11112 column number is reached.
11113 Whitespace at a chosen wrap point is removed.
11114 A line-wrap consists of a newline followed by a tab,
11115 and the tab is counted as 8 columns.
11116
11117
11118
11119 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11120 .cindex "base64 encoding" "conversion from hex"
11121 .cindex "expansion" "hex to base64"
11122 .cindex "&%hex2b64%& expansion item"
11123 This operator converts a hex string into one that is base64 encoded. This can
11124 be useful for processing the output of the various hashing functions.
11125
11126
11127
11128 .vitem &*${hexquote:*&<&'string'&>&*}*&
11129 .cindex "quoting" "hex-encoded unprintable characters"
11130 .cindex "&%hexquote%& expansion item"
11131 This operator converts non-printable characters in a string into a hex
11132 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11133 as is, and other byte values are converted to &`\xNN`&, for example, a
11134 byte value 127 is converted to &`\x7f`&.
11135
11136
11137 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11138 .cindex "&%ipv6denorm%& expansion item"
11139 .cindex "IP address" normalisation
11140 This expands an IPv6 address to a full eight-element colon-separated set
11141 of hex digits including leading zeroes.
11142 A trailing ipv4-style dotted-decimal set is converted to hex.
11143 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11144
11145 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11146 .cindex "&%ipv6norm%& expansion item"
11147 .cindex "IP address" normalisation
11148 .cindex "IP address" "canonical form"
11149 This converts an IPv6 address to canonical form.
11150 Leading zeroes of groups are omitted, and the longest
11151 set of zero-valued groups is replaced with a double colon.
11152 A trailing ipv4-style dotted-decimal set is converted to hex.
11153 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11154
11155
11156 .vitem &*${lc:*&<&'string'&>&*}*&
11157 .cindex "case forcing in strings"
11158 .cindex "string" "case forcing"
11159 .cindex "lower casing"
11160 .cindex "expansion" "case forcing"
11161 .cindex "&%lc%& expansion item"
11162 This forces the letters in the string into lower-case, for example:
11163 .code
11164 ${lc:$local_part}
11165 .endd
11166 Case is defined per the system C locale.
11167
11168 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11169 .cindex "expansion" "string truncation"
11170 .cindex "&%length%& expansion item"
11171 The &%length%& operator is a simpler interface to the &%length%& function that
11172 can be used when the parameter is a fixed number (as opposed to a string that
11173 changes when expanded). The effect is the same as
11174 .code
11175 ${length{<number>}{<string>}}
11176 .endd
11177 See the description of the general &%length%& item above for details. Note that
11178 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11179 when &%length%& is used as an operator.
11180 All measurement is done in bytes and is not UTF-8 aware.
11181
11182
11183 .vitem &*${listcount:*&<&'string'&>&*}*&
11184 .cindex "expansion" "list item count"
11185 .cindex "list" "item count"
11186 .cindex "list" "count of items"
11187 .cindex "&%listcount%& expansion item"
11188 The string is interpreted as a list and the number of items is returned.
11189
11190
11191 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11192 .cindex "expansion" "named list"
11193 .cindex "&%listnamed%& expansion item"
11194 The name is interpreted as a named list and the content of the list is returned,
11195 expanding any referenced lists, re-quoting as needed for colon-separation.
11196 If the optional type is given it must be one of "a", "d", "h" or "l"
11197 and selects address-, domain-, host- or localpart- lists to search among respectively.
11198 Otherwise all types are searched in an undefined order and the first
11199 matching list is returned.
11200 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11201 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11202
11203
11204 .vitem &*${local_part:*&<&'string'&>&*}*&
11205 .cindex "expansion" "local part extraction"
11206 .cindex "&%local_part%& expansion item"
11207 The string is interpreted as an RFC 2822 address and the local part is
11208 extracted from it. If the string does not parse successfully, the result is
11209 empty.
11210 The parsing correctly handles SMTPUTF8 Unicode in the string.
11211
11212
11213 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*& &&&
11214        &*${mask_n:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11215 .cindex "masked IP address"
11216 .cindex "IP address" "masking"
11217 .cindex "CIDR notation"
11218 .cindex "expansion" "IP address masking"
11219 .cindex "&%mask%& expansion item"
11220 If the form of the string to be operated on is not an IP address followed by a
11221 slash and an integer (that is, a network address in CIDR notation), the
11222 expansion fails. Otherwise, this operator converts the IP address to binary,
11223 masks off the least significant bits according to the bit count, and converts
11224 the result back to text, with mask appended. For example,
11225 .code
11226 ${mask:10.111.131.206/28}
11227 .endd
11228 returns the string &"10.111.131.192/28"&.
11229
11230 Since this operation is expected to
11231 be mostly used for looking up masked addresses in files, the
11232 normal
11233 result for an IPv6
11234 address uses dots to separate components instead of colons, because colon
11235 terminates a key string in lsearch files. So, for example,
11236 .code
11237 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11238 .endd
11239 returns the string
11240 .code
11241 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11242 .endd
11243 If the optional form &*mask_n*& is used, IPv6 address result are instead
11244 returned in normailsed form, using colons and with zero-compression.
11245 Letters in IPv6 addresses are always output in lower case.
11246
11247
11248 .vitem &*${md5:*&<&'string'&>&*}*&
11249 .cindex "MD5 hash"
11250 .cindex "expansion" "MD5 hash"
11251 .cindex certificate fingerprint
11252 .cindex "&%md5%& expansion item"
11253 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11254 as a 32-digit hexadecimal number, in which any letters are in lower case.
11255
11256 If the string is a single variable of type certificate,
11257 returns the MD5 hash fingerprint of the certificate.
11258
11259
11260 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11261 .cindex "expansion" "numeric hash"
11262 .cindex "hash function" "numeric"
11263 The &%nhash%& operator is a simpler interface to the numeric hashing function
11264 that can be used when the two parameters are fixed numbers (as opposed to
11265 strings that change when expanded). The effect is the same as
11266 .code
11267 ${nhash{<n>}{<m>}{<string>}}
11268 .endd
11269 See the description of the general &%nhash%& item above for details.
11270
11271
11272 .vitem &*${quote:*&<&'string'&>&*}*&
11273 .cindex "quoting" "in string expansions"
11274 .cindex "expansion" "quoting"
11275 .cindex "&%quote%& expansion item"
11276 The &%quote%& operator puts its argument into double quotes if it
11277 is an empty string or
11278 contains anything other than letters, digits, underscores, dots, and hyphens.
11279 Any occurrences of double quotes and backslashes are escaped with a backslash.
11280 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11281 respectively For example,
11282 .code
11283 ${quote:ab"*"cd}
11284 .endd
11285 becomes
11286 .code
11287 "ab\"*\"cd"
11288 .endd
11289 The place where this is useful is when the argument is a substitution from a
11290 variable or a message header.
11291
11292 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11293 .cindex "&%quote_local_part%& expansion item"
11294 This operator is like &%quote%&, except that it quotes the string only if
11295 required to do so by the rules of RFC 2822 for quoting local parts. For
11296 example, a plus sign would not cause quoting (but it would for &%quote%&).
11297 If you are creating a new email address from the contents of &$local_part$&
11298 (or any other unknown data), you should always use this operator.
11299
11300 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11301 will likely use the quoting form.
11302 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11303
11304
11305 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11306 .cindex "quoting" "lookup-specific"
11307 This operator applies lookup-specific quoting rules to the string. Each
11308 query-style lookup type has its own quoting rules which are described with
11309 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11310 .code
11311 ${quote_ldap:two * two}
11312 .endd
11313 returns
11314 .code
11315 two%20%5C2A%20two
11316 .endd
11317 For single-key lookup types, no quoting is ever necessary and this operator
11318 yields an unchanged string.
11319
11320
11321 .vitem &*${randint:*&<&'n'&>&*}*&
11322 .cindex "random number"
11323 This operator returns a somewhat random number which is less than the
11324 supplied number and is at least 0.  The quality of this randomness depends
11325 on how Exim was built; the values are not suitable for keying material.
11326 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11327 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11328 for versions of GnuTLS with that function.
11329 Otherwise, the implementation may be arc4random(), random() seeded by
11330 srandomdev() or srandom(), or a custom implementation even weaker than
11331 random().
11332
11333
11334 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11335 .cindex "expansion" "IP address"
11336 This operator reverses an IP address; for IPv4 addresses, the result is in
11337 dotted-quad decimal form, while for IPv6 addresses the result is in
11338 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11339 for DNS.  For example,
11340 .code
11341 ${reverse_ip:192.0.2.4}
11342 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11343 .endd
11344 returns
11345 .code
11346 4.2.0.192
11347 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
11348 .endd
11349
11350
11351 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11352 .cindex "expansion" "RFC 2047"
11353 .cindex "RFC 2047" "expansion operator"
11354 .cindex "&%rfc2047%& expansion item"
11355 This operator encodes text according to the rules of RFC 2047. This is an
11356 encoding that is used in header lines to encode non-ASCII characters. It is
11357 assumed that the input string is in the encoding specified by the
11358 &%headers_charset%& option, which gets its default at build time. If the string
11359 contains only characters in the range 33&--126, and no instances of the
11360 characters
11361 .code
11362 ? = ( ) < > @ , ; : \ " . [ ] _
11363 .endd
11364 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11365 string, using as many &"encoded words"& as necessary to encode all the
11366 characters.
11367
11368
11369 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11370 .cindex "expansion" "RFC 2047"
11371 .cindex "RFC 2047" "decoding"
11372 .cindex "&%rfc2047d%& expansion item"
11373 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11374 bytes are replaced by question marks. Characters are converted into the
11375 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11376 not recognized unless &%check_rfc2047_length%& is set false.
11377
11378 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11379 access a header line, RFC 2047 decoding is done automatically. You do not need
11380 to use this operator as well.
11381
11382
11383
11384 .vitem &*${rxquote:*&<&'string'&>&*}*&
11385 .cindex "quoting" "in regular expressions"
11386 .cindex "regular expressions" "quoting"
11387 .cindex "&%rxquote%& expansion item"
11388 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11389 characters in its argument. This is useful when substituting the values of
11390 variables or headers inside regular expressions.
11391
11392
11393 .vitem &*${sha1:*&<&'string'&>&*}*&
11394 .cindex "SHA-1 hash"
11395 .cindex "expansion" "SHA-1 hashing"
11396 .cindex certificate fingerprint
11397 .cindex "&%sha1%& expansion item"
11398 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11399 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11400
11401 If the string is a single variable of type certificate,
11402 returns the SHA-1 hash fingerprint of the certificate.
11403
11404
11405 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11406        &*${sha2:*&<&'string'&>&*}*& &&&
11407        &*${sha2_<n>:*&<&'string'&>&*}*&
11408 .cindex "SHA-256 hash"
11409 .cindex "SHA-2 hash"
11410 .cindex certificate fingerprint
11411 .cindex "expansion" "SHA-256 hashing"
11412 .cindex "&%sha256%& expansion item"
11413 .cindex "&%sha2%& expansion item"
11414 The &%sha256%& operator computes the SHA-256 hash value of the string
11415 and returns
11416 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11417
11418 If the string is a single variable of type certificate,
11419 returns the SHA-256 hash fingerprint of the certificate.
11420
11421 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11422 (except for certificates, which are not supported).
11423 Finally, if an underbar
11424 and a number is appended it specifies the output length, selecting a
11425 member of the SHA-2 family of hash functions.
11426 Values of 256, 384 and 512 are accepted, with 256 being the default.
11427
11428
11429 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11430        &*${sha3_<n>:*&<&'string'&>&*}*&
11431 .cindex "SHA3 hash"
11432 .cindex "expansion" "SHA3 hashing"
11433 .cindex "&%sha3%& expansion item"
11434 The &%sha3%& operator computes the SHA3-256 hash value of the string
11435 and returns
11436 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11437
11438 If a number is appended, separated by an underbar, it specifies
11439 the output length.  Values of 224, 256, 384 and 512 are accepted;
11440 with 256 being the default.
11441
11442 The &%sha3%& expansion item is only supported if Exim has been
11443 compiled with GnuTLS 3.5.0 or later,
11444 or OpenSSL 1.1.1 or later.
11445 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11446
11447
11448 .vitem &*${stat:*&<&'string'&>&*}*&
11449 .cindex "expansion" "statting a file"
11450 .cindex "file" "extracting characteristics"
11451 .cindex "&%stat%& expansion item"
11452 The string, after expansion, must be a file path. A call to the &[stat()]&
11453 function is made for this path. If &[stat()]& fails, an error occurs and the
11454 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11455 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11456 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11457 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11458 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11459 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11460 can extract individual fields using the &%extract%& expansion item.
11461
11462 The use of the &%stat%& expansion in users' filter files can be locked out by
11463 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11464 systems for files larger than 2GB.
11465
11466 .vitem &*${str2b64:*&<&'string'&>&*}*&
11467 .cindex "&%str2b64%& expansion item"
11468 Now deprecated, a synonym for the &%base64%& expansion operator.
11469
11470
11471
11472 .vitem &*${strlen:*&<&'string'&>&*}*&
11473 .cindex "expansion" "string length"
11474 .cindex "string" "length in expansion"
11475 .cindex "&%strlen%& expansion item"
11476 The item is replaced by the length of the expanded string, expressed as a
11477 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11478 All measurement is done in bytes and is not UTF-8 aware.
11479
11480
11481 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11482 .cindex "&%substr%& expansion item"
11483 .cindex "substring extraction"
11484 .cindex "expansion" "substring expansion"
11485 The &%substr%& operator is a simpler interface to the &%substr%& function that
11486 can be used when the two parameters are fixed numbers (as opposed to strings
11487 that change when expanded). The effect is the same as
11488 .code
11489 ${substr{<start>}{<length>}{<string>}}
11490 .endd
11491 See the description of the general &%substr%& item above for details. The
11492 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11493 All measurement is done in bytes and is not UTF-8 aware.
11494
11495 .vitem &*${time_eval:*&<&'string'&>&*}*&
11496 .cindex "&%time_eval%& expansion item"
11497 .cindex "time interval" "decoding"
11498 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11499 seconds.
11500
11501 .vitem &*${time_interval:*&<&'string'&>&*}*&
11502 .cindex "&%time_interval%& expansion item"
11503 .cindex "time interval" "formatting"
11504 The argument (after sub-expansion) must be a sequence of decimal digits that
11505 represents an interval of time as a number of seconds. It is converted into a
11506 number of larger units and output in Exim's normal time format, for example,
11507 &`1w3d4h2m6s`&.
11508
11509 .vitem &*${uc:*&<&'string'&>&*}*&
11510 .cindex "case forcing in strings"
11511 .cindex "string" "case forcing"
11512 .cindex "upper casing"
11513 .cindex "expansion" "case forcing"
11514 .cindex "&%uc%& expansion item"
11515 This forces the letters in the string into upper-case.
11516 Case is defined per the system C locale.
11517
11518 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11519 .cindex "correction of invalid utf-8 sequences in strings"
11520 .cindex "utf-8" "utf-8 sequences"
11521 .cindex "incorrect utf-8"
11522 .cindex "expansion" "utf-8 forcing"
11523 .cindex "&%utf8clean%& expansion item"
11524 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11525 In versions of Exim before 4.92, this did not correctly do so for a truncated
11526 final codepoint's encoding, and the character would be silently dropped.
11527 If you must handle detection of this scenario across both sets of Exim behavior,
11528 the complexity will depend upon the task.
11529 For instance, to detect if the first character is multibyte and a 1-byte
11530 extraction can be successfully used as a path component (as is common for
11531 dividing up delivery folders), you might use:
11532 .code
11533 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11534 .endd
11535 (which will false-positive if the first character of the local part is a
11536 literal question mark).
11537
11538 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11539        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11540        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11541        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11542 .cindex expansion UTF-8
11543 .cindex UTF-8 expansion
11544 .cindex EAI
11545 .cindex internationalisation
11546 .cindex "&%utf8_domain_to_alabel%& expansion item"
11547 .cindex "&%utf8_domain_from_alabel%& expansion item"
11548 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11549 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11550 These convert EAI mail name components between UTF-8 and a-label forms.
11551 For information on internationalisation support see &<<SECTi18nMTA>>&.
11552 .endlist
11553
11554
11555
11556
11557
11558
11559 .section "Expansion conditions" "SECTexpcond"
11560 .scindex IIDexpcond "expansion" "conditions"
11561 The following conditions are available for testing by the &%${if%& construct
11562 while expanding strings:
11563
11564 .vlist
11565 .vitem &*!*&<&'condition'&>
11566 .cindex "expansion" "negating a condition"
11567 .cindex "negation" "in expansion condition"
11568 Preceding any condition with an exclamation mark negates the result of the
11569 condition.
11570
11571 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11572 .cindex "numeric comparison"
11573 .cindex "expansion" "numeric comparison"
11574 There are a number of symbolic operators for doing numeric comparisons. They
11575 are:
11576 .itable none 0 0 2 10* left 90* left
11577 .irow "=   " "equal"
11578 .irow "==  " "equal"
11579 .irow ">   " "greater"
11580 .irow ">=  " "greater or equal"
11581 .irow "<   " "less"
11582 .irow "<=  " "less or equal"
11583 .endtable
11584 For example:
11585 .code
11586 ${if >{$message_size}{10M} ...
11587 .endd
11588 Note that the general negation operator provides for inequality testing. The
11589 two strings must take the form of optionally signed decimal integers,
11590 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11591 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11592 As a special case, the numerical value of an empty string is taken as
11593 zero.
11594
11595 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11596 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11597 10M, not if 10M is larger than &$message_size$&.
11598
11599
11600 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11601         {*&<&'arg2'&>&*}...}*&
11602 .cindex "expansion" "calling an acl"
11603 .cindex "&%acl%&" "expansion condition"
11604 The name and zero to nine argument strings are first expanded separately.  The expanded
11605 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11606 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11607 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11608 and may use the variables; if another acl expansion is used the values
11609 are restored after it returns.  If the ACL sets
11610 a value using a "message =" modifier the variable $value becomes
11611 the result of the expansion, otherwise it is empty.
11612 If the ACL returns accept the condition is true; if deny, false.
11613 If the ACL returns defer the result is a forced-fail.
11614
11615 .vitem &*bool&~{*&<&'string'&>&*}*&
11616 .cindex "expansion" "boolean parsing"
11617 .cindex "&%bool%& expansion condition"
11618 This condition turns a string holding a true or false representation into
11619 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11620 (case-insensitively); also integer numbers map to true if non-zero,
11621 false if zero.
11622 An empty string is treated as false.
11623 Leading and trailing whitespace is ignored;
11624 thus a string consisting only of whitespace is false.
11625 All other string values will result in expansion failure.
11626
11627 When combined with ACL variables, this expansion condition will let you
11628 make decisions in one place and act on those decisions in another place.
11629 For example:
11630 .code
11631 ${if bool{$acl_m_privileged_sender} ...
11632 .endd
11633
11634
11635 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11636 .cindex "expansion" "boolean parsing"
11637 .cindex "&%bool_lax%& expansion condition"
11638 Like &%bool%&, this condition turns a string into a boolean state.  But
11639 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11640 loose definition that the Router &%condition%& option uses.  The empty string
11641 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11642 true.  Leading and trailing whitespace is ignored.
11643
11644 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11645
11646 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11647 .cindex "expansion" "encrypted comparison"
11648 .cindex "encrypted strings, comparing"
11649 .cindex "&%crypteq%& expansion condition"
11650 This condition is included in the Exim binary if it is built to support any
11651 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11652 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11653 included in the binary.
11654
11655 The &%crypteq%& condition has two arguments. The first is encrypted and
11656 compared against the second, which is already encrypted. The second string may
11657 be in the LDAP form for storing encrypted strings, which starts with the
11658 encryption type in curly brackets, followed by the data. If the second string
11659 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11660 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11661 Typically this will be a field from a password file. An example of an encrypted
11662 string in LDAP form is:
11663 .code
11664 {md5}CY9rzUYh03PK3k6DJie09g==
11665 .endd
11666 If such a string appears directly in an expansion, the curly brackets have to
11667 be quoted, because they are part of the expansion syntax. For example:
11668 .code
11669 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11670 .endd
11671 The following encryption types (whose names are matched case-independently) are
11672 supported:
11673
11674 .ilist
11675 .cindex "MD5 hash"
11676 .cindex "base64 encoding" "in encrypted password"
11677 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11678 printable characters to compare with the remainder of the second string. If the
11679 length of the comparison string is 24, Exim assumes that it is base64 encoded
11680 (as in the above example). If the length is 32, Exim assumes that it is a
11681 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11682 comparison fails.
11683
11684 .next
11685 .cindex "SHA-1 hash"
11686 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11687 printable characters to compare with the remainder of the second string. If the
11688 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11689 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11690 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11691
11692 .next
11693 .cindex "&[crypt()]&"
11694 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11695 only the first eight characters of the password. However, in modern operating
11696 systems this is no longer true, and in many cases the entire password is used,
11697 whatever its length.
11698
11699 .next
11700 .cindex "&[crypt16()]&"
11701 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11702 use up to 16 characters of the password in some operating systems. Again, in
11703 modern operating systems, more characters may be used.
11704 .endlist
11705 Exim has its own version of &[crypt16()]&, which is just a double call to
11706 &[crypt()]&. For operating systems that have their own version, setting
11707 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11708 operating system version instead of its own. This option is set by default in
11709 the OS-dependent &_Makefile_& for those operating systems that are known to
11710 support &[crypt16()]&.
11711
11712 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11713 it was not using the same algorithm as some operating systems' versions. It
11714 turns out that as well as &[crypt16()]& there is a function called
11715 &[bigcrypt()]& in some operating systems. This may or may not use the same
11716 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11717
11718 However, since there is now a move away from the traditional &[crypt()]&
11719 functions towards using SHA1 and other algorithms, tidying up this area of
11720 Exim is seen as very low priority.
11721
11722 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11723 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11724 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11725 default is &`{crypt}`&. Whatever the default, you can always use either
11726 function by specifying it explicitly in curly brackets.
11727
11728 .vitem &*def:*&<&'variable&~name'&>
11729 .cindex "expansion" "checking for empty variable"
11730 .cindex "&%def%& expansion condition"
11731 The &%def%& condition must be followed by the name of one of the expansion
11732 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11733 variable does not contain the empty string. For example:
11734 .code
11735 ${if def:sender_ident {from $sender_ident}}
11736 .endd
11737 Note that the variable name is given without a leading &%$%& character. If the
11738 variable does not exist, the expansion fails.
11739
11740 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11741         &~&*def:h_*&<&'header&~name'&>&*:*&"
11742 .cindex "expansion" "checking header line existence"
11743 This condition is true if a message is being processed and the named header
11744 exists in the message. For example,
11745 .code
11746 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11747 .endd
11748 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11749 the header name must be terminated by a colon if white space does not follow.
11750
11751 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11752        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11753 .cindex "string" "comparison"
11754 .cindex "expansion" "string comparison"
11755 .cindex "&%eq%& expansion condition"
11756 .cindex "&%eqi%& expansion condition"
11757 The two substrings are first expanded. The condition is true if the two
11758 resulting strings are identical. For &%eq%& the comparison includes the case of
11759 letters, whereas for &%eqi%& the comparison is case-independent, where
11760 case is defined per the system C locale.
11761
11762 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11763 .cindex "expansion" "file existence test"
11764 .cindex "file" "existence test"
11765 .cindex "&%exists%&, expansion condition"
11766 The substring is first expanded and then interpreted as an absolute path. The
11767 condition is true if the named file (or directory) exists. The existence test
11768 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11769 users' filter files may be locked out by the system administrator.
11770
11771 &*Note:*& Testing a path using this condition is not a sufficient way of
11772 de-tainting it.
11773 Consider using a dsearch lookup.
11774
11775 .vitem &*first_delivery*&
11776 .cindex "delivery" "first"
11777 .cindex "first delivery"
11778 .cindex "expansion" "first delivery test"
11779 .cindex "&%first_delivery%& expansion condition"
11780 .cindex retry condition
11781 This condition, which has no data, is true during a message's first delivery
11782 attempt. It is false during any subsequent delivery attempts.
11783
11784
11785 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11786        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11787 .cindex "list" "iterative conditions"
11788 .cindex "expansion" "&*forall*& condition"
11789 .cindex "expansion" "&*forany*& condition"
11790 .vindex "&$item$&"
11791 These conditions iterate over a list. The first argument is expanded to form
11792 the list. By default, the list separator is a colon, but it can be changed by
11793 the normal method (&<<SECTlistsepchange>>&).
11794 The second argument is interpreted as a condition that is to
11795 be applied to each item in the list in turn. During the interpretation of the
11796 condition, the current list item is placed in a variable called &$item$&.
11797 .ilist
11798 For &*forany*&, interpretation stops if the condition is true for any item, and
11799 the result of the whole condition is true. If the condition is false for all
11800 items in the list, the overall condition is false.
11801 .next
11802 For &*forall*&, interpretation stops if the condition is false for any item,
11803 and the result of the whole condition is false. If the condition is true for
11804 all items in the list, the overall condition is true.
11805 .endlist
11806 Note that negation of &*forany*& means that the condition must be false for all
11807 items for the overall condition to succeed, and negation of &*forall*& means
11808 that the condition must be false for at least one item.
11809
11810 Example:
11811 .code
11812 ${if forany{$recipients_list}{match{$item}{^user3@}}{yes}{no}}
11813 .endd
11814 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11815 being processed, to enable these expansion items to be nested.
11816
11817 To scan a named list, expand it with the &*listnamed*& operator.
11818
11819 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11820        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11821        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11822        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11823 .cindex JSON "iterative conditions"
11824 .cindex JSON expansions
11825 .cindex expansion "&*forall_json*& condition"
11826 .cindex expansion "&*forany_json*& condition"
11827 .cindex expansion "&*forall_jsons*& condition"
11828 .cindex expansion "&*forany_jsons*& condition"
11829 As for the above, except that the first argument must, after expansion,
11830 be a JSON array.
11831 The array separator is not changeable.
11832 For the &"jsons"& variants the elements are expected to be JSON strings
11833 and have their quotes removed before the evaluation of the condition.
11834
11835
11836
11837 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11838        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11839 .cindex "string" "comparison"
11840 .cindex "expansion" "string comparison"
11841 .cindex "&%ge%& expansion condition"
11842 .cindex "&%gei%& expansion condition"
11843 The two substrings are first expanded. The condition is true if the first
11844 string is lexically greater than or equal to the second string. For &%ge%& the
11845 comparison includes the case of letters, whereas for &%gei%& the comparison is
11846 case-independent.
11847 Case and collation order are defined per the system C locale.
11848
11849 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11850        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11851 .cindex "string" "comparison"
11852 .cindex "expansion" "string comparison"
11853 .cindex "&%gt%& expansion condition"
11854 .cindex "&%gti%& expansion condition"
11855 The two substrings are first expanded. The condition is true if the first
11856 string is lexically greater than the second string. For &%gt%& the comparison
11857 includes the case of letters, whereas for &%gti%& the comparison is
11858 case-independent.
11859 Case and collation order are defined per the system C locale.
11860
11861
11862 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11863 SRS decode.  See SECT &<<SECTSRS>>& for details.
11864
11865
11866 .vitem &*inlist&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*& &&&
11867        &*inlisti&~{*&<&'subject'&>&*}{*&<&'list'&>&*}*&
11868 .cindex "string" "comparison"
11869 .cindex "list" "iterative conditions"
11870 Both strings are expanded; the second string is treated as a list of simple
11871 strings; if the first string is a member of the second, then the condition
11872 is true.
11873 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11874
11875 These are simpler to use versions of the more powerful &*forany*& condition.
11876 Examples, and the &*forany*& equivalents:
11877 .code
11878 ${if inlist{needle}{foo:needle:bar}}
11879   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11880 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11881   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11882 .endd
11883
11884 The variable &$value$& will be set for a successful match and can be
11885 used in the success clause of an &%if%& expansion item using the condition.
11886 .cindex "tainted data" "de-tainting"
11887 .cindex "de-tainting" "using an inlist expansion condition"
11888 It will have the same taint status as the list; expansions such as
11889 .code
11890 ${if inlist {$h_mycode:} {0 : 1 : 42} {$value}}
11891 .endd
11892 can be used for de-tainting.
11893 Any previous &$value$& is restored after the if.
11894
11895
11896 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11897        &*isip4&~{*&<&'string'&>&*}*& &&&
11898        &*isip6&~{*&<&'string'&>&*}*&
11899 .cindex "IP address" "testing string format"
11900 .cindex "string" "testing for IP address"
11901 .cindex "&%isip%& expansion condition"
11902 .cindex "&%isip4%& expansion condition"
11903 .cindex "&%isip6%& expansion condition"
11904 The substring is first expanded, and then tested to see if it has the form of
11905 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11906 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11907
11908 For an IPv4 address, the test is for four dot-separated components, each of
11909 which consists of from one to three digits. For an IPv6 address, up to eight
11910 colon-separated components are permitted, each containing from one to four
11911 hexadecimal digits. There may be fewer than eight components if an empty
11912 component (adjacent colons) is present. Only one empty component is permitted.
11913
11914 &*Note*&: The checks used to be just on the form of the address; actual numerical
11915 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11916 check.
11917 This is no longer the case.
11918
11919 The main use of these tests is to distinguish between IP addresses and
11920 host names, or between IPv4 and IPv6 addresses. For example, you could use
11921 .code
11922 ${if isip4{$sender_host_address}...
11923 .endd
11924 to test which IP version an incoming SMTP connection is using.
11925
11926 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11927 .cindex "LDAP" "use for authentication"
11928 .cindex "expansion" "LDAP authentication test"
11929 .cindex "&%ldapauth%& expansion condition"
11930 This condition supports user authentication using LDAP. See section
11931 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11932 queries. For this use, the query must contain a user name and password. The
11933 query itself is not used, and can be empty. The condition is true if the
11934 password is not empty, and the user name and password are accepted by the LDAP
11935 server. An empty password is rejected without calling LDAP because LDAP binds
11936 with an empty password are considered anonymous regardless of the username, and
11937 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11938 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11939 this can be used.
11940
11941
11942 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11943        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11944 .cindex "string" "comparison"
11945 .cindex "expansion" "string comparison"
11946 .cindex "&%le%& expansion condition"
11947 .cindex "&%lei%& expansion condition"
11948 The two substrings are first expanded. The condition is true if the first
11949 string is lexically less than or equal to the second string. For &%le%& the
11950 comparison includes the case of letters, whereas for &%lei%& the comparison is
11951 case-independent.
11952 Case and collation order are defined per the system C locale.
11953
11954 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11955        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11956 .cindex "string" "comparison"
11957 .cindex "expansion" "string comparison"
11958 .cindex "&%lt%& expansion condition"
11959 .cindex "&%lti%& expansion condition"
11960 The two substrings are first expanded. The condition is true if the first
11961 string is lexically less than the second string. For &%lt%& the comparison
11962 includes the case of letters, whereas for &%lti%& the comparison is
11963 case-independent.
11964 Case and collation order are defined per the system C locale.
11965
11966
11967 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11968 .cindex "expansion" "regular expression comparison"
11969 .cindex "regular expressions" "match in expanded string"
11970 .cindex "&%match%& expansion condition"
11971 The two substrings are first expanded. The second is then treated as a regular
11972 expression and applied to the first. Because of the pre-expansion, if the
11973 regular expression contains dollar, or backslash characters, they must be
11974 escaped. Care must also be taken if the regular expression contains braces
11975 (curly brackets). A closing brace must be escaped so that it is not taken as a
11976 premature termination of <&'string2'&>. The easiest approach is to use the
11977 &`\N`& feature to disable expansion of the regular expression.
11978 For example,
11979 .code
11980 ${if match {$local_part}{\N^\d{3}\N} ...
11981 .endd
11982 If the whole expansion string is in double quotes, further escaping of
11983 backslashes is also required.
11984
11985 The condition is true if the regular expression match succeeds.
11986 The regular expression is not required to begin with a circumflex
11987 metacharacter, but if there is no circumflex, the expression is not anchored,
11988 and it may match anywhere in the subject, not just at the start. If you want
11989 the pattern to match at the end of the subject, you must include the &`$`&
11990 metacharacter at an appropriate point.
11991 All character handling is done in bytes and is not UTF-8 aware,
11992 but we might change this in a future Exim release.
11993
11994 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11995 At the start of an &%if%& expansion the values of the numeric variable
11996 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11997 succeeds causes them to be reset to the substrings of that condition and they
11998 will have these values during the expansion of the success string. At the end
11999 of the &%if%& expansion, the previous values are restored. After testing a
12000 combination of conditions using &%or%&, the subsequent values of the numeric
12001 variables are those of the condition that succeeded.
12002
12003 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12004 .cindex "&%match_address%& expansion condition"
12005 See &*match_local_part*&.
12006
12007 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12008 .cindex "&%match_domain%& expansion condition"
12009 See &*match_local_part*&.
12010
12011 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12012 .cindex "&%match_ip%& expansion condition"
12013 This condition matches an IP address to a list of IP address patterns. It must
12014 be followed by two argument strings. The first (after expansion) must be an IP
12015 address or an empty string. The second (not expanded) is a restricted host
12016 list that can match only an IP address, not a host name. For example:
12017 .code
12018 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
12019 .endd
12020 The specific types of host list item that are permitted in the list are:
12021
12022 .ilist
12023 An IP address, optionally with a CIDR mask.
12024 .next
12025 A single asterisk, which matches any IP address.
12026 .next
12027 An empty item, which matches only if the IP address is empty. This could be
12028 useful for testing for a locally submitted message or one from specific hosts
12029 in a single test such as
12030 . ==== As this is a nested list, any displays it contains must be indented
12031 . ==== as otherwise they are too far to the left. This comment applies to
12032 . ==== the use of xmlto plus fop. There's no problem when formatting with
12033 . ==== sdop, with or without the extra indent.
12034 .code
12035   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
12036 .endd
12037 where the first item in the list is the empty string.
12038 .next
12039 The item @[] matches any of the local host's interface addresses.
12040 .next
12041 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12042 even if &`net-`& is not specified. There is never any attempt to turn the IP
12043 address into a host name. The most common type of linear search for
12044 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12045 masks. For example:
12046 .code
12047   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12048 .endd
12049 It is of course possible to use other kinds of lookup, and in such a case, you
12050 do need to specify the &`net-`& prefix if you want to specify a specific
12051 address mask, for example:
12052 .code
12053   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12054 .endd
12055 However, unless you are combining a &%match_ip%& condition with others, it is
12056 just as easy to use the fact that a lookup is itself a condition, and write:
12057 .code
12058   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12059 .endd
12060 .endlist ilist
12061
12062 Note that <&'string2'&> is not itself subject to string expansion, unless
12063 Exim was built with the EXPAND_LISTMATCH_RHS option.
12064
12065 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12066
12067 The variable &$value$& will be set for a successful match and can be
12068 used in the success clause of an &%if%& expansion item using the condition.
12069 Any previous &$value$& is restored after the if.
12070
12071 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12072 .cindex "domain list" "in expansion condition"
12073 .cindex "address list" "in expansion condition"
12074 .cindex "local part" "list, in expansion condition"
12075 .cindex "&%match_local_part%& expansion condition"
12076 This condition, together with &%match_address%& and &%match_domain%&, make it
12077 possible to test domain, address, and local part lists within expansions. Each
12078 condition requires two arguments: an item and a list to match. A trivial
12079 example is:
12080 .code
12081 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12082 .endd
12083 In each case, the second argument may contain any of the allowable items for a
12084 list of the appropriate type. Also, because the second argument
12085 is a standard form of list, it is possible to refer to a named list.
12086 Thus, you can use conditions like this:
12087 .code
12088 ${if match_domain{$domain}{+local_domains}{...
12089 .endd
12090 .cindex "&`+caseful`&"
12091 For address lists, the matching starts off caselessly, but the &`+caseful`&
12092 item can be used, as in all address lists, to cause subsequent items to
12093 have their local parts matched casefully. Domains are always matched
12094 caselessly.
12095
12096 The variable &$value$& will be set for a successful match and can be
12097 used in the success clause of an &%if%& expansion item using the condition.
12098 .cindex "tainted data" "de-tainting"
12099 .cindex "de-tainting" "using a match_local_part expansion condition"
12100 It will have the same taint status as the list; expansions such as
12101 .code
12102 ${if match_local_part {$local_part} {alice : bill : charlotte : dave} {$value}}
12103 .endd
12104 can be used for de-tainting.
12105 Any previous &$value$& is restored after the if.
12106
12107 Note that <&'string2'&> is not itself subject to string expansion, unless
12108 Exim was built with the EXPAND_LISTMATCH_RHS option.
12109
12110 &*Note*&: Host lists are &'not'& supported in this way. This is because
12111 hosts have two identities: a name and an IP address, and it is not clear
12112 how to specify cleanly how such a test would work. However, IP addresses can be
12113 matched using &%match_ip%&.
12114
12115 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12116 .cindex "PAM authentication"
12117 .cindex "AUTH" "with PAM"
12118 .cindex "Solaris" "PAM support"
12119 .cindex "expansion" "PAM authentication test"
12120 .cindex "&%pam%& expansion condition"
12121 &'Pluggable Authentication Modules'&
12122 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12123 available in Solaris
12124 and in some GNU/Linux distributions.
12125 The Exim support, which is intended for use in conjunction with
12126 the SMTP AUTH command, is available only if Exim is compiled with
12127 .code
12128 SUPPORT_PAM=yes
12129 .endd
12130 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12131 in some releases of GNU/Linux &%-ldl%& is also needed.
12132
12133 The argument string is first expanded, and the result must be a
12134 colon-separated list of strings. Leading and trailing white space is ignored.
12135 The PAM module is initialized with the service name &"exim"& and the user name
12136 taken from the first item in the colon-separated data string (<&'string1'&>).
12137 The remaining items in the data string are passed over in response to requests
12138 from the authentication function. In the simple case there will only be one
12139 request, for a password, so the data consists of just two strings.
12140
12141 There can be problems if any of the strings are permitted to contain colon
12142 characters. In the usual way, these have to be doubled to avoid being taken as
12143 separators.
12144 The &%listquote%& expansion item can be used for this.
12145 For example, the configuration
12146 of a LOGIN authenticator might contain this setting:
12147 .code
12148 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12149 .endd
12150 In some operating systems, PAM authentication can be done only from a process
12151 running as root. Since Exim is running as the Exim user when receiving
12152 messages, this means that PAM cannot be used directly in those systems.
12153 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12154
12155
12156 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12157 .cindex "&'pwcheck'& daemon"
12158 .cindex "Cyrus"
12159 .cindex "expansion" "&'pwcheck'& authentication test"
12160 .cindex "&%pwcheck%& expansion condition"
12161 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12162 This is one way of making it possible for passwords to be checked by a process
12163 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12164 deprecated. Its replacement is &'saslauthd'& (see below).
12165
12166 The pwcheck support is not included in Exim by default. You need to specify
12167 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12168 building Exim. For example:
12169 .code
12170 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12171 .endd
12172 You do not need to install the full Cyrus software suite in order to use
12173 the pwcheck daemon. You can compile and install just the daemon alone
12174 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12175 access to the &_/var/pwcheck_& directory.
12176
12177 The &%pwcheck%& condition takes one argument, which must be the user name and
12178 password, separated by a colon. For example, in a LOGIN authenticator
12179 configuration, you might have this:
12180 .code
12181 server_condition = ${if pwcheck{$auth1:$auth2}}
12182 .endd
12183 Again, for a PLAIN authenticator configuration, this would be:
12184 .code
12185 server_condition = ${if pwcheck{$auth2:$auth3}}
12186 .endd
12187 .vitem &*queue_running*&
12188 .cindex "queue runner" "detecting when delivering from"
12189 .cindex "expansion" "queue runner test"
12190 .cindex "&%queue_running%& expansion condition"
12191 This condition, which has no data, is true during delivery attempts that are
12192 initiated by queue runner processes, and false otherwise.
12193
12194
12195 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12196 .cindex "Radius"
12197 .cindex "expansion" "Radius authentication"
12198 .cindex "&%radius%& expansion condition"
12199 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12200 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12201 the Radius client configuration file in order to build Exim with Radius
12202 support.
12203
12204 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12205 library, using the original API. If you are using release 0.4.0 or later of
12206 this library, you need to set
12207 .code
12208 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12209 .endd
12210 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12211 &%libradius%& library that comes with FreeBSD. To do this, set
12212 .code
12213 RADIUS_LIB_TYPE=RADLIB
12214 .endd
12215 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12216 You may also have to supply a suitable setting in EXTRALIBS so that the
12217 Radius library can be found when Exim is linked.
12218
12219 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12220 Radius client library, which calls the Radius server. The condition is true if
12221 the authentication is successful. For example:
12222 .code
12223 server_condition = ${if radius{<arguments>}}
12224 .endd
12225
12226
12227 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12228         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12229 .cindex "&'saslauthd'& daemon"
12230 .cindex "Cyrus"
12231 .cindex "expansion" "&'saslauthd'& authentication test"
12232 .cindex "&%saslauthd%& expansion condition"
12233 This condition supports user authentication using the Cyrus &'saslauthd'&
12234 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12235 Using this daemon is one way of making it possible for passwords to be checked
12236 by a process that is not running as root.
12237
12238 The saslauthd support is not included in Exim by default. You need to specify
12239 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12240 building Exim. For example:
12241 .code
12242 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12243 .endd
12244 You do not need to install the full Cyrus software suite in order to use
12245 the saslauthd daemon. You can compile and install just the daemon alone
12246 from the Cyrus SASL library.
12247
12248 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12249 two are mandatory. For example:
12250 .code
12251 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12252 .endd
12253 The service and the realm are optional (which is why the arguments are enclosed
12254 in their own set of braces). For details of the meaning of the service and
12255 realm, and how to run the daemon, consult the Cyrus documentation.
12256 .endlist vlist
12257
12258
12259
12260 .section "Combining expansion conditions" "SECID84"
12261 .cindex "expansion" "combining conditions"
12262 Several conditions can be tested at once by combining them using the &%and%&
12263 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12264 conditions on their own, and precede their lists of sub-conditions. Each
12265 sub-condition must be enclosed in braces within the overall braces that contain
12266 the list. No repetition of &%if%& is used.
12267
12268
12269 .vlist
12270 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12271 .cindex "&""or""& expansion condition"
12272 .cindex "expansion" "&""or""& of conditions"
12273 The sub-conditions are evaluated from left to right. The condition is true if
12274 any one of the sub-conditions is true.
12275 For example,
12276 .code
12277 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12278 .endd
12279 When a true sub-condition is found, the following ones are parsed but not
12280 evaluated. If there are several &"match"& sub-conditions the values of the
12281 numeric variables afterwards are taken from the first one that succeeds.
12282
12283 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12284 .cindex "&""and""& expansion condition"
12285 .cindex "expansion" "&""and""& of conditions"
12286 The sub-conditions are evaluated from left to right. The condition is true if
12287 all of the sub-conditions are true. If there are several &"match"&
12288 sub-conditions, the values of the numeric variables afterwards are taken from
12289 the last one. When a false sub-condition is found, the following ones are
12290 parsed but not evaluated.
12291 .endlist
12292 .ecindex IIDexpcond
12293
12294
12295
12296
12297 .section "Expansion variables" "SECTexpvar"
12298 .cindex "expansion" "variables, list of"
12299 This section contains an alphabetical list of all the expansion variables. Some
12300 of them are available only when Exim is compiled with specific options such as
12301 support for TLS or the content scanning extension.
12302 .cindex "tainted data"
12303 Variables marked as &'tainted'& are likely to carry data supplied by
12304 a potential attacker.
12305 Variables without such marking may also, depending on how their
12306 values are created.
12307 Such variables should not be further expanded,
12308 used as filenames
12309 or used as command-line arguments for external commands.
12310
12311 .vlist
12312 .vitem "&$0$&, &$1$&, etc"
12313 .cindex "numerical variables (&$1$& &$2$& etc)"
12314 When a &%match%& expansion condition succeeds, these variables contain the
12315 captured substrings identified by the regular expression during subsequent
12316 processing of the success string of the containing &%if%& expansion item.
12317 In the expansion condition case
12318 they do not retain their values afterwards; in fact, their previous
12319 values are restored at the end of processing an &%if%& item. The numerical
12320 variables may also be set externally by some other matching process which
12321 precedes the expansion of the string. For example, the commands available in
12322 Exim filter files include an &%if%& command with its own regular expression
12323 matching condition.
12324 If the subject string was tainted then any captured substring will also be.
12325
12326 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12327 Within an acl condition, expansion condition or expansion item
12328 any arguments are copied to these variables,
12329 any unused variables being made empty.
12330
12331 .vitem "&$acl_c...$&"
12332 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12333 can be given any name that starts with &$acl_c$& and is at least six characters
12334 long, but the sixth character must be either a digit or an underscore. For
12335 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12336 variables persist throughout the lifetime of an SMTP connection. They can be
12337 used to pass information between ACLs and between different invocations of the
12338 same ACL. When a message is received, the values of these variables are saved
12339 with the message, and can be accessed by filters, routers, and transports
12340 during subsequent delivery.
12341
12342 .vitem "&$acl_m...$&"
12343 These variables are like the &$acl_c...$& variables, except that their values
12344 are reset after a message has been received. Thus, if several messages are
12345 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12346 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12347 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12348 message is received, the values of these variables are saved with the message,
12349 and can be accessed by filters, routers, and transports during subsequent
12350 delivery.
12351
12352 .vitem &$acl_narg$&
12353 Within an acl condition, expansion condition or expansion item
12354 this variable has the number of arguments.
12355
12356 .vitem &$acl_verify_message$&
12357 .vindex "&$acl_verify_message$&"
12358 After an address verification has failed, this variable contains the failure
12359 message. It retains its value for use in subsequent modifiers of the verb.
12360 The message can be preserved by coding like this:
12361 .code
12362 warn !verify = sender
12363      set acl_m0 = $acl_verify_message
12364 .endd
12365 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12366 &%log_message%& modifiers, to include information about the verification
12367 failure.
12368 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12369
12370 .vitem &$address_data$&
12371 .vindex "&$address_data$&"
12372 This variable is set by means of the &%address_data%& option in routers. The
12373 value then remains with the address while it is processed by subsequent routers
12374 and eventually a transport. If the transport is handling multiple addresses,
12375 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12376 for more details. &*Note*&: The contents of &$address_data$& are visible in
12377 user filter files.
12378
12379 If &$address_data$& is set when the routers are called from an ACL to verify
12380 a recipient address, the final value is still in the variable for subsequent
12381 conditions and modifiers of the ACL statement. If routing the address caused it
12382 to be redirected to just one address, the child address is also routed as part
12383 of the verification, and in this case the final value of &$address_data$& is
12384 from the child's routing.
12385
12386 If &$address_data$& is set when the routers are called from an ACL to verify a
12387 sender address, the final value is also preserved, but this time in
12388 &$sender_address_data$&, to distinguish it from data from a recipient
12389 address.
12390
12391 In both cases (recipient and sender verification), the value does not persist
12392 after the end of the current ACL statement. If you want to preserve
12393 these values for longer, you can save them in ACL variables.
12394
12395 .vitem &$address_file$&
12396 .vindex "&$address_file$&"
12397 When, as a result of aliasing, forwarding, or filtering, a message is directed
12398 to a specific file, this variable holds the name of the file when the transport
12399 is running. At other times, the variable is empty. For example, using the
12400 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12401 .code
12402 /home/r2d2/savemail
12403 .endd
12404 then when the &(address_file)& transport is running, &$address_file$&
12405 contains the text string &`/home/r2d2/savemail`&.
12406 .cindex "Sieve filter" "value of &$address_file$&"
12407 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12408 then up to the transport configuration to generate an appropriate absolute path
12409 to the relevant file.
12410
12411 .vitem &$address_pipe$&
12412 .vindex "&$address_pipe$&"
12413 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12414 this variable holds the pipe command when the transport is running.
12415
12416 .vitem "&$auth1$& &-- &$auth4$&"
12417 .vindex "&$auth1$&, &$auth2$&, etc"
12418 These variables are used in SMTP authenticators (see chapters
12419 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12420
12421 .vitem &$authenticated_id$&
12422 .cindex "authentication" "id"
12423 .vindex "&$authenticated_id$&"
12424 When a server successfully authenticates a client it may be configured to
12425 preserve some of the authentication information in the variable
12426 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12427 user/password authenticator configuration might preserve the user name for use
12428 in the routers. Note that this is not the same information that is saved in
12429 &$sender_host_authenticated$&.
12430
12431 When a message is submitted locally (that is, not over a TCP connection)
12432 the value of &$authenticated_id$& is normally the login name of the calling
12433 process. However, a trusted user can override this by means of the &%-oMai%&
12434 command line option.
12435 This second case also sets up information used by the
12436 &$authresults$& expansion item.
12437
12438 .vitem &$authenticated_fail_id$&
12439 .cindex "authentication" "fail" "id"
12440 .vindex "&$authenticated_fail_id$&"
12441 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12442 will contain the failed authentication id. If more than one authentication
12443 id is attempted, it will contain only the last one. The variable is
12444 available for processing in the ACL's, generally the quit or notquit ACL.
12445 A message to a local recipient could still be accepted without requiring
12446 authentication, which means this variable could also be visible in all of
12447 the ACL's as well.
12448
12449
12450 .tvar &$authenticated_sender$&
12451 .cindex "sender" "authenticated"
12452 .cindex "authentication" "sender"
12453 .cindex "AUTH" "on MAIL command"
12454 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12455 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12456 described in section &<<SECTauthparamail>>&. Unless the data is the string
12457 &"<>"&, it is set as the authenticated sender of the message, and the value is
12458 available during delivery in the &$authenticated_sender$& variable. If the
12459 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12460
12461 .vindex "&$qualify_domain$&"
12462 When a message is submitted locally (that is, not over a TCP connection), the
12463 value of &$authenticated_sender$& is an address constructed from the login
12464 name of the calling process and &$qualify_domain$&, except that a trusted user
12465 can override this by means of the &%-oMas%& command line option.
12466
12467
12468 .vitem &$authentication_failed$&
12469 .cindex "authentication" "failure"
12470 .vindex "&$authentication_failed$&"
12471 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12472 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12473 possible to distinguish between &"did not try to authenticate"&
12474 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12475 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12476 is empty and &$authentication_failed$& is set to &"1"&).
12477 Failure includes cancellation of a authentication attempt,
12478 and any negative response to an AUTH command,
12479 (including, for example, an attempt to use an undefined mechanism).
12480
12481 .vitem &$av_failed$&
12482 .cindex "content scanning" "AV scanner failure"
12483 This variable is available when Exim is compiled with the content-scanning
12484 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12485 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12486 the ACL malware condition.
12487
12488 .vitem &$body_linecount$&
12489 .cindex "message body" "line count"
12490 .cindex "body of message" "line count"
12491 .vindex "&$body_linecount$&"
12492 When a message is being received or delivered, this variable contains the
12493 number of lines in the message's body. See also &$message_linecount$&.
12494
12495 .vitem &$body_zerocount$&
12496 .cindex "message body" "binary zero count"
12497 .cindex "body of message" "binary zero count"
12498 .cindex "binary zero" "in message body"
12499 .vindex "&$body_zerocount$&"
12500 When a message is being received or delivered, this variable contains the
12501 number of binary zero bytes (ASCII NULs) in the message's body.
12502
12503 .vitem &$bounce_recipient$&
12504 .vindex "&$bounce_recipient$&"
12505 This is set to the recipient address of a bounce message while Exim is creating
12506 it. It is useful if a customized bounce message text file is in use (see
12507 chapter &<<CHAPemsgcust>>&).
12508
12509 .vitem &$bounce_return_size_limit$&
12510 .vindex "&$bounce_return_size_limit$&"
12511 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12512 up to a multiple of 1000. It is useful when a customized error message text
12513 file is in use (see chapter &<<CHAPemsgcust>>&).
12514
12515 .vitem &$caller_gid$&
12516 .cindex "gid (group id)" "caller"
12517 .vindex "&$caller_gid$&"
12518 The real group id under which the process that called Exim was running. This is
12519 not the same as the group id of the originator of a message (see
12520 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12521 incarnation normally contains the Exim gid.
12522
12523 .vitem &$caller_uid$&
12524 .cindex "uid (user id)" "caller"
12525 .vindex "&$caller_uid$&"
12526 The real user id under which the process that called Exim was running. This is
12527 not the same as the user id of the originator of a message (see
12528 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12529 incarnation normally contains the Exim uid.
12530
12531 .vitem &$callout_address$&
12532 .vindex "&$callout_address$&"
12533 After a callout for verification, spamd or malware daemon service, the
12534 address that was connected to.
12535
12536 .vitem &$compile_number$&
12537 .vindex "&$compile_number$&"
12538 The building process for Exim keeps a count of the number
12539 of times it has been compiled. This serves to distinguish different
12540 compilations of the same version of Exim.
12541
12542 .vitem &$config_dir$&
12543 .vindex "&$config_dir$&"
12544 The directory name of the main configuration file. That is, the content of
12545 &$config_file$& with the last component stripped. The value does not
12546 contain the trailing slash. If &$config_file$& does not contain a slash,
12547 &$config_dir$& is ".".
12548
12549 .vitem &$config_file$&
12550 .vindex "&$config_file$&"
12551 The name of the main configuration file Exim is using.
12552
12553 .vitem &$dkim_verify_status$&
12554 Results of DKIM verification.
12555 For details see section &<<SECDKIMVFY>>&.
12556
12557 .vitem &$dkim_cur_signer$& &&&
12558        &$dkim_verify_reason$& &&&
12559        &$dkim_domain$& &&&
12560        &$dkim_identity$& &&&
12561        &$dkim_selector$& &&&
12562        &$dkim_algo$& &&&
12563        &$dkim_canon_body$& &&&
12564        &$dkim_canon_headers$& &&&
12565        &$dkim_copiedheaders$& &&&
12566        &$dkim_bodylength$& &&&
12567        &$dkim_created$& &&&
12568        &$dkim_expires$& &&&
12569        &$dkim_headernames$& &&&
12570        &$dkim_key_testing$& &&&
12571        &$dkim_key_nosubdomains$& &&&
12572        &$dkim_key_srvtype$& &&&
12573        &$dkim_key_granularity$& &&&
12574        &$dkim_key_notes$& &&&
12575        &$dkim_key_length$&
12576 These variables are only available within the DKIM ACL.
12577 For details see section &<<SECDKIMVFY>>&.
12578
12579 .vitem &$dkim_signers$&
12580 .vindex &$dkim_signers$&
12581 When a message has been received this variable contains
12582 a colon-separated list of signer domains and identities for the message.
12583 For details see section &<<SECDKIMVFY>>&.
12584
12585 .vitem &$dmarc_domain_policy$& &&&
12586        &$dmarc_status$& &&&
12587        &$dmarc_status_text$& &&&
12588        &$dmarc_used_domains$&
12589 Results of DMARC verification.
12590 For details see section &<<SECDMARC>>&.
12591
12592 .vitem &$dnslist_domain$& &&&
12593        &$dnslist_matched$& &&&
12594        &$dnslist_text$& &&&
12595        &$dnslist_value$&
12596 .vindex "&$dnslist_domain$&"
12597 .vindex "&$dnslist_matched$&"
12598 .vindex "&$dnslist_text$&"
12599 .vindex "&$dnslist_value$&"
12600 .cindex "black list (DNS)"
12601 When a DNS (black) list lookup succeeds, these variables are set to contain
12602 the following data from the lookup: the list's domain name, the key that was
12603 looked up, the contents of any associated TXT record, and the value from the
12604 main A record. See section &<<SECID204>>& for more details.
12605
12606 .tvar &$domain$&
12607 When an address is being routed, or delivered on its own, this variable
12608 contains the domain. Uppercase letters in the domain are converted into lower
12609 case for &$domain$&.
12610
12611 Global address rewriting happens when a message is received, so the value of
12612 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12613 is set during user filtering, but not during system filtering, because a
12614 message may have many recipients and the system filter is called just once.
12615
12616 When more than one address is being delivered at once (for example, several
12617 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12618 have the same domain. Transports can be restricted to handling only one domain
12619 at a time if the value of &$domain$& is required at transport time &-- this is
12620 the default for local transports. For further details of the environment in
12621 which local transports are run, see chapter &<<CHAPenvironment>>&.
12622
12623 .oindex "&%delay_warning_condition%&"
12624 At the end of a delivery, if all deferred addresses have the same domain, it is
12625 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12626
12627 The &$domain$& variable is also used in some other circumstances:
12628
12629 .ilist
12630 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12631 the recipient address. The domain of the &'sender'& address is in
12632 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12633 normally set during the running of the MAIL ACL. However, if the sender address
12634 is verified with a callout during the MAIL ACL, the sender domain is placed in
12635 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12636 the &(smtp)& transport.
12637
12638 .next
12639 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12640 &$domain$& contains the domain portion of the address that is being rewritten;
12641 it can be used in the expansion of the replacement address, for example, to
12642 rewrite domains by file lookup.
12643
12644 .next
12645 With one important exception, whenever a domain list is being scanned,
12646 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12647 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12648 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12649 that, in a RCPT ACL, the sender domain list can be dependent on the
12650 recipient domain (which is what is in &$domain$& at this time).
12651
12652 .next
12653 .cindex "ETRN" "value of &$domain$&"
12654 .oindex "&%smtp_etrn_command%&"
12655 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12656 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12657 .endlist
12658
12659 .cindex "tainted data"
12660 If the origin of the data is an incoming message,
12661 the result of expanding this variable is tainted and may not
12662 be further expanded or used as a filename.
12663 When an untainted version is needed, one should be obtained from
12664 looking up the value in a local (therefore trusted) database.
12665 Often &$domain_data$& is usable in this role.
12666
12667
12668 .vitem &$domain_data$&
12669 .vindex "&$domain_data$&"
12670 When the &%domains%& condition on a router
12671 or an ACL
12672 matches a domain
12673 against a list, the match value is copied to &$domain_data$&.
12674 This is an enhancement over previous versions of Exim, when it only
12675 applied to the data read by a lookup.
12676 For details on match values see section &<<SECTlistresults>>& et. al.
12677
12678 If the router routes the
12679 address to a transport, the value is available in that transport. If the
12680 transport is handling multiple addresses, the value from the first address is
12681 used.
12682
12683 &$domain_data$& set in an ACL is available during
12684 the rest of the ACL statement.
12685
12686 .vitem &$exim_gid$&
12687 .vindex "&$exim_gid$&"
12688 This variable contains the numerical value of the Exim group id.
12689
12690 .vitem &$exim_path$&
12691 .vindex "&$exim_path$&"
12692 This variable contains the path to the Exim binary.
12693
12694 .vitem &$exim_uid$&
12695 .vindex "&$exim_uid$&"
12696 This variable contains the numerical value of the Exim user id.
12697
12698 .vitem &$exim_version$&
12699 .vindex "&$exim_version$&"
12700 This variable contains the version string of the Exim build.
12701 The first character is a major version number, currently 4.
12702 Then after a dot, the next group of digits is a minor version number.
12703 There may be other characters following the minor version.
12704 This value may be overridden by the &%exim_version%& main config option.
12705
12706 .vitem &$header_$&<&'name'&>
12707 .tmark
12708 This is not strictly an expansion variable. It is expansion syntax for
12709 inserting the message header line with the given name. Note that the name must
12710 be terminated by colon or white space, because it may contain a wide variety of
12711 characters. Note also that braces must &'not'& be used.
12712 See the full description in section &<<SECTexpansionitems>>& above.
12713
12714 .vitem &$headers_added$&
12715 .vindex "&$headers_added$&"
12716 Within an ACL this variable contains the headers added so far by
12717 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12718 The headers are a newline-separated list.
12719
12720 .vitem &$home$&
12721 .vindex "&$home$&"
12722 When the &%check_local_user%& option is set for a router, the user's home
12723 directory is placed in &$home$& when the check succeeds. In particular, this
12724 means it is set during the running of users' filter files. A router may also
12725 explicitly set a home directory for use by a transport; this can be overridden
12726 by a setting on the transport itself.
12727
12728 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12729 of the environment variable HOME, which is subject to the
12730 &%keep_environment%& and &%add_environment%& main config options.
12731
12732 .vitem &$host$&
12733 .vindex "&$host$&"
12734 If a router assigns an address to a transport (any transport), and passes a
12735 list of hosts with the address, the value of &$host$& when the transport starts
12736 to run is the name of the first host on the list. Note that this applies both
12737 to local and remote transports.
12738
12739 .cindex "transport" "filter"
12740 .cindex "filter" "transport filter"
12741 For the &(smtp)& transport, if there is more than one host, the value of
12742 &$host$& changes as the transport works its way through the list. In
12743 particular, when the &(smtp)& transport is expanding its options for encryption
12744 using TLS, or for specifying a transport filter (see chapter
12745 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12746 is connected.
12747
12748 When used in the client part of an authenticator configuration (see chapter
12749 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12750 client is connected.
12751
12752
12753 .vitem &$host_address$&
12754 .vindex "&$host_address$&"
12755 This variable is set to the remote host's IP address whenever &$host$& is set
12756 for a remote connection. It is also set to the IP address that is being checked
12757 when the &%ignore_target_hosts%& option is being processed.
12758
12759 .vitem &$host_data$&
12760 .vindex "&$host_data$&"
12761 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12762 result of the lookup is made available in the &$host_data$& variable. This
12763 allows you, for example, to do things like this:
12764 .code
12765 deny  hosts = net-lsearch;/some/file
12766       message = $host_data
12767 .endd
12768
12769 .vitem &$host_lookup_deferred$&
12770 .cindex "host name" "lookup, failure of"
12771 .vindex "&$host_lookup_deferred$&"
12772 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12773 message comes from a remote host and there is an attempt to look up the host's
12774 name from its IP address, and the attempt is not successful, one of these
12775 variables is set to &"1"&.
12776
12777 .ilist
12778 If the lookup receives a definite negative response (for example, a DNS lookup
12779 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12780
12781 .next
12782 If there is any kind of problem during the lookup, such that Exim cannot
12783 tell whether or not the host name is defined (for example, a timeout for a DNS
12784 lookup), &$host_lookup_deferred$& is set to &"1"&.
12785 .endlist ilist
12786
12787 Looking up a host's name from its IP address consists of more than just a
12788 single reverse lookup. Exim checks that a forward lookup of at least one of the
12789 names it receives from a reverse lookup yields the original IP address. If this
12790 is not the case, Exim does not accept the looked up name(s), and
12791 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12792 IP address (for example, the existence of a PTR record in the DNS) is not
12793 sufficient on its own for the success of a host name lookup. If the reverse
12794 lookup succeeds, but there is a lookup problem such as a timeout when checking
12795 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12796 &"1"&. See also &$sender_host_name$&.
12797
12798 .cindex authentication "expansion item"
12799 Performing these checks sets up information used by the
12800 &%authresults%& expansion item.
12801
12802
12803 .vitem &$host_lookup_failed$&
12804 .vindex "&$host_lookup_failed$&"
12805 See &$host_lookup_deferred$&.
12806
12807 .vitem &$host_port$&
12808 .vindex "&$host_port$&"
12809 This variable is set to the remote host's TCP port whenever &$host$& is set
12810 for an outbound connection.
12811
12812 .vitem &$initial_cwd$&
12813 .vindex "&$initial_cwd$&
12814 This variable contains the full path name of the initial working
12815 directory of the current Exim process. This may differ from the current
12816 working directory, as Exim changes this to "/" during early startup, and
12817 to &$spool_directory$& later.
12818
12819 .vitem &$inode$&
12820 .vindex "&$inode$&"
12821 The only time this variable is set is while expanding the &%directory_file%&
12822 option in the &(appendfile)& transport. The variable contains the inode number
12823 of the temporary file which is about to be renamed. It can be used to construct
12824 a unique name for the file.
12825
12826 .vitem &$interface_address$& &&&
12827        &$interface_port$&
12828 .vindex "&$interface_address$&"
12829 .vindex "&$interface_port$&"
12830 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12831
12832 .vitem &$item$&
12833 .vindex "&$item$&"
12834 This variable is used during the expansion of &*forall*& and &*forany*&
12835 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12836 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12837 empty.
12838
12839 .vitem &$ldap_dn$&
12840 .vindex "&$ldap_dn$&"
12841 This variable, which is available only when Exim is compiled with LDAP support,
12842 contains the DN from the last entry in the most recently successful LDAP
12843 lookup.
12844
12845 .vitem &$load_average$&
12846 .vindex "&$load_average$&"
12847 This variable contains the system load average, multiplied by 1000 so that it
12848 is an integer. For example, if the load average is 0.21, the value of the
12849 variable is 210. The value is recomputed every time the variable is referenced.
12850
12851 .tvar &$local_part$&
12852 When an address is being routed, or delivered on its own, this
12853 variable contains the local part. When a number of addresses are being
12854 delivered together (for example, multiple RCPT commands in an SMTP
12855 session), &$local_part$& is not set.
12856
12857 Global address rewriting happens when a message is received, so the value of
12858 &$local_part$& during routing and delivery is the value after rewriting.
12859 &$local_part$& is set during user filtering, but not during system filtering,
12860 because a message may have many recipients and the system filter is called just
12861 once.
12862
12863 .cindex "tainted data"
12864 If the origin of the data is an incoming message,
12865 the result of expanding this variable is tainted and
12866 may not be further expanded or used as a filename.
12867
12868 &*Warning*&: the content of this variable is usually provided by a potential
12869 attacker.
12870 Consider carefully the implications of using it unvalidated as a name
12871 for file access.
12872 This presents issues for users' &_.forward_& and filter files.
12873 For traditional full user accounts, use &%check_local_users%& and the
12874 &$local_part_data$& variable rather than this one.
12875 For virtual users, store a suitable pathname component in the database
12876 which is used for account name validation, and use that retrieved value
12877 rather than this variable.
12878 Often &$local_part_data$& is usable in this role.
12879 If needed, use a router &%address_data%& or &%set%& option for
12880 the retrieved data.
12881
12882 When a message is being delivered to a file, pipe, or autoreply transport as a
12883 result of aliasing or forwarding, &$local_part$& is set to the local part of
12884 the parent address, not to the filename or command (see &$address_file$& and
12885 &$address_pipe$&).
12886
12887 When an ACL is running for a RCPT command, &$local_part$& contains the
12888 local part of the recipient address.
12889
12890 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12891 &$local_part$& contains the local part of the address that is being rewritten;
12892 it can be used in the expansion of the replacement address, for example.
12893
12894 In all cases, all quoting is removed from the local part. For example, for both
12895 the addresses
12896 .code
12897 "abc:xyz"@test.example
12898 abc\:xyz@test.example
12899 .endd
12900 the value of &$local_part$& is
12901 .code
12902 abc:xyz
12903 .endd
12904 If you use &$local_part$& to create another address, you should always wrap it
12905 inside a quoting operator. For example, in a &(redirect)& router you could
12906 have:
12907 .code
12908 data = ${quote_local_part:$local_part}@new.domain.example
12909 .endd
12910 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12911 to process local parts in a case-dependent manner in a router, you can set the
12912 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12913
12914 .vitem &$local_part_data$&
12915 .vindex "&$local_part_data$&"
12916 When the &%local_parts%& condition on a router or ACL
12917 matches a local part list
12918 the match value is copied to &$local_part_data$&.
12919 This is an enhancement over previous versions of Exim, when it only
12920 applied to the data read by a lookup.
12921 For details on match values see section &<<SECTlistresults>>& et. al.
12922
12923 The &%check_local_user%& router option also sets this variable.
12924
12925 .vindex &$local_part_prefix$& &&&
12926         &$local_part_prefix_v$& &&&
12927         &$local_part_suffix$& &&&
12928         &$local_part_suffix_v$&
12929 .cindex affix variables
12930 If a local part prefix or suffix has been recognized, it is not included in the
12931 value of &$local_part$& during routing and subsequent delivery. The values of
12932 any prefix or suffix are in &$local_part_prefix$& and
12933 &$local_part_suffix$&, respectively.
12934 .cindex "tainted data"
12935 If the specification did not include a wildcard then
12936 the affix variable value is not tainted.
12937
12938 If the affix specification included a wildcard then the portion of
12939 the affix matched by the wildcard is in
12940 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12941 and both the whole and varying values are tainted.
12942
12943 .vitem &$local_scan_data$&
12944 .vindex "&$local_scan_data$&"
12945 This variable contains the text returned by the &[local_scan()]& function when
12946 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12947
12948 .vitem &$local_user_gid$&
12949 .vindex "&$local_user_gid$&"
12950 See &$local_user_uid$&.
12951
12952 .vitem &$local_user_uid$&
12953 .vindex "&$local_user_uid$&"
12954 This variable and &$local_user_gid$& are set to the uid and gid after the
12955 &%check_local_user%& router precondition succeeds. This means that their values
12956 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12957 and &%condition%&), for the &%address_data%& expansion, and for any
12958 router-specific expansions. At all other times, the values in these variables
12959 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12960
12961 .vitem &$localhost_number$&
12962 .vindex "&$localhost_number$&"
12963 This contains the expanded value of the
12964 &%localhost_number%& option. The expansion happens after the main options have
12965 been read.
12966
12967 .vitem &$log_inodes$&
12968 .vindex "&$log_inodes$&"
12969 The number of free inodes in the disk partition where Exim's
12970 log files are being written. The value is recalculated whenever the variable is
12971 referenced. If the relevant file system does not have the concept of inodes,
12972 the value of is -1. See also the &%check_log_inodes%& option.
12973
12974 .vitem &$log_space$&
12975 .vindex "&$log_space$&"
12976 The amount of free space (as a number of kilobytes) in the disk
12977 partition where Exim's log files are being written. The value is recalculated
12978 whenever the variable is referenced. If the operating system does not have the
12979 ability to find the amount of free space (only true for experimental systems),
12980 the space value is -1. See also the &%check_log_space%& option.
12981
12982
12983 .vitem &$lookup_dnssec_authenticated$&
12984 .vindex "&$lookup_dnssec_authenticated$&"
12985 This variable is set after a DNS lookup done by
12986 a dnsdb lookup expansion, dnslookup router or smtp transport.
12987 .cindex "DNS" "DNSSEC"
12988 It will be empty if &(DNSSEC)& was not requested,
12989 &"no"& if the result was not labelled as authenticated data
12990 and &"yes"& if it was.
12991 Results that are labelled as authoritative answer that match
12992 the &%dns_trust_aa%& configuration variable count also
12993 as authenticated data.
12994
12995 .vitem &$mailstore_basename$&
12996 .vindex "&$mailstore_basename$&"
12997 This variable is set only when doing deliveries in &"mailstore"& format in the
12998 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12999 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
13000 contains the basename of the files that are being written, that is, the name
13001 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
13002 variable is empty.
13003
13004 .vitem &$malware_name$&
13005 .vindex "&$malware_name$&"
13006 This variable is available when Exim is compiled with the
13007 content-scanning extension. It is set to the name of the virus that was found
13008 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
13009
13010 .vitem &$max_received_linelength$&
13011 .vindex "&$max_received_linelength$&"
13012 .cindex "maximum" "line length"
13013 .cindex "line length" "maximum"
13014 This variable contains the number of bytes in the longest line that was
13015 received as part of the message, not counting the line termination
13016 character(s).
13017 It is not valid if the &%spool_wireformat%& option is used.
13018
13019 .vitem &$message_age$&
13020 .cindex "message" "age of"
13021 .vindex "&$message_age$&"
13022 This variable is set at the start of a delivery attempt to contain the number
13023 of seconds since the message was received. It does not change during a single
13024 delivery attempt.
13025
13026 .tvar &$message_body$&
13027 .cindex "body of message" "expansion variable"
13028 .cindex "message body" "in expansion"
13029 .cindex "binary zero" "in message body"
13030 .oindex "&%message_body_visible%&"
13031 This variable contains the initial portion of a message's body while it is
13032 being delivered, and is intended mainly for use in filter files. The maximum
13033 number of characters of the body that are put into the variable is set by the
13034 &%message_body_visible%& configuration option; the default is 500.
13035
13036 .oindex "&%message_body_newlines%&"
13037 By default, newlines are converted into spaces in &$message_body$&, to make it
13038 easier to search for phrases that might be split over a line break. However,
13039 this can be disabled by setting &%message_body_newlines%& to be true. Binary
13040 zeros are always converted into spaces.
13041
13042 .tvar &$message_body_end$&
13043 .cindex "body of message" "expansion variable"
13044 .cindex "message body" "in expansion"
13045 This variable contains the final portion of a message's
13046 body while it is being delivered. The format and maximum size are as for
13047 &$message_body$&.
13048
13049 .vitem &$message_body_size$&
13050 .cindex "body of message" "size"
13051 .cindex "message body" "size"
13052 .vindex "&$message_body_size$&"
13053 When a message is being delivered, this variable contains the size of the body
13054 in bytes. The count starts from the character after the blank line that
13055 separates the body from the header. Newlines are included in the count. See
13056 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
13057
13058 If the spool file is wireformat
13059 (see the &%spool_wireformat%& main option)
13060 the CRLF line-terminators are included in the count.
13061
13062 .vitem &$message_exim_id$&
13063 .vindex "&$message_exim_id$&"
13064 When a message is being received or delivered, this variable contains the
13065 unique message id that is generated and used by Exim to identify the message.
13066 An id is not created for a message until after its header has been successfully
13067 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13068 line; it is the local id that Exim assigns to the message, for example:
13069 &`1BXTIK-0001yO-VA`&.
13070
13071 .tvar &$message_headers$&
13072 This variable contains a concatenation of all the header lines when a message
13073 is being processed, except for lines added by routers or transports. The header
13074 lines are separated by newline characters. Their contents are decoded in the
13075 same way as a header line that is inserted by &%bheader%&.
13076
13077 .tvar &$message_headers_raw$&
13078 This variable is like &$message_headers$& except that no processing of the
13079 contents of header lines is done.
13080
13081 .vitem &$message_id$&
13082 This is an old name for &$message_exim_id$&. It is now deprecated.
13083
13084 .vitem &$message_linecount$&
13085 .vindex "&$message_linecount$&"
13086 This variable contains the total number of lines in the header and body of the
13087 message. Compare &$body_linecount$&, which is the count for the body only.
13088 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13089 number of lines received. Before delivery happens (that is, before filters,
13090 routers, and transports run) the count is increased to include the
13091 &'Received:'& header line that Exim standardly adds, and also any other header
13092 lines that are added by ACLs. The blank line that separates the message header
13093 from the body is not counted.
13094
13095 As with the special case of &$message_size$&, during the expansion of the
13096 appendfile transport's maildir_tag option in maildir format, the value of
13097 &$message_linecount$& is the precise size of the number of newlines in the
13098 file that has been written (minus one for the blank line between the
13099 header and the body).
13100
13101 Here is an example of the use of this variable in a DATA ACL:
13102 .code
13103 deny condition = \
13104       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13105      message   = Too many lines in message header
13106 .endd
13107 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13108 message has not yet been received.
13109
13110 This variable is not valid if the &%spool_wireformat%& option is used.
13111
13112 .vitem &$message_size$&
13113 .cindex "size" "of message"
13114 .cindex "message" "size"
13115 .vindex "&$message_size$&"
13116 When a message is being processed, this variable contains its size in bytes. In
13117 most cases, the size includes those headers that were received with the
13118 message, but not those (such as &'Envelope-to:'&) that are added to individual
13119 deliveries as they are written. However, there is one special case: during the
13120 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13121 doing a delivery in maildir format, the value of &$message_size$& is the
13122 precise size of the file that has been written. See also
13123 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13124
13125 .cindex "RCPT" "value of &$message_size$&"
13126 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13127 contains the size supplied on the MAIL command, or -1 if no size was given. The
13128 value may not, of course, be truthful.
13129
13130 .vitem &$mime_anomaly_level$& &&&
13131        &$mime_anomaly_text$& &&&
13132        &$mime_boundary$& &&&
13133        &$mime_charset$& &&&
13134        &$mime_content_description$& &&&
13135        &$mime_content_disposition$& &&&
13136        &$mime_content_id$& &&&
13137        &$mime_content_size$& &&&
13138        &$mime_content_transfer_encoding$& &&&
13139        &$mime_content_type$& &&&
13140        &$mime_decoded_filename$& &&&
13141        &$mime_filename$& &&&
13142        &$mime_is_coverletter$& &&&
13143        &$mime_is_multipart$& &&&
13144        &$mime_is_rfc822$& &&&
13145        &$mime_part_count$&
13146 A number of variables whose names start with &$mime$& are
13147 available when Exim is compiled with the content-scanning extension. For
13148 details, see section &<<SECTscanmimepart>>&.
13149
13150 .vitem "&$n0$& &-- &$n9$&"
13151 These variables are counters that can be incremented by means
13152 of the &%add%& command in filter files.
13153
13154 .tvar &$original_domain$&
13155 .vindex "&$domain$&"
13156 When a top-level address is being processed for delivery, this contains the
13157 same value as &$domain$&. However, if a &"child"& address (for example,
13158 generated by an alias, forward, or filter file) is being processed, this
13159 variable contains the domain of the original address (lower cased). This
13160 differs from &$parent_domain$& only when there is more than one level of
13161 aliasing or forwarding. When more than one address is being delivered in a
13162 single transport run, &$original_domain$& is not set.
13163
13164 If a new address is created by means of a &%deliver%& command in a system
13165 filter, it is set up with an artificial &"parent"& address. This has the local
13166 part &'system-filter'& and the default qualify domain.
13167
13168 .tvar &$original_local_part$&
13169 .vindex "&$local_part$&"
13170 When a top-level address is being processed for delivery, this contains the
13171 same value as &$local_part$&, unless a prefix or suffix was removed from the
13172 local part, because &$original_local_part$& always contains the full local
13173 part. When a &"child"& address (for example, generated by an alias, forward, or
13174 filter file) is being processed, this variable contains the full local part of
13175 the original address.
13176
13177 If the router that did the redirection processed the local part
13178 case-insensitively, the value in &$original_local_part$& is in lower case.
13179 This variable differs from &$parent_local_part$& only when there is more than
13180 one level of aliasing or forwarding. When more than one address is being
13181 delivered in a single transport run, &$original_local_part$& is not set.
13182
13183 If a new address is created by means of a &%deliver%& command in a system
13184 filter, it is set up with an artificial &"parent"& address. This has the local
13185 part &'system-filter'& and the default qualify domain.
13186
13187 .vitem &$originator_gid$&
13188 .cindex "gid (group id)" "of originating user"
13189 .cindex "sender" "gid"
13190 .vindex "&$caller_gid$&"
13191 .vindex "&$originator_gid$&"
13192 This variable contains the value of &$caller_gid$& that was set when the
13193 message was received. For messages received via the command line, this is the
13194 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13195 normally the gid of the Exim user.
13196
13197 .vitem &$originator_uid$&
13198 .cindex "uid (user id)" "of originating user"
13199 .cindex "sender" "uid"
13200 .vindex "&$caller_uid$&"
13201 .vindex "&$originator_uid$&"
13202 The value of &$caller_uid$& that was set when the message was received. For
13203 messages received via the command line, this is the uid of the sending user.
13204 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13205 user.
13206
13207 .tvar &$parent_domain$&
13208 This variable is similar to &$original_domain$& (see
13209 above), except that it refers to the immediately preceding parent address.
13210
13211 .tvar &$parent_local_part$&
13212 This variable is similar to &$original_local_part$&
13213 (see above), except that it refers to the immediately preceding parent address.
13214
13215 .vitem &$pid$&
13216 .cindex "pid (process id)" "of current process"
13217 .vindex "&$pid$&"
13218 This variable contains the current process id.
13219
13220 .vitem &$pipe_addresses$&
13221 .cindex "filter" "transport filter"
13222 .cindex "transport" "filter"
13223 .vindex "&$pipe_addresses$&"
13224 This is not an expansion variable, but is mentioned here because the string
13225 &`$pipe_addresses`& is handled specially in the command specification for the
13226 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13227 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13228 It cannot be used in general expansion strings, and provokes an &"unknown
13229 variable"& error if encountered.
13230 &*Note*&: This value permits data supplied by a potential attacker to
13231 be used in the command for a &(pipe)& transport.
13232 Such configurations should be carefully assessed for security vulnerbilities.
13233
13234 .vitem &$primary_hostname$&
13235 .vindex "&$primary_hostname$&"
13236 This variable contains the value set by &%primary_hostname%& in the
13237 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13238 a single-component name, Exim calls &[gethostbyname()]& (or
13239 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13240 qualified host name. See also &$smtp_active_hostname$&.
13241
13242
13243 .vitem &$proxy_external_address$& &&&
13244        &$proxy_external_port$& &&&
13245        &$proxy_local_address$& &&&
13246        &$proxy_local_port$& &&&
13247        &$proxy_session$&
13248 These variables are only available when built with Proxy Protocol
13249 or SOCKS5 support.
13250 For details see chapter &<<SECTproxyInbound>>&.
13251
13252 .vitem &$prdr_requested$&
13253 .cindex "PRDR" "variable for"
13254 This variable is set to &"yes"& if PRDR was requested by the client for the
13255 current message, otherwise &"no"&.
13256
13257 .vitem &$prvscheck_address$& &&&
13258        &$prvscheck_keynum$& &&&
13259        &$prvscheck_result$&
13260 These variables are used in conjunction with the &%prvscheck%& expansion item,
13261 which is described in sections &<<SECTexpansionitems>>& and
13262 &<<SECTverifyPRVS>>&.
13263
13264 .vitem &$qualify_domain$&
13265 .vindex "&$qualify_domain$&"
13266 The value set for the &%qualify_domain%& option in the configuration file.
13267
13268 .vitem &$qualify_recipient$&
13269 .vindex "&$qualify_recipient$&"
13270 The value set for the &%qualify_recipient%& option in the configuration file,
13271 or if not set, the value of &$qualify_domain$&.
13272
13273 .vitem &$queue_name$&
13274 .vindex &$queue_name$&
13275 .cindex "named queues" variable
13276 .cindex queues named
13277 The name of the spool queue in use; empty for the default queue.
13278
13279 .vitem &$queue_size$&
13280 .vindex "&$queue_size$&"
13281 .cindex "queue" "size of"
13282 .cindex "spool" "number of messages"
13283 This variable contains the number of messages queued.
13284 It is evaluated on demand, but no more often than once every minute.
13285 If there is no daemon notifier socket open, the value will be
13286 an empty string.
13287
13288 .vitem &$r_...$&
13289 .vindex &$r_...$&
13290 .cindex router variables
13291 Values can be placed in these variables by the &%set%& option of a router.
13292 They can be given any name that starts with &$r_$&.
13293 The values persist for the address being handled through subsequent routers
13294 and the eventual transport.
13295
13296 .vitem &$rcpt_count$&
13297 .vindex "&$rcpt_count$&"
13298 When a message is being received by SMTP, this variable contains the number of
13299 RCPT commands received for the current message. If this variable is used in a
13300 RCPT ACL, its value includes the current command.
13301
13302 .vitem &$rcpt_defer_count$&
13303 .vindex "&$rcpt_defer_count$&"
13304 .cindex "4&'xx'& responses" "count of"
13305 When a message is being received by SMTP, this variable contains the number of
13306 RCPT commands in the current message that have previously been rejected with a
13307 temporary (4&'xx'&) response.
13308
13309 .vitem &$rcpt_fail_count$&
13310 .vindex "&$rcpt_fail_count$&"
13311 When a message is being received by SMTP, this variable contains the number of
13312 RCPT commands in the current message that have previously been rejected with a
13313 permanent (5&'xx'&) response.
13314
13315 .vitem &$received_count$&
13316 .vindex "&$received_count$&"
13317 This variable contains the number of &'Received:'& header lines in the message,
13318 including the one added by Exim (so its value is always greater than zero). It
13319 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13320 delivering.
13321
13322 .tvar &$received_for$&
13323 If there is only a single recipient address in an incoming message, this
13324 variable contains that address when the &'Received:'& header line is being
13325 built. The value is copied after recipient rewriting has happened, but before
13326 the &[local_scan()]& function is run.
13327
13328 .vitem &$received_ip_address$& &&&
13329        &$received_port$&
13330 .vindex "&$received_ip_address$&"
13331 .vindex "&$received_port$&"
13332 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13333 variables are set to the address and port on the local IP interface.
13334 (The remote IP address and port are in
13335 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13336 the port value is -1 unless it has been set using the &%-oMi%& command line
13337 option.
13338
13339 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13340 could be used, for example, to make the filename for a TLS certificate depend
13341 on which interface and/or port is being used for the incoming connection. The
13342 values of &$received_ip_address$& and &$received_port$& are saved with any
13343 messages that are received, thus making these variables available at delivery
13344 time.
13345 For outbound connections see &$sending_ip_address$&.
13346
13347 .vitem &$received_protocol$&
13348 .vindex "&$received_protocol$&"
13349 When a message is being processed, this variable contains the name of the
13350 protocol by which it was received. Most of the names used by Exim are defined
13351 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13352 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13353 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13354 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13355 connection and the client was successfully authenticated.
13356
13357 Exim uses the protocol name &"smtps"& for the case when encryption is
13358 automatically set up on connection without the use of STARTTLS (see
13359 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13360 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13361 where the client initially uses EHLO, sets up an encrypted connection using
13362 STARTTLS, and then uses HELO afterwards.
13363
13364 The &%-oMr%& option provides a way of specifying a custom protocol name for
13365 messages that are injected locally by trusted callers. This is commonly used to
13366 identify messages that are being re-injected after some kind of scanning.
13367
13368 .vitem &$received_time$&
13369 .vindex "&$received_time$&"
13370 This variable contains the date and time when the current message was received,
13371 as a number of seconds since the start of the Unix epoch.
13372
13373 .vitem &$recipient_data$&
13374 .vindex "&$recipient_data$&"
13375 This variable is set after an indexing lookup success in an ACL &%recipients%&
13376 condition. It contains the data from the lookup, and the value remains set
13377 until the next &%recipients%& test. Thus, you can do things like this:
13378 .display
13379 &`require recipients  = cdb*@;/some/file`&
13380 &`deny    `&&'some further test involving'& &`$recipient_data`&
13381 .endd
13382 &*Warning*&: This variable is set only when a lookup is used as an indexing
13383 method in the address list, using the semicolon syntax as in the example above.
13384 The variable is not set for a lookup that is used as part of the string
13385 expansion that all such lists undergo before being interpreted.
13386
13387 .vitem &$recipient_verify_failure$&
13388 .vindex "&$recipient_verify_failure$&"
13389 In an ACL, when a recipient verification fails, this variable contains
13390 information about the failure. It is set to one of the following words:
13391
13392 .ilist
13393 &"qualify"&: The address was unqualified (no domain), and the message
13394 was neither local nor came from an exempted host.
13395
13396 .next
13397 &"route"&: Routing failed.
13398
13399 .next
13400 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13401 or before the MAIL command (that is, on initial connection, HELO, or
13402 MAIL).
13403
13404 .next
13405 &"recipient"&: The RCPT command in a callout was rejected.
13406 .next
13407
13408 &"postmaster"&: The postmaster check in a callout was rejected.
13409 .endlist
13410
13411 The main use of this variable is expected to be to distinguish between
13412 rejections of MAIL and rejections of RCPT.
13413
13414 .tvar &$recipients$&
13415 .tvar &$recipients_list$&
13416 These variables both contain the envelope recipients for a message.
13417
13418 The first uses a comma and a space separate the addresses in the replacement text.
13419 &*Note*&: an address can legitimately contain a comma;
13420 this variable is not intended for further processing.
13421
13422 The second is a proper Exim list; colon-separated.
13423
13424 However, the variables
13425 are not generally available, to prevent exposure of Bcc recipients in
13426 unprivileged users' filter files. You can use either of them  only in these
13427 cases:
13428
13429 .olist
13430 In a system filter file.
13431 .next
13432 In the ACLs associated with the DATA command and with non-SMTP messages, that
13433 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13434 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13435 &%acl_not_smtp_mime%&.
13436 .next
13437 From within a &[local_scan()]& function.
13438 .endlist
13439
13440
13441 .vitem &$recipients_count$&
13442 .vindex "&$recipients_count$&"
13443 When a message is being processed, this variable contains the number of
13444 envelope recipients that came with the message. Duplicates are not excluded
13445 from the count. While a message is being received over SMTP, the number
13446 increases for each accepted recipient. It can be referenced in an ACL.
13447
13448
13449 .vitem &$regex_match_string$&
13450 .vindex "&$regex_match_string$&"
13451 This variable is set to contain the matching regular expression after a
13452 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13453
13454 .vitem "&$regex1$&, &$regex2$&, etc"
13455 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13456 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13457 these variables contain the
13458 captured substrings identified by the regular expression.
13459 If the subject string was tainted then so will any captured substring.
13460
13461
13462 .tvar &$reply_address$&
13463 When a message is being processed, this variable contains the contents of the
13464 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13465 contents of the &'From:'& header line. Apart from the removal of leading
13466 white space, the value is not processed in any way. In particular, no RFC 2047
13467 decoding or character code translation takes place.
13468
13469 .vitem &$return_path$&
13470 .vindex "&$return_path$&"
13471 When a message is being delivered, this variable contains the return path &--
13472 the sender field that will be sent as part of the envelope. It is not enclosed
13473 in <> characters. At the start of routing an address, &$return_path$& has the
13474 same value as &$sender_address$&, but if, for example, an incoming message to a
13475 mailing list has been expanded by a router which specifies a different address
13476 for bounce messages, &$return_path$& subsequently contains the new bounce
13477 address, whereas &$sender_address$& always contains the original sender address
13478 that was received with the message. In other words, &$sender_address$& contains
13479 the incoming envelope sender, and &$return_path$& contains the outgoing
13480 envelope sender.
13481
13482 .vitem &$return_size_limit$&
13483 .vindex "&$return_size_limit$&"
13484 This is an obsolete name for &$bounce_return_size_limit$&.
13485
13486 .vitem &$router_name$&
13487 .cindex "router" "name"
13488 .cindex "name" "of router"
13489 .vindex "&$router_name$&"
13490 During the running of a router, or a transport called,
13491 this variable contains the router name.
13492
13493 .vitem &$runrc$&
13494 .cindex "return code" "from &%run%& expansion"
13495 .vindex "&$runrc$&"
13496 This variable contains the return code from a command that is run by the
13497 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13498 assume the order in which option values are expanded, except for those
13499 preconditions whose order of testing is documented. Therefore, you cannot
13500 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13501 another.
13502
13503 .vitem &$self_hostname$&
13504 .oindex "&%self%&" "value of host name"
13505 .vindex "&$self_hostname$&"
13506 When an address is routed to a supposedly remote host that turns out to be the
13507 local host, what happens is controlled by the &%self%& generic router option.
13508 One of its values causes the address to be passed to another router. When this
13509 happens, &$self_hostname$& is set to the name of the local host that the
13510 original router encountered. In other circumstances its contents are null.
13511
13512 .tvar &$sender_address$&
13513 When a message is being processed, this variable contains the sender's address
13514 that was received in the message's envelope. The case of letters in the address
13515 is retained, in both the local part and the domain. For bounce messages, the
13516 value of this variable is the empty string. See also &$return_path$&.
13517
13518 .vitem &$sender_address_data$&
13519 .vindex "&$address_data$&"
13520 .vindex "&$sender_address_data$&"
13521 If &$address_data$& is set when the routers are called from an ACL to verify a
13522 sender address, the final value is preserved in &$sender_address_data$&, to
13523 distinguish it from data from a recipient address. The value does not persist
13524 after the end of the current ACL statement. If you want to preserve it for
13525 longer, you can save it in an ACL variable.
13526
13527 .tvar &$sender_address_domain$&
13528 The domain portion of &$sender_address$&.
13529
13530 .tvar &$sender_address_local_part$&
13531 The local part portion of &$sender_address$&.
13532
13533 .vitem &$sender_data$&
13534 .vindex "&$sender_data$&"
13535 This variable is set after a lookup success in an ACL &%senders%& condition or
13536 in a router &%senders%& option. It contains the data from the lookup, and the
13537 value remains set until the next &%senders%& test. Thus, you can do things like
13538 this:
13539 .display
13540 &`require senders      = cdb*@;/some/file`&
13541 &`deny    `&&'some further test involving'& &`$sender_data`&
13542 .endd
13543 &*Warning*&: This variable is set only when a lookup is used as an indexing
13544 method in the address list, using the semicolon syntax as in the example above.
13545 The variable is not set for a lookup that is used as part of the string
13546 expansion that all such lists undergo before being interpreted.
13547
13548 .vitem &$sender_fullhost$&
13549 .vindex "&$sender_fullhost$&"
13550 When a message is received from a remote host, this variable contains the host
13551 name and IP address in a single string. It ends with the IP address in square
13552 brackets, followed by a colon and a port number if the logging of ports is
13553 enabled. The format of the rest of the string depends on whether the host
13554 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13555 looking up its IP address. (Looking up the IP address can be forced by the
13556 &%host_lookup%& option, independent of verification.) A plain host name at the
13557 start of the string is a verified host name; if this is not present,
13558 verification either failed or was not requested. A host name in parentheses is
13559 the argument of a HELO or EHLO command. This is omitted if it is identical to
13560 the verified host name or to the host's IP address in square brackets.
13561
13562 .vitem &$sender_helo_dnssec$&
13563 .vindex "&$sender_helo_dnssec$&"
13564 This boolean variable is true if a successful HELO verification was
13565 .cindex "DNS" "DNSSEC"
13566 done using DNS information the resolver library stated was authenticated data.
13567
13568 .tvar &$sender_helo_name$&
13569 When a message is received from a remote host that has issued a HELO or EHLO
13570 command, the argument of that command is placed in this variable. It is also
13571 set if HELO or EHLO is used when a message is received using SMTP locally via
13572 the &%-bs%& or &%-bS%& options.
13573
13574 .vitem &$sender_host_address$&
13575 .vindex "&$sender_host_address$&"
13576 When a message is received from a remote host using SMTP,
13577 this variable contains that
13578 host's IP address. For locally non-SMTP submitted messages, it is empty.
13579
13580 .vitem &$sender_host_authenticated$&
13581 .vindex "&$sender_host_authenticated$&"
13582 This variable contains the name (not the public name) of the authenticator
13583 driver that successfully authenticated the client from which the message was
13584 received. It is empty if there was no successful authentication. See also
13585 &$authenticated_id$&.
13586
13587 .vitem &$sender_host_dnssec$&
13588 .vindex "&$sender_host_dnssec$&"
13589 If an attempt to populate &$sender_host_name$& has been made
13590 (by reference, &%hosts_lookup%& or
13591 otherwise) then this boolean will have been set true if, and only if, the
13592 resolver library states that both
13593 the reverse and forward DNS were authenticated data.  At all
13594 other times, this variable is false.
13595
13596 .cindex "DNS" "DNSSEC"
13597 It is likely that you will need to coerce DNSSEC support on in the resolver
13598 library, by setting:
13599 .code
13600 dns_dnssec_ok = 1
13601 .endd
13602
13603 In addition, on Linux with glibc 2.31 or newer the resolver library will
13604 default to stripping out a successful validation status.
13605 This will break a previously working Exim installation.
13606 Provided that you do trust the resolver (ie, is on localhost) you can tell
13607 glibc to pass through any successful validation with a new option in
13608 &_/etc/resolv.conf_&:
13609 .code
13610 options trust-ad
13611 .endd
13612
13613 Exim does not perform DNSSEC validation itself, instead leaving that to a
13614 validating resolver (e.g. unbound, or bind with suitable configuration).
13615
13616 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13617 mechanism in the list, then this variable will be false.
13618
13619 This requires that your system resolver library support EDNS0 (and that
13620 DNSSEC flags exist in the system headers).  If the resolver silently drops
13621 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13622 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13623
13624
13625 .tvar &$sender_host_name$&
13626 When a message is received from a remote host, this variable contains the
13627 host's name as obtained by looking up its IP address. For messages received by
13628 other means, this variable is empty.
13629
13630 .vindex "&$host_lookup_failed$&"
13631 If the host name has not previously been looked up, a reference to
13632 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13633 A looked up name is accepted only if it leads back to the original IP address
13634 via a forward lookup. If either the reverse or the forward lookup fails to find
13635 any data, or if the forward lookup does not yield the original IP address,
13636 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13637
13638 .vindex "&$host_lookup_deferred$&"
13639 However, if either of the lookups cannot be completed (for example, there is a
13640 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13641 &$host_lookup_failed$& remains set to &"0"&.
13642
13643 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13644 host name again if there is a subsequent reference to &$sender_host_name$&
13645 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13646 is set to &"1"&.
13647
13648 Exim does not automatically look up every calling host's name. If you want
13649 maximum efficiency, you should arrange your configuration so that it avoids
13650 these lookups altogether. The lookup happens only if one or more of the
13651 following are true:
13652
13653 .ilist
13654 A string containing &$sender_host_name$& is expanded.
13655 .next
13656 The calling host matches the list in &%host_lookup%&. In the default
13657 configuration, this option is set to *, so it must be changed if lookups are
13658 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13659 .next
13660 Exim needs the host name in order to test an item in a host list. The items
13661 that require this are described in sections &<<SECThoslispatnam>>& and
13662 &<<SECThoslispatnamsk>>&.
13663 .next
13664 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13665 In this case, the host name is required to compare with the name quoted in any
13666 EHLO or HELO commands that the client issues.
13667 .next
13668 The remote host issues a EHLO or HELO command that quotes one of the
13669 domains in &%helo_lookup_domains%&. The default value of this option is
13670 . ==== As this is a nested list, any displays it contains must be indented
13671 . ==== as otherwise they are too far to the left.
13672 .code
13673   helo_lookup_domains = @ : @[]
13674 .endd
13675 which causes a lookup if a remote host (incorrectly) gives the server's name or
13676 IP address in an EHLO or HELO command.
13677 .endlist
13678
13679
13680 .vitem &$sender_host_port$&
13681 .vindex "&$sender_host_port$&"
13682 When a message is received from a remote host, this variable contains the port
13683 number that was used on the remote host.
13684
13685 .vitem &$sender_ident$&
13686 .vindex "&$sender_ident$&"
13687 When a message is received from a remote host, this variable contains the
13688 identification received in response to an RFC 1413 request. When a message has
13689 been received locally, this variable contains the login name of the user that
13690 called Exim.
13691
13692 .vitem &$sender_rate_$&&'xxx'&
13693 A number of variables whose names begin &$sender_rate_$& are set as part of the
13694 &%ratelimit%& ACL condition. Details are given in section
13695 &<<SECTratelimiting>>&.
13696
13697 .vitem &$sender_rcvhost$&
13698 .cindex "DNS" "reverse lookup"
13699 .cindex "reverse DNS lookup"
13700 .vindex "&$sender_rcvhost$&"
13701 This is provided specifically for use in &'Received:'& headers. It starts with
13702 either the verified host name (as obtained from a reverse DNS lookup) or, if
13703 there is no verified host name, the IP address in square brackets. After that
13704 there may be text in parentheses. When the first item is a verified host name,
13705 the first thing in the parentheses is the IP address in square brackets,
13706 followed by a colon and a port number if port logging is enabled. When the
13707 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13708 the parentheses.
13709
13710 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13711 was used and its argument was not identical to the real host name or IP
13712 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13713 all three items are present in the parentheses, a newline and tab are inserted
13714 into the string, to improve the formatting of the &'Received:'& header.
13715
13716 .vitem &$sender_verify_failure$&
13717 .vindex "&$sender_verify_failure$&"
13718 In an ACL, when a sender verification fails, this variable contains information
13719 about the failure. The details are the same as for
13720 &$recipient_verify_failure$&.
13721
13722 .vitem &$sending_ip_address$&
13723 .vindex "&$sending_ip_address$&"
13724 This variable is set whenever an outgoing SMTP connection to another host has
13725 been set up. It contains the IP address of the local interface that is being
13726 used. This is useful if a host that has more than one IP address wants to take
13727 on different personalities depending on which one is being used. For incoming
13728 connections, see &$received_ip_address$&.
13729
13730 .vitem &$sending_port$&
13731 .vindex "&$sending_port$&"
13732 This variable is set whenever an outgoing SMTP connection to another host has
13733 been set up. It contains the local port that is being used. For incoming
13734 connections, see &$received_port$&.
13735
13736 .vitem &$smtp_active_hostname$&
13737 .vindex "&$smtp_active_hostname$&"
13738 During an incoming SMTP session, this variable contains the value of the active
13739 host name, as specified by the &%smtp_active_hostname%& option. The value of
13740 &$smtp_active_hostname$& is saved with any message that is received, so its
13741 value can be consulted during routing and delivery.
13742
13743 .tvar &$smtp_command$&
13744 During the processing of an incoming SMTP command, this variable contains the
13745 entire command. This makes it possible to distinguish between HELO and EHLO in
13746 the HELO ACL, and also to distinguish between commands such as these:
13747 .code
13748 MAIL FROM:<>
13749 MAIL FROM: <>
13750 .endd
13751 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13752 command, the address in &$smtp_command$& is the original address before any
13753 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13754 the address after SMTP-time rewriting.
13755
13756 .tvar &$smtp_command_argument$&
13757 .cindex "SMTP" "command, argument for"
13758 While an ACL is running to check an SMTP command, this variable contains the
13759 argument, that is, the text that follows the command name, with leading white
13760 space removed. Following the introduction of &$smtp_command$&, this variable is
13761 somewhat redundant, but is retained for backwards compatibility.
13762
13763 .vitem &$smtp_command_history$&
13764 .cindex SMTP "command history"
13765 .vindex "&$smtp_command_history$&"
13766 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13767 received, in time-order left to right.  Only a limited number of commands
13768 are remembered.
13769
13770 .vitem &$smtp_count_at_connection_start$&
13771 .vindex "&$smtp_count_at_connection_start$&"
13772 This variable is set greater than zero only in processes spawned by the Exim
13773 daemon for handling incoming SMTP connections. The name is deliberately long,
13774 in order to emphasize what the contents are. When the daemon accepts a new
13775 connection, it increments this variable. A copy of the variable is passed to
13776 the child process that handles the connection, but its value is fixed, and
13777 never changes. It is only an approximation of how many incoming connections
13778 there actually are, because many other connections may come and go while a
13779 single connection is being processed. When a child process terminates, the
13780 daemon decrements its copy of the variable.
13781
13782 .vitem &$smtp_notquit_reason$&
13783 .vindex "&$smtp_notquit_reason$&"
13784 When the not-QUIT ACL is running, this variable is set to a string
13785 that indicates the reason for the termination of the SMTP connection.
13786
13787 .vitem "&$sn0$& &-- &$sn9$&"
13788 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13789 that were current at the end of the system filter file. This allows a system
13790 filter file to set values that can be tested in users' filter files. For
13791 example, a system filter could set a value indicating how likely it is that a
13792 message is junk mail.
13793
13794 .vitem &$spam_score$& &&&
13795        &$spam_score_int$& &&&
13796        &$spam_bar$& &&&
13797        &$spam_report$& &&&
13798        &$spam_action$&
13799 A number of variables whose names start with &$spam$& are available when Exim
13800 is compiled with the content-scanning extension. For details, see section
13801 &<<SECTscanspamass>>&.
13802
13803 .vitem &$spf_header_comment$& &&&
13804        &$spf_received$& &&&
13805        &$spf_result$& &&&
13806        &$spf_result_guessed$& &&&
13807        &$spf_smtp_comment$&
13808 These variables are only available if Exim is built with SPF support.
13809 For details see section &<<SECSPF>>&.
13810
13811 .vitem &$spool_directory$&
13812 .vindex "&$spool_directory$&"
13813 The name of Exim's spool directory.
13814
13815 .vitem &$spool_inodes$&
13816 .vindex "&$spool_inodes$&"
13817 The number of free inodes in the disk partition where Exim's spool files are
13818 being written. The value is recalculated whenever the variable is referenced.
13819 If the relevant file system does not have the concept of inodes, the value of
13820 is -1. See also the &%check_spool_inodes%& option.
13821
13822 .vitem &$spool_space$&
13823 .vindex "&$spool_space$&"
13824 The amount of free space (as a number of kilobytes) in the disk partition where
13825 Exim's spool files are being written. The value is recalculated whenever the
13826 variable is referenced. If the operating system does not have the ability to
13827 find the amount of free space (only true for experimental systems), the space
13828 value is -1. For example, to check in an ACL that there is at least 50
13829 megabytes free on the spool, you could write:
13830 .code
13831 condition = ${if > {$spool_space}{50000}}
13832 .endd
13833 See also the &%check_spool_space%& option.
13834
13835
13836 .vitem &$thisaddress$&
13837 .vindex "&$thisaddress$&"
13838 This variable is set only during the processing of the &%foranyaddress%&
13839 command in a filter file. Its use is explained in the description of that
13840 command, which can be found in the separate document entitled &'Exim's
13841 interfaces to mail filtering'&.
13842
13843 .vitem &$tls_in_bits$&
13844 .vindex "&$tls_in_bits$&"
13845 Contains an approximation of the TLS cipher's bit-strength
13846 on the inbound connection; the meaning of
13847 this depends upon the TLS implementation used.
13848 If TLS has not been negotiated, the value will be 0.
13849 The value of this is automatically fed into the Cyrus SASL authenticator
13850 when acting as a server, to specify the "external SSF" (a SASL term).
13851
13852 The deprecated &$tls_bits$& variable refers to the inbound side
13853 except when used in the context of an outbound SMTP delivery, when it refers to
13854 the outbound.
13855
13856 .vitem &$tls_out_bits$&
13857 .vindex "&$tls_out_bits$&"
13858 Contains an approximation of the TLS cipher's bit-strength
13859 on an outbound SMTP 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
13863 .vitem &$tls_in_ourcert$&
13864 .vindex "&$tls_in_ourcert$&"
13865 .cindex certificate variables
13866 This variable refers to the certificate presented to the peer of an
13867 inbound connection when the message was received.
13868 It is only useful as the argument of a
13869 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13870 or a &%def%& condition.
13871
13872 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13873 when a list of more than one
13874 file is used for &%tls_certificate%&, this variable is not reliable.
13875 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13876
13877 .vitem &$tls_in_peercert$&
13878 .vindex "&$tls_in_peercert$&"
13879 This variable refers to the certificate presented by 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 If certificate verification fails it may refer to a failing chain element
13885 which is not the leaf.
13886
13887 .vitem &$tls_out_ourcert$&
13888 .vindex "&$tls_out_ourcert$&"
13889 This variable refers to the certificate presented to the peer of an
13890 outbound connection.  It is only useful as the argument of a
13891 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13892 or a &%def%& condition.
13893
13894 .vitem &$tls_out_peercert$&
13895 .vindex "&$tls_out_peercert$&"
13896 This variable refers to the certificate presented by the peer of an
13897 outbound connection.  It is only useful as the argument of a
13898 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13899 or a &%def%& condition.
13900 If certificate verification fails it may refer to a failing chain element
13901 which is not the leaf.
13902
13903 .vitem &$tls_in_certificate_verified$&
13904 .vindex "&$tls_in_certificate_verified$&"
13905 This variable is set to &"1"& if a TLS certificate was verified when the
13906 message was received, and &"0"& otherwise.
13907
13908 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13909 except when used in the context of an outbound SMTP delivery, when it refers to
13910 the outbound.
13911
13912 .vitem &$tls_out_certificate_verified$&
13913 .vindex "&$tls_out_certificate_verified$&"
13914 This variable is set to &"1"& if a TLS certificate was verified when an
13915 outbound SMTP connection was made,
13916 and &"0"& otherwise.
13917
13918 .vitem &$tls_in_cipher$&
13919 .vindex "&$tls_in_cipher$&"
13920 .vindex "&$tls_cipher$&"
13921 When a message is received from a remote host over an encrypted SMTP
13922 connection, this variable is set to the cipher suite that was negotiated, for
13923 example DES-CBC3-SHA. In other circumstances, in particular, for message
13924 received over unencrypted connections, the variable is empty. Testing
13925 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13926 non-encrypted connections during ACL processing.
13927
13928 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13929 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13930 becomes the same as &$tls_out_cipher$&.
13931
13932 .vitem &$tls_in_cipher_std$&
13933 .vindex "&$tls_in_cipher_std$&"
13934 As above, but returning the RFC standard name for the cipher suite.
13935
13936 .vitem &$tls_out_cipher$&
13937 .vindex "&$tls_out_cipher$&"
13938 This variable is
13939 cleared before any outgoing SMTP connection is made,
13940 and then set to the outgoing cipher suite if one is negotiated. See chapter
13941 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13942 details of the &(smtp)& transport.
13943
13944 .vitem &$tls_out_cipher_std$&
13945 .vindex "&$tls_out_cipher_std$&"
13946 As above, but returning the RFC standard name for the cipher suite.
13947
13948 .vitem &$tls_out_dane$&
13949 .vindex &$tls_out_dane$&
13950 DANE active status.  See section &<<SECDANE>>&.
13951
13952 .vitem &$tls_in_ocsp$&
13953 .vindex "&$tls_in_ocsp$&"
13954 When a message is received from a remote client connection
13955 the result of any OCSP request from the client is encoded in this variable:
13956 .code
13957 0 OCSP proof was not requested (default value)
13958 1 No response to request
13959 2 Response not verified
13960 3 Verification failed
13961 4 Verification succeeded
13962 .endd
13963
13964 .vitem &$tls_out_ocsp$&
13965 .vindex "&$tls_out_ocsp$&"
13966 When a message is sent to a remote host connection
13967 the result of any OCSP request made is encoded in this variable.
13968 See &$tls_in_ocsp$& for values.
13969
13970 .vitem &$tls_in_peerdn$&
13971 .vindex "&$tls_in_peerdn$&"
13972 .vindex "&$tls_peerdn$&"
13973 .cindex certificate "extracting fields"
13974 When a message is received from a remote host over an encrypted SMTP
13975 connection, and Exim is configured to request a certificate from the client,
13976 the value of the Distinguished Name of the certificate is made available in the
13977 &$tls_in_peerdn$& during subsequent processing.
13978 If certificate verification fails it may refer to a failing chain element
13979 which is not the leaf.
13980
13981 The deprecated &$tls_peerdn$& variable refers to the inbound side
13982 except when used in the context of an outbound SMTP delivery, when it refers to
13983 the outbound.
13984
13985 .vitem &$tls_out_peerdn$&
13986 .vindex "&$tls_out_peerdn$&"
13987 When a message is being delivered to a remote host over an encrypted SMTP
13988 connection, and Exim is configured to request a certificate from the server,
13989 the value of the Distinguished Name of the certificate is made available in the
13990 &$tls_out_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
13995 .vitem &$tls_in_resumption$& &&&
13996        &$tls_out_resumption$&
13997 .vindex &$tls_in_resumption$&
13998 .vindex &$tls_out_resumption$&
13999 .cindex TLS resumption
14000 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
14001
14002
14003 .tvar &$tls_in_sni$&
14004 .vindex "&$tls_sni$&"
14005 .cindex "TLS" "Server Name Indication"
14006 .cindex "TLS" SNI
14007 .cindex SNI "observability on server"
14008 When a TLS session is being established, if the client sends the Server
14009 Name Indication extension, the value will be placed in this variable.
14010 If the variable appears in &%tls_certificate%& then this option and
14011 some others, described in &<<SECTtlssni>>&,
14012 will be re-expanded early in the TLS session, to permit
14013 a different certificate to be presented (and optionally a different key to be
14014 used) to the client, based upon the value of the SNI extension.
14015
14016 The deprecated &$tls_sni$& variable refers to the inbound side
14017 except when used in the context of an outbound SMTP delivery, when it refers to
14018 the outbound.
14019
14020 .vitem &$tls_out_sni$&
14021 .vindex "&$tls_out_sni$&"
14022 .cindex "TLS" "Server Name Indication"
14023 .cindex "TLS" SNI
14024 .cindex SNI "observability in client"
14025 During outbound
14026 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
14027 the transport.
14028
14029 .vitem &$tls_out_tlsa_usage$&
14030 .vindex &$tls_out_tlsa_usage$&
14031 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
14032
14033 .vitem &$tls_in_ver$&
14034 .vindex "&$tls_in_ver$&"
14035 When a message is received from a remote host over an encrypted SMTP connection
14036 this variable is set to the protocol version, eg &'TLS1.2'&.
14037
14038 .vitem &$tls_out_ver$&
14039 .vindex "&$tls_out_ver$&"
14040 When a message is being delivered to a remote host over an encrypted SMTP connection
14041 this variable is set to the protocol version.
14042
14043
14044 .vitem &$tod_bsdinbox$&
14045 .vindex "&$tod_bsdinbox$&"
14046 The time of day and the date, in the format required for BSD-style mailbox
14047 files, for example: Thu Oct 17 17:14:09 1995.
14048
14049 .vitem &$tod_epoch$&
14050 .vindex "&$tod_epoch$&"
14051 The time and date as a number of seconds since the start of the Unix epoch.
14052
14053 .vitem &$tod_epoch_l$&
14054 .vindex "&$tod_epoch_l$&"
14055 The time and date as a number of microseconds since the start of the Unix epoch.
14056
14057 .vitem &$tod_full$&
14058 .vindex "&$tod_full$&"
14059 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
14060 +0100. The timezone is always given as a numerical offset from UTC, with
14061 positive values used for timezones that are ahead (east) of UTC, and negative
14062 values for those that are behind (west).
14063
14064 .vitem &$tod_log$&
14065 .vindex "&$tod_log$&"
14066 The time and date in the format used for writing Exim's log files, for example:
14067 1995-10-12 15:32:29, but without a timezone.
14068
14069 .vitem &$tod_logfile$&
14070 .vindex "&$tod_logfile$&"
14071 This variable contains the date in the format yyyymmdd. This is the format that
14072 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14073 flag.
14074
14075 .vitem &$tod_zone$&
14076 .vindex "&$tod_zone$&"
14077 This variable contains the numerical value of the local timezone, for example:
14078 -0500.
14079
14080 .vitem &$tod_zulu$&
14081 .vindex "&$tod_zulu$&"
14082 This variable contains the UTC date and time in &"Zulu"& format, as specified
14083 by ISO 8601, for example: 20030221154023Z.
14084
14085 .vitem &$transport_name$&
14086 .cindex "transport" "name"
14087 .cindex "name" "of transport"
14088 .vindex "&$transport_name$&"
14089 During the running of a transport, this variable contains its name.
14090
14091 .vitem &$value$&
14092 .vindex "&$value$&"
14093 This variable contains the result of an expansion lookup, extraction operation,
14094 or external command, as described above. It is also used during a
14095 &*reduce*& expansion.
14096
14097 .vitem &$verify_mode$&
14098 .vindex "&$verify_mode$&"
14099 While a router or transport is being run in verify mode or for cutthrough delivery,
14100 contains "S" for sender-verification or "R" for recipient-verification.
14101 Otherwise, empty.
14102
14103 .vitem &$version_number$&
14104 .vindex "&$version_number$&"
14105 The version number of Exim. Same as &$exim_version$&, may be overridden
14106 by the &%exim_version%& main config option.
14107
14108 .vitem &$warn_message_delay$&
14109 .vindex "&$warn_message_delay$&"
14110 This variable is set only during the creation of a message warning about a
14111 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14112
14113 .vitem &$warn_message_recipients$&
14114 .vindex "&$warn_message_recipients$&"
14115 This variable is set only during the creation of a message warning about a
14116 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14117 .endlist
14118 .ecindex IIDstrexp
14119
14120
14121
14122 . ////////////////////////////////////////////////////////////////////////////
14123 . ////////////////////////////////////////////////////////////////////////////
14124
14125 .chapter "Embedded Perl" "CHAPperl"
14126 .scindex IIDperl "Perl" "calling from Exim"
14127 Exim can be built to include an embedded Perl interpreter. When this is done,
14128 Perl subroutines can be called as part of the string expansion process. To make
14129 use of the Perl support, you need version 5.004 or later of Perl installed on
14130 your system. To include the embedded interpreter in the Exim binary, include
14131 the line
14132 .code
14133 EXIM_PERL = perl.o
14134 .endd
14135 in your &_Local/Makefile_& and then build Exim in the normal way.
14136
14137
14138 .section "Setting up so Perl can be used" "SECID85"
14139 .oindex "&%perl_startup%&"
14140 Access to Perl subroutines is via a global configuration option called
14141 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14142 no &%perl_startup%& option in the Exim configuration file then no Perl
14143 interpreter is started and there is almost no overhead for Exim (since none of
14144 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14145 option then the associated value is taken to be Perl code which is executed in
14146 a newly created Perl interpreter.
14147
14148 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14149 need backslashes before any characters to escape special meanings. The option
14150 should usually be something like
14151 .code
14152 perl_startup = do '/etc/exim.pl'
14153 .endd
14154 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14155 use from Exim. Exim can be configured either to start up a Perl interpreter as
14156 soon as it is entered, or to wait until the first time it is needed. Starting
14157 the interpreter at the beginning ensures that it is done while Exim still has
14158 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14159 fact used in a particular run. Also, note that this does not mean that Exim is
14160 necessarily running as root when Perl is called at a later time. By default,
14161 the interpreter is started only when it is needed, but this can be changed in
14162 two ways:
14163
14164 .ilist
14165 .oindex "&%perl_at_start%&"
14166 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14167 a startup when Exim is entered.
14168 .next
14169 The command line option &%-ps%& also requests a startup when Exim is entered,
14170 overriding the setting of &%perl_at_start%&.
14171 .endlist
14172
14173 There is also a command line option &%-pd%& (for delay) which suppresses the
14174 initial startup, even if &%perl_at_start%& is set.
14175
14176 .ilist
14177 .oindex "&%perl_taintmode%&"
14178 .cindex "Perl" "taintmode"
14179 To provide more security executing Perl code via the embedded Perl
14180 interpreter, the &%perl_taintmode%& option can be set. This enables the
14181 taint mode of the Perl interpreter. You are encouraged to set this
14182 option to a true value. To avoid breaking existing installations, it
14183 defaults to false.
14184
14185 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14186
14187
14188 .section "Calling Perl subroutines" "SECID86"
14189 When the configuration file includes a &%perl_startup%& option you can make use
14190 of the string expansion item to call the Perl subroutines that are defined
14191 by the &%perl_startup%& code. The operator is used in any of the following
14192 forms:
14193 .code
14194 ${perl{foo}}
14195 ${perl{foo}{argument}}
14196 ${perl{foo}{argument1}{argument2} ... }
14197 .endd
14198 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14199 arguments may be passed. Passing more than this results in an expansion failure
14200 with an error message of the form
14201 .code
14202 Too many arguments passed to Perl subroutine "foo" (max is 8)
14203 .endd
14204 The return value of the Perl subroutine is evaluated in a scalar context before
14205 it is passed back to Exim to be inserted into the expanded string. If the
14206 return value is &'undef'&, the expansion is forced to fail in the same way as
14207 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14208 by obeying Perl's &%die%& function, the expansion fails with the error message
14209 that was passed to &%die%&.
14210
14211
14212 .section "Calling Exim functions from Perl" "SECID87"
14213 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14214 is available to call back into Exim's string expansion function. For example,
14215 the Perl code
14216 .code
14217 my $lp = Exim::expand_string('$local_part');
14218 .endd
14219 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14220 Note those are single quotes and not double quotes to protect against
14221 &$local_part$& being interpolated as a Perl variable.
14222
14223 If the string expansion is forced to fail by a &"fail"& item, the result of
14224 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14225 expansion string, the Perl call from the original expansion string fails with
14226 an appropriate error message, in the same way as if &%die%& were used.
14227
14228 .cindex "debugging" "from embedded Perl"
14229 .cindex "log" "writing from embedded Perl"
14230 Two other Exim functions are available for use from within Perl code.
14231 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14232 debugging is enabled. If you want a newline at the end, you must supply it.
14233 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14234 timestamp. In this case, you should not supply a terminating newline.
14235
14236
14237 .section "Use of standard output and error by Perl" "SECID88"
14238 .cindex "Perl" "standard output and error"
14239 You should not write to the standard error or output streams from within your
14240 Perl code, as it is not defined how these are set up. In versions of Exim
14241 before 4.50, it is possible for the standard output or error to refer to the
14242 SMTP connection during message reception via the daemon. Writing to this stream
14243 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14244 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14245 avoided, but the output is lost.
14246
14247 .cindex "Perl" "use of &%warn%&"
14248 The Perl &%warn%& statement writes to the standard error stream by default.
14249 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14250 you have no control. When Exim starts up the Perl interpreter, it arranges for
14251 output from the &%warn%& statement to be written to the Exim main log. You can
14252 change this by including appropriate Perl magic somewhere in your Perl code.
14253 For example, to discard &%warn%& output completely, you need this:
14254 .code
14255 $SIG{__WARN__} = sub { };
14256 .endd
14257 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14258 example, the code for the subroutine is empty, so it does nothing, but you can
14259 include any Perl code that you like. The text of the &%warn%& message is passed
14260 as the first subroutine argument.
14261 .ecindex IIDperl
14262
14263
14264 . ////////////////////////////////////////////////////////////////////////////
14265 . ////////////////////////////////////////////////////////////////////////////
14266
14267 .chapter "Starting the daemon and the use of network interfaces" &&&
14268          "CHAPinterfaces" &&&
14269          "Starting the daemon"
14270 .cindex "daemon" "starting"
14271 .cindex "interface" "listening"
14272 .cindex "network interface"
14273 .cindex "interface" "network"
14274 .cindex "IP address" "for listening"
14275 .cindex "daemon" "listening IP addresses"
14276 .cindex "TCP/IP" "setting listening interfaces"
14277 .cindex "TCP/IP" "setting listening ports"
14278 A host that is connected to a TCP/IP network may have one or more physical
14279 hardware network interfaces. Each of these interfaces may be configured as one
14280 or more &"logical"& interfaces, which are the entities that a program actually
14281 works with. Each of these logical interfaces is associated with an IP address.
14282 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14283 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14284 knowledge about the host's interfaces for use in three different circumstances:
14285
14286 .olist
14287 When a listening daemon is started, Exim needs to know which interfaces
14288 and ports to listen on.
14289 .next
14290 When Exim is routing an address, it needs to know which IP addresses
14291 are associated with local interfaces. This is required for the correct
14292 processing of MX lists by removing the local host and others with the
14293 same or higher priority values. Also, Exim needs to detect cases
14294 when an address is routed to an IP address that in fact belongs to the
14295 local host. Unless the &%self%& router option or the &%allow_localhost%&
14296 option of the smtp transport is set (as appropriate), this is treated
14297 as an error situation.
14298 .next
14299 When Exim connects to a remote host, it may need to know which interface to use
14300 for the outgoing connection.
14301 .endlist
14302
14303
14304 Exim's default behaviour is likely to be appropriate in the vast majority
14305 of cases. If your host has only one interface, and you want all its IP
14306 addresses to be treated in the same way, and you are using only the
14307 standard SMTP port, you should not need to take any special action. The
14308 rest of this chapter does not apply to you.
14309
14310 In a more complicated situation you may want to listen only on certain
14311 interfaces, or on different ports, and for this reason there are a number of
14312 options that can be used to influence Exim's behaviour. The rest of this
14313 chapter describes how they operate.
14314
14315 When a message is received over TCP/IP, the interface and port that were
14316 actually used are set in &$received_ip_address$& and &$received_port$&.
14317
14318
14319
14320 .section "Starting a listening daemon" "SECID89"
14321 When a listening daemon is started (by means of the &%-bd%& command line
14322 option), the interfaces and ports on which it listens are controlled by the
14323 following options:
14324
14325 .ilist
14326 &%daemon_smtp_ports%& contains a list of default ports
14327 or service names.
14328 (For backward compatibility, this option can also be specified in the singular.)
14329 .next
14330 &%local_interfaces%& contains list of interface IP addresses on which to
14331 listen. Each item may optionally also specify a port.
14332 .endlist
14333
14334 The default list separator in both cases is a colon, but this can be changed as
14335 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14336 it is usually best to change the separator to avoid having to double all the
14337 colons. For example:
14338 .code
14339 local_interfaces = <; 127.0.0.1 ; \
14340                       192.168.23.65 ; \
14341                       ::1 ; \
14342                       3ffe:ffff:836f::fe86:a061
14343 .endd
14344 There are two different formats for specifying a port along with an IP address
14345 in &%local_interfaces%&:
14346
14347 .olist
14348 The port is added onto the address with a dot separator. For example, to listen
14349 on port 1234 on two different IP addresses:
14350 .code
14351 local_interfaces = <; 192.168.23.65.1234 ; \
14352                       3ffe:ffff:836f::fe86:a061.1234
14353 .endd
14354 .next
14355 The IP address is enclosed in square brackets, and the port is added
14356 with a colon separator, for example:
14357 .code
14358 local_interfaces = <; [192.168.23.65]:1234 ; \
14359                       [3ffe:ffff:836f::fe86:a061]:1234
14360 .endd
14361 .endlist
14362
14363 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14364 default setting contains just one port:
14365 .code
14366 daemon_smtp_ports = smtp
14367 .endd
14368 If more than one port is listed, each interface that does not have its own port
14369 specified listens on all of them. Ports that are listed in
14370 &%daemon_smtp_ports%& can be identified either by name (defined in
14371 &_/etc/services_&) or by number. However, when ports are given with individual
14372 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14373
14374
14375
14376 .section "Special IP listening addresses" "SECID90"
14377 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14378 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14379 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14380 instead of setting up separate listening sockets for each interface. The
14381 default value of &%local_interfaces%& is
14382 .code
14383 local_interfaces = 0.0.0.0
14384 .endd
14385 when Exim is built without IPv6 support; otherwise it is:
14386 .code
14387 local_interfaces = <; ::0 ; 0.0.0.0
14388 .endd
14389 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14390
14391
14392
14393 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14394 The &%-oX%& command line option can be used to override the values of
14395 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14396 instance. Another way of doing this would be to use macros and the &%-D%&
14397 option. However, &%-oX%& can be used by any admin user, whereas modification of
14398 the runtime configuration by &%-D%& is allowed only when the caller is root or
14399 exim.
14400
14401 The value of &%-oX%& is a list of items. The default colon separator can be
14402 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14403 If there are any items that do not
14404 contain dots or colons (that is, are not IP addresses), the value of
14405 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14406 items that do contain dots or colons, the value of &%local_interfaces%& is
14407 replaced by those items. Thus, for example,
14408 .code
14409 -oX 1225
14410 .endd
14411 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14412 whereas
14413 .code
14414 -oX 192.168.34.5.1125
14415 .endd
14416 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14417 (However, since &%local_interfaces%& now contains no items without ports, the
14418 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14419
14420
14421
14422 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14423 .cindex "submissions protocol"
14424 .cindex "ssmtp protocol"
14425 .cindex "smtps protocol"
14426 .cindex "SMTP" "ssmtp protocol"
14427 .cindex "SMTP" "smtps protocol"
14428 Exim supports the use of TLS-on-connect, used by mail clients in the
14429 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14430 For some years, IETF Standards Track documents only blessed the
14431 STARTTLS-based Submission service (port 587) while common practice was to support
14432 the same feature set on port 465, but using TLS-on-connect.
14433 If your installation needs to provide service to mail clients
14434 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14435 the 465 TCP ports.
14436
14437 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14438 service names, connections to those ports must first establish TLS, before
14439 proceeding to the application layer use of the SMTP protocol.
14440
14441 The common use of this option is expected to be
14442 .code
14443 tls_on_connect_ports = 465
14444 .endd
14445 per RFC 8314.
14446 There is also a command line option &%-tls-on-connect%&, which forces all ports
14447 to behave in this way when a daemon is started.
14448
14449 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14450 daemon to listen on those ports. You must still specify them in
14451 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14452 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14453 connections via the daemon.)
14454
14455
14456
14457
14458 .section "IPv6 address scopes" "SECID92"
14459 .cindex "IPv6" "address scopes"
14460 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14461 can, in principle, have the same link-local IPv6 address on different
14462 interfaces. Thus, additional information is needed, over and above the IP
14463 address, to distinguish individual interfaces. A convention of using a
14464 percent sign followed by something (often the interface name) has been
14465 adopted in some cases, leading to addresses like this:
14466 .code
14467 fe80::202:b3ff:fe03:45c1%eth0
14468 .endd
14469 To accommodate this usage, a percent sign followed by an arbitrary string is
14470 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14471 to convert a textual IPv6 address for actual use. This function recognizes the
14472 percent convention in operating systems that support it, and it processes the
14473 address appropriately. Unfortunately, some older libraries have problems with
14474 &[getaddrinfo()]&. If
14475 .code
14476 IPV6_USE_INET_PTON=yes
14477 .endd
14478 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14479 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14480 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14481 function.) Of course, this means that the additional functionality of
14482 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14483
14484 .section "Disabling IPv6" "SECID93"
14485 .cindex "IPv6" "disabling"
14486 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14487 run on a host whose kernel does not support IPv6. The binary will fall back to
14488 using IPv4, but it may waste resources looking up AAAA records, and trying to
14489 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14490 .oindex "&%disable_ipv6%&"
14491 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14492 activities take place. AAAA records are never looked up, and any IPv6 addresses
14493 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14494 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14495 to handle IPv6 literal addresses.
14496
14497 On the other hand, when IPv6 is in use, there may be times when you want to
14498 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14499 option to globally suppress the lookup of AAAA records for specified domains,
14500 and you can use the &%ignore_target_hosts%& generic router option to ignore
14501 IPv6 addresses in an individual router.
14502
14503
14504
14505 .section "Examples of starting a listening daemon" "SECID94"
14506 The default case in an IPv6 environment is
14507 .code
14508 daemon_smtp_ports = smtp
14509 local_interfaces = <; ::0 ; 0.0.0.0
14510 .endd
14511 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14512 Either one or two sockets may be used, depending on the characteristics of
14513 the TCP/IP stack. (This is complicated and messy; for more information,
14514 read the comments in the &_daemon.c_& source file.)
14515
14516 To specify listening on ports 25 and 26 on all interfaces:
14517 .code
14518 daemon_smtp_ports = 25 : 26
14519 .endd
14520 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14521 .code
14522 local_interfaces = <; ::0.25     ; ::0.26 \
14523                       0.0.0.0.25 ; 0.0.0.0.26
14524 .endd
14525 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14526 IPv4 loopback address only:
14527 .code
14528 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14529 .endd
14530 To specify listening on the default port on specific interfaces only:
14531 .code
14532 local_interfaces = 10.0.0.67 : 192.168.34.67
14533 .endd
14534 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14535
14536
14537
14538 .section "Recognizing the local host" "SECTreclocipadd"
14539 The &%local_interfaces%& option is also used when Exim needs to determine
14540 whether or not an IP address refers to the local host. That is, the IP
14541 addresses of all the interfaces on which a daemon is listening are always
14542 treated as local.
14543
14544 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14545 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14546 available interfaces from the operating system, and extracts the relevant
14547 (that is, IPv4 or IPv6) addresses to use for checking.
14548
14549 Some systems set up large numbers of virtual interfaces in order to provide
14550 many virtual web servers. In this situation, you may want to listen for
14551 email on only a few of the available interfaces, but nevertheless treat all
14552 interfaces as local when routing. You can do this by setting
14553 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14554 &"all"& wildcard values. These addresses are recognized as local, but are not
14555 used for listening. Consider this example:
14556 .code
14557 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14558                       192.168.53.235 ; \
14559                       3ffe:2101:12:1:a00:20ff:fe86:a061
14560
14561 extra_local_interfaces = <; ::0 ; 0.0.0.0
14562 .endd
14563 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14564 address, but all available interface addresses are treated as local when
14565 Exim is routing.
14566
14567 In some environments the local host name may be in an MX list, but with an IP
14568 address that is not assigned to any local interface. In other cases it may be
14569 desirable to treat other host names as if they referred to the local host. Both
14570 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14571 This contains host names rather than IP addresses. When a host is referenced
14572 during routing, either via an MX record or directly, it is treated as the local
14573 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14574 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14575
14576
14577
14578 .section "Delivering to a remote host" "SECID95"
14579 Delivery to a remote host is handled by the smtp transport. By default, it
14580 allows the system's TCP/IP functions to choose which interface to use (if
14581 there is more than one) when connecting to a remote host. However, the
14582 &%interface%& option can be set to specify which interface is used. See the
14583 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14584 details.
14585
14586
14587
14588
14589 . ////////////////////////////////////////////////////////////////////////////
14590 . ////////////////////////////////////////////////////////////////////////////
14591
14592 .chapter "Main configuration" "CHAPmainconfig"
14593 .scindex IIDconfima "configuration file" "main section"
14594 .scindex IIDmaiconf "main configuration"
14595 The first part of the runtime configuration file contains three types of item:
14596
14597 .ilist
14598 Macro definitions: These lines start with an upper case letter. See section
14599 &<<SECTmacrodefs>>& for details of macro processing.
14600 .next
14601 Named list definitions: These lines start with one of the words &"domainlist"&,
14602 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14603 section &<<SECTnamedlists>>&.
14604 .next
14605 Main configuration settings: Each setting occupies one line of the file
14606 (with possible continuations). If any setting is preceded by the word
14607 &"hide"&, the &%-bP%& command line option displays its value to admin users
14608 only. See section &<<SECTcos>>& for a description of the syntax of these option
14609 settings.
14610 .endlist
14611
14612 This chapter specifies all the main configuration options, along with their
14613 types and default values. For ease of finding a particular option, they appear
14614 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14615 are now so many options, they are first listed briefly in functional groups, as
14616 an aid to finding the name of the option you are looking for. Some options are
14617 listed in more than one group.
14618
14619 .section "Miscellaneous" "SECID96"
14620 .table2
14621 .row &%add_environment%&             "environment variables"
14622 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14623 .row &%debug_store%&                 "do extra internal checks"
14624 .row &%disable_ipv6%&                "do no IPv6 processing"
14625 .row &%keep_environment%&            "environment variables"
14626 .row &%keep_malformed%&              "for broken files &-- should not happen"
14627 .row &%localhost_number%&            "for unique message ids in clusters"
14628 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14629 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14630 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14631 .row &%print_topbitchars%&           "top-bit characters are printing"
14632 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14633 .row &%timezone%&                    "force time zone"
14634 .endtable
14635
14636
14637 .section "Exim parameters" "SECID97"
14638 .table2
14639 .row &%exim_group%&                  "override compiled-in value"
14640 .row &%exim_path%&                   "override compiled-in value"
14641 .row &%exim_user%&                   "override compiled-in value"
14642 .row &%primary_hostname%&            "default from &[uname()]&"
14643 .row &%split_spool_directory%&       "use multiple directories"
14644 .row &%spool_directory%&             "override compiled-in value"
14645 .endtable
14646
14647
14648
14649 .section "Privilege controls" "SECID98"
14650 .table2
14651 .row &%admin_groups%&                "groups that are Exim admin users"
14652 .row &%commandline_checks_require_admin%& "require admin for various checks"
14653 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14654 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14655 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14656 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14657 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14658 .row &%never_users%&                 "do not run deliveries as these"
14659 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14660 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14661 .row &%trusted_groups%&              "groups that are trusted"
14662 .row &%trusted_users%&               "users that are trusted"
14663 .endtable
14664
14665
14666
14667 .section "Logging" "SECID99"
14668 .table2
14669 .row &%event_action%&                "custom logging"
14670 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14671 .row &%log_file_path%&               "override compiled-in value"
14672 .row &%log_selector%&                "set/unset optional logging"
14673 .row &%log_timezone%&                "add timezone to log lines"
14674 .row &%message_logs%&                "create per-message logs"
14675 .row &%preserve_message_logs%&       "after message completion"
14676 .row &%panic_coredump%&              "request coredump on fatal errors"
14677 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14678 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14679 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14680 .row &%syslog_facility%&             "set syslog &""facility""& field"
14681 .row &%syslog_pid%&                  "pid in syslog lines"
14682 .row &%syslog_processname%&          "set syslog &""ident""& field"
14683 .row &%syslog_timestamp%&            "timestamp syslog lines"
14684 .row &%write_rejectlog%&             "control use of message log"
14685 .endtable
14686
14687
14688
14689 .section "Frozen messages" "SECID100"
14690 .table2
14691 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14692 .row &%freeze_tell%&                 "send message when freezing"
14693 .row &%move_frozen_messages%&        "to another directory"
14694 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14695 .endtable
14696
14697
14698
14699 .section "Data lookups" "SECID101"
14700 .table2
14701 .row &%ibase_servers%&               "InterBase servers"
14702 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14703 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14704 .row &%ldap_cert_file%&              "client cert file for LDAP"
14705 .row &%ldap_cert_key%&               "client key file for LDAP"
14706 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14707 .row &%ldap_default_servers%&        "used if no server in query"
14708 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14709 .row &%ldap_start_tls%&              "require TLS within LDAP"
14710 .row &%ldap_version%&                "set protocol version"
14711 .row &%lookup_open_max%&             "lookup files held open"
14712 .row &%mysql_servers%&               "default MySQL servers"
14713 .row &%oracle_servers%&              "Oracle servers"
14714 .row &%pgsql_servers%&               "default PostgreSQL servers"
14715 .row &%sqlite_lock_timeout%&         "as it says"
14716 .endtable
14717
14718
14719
14720 .section "Message ids" "SECID102"
14721 .table2
14722 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14723 .row &%message_id_header_text%&      "ditto"
14724 .endtable
14725
14726
14727
14728 .section "Embedded Perl Startup" "SECID103"
14729 .table2
14730 .row &%perl_at_start%&               "always start the interpreter"
14731 .row &%perl_startup%&                "code to obey when starting Perl"
14732 .row &%perl_taintmode%&              "enable taint mode in Perl"
14733 .endtable
14734
14735
14736
14737 .section "Daemon" "SECID104"
14738 .table2
14739 .row &%daemon_smtp_ports%&           "default ports"
14740 .row &%daemon_startup_retries%&      "number of times to retry"
14741 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14742 .row &%extra_local_interfaces%&      "not necessarily listened on"
14743 .row &%local_interfaces%&            "on which to listen, with optional ports"
14744 .row &%notifier_socket%&             "override compiled-in value"
14745 .row &%pid_file_path%&               "override compiled-in value"
14746 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14747 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14748 .endtable
14749
14750
14751
14752 .section "Resource control" "SECID105"
14753 .table2
14754 .row &%check_log_inodes%&            "before accepting a message"
14755 .row &%check_log_space%&             "before accepting a message"
14756 .row &%check_spool_inodes%&          "before accepting a message"
14757 .row &%check_spool_space%&           "before accepting a message"
14758 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14759 .row &%queue_only_load%&             "queue incoming if load high"
14760 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14761 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14762 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14763 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14764 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14765 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14766 .row &%smtp_accept_max_per_connection%& "messages per connection"
14767 .row &%smtp_accept_max_per_host%&    "connections from one host"
14768 .row &%smtp_accept_queue%&           "queue mail if more connections"
14769 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14770                                            connection"
14771 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14772 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14773 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14774 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14775 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14776 .endtable
14777
14778
14779
14780 .section "Policy controls" "SECID106"
14781 .table2
14782 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14783 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14784 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14785 .row &%acl_smtp_auth%&               "ACL for AUTH"
14786 .row &%acl_smtp_connect%&            "ACL for connection"
14787 .row &%acl_smtp_data%&               "ACL for DATA"
14788 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14789 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14790 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14791 .row &%acl_smtp_expn%&               "ACL for EXPN"
14792 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14793 .row &%acl_smtp_mail%&               "ACL for MAIL"
14794 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14795 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14796 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14797 .row &%acl_smtp_predata%&            "ACL for start of data"
14798 .row &%acl_smtp_quit%&               "ACL for QUIT"
14799 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14800 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14801 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14802 .row &%av_scanner%&                  "specify virus scanner"
14803 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14804                                       words""&"
14805 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14806 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14807 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14808 .row &%header_maxsize%&              "total size of message header"
14809 .row &%header_line_maxsize%&         "individual header line limit"
14810 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14811 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14812 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14813 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14814 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14815 .row &%host_lookup%&                 "host name looked up for these hosts"
14816 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14817 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14818 .row &%host_reject_connection%&      "reject connection from these hosts"
14819 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14820 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14821 .row &%message_size_limit%&          "for all messages"
14822 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14823 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14824 .row &%spamd_address%&               "set interface to SpamAssassin"
14825 .row &%strict_acl_vars%&             "object to unset ACL variables"
14826 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14827 .endtable
14828
14829
14830
14831 .section "Callout cache" "SECID107"
14832 .table2
14833 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14834                                          item"
14835 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14836                                          item"
14837 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14838 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14839 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14840 .endtable
14841
14842
14843
14844 .section "TLS" "SECID108"
14845 .table2
14846 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14847 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14848 .row &%hosts_require_alpn%&          "mandatory ALPN"
14849 .row &%hosts_require_helo%&          "mandatory HELO/EHLO"
14850 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14851 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14852 .row &%tls_alpn%&                    "acceptable protocol names"
14853 .row &%tls_certificate%&             "location of server certificate"
14854 .row &%tls_crl%&                     "certificate revocation list"
14855 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14856 .row &%tls_dhparam%&                 "DH parameters for server"
14857 .row &%tls_eccurve%&                 "EC curve selection for server"
14858 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14859 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14860 .row &%tls_privatekey%&              "location of server private key"
14861 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14862 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14863 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14864 .row &%tls_verify_certificates%&     "expected client certificates"
14865 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14866 .endtable
14867
14868
14869
14870 .section "Local user handling" "SECID109"
14871 .table2
14872 .row &%finduser_retries%&            "useful in NIS environments"
14873 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14874 .row &%gecos_pattern%&               "ditto"
14875 .row &%max_username_length%&         "for systems that truncate"
14876 .row &%unknown_login%&               "used when no login name found"
14877 .row &%unknown_username%&            "ditto"
14878 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14879 .row &%uucp_from_sender%&            "ditto"
14880 .endtable
14881
14882
14883
14884 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14885 .table2
14886 .row &%header_maxsize%&              "total size of message header"
14887 .row &%header_line_maxsize%&         "individual header line limit"
14888 .row &%message_size_limit%&          "applies to all messages"
14889 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14890 .row &%received_header_text%&        "expanded to make &'Received:'&"
14891 .row &%received_headers_max%&        "for mail loop detection"
14892 .row &%recipients_max%&              "limit per message"
14893 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14894 .endtable
14895
14896
14897
14898
14899 .section "Non-SMTP incoming messages" "SECID111"
14900 .table2
14901 .row &%receive_timeout%&             "for non-SMTP messages"
14902 .endtable
14903
14904
14905
14906
14907
14908 .section "Incoming SMTP messages" "SECID112"
14909 See also the &'Policy controls'& section above.
14910
14911 .table2
14912 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14913 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14914 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14915 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14916 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14917 .row &%dmarc_history_file%&          "DMARC results log"
14918 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14919 .row &%host_lookup%&                 "host name looked up for these hosts"
14920 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14921 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14922 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14923 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14924 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14925 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14926 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14927 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14928 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14929 .row &%smtp_accept_max_per_connection%& "messages per connection"
14930 .row &%smtp_accept_max_per_host%&    "connections from one host"
14931 .row &%smtp_accept_queue%&           "queue mail if more connections"
14932 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14933                                            connection"
14934 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14935 .row &%smtp_active_hostname%&        "host name to use in messages"
14936 .row &%smtp_banner%&                 "text for welcome banner"
14937 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14938 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14939 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14940 .row &%smtp_etrn_command%&           "what to run for ETRN"
14941 .row &%smtp_etrn_serialize%&         "only one at once"
14942 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14943 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14944 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14945 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14946 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14947 .row &%smtp_receive_timeout%&        "per command or data line"
14948 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14949 .row &%smtp_return_error_details%&   "give detail on rejections"
14950 .endtable
14951
14952
14953
14954 .section "SMTP extensions" "SECID113"
14955 .table2
14956 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14957 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14958 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14959 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14960 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14961 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14962 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14963 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14964 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14965 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14966 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14967 .endtable
14968
14969
14970
14971 .section "Processing messages" "SECID114"
14972 .table2
14973 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14974 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14975 .row &%allow_utf8_domains%&          "in addresses"
14976 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14977                                       words""&"
14978 .row &%delivery_date_remove%&        "from incoming messages"
14979 .row &%envelope_to_remove%&          "from incoming messages"
14980 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14981 .row &%headers_charset%&             "default for translations"
14982 .row &%qualify_domain%&              "default for senders"
14983 .row &%qualify_recipient%&           "default for recipients"
14984 .row &%return_path_remove%&          "from incoming messages"
14985 .row &%strip_excess_angle_brackets%& "in addresses"
14986 .row &%strip_trailing_dot%&          "at end of addresses"
14987 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14988 .endtable
14989
14990
14991
14992 .section "System filter" "SECID115"
14993 .table2
14994 .row &%system_filter%&               "locate system filter"
14995 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14996                                             directory"
14997 .row &%system_filter_file_transport%& "transport for delivery to a file"
14998 .row &%system_filter_group%&         "group for filter running"
14999 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
15000 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
15001 .row &%system_filter_user%&          "user for filter running"
15002 .endtable
15003
15004
15005
15006 .section "Routing and delivery" "SECID116"
15007 .table2
15008 .row &%disable_ipv6%&                "do no IPv6 processing"
15009 .row &%dns_again_means_nonexist%&    "for broken domains"
15010 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
15011 .row &%dns_dnssec_ok%&               "parameter for resolver"
15012 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
15013 .row &%dns_retrans%&                 "parameter for resolver"
15014 .row &%dns_retry%&                   "parameter for resolver"
15015 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
15016 .row &%dns_use_edns0%&               "parameter for resolver"
15017 .row &%hold_domains%&                "hold delivery for these domains"
15018 .row &%local_interfaces%&            "for routing checks"
15019 .row &%queue_domains%&               "no immediate delivery for these"
15020 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
15021 .row &%queue_only%&                  "no immediate delivery at all"
15022 .row &%queue_only_file%&             "no immediate delivery if file exists"
15023 .row &%queue_only_load%&             "no immediate delivery if load is high"
15024 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
15025 .row &%queue_only_override%&         "allow command line to override"
15026 .row &%queue_run_in_order%&          "order of arrival"
15027 .row &%queue_run_max%&               "of simultaneous queue runners"
15028 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
15029 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
15030 .row &%remote_sort_domains%&         "order of remote deliveries"
15031 .row &%retry_data_expire%&           "timeout for retry data"
15032 .row &%retry_interval_max%&          "safety net for retry rules"
15033 .endtable
15034
15035
15036
15037 .section "Bounce and warning messages" "SECID117"
15038 .table2
15039 .row &%bounce_message_file%&         "content of bounce"
15040 .row &%bounce_message_text%&         "content of bounce"
15041 .row &%bounce_return_body%&          "include body if returning message"
15042 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
15043 .row &%bounce_return_message%&       "include original message in bounce"
15044 .row &%bounce_return_size_limit%&    "limit on returned message"
15045 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
15046 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
15047 .row &%errors_copy%&                 "copy bounce messages"
15048 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
15049 .row &%delay_warning%&               "time schedule"
15050 .row &%delay_warning_condition%&     "condition for warning messages"
15051 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
15052 .row &%smtp_return_error_details%&   "give detail on rejections"
15053 .row &%warn_message_file%&           "content of warning message"
15054 .endtable
15055
15056
15057
15058 .section "Alphabetical list of main options" "SECTalomo"
15059 Those options that undergo string expansion before use are marked with
15060 &dagger;.
15061
15062 .option accept_8bitmime main boolean true
15063 .cindex "8BITMIME"
15064 .cindex "8-bit characters"
15065 .cindex "log" "selectors"
15066 .cindex "log" "8BITMIME"
15067 .cindex "ESMTP extensions" 8BITMIME
15068 This option causes Exim to send 8BITMIME in its response to an SMTP
15069 EHLO command, and to accept the BODY= parameter on MAIL commands.
15070 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15071 takes no steps to do anything special with messages received by this route.
15072
15073 Historically Exim kept this option off by default, but the maintainers
15074 feel that in today's Internet, this causes more problems than it solves.
15075 It now defaults to true.
15076 A more detailed analysis of the issues is provided by Dan Bernstein:
15077 .display
15078 &url(https://cr.yp.to/smtp/8bitmime.html)
15079 .endd
15080
15081 To log received 8BITMIME status use
15082 .code
15083 log_selector = +8bitmime
15084 .endd
15085
15086 .option acl_not_smtp main string&!! unset
15087 .cindex "&ACL;" "for non-SMTP messages"
15088 .cindex "non-SMTP messages" "ACLs for"
15089 This option defines the ACL that is run when a non-SMTP message has been
15090 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15091 further details.
15092
15093 .option acl_not_smtp_mime main string&!! unset
15094 This option defines the ACL that is run for individual MIME parts of non-SMTP
15095 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15096 SMTP messages.
15097
15098 .option acl_not_smtp_start main string&!! unset
15099 .cindex "&ACL;" "at start of non-SMTP message"
15100 .cindex "non-SMTP messages" "ACLs for"
15101 This option defines the ACL that is run before Exim starts reading a
15102 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15103
15104 .option acl_smtp_auth main string&!! unset
15105 .cindex "&ACL;" "setting up for SMTP commands"
15106 .cindex "AUTH" "ACL for"
15107 This option defines the ACL that is run when an SMTP AUTH command is
15108 received. See chapter &<<CHAPACL>>& for further details.
15109
15110 .option acl_smtp_connect main string&!! unset
15111 .cindex "&ACL;" "on SMTP connection"
15112 This option defines the ACL that is run when an SMTP connection is received.
15113 See chapter &<<CHAPACL>>& for further details.
15114
15115 .option acl_smtp_data main string&!! unset
15116 .cindex "DATA" "ACL for"
15117 This option defines the ACL that is run after an SMTP DATA command has been
15118 processed and the message itself has been received, but before the final
15119 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15120
15121 .option acl_smtp_data_prdr main string&!! accept
15122 .cindex "PRDR" "ACL for"
15123 .cindex "DATA" "PRDR ACL for"
15124 .cindex "&ACL;" "PRDR-related"
15125 .cindex "&ACL;" "per-user data processing"
15126 This option defines the ACL that,
15127 if the PRDR feature has been negotiated,
15128 is run for each recipient after an SMTP DATA command has been
15129 processed and the message itself has been received, but before the
15130 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15131
15132 .option acl_smtp_dkim main string&!! unset
15133 .cindex DKIM "ACL for"
15134 This option defines the ACL that is run for each DKIM signature
15135 (by default, or as specified in the dkim_verify_signers option)
15136 of a received message.
15137 See section &<<SECDKIMVFY>>& for further details.
15138
15139 .option acl_smtp_etrn main string&!! unset
15140 .cindex "ETRN" "ACL for"
15141 This option defines the ACL that is run when an SMTP ETRN command is
15142 received. See chapter &<<CHAPACL>>& for further details.
15143
15144 .option acl_smtp_expn main string&!! unset
15145 .cindex "EXPN" "ACL for"
15146 This option defines the ACL that is run when an SMTP EXPN command is
15147 received. See chapter &<<CHAPACL>>& for further details.
15148
15149 .option acl_smtp_helo main string&!! unset
15150 .cindex "EHLO" "ACL for"
15151 .cindex "HELO" "ACL for"
15152 This option defines the ACL that is run when an SMTP EHLO or HELO
15153 command is received. See chapter &<<CHAPACL>>& for further details.
15154
15155
15156 .option acl_smtp_mail main string&!! unset
15157 .cindex "MAIL" "ACL for"
15158 This option defines the ACL that is run when an SMTP MAIL command is
15159 received. See chapter &<<CHAPACL>>& for further details.
15160
15161 .option acl_smtp_mailauth main string&!! unset
15162 .cindex "AUTH" "on MAIL command"
15163 This option defines the ACL that is run when there is an AUTH parameter on
15164 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15165 &<<CHAPSMTPAUTH>>& for details of authentication.
15166
15167 .option acl_smtp_mime main string&!! unset
15168 .cindex "MIME content scanning" "ACL for"
15169 This option is available when Exim is built with the content-scanning
15170 extension. It defines the ACL that is run for each MIME part in a message. See
15171 section &<<SECTscanmimepart>>& for details.
15172
15173 .option acl_smtp_notquit main string&!! unset
15174 .cindex "not-QUIT, ACL for"
15175 This option defines the ACL that is run when an SMTP session
15176 ends without a QUIT command being received.
15177 See chapter &<<CHAPACL>>& for further details.
15178
15179 .option acl_smtp_predata main string&!! unset
15180 This option defines the ACL that is run when an SMTP DATA command is
15181 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15182 further details.
15183
15184 .option acl_smtp_quit main string&!! unset
15185 .cindex "QUIT, ACL for"
15186 This option defines the ACL that is run when an SMTP QUIT command is
15187 received. See chapter &<<CHAPACL>>& for further details.
15188
15189 .option acl_smtp_rcpt main string&!! unset
15190 .cindex "RCPT" "ACL for"
15191 This option defines the ACL that is run when an SMTP RCPT command is
15192 received. See chapter &<<CHAPACL>>& for further details.
15193
15194 .option acl_smtp_starttls main string&!! unset
15195 .cindex "STARTTLS, ACL for"
15196 This option defines the ACL that is run when an SMTP STARTTLS command is
15197 received. See chapter &<<CHAPACL>>& for further details.
15198
15199 .option acl_smtp_vrfy main string&!! unset
15200 .cindex "VRFY" "ACL for"
15201 This option defines the ACL that is run when an SMTP VRFY command is
15202 received. See chapter &<<CHAPACL>>& for further details.
15203
15204 .option add_environment main "string list" empty
15205 .cindex "environment" "set values"
15206 This option adds individual environment variables that the
15207 currently linked libraries and programs in child processes may use.
15208 Each list element should be of the form &"name=value"&.
15209
15210 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15211
15212 .option admin_groups main "string list&!!" unset
15213 .cindex "admin user"
15214 This option is expanded just once, at the start of Exim's processing. If the
15215 current group or any of the supplementary groups of an Exim caller is in this
15216 colon-separated list, the caller has admin privileges. If all your system
15217 programmers are in a specific group, for example, you can give them all Exim
15218 admin privileges by putting that group in &%admin_groups%&. However, this does
15219 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15220 To permit this, you have to add individuals to the Exim group.
15221
15222 .option allow_domain_literals main boolean false
15223 .cindex "domain literal"
15224 If this option is set, the RFC 2822 domain literal format is permitted in
15225 email addresses. The option is not set by default, because the domain literal
15226 format is not normally required these days, and few people know about it. It
15227 has, however, been exploited by mail abusers.
15228
15229 Unfortunately, it seems that some DNS black list maintainers are using this
15230 format to report black listing to postmasters. If you want to accept messages
15231 addressed to your hosts by IP address, you need to set
15232 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15233 domains (defined in the named domain list &%local_domains%& in the default
15234 configuration). This &"magic string"& matches the domain literal form of all
15235 the local host's IP addresses.
15236
15237 .option allow_mx_to_ip main boolean false
15238 .cindex "MX record" "pointing to IP address"
15239 It appears that more and more DNS zone administrators are breaking the rules
15240 and putting domain names that look like IP addresses on the right hand side of
15241 MX records. Exim follows the rules and rejects this, giving an error message
15242 that explains the misconfiguration. However, some other MTAs support this
15243 practice, so to avoid &"Why can't Exim do this?"& complaints,
15244 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15245 recommended, except when you have no other choice.
15246
15247 .option allow_utf8_domains main boolean false
15248 .cindex "domain" "UTF-8 characters in"
15249 .cindex "UTF-8" "in domain name"
15250 Lots of discussion is going on about internationalized domain names. One
15251 camp is strongly in favour of just using UTF-8 characters, and it seems
15252 that at least two other MTAs permit this.
15253 This option allows Exim users to experiment if they wish.
15254
15255 If it is set true, Exim's domain parsing function allows valid
15256 UTF-8 multicharacters to appear in domain name components, in addition to
15257 letters, digits, and hyphens.
15258
15259 If Exim is built with internationalization support
15260 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15261 this option can be left as default.
15262 Without that,
15263 if you want to look up such domain names in the DNS, you must also
15264 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15265 suitable setting is:
15266 .code
15267 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15268   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15269 .endd
15270 Alternatively, you can just disable this feature by setting
15271 .code
15272 dns_check_names_pattern =
15273 .endd
15274 That is, set the option to an empty string so that no check is done.
15275
15276
15277 .option auth_advertise_hosts main "host list&!!" *
15278 .cindex "authentication" "advertising"
15279 .cindex "AUTH" "advertising"
15280 .cindex "ESMTP extensions" AUTH
15281 If any server authentication mechanisms are configured, Exim advertises them in
15282 response to an EHLO command only if the calling host matches this list.
15283 Otherwise, Exim does not advertise AUTH.
15284 Exim does not accept AUTH commands from clients to which it has not
15285 advertised the availability of AUTH. The advertising of individual
15286 authentication mechanisms can be controlled by the use of the
15287 &%server_advertise_condition%& generic authenticator option on the individual
15288 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15289
15290 Certain mail clients (for example, Netscape) require the user to provide a name
15291 and password for authentication if AUTH is advertised, even though it may
15292 not be needed (the host may accept messages from hosts on its local LAN without
15293 authentication, for example). The &%auth_advertise_hosts%& option can be used
15294 to make these clients more friendly by excluding them from the set of hosts to
15295 which Exim advertises AUTH.
15296
15297 .cindex "AUTH" "advertising when encrypted"
15298 If you want to advertise the availability of AUTH only when the connection
15299 is encrypted using TLS, you can make use of the fact that the value of this
15300 option is expanded, with a setting like this:
15301 .code
15302 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15303 .endd
15304 .vindex "&$tls_in_cipher$&"
15305 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15306 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15307 expansion is *, which matches all hosts.
15308
15309
15310 .option auto_thaw main time 0s
15311 .cindex "thawing messages"
15312 .cindex "unfreezing messages"
15313 If this option is set to a time greater than zero, a queue runner will try a
15314 new delivery attempt on any frozen message, other than a bounce message, if
15315 this much time has passed since it was frozen. This may result in the message
15316 being re-frozen if nothing has changed since the last attempt. It is a way of
15317 saying &"keep on trying, even though there are big problems"&.
15318
15319 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15320 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15321 thought to be very useful any more, and its use should probably be avoided.
15322
15323
15324 .option av_scanner main string "see below"
15325 This option is available if Exim is built with the content-scanning extension.
15326 It specifies which anti-virus scanner to use. The default value is:
15327 .code
15328 sophie:/var/run/sophie
15329 .endd
15330 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15331 before use. See section &<<SECTscanvirus>>& for further details.
15332
15333
15334 .option bi_command main string unset
15335 .oindex "&%-bi%&"
15336 This option supplies the name of a command that is run when Exim is called with
15337 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15338 just the command name, it is not a complete command line. If an argument is
15339 required, it must come from the &%-oA%& command line option.
15340
15341
15342 .option bounce_message_file main string&!! unset
15343 .cindex "bounce message" "customizing"
15344 .cindex "customizing" "bounce message"
15345 This option defines a template file containing paragraphs of text to be used
15346 for constructing bounce messages.  Details of the file's contents are given in
15347 chapter &<<CHAPemsgcust>>&.
15348 .cindex bounce_message_file "tainted data"
15349 The option is expanded to give the file path, which must be
15350 absolute and untainted.
15351 See also &%warn_message_file%&.
15352
15353
15354 .option bounce_message_text main string unset
15355 When this option is set, its contents are included in the default bounce
15356 message immediately after &"This message was created automatically by mail
15357 delivery software."& It is not used if &%bounce_message_file%& is set.
15358
15359 .option bounce_return_body main boolean true
15360 .cindex "bounce message" "including body"
15361 This option controls whether the body of an incoming message is included in a
15362 bounce message when &%bounce_return_message%& is true. The default setting
15363 causes the entire message, both header and body, to be returned (subject to the
15364 value of &%bounce_return_size_limit%&). If this option is false, only the
15365 message header is included. In the case of a non-SMTP message containing an
15366 error that is detected during reception, only those header lines preceding the
15367 point at which the error was detected are returned.
15368 .cindex "bounce message" "including original"
15369
15370 .option bounce_return_linesize_limit main integer 998
15371 .cindex "size" "of bounce lines, limit"
15372 .cindex "bounce message" "line length limit"
15373 .cindex "limit" "bounce message line length"
15374 This option sets a limit in bytes on the line length of messages
15375 that are returned to senders due to delivery problems,
15376 when &%bounce_return_message%& is true.
15377 The default value corresponds to RFC limits.
15378 If the message being returned has lines longer than this value it is
15379 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15380
15381 The option also applies to bounces returned when an error is detected
15382 during reception of a message.
15383 In this case lines from the original are truncated.
15384
15385 The option does not apply to messages generated by an &(autoreply)& transport.
15386
15387
15388 .option bounce_return_message main boolean true
15389 If this option is set false, none of the original message is included in
15390 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15391 &%bounce_return_body%&.
15392
15393
15394 .option bounce_return_size_limit main integer 100K
15395 .cindex "size" "of bounce, limit"
15396 .cindex "bounce message" "size limit"
15397 .cindex "limit" "bounce message size"
15398 This option sets a limit in bytes on the size of messages that are returned to
15399 senders as part of bounce messages when &%bounce_return_message%& is true. The
15400 limit should be less than the value of the global &%message_size_limit%& and of
15401 any &%message_size_limit%& settings on transports, to allow for the bounce text
15402 that Exim generates. If this option is set to zero there is no limit.
15403
15404 When the body of any message that is to be included in a bounce message is
15405 greater than the limit, it is truncated, and a comment pointing this out is
15406 added at the top. The actual cutoff may be greater than the value given, owing
15407 to the use of buffering for transferring the message in chunks (typically 8K in
15408 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15409 messages.
15410
15411 .option bounce_sender_authentication main string unset
15412 .cindex "bounce message" "sender authentication"
15413 .cindex "authentication" "bounce message"
15414 .cindex "AUTH" "on bounce message"
15415 This option provides an authenticated sender address that is sent with any
15416 bounce messages generated by Exim that are sent over an authenticated SMTP
15417 connection. A typical setting might be:
15418 .code
15419 bounce_sender_authentication = mailer-daemon@my.domain.example
15420 .endd
15421 which would cause bounce messages to be sent using the SMTP command:
15422 .code
15423 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15424 .endd
15425 The value of &%bounce_sender_authentication%& must always be a complete email
15426 address.
15427
15428 .option callout_domain_negative_expire main time 3h
15429 .cindex "caching" "callout timeouts"
15430 .cindex "callout" "caching timeouts"
15431 This option specifies the expiry time for negative callout cache data for a
15432 domain. See section &<<SECTcallver>>& for details of callout verification, and
15433 section &<<SECTcallvercache>>& for details of the caching.
15434
15435
15436 .option callout_domain_positive_expire main time 7d
15437 This option specifies the expiry time for positive callout cache data for a
15438 domain. See section &<<SECTcallver>>& for details of callout verification, and
15439 section &<<SECTcallvercache>>& for details of the caching.
15440
15441
15442 .option callout_negative_expire main time 2h
15443 This option specifies the expiry time for negative callout cache data for an
15444 address. See section &<<SECTcallver>>& for details of callout verification, and
15445 section &<<SECTcallvercache>>& for details of the caching.
15446
15447
15448 .option callout_positive_expire main time 24h
15449 This option specifies the expiry time for positive callout cache data for an
15450 address. See section &<<SECTcallver>>& for details of callout verification, and
15451 section &<<SECTcallvercache>>& for details of the caching.
15452
15453
15454 .option callout_random_local_part main string&!! "see below"
15455 This option defines the &"random"& local part that can be used as part of
15456 callout verification. The default value is
15457 .code
15458 $primary_hostname-$tod_epoch-testing
15459 .endd
15460 See section &<<CALLaddparcall>>& for details of how this value is used.
15461
15462
15463 .options check_log_inodes main integer 100 &&&
15464          check_log_space main integer 10M
15465 See &%check_spool_space%& below.
15466
15467 .oindex "&%check_rfc2047_length%&"
15468 .cindex "RFC 2047" "disabling length check"
15469 .option check_rfc2047_length main boolean true
15470 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15471 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15472 word; strings to be encoded that exceed this length are supposed to use
15473 multiple encoded words. By default, Exim does not recognize encoded words that
15474 exceed the maximum length. However, it seems that some software, in violation
15475 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15476 set false, Exim recognizes encoded words of any length.
15477
15478
15479 .options check_spool_inodes main integer 100 &&&
15480          check_spool_space main integer 10M
15481 .cindex "checking disk space"
15482 .cindex "disk space, checking"
15483 .cindex "spool directory" "checking space"
15484 The four &%check_...%& options allow for checking of disk resources before a
15485 message is accepted.
15486
15487 .vindex "&$log_inodes$&"
15488 .vindex "&$log_space$&"
15489 .vindex "&$spool_inodes$&"
15490 .vindex "&$spool_space$&"
15491 When any of these options are nonzero, they apply to all incoming messages. If you
15492 want to apply different checks to different kinds of message, you can do so by
15493 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15494 &$spool_space$& in an ACL with appropriate additional conditions.
15495
15496
15497 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15498 either value is greater than zero, for example:
15499 .code
15500 check_spool_space = 100M
15501 check_spool_inodes = 100
15502 .endd
15503 The spool partition is the one that contains the directory defined by
15504 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15505 transit.
15506
15507 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15508 files are written if either is greater than zero. These should be set only if
15509 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15510
15511 If there is less space or fewer inodes than requested, Exim refuses to accept
15512 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15513 error response to the MAIL command. If ESMTP is in use and there was a
15514 SIZE parameter on the MAIL command, its value is added to the
15515 &%check_spool_space%& value, and the check is performed even if
15516 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15517
15518 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15519 number of kilobytes (though specified in bytes).
15520 If a non-multiple of 1024 is specified, it is rounded up.
15521
15522 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15523 failure a message is written to stderr and Exim exits with a non-zero code, as
15524 it obviously cannot send an error message of any kind.
15525
15526 There is a slight performance penalty for these checks.
15527 Versions of Exim preceding 4.88 had these disabled by default;
15528 high-rate installations confident they will never run out of resources
15529 may wish to deliberately disable them.
15530
15531 .option chunking_advertise_hosts main "host list&!!" *
15532 .cindex CHUNKING advertisement
15533 .cindex "RFC 3030" "CHUNKING"
15534 .cindex "ESMTP extensions" CHUNKING
15535 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15536 these hosts.
15537 Hosts may use the BDAT command as an alternate to DATA.
15538
15539 .option commandline_checks_require_admin main boolean &`false`&
15540 .cindex "restricting access to features"
15541 This option restricts various basic checking features to require an
15542 administrative user.
15543 This affects most of the &%-b*%& options, such as &%-be%&.
15544
15545 .option debug_store main boolean &`false`&
15546 .cindex debugging "memory corruption"
15547 .cindex memory debugging
15548 This option, when true, enables extra checking in Exim's internal memory
15549 management.  For use when a memory corruption issue is being investigated,
15550 it should normally be left as default.
15551
15552 .option daemon_smtp_ports main string &`smtp`&
15553 .cindex "port" "for daemon"
15554 .cindex "TCP/IP" "setting listening ports"
15555 This option specifies one or more default SMTP ports on which the Exim daemon
15556 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15557 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15558
15559 .options daemon_startup_retries main integer 9 &&&
15560          daemon_startup_sleep main time 30s
15561 .cindex "daemon startup, retrying"
15562 These options control the retrying done by
15563 the daemon at startup when it cannot immediately bind a listening socket
15564 (typically because the socket is already in use): &%daemon_startup_retries%&
15565 defines the number of retries after the first failure, and
15566 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15567
15568 .option delay_warning main "time list" 24h
15569 .cindex "warning of delay"
15570 .cindex "delay warning, specifying"
15571 .cindex "queue" "delay warning"
15572 When a message is delayed, Exim sends a warning message to the sender at
15573 intervals specified by this option. The data is a colon-separated list of times
15574 after which to send warning messages. If the value of the option is an empty
15575 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15576 message has been in the queue for longer than the last time, the last interval
15577 between the times is used to compute subsequent warning times. For example,
15578 with
15579 .code
15580 delay_warning = 4h:8h:24h
15581 .endd
15582 the first message is sent after 4 hours, the second after 8 hours, and
15583 the third one after 24 hours. After that, messages are sent every 16 hours,
15584 because that is the interval between the last two times on the list. If you set
15585 just one time, it specifies the repeat interval. For example, with:
15586 .code
15587 delay_warning = 6h
15588 .endd
15589 messages are repeated every six hours. To stop warnings after a given time, set
15590 a very large time at the end of the list. For example:
15591 .code
15592 delay_warning = 2h:12h:99d
15593 .endd
15594 Note that the option is only evaluated at the time a delivery attempt fails,
15595 which depends on retry and queue-runner configuration.
15596 Typically retries will be configured more frequently than warning messages.
15597
15598 .option delay_warning_condition main string&!! "see below"
15599 .vindex "&$domain$&"
15600 The string is expanded at the time a warning message might be sent. If all the
15601 deferred addresses have the same domain, it is set in &$domain$& during the
15602 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15603 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15604 &"false"& (the comparison being done caselessly) then the warning message is
15605 not sent. The default is:
15606 .code
15607 delay_warning_condition = ${if or {\
15608   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15609   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15610   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15611   } {no}{yes}}
15612 .endd
15613 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15614 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15615 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15616 &"auto-replied"& in an &'Auto-Submitted:'& header.
15617
15618 .option deliver_drop_privilege main boolean false
15619 .cindex "unprivileged delivery"
15620 .cindex "delivery" "unprivileged"
15621 If this option is set true, Exim drops its root privilege at the start of a
15622 delivery process, and runs as the Exim user throughout. This severely restricts
15623 the kinds of local delivery that are possible, but is viable in certain types
15624 of configuration. There is a discussion about the use of root privilege in
15625 chapter &<<CHAPsecurity>>&.
15626
15627 .option deliver_queue_load_max main fixed-point unset
15628 .cindex "load average"
15629 .cindex "queue runner" "abandoning"
15630 When this option is set, a queue run is abandoned if the system load average
15631 becomes greater than the value of the option. The option has no effect on
15632 ancient operating systems on which Exim cannot determine the load average.
15633 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15634
15635
15636 .option delivery_date_remove main boolean true
15637 .cindex "&'Delivery-date:'& header line"
15638 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15639 message when it is delivered, in exactly the same way as &'Return-path:'& is
15640 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15641 should not be present in incoming messages, and this option causes them to be
15642 removed at the time the message is received, to avoid any problems that might
15643 occur when a delivered message is subsequently sent on to some other recipient.
15644
15645 .option disable_fsync main boolean false
15646 .cindex "&[fsync()]&, disabling"
15647 This option is available only if Exim was built with the compile-time option
15648 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15649 a runtime configuration generates an &"unknown option"& error. You should not
15650 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15651 really, really, really understand what you are doing. &'No pre-compiled
15652 distributions of Exim should ever make this option available.'&
15653
15654 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15655 updated files' data to be written to disc before continuing. Unexpected events
15656 such as crashes and power outages may cause data to be lost or scrambled.
15657 Here be Dragons. &*Beware.*&
15658
15659
15660 .option disable_ipv6 main boolean false
15661 .cindex "IPv6" "disabling"
15662 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15663 activities take place. AAAA records are never looked up, and any IPv6 addresses
15664 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15665 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15666 to handle IPv6 literal addresses.
15667
15668
15669 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15670 .cindex DKIM "selecting signature algorithms"
15671 This option gives a list of hash types which are acceptable in signatures,
15672 and an order of processing.
15673 Signatures with algorithms not in the list will be ignored.
15674
15675 Acceptable values include:
15676 .code
15677 sha1
15678 sha256
15679 sha512
15680 .endd
15681
15682 Note that the acceptance of sha1 violates RFC 8301.
15683
15684 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15685 This option gives a list of key 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
15690 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15691 This option gives a list of key sizes which are acceptable in signatures.
15692 The list is keyed by the algorithm type for the key; the values are in bits.
15693 Signatures with keys smaller than given by this option will fail verification.
15694
15695 The default enforces the RFC 8301 minimum key size for RSA signatures.
15696
15697 .option dkim_verify_minimal main boolean false
15698 If set to true, verification of signatures will terminate after the
15699 first success.
15700
15701 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15702 .cindex DKIM "controlling calls to the ACL"
15703 This option gives a list of DKIM domains for which the DKIM ACL is run.
15704 It is expanded after the message is received; by default it runs
15705 the ACL once for each signature in the message.
15706 See section &<<SECDKIMVFY>>&.
15707
15708
15709 .option dmarc_forensic_sender main string&!! unset
15710 .option dmarc_history_file main string unset
15711 .option dmarc_tld_file main string unset
15712 .cindex DMARC "main section options"
15713 These options control DMARC processing.
15714 See section &<<SECDMARC>>& for details.
15715
15716
15717 .option dns_again_means_nonexist main "domain list&!!" unset
15718 .cindex "DNS" "&""try again""& response; overriding"
15719 DNS lookups give a &"try again"& response for the DNS errors
15720 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15721 keep trying to deliver a message, or to give repeated temporary errors to
15722 incoming mail. Sometimes the effect is caused by a badly set up name server and
15723 may persist for a long time. If a domain which exhibits this problem matches
15724 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15725 This option should be used with care. You can make it apply to reverse lookups
15726 by a setting such as this:
15727 .code
15728 dns_again_means_nonexist = *.in-addr.arpa
15729 .endd
15730 This option applies to all DNS lookups that Exim does,
15731 except for TLSA lookups (where knowing about such failures
15732 is security-relevant).
15733 It also applies when the
15734 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15735 since these are most likely to be caused by DNS lookup problems. The
15736 &(dnslookup)& router has some options of its own for controlling what happens
15737 when lookups for MX or SRV records give temporary errors. These more specific
15738 options are applied after this global option.
15739
15740 .option dns_check_names_pattern main string "see below"
15741 .cindex "DNS" "pre-check of name syntax"
15742 When this option is set to a non-empty string, it causes Exim to check domain
15743 names for characters that are not allowed in host names before handing them to
15744 the DNS resolver, because some resolvers give temporary errors for names that
15745 contain unusual characters. If a domain name contains any unwanted characters,
15746 a &"not found"& result is forced, and the resolver is not called. The check is
15747 done by matching the domain name against a regular expression, which is the
15748 value of this option. The default pattern is
15749 .code
15750 dns_check_names_pattern = \
15751   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15752 .endd
15753 which permits only letters, digits, slashes, and hyphens in components, but
15754 they must start and end with a letter or digit. Slashes are not, in fact,
15755 permitted in host names, but they are found in certain NS records (which can be
15756 accessed in Exim by using a &%dnsdb%& lookup). If you set
15757 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15758 empty string.
15759
15760 .option dns_csa_search_limit main integer 5
15761 This option controls the depth of parental searching for CSA SRV records in the
15762 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15763
15764 .option dns_csa_use_reverse main boolean true
15765 This option controls whether or not an IP address, given as a CSA domain, is
15766 reversed and looked up in the reverse DNS, as described in more detail in
15767 section &<<SECTverifyCSA>>&.
15768
15769 .option dns_cname_loops main integer 1
15770 .cindex DNS "CNAME following"
15771 This option controls the following of CNAME chains, needed if the resolver does
15772 not do it internally.
15773 As of 2018 most should, and the default can be left.
15774 If you have an ancient one, a value of 10 is likely needed.
15775
15776 The default value of one CNAME-follow is needed
15777 thanks to the observed return for an MX request,
15778 given no MX presence but a CNAME to an A, of the CNAME.
15779
15780
15781 .option dns_dnssec_ok main integer -1
15782 .cindex "DNS" "resolver options"
15783 .cindex "DNS" "DNSSEC"
15784 If this option is set to a non-negative number then Exim will initialise the
15785 DNS resolver library to either use or not use DNSSEC, overriding the system
15786 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15787
15788 If the resolver library does not support DNSSEC then this option has no effect.
15789
15790 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15791 will default to stripping out a successful validation status.
15792 This will break a previously working Exim installation.
15793 Provided that you do trust the resolver (ie, is on localhost) you can tell
15794 glibc to pass through any successful validation with a new option in
15795 &_/etc/resolv.conf_&:
15796 .code
15797 options trust-ad
15798 .endd
15799
15800
15801 .option dns_ipv4_lookup main "domain list&!!" unset
15802 .cindex "IPv6" "DNS lookup for AAAA records"
15803 .cindex "DNS" "IPv6 lookup for AAAA records"
15804 .cindex DNS "IPv6 disabling"
15805 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15806 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15807 (A records) when trying to find IP addresses for hosts, unless the host's
15808 domain matches this list.
15809
15810 This is a fudge to help with name servers that give big delays or otherwise do
15811 not work for the AAAA record type. In due course, when the world's name
15812 servers have all been upgraded, there should be no need for this option.
15813 Note that all lookups, including those done for verification, are affected;
15814 this will result in verify failure for IPv6 connections or ones using names
15815 only valid for IPv6 addresses.
15816
15817
15818 .option dns_retrans main time 0s
15819 .cindex "DNS" "resolver options"
15820 .cindex timeout "dns lookup"
15821 .cindex "DNS" timeout
15822 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15823 retransmission and retry parameters for DNS lookups. Values of zero (the
15824 defaults) leave the system default settings unchanged. The first value is the
15825 time between retries, and the second is the number of retries. It isn't
15826 totally clear exactly how these settings affect the total time a DNS lookup may
15827 take. I haven't found any documentation about timeouts on DNS lookups; these
15828 parameter values are available in the external resolver interface structure,
15829 but nowhere does it seem to describe how they are used or what you might want
15830 to set in them.
15831 See also the &%slow_lookup_log%& option.
15832
15833
15834 .option dns_retry main integer 0
15835 See &%dns_retrans%& above.
15836
15837
15838 .option dns_trust_aa main "domain list&!!" unset
15839 .cindex "DNS" "resolver options"
15840 .cindex "DNS" "DNSSEC"
15841 If this option is set then lookup results marked with the AA bit
15842 (Authoritative Answer) are trusted the same way as if they were
15843 DNSSEC-verified. The authority section's name of the answer must
15844 match with this expanded domain list.
15845
15846 Use this option only if you talk directly to a resolver that is
15847 authoritative for some zones and does not set the AD (Authentic Data)
15848 bit in the answer. Some DNS servers may have an configuration option to
15849 mark the answers from their own zones as verified (they set the AD bit).
15850 Others do not have this option. It is considered as poor practice using
15851 a resolver that is an authoritative server for some zones.
15852
15853 Use this option only if you really have to (e.g. if you want
15854 to use DANE for remote delivery to a server that is listed in the DNS
15855 zones that your resolver is authoritative for).
15856
15857 If the DNS answer packet has the AA bit set and contains resource record
15858 in the answer section, the name of the first NS record appearing in the
15859 authority section is compared against the list. If the answer packet is
15860 authoritative but the answer section is empty, the name of the first SOA
15861 record in the authoritative section is used instead.
15862
15863 .cindex "DNS" "resolver options"
15864 .option dns_use_edns0 main integer -1
15865 .cindex "DNS" "resolver options"
15866 .cindex "DNS" "EDNS0"
15867 .cindex "DNS" "OpenBSD
15868 If this option is set to a non-negative number then Exim will initialise the
15869 DNS resolver library to either use or not use EDNS0 extensions, overriding
15870 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15871 on.
15872
15873 If the resolver library does not support EDNS0 then this option has no effect.
15874
15875 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15876 means that DNSSEC will not work with Exim on that platform either, unless Exim
15877 is linked against an alternative DNS client library.
15878
15879
15880 .option drop_cr main boolean false
15881 This is an obsolete option that is now a no-op. It used to affect the way Exim
15882 handled CR and LF characters in incoming messages. What happens now is
15883 described in section &<<SECTlineendings>>&.
15884
15885 .option dsn_advertise_hosts main "host list&!!" unset
15886 .cindex "bounce messages" "success"
15887 .cindex "DSN" "success"
15888 .cindex "Delivery Status Notification" "success"
15889 .cindex "ESMTP extensions" DSN
15890 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15891 and accepted from, these hosts.
15892 Hosts may use the NOTIFY and ORCPT options on RCPT TO commands,
15893 and RET and ENVID options on MAIL FROM commands.
15894 A NOTIFY=SUCCESS option requests success-DSN messages.
15895 A NOTIFY= option with no argument requests that no delay or failure DSNs
15896 are sent.
15897 &*Note*&: Supplying success-DSN messages has been criticised
15898 on privacy grounds; it can leak details of internal forwarding.
15899
15900 .option dsn_from main "string&!!" "see below"
15901 .cindex "&'From:'& header line" "in bounces"
15902 .cindex "bounce messages" "&'From:'& line, specifying"
15903 This option can be used to vary the contents of &'From:'& header lines in
15904 bounces and other automatically generated messages (&"Delivery Status
15905 Notifications"& &-- hence the name of the option). The default setting is:
15906 .code
15907 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15908 .endd
15909 The value is expanded every time it is needed. If the expansion fails, a
15910 panic is logged, and the default value is used.
15911
15912 .option envelope_to_remove main boolean true
15913 .cindex "&'Envelope-to:'& header line"
15914 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15915 message when it is delivered, in exactly the same way as &'Return-path:'& is
15916 handled. &'Envelope-to:'& records the original recipient address from the
15917 message's envelope that caused the delivery to happen. Such headers should not
15918 be present in incoming messages, and this option causes them to be removed at
15919 the time the message is received, to avoid any problems that might occur when a
15920 delivered message is subsequently sent on to some other recipient.
15921
15922
15923 .option errors_copy main "string list&!!" unset
15924 .cindex "bounce message" "copy to other address"
15925 .cindex "copy of bounce message"
15926 Setting this option causes Exim to send bcc copies of bounce messages that it
15927 generates to other addresses. &*Note*&: This does not apply to bounce messages
15928 coming from elsewhere. The value of the option is a colon-separated list of
15929 items. Each item consists of a pattern, terminated by white space, followed by
15930 a comma-separated list of email addresses. If a pattern contains spaces, it
15931 must be enclosed in double quotes.
15932
15933 Each pattern is processed in the same way as a single item in an address list
15934 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15935 the bounce message, the message is copied to the addresses on the list. The
15936 items are scanned in order, and once a matching one is found, no further items
15937 are examined. For example:
15938 .code
15939 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15940               rqps@mydomain   hostmaster@mydomain.example,\
15941                               postmaster@mydomain.example
15942 .endd
15943 .vindex "&$domain$&"
15944 .vindex "&$local_part$&"
15945 The address list is expanded before use. The expansion variables &$local_part$&
15946 and &$domain$& are set from the original recipient of the error message, and if
15947 there was any wildcard matching in the pattern, the expansion
15948 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15949 variables &$0$&, &$1$&, etc. are set in the normal way.
15950
15951
15952 .option errors_reply_to main string unset
15953 .cindex "bounce message" "&'Reply-to:'& in"
15954 By default, Exim's bounce and delivery warning messages contain the header line
15955 .display
15956 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15957 .endd
15958 .oindex &%quota_warn_message%&
15959 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15960 A warning message that is generated by the &%quota_warn_message%& option in an
15961 &(appendfile)& transport may contain its own &'From:'& header line that
15962 overrides the default.
15963
15964 Experience shows that people reply to bounce messages. If the
15965 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15966 and warning messages. For example:
15967 .code
15968 errors_reply_to = postmaster@my.domain.example
15969 .endd
15970 The value of the option is not expanded. It must specify a valid RFC 2822
15971 address. However, if a warning message that is generated by the
15972 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15973 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15974 not used.
15975
15976
15977 .option event_action main string&!! unset
15978 .cindex events
15979 This option declares a string to be expanded for Exim's events mechanism.
15980 For details see chapter &<<CHAPevents>>&.
15981
15982
15983 .option exim_group main string "compile-time configured"
15984 .cindex "gid (group id)" "Exim's own"
15985 .cindex "Exim group"
15986 This option changes the gid under which Exim runs when it gives up root
15987 privilege. The default value is compiled into the binary. The value of this
15988 option is used only when &%exim_user%& is also set. Unless it consists entirely
15989 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15990 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15991 security issues.
15992
15993
15994 .option exim_path main string "see below"
15995 .cindex "Exim binary, path name"
15996 This option specifies the path name of the Exim binary, which is used when Exim
15997 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15998 the directory configured at compile time by the BIN_DIRECTORY setting. It
15999 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
16000 other place.
16001 &*Warning*&: Do not use a macro to define the value of this option, because
16002 you will break those Exim utilities that scan the configuration file to find
16003 where the binary is. (They then use the &%-bP%& option to extract option
16004 settings such as the value of &%spool_directory%&.)
16005
16006
16007 .option exim_user main string "compile-time configured"
16008 .cindex "uid (user id)" "Exim's own"
16009 .cindex "Exim user"
16010 This option changes the uid under which Exim runs when it gives up root
16011 privilege. The default value is compiled into the binary. Ownership of the run
16012 time configuration file and the use of the &%-C%& and &%-D%& command line
16013 options is checked against the values in the binary, not what is set here.
16014
16015 Unless it consists entirely of digits, the string is looked up using
16016 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
16017 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
16018 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
16019
16020
16021 .option exim_version main string "current version"
16022 .cindex "Exim version"
16023 .cindex customizing "version number"
16024 .cindex "version number of Exim" override
16025 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
16026 various places.  Use with care; this may fool stupid security scanners.
16027
16028
16029 .option extra_local_interfaces main "string list" unset
16030 This option defines network interfaces that are to be considered local when
16031 routing, but which are not used for listening by the daemon. See section
16032 &<<SECTreclocipadd>>& for details.
16033
16034
16035 . Allow this long option name to split; give it unsplit as a fifth argument
16036 . for the automatic .oindex that is generated by .option.
16037
16038 .option "extract_addresses_remove_arguments" main boolean true &&&
16039          extract_addresses_remove_arguments
16040 .oindex "&%-t%&"
16041 .cindex "command line" "addresses with &%-t%&"
16042 .cindex "Sendmail compatibility" "&%-t%& option"
16043 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
16044 are present on the command line when the &%-t%& option is used to build an
16045 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16046 line addresses are removed from the recipients list. This is also how Smail
16047 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16048 command line addresses are added to those obtained from the header lines. When
16049 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16050 argument headers. If it is set false, Exim adds rather than removes argument
16051 addresses.
16052
16053
16054 .option finduser_retries main integer 0
16055 .cindex "NIS, retrying user lookups"
16056 On systems running NIS or other schemes in which user and group information is
16057 distributed from a remote system, there can be times when &[getpwnam()]& and
16058 related functions fail, even when given valid data, because things time out.
16059 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16060 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16061 many extra times to find a user or a group, waiting for one second between
16062 retries.
16063
16064 .cindex "&_/etc/passwd_&" "multiple reading of"
16065 You should not set this option greater than zero if your user information is in
16066 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16067 search the file multiple times for non-existent users, and also cause delay.
16068
16069
16070
16071 .option freeze_tell main "string list, comma separated" unset
16072 .cindex "freezing messages" "sending a message when freezing"
16073 .cindex "frozen messages" "sending a message when freezing"
16074 On encountering certain errors, or when configured to do so in a system filter,
16075 ACL, or special router, Exim freezes a message. This means that no further
16076 delivery attempts take place until an administrator thaws the message, or the
16077 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16078 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16079 warning message whenever it freezes something, unless the message it is
16080 freezing is a locally-generated bounce message. (Without this exception there
16081 is the possibility of looping.) The warning message is sent to the addresses
16082 supplied as the comma-separated value of this option. If several of the
16083 message's addresses cause freezing, only a single message is sent. If the
16084 freezing was automatic, the reason(s) for freezing can be found in the message
16085 log. If you configure freezing in a filter or ACL, you must arrange for any
16086 logging that you require.
16087
16088
16089 .options gecos_name main string&!! unset &&&
16090          gecos_pattern main string unset
16091 .cindex "HP-UX"
16092 .cindex "&""gecos""& field, parsing"
16093 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16094 password file to hold other information in addition to users' real names. Exim
16095 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16096 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16097 of the field are used unchanged, except that, if an ampersand is encountered,
16098 it is replaced by the user's login name with the first character forced to
16099 upper case, since this is a convention that is observed on many systems.
16100
16101 When these options are set, &%gecos_pattern%& is treated as a regular
16102 expression that is to be applied to the field (again with && replaced by the
16103 login name), and if it matches, &%gecos_name%& is expanded and used as the
16104 user's name.
16105
16106 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16107 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16108 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16109 name terminates at the first comma, the following can be used:
16110 .code
16111 gecos_pattern = ([^,]*)
16112 gecos_name = $1
16113 .endd
16114
16115
16116 .option gnutls_compat_mode main boolean unset
16117 This option controls whether GnuTLS is used in compatibility mode in an Exim
16118 server. This reduces security slightly, but improves interworking with older
16119 implementations of TLS.
16120
16121
16122 .option gnutls_allow_auto_pkcs11 main boolean unset
16123 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16124 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16125
16126 See
16127 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16128 for documentation.
16129
16130
16131
16132 .option headers_charset main string "see below"
16133 This option sets a default character set for translating from encoded MIME
16134 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16135 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16136 ultimate default is ISO-8859-1. For more details see the description of header
16137 insertions in section &<<SECTexpansionitems>>&.
16138
16139
16140
16141 .option header_maxsize main integer "see below"
16142 .cindex "header section" "maximum size of"
16143 .cindex "limit" "size of message header section"
16144 This option controls the overall maximum size of a message's header
16145 section. The default is the value of HEADER_MAXSIZE in
16146 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16147 sections are rejected.
16148
16149
16150 .option header_line_maxsize main integer 0
16151 .cindex "header lines" "maximum size of"
16152 .cindex "limit" "size of one header line"
16153 This option limits the length of any individual header line in a message, after
16154 all the continuations have been joined together. Messages with individual
16155 header lines that are longer than the limit are rejected. The default value of
16156 zero means &"no limit"&.
16157
16158
16159
16160
16161 .option helo_accept_junk_hosts main "host list&!!" unset
16162 .cindex "HELO" "accepting junk data"
16163 .cindex "EHLO" "accepting junk data"
16164 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16165 mail, and gives an error response for invalid data. Unfortunately, there are
16166 some SMTP clients that send syntactic junk. They can be accommodated by setting
16167 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16168 if you want to do semantic checking.
16169 See also &%helo_allow_chars%& for a way of extending the permitted character
16170 set.
16171
16172
16173 .option helo_allow_chars main string unset
16174 .cindex "HELO" "underscores in"
16175 .cindex "EHLO" "underscores in"
16176 .cindex "underscore in EHLO/HELO"
16177 This option can be set to a string of rogue characters that are permitted in
16178 all EHLO and HELO names in addition to the standard letters, digits,
16179 hyphens, and dots. If you really must allow underscores, you can set
16180 .code
16181 helo_allow_chars = _
16182 .endd
16183 Note that the value is one string, not a list.
16184
16185
16186 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16187 .cindex "HELO" "forcing reverse lookup"
16188 .cindex "EHLO" "forcing reverse lookup"
16189 If the domain given by a client in a HELO or EHLO command matches this
16190 list, a reverse lookup is done in order to establish the host's true name. The
16191 default forces a lookup if the client host gives the server's name or any of
16192 its IP addresses (in brackets), something that broken clients have been seen to
16193 do.
16194
16195
16196 .option helo_try_verify_hosts main "host list&!!" unset
16197 .cindex "HELO verifying" "optional"
16198 .cindex "EHLO" "verifying, optional"
16199 By default, Exim just checks the syntax of HELO and EHLO commands (see
16200 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16201 to do more extensive checking of the data supplied by these commands. The ACL
16202 condition &`verify = helo`& is provided to make this possible.
16203 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16204 to force the check to occur. From release 4.53 onwards, this is no longer
16205 necessary. If the check has not been done before &`verify = helo`& is
16206 encountered, it is done at that time. Consequently, this option is obsolete.
16207 Its specification is retained here for backwards compatibility.
16208
16209 When an EHLO or HELO command is received, if the calling host matches
16210 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16211 EHLO command either:
16212
16213 .ilist
16214 is an IP literal matching the calling address of the host, or
16215 .next
16216 .cindex "DNS" "reverse lookup"
16217 .cindex "reverse DNS lookup"
16218 matches the host name that Exim obtains by doing a reverse lookup of the
16219 calling host address, or
16220 .next
16221 when looked up in DNS yields the calling host address.
16222 .endlist
16223
16224 However, the EHLO or HELO command is not rejected if any of the checks
16225 fail. Processing continues, but the result of the check is remembered, and can
16226 be detected later in an ACL by the &`verify = helo`& condition.
16227
16228 If DNS was used for successful verification, the variable
16229 .cindex "DNS" "DNSSEC"
16230 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16231
16232 .option helo_verify_hosts main "host list&!!" unset
16233 .cindex "HELO verifying" "mandatory"
16234 .cindex "EHLO" "verifying, mandatory"
16235 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16236 backwards compatibility. For hosts that match this option, Exim checks the host
16237 name given in the HELO or EHLO in the same way as for
16238 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16239 rejected with a 550 error, and entries are written to the main and reject logs.
16240 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16241 error.
16242
16243 .option hold_domains main "domain list&!!" unset
16244 .cindex "domain" "delaying delivery"
16245 .cindex "delivery" "delaying certain domains"
16246 This option allows mail for particular domains to be held in the queue
16247 manually. The option is overridden if a message delivery is forced with the
16248 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16249 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16250 item in &%hold_domains%&, no routing or delivery for that address is done, and
16251 it is deferred every time the message is looked at.
16252
16253 This option is intended as a temporary operational measure for delaying the
16254 delivery of mail while some problem is being sorted out, or some new
16255 configuration tested. If you just want to delay the processing of some
16256 domains until a queue run occurs, you should use &%queue_domains%& or
16257 &%queue_smtp_domains%&, not &%hold_domains%&.
16258
16259 A setting of &%hold_domains%& does not override Exim's code for removing
16260 messages from the queue if they have been there longer than the longest retry
16261 time in any retry rule. If you want to hold messages for longer than the normal
16262 retry times, insert a dummy retry rule with a long retry time.
16263
16264
16265 .option host_lookup main "host list&!!" unset
16266 .cindex "host name" "lookup, forcing"
16267 Exim does not look up the name of a calling host from its IP address unless it
16268 is required to compare against some host list, or the host matches
16269 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16270 option (which normally contains IP addresses rather than host names). The
16271 default configuration file contains
16272 .code
16273 host_lookup = *
16274 .endd
16275 which causes a lookup to happen for all hosts. If the expense of these lookups
16276 is felt to be too great, the setting can be changed or removed.
16277
16278 After a successful reverse lookup, Exim does a forward lookup on the name it
16279 has obtained, to verify that it yields the IP address that it started with. If
16280 this check fails, Exim behaves as if the name lookup failed.
16281
16282 .vindex "&$host_lookup_failed$&"
16283 .vindex "&$sender_host_name$&"
16284 After any kind of failure, the host name (in &$sender_host_name$&) remains
16285 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16286 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16287 &`verify = reverse_host_lookup`& in ACLs.
16288
16289
16290 .option host_lookup_order main "string list" &`bydns:byaddr`&
16291 This option specifies the order of different lookup methods when Exim is trying
16292 to find a host name from an IP address. The default is to do a DNS lookup
16293 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16294 if that fails. You can change the order of these lookups, or omit one entirely,
16295 if you want.
16296
16297 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16298 multiple PTR records in the DNS and the IP address is not listed in
16299 &_/etc/hosts_&. Different operating systems give different results in this
16300 case. That is why the default tries a DNS lookup first.
16301
16302
16303
16304 .option host_reject_connection main "host list&!!" unset
16305 .cindex "host" "rejecting connections from"
16306 If this option is set, incoming SMTP calls from the hosts listed are rejected
16307 as soon as the connection is made.
16308 This option is obsolete, and retained only for backward compatibility, because
16309 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16310 connections immediately.
16311
16312 If the connection is on a TLS-on-connect port then the TCP connection is
16313 just dropped.  Otherwise, an SMTP error is sent first.
16314
16315 The ability to give an immediate rejection (either by this option or using an
16316 ACL) is provided for use in unusual cases. Many hosts will just try again,
16317 sometimes without much delay. Normally, it is better to use an ACL to reject
16318 incoming messages at a later stage, such as after RCPT commands. See
16319 chapter &<<CHAPACL>>&.
16320
16321
16322 .option hosts_connection_nolog main "host list&!!" unset
16323 .cindex "host" "not logging connections from"
16324 This option defines a list of hosts for which connection logging does not
16325 happen, even though the &%smtp_connection%& log selector is set. For example,
16326 you might want not to log SMTP connections from local processes, or from
16327 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16328 the daemon; you should therefore strive to restrict its value to a short inline
16329 list of IP addresses and networks. To disable logging SMTP connections from
16330 local processes, you must create a host list with an empty item. For example:
16331 .code
16332 hosts_connection_nolog = :
16333 .endd
16334 The hosts affected by this option also do not log "no MAIL in SMTP connection"
16335 lines, as may commonly be produced by a monitoring system.
16336
16337
16338 .option hosts_require_alpn main "host list&!!" unset
16339 .cindex ALPN "require negotiation in server"
16340 .cindex TLS ALPN
16341 .cindex TLS "Application Layer Protocol Names"
16342 If the TLS library supports ALPN
16343 then a successful negotiation of ALPN will be required for any client
16344 matching the list, for TLS to be used.
16345 See also the &%tls_alpn%& option.
16346
16347 &*Note*&: prevention of fallback to in-clear connection is not
16348 managed by this option, and should be done separately.
16349
16350
16351 .option hosts_require_helo main "host list&!!" *
16352 .cindex "HELO/EHLO" requiring
16353 Exim will require an accepted HELO or EHLO command from a host matching
16354 this list, before accepting a MAIL command.
16355
16356
16357 .option hosts_proxy main "host list&!!" unset
16358 .cindex proxy "proxy protocol"
16359 This option enables use of Proxy Protocol proxies for incoming
16360 connections.  For details see section &<<SECTproxyInbound>>&.
16361
16362
16363 .option hosts_treat_as_local main "domain list&!!" unset
16364 .cindex "local host" "domains treated as"
16365 .cindex "host" "treated as local"
16366 If this option is set, any host names that match the domain list are treated as
16367 if they were the local host when Exim is scanning host lists obtained from MX
16368 records
16369 or other sources. Note that the value of this option is a domain list, not a
16370 host list, because it is always used to check host names, not IP addresses.
16371
16372 This option also applies when Exim is matching the special items
16373 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16374 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16375 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16376 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16377 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16378 interfaces and recognizing the local host.
16379
16380
16381 .option ibase_servers main "string list" unset
16382 .cindex "InterBase" "server list"
16383 This option provides a list of InterBase servers and associated connection data,
16384 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16385 The option is available only if Exim has been built with InterBase support.
16386
16387
16388
16389 .option ignore_bounce_errors_after main time 10w
16390 .cindex "bounce message" "discarding"
16391 .cindex "discarding bounce message"
16392 This option affects the processing of bounce messages that cannot be delivered,
16393 that is, those that suffer a permanent delivery failure. (Bounce messages that
16394 suffer temporary delivery failures are of course retried in the usual way.)
16395
16396 After a permanent delivery failure, bounce messages are frozen,
16397 because there is no sender to whom they can be returned. When a frozen bounce
16398 message has been in the queue for more than the given time, it is unfrozen at
16399 the next queue run, and a further delivery is attempted. If delivery fails
16400 again, the bounce message is discarded. This makes it possible to keep failed
16401 bounce messages around for a shorter time than the normal maximum retry time
16402 for frozen messages. For example,
16403 .code
16404 ignore_bounce_errors_after = 12h
16405 .endd
16406 retries failed bounce message deliveries after 12 hours, discarding any further
16407 failures. If the value of this option is set to a zero time period, bounce
16408 failures are discarded immediately. Setting a very long time (as in the default
16409 value) has the effect of disabling this option. For ways of automatically
16410 dealing with other kinds of frozen message, see &%auto_thaw%& and
16411 &%timeout_frozen_after%&.
16412
16413
16414 .options ignore_fromline_hosts main "host list&!!" unset &&&
16415          ignore_fromline_local main boolean false
16416 .cindex "&""From""& line"
16417 .cindex "UUCP" "&""From""& line"
16418 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16419 the headers of a message. By default this is treated as the start of the
16420 message's body, which means that any following headers are not recognized as
16421 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16422 match those hosts that insist on sending it. If the sender is actually a local
16423 process rather than a remote host, and is using &%-bs%& to inject the messages,
16424 &%ignore_fromline_local%& must be set to achieve this effect.
16425
16426
16427
16428 .option keep_environment main "string list" unset
16429 .cindex "environment" "values from"
16430 This option contains a string list of environment variables to keep.
16431 You have to trust these variables or you have to be sure that
16432 these variables do not impose any security risk. Keep in mind that
16433 during the startup phase Exim is running with an effective UID 0 in most
16434 installations. As the default value is an empty list, the default
16435 environment for using libraries, running embedded Perl code, or running
16436 external binaries is empty, and does not not even contain PATH or HOME.
16437
16438 Actually the list is interpreted as a list of patterns
16439 (&<<SECTlistexpand>>&), except that it is not expanded first.
16440
16441 WARNING: Macro substitution is still done first, so having a macro
16442 FOO and having FOO_HOME in your &%keep_environment%& option may have
16443 unexpected results. You may work around this using a regular expression
16444 that does not match the macro name: ^[F]OO_HOME$.
16445
16446 Current versions of Exim issue a warning during startup if you do not mention
16447 &%keep_environment%& in your runtime configuration file and if your
16448 current environment is not empty. Future versions may not issue that warning
16449 anymore.
16450
16451 See the &%add_environment%& main config option for a way to set
16452 environment variables to a fixed value.  The environment for &(pipe)&
16453 transports is handled separately, see section &<<SECTpipeenv>>& for
16454 details.
16455
16456
16457 .option keep_malformed main time 4d
16458 This option specifies the length of time to keep messages whose spool files
16459 have been corrupted in some way. This should, of course, never happen. At the
16460 next attempt to deliver such a message, it gets removed. The incident is
16461 logged.
16462
16463
16464 .option ldap_ca_cert_dir main string unset
16465 .cindex "LDAP", "TLS CA certificate directory"
16466 .cindex certificate "directory for LDAP"
16467 This option indicates which directory contains CA certificates for verifying
16468 a TLS certificate presented by an LDAP server.
16469 While Exim does not provide a default value, your SSL library may.
16470 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16471 and constrained to be a directory.
16472
16473
16474 .option ldap_ca_cert_file main string unset
16475 .cindex "LDAP", "TLS CA certificate file"
16476 .cindex certificate "file for LDAP"
16477 This option indicates which file contains CA certificates for verifying
16478 a TLS certificate presented by an LDAP server.
16479 While Exim does not provide a default value, your SSL library may.
16480 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16481 and constrained to be a file.
16482
16483
16484 .option ldap_cert_file main string unset
16485 .cindex "LDAP" "TLS client certificate file"
16486 .cindex certificate "file for LDAP"
16487 This option indicates which file contains an TLS client certificate which
16488 Exim should present to the LDAP server during TLS negotiation.
16489 Should be used together with &%ldap_cert_key%&.
16490
16491
16492 .option ldap_cert_key main string unset
16493 .cindex "LDAP" "TLS client key file"
16494 .cindex certificate "key for LDAP"
16495 This option indicates which file contains the secret/private key to use
16496 to prove identity to the LDAP server during TLS negotiation.
16497 Should be used together with &%ldap_cert_file%&, which contains the
16498 identity to be proven.
16499
16500
16501 .option ldap_cipher_suite main string unset
16502 .cindex "LDAP" "TLS cipher suite"
16503 This controls the TLS cipher-suite negotiation during TLS negotiation with
16504 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16505 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16506
16507
16508 .option ldap_default_servers main "string list" unset
16509 .cindex "LDAP" "default servers"
16510 This option provides a list of LDAP servers which are tried in turn when an
16511 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16512 details of LDAP queries. This option is available only when Exim has been built
16513 with LDAP support.
16514
16515
16516 .option ldap_require_cert main string unset.
16517 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16518 This should be one of the values "hard", "demand", "allow", "try" or "never".
16519 A value other than one of these is interpreted as "never".
16520 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16521 Although Exim does not set a default, the LDAP library probably defaults
16522 to hard/demand.
16523
16524
16525 .option ldap_start_tls main boolean false
16526 .cindex "LDAP" "whether or not to negotiate TLS"
16527 If set, Exim will attempt to negotiate TLS with the LDAP server when
16528 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16529 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16530 of SSL-on-connect.
16531 In the event of failure to negotiate TLS, the action taken is controlled
16532 by &%ldap_require_cert%&.
16533 This option is ignored for &`ldapi`& connections.
16534
16535
16536 .option ldap_version main integer unset
16537 .cindex "LDAP" "protocol version, forcing"
16538 This option can be used to force Exim to set a specific protocol version for
16539 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16540 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16541 the LDAP headers; otherwise it is 2. This option is available only when Exim
16542 has been built with LDAP support.
16543
16544
16545
16546 .option local_from_check main boolean true
16547 .cindex "&'Sender:'& header line" "disabling addition of"
16548 .cindex "&'From:'& header line" "disabling checking of"
16549 When a message is submitted locally (that is, not over a TCP/IP connection) by
16550 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16551 checks that the &'From:'& header line matches the login of the calling user and
16552 the domain specified by &%qualify_domain%&.
16553
16554 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16555 locally submitted message is automatically qualified by Exim, unless the
16556 &%-bnq%& command line option is used.
16557
16558 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16559 on the local part. If the &'From:'& header line does not match, Exim adds a
16560 &'Sender:'& header with an address constructed from the calling user's login
16561 and the default qualify domain.
16562
16563 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16564 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16565 &'Sender:'& header lines supplied by untrusted users, you must also set
16566 &%local_sender_retain%& to be true.
16567
16568 .cindex "envelope from"
16569 .cindex "envelope sender"
16570 These options affect only the header lines in the message. The envelope sender
16571 is still forced to be the login id at the qualify domain unless
16572 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16573
16574 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16575 request similar header line checking. See section &<<SECTthesenhea>>&, which
16576 has more details about &'Sender:'& processing.
16577
16578
16579
16580
16581 .options local_from_prefix main string unset &&&
16582          local_from_suffix main string unset
16583 When Exim checks the &'From:'& header line of locally submitted messages for
16584 matching the login id (see &%local_from_check%& above), it can be configured to
16585 ignore certain prefixes and suffixes in the local part of the address. This is
16586 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16587 appropriate lists, in the same form as the &%local_part_prefix%& and
16588 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16589 example, if
16590 .code
16591 local_from_prefix = *-
16592 .endd
16593 is set, a &'From:'& line containing
16594 .code
16595 From: anything-user@your.domain.example
16596 .endd
16597 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16598 matches the actual sender address that is constructed from the login name and
16599 qualify domain.
16600
16601
16602 .option local_interfaces main "string list" "see below"
16603 This option controls which network interfaces are used by the daemon for
16604 listening; they are also used to identify the local host when routing. Chapter
16605 &<<CHAPinterfaces>>& contains a full description of this option and the related
16606 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16607 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16608 &%local_interfaces%& is
16609 .code
16610 local_interfaces = 0.0.0.0
16611 .endd
16612 when Exim is built without IPv6 support; otherwise it is
16613 .code
16614 local_interfaces = <; ::0 ; 0.0.0.0
16615 .endd
16616
16617 .option local_scan_timeout main time 5m
16618 .cindex "timeout" "for &[local_scan()]& function"
16619 .cindex "&[local_scan()]& function" "timeout"
16620 This timeout applies to the &[local_scan()]& function (see chapter
16621 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16622 the incoming message is rejected with a temporary error if it is an SMTP
16623 message. For a non-SMTP message, the message is dropped and Exim ends with a
16624 non-zero code. The incident is logged on the main and reject logs.
16625
16626
16627
16628 .option local_sender_retain main boolean false
16629 .cindex "&'Sender:'& header line" "retaining from local submission"
16630 When a message is submitted locally (that is, not over a TCP/IP connection) by
16631 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16632 do not want this to happen, you must set &%local_sender_retain%&, and you must
16633 also set &%local_from_check%& to be false (Exim will complain if you do not).
16634 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16635 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16636
16637
16638
16639
16640 .option localhost_number main string&!! unset
16641 .cindex "host" "locally unique number for"
16642 .cindex "message ids" "with multiple hosts"
16643 .cindex multiple "systems sharing a spool"
16644 .cindex "multiple hosts" "sharing a spool"
16645 .cindex "shared spool directory"
16646 .cindex "spool directory" sharing
16647 .vindex "&$localhost_number$&"
16648 Exim's message ids are normally unique only within the local host. If
16649 uniqueness among a set of hosts is required
16650 (eg. because they share a spool directory),
16651 each host must set a different
16652 value for the &%localhost_number%& option. The string is expanded immediately
16653 after reading the configuration file (so that a number can be computed from the
16654 host name, for example) and the result of the expansion must be a number in the
16655 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16656 systems). This is available in subsequent string expansions via the variable
16657 &$localhost_number$&. When &%localhost_number%& is set, the final four
16658 characters of the message id, instead of just being a fractional part of the
16659 time, are computed from the time and the local host number as described in
16660 section &<<SECTmessiden>>&.
16661
16662
16663
16664 .option log_file_path main "string list&!!" "set at compile time"
16665 .cindex "log" "file path for"
16666 This option sets the path which is used to determine the names of Exim's log
16667 files, or indicates that logging is to be to syslog, or both. It is expanded
16668 when Exim is entered, so it can, for example, contain a reference to the host
16669 name. If no specific path is set for the log files at compile or runtime,
16670 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16671 they are written in a sub-directory called &_log_& in Exim's spool directory.
16672 A path must start with a slash.
16673 To send to syslog, use the word &"syslog"&.
16674 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16675 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16676 used. If this string is fixed at your installation (contains no expansion
16677 variables) it is recommended that you do not set this option in the
16678 configuration file, but instead supply the path using LOG_FILE_PATH in
16679 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16680 early on &-- in particular, failure to read the configuration file.
16681
16682
16683 .option log_selector main string unset
16684 .cindex "log" "selectors"
16685 This option can be used to reduce or increase the number of things that Exim
16686 writes to its log files. Its argument is made up of names preceded by plus or
16687 minus characters. For example:
16688 .code
16689 log_selector = +arguments -retry_defer
16690 .endd
16691 A list of possible names and what they control is given in the chapter on
16692 logging, in section &<<SECTlogselector>>&.
16693
16694
16695 .option log_timezone main boolean false
16696 .cindex "log" "timezone for entries"
16697 .vindex "&$tod_log$&"
16698 .vindex "&$tod_zone$&"
16699 By default, the timestamps on log lines are in local time without the
16700 timezone. This means that if your timezone changes twice a year, the timestamps
16701 in log lines are ambiguous for an hour when the clocks go back. One way of
16702 avoiding this problem is to set the timezone to UTC. An alternative is to set
16703 &%log_timezone%& true. This turns on the addition of the timezone offset to
16704 timestamps in log lines. Turning on this option can add quite a lot to the size
16705 of log files because each line is extended by 6 characters. Note that the
16706 &$tod_log$& variable contains the log timestamp without the zone, but there is
16707 another variable called &$tod_zone$& that contains just the timezone offset.
16708
16709
16710 .option lookup_open_max main integer 25
16711 .cindex "too many open files"
16712 .cindex "open files, too many"
16713 .cindex "file" "too many open"
16714 .cindex "lookup" "maximum open files"
16715 .cindex "limit" "open files for lookups"
16716 This option limits the number of simultaneously open files for single-key
16717 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16718 Exim normally keeps these files open during routing, because often the same
16719 file is required several times. If the limit is reached, Exim closes the least
16720 recently used file. Note that if you are using the &'ndbm'& library, it
16721 actually opens two files for each logical DBM database, though it still counts
16722 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16723 open files"& errors with NDBM, you need to reduce the value of
16724 &%lookup_open_max%&.
16725
16726
16727 .option max_username_length main integer 0
16728 .cindex "length of login name"
16729 .cindex "user name" "maximum length"
16730 .cindex "limit" "user name length"
16731 Some operating systems are broken in that they truncate long arguments to
16732 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16733 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16734 an argument that is longer behaves as if &[getpwnam()]& failed.
16735
16736
16737 .option message_body_newlines main bool false
16738 .cindex "message body" "newlines in variables"
16739 .cindex "newline" "in message body variables"
16740 .vindex "&$message_body$&"
16741 .vindex "&$message_body_end$&"
16742 By default, newlines in the message body are replaced by spaces when setting
16743 the &$message_body$& and &$message_body_end$& expansion variables. If this
16744 option is set true, this no longer happens.
16745
16746
16747 .option message_body_visible main integer 500
16748 .cindex "body of message" "visible size"
16749 .cindex "message body" "visible size"
16750 .vindex "&$message_body$&"
16751 .vindex "&$message_body_end$&"
16752 This option specifies how much of a message's body is to be included in the
16753 &$message_body$& and &$message_body_end$& expansion variables.
16754
16755
16756 .option message_id_header_domain main string&!! unset
16757 .cindex "&'Message-ID:'& header line"
16758 If this option is set, the string is expanded and used as the right hand side
16759 (domain) of the &'Message-ID:'& header that Exim creates if a
16760 locally-originated incoming message does not have one. &"Locally-originated"&
16761 means &"not received over TCP/IP."&
16762 Otherwise, the primary host name is used.
16763 Only letters, digits, dot and hyphen are accepted; any other characters are
16764 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16765 empty string, the option is ignored.
16766
16767
16768 .option message_id_header_text main string&!! unset
16769 If this variable is set, the string is expanded and used to augment the text of
16770 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16771 message does not have one. The text of this header is required by RFC 2822 to
16772 take the form of an address. By default, Exim uses its internal message id as
16773 the local part, and the primary host name as the domain. If this option is set,
16774 it is expanded, and provided the expansion is not forced to fail, and does not
16775 yield an empty string, the result is inserted into the header immediately
16776 before the @, separated from the internal message id by a dot. Any characters
16777 that are illegal in an address are automatically converted into hyphens. This
16778 means that variables such as &$tod_log$& can be used, because the spaces and
16779 colons will become hyphens.
16780
16781
16782 .option message_logs main boolean true
16783 .cindex "message logs" "disabling"
16784 .cindex "log" "message log; disabling"
16785 If this option is turned off, per-message log files are not created in the
16786 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16787 Exim, by reducing the number of files involved in handling a message from a
16788 minimum of four (header spool file, body spool file, delivery journal, and
16789 per-message log) to three. The other major I/O activity is Exim's main log,
16790 which is not affected by this option.
16791
16792
16793 .option message_size_limit main string&!! 50M
16794 .cindex "message" "size limit"
16795 .cindex "limit" "message size"
16796 .cindex "size" "of message, limit"
16797 This option limits the maximum size of message that Exim will process. The
16798 value is expanded for each incoming connection so, for example, it can be made
16799 to depend on the IP address of the remote host for messages arriving via
16800 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16801 optionally followed by K or M.
16802
16803 .cindex "SIZE" "ESMTP extension, advertising"
16804 .cindex "ESMTP extensions" SIZE
16805 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16806 service extension keyword.
16807
16808 &*Note*&: This limit cannot be made to depend on a message's sender or any
16809 other properties of an individual message, because it has to be advertised in
16810 the server's response to EHLO. String expansion failure causes a temporary
16811 error. A value of zero means no limit, but its use is not recommended. See also
16812 &%bounce_return_size_limit%&.
16813
16814 Incoming SMTP messages are failed with a 552 error if the limit is
16815 exceeded; locally-generated messages either get a stderr message or a delivery
16816 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16817 an oversized message is logged in both the main and the reject logs. See also
16818 the generic transport option &%message_size_limit%&, which limits the size of
16819 message that an individual transport can process.
16820
16821 If you use a virus-scanner and set this option to to a value larger than the
16822 maximum size that your virus-scanner is configured to support, you may get
16823 failures triggered by large mails.  The right size to configure for the
16824 virus-scanner depends upon what data is passed and the options in use but it's
16825 probably safest to just set it to a little larger than this value.  E.g., with a
16826 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16827 some problems may result.
16828
16829 A value of 0 will disable size limit checking; Exim will still advertise the
16830 SIZE extension in an EHLO response, but without a limit, so as to permit
16831 SMTP clients to still indicate the message size along with the MAIL verb.
16832
16833
16834 .option move_frozen_messages main boolean false
16835 .cindex "frozen messages" "moving"
16836 This option, which is available only if Exim has been built with the setting
16837 .code
16838 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16839 .endd
16840 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16841 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16842 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16843 standard utilities for handling such moved messages, and they do not show up in
16844 lists generated by &%-bp%& or by the Exim monitor.
16845
16846
16847 .option mua_wrapper main boolean false
16848 Setting this option true causes Exim to run in a very restrictive mode in which
16849 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16850 contains a full description of this facility.
16851
16852
16853
16854 .option mysql_servers main "string list" unset
16855 .cindex "MySQL" "server list"
16856 This option provides a list of MySQL servers and associated connection data, to
16857 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16858 option is available only if Exim has been built with MySQL support.
16859
16860
16861 .option never_users main "string list&!!" unset
16862 This option is expanded just once, at the start of Exim's processing. Local
16863 message deliveries are normally run in processes that are setuid to the
16864 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16865 It is usually desirable to prevent any deliveries from running as root, as a
16866 safety precaution.
16867
16868 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16869 list of users that must not be used for local deliveries. This list is fixed in
16870 the binary and cannot be overridden by the configuration file. By default, it
16871 contains just the single user name &"root"&. The &%never_users%& runtime option
16872 can be used to add more users to the fixed list.
16873
16874 If a message is to be delivered as one of the users on the fixed list or the
16875 &%never_users%& list, an error occurs, and delivery is deferred. A common
16876 example is
16877 .code
16878 never_users = root:daemon:bin
16879 .endd
16880 Including root is redundant if it is also on the fixed list, but it does no
16881 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16882 transport driver.
16883
16884
16885 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16886 This option gives the name for a unix-domain socket on which the daemon
16887 listens for work and information-requests.
16888 Only installations running multiple daemons sharing a spool directory
16889 should need to modify the default.
16890
16891 The option is expanded before use.
16892 If the platform supports Linux-style abstract socket names, the result
16893 is used with a nul byte prefixed.
16894 Otherwise,
16895 it should be a full path name and use a directory accessible
16896 to Exim.
16897
16898 If this option is set as empty,
16899 or the command line &%-oY%& option is used, or
16900 the command line uses a &%-oX%& option and does not use &%-oP%&,
16901 then a notifier socket is not created.
16902
16903
16904 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16905 .cindex "OpenSSL "compatibility options"
16906 This option allows an administrator to adjust the SSL options applied
16907 by OpenSSL to connections.  It is given as a space-separated list of items,
16908 each one to be +added or -subtracted from the current value.
16909
16910 This option is only available if Exim is built against OpenSSL.  The values
16911 available for this option vary according to the age of your OpenSSL install.
16912 The &"all"& value controls a subset of flags which are available, typically
16913 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16914 list the values known on your system and Exim should support all the
16915 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16916 names lose the leading &"SSL_OP_"& and are lower-cased.
16917
16918 Note that adjusting the options can have severe impact upon the security of
16919 SSL as used by Exim.  It is possible to disable safety checks and shoot
16920 yourself in the foot in various unpleasant ways.  This option should not be
16921 adjusted lightly.  An unrecognised item will be detected at startup, by
16922 invoking Exim with the &%-bV%& flag.
16923
16924 The option affects Exim operating both as a server and as a client.
16925
16926 Historical note: prior to release 4.80, Exim defaulted this value to
16927 "+dont_insert_empty_fragments", which may still be needed for compatibility
16928 with some clients, but which lowers security by increasing exposure to
16929 some now infamous attacks.
16930
16931 Examples:
16932 .code
16933 # Make both old MS and old Eudora happy:
16934 openssl_options = -all +microsoft_big_sslv3_buffer \
16935                        +dont_insert_empty_fragments
16936
16937 # Disable older protocol versions:
16938 openssl_options = +no_sslv2 +no_sslv3
16939 .endd
16940
16941 Possible options may include:
16942 .ilist
16943 &`all`&
16944 .next
16945 &`allow_unsafe_legacy_renegotiation`&
16946 .next
16947 &`cipher_server_preference`&
16948 .next
16949 &`dont_insert_empty_fragments`&
16950 .next
16951 &`ephemeral_rsa`&
16952 .next
16953 &`legacy_server_connect`&
16954 .next
16955 &`microsoft_big_sslv3_buffer`&
16956 .next
16957 &`microsoft_sess_id_bug`&
16958 .next
16959 &`msie_sslv2_rsa_padding`&
16960 .next
16961 &`netscape_challenge_bug`&
16962 .next
16963 &`netscape_reuse_cipher_change_bug`&
16964 .next
16965 &`no_compression`&
16966 .next
16967 &`no_session_resumption_on_renegotiation`&
16968 .next
16969 &`no_sslv2`&
16970 .next
16971 &`no_sslv3`&
16972 .next
16973 &`no_ticket`&
16974 .next
16975 &`no_tlsv1`&
16976 .next
16977 &`no_tlsv1_1`&
16978 .next
16979 &`no_tlsv1_2`&
16980 .next
16981 &`safari_ecdhe_ecdsa_bug`&
16982 .next
16983 &`single_dh_use`&
16984 .next
16985 &`single_ecdh_use`&
16986 .next
16987 &`ssleay_080_client_dh_bug`&
16988 .next
16989 &`sslref2_reuse_cert_type_bug`&
16990 .next
16991 &`tls_block_padding_bug`&
16992 .next
16993 &`tls_d5_bug`&
16994 .next
16995 &`tls_rollback_bug`&
16996 .endlist
16997
16998 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16999 all clients connecting using the MacOS SecureTransport TLS facility prior
17000 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
17001 to negotiate TLS then this option value might help, provided that your OpenSSL
17002 release is new enough to contain this work-around.  This may be a situation
17003 where you have to upgrade OpenSSL to get buggy clients working.
17004
17005
17006 .option oracle_servers main "string list" unset
17007 .cindex "Oracle" "server list"
17008 This option provides a list of Oracle servers and associated connection data,
17009 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
17010 The option is available only if Exim has been built with Oracle support.
17011
17012
17013 .option panic_coredump main boolean false
17014 This option is rarely needed but can help for some debugging investigations.
17015 If set, when an internal error is detected by Exim which is sufficient
17016 to terminate the process
17017 (all such are logged in the paniclog)
17018 then a coredump is requested.
17019
17020 Note that most systems require additional administrative configuration
17021 to permit write a core file for a setuid program, which is Exim's
17022 common installed configuration.
17023
17024 .option percent_hack_domains main "domain list&!!" unset
17025 .cindex "&""percent hack""&"
17026 .cindex "source routing" "in email address"
17027 .cindex "address" "source-routed"
17028 The &"percent hack"& is the convention whereby a local part containing a
17029 percent sign is re-interpreted as a new email address, with the percent
17030 replaced by @. This is sometimes called &"source routing"&, though that term is
17031 also applied to RFC 2822 addresses that begin with an @ character. If this
17032 option is set, Exim implements the percent facility for those domains listed,
17033 but no others. This happens before an incoming SMTP address is tested against
17034 an ACL.
17035
17036 &*Warning*&: The &"percent hack"& has often been abused by people who are
17037 trying to get round relaying restrictions. For this reason, it is best avoided
17038 if at all possible. Unfortunately, a number of less security-conscious MTAs
17039 implement it unconditionally. If you are running Exim on a gateway host, and
17040 routing mail through to internal MTAs without processing the local parts, it is
17041 a good idea to reject recipient addresses with percent characters in their
17042 local parts. Exim's default configuration does this.
17043
17044
17045 .options perl_at_start main boolean false &&&
17046          perl_startup main string unset
17047 .cindex "Perl"
17048 These options are available only when Exim is built with an embedded Perl
17049 interpreter. See chapter &<<CHAPperl>>& for details of their use.
17050
17051 .option perl_taintmode main boolean false
17052 .cindex "Perl"
17053 This option enables the taint mode of the embedded Perl interpreter.
17054
17055
17056 .option pgsql_servers main "string list" unset
17057 .cindex "PostgreSQL lookup type" "server list"
17058 This option provides a list of PostgreSQL servers and associated connection
17059 data, to be used in conjunction with &(pgsql)& lookups (see section
17060 &<<SECID72>>&). The option is available only if Exim has been built with
17061 PostgreSQL support.
17062
17063
17064 .option pid_file_path main string&!! "set at compile time"
17065 .cindex "daemon" "pid file path"
17066 .cindex "pid file, path for"
17067 This option sets the name of the file to which the Exim daemon writes its
17068 process id. The string is expanded, so it can contain, for example, references
17069 to the host name:
17070 .code
17071 pid_file_path = /var/log/$primary_hostname/exim.pid
17072 .endd
17073 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17074 spool directory.
17075 The value set by the option can be overridden by the &%-oP%& command line
17076 option. A pid file is not written if a &"non-standard"& daemon is run by means
17077 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17078
17079
17080 .option pipelining_advertise_hosts main "host list&!!" *
17081 .cindex "PIPELINING" "suppressing advertising"
17082 .cindex "ESMTP extensions" PIPELINING
17083 This option can be used to suppress the advertisement of the SMTP
17084 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17085 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17086 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17087 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17088 that clients will use it; &"out of order"& commands that are &"expected"& do
17089 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17090
17091 .option pipelining_connect_advertise_hosts main "host list&!!" *
17092 .cindex "pipelining" "early connection"
17093 .cindex "pipelining" PIPECONNECT
17094 .cindex "ESMTP extensions" PIPECONNECT
17095 If Exim is built without the DISABLE_PIPE_CONNECT build option
17096 this option controls which hosts the facility is advertised to
17097 and from which pipeline early-connection (before MAIL) SMTP
17098 commands are acceptable.
17099 When used, the pipelining saves on roundtrip times.
17100
17101 See also the &%hosts_pipe_connect%& smtp transport option.
17102
17103 The SMTP service extension keyword advertised is &"PIPECONNECT"&;
17104 it permits the client to pipeline
17105 TCP connection and hello command (inclear phase),
17106 or TLS-establishment and hello command (encrypted phase),
17107 on later connections to the same host.
17108
17109
17110 .option prdr_enable main boolean false
17111 .cindex "PRDR" "enabling on server"
17112 .cindex "ESMTP extensions" PRDR
17113 This option can be used to enable the Per-Recipient Data Response extension
17114 to SMTP, defined by Eric Hall.
17115 If the option is set, PRDR is advertised by Exim when operating as a server.
17116 If the client requests PRDR, and more than one recipient, for a message
17117 an additional ACL is called for each recipient after the message content
17118 is received.  See section &<<SECTPRDRACL>>&.
17119
17120 .option preserve_message_logs main boolean false
17121 .cindex "message logs" "preserving"
17122 If this option is set, message log files are not deleted when messages are
17123 completed. Instead, they are moved to a sub-directory of the spool directory
17124 called &_msglog.OLD_&, where they remain available for statistical or debugging
17125 purposes. This is a dangerous option to set on systems with any appreciable
17126 volume of mail. Use with care!
17127
17128
17129 .option primary_hostname main string "see below"
17130 .cindex "name" "of local host"
17131 .cindex "host" "name of local"
17132 .cindex "local host" "name of"
17133 .vindex "&$primary_hostname$&"
17134 This specifies the name of the current host. It is used in the default EHLO or
17135 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17136 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17137 The value is also used by default in some SMTP response messages from an Exim
17138 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17139
17140 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17141 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17142 contains only one component, Exim passes it to &[gethostbyname()]& (or
17143 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17144 version. The variable &$primary_hostname$& contains the host name, whether set
17145 explicitly by this option, or defaulted.
17146
17147
17148 .option print_topbitchars main boolean false
17149 .cindex "printing characters"
17150 .cindex "8-bit characters"
17151 By default, Exim considers only those characters whose codes lie in the range
17152 32&--126 to be printing characters. In a number of circumstances (for example,
17153 when writing log entries) non-printing characters are converted into escape
17154 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17155 is set, code values of 128 and above are also considered to be printing
17156 characters.
17157
17158 This option also affects the header syntax checks performed by the
17159 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17160 the user's full name when constructing From: and Sender: addresses (as
17161 described in section &<<SECTconstr>>&). Setting this option can cause
17162 Exim to generate eight bit message headers that do not conform to the
17163 standards.
17164
17165
17166 .option process_log_path main string unset
17167 .cindex "process log path"
17168 .cindex "log" "process log"
17169 .cindex "&'exiwhat'&"
17170 This option sets the name of the file to which an Exim process writes its
17171 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17172 utility script. If this option is unset, the file called &_exim-process.info_&
17173 in Exim's spool directory is used. The ability to specify the name explicitly
17174 can be useful in environments where two different Exims are running, using
17175 different spool directories.
17176
17177
17178 .option prod_requires_admin main boolean true
17179 .cindex "restricting access to features"
17180 .oindex "&%-M%&"
17181 .oindex "&%-R%&"
17182 .oindex "&%-q%&"
17183 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17184 admin user unless &%prod_requires_admin%& is set false. See also
17185 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17186
17187
17188 .option proxy_protocol_timeout main time 3s
17189 .cindex proxy "proxy protocol"
17190 This option sets the timeout for proxy protocol negotiation.
17191 For details see section &<<SECTproxyInbound>>&.
17192
17193
17194 .option qualify_domain main string "see below"
17195 .cindex "domain" "for qualifying addresses"
17196 .cindex "address" "qualification"
17197 This option specifies the domain name that is added to any envelope sender
17198 addresses that do not have a domain qualification. It also applies to
17199 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17200 are accepted by default only for locally-generated messages. Qualification is
17201 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17202 locally-generated messages, unless the &%-bnq%& command line option is used.
17203
17204 Messages from external sources must always contain fully qualified addresses,
17205 unless the sending host matches &%sender_unqualified_hosts%& or
17206 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17207 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17208 necessary. Internally, Exim always works with fully qualified envelope
17209 addresses. If &%qualify_domain%& is not set, it defaults to the
17210 &%primary_hostname%& value.
17211
17212
17213 .option qualify_recipient main string "see below"
17214 This option allows you to specify a different domain for qualifying recipient
17215 addresses to the one that is used for senders. See &%qualify_domain%& above.
17216
17217
17218
17219 .option queue_domains main "domain list&!!" unset
17220 .cindex "domain" "specifying non-immediate delivery"
17221 .cindex "queueing incoming messages"
17222 .cindex "message" "queueing certain domains"
17223 This option lists domains for which immediate delivery is not required.
17224 A delivery process is started whenever a message is received, but only those
17225 domains that do not match are processed. All other deliveries wait until the
17226 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17227
17228
17229 .option queue_fast_ramp main boolean true
17230 .cindex "queue runner" "two phase"
17231 .cindex "queue" "double scanning"
17232 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17233 command line, may start parallel delivery processes during their first
17234 phase.  This will be done when a threshold number of messages have been
17235 routed for a single host.
17236
17237
17238 .option queue_list_requires_admin main boolean true
17239 .cindex "restricting access to features"
17240 .oindex "&%-bp%&"
17241 The &%-bp%& command-line option, which lists the messages that are on the
17242 queue, requires the caller to be an admin user unless
17243 &%queue_list_requires_admin%& is set false.
17244 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17245
17246
17247 .option queue_only main boolean false
17248 .cindex "queueing incoming messages"
17249 .cindex "message" "queueing unconditionally"
17250 If &%queue_only%& is set, a delivery process is not automatically started
17251 whenever a message is received. Instead, the message waits in the queue for the
17252 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17253 delivered immediately when certain conditions (such as heavy load) occur.
17254
17255 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17256 and &%-odi%& command line options override &%queue_only%& unless
17257 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17258 &%queue_only_load%&, and &%smtp_accept_queue%&.
17259
17260
17261 .option queue_only_file main "string list" unset
17262 .cindex "queueing incoming messages"
17263 .cindex "message" "queueing by file existence"
17264 This option can be set to a colon-separated list of absolute path names, each
17265 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17266 it tests for the existence of each listed path using a call to &[stat()]&. For
17267 each path that exists, the corresponding queueing option is set.
17268 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17269 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17270 .code
17271 queue_only_file = smtp/some/file
17272 .endd
17273 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17274 &_/some/file_& exists.
17275
17276
17277 .option queue_only_load main fixed-point unset
17278 .cindex "load average"
17279 .cindex "queueing incoming messages"
17280 .cindex "message" "queueing by load"
17281 If the system load average is higher than this value, incoming messages from
17282 all sources are queued, and no automatic deliveries are started. If this
17283 happens during local or remote SMTP input, all subsequent messages received on
17284 the same SMTP connection are queued by default, whatever happens to the load in
17285 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17286 false.
17287
17288 Deliveries will subsequently be performed by queue runner processes. This
17289 option has no effect on ancient operating systems on which Exim cannot
17290 determine the load average. See also &%deliver_queue_load_max%& and
17291 &%smtp_load_reserve%&.
17292
17293
17294 .option queue_only_load_latch main boolean true
17295 .cindex "load average" "re-evaluating per message"
17296 When this option is true (the default), once one message has been queued
17297 because the load average is higher than the value set by &%queue_only_load%&,
17298 all subsequent messages received on the same SMTP connection are also queued.
17299 This is a deliberate choice; even though the load average may fall below the
17300 threshold, it doesn't seem right to deliver later messages on the same
17301 connection when not delivering earlier ones. However, there are special
17302 circumstances such as very long-lived connections from scanning appliances
17303 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17304 should be set false. This causes the value of the load average to be
17305 re-evaluated for each message.
17306
17307
17308 .option queue_only_override main boolean true
17309 .cindex "queueing incoming messages"
17310 When this option is true, the &%-od%&&'x'& command line options override the
17311 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17312 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17313 to override; they are accepted, but ignored.
17314
17315
17316 .option queue_run_in_order main boolean false
17317 .cindex "queue runner" "processing messages in order"
17318 If this option is set, queue runs happen in order of message arrival instead of
17319 in an arbitrary order. For this to happen, a complete list of the entire queue
17320 must be set up before the deliveries start. When the queue is all held in a
17321 single directory (the default), a single list is created for both the ordered
17322 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17323 single list is not created when &%queue_run_in_order%& is false. In this case,
17324 the sub-directories are processed one at a time (in a random order), and this
17325 avoids setting up one huge list for the whole queue. Thus, setting
17326 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17327 when the queue is large, because of the extra work in setting up the single,
17328 large list. In most situations, &%queue_run_in_order%& should not be set.
17329
17330
17331
17332 .option queue_run_max main integer&!! 5
17333 .cindex "queue runner" "maximum number of"
17334 This controls the maximum number of queue runner processes that an Exim daemon
17335 can run simultaneously. This does not mean that it starts them all at once,
17336 but rather that if the maximum number are still running when the time comes to
17337 start another one, it refrains from starting another one. This can happen with
17338 very large queues and/or very sluggish deliveries. This option does not,
17339 however, interlock with other processes, so additional queue runners can be
17340 started by other means, or by killing and restarting the daemon.
17341
17342 Setting this option to zero does not suppress queue runs; rather, it disables
17343 the limit, allowing any number of simultaneous queue runner processes to be
17344 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17345 the daemon's command line.
17346
17347 .cindex queues named
17348 .cindex "named queues" "resource limit"
17349 To set limits for different named queues use
17350 an expansion depending on the &$queue_name$& variable.
17351
17352 .option queue_smtp_domains main "domain list&!!" unset
17353 .cindex "queueing incoming messages"
17354 .cindex "message" "queueing remote deliveries"
17355 .cindex "first pass routing"
17356 When this option is set, a delivery process is started whenever a message is
17357 received, routing is performed, and local deliveries take place.
17358 However, if any SMTP deliveries are required for domains that match
17359 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17360 message waits in the queue for the next queue run. Since routing of the message
17361 has taken place, Exim knows to which remote hosts it must be delivered, and so
17362 when the queue run happens, multiple messages for the same host are delivered
17363 over a single SMTP connection. The &%-odqs%& command line option causes all
17364 SMTP deliveries to be queued in this way, and is equivalent to setting
17365 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17366 &%queue_domains%&.
17367
17368
17369 .option receive_timeout main time 0s
17370 .cindex "timeout" "for non-SMTP input"
17371 This option sets the timeout for accepting a non-SMTP message, that is, the
17372 maximum time that Exim waits when reading a message on the standard input. If
17373 the value is zero, it will wait forever. This setting is overridden by the
17374 &%-or%& command line option. The timeout for incoming SMTP messages is
17375 controlled by &%smtp_receive_timeout%&.
17376
17377 .option received_header_text main string&!! "see below"
17378 .cindex "customizing" "&'Received:'& header"
17379 .cindex "&'Received:'& header line" "customizing"
17380 This string defines the contents of the &'Received:'& message header that is
17381 added to each message, except for the timestamp, which is automatically added
17382 on at the end (preceded by a semicolon). The string is expanded each time it is
17383 used. If the expansion yields an empty string, no &'Received:'& header line is
17384 added to the message. Otherwise, the string should start with the text
17385 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17386 header lines.
17387 The default setting is:
17388
17389 .code
17390 received_header_text = Received: \
17391   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17392     {${if def:sender_ident \
17393       {from ${quote_local_part:$sender_ident} }}\
17394         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17395   by $primary_hostname \
17396   ${if def:received_protocol {with $received_protocol }}\
17397   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17398   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17399   (Exim $version_number)\n\t\
17400   ${if def:sender_address \
17401   {(envelope-from <$sender_address>)\n\t}}\
17402   id $message_exim_id\
17403   ${if def:received_for {\n\tfor $received_for}}
17404 .endd
17405
17406 The references to the TLS version and cipher are
17407 omitted when Exim is built without TLS
17408 support. The use of conditional expansions ensures that this works for both
17409 locally generated messages and messages received from remote hosts, giving
17410 header lines such as the following:
17411 .code
17412 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17413 by marley.carol.example with esmtp (Exim 4.00)
17414 (envelope-from <bob@carol.example>)
17415 id 16IOWa-00019l-00
17416 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17417 Received: by scrooge.carol.example with local (Exim 4.00)
17418 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17419 .endd
17420 Until the body of the message has been received, the timestamp is the time when
17421 the message started to be received. Once the body has arrived, and all policy
17422 checks have taken place, the timestamp is updated to the time at which the
17423 message was accepted.
17424
17425
17426 .option received_headers_max main integer 30
17427 .cindex "loop" "prevention"
17428 .cindex "mail loop prevention"
17429 .cindex "&'Received:'& header line" "counting"
17430 When a message is to be delivered, the number of &'Received:'& headers is
17431 counted, and if it is greater than this parameter, a mail loop is assumed to
17432 have occurred, the delivery is abandoned, and an error message is generated.
17433 This applies to both local and remote deliveries.
17434
17435
17436 .option recipient_unqualified_hosts main "host list&!!" unset
17437 .cindex "unqualified addresses"
17438 .cindex "host" "unqualified addresses from"
17439 This option lists those hosts from which Exim is prepared to accept unqualified
17440 recipient addresses in message envelopes. The addresses are made fully
17441 qualified by the addition of the &%qualify_recipient%& value. This option also
17442 affects message header lines. Exim does not reject unqualified recipient
17443 addresses in headers, but it qualifies them only if the message came from a
17444 host that matches &%recipient_unqualified_hosts%&,
17445 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17446 option was not set.
17447
17448
17449 .option recipients_max main integer 50000
17450 .cindex "limit" "number of recipients"
17451 .cindex "recipient" "maximum number"
17452 If this option is set greater than zero, it specifies the maximum number of
17453 original recipients for any message. Additional recipients that are generated
17454 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17455 all recipients over the limit; earlier recipients are delivered as normal.
17456 Non-SMTP messages with too many recipients are failed, and no deliveries are
17457 done.
17458
17459 .cindex "RCPT" "maximum number of incoming"
17460 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17461 RCPT commands in a single message.
17462
17463
17464 .option recipients_max_reject main boolean false
17465 If this option is set true, Exim rejects SMTP messages containing too many
17466 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17467 error to the eventual DATA command. Otherwise (the default) it gives a 452
17468 error to the surplus RCPT commands and accepts the message on behalf of the
17469 initial set of recipients. The remote server should then re-send the message
17470 for the remaining recipients at a later time.
17471
17472
17473 .option remote_max_parallel main integer 4
17474 .cindex "delivery" "parallelism for remote"
17475 This option controls parallel delivery of one message to a number of remote
17476 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17477 does all the remote deliveries for a message one by one. Otherwise, if a single
17478 message has to be delivered to more than one remote host, or if several copies
17479 have to be sent to the same remote host, up to &%remote_max_parallel%&
17480 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17481 deliveries are required, the maximum number of processes are started, and as
17482 each one finishes, another is begun. The order of starting processes is the
17483 same as if sequential delivery were being done, and can be controlled by the
17484 &%remote_sort_domains%& option. If parallel delivery takes place while running
17485 with debugging turned on, the debugging output from each delivery process is
17486 tagged with its process id.
17487
17488 This option controls only the maximum number of parallel deliveries for one
17489 message in one Exim delivery process. Because Exim has no central queue
17490 manager, there is no way of controlling the total number of simultaneous
17491 deliveries if the configuration allows a delivery attempt as soon as a message
17492 is received.
17493
17494 See also the &%max_parallel%& generic transport option,
17495 and the &%serialize_hosts%& smtp transport option.
17496
17497 .cindex "number of deliveries"
17498 .cindex "delivery" "maximum number of"
17499 If you want to control the total number of deliveries on the system, you
17500 need to set the &%queue_only%& option. This ensures that all incoming messages
17501 are added to the queue without starting a delivery process. Then set up an Exim
17502 daemon to start queue runner processes at appropriate intervals (probably
17503 fairly often, for example, every minute), and limit the total number of queue
17504 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17505 delivers only one message at a time, the maximum number of deliveries that can
17506 then take place at once is &%queue_run_max%& multiplied by
17507 &%remote_max_parallel%&.
17508
17509 If it is purely remote deliveries you want to control, use
17510 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17511 doing the SMTP routing before queueing, so that several messages for the same
17512 host will eventually get delivered down the same connection.
17513
17514
17515 .option remote_sort_domains main "domain list&!!" unset
17516 .cindex "sorting remote deliveries"
17517 .cindex "delivery" "sorting remote"
17518 When there are a number of remote deliveries for a message, they are sorted by
17519 domain into the order given by this list. For example,
17520 .code
17521 remote_sort_domains = *.cam.ac.uk:*.uk
17522 .endd
17523 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17524 then to those in the &%uk%& domain, then to any others.
17525
17526
17527 .option retry_data_expire main time 7d
17528 .cindex "hints database" "data expiry"
17529 This option sets a &"use before"& time on retry information in Exim's hints
17530 database. Any older retry data is ignored. This means that, for example, once a
17531 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17532 past failures.
17533
17534
17535 .option retry_interval_max main time 24h
17536 .cindex "retry" "limit on interval"
17537 .cindex "limit" "on retry interval"
17538 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17539 intervals between delivery attempts for messages that cannot be delivered
17540 straight away. This option sets an overall limit to the length of time between
17541 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17542 the default value.
17543
17544
17545 .option return_path_remove main boolean true
17546 .cindex "&'Return-path:'& header line" "removing"
17547 RFC 2821, section 4.4, states that an SMTP server must insert a
17548 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17549 The &'Return-path:'& header preserves the sender address as received in the
17550 MAIL command. This description implies that this header should not be present
17551 in an incoming message. If &%return_path_remove%& is true, any existing
17552 &'Return-path:'& headers are removed from messages at the time they are
17553 received. Exim's transports have options for adding &'Return-path:'& headers at
17554 the time of delivery. They are normally used only for final local deliveries.
17555
17556
17557 .option return_size_limit main integer 100K
17558 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17559
17560
17561 .option rfc1413_hosts main "host list&!!" @[]
17562 .cindex "RFC 1413"
17563 .cindex "host" "for RFC 1413 calls"
17564 RFC 1413 identification calls are made to any client host which matches
17565 an item in the list.
17566 The default value specifies just this host, being any local interface
17567 for the system.
17568
17569 .option rfc1413_query_timeout main time 0s
17570 .cindex "RFC 1413" "query timeout"
17571 .cindex "timeout" "for RFC 1413 call"
17572 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17573 no RFC 1413 calls are ever made.
17574
17575
17576 .option sender_unqualified_hosts main "host list&!!" unset
17577 .cindex "unqualified addresses"
17578 .cindex "host" "unqualified addresses from"
17579 This option lists those hosts from which Exim is prepared to accept unqualified
17580 sender addresses. The addresses are made fully qualified by the addition of
17581 &%qualify_domain%&. This option also affects message header lines. Exim does
17582 not reject unqualified addresses in headers that contain sender addresses, but
17583 it qualifies them only if the message came from a host that matches
17584 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17585 using TCP/IP), and the &%-bnq%& option was not set.
17586
17587
17588 .option slow_lookup_log main integer 0
17589 .cindex "logging" "slow lookups"
17590 .cindex "dns" "logging slow lookups"
17591 This option controls logging of slow lookups.
17592 If the value is nonzero it is taken as a number of milliseconds
17593 and lookups taking longer than this are logged.
17594 Currently this applies only to DNS lookups.
17595
17596
17597
17598 .option smtp_accept_keepalive main boolean true
17599 .cindex "keepalive" "on incoming connection"
17600 This option controls the setting of the SO_KEEPALIVE option on incoming
17601 TCP/IP socket connections. When set, it causes the kernel to probe idle
17602 connections periodically, by sending packets with &"old"& sequence numbers. The
17603 other end of the connection should send an acknowledgment if the connection is
17604 still okay or a reset if the connection has been aborted. The reason for doing
17605 this is that it has the beneficial effect of freeing up certain types of
17606 connection that can get stuck when the remote host is disconnected without
17607 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17608 hours to detect unreachable hosts.
17609
17610
17611
17612 .option smtp_accept_max main integer 20
17613 .cindex "limit" "incoming SMTP connections"
17614 .cindex "SMTP" "incoming connection count"
17615 .cindex "inetd"
17616 This option specifies the maximum number of simultaneous incoming SMTP calls
17617 that Exim will accept. It applies only to the listening daemon; there is no
17618 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17619 value is set to zero, no limit is applied. However, it is required to be
17620 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17621 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17622
17623 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17624 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17625 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17626 and &%smtp_load_reserve%& are then checked before accepting the connection.
17627
17628
17629 .option smtp_accept_max_nonmail main integer 10
17630 .cindex "limit" "non-mail SMTP commands"
17631 .cindex "SMTP" "limiting non-mail commands"
17632 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17633 the connection if there are too many. This option defines &"too many"&. The
17634 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17635 client looping sending EHLO, for example. The check is applied only if the
17636 client host matches &%smtp_accept_max_nonmail_hosts%&.
17637
17638 When a new message is expected, one occurrence of RSET is not counted. This
17639 allows a client to send one RSET between messages (this is not necessary,
17640 but some clients do it). Exim also allows one uncounted occurrence of HELO
17641 or EHLO, and one occurrence of STARTTLS between messages. After
17642 starting up a TLS session, another EHLO is expected, and so it too is not
17643 counted. The first occurrence of AUTH in a connection, or immediately
17644 following STARTTLS is not counted. Otherwise, all commands other than
17645 MAIL, RCPT, DATA, and QUIT are counted.
17646
17647
17648 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17649 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17650 check by setting this option. The default value makes it apply to all hosts. By
17651 changing the value, you can exclude any badly-behaved hosts that you have to
17652 live with.
17653
17654
17655 . Allow this long option name to split; give it unsplit as a fifth argument
17656 . for the automatic .oindex that is generated by .option.
17657 . We insert " &~&~" which is both pretty nasty visually and results in
17658 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17659 . zero-width-space, which would be nicer visually and results in (at least)
17660 . html that Firefox will split on when it's forced to reflow (rather than
17661 . inserting a horizontal scrollbar).  However, the text is still not
17662 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17663 . the option name to split.
17664
17665 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17666          smtp_accept_max_per_connection
17667 .cindex "SMTP" "limiting incoming message count"
17668 .cindex "limit" "messages per SMTP connection"
17669 The value of this option limits the number of MAIL commands that Exim is
17670 prepared to accept over a single SMTP connection, whether or not each command
17671 results in the transfer of a message. After the limit is reached, a 421
17672 response is given to subsequent MAIL commands. This limit is a safety
17673 precaution against a client that goes mad (incidents of this type have been
17674 seen).
17675 The option is expanded after the HELO or EHLO is received
17676 and may depend on values available at that time.
17677 An empty or zero value after expansion removes the limit.
17678
17679
17680 .option smtp_accept_max_per_host main string&!! unset
17681 .cindex "limit" "SMTP connections from one host"
17682 .cindex "host" "limiting SMTP connections from"
17683 This option restricts the number of simultaneous IP connections from a single
17684 host (strictly, from a single IP address) to the Exim daemon. The option is
17685 expanded, to enable different limits to be applied to different hosts by
17686 reference to &$sender_host_address$&. Once the limit is reached, additional
17687 connection attempts from the same host are rejected with error code 421. This
17688 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17689 of zero imposes no limit. If this option is set greater than zero, it is
17690 required that &%smtp_accept_max%& be non-zero.
17691
17692 &*Warning*&: When setting this option you should not use any expansion
17693 constructions that take an appreciable amount of time. The expansion and test
17694 happen in the main daemon loop, in order to reject additional connections
17695 without forking additional processes (otherwise a denial-of-service attack
17696 could cause a vast number or processes to be created). While the daemon is
17697 doing this processing, it cannot accept any other incoming connections.
17698
17699
17700
17701 .option smtp_accept_queue main integer 0
17702 .cindex "SMTP" "incoming connection count"
17703 .cindex "queueing incoming messages"
17704 .cindex "message" "queueing by SMTP connection count"
17705 If the number of simultaneous incoming SMTP connections being handled via the
17706 listening daemon exceeds this value, messages received by SMTP are just placed
17707 in the queue; no delivery processes are started automatically. The count is
17708 fixed at the start of an SMTP connection. It cannot be updated in the
17709 subprocess that receives messages, and so the queueing or not queueing applies
17710 to all messages received in the same connection.
17711
17712 A value of zero implies no limit, and clearly any non-zero value is useful only
17713 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17714 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17715 various &%-od%&&'x'& command line options.
17716
17717
17718 . See the comment on smtp_accept_max_per_connection
17719
17720 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17721          smtp_accept_queue_per_connection
17722 .cindex "queueing incoming messages"
17723 .cindex "message" "queueing by message count"
17724 This option limits the number of delivery processes that Exim starts
17725 automatically when receiving messages via SMTP, whether via the daemon or by
17726 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17727 and the number of messages received in a single SMTP session exceeds this
17728 number, subsequent messages are placed in the queue, but no delivery processes
17729 are started. This helps to limit the number of Exim processes when a server
17730 restarts after downtime and there is a lot of mail waiting for it on other
17731 systems. On large systems, the default should probably be increased, and on
17732 dial-in client systems it should probably be set to zero (that is, disabled).
17733
17734
17735 .option smtp_accept_reserve main integer 0
17736 .cindex "SMTP" "incoming call count"
17737 .cindex "host" "reserved"
17738 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17739 number of SMTP connections that are reserved for connections from the hosts
17740 that are specified in &%smtp_reserve_hosts%&. The value set in
17741 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17742 restricted to this number of connections; the option specifies a minimum number
17743 of connection slots for them, not a maximum. It is a guarantee that this group
17744 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17745 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17746 individual host.
17747
17748 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17749 set to 5, once there are 45 active connections (from any hosts), new
17750 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17751 provided the other criteria for acceptance are met.
17752
17753
17754 .option smtp_active_hostname main string&!! unset
17755 .cindex "host" "name in SMTP responses"
17756 .cindex "SMTP" "host name in responses"
17757 .vindex "&$primary_hostname$&"
17758 This option is provided for multi-homed servers that want to masquerade as
17759 several different hosts. At the start of an incoming SMTP connection, its value
17760 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17761 responses. For example, it is used as domain name in the response to an
17762 incoming HELO or EHLO command.
17763
17764 .vindex "&$smtp_active_hostname$&"
17765 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17766 is saved with any messages that are received. It is therefore available for use
17767 in routers and transports when the message is later delivered.
17768
17769 If this option is unset, or if its expansion is forced to fail, or if the
17770 expansion results in an empty string, the value of &$primary_hostname$& is
17771 used. Other expansion failures cause a message to be written to the main and
17772 panic logs, and the SMTP command receives a temporary error. Typically, the
17773 value of &%smtp_active_hostname%& depends on the incoming interface address.
17774 For example:
17775 .code
17776 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17777   {cox.mydomain}{box.mydomain}}
17778 .endd
17779
17780 Although &$smtp_active_hostname$& is primarily concerned with incoming
17781 messages, it is also used as the default for HELO commands in callout
17782 verification if there is no remote transport from which to obtain a
17783 &%helo_data%& value.
17784
17785 .option smtp_backlog_monitor main integer 0
17786 .cindex "connection backlog" monitoring
17787 If this option is set to greater than zero, and the backlog of available
17788 TCP connections on a socket listening for SMTP is larger than it, a line
17789 is logged giving the value and the socket address and port.
17790 The value is retrived jsut before an accept call.
17791 This facility is only available on Linux.
17792
17793 .option smtp_banner main string&!! "see below"
17794 .cindex "SMTP" "welcome banner"
17795 .cindex "banner for SMTP"
17796 .cindex "welcome banner for SMTP"
17797 .cindex "customizing" "SMTP banner"
17798 If a connect ACL does not supply a message,
17799 this string (which is expanded every time it is used) is output as the initial
17800 positive response to an SMTP connection. The default setting is:
17801 .code
17802 smtp_banner = $smtp_active_hostname ESMTP Exim \
17803   $version_number $tod_full
17804 .endd
17805 Failure to expand the string causes a panic error;
17806 a forced fail just closes the connection.
17807 If you want to create a
17808 multiline response to the initial SMTP connection, use &"\n"& in the string at
17809 appropriate points, but not at the end. Note that the 220 code is not included
17810 in this string. Exim adds it automatically (several times in the case of a
17811 multiline response).
17812
17813
17814 .option smtp_check_spool_space main boolean true
17815 .cindex "checking disk space"
17816 .cindex "disk space, checking"
17817 .cindex "spool directory" "checking space"
17818 When this option is set, if an incoming SMTP session encounters the SIZE
17819 option on a MAIL command, it checks that there is enough space in the
17820 spool directory's partition to accept a message of that size, while still
17821 leaving free the amount specified by &%check_spool_space%& (even if that value
17822 is zero). If there isn't enough space, a temporary error code is returned.
17823
17824
17825 .option smtp_connect_backlog main integer 20
17826 .cindex "connection backlog" "set maximum"
17827 .cindex "SMTP" "connection backlog"
17828 .cindex "backlog of connections"
17829 This option specifies a maximum number of waiting SMTP connections. Exim passes
17830 this value to the TCP/IP system when it sets up its listener. Once this number
17831 of connections are waiting for the daemon's attention, subsequent connection
17832 attempts are refused at the TCP/IP level. At least, that is what the manuals
17833 say; in some circumstances such connection attempts have been observed to time
17834 out instead. For large systems it is probably a good idea to increase the
17835 value (to 50, say). It also gives some protection against denial-of-service
17836 attacks by SYN flooding.
17837
17838
17839 .option smtp_enforce_sync main boolean true
17840 .cindex "SMTP" "synchronization checking"
17841 .cindex "synchronization checking in SMTP"
17842 The SMTP protocol specification requires the client to wait for a response from
17843 the server at certain points in the dialogue. Without PIPELINING these
17844 synchronization points are after every command; with PIPELINING they are
17845 fewer, but they still exist.
17846
17847 Some spamming sites send out a complete set of SMTP commands without waiting
17848 for any response. Exim protects against this by rejecting a message if the
17849 client has sent further input when it should not have. The error response &"554
17850 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17851 for this error cannot be perfect because of transmission delays (unexpected
17852 input may be on its way but not yet received when Exim checks). However, it
17853 does detect many instances.
17854
17855 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17856 If you want to disable the check selectively (for example, only for certain
17857 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17858 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17859
17860
17861
17862 .option smtp_etrn_command main string&!! unset
17863 .cindex "ETRN" "command to be run"
17864 .cindex "ESMTP extensions" ETRN
17865 .vindex "&$domain$&"
17866 If this option is set, the given command is run whenever an SMTP ETRN
17867 command is received from a host that is permitted to issue such commands (see
17868 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17869 are independently expanded. The expansion variable &$domain$& is set to the
17870 argument of the ETRN command, and no syntax checking is done on it. For
17871 example:
17872 .code
17873 smtp_etrn_command = /etc/etrn_command $domain \
17874                     $sender_host_address
17875 .endd
17876 If the option is not set, the argument for the ETRN command must
17877 be a &'#'& followed by an address string.
17878 In this case an &'exim -R <string>'& command is used;
17879 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17880
17881 A new process is created to run the command, but Exim does not wait for it to
17882 complete. Consequently, its status cannot be checked. If the command cannot be
17883 run, a line is written to the panic log, but the ETRN caller still receives
17884 a 250 success response. Exim is normally running under its own uid when
17885 receiving SMTP, so it is not possible for it to change the uid before running
17886 the command.
17887
17888
17889 .option smtp_etrn_serialize main boolean true
17890 .cindex "ETRN" "serializing"
17891 When this option is set, it prevents the simultaneous execution of more than
17892 one identical command as a result of ETRN in an SMTP connection. See
17893 section &<<SECTETRN>>& for details.
17894
17895
17896 .option smtp_load_reserve main fixed-point unset
17897 .cindex "load average"
17898 If the system load average ever gets higher than this, incoming SMTP calls are
17899 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17900 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17901 the load is over the limit. The option has no effect on ancient operating
17902 systems on which Exim cannot determine the load average. See also
17903 &%deliver_queue_load_max%& and &%queue_only_load%&.
17904
17905
17906
17907 .option smtp_max_synprot_errors main integer 3
17908 .cindex "SMTP" "limiting syntax and protocol errors"
17909 .cindex "limit" "SMTP syntax and protocol errors"
17910 Exim rejects SMTP commands that contain syntax or protocol errors. In
17911 particular, a syntactically invalid email address, as in this command:
17912 .code
17913 RCPT TO:<abc xyz@a.b.c>
17914 .endd
17915 causes immediate rejection of the command, before any other tests are done.
17916 (The ACL cannot be run if there is no valid address to set up for it.) An
17917 example of a protocol error is receiving RCPT before MAIL. If there are
17918 too many syntax or protocol errors in one SMTP session, the connection is
17919 dropped. The limit is set by this option.
17920
17921 .cindex "PIPELINING" "expected errors"
17922 When the PIPELINING extension to SMTP is in use, some protocol errors are
17923 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17924 Exim assumes that PIPELINING will be used if it advertises it (see
17925 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17926 not count towards the limit.
17927
17928
17929
17930 .option smtp_max_unknown_commands main integer 3
17931 .cindex "SMTP" "limiting unknown commands"
17932 .cindex "limit" "unknown SMTP commands"
17933 If there are too many unrecognized commands in an incoming SMTP session, an
17934 Exim server drops the connection. This is a defence against some kinds of abuse
17935 that subvert web
17936 clients
17937 into making connections to SMTP ports; in these circumstances, a number of
17938 non-SMTP command lines are sent first.
17939
17940
17941
17942 .options smtp_ratelimit_hosts main "host list&!!" unset &&&
17943          smtp_ratelimit_mail main string unset &&&
17944          smtp_ratelimit_rcpt main string unset
17945 .cindex "SMTP" "rate limiting"
17946 .cindex "limit" "rate of message arrival"
17947 .cindex "RCPT" "rate limiting"
17948 Some sites find it helpful to be able to limit the rate at which certain hosts
17949 can send them messages, and the rate at which an individual message can specify
17950 recipients.
17951
17952 Exim has two rate-limiting facilities. This section describes the older
17953 facility, which can limit rates within a single connection. The newer
17954 &%ratelimit%& ACL condition can limit rates across all connections. See section
17955 &<<SECTratelimiting>>& for details of the newer facility.
17956
17957 When a host matches &%smtp_ratelimit_hosts%&, the values of
17958 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17959 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17960 respectively. Each option, if set, must contain a set of four comma-separated
17961 values:
17962
17963 .ilist
17964 A threshold, before which there is no rate limiting.
17965 .next
17966 An initial time delay. Unlike other times in Exim, numbers with decimal
17967 fractional parts are allowed here.
17968 .next
17969 A factor by which to increase the delay each time.
17970 .next
17971 A maximum value for the delay. This should normally be less than 5 minutes,
17972 because after that time, the client is liable to timeout the SMTP command.
17973 .endlist
17974
17975 For example, these settings have been used successfully at the site which
17976 first suggested this feature, for controlling mail from their customers:
17977 .code
17978 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17979 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17980 .endd
17981 The first setting specifies delays that are applied to MAIL commands after
17982 two have been received over a single connection. The initial delay is 0.5
17983 seconds, increasing by a factor of 1.05 each time. The second setting applies
17984 delays to RCPT commands when more than four occur in a single message.
17985
17986
17987
17988 .option smtp_receive_timeout main time&!! 5m
17989 .cindex "timeout" "for SMTP input"
17990 .cindex "SMTP" "input timeout"
17991 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17992 input, including batch SMTP. If a line of input (either an SMTP command or a
17993 data line) is not received within this time, the SMTP connection is dropped and
17994 the message is abandoned.
17995 A line is written to the log containing one of the following messages:
17996 .code
17997 SMTP command timeout on connection from...
17998 SMTP data timeout on connection from...
17999 .endd
18000 The former means that Exim was expecting to read an SMTP command; the latter
18001 means that it was in the DATA phase, reading the contents of a message.
18002
18003 If the first character of the option is a &"$"& the option is
18004 expanded before use and may depend on
18005 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
18006
18007
18008 .oindex "&%-os%&"
18009 The value set by this option can be overridden by the
18010 &%-os%& command-line option. A setting of zero time disables the timeout, but
18011 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
18012 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
18013 timeout is controlled by &%receive_timeout%& and &%-or%&.
18014
18015
18016 .option smtp_reserve_hosts main "host list&!!" unset
18017 This option defines hosts for which SMTP connections are reserved; see
18018 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
18019
18020
18021 .option smtp_return_error_details main boolean false
18022 .cindex "SMTP" "details policy failures"
18023 .cindex "policy control" "rejection, returning details"
18024 In the default state, Exim uses bland messages such as
18025 &"Administrative prohibition"& when it rejects SMTP commands for policy
18026 reasons. Many sysadmins like this because it gives away little information
18027 to spammers. However, some other sysadmins who are applying strict checking
18028 policies want to give out much fuller information about failures. Setting
18029 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
18030 example, instead of &"Administrative prohibition"&, it might give:
18031 .code
18032 550-Rejected after DATA: '>' missing at end of address:
18033 550 failing address in "From" header is: <user@dom.ain
18034 .endd
18035
18036
18037 .option smtputf8_advertise_hosts main "host list&!!" *
18038 .cindex "SMTPUTF8" "ESMTP extension, advertising"
18039 .cindex "ESMTP extensions" SMTPUTF8
18040 When Exim is built with support for internationalised mail names,
18041 the availability thereof is advertised in
18042 response to EHLO only to those client hosts that match this option. See
18043 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
18044
18045
18046 .option spamd_address main string "127.0.0.1 783"
18047 This option is available when Exim is compiled with the content-scanning
18048 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
18049 See section &<<SECTscanspamass>>& for more details.
18050
18051
18052
18053 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
18054 This option is available when Exim is compiled with SPF support.
18055 See section &<<SECSPF>>& for more details.
18056
18057 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
18058 This option is available when Exim is compiled with SPF support.  It
18059 allows the customisation of the SMTP comment that the SPF library
18060 generates.  You are strongly encouraged to link to your own explanative
18061 site. The template must not contain spaces. If you need spaces in the
18062 output, use the proper placeholder. If libspf2 can not parse the
18063 template, it uses a built-in default broken link. The following placeholders
18064 (along with Exim variables (but see below)) are allowed in the template:
18065 .ilist
18066 &*%_*&: A space.
18067 .next
18068 &*%{L}*&: Envelope sender's local part.
18069 .next
18070 &*%{S}*&: Envelope sender.
18071 .next
18072 &*%{O}*&: Envelope sender's domain.
18073 .next
18074 &*%{D}*&: Current(?) domain.
18075 .next
18076 &*%{I}*&: SMTP client Ip.
18077 .next
18078 &*%{C}*&: SMTP client pretty IP.
18079 .next
18080 &*%{T}*&: Epoch time (UTC).
18081 .next
18082 &*%{P}*&: SMTP client domain name.
18083 .next
18084 &*%{V}*&: IP version.
18085 .next
18086 &*%{H}*&: EHLO/HELO domain.
18087 .next
18088 &*%{R}*&: Receiving domain.
18089 .endlist
18090 The capitalized placeholders do proper URL encoding, if you use them
18091 lowercased, no encoding takes place.  This list was compiled from the
18092 libspf2 sources.
18093
18094 A note on using Exim variables: As
18095 currently the SPF library is initialized before the SMTP EHLO phase,
18096 the variables useful for expansion are quite limited.
18097
18098
18099 .option split_spool_directory main boolean false
18100 .cindex "multiple spool directories"
18101 .cindex "spool directory" "split"
18102 .cindex "directories, multiple"
18103 If this option is set, it causes Exim to split its input directory into 62
18104 subdirectories, each with a single alphanumeric character as its name. The
18105 sixth character of the message id is used to allocate messages to
18106 subdirectories; this is the least significant base-62 digit of the time of
18107 arrival of the message.
18108
18109 Splitting up the spool in this way may provide better performance on systems
18110 where there are long mail queues, by reducing the number of files in any one
18111 directory. The msglog directory is also split up in a similar way to the input
18112 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18113 are still placed in the single directory &_msglog.OLD_&.
18114
18115 It is not necessary to take any special action for existing messages when
18116 changing &%split_spool_directory%&. Exim notices messages that are in the
18117 &"wrong"& place, and continues to process them. If the option is turned off
18118 after a period of being on, the subdirectories will eventually empty and be
18119 automatically deleted.
18120
18121 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18122 changes. Instead of creating a list of all messages in the queue, and then
18123 trying to deliver each one, in turn, it constructs a list of those in one
18124 sub-directory and tries to deliver them, before moving on to the next
18125 sub-directory. The sub-directories are processed in a random order. This
18126 spreads out the scanning of the input directories, and uses less memory. It is
18127 particularly beneficial when there are lots of messages in the queue. However,
18128 if &%queue_run_in_order%& is set, none of this new processing happens. The
18129 entire queue has to be scanned and sorted before any deliveries can start.
18130
18131
18132 .option spool_directory main string&!! "set at compile time"
18133 .cindex "spool directory" "path to"
18134 This defines the directory in which Exim keeps its spool, that is, the messages
18135 it is waiting to deliver. The default value is taken from the compile-time
18136 configuration setting, if there is one. If not, this option must be set. The
18137 string is expanded, so it can contain, for example, a reference to
18138 &$primary_hostname$&.
18139
18140 If the spool directory name is fixed on your installation, it is recommended
18141 that you set it at build time rather than from this option, particularly if the
18142 log files are being written to the spool directory (see &%log_file_path%&).
18143 Otherwise log files cannot be used for errors that are detected early on, such
18144 as failures in the configuration file.
18145
18146 By using this option to override the compiled-in path, it is possible to run
18147 tests of Exim without using the standard spool.
18148
18149 .option spool_wireformat main boolean false
18150 .cindex "spool directory" "file formats"
18151 If this option is set, Exim may for some messages use an alternative format
18152 for data-files in the spool which matches the wire format.
18153 Doing this permits more efficient message reception and transmission.
18154 Currently it is only done for messages received using the ESMTP CHUNKING
18155 option.
18156
18157 The following variables will not have useful values:
18158 .code
18159 $max_received_linelength
18160 $body_linecount
18161 $body_zerocount
18162 .endd
18163
18164 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18165 and any external programs which are passed a reference to a message data file
18166 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18167 will need to be aware of the different formats potentially available.
18168
18169 Using any of the ACL conditions noted will negate the reception benefit
18170 (as a Unix-mbox-format file is constructed for them).
18171 The transmission benefit is maintained.
18172
18173 .option sqlite_lock_timeout main time 5s
18174 .cindex "sqlite lookup type" "lock timeout"
18175 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18176 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18177
18178 .option strict_acl_vars main boolean false
18179 .cindex "&ACL;" "variables, handling unset"
18180 This option controls what happens if a syntactically valid but undefined ACL
18181 variable is referenced. If it is false (the default), an empty string
18182 is substituted; if it is true, an error is generated. See section
18183 &<<SECTaclvariables>>& for details of ACL variables.
18184
18185 .option strip_excess_angle_brackets main boolean false
18186 .cindex "angle brackets, excess"
18187 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18188 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18189 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18190 passed on to another MTA, the excess angle brackets are not passed on. If this
18191 option is not set, multiple pairs of angle brackets cause a syntax error.
18192
18193
18194 .option strip_trailing_dot main boolean false
18195 .cindex "trailing dot on domain"
18196 .cindex "dot" "trailing on domain"
18197 If this option is set, a trailing dot at the end of a domain in an address is
18198 ignored. If this is in the envelope and the message is passed on to another
18199 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18200 domain causes a syntax error.
18201 However, addresses in header lines are checked only when an ACL requests header
18202 syntax checking.
18203
18204
18205 .option syslog_duplication main boolean true
18206 .cindex "syslog" "duplicate log lines; suppressing"
18207 When Exim is logging to syslog, it writes the log lines for its three
18208 separate logs at different syslog priorities so that they can in principle
18209 be separated on the logging hosts. Some installations do not require this
18210 separation, and in those cases, the duplication of certain log lines is a
18211 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18212 particular log line is written to syslog. For lines that normally go to
18213 both the main log and the reject log, the reject log version (possibly
18214 containing message header lines) is written, at LOG_NOTICE priority.
18215 Lines that normally go to both the main and the panic log are written at
18216 the LOG_ALERT priority.
18217
18218
18219 .option syslog_facility main string unset
18220 .cindex "syslog" "facility; setting"
18221 This option sets the syslog &"facility"& name, used when Exim is logging to
18222 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18223 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18224 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18225 details of Exim's logging.
18226
18227
18228 .option syslog_pid main boolean true
18229 .cindex "syslog" "pid"
18230 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18231 omitted when these lines are sent to syslog. (Syslog normally prefixes
18232 the log lines with the PID of the logging process automatically.) You need
18233 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18234 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18235
18236
18237
18238 .option syslog_processname main string &`exim`&
18239 .cindex "syslog" "process name; setting"
18240 This option sets the syslog &"ident"& name, used when Exim is logging to
18241 syslog. The value must be no longer than 32 characters. See chapter
18242 &<<CHAPlog>>& for details of Exim's logging.
18243
18244
18245
18246 .option syslog_timestamp main boolean true
18247 .cindex "syslog" "timestamps"
18248 .cindex timestamps syslog
18249 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18250 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18251 details of Exim's logging.
18252
18253
18254 .option system_filter main string&!! unset
18255 .cindex "filter" "system filter"
18256 .cindex "system filter" "specifying"
18257 .cindex "Sieve filter" "not available for system filter"
18258 This option specifies an Exim filter file that is applied to all messages at
18259 the start of each delivery attempt, before any routing is done. System filters
18260 must be Exim filters; they cannot be Sieve filters. If the system filter
18261 generates any deliveries to files or pipes, or any new mail messages, the
18262 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18263 which transports are to be used. Details of this facility are given in chapter
18264 &<<CHAPsystemfilter>>&.
18265 A forced expansion failure results in no filter operation.
18266
18267
18268 .option system_filter_directory_transport main string&!! unset
18269 .vindex "&$address_file$&"
18270 This sets the name of the transport driver that is to be used when the
18271 &%save%& command in a system message filter specifies a path ending in &"/"&,
18272 implying delivery of each message into a separate file in some directory.
18273 During the delivery, the variable &$address_file$& contains the path name.
18274
18275
18276 .option system_filter_file_transport main string&!! unset
18277 .cindex "file" "transport for system filter"
18278 This sets the name of the transport driver that is to be used when the &%save%&
18279 command in a system message filter specifies a path not ending in &"/"&. During
18280 the delivery, the variable &$address_file$& contains the path name.
18281
18282 .option system_filter_group main string unset
18283 .cindex "gid (group id)" "system filter"
18284 This option is used only when &%system_filter_user%& is also set. It sets the
18285 gid under which the system filter is run, overriding any gid that is associated
18286 with the user. The value may be numerical or symbolic.
18287
18288 .option system_filter_pipe_transport main string&!! unset
18289 .cindex "&(pipe)& transport" "for system filter"
18290 .vindex "&$address_pipe$&"
18291 This specifies the transport driver that is to be used when a &%pipe%& command
18292 is used in a system filter. During the delivery, the variable &$address_pipe$&
18293 contains the pipe command.
18294
18295
18296 .option system_filter_reply_transport main string&!! unset
18297 .cindex "&(autoreply)& transport" "for system filter"
18298 This specifies the transport driver that is to be used when a &%mail%& command
18299 is used in a system filter.
18300
18301
18302 .option system_filter_user main string unset
18303 .cindex "uid (user id)" "system filter"
18304 If this option is set to root, the system filter is run in the main Exim
18305 delivery process, as root.  Otherwise, the system filter runs in a separate
18306 process, as the given user, defaulting to the Exim run-time user.
18307 Unless the string consists entirely of digits, it
18308 is looked up in the password data. Failure to find the named user causes a
18309 configuration error. The gid is either taken from the password data, or
18310 specified by &%system_filter_group%&. When the uid is specified numerically,
18311 &%system_filter_group%& is required to be set.
18312
18313 If the system filter generates any pipe, file, or reply deliveries, the uid
18314 under which the filter is run is used when transporting them, unless a
18315 transport option overrides.
18316
18317
18318 .option tcp_nodelay main boolean true
18319 .cindex "daemon" "TCP_NODELAY on sockets"
18320 .cindex "Nagle algorithm"
18321 .cindex "TCP_NODELAY on listening sockets"
18322 If this option is set false, it stops the Exim daemon setting the
18323 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18324 turns off the &"Nagle algorithm"&, which is a way of improving network
18325 performance in interactive (character-by-character) situations. Turning it off
18326 should improve Exim's performance a bit, so that is what happens by default.
18327 However, it appears that some broken clients cannot cope, and time out. Hence
18328 this option. It affects only those sockets that are set up for listening by the
18329 daemon. Sockets created by the smtp transport for delivering mail always set
18330 TCP_NODELAY.
18331
18332
18333 .option timeout_frozen_after main time 0s
18334 .cindex "frozen messages" "timing out"
18335 .cindex "timeout" "frozen messages"
18336 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18337 message of any kind that has been in the queue for longer than the given time
18338 is automatically cancelled at the next queue run. If the frozen message is a
18339 bounce message, it is just discarded; otherwise, a bounce is sent to the
18340 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18341 If you want to timeout frozen bounce messages earlier than other kinds of
18342 frozen message, see &%ignore_bounce_errors_after%&.
18343
18344 &*Note:*& the default value of zero means no timeouts; with this setting,
18345 frozen messages remain in the queue forever (except for any frozen bounce
18346 messages that are released by &%ignore_bounce_errors_after%&).
18347
18348
18349 .option timezone main string unset
18350 .cindex "timezone, setting"
18351 .cindex "environment" "values from"
18352 The value of &%timezone%& is used to set the environment variable TZ while
18353 running Exim (if it is different on entry). This ensures that all timestamps
18354 created by Exim are in the required timezone. If you want all your timestamps
18355 to be in UTC (aka GMT) you should set
18356 .code
18357 timezone = UTC
18358 .endd
18359 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18360 or, if that is not set, from the value of the TZ environment variable when Exim
18361 is built. If &%timezone%& is set to the empty string, either at build or run
18362 time, any existing TZ variable is removed from the environment when Exim
18363 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18364 unfortunately not all, operating systems.
18365
18366
18367 .option tls_advertise_hosts main "host list&!!" *
18368 .cindex "TLS" "advertising"
18369 .cindex "encryption" "on SMTP connection"
18370 .cindex "SMTP" "encrypted connection"
18371 .cindex "ESMTP extensions" STARTTLS
18372 When Exim is built with support for TLS encrypted connections, the availability
18373 of the STARTTLS command to set up an encrypted session is advertised in
18374 response to EHLO only to those client hosts that match this option. See
18375 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18376 Note that the default value requires that a certificate be supplied
18377 using the &%tls_certificate%& option.  If TLS support for incoming connections
18378 is not required the &%tls_advertise_hosts%& option should be set empty.
18379
18380
18381 .option tls_alpn main "string list&!!" "smtp : esmtp"
18382 .cindex TLS "Application Layer Protocol Names"
18383 .cindex TLS ALPN
18384 .cindex ALPN "set acceptable names for server"
18385 If this option is set,
18386 the TLS library supports ALPN,
18387 and the client offers either more than one
18388 ALPN name or a name which does not match the list,
18389 the TLS connection is declined.
18390
18391
18392 .option tls_certificate main "string list&!!" unset
18393 .cindex "TLS" "server certificate; location of"
18394 .cindex "certificate" "server, location of"
18395 The value of this option is expanded, and must then be a list of absolute paths to
18396 files which contain the server's certificates (in PEM format).
18397 Commonly only one file is needed.
18398 The server's private key is also
18399 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18400 &<<CHAPTLS>>& for further details.
18401
18402 &*Note*&: The certificates defined by this option are used only when Exim is
18403 receiving incoming messages as a server. If you want to supply certificates for
18404 use when sending messages as a client, you must set the &%tls_certificate%&
18405 option in the relevant &(smtp)& transport.
18406
18407 &*Note*&: If you use filenames based on IP addresses, change the list
18408 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18409
18410 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18411 when a list of more than one
18412 file is used, the &$tls_in_ourcert$& variable is unreliable.
18413 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18414
18415 .cindex SNI "selecting server certificate based on"
18416 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18417 if the OpenSSL build supports TLS extensions and the TLS client sends the
18418 Server Name Indication extension, then this option and others documented in
18419 &<<SECTtlssni>>& will be re-expanded.
18420
18421 If this option is unset or empty a self-signed certificate will be
18422 used.
18423 Under Linux this is generated at daemon startup; on other platforms it will be
18424 generated fresh for every connection.
18425
18426 .option tls_crl main string&!! unset
18427 .cindex "TLS" "server certificate revocation list"
18428 .cindex "certificate" "revocation list for server"
18429 This option specifies a certificate revocation list. The expanded value must
18430 be the name of a file that contains CRLs in PEM format.
18431
18432 Under OpenSSL the option can specify a directory with CRL files.
18433
18434 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18435 for each signing element of the certificate chain (i.e. all but the leaf).
18436 For the file variant this can be multiple PEM blocks in the one file.
18437
18438 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18439
18440
18441 .option tls_dh_max_bits main integer 2236
18442 .cindex "TLS" "D-H bit count"
18443 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18444 the chosen TLS library.  That value might prove to be too high for
18445 interoperability.  This option provides a maximum clamp on the value
18446 suggested, trading off security for interoperability.
18447
18448 The value must be at least 1024.
18449
18450 The value 2236 was chosen because, at time of adding the option, it was the
18451 hard-coded maximum value supported by the NSS cryptographic library, as used
18452 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18453
18454 If you prefer more security and are willing to break some clients, raise this
18455 number.
18456
18457 Note that the value passed to GnuTLS for *generating* a new prime may be a
18458 little less than this figure, because GnuTLS is inexact and may produce a
18459 larger prime than requested.
18460
18461
18462 .option tls_dhparam main string&!! unset
18463 .cindex "TLS" "D-H parameters for server"
18464 The value of this option is expanded and indicates the source of DH parameters
18465 to be used by Exim.
18466
18467 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
18468 local DH parameters*&, which has been supported across all versions of Exim.  The
18469 other specific constants available are a fallback so that even when
18470 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18471
18472 If &%tls_dhparam%& is a filename starting with a &`/`&,
18473 then it names a file from which DH
18474 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18475 PKCS#3 representation of the DH prime.  If the file does not exist, for
18476 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18477 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18478 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18479 and treated as though the &%tls_dhparam%& were set to "none".
18480
18481 If this option expands to the string "none", then no DH parameters will be
18482 loaded by Exim.
18483
18484 If this option expands to the string "historic" and Exim is using GnuTLS, then
18485 Exim will attempt to load a file from inside the spool directory.  If the file
18486 does not exist, Exim will attempt to create it.
18487 See section &<<SECTgnutlsparam>>& for further details.
18488
18489 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18490 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18491
18492 In older versions of Exim the default was the 2048 bit prime described in section
18493 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18494 in IKE is assigned number 23.
18495
18496 Otherwise, the option must expand to the name used by Exim for any of a number
18497 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18498 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18499 the number used by IKE, or "default" which corresponds to
18500 &`exim.dev.20160529.3`&.
18501
18502 The available standard primes are:
18503 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18504 &`ike1`&, &`ike2`&, &`ike5`&,
18505 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18506 &`ike22`&, &`ike23`& and &`ike24`&.
18507
18508 The available additional primes are:
18509 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18510
18511 Some of these will be too small to be accepted by clients.
18512 Some may be too large to be accepted by clients.
18513 The open cryptographic community has suspicions about the integrity of some
18514 of the later IKE values, which led into RFC7919 providing new fixed constants
18515 (the "ffdhe" identifiers).
18516
18517 At this point, all of the "ike" values should be considered obsolete;
18518 they are still in Exim to avoid breaking unusual configurations, but are
18519 candidates for removal the next time we have backwards-incompatible changes.
18520 Two of them in particular (&`ike1`& and &`ike22`&) are called out by RFC 8247
18521 as MUST NOT use for IPSEC, and two more (&`ike23`& and &`ike24`&) as
18522 SHOULD NOT.
18523 Because of this, Exim regards them as deprecated; if either of the first pair
18524 are used, warnings will be logged in the paniclog, and if any are used then
18525 warnings will be logged in the mainlog.
18526 All four will be removed in a future Exim release.
18527
18528 The TLS protocol does not negotiate an acceptable size for this; clients tend
18529 to hard-drop connections if what is offered by the server is unacceptable,
18530 whether too large or too small, and there's no provision for the client to
18531 tell the server what these constraints are.  Thus, as a server operator, you
18532 need to make an educated guess as to what is most likely to work for your
18533 userbase.
18534
18535 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18536 is most likely to maximise interoperability.  The upper bound comes from
18537 applications using the Mozilla Network Security Services (NSS) library, which
18538 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18539 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18540 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18541 acceptable bound from 1024 to 2048.
18542
18543
18544 .option tls_eccurve main string list&!! &`auto`&
18545 .cindex TLS "EC cryptography"
18546 This option selects EC curves for use by Exim when used with OpenSSL.
18547 It has no effect when Exim is used with GnuTLS
18548 (the equivalent can be done using a priority string for the
18549 &%tls_require_ciphers%& option).
18550
18551 After expansion it must contain
18552 one or (only for OpenSSL versiona 1.1.1 onwards) more
18553 EC curve names, such as &`prime256v1`&, &`secp384r1`&, or &`P-521`&.
18554 Consult your OpenSSL manual for valid curve names.
18555
18556 For OpenSSL versions before (and not including) 1.0.2, the string
18557 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18558 &`auto`& tells the library to choose.
18559
18560 If the option expands to an empty string, the effect is undefined.
18561
18562
18563 .option tls_ocsp_file main string&!! unset
18564 .cindex TLS "certificate status"
18565 .cindex TLS "OCSP proof file"
18566 This option
18567 must if set expand to the absolute path to a file which contains a current
18568 status proof for the server's certificate, as obtained from the
18569 Certificate Authority.
18570
18571 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18572 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18573
18574 For OpenSSL 1.1.0 or later, and
18575 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18576 of files, to match a list given for the &%tls_certificate%& option.
18577 The ordering of the two lists must match.
18578 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18579
18580 The file(s) should be in DER format,
18581 except for GnuTLS 3.6.3 or later
18582 or for OpenSSL,
18583 when an optional filetype prefix can be used.
18584 The prefix must be one of "DER" or "PEM", followed by
18585 a single space.  If one is used it sets the format for subsequent
18586 files in the list; the initial format is DER.
18587 If multiple proofs are wanted, for multiple chain elements
18588 (this only works under TLS1.3)
18589 they must be coded as a combined OCSP response.
18590
18591 Although GnuTLS will accept PEM files with multiple separate
18592 PEM blobs (ie. separate OCSP responses), it sends them in the
18593 TLS Certificate record interleaved with the certificates of the chain;
18594 although a GnuTLS client is happy with that, an OpenSSL client is not.
18595
18596 .option tls_on_connect_ports main "string list" unset
18597 .cindex SSMTP
18598 .cindex SMTPS
18599 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18600 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18601 set up without waiting for the client to issue a STARTTLS command. For
18602 further details, see section &<<SECTsupobssmt>>&.
18603
18604
18605
18606 .option tls_privatekey main "string list&!!" unset
18607 .cindex "TLS" "server private key; location of"
18608 The value of this option is expanded, and must then be a list of absolute paths to
18609 files which contains the server's private keys.
18610 If this option is unset, or if
18611 the expansion is forced to fail, or the result is an empty string, the private
18612 key is assumed to be in the same file as the server's certificates. See chapter
18613 &<<CHAPTLS>>& for further details.
18614
18615 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18616
18617
18618 .option tls_remember_esmtp main boolean false
18619 .cindex "TLS" "esmtp state; remembering"
18620 .cindex "TLS" "broken clients"
18621 If this option is set true, Exim violates the RFCs by remembering that it is in
18622 &"esmtp"& state after successfully negotiating a TLS session. This provides
18623 support for broken clients that fail to send a new EHLO after starting a
18624 TLS session.
18625
18626
18627 .option tls_require_ciphers main string&!! unset
18628 .cindex "TLS" "requiring specific ciphers"
18629 .cindex "cipher" "requiring specific"
18630 This option controls which ciphers can be used for incoming TLS connections.
18631 The &(smtp)& transport has an option of the same name for controlling outgoing
18632 connections. This option is expanded for each connection, so can be varied for
18633 different clients if required. The value of this option must be a list of
18634 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18635 in somewhat different ways. If GnuTLS is being used, the client controls the
18636 preference order of the available ciphers. Details are given in sections
18637 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18638
18639
18640 .option tls_resumption_hosts main "host list&!!" unset
18641 .cindex TLS resumption
18642 This option controls which connections to offer the TLS resumption feature.
18643 See &<<SECTresumption>>& for details.
18644
18645
18646 .option tls_try_verify_hosts main "host list&!!" unset
18647 .cindex "TLS" "client certificate verification"
18648 .cindex "certificate" "verification of client"
18649 See &%tls_verify_hosts%& below.
18650
18651
18652 .option tls_verify_certificates main string&!! system
18653 .cindex "TLS" "client certificate verification"
18654 .cindex "certificate" "verification of client"
18655 The value of this option is expanded, and must then be either the
18656 word "system"
18657 or the absolute path to
18658 a file or directory containing permitted certificates for clients that
18659 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18660
18661 The "system" value for the option will use a
18662 system default location compiled into the SSL library.
18663 This is not available for GnuTLS versions preceding 3.0.20,
18664 and will be taken as empty; an explicit location
18665 must be specified.
18666
18667 The use of a directory for the option value is not available for GnuTLS versions
18668 preceding 3.3.6 and a single file must be used.
18669
18670 With OpenSSL the certificates specified
18671 explicitly
18672 either by file or directory
18673 are added to those given by the system default location.
18674
18675 These certificates should be for the certificate authorities trusted, rather
18676 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18677 the value is a file then the certificates are sent by Exim as a server to
18678 connecting clients, defining the list of accepted certificate authorities.
18679 Thus the values defined should be considered public data.  To avoid this,
18680 use the explicit directory version. (If your peer is Exim up to 4.85,
18681 using GnuTLS, you may need to send the CAs (thus using the file
18682 variant). Otherwise the peer doesn't send its certificate.)
18683
18684 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18685
18686 A forced expansion failure or setting to an empty string is equivalent to
18687 being unset.
18688
18689
18690 .option tls_verify_hosts main "host list&!!" unset
18691 .cindex "TLS" "client certificate verification"
18692 .cindex "certificate" "verification of client"
18693 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18694 certificates from clients. The expected certificates are defined by
18695 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18696 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18697 &%tls_verify_certificates%& is not set.
18698
18699 Any client that matches &%tls_verify_hosts%& is constrained by
18700 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18701 present one of the listed certificates. If it does not, the connection is
18702 aborted.
18703 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18704 the host to use TLS. It can still send SMTP commands through unencrypted
18705 connections. Forcing a client to use TLS has to be done separately using an
18706 ACL to reject inappropriate commands when the connection is not encrypted.
18707
18708 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18709 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18710 certificate and checks it against &%tls_verify_certificates%&, but does not
18711 abort the connection if there is no certificate or if it does not match. This
18712 state can be detected in an ACL, which makes it possible to implement policies
18713 such as &"accept for relay only if a verified certificate has been received,
18714 but accept for local delivery if encrypted, even without a verified
18715 certificate"&.
18716
18717 Client hosts that match neither of these lists are not asked to present
18718 certificates.
18719
18720
18721 .option trusted_groups main "string list&!!" unset
18722 .cindex "trusted groups"
18723 .cindex "groups" "trusted"
18724 This option is expanded just once, at the start of Exim's processing. If this
18725 option is set, any process that is running in one of the listed groups, or
18726 which has one of them as a supplementary group, is trusted. The groups can be
18727 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18728 details of what trusted callers are permitted to do. If neither
18729 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18730 are trusted.
18731
18732 .option trusted_users main "string list&!!" unset
18733 .cindex "trusted users"
18734 .cindex "user" "trusted"
18735 This option is expanded just once, at the start of Exim's processing. If this
18736 option is set, any process that is running as one of the listed users is
18737 trusted. The users can be specified numerically or by name. See section
18738 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18739 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18740 Exim user are trusted.
18741
18742 .option unknown_login main string&!! unset
18743 .cindex "uid (user id)" "unknown caller"
18744 .vindex "&$caller_uid$&"
18745 This is a specialized feature for use in unusual configurations. By default, if
18746 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18747 gives up. The &%unknown_login%& option can be used to set a login name to be
18748 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18749 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18750 is used for the user's real name (gecos field), unless this has been set by the
18751 &%-F%& option.
18752
18753 .option unknown_username main string unset
18754 See &%unknown_login%&.
18755
18756 .option untrusted_set_sender main "address list&!!" unset
18757 .cindex "trusted users"
18758 .cindex "sender" "setting by untrusted user"
18759 .cindex "untrusted user setting sender"
18760 .cindex "user" "untrusted setting sender"
18761 .cindex "envelope from"
18762 .cindex "envelope sender"
18763 When an untrusted user submits a message to Exim using the standard input, Exim
18764 normally creates an envelope sender address from the user's login and the
18765 default qualification domain. Data from the &%-f%& option (for setting envelope
18766 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18767 is used) is ignored.
18768
18769 However, untrusted users are permitted to set an empty envelope sender address,
18770 to declare that a message should never generate any bounces. For example:
18771 .code
18772 exim -f '<>' user@domain.example
18773 .endd
18774 .vindex "&$sender_ident$&"
18775 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18776 other envelope sender addresses in a controlled way. When it is set, untrusted
18777 users are allowed to set envelope sender addresses that match any of the
18778 patterns in the list. Like all address lists, the string is expanded. The
18779 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18780 users to setting senders that start with their login ids
18781 followed by a hyphen
18782 by a setting like this:
18783 .code
18784 untrusted_set_sender = ^$sender_ident-
18785 .endd
18786 If you want to allow untrusted users to set envelope sender addresses without
18787 restriction, you can use
18788 .code
18789 untrusted_set_sender = *
18790 .endd
18791 The &%untrusted_set_sender%& option applies to all forms of local input, but
18792 only to the setting of the envelope sender. It does not permit untrusted users
18793 to use the other options which trusted user can use to override message
18794 parameters. Furthermore, it does not stop Exim from removing an existing
18795 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18796 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18797 overriding these actions. The handling of the &'Sender:'& header is also
18798 described in section &<<SECTthesenhea>>&.
18799
18800 The log line for a message's arrival shows the envelope sender following
18801 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18802 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18803 envelope sender address, the user's login is shown in parentheses after the
18804 sender address.
18805
18806
18807 .option uucp_from_pattern main string "see below"
18808 .cindex "&""From""& line"
18809 .cindex "UUCP" "&""From""& line"
18810 Some applications that pass messages to an MTA via a command line interface use
18811 an initial line starting with &"From&~"& to pass the envelope sender. In
18812 particular, this is used by UUCP software. Exim recognizes such a line by means
18813 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18814 matches, the sender address is constructed by expanding the contents of
18815 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18816 default pattern recognizes lines in the following two forms:
18817 .code
18818 From ph10 Fri Jan  5 12:35 GMT 1996
18819 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18820 .endd
18821 The pattern can be seen by running
18822 .code
18823 exim -bP uucp_from_pattern
18824 .endd
18825 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18826 year in the second case. The first word after &"From&~"& is matched in the
18827 regular expression by a parenthesized subpattern. The default value for
18828 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18829 (&"ph10"& in the example above) as the message's sender. See also
18830 &%ignore_fromline_hosts%&.
18831
18832
18833 .option uucp_from_sender main string&!! &`$1`&
18834 See &%uucp_from_pattern%& above.
18835
18836
18837 .option warn_message_file main string&!! unset
18838 .cindex "warning of delay" "customizing the message"
18839 .cindex "customizing" "warning message"
18840 This option defines a template file containing paragraphs of text to be used
18841 for constructing the warning message which is sent by Exim when a message has
18842 been in the queue for a specified amount of time, as specified by
18843 &%delay_warning%&. Details of the file's contents are given in chapter
18844 &<<CHAPemsgcust>>&.
18845 .cindex warn_message_file "tainted data"
18846 The option is expanded to give the file path, which must be
18847 absolute and untainted.
18848 See also &%bounce_message_file%&.
18849
18850
18851 .option write_rejectlog main boolean true
18852 .cindex "reject log" "disabling"
18853 If this option is set false, Exim no longer writes anything to the reject log.
18854 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18855 .ecindex IIDconfima
18856 .ecindex IIDmaiconf
18857
18858
18859
18860
18861 . ////////////////////////////////////////////////////////////////////////////
18862 . ////////////////////////////////////////////////////////////////////////////
18863
18864 .chapter "Generic options for routers" "CHAProutergeneric"
18865 .scindex IIDgenoprou1 "options" "generic; for routers"
18866 .scindex IIDgenoprou2 "generic options" "router"
18867 This chapter describes the generic options that apply to all routers.
18868 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18869
18870 For a general description of how a router operates, see sections
18871 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18872 which the preconditions are tested. The order of expansion of the options that
18873 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18874 &%headers_remove%&, &%transport%&.
18875
18876 The name of a router is limited to be &drivernamemax; ASCII characters long;
18877 prior to Exim 4.95 names would be silently truncated at this length, but now
18878 it is enforced.
18879
18880
18881 .option address_data routers string&!! unset
18882 .cindex "router" "data attached to address"
18883 The string is expanded just before the router is run, that is, after all the
18884 precondition tests have succeeded. If the expansion is forced to fail, the
18885 router declines, the value of &%address_data%& remains unchanged, and the
18886 &%more%& option controls what happens next. Other expansion failures cause
18887 delivery of the address to be deferred.
18888
18889 .vindex "&$address_data$&"
18890 When the expansion succeeds, the value is retained with the address, and can be
18891 accessed using the variable &$address_data$& in the current router, subsequent
18892 routers, and the eventual transport.
18893
18894 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18895 that runs a user's filter file, the contents of &$address_data$& are accessible
18896 in the filter. This is not normally a problem, because such data is usually
18897 either not confidential or it &"belongs"& to the current user, but if you do
18898 put confidential data into &$address_data$& you need to remember this point.
18899
18900 Even if the router declines or passes, the value of &$address_data$& remains
18901 with the address, though it can be changed by another &%address_data%& setting
18902 on a subsequent router. If a router generates child addresses, the value of
18903 &$address_data$& propagates to them. This also applies to the special kind of
18904 &"child"& that is generated by a router with the &%unseen%& option.
18905
18906 The idea of &%address_data%& is that you can use it to look up a lot of data
18907 for the address once, and then pick out parts of the data later. For example,
18908 you could use a single LDAP lookup to return a string of the form
18909 .code
18910 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18911 .endd
18912 In the transport you could pick out the mailbox by a setting such as
18913 .code
18914 file = ${extract{mailbox}{$address_data}}
18915 .endd
18916 This makes the configuration file less messy, and also reduces the number of
18917 lookups (though Exim does cache lookups).
18918
18919 See also the &%set%& option below.
18920
18921 .vindex "&$sender_address_data$&"
18922 .vindex "&$address_data$&"
18923 The &%address_data%& facility is also useful as a means of passing information
18924 from one router to another, and from a router to a transport. In addition, if
18925 &$address_data$& is set by a router when verifying a recipient address from an
18926 ACL, it remains available for use in the rest of the ACL statement. After
18927 verifying a sender, the value is transferred to &$sender_address_data$&.
18928
18929
18930
18931 .option address_test routers&!? boolean true
18932 .oindex "&%-bt%&"
18933 .cindex "router" "skipping when address testing"
18934 If this option is set false, the router is skipped when routing is being tested
18935 by means of the &%-bt%& command line option. This can be a convenience when
18936 your first router sends messages to an external scanner, because it saves you
18937 having to set the &"already scanned"& indicator when testing real address
18938 routing.
18939
18940
18941
18942 .option cannot_route_message routers string&!! unset
18943 .cindex "router" "customizing &""cannot route""& message"
18944 .cindex "customizing" "&""cannot route""& message"
18945 This option specifies a text message that is used when an address cannot be
18946 routed because Exim has run out of routers. The default message is
18947 &"Unrouteable address"&. This option is useful only on routers that have
18948 &%more%& set false, or on the very last router in a configuration, because the
18949 value that is used is taken from the last router that is considered. This
18950 includes a router that is skipped because its preconditions are not met, as
18951 well as a router that declines. For example, using the default configuration,
18952 you could put:
18953 .code
18954 cannot_route_message = Remote domain not found in DNS
18955 .endd
18956 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18957 and
18958 .code
18959 cannot_route_message = Unknown local user
18960 .endd
18961 on the final router that checks for local users. If string expansion fails for
18962 this option, the default message is used. Unless the expansion failure was
18963 explicitly forced, a message about the failure is written to the main and panic
18964 logs, in addition to the normal message about the routing failure.
18965
18966
18967 .option caseful_local_part routers boolean false
18968 .cindex "case of local parts"
18969 .cindex "router" "case of local parts"
18970 By default, routers handle the local parts of addresses in a case-insensitive
18971 manner, though the actual case is preserved for transmission with the message.
18972 If you want the case of letters to be significant in a router, you must set
18973 this option true. For individual router options that contain address or local
18974 part lists (for example, &%local_parts%&), case-sensitive matching can be
18975 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18976 more details.
18977
18978 .vindex "&$local_part$&"
18979 .vindex "&$original_local_part$&"
18980 .vindex "&$parent_local_part$&"
18981 The value of the &$local_part$& variable is forced to lower case while a
18982 router is running unless &%caseful_local_part%& is set. When a router assigns
18983 an address to a transport, the value of &$local_part$& when the transport runs
18984 is the same as it was in the router. Similarly, when a router generates child
18985 addresses by aliasing or forwarding, the values of &$original_local_part$&
18986 and &$parent_local_part$& are those that were used by the redirecting router.
18987
18988 This option applies to the processing of an address by a router. When a
18989 recipient address is being processed in an ACL, there is a separate &%control%&
18990 modifier that can be used to specify case-sensitive processing within the ACL
18991 (see section &<<SECTcontrols>>&).
18992
18993
18994
18995 .option check_local_user routers&!? boolean false
18996 .cindex "local user, checking in router"
18997 .cindex "router" "checking for local user"
18998 .cindex "&_/etc/passwd_&"
18999 .vindex "&$home$&"
19000 When this option is true, Exim checks that the local part of the recipient
19001 address (with affixes removed if relevant) is the name of an account on the
19002 local system. The check is done by calling the &[getpwnam()]& function rather
19003 than trying to read &_/etc/passwd_& directly. This means that other methods of
19004 holding password data (such as NIS) are supported. If the local part is a local
19005 user,
19006 .cindex "tainted data" "de-tainting"
19007 .cindex "de-tainting" "using router check_local_user option"
19008 &$local_part_data$& is set to an untainted version of the local part and
19009 &$home$& is set from the password data. The latter can be tested in other
19010 preconditions that are evaluated after this one (the order of evaluation is
19011 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
19012 overridden by &%router_home_directory%&. If the local part is not a local user,
19013 the router is skipped.
19014
19015 If you want to check that the local part is either the name of a local user
19016 or matches something else, you cannot combine &%check_local_user%& with a
19017 setting of &%local_parts%&, because that specifies the logical &'and'& of the
19018 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
19019 setting to achieve this. For example:
19020 .code
19021 local_parts = passwd;$local_part : lsearch;/etc/other/users
19022 .endd
19023 Note, however, that the side effects of &%check_local_user%& (such as setting
19024 up a home directory) do not occur when a &(passwd)& lookup is used in a
19025 &%local_parts%& (or any other) precondition.
19026
19027
19028
19029 .option condition routers&!? string&!! unset
19030 .cindex "router" "customized precondition"
19031 This option specifies a general precondition test that has to succeed for the
19032 router to be called. The &%condition%& option is the last precondition to be
19033 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
19034 result is a forced failure, or an empty string, or one of the strings &"0"& or
19035 &"no"& or &"false"& (checked without regard to the case of the letters), the
19036 router is skipped, and the address is offered to the next one.
19037
19038 If the result is any other value, the router is run (as this is the last
19039 precondition to be evaluated, all the other preconditions must be true).
19040
19041 This option is unusual in that multiple &%condition%& options may be present.
19042 All &%condition%& options must succeed.
19043
19044 The &%condition%& option provides a means of applying custom conditions to the
19045 running of routers. Note that in the case of a simple conditional expansion,
19046 the default expansion values are exactly what is wanted. For example:
19047 .code
19048 condition = ${if >{$message_age}{600}}
19049 .endd
19050 Because of the default behaviour of the string expansion, this is equivalent to
19051 .code
19052 condition = ${if >{$message_age}{600}{true}{}}
19053 .endd
19054
19055 A multiple condition example, which succeeds:
19056 .code
19057 condition = ${if >{$message_age}{600}}
19058 condition = ${if !eq{${lc:$local_part}}{postmaster}}
19059 condition = foobar
19060 .endd
19061
19062 If the expansion fails (other than forced failure) delivery is deferred. Some
19063 of the other precondition options are common special cases that could in fact
19064 be specified using &%condition%&.
19065
19066 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
19067 are far older, and use one set of semantics.  ACLs are newer and when
19068 they were created, the ACL &%condition%& process was given far stricter
19069 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
19070 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
19071 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19072 Router rules processing behavior.
19073
19074 This is best illustrated in an example:
19075 .code
19076 # If used in an ACL condition will fail with a syntax error, but
19077 # in a router condition any extra characters are treated as a string
19078
19079 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19080 true {yes} {no}}
19081
19082 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19083  {yes} {no}}
19084 .endd
19085 In each example above, the &%if%& statement actually ends after
19086 &"{google.com}}"&.  Since no true or false braces were defined, the
19087 default &%if%& behavior is to return a boolean true or a null answer
19088 (which evaluates to false). The rest of the line is then treated as a
19089 string. So the first example resulted in the boolean answer &"true"&
19090 with the string &" {yes} {no}}"& appended to it. The second example
19091 resulted in the null output (indicating false) with the string
19092 &" {yes} {no}}"& appended to it.
19093
19094 In fact you can put excess forward braces in too.  In the router
19095 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19096 mean something, like after a &"$"& or when required as part of a
19097 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19098 string characters.
19099
19100 Thus, in a Router, the above expansion strings will both always evaluate
19101 true, as the result of expansion is a non-empty string which doesn't
19102 match an explicit false value.  This can be tricky to debug.  By
19103 contrast, in an ACL either of those strings will always result in an
19104 expansion error because the result doesn't look sufficiently boolean.
19105
19106
19107 .option debug_print routers string&!! unset
19108 .cindex "testing" "variables in drivers"
19109 If this option is set and debugging is enabled (see the &%-d%& command line
19110 option) or in address-testing mode (see the &%-bt%& command line option),
19111 the string is expanded and included in the debugging output.
19112 If expansion of the string fails, the error message is written to the debugging
19113 output, and Exim carries on processing.
19114 This option is provided to help with checking out the values of variables and
19115 so on when debugging router configurations. For example, if a &%condition%&
19116 option appears not to be working, &%debug_print%& can be used to output the
19117 variables it references. The output happens after checks for &%domains%&,
19118 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19119 are tested. A newline is added to the text if it does not end with one.
19120 The variable &$router_name$& contains the name of the router.
19121
19122
19123
19124 .option disable_logging routers boolean false
19125 If this option is set true, nothing is logged for any routing errors
19126 or for any deliveries caused by this router. You should not set this option
19127 unless you really, really know what you are doing. See also the generic
19128 transport option of the same name.
19129
19130 .option dnssec_request_domains routers "domain list&!!" *
19131 .cindex "MX record" "security"
19132 .cindex "DNSSEC" "MX lookup"
19133 .cindex "security" "MX lookup"
19134 .cindex "DNS" "DNSSEC"
19135 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19136 the DNSSEC request bit set.
19137 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19138
19139 .option dnssec_require_domains routers "domain list&!!" unset
19140 .cindex "MX record" "security"
19141 .cindex "DNSSEC" "MX lookup"
19142 .cindex "security" "MX lookup"
19143 .cindex "DNS" "DNSSEC"
19144 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19145 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19146 (AD bit) set will be ignored and logged as a host-lookup failure.
19147 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19148
19149
19150 .option domains routers&!? "domain list&!!" unset
19151 .cindex "router" "restricting to specific domains"
19152 .vindex "&$domain_data$&"
19153 If this option is set, the router is skipped unless the current domain matches
19154 the list.
19155 The data returned by the list check
19156 is placed in &$domain_data$& for use in string
19157 expansions of the driver's private options and in the transport.
19158 See section &<<SECTrouprecon>>& for
19159 a list of the order in which preconditions are evaluated.
19160
19161 A complex example, using a file like:
19162 .code
19163 alice@dom1
19164 bill@dom1
19165 maggie@dom1
19166 .endd
19167 and checking both domain and local_part
19168 .code
19169 domains =         ${domain:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19170 local_parts = ${local_part:${lookup {$local_part@$domain} lseach,ret=key {/path/to/accountsfile}}}
19171 .endd
19172
19173
19174
19175 .option driver routers string unset
19176 This option must always be set. It specifies which of the available routers is
19177 to be used.
19178
19179
19180 .option dsn_lasthop routers boolean false
19181 .cindex "DSN" "success"
19182 .cindex "Delivery Status Notification" "success"
19183 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19184 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19185 instead send a success DSN as if the next hop does not support DSN.
19186 Not effective on redirect routers.
19187
19188
19189
19190 .option errors_to routers string&!! unset
19191 .cindex "envelope from"
19192 .cindex "envelope sender"
19193 .cindex "router" "changing address for errors"
19194 If a router successfully handles an address, it may assign the address to a
19195 transport for delivery or it may generate child addresses. In both cases, if
19196 there is a delivery problem during later processing, the resulting bounce
19197 message is sent to the address that results from expanding this string,
19198 provided that the address verifies successfully. The &%errors_to%& option is
19199 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19200
19201 The &%errors_to%& setting associated with an address can be overridden if it
19202 subsequently passes through other routers that have their own &%errors_to%&
19203 settings, or if the message is delivered by a transport with a &%return_path%&
19204 setting.
19205
19206 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19207 the expansion fails to verify, the errors address associated with the incoming
19208 address is used. At top level, this is the envelope sender. A non-forced
19209 expansion failure causes delivery to be deferred.
19210
19211 If an address for which &%errors_to%& has been set ends up being delivered over
19212 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19213 any bounces that are generated by other MTAs on the delivery route are also
19214 sent there. You can set &%errors_to%& to the empty string by either of these
19215 settings:
19216 .code
19217 errors_to =
19218 errors_to = ""
19219 .endd
19220 An expansion item that yields an empty string has the same effect. If you do
19221 this, a locally detected delivery error for addresses processed by this router
19222 no longer gives rise to a bounce message; the error is discarded. If the
19223 address is delivered to a remote host, the return path is set to &`<>`&, unless
19224 overridden by the &%return_path%& option on the transport.
19225
19226 .vindex "&$address_data$&"
19227 If for some reason you want to discard local errors, but use a non-empty
19228 MAIL command for remote delivery, you can preserve the original return
19229 path in &$address_data$& in the router, and reinstate it in the transport by
19230 setting &%return_path%&.
19231
19232 The most common use of &%errors_to%& is to direct mailing list bounces to the
19233 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19234 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19235
19236
19237
19238 .option expn routers&!? boolean true
19239 .cindex "address" "testing"
19240 .cindex "testing" "addresses"
19241 .cindex "EXPN" "router skipping"
19242 .cindex "router" "skipping for EXPN"
19243 If this option is turned off, the router is skipped when testing an address
19244 as a result of processing an SMTP EXPN command. You might, for example,
19245 want to turn it off on a router for users' &_.forward_& files, while leaving it
19246 on for the system alias file.
19247 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19248 are evaluated.
19249
19250 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19251 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19252 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19253
19254
19255
19256 .option fail_verify routers boolean false
19257 .cindex "router" "forcing verification failure"
19258 Setting this option has the effect of setting both &%fail_verify_sender%& and
19259 &%fail_verify_recipient%& to the same value.
19260
19261
19262
19263 .option fail_verify_recipient routers boolean false
19264 If this option is true and an address is accepted by this router when
19265 verifying a recipient, verification fails.
19266
19267
19268
19269 .option fail_verify_sender routers boolean false
19270 If this option is true and an address is accepted by this router when
19271 verifying a sender, verification fails.
19272
19273
19274
19275 .option fallback_hosts routers "string list" unset
19276 .cindex "router" "fallback hosts"
19277 .cindex "fallback" "hosts specified on router"
19278 String expansion is not applied to this option. The argument must be a
19279 colon-separated list of host names or IP addresses. The list separator can be
19280 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19281 each name or address. In fact, the format of each item is exactly the same as
19282 defined for the list of hosts in a &(manualroute)& router (see section
19283 &<<SECTformatonehostitem>>&).
19284
19285 If a router queues an address for a remote transport, this host list is
19286 associated with the address, and used instead of the transport's fallback host
19287 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19288 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19289 transport for further details.
19290
19291
19292 .option group routers string&!! "see below"
19293 .cindex "gid (group id)" "local delivery"
19294 .cindex "local transports" "uid and gid"
19295 .cindex "transport" "local"
19296 .cindex "router" "setting group"
19297 When a router queues an address for a transport, and the transport does not
19298 specify a group, the group given here is used when running the delivery
19299 process.
19300 The group may be specified numerically or by name. If expansion fails, the
19301 error is logged and delivery is deferred.
19302 The default is unset, unless &%check_local_user%& is set, when the default
19303 is taken from the password information. See also &%initgroups%& and &%user%&
19304 and the discussion in chapter &<<CHAPenvironment>>&.
19305
19306
19307
19308 .option headers_add routers list&!! unset
19309 .cindex "header lines" "adding"
19310 .cindex "router" "adding header lines"
19311 This option specifies a list of text headers,
19312 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19313 that is associated with any addresses that are accepted by the router.
19314 Each item is separately expanded, at routing time.  However, this
19315 option has no effect when an address is just being verified. The way in which
19316 the text is used to add header lines at transport time is described in section
19317 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19318 message is in the process of being transported. This means that references to
19319 header lines in string expansions in the transport's configuration do not
19320 &"see"& the added header lines.
19321
19322 The &%headers_add%& option is expanded after &%errors_to%&, but before
19323 &%headers_remove%& and &%transport%&. If an item is empty, or if
19324 an item expansion is forced to fail, the item has no effect. Other expansion
19325 failures are treated as configuration errors.
19326
19327 Unlike most options, &%headers_add%& can be specified multiple times
19328 for a router; all listed headers are added.
19329
19330 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19331 router that has the &%one_time%& option set.
19332
19333 .cindex "duplicate addresses"
19334 .oindex "&%unseen%&"
19335 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19336 additions are deleted when the address is passed on to subsequent routers.
19337 For a &%redirect%& router, if a generated address is the same as the incoming
19338 address, this can lead to duplicate addresses with different header
19339 modifications. Exim does not do duplicate deliveries (except, in certain
19340 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19341 which of the duplicates is discarded, so this ambiguous situation should be
19342 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19343
19344
19345
19346 .option headers_remove routers list&!! unset
19347 .cindex "header lines" "removing"
19348 .cindex "router" "removing header lines"
19349 This option specifies a list of text headers,
19350 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19351 that is associated with any addresses that are accepted by the router.
19352 However, the option has no effect when an address is just being verified.
19353 Each list item is separately expanded, at transport time.
19354 If an item ends in *, it will match any header with the given prefix.
19355 The way in which
19356 the text is used to remove header lines at transport time is described in
19357 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19358 the message is in the process of being transported. This means that references
19359 to header lines in string expansions in the transport's configuration still
19360 &"see"& the original header lines.
19361
19362 The &%headers_remove%& option is handled after &%errors_to%& and
19363 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19364 the item has no effect. Other expansion failures are treated as configuration
19365 errors.
19366
19367 Unlike most options, &%headers_remove%& can be specified multiple times
19368 for a router; all listed headers are removed.
19369
19370 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19371 router that has the &%one_time%& option set.
19372
19373 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19374 removal requests are deleted when the address is passed on to subsequent
19375 routers, and this can lead to problems with duplicates -- see the similar
19376 warning for &%headers_add%& above.
19377
19378 &*Warning 3*&: Because of the separate expansion of the list items,
19379 items that contain a list separator must have it doubled.
19380 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19381
19382
19383
19384 .option ignore_target_hosts routers "host list&!!" unset
19385 .cindex "IP address" "discarding"
19386 .cindex "router" "discarding IP addresses"
19387 Although this option is a host list, it should normally contain IP address
19388 entries rather than names. If any host that is looked up by the router has an
19389 IP address that matches an item in this list, Exim behaves as if that IP
19390 address did not exist. This option allows you to cope with rogue DNS entries
19391 like
19392 .code
19393 remote.domain.example.  A  127.0.0.1
19394 .endd
19395 by setting
19396 .code
19397 ignore_target_hosts = 127.0.0.1
19398 .endd
19399 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19400 discarded in this way, the router declines. In a conventional configuration, an
19401 attempt to mail to such a domain would normally provoke the &"unrouteable
19402 domain"& error, and an attempt to verify an address in the domain would fail.
19403 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19404 router declines if presented with one of the listed addresses.
19405
19406 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19407 means of the first or the second of the following settings, respectively:
19408 .code
19409 ignore_target_hosts = 0.0.0.0/0
19410 ignore_target_hosts = <; 0::0/0
19411 .endd
19412 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19413 in the second line matches all IPv6 addresses.
19414
19415 This option may also be useful for ignoring link-local and site-local IPv6
19416 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19417 is expanded before use as a list, it is possible to make it dependent on the
19418 domain that is being routed.
19419
19420 .vindex "&$host_address$&"
19421 During its expansion, &$host_address$& is set to the IP address that is being
19422 checked.
19423
19424 .option initgroups routers boolean false
19425 .cindex "additional groups"
19426 .cindex "groups" "additional"
19427 .cindex "local transports" "uid and gid"
19428 .cindex "transport" "local"
19429 If the router queues an address for a transport, and this option is true, and
19430 the uid supplied by the router is not overridden by the transport, the
19431 &[initgroups()]& function is called when running the transport to ensure that
19432 any additional groups associated with the uid are set up. See also &%group%&
19433 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19434
19435
19436
19437 .option local_part_prefix routers&!? "string list" unset
19438 .cindex affix "router precondition"
19439 .cindex "router" "prefix for local part"
19440 .cindex "prefix" "for local part, used in router"
19441 If this option is set, the router is skipped unless the local part starts with
19442 one of the given strings, or &%local_part_prefix_optional%& is true. See
19443 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19444 evaluated.
19445
19446 The list is scanned from left to right, and the first prefix that matches is
19447 used. A limited form of wildcard is available; if the prefix begins with an
19448 asterisk, it matches the longest possible sequence of arbitrary characters at
19449 the start of the local part. An asterisk should therefore always be followed by
19450 some character that does not occur in normal local parts.
19451 .cindex "multiple mailboxes"
19452 .cindex "mailbox" "multiple"
19453 Wildcarding can be used to set up multiple user mailboxes, as described in
19454 section &<<SECTmulbox>>&.
19455
19456 .vindex "&$local_part$&"
19457 .vindex "&$local_part_prefix$&"
19458 During the testing of the &%local_parts%& option, and while the router is
19459 running, the prefix is removed from the local part, and is available in the
19460 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19461 the router accepts the address, this remains true during subsequent delivery by
19462 a transport. In particular, the local part that is transmitted in the RCPT
19463 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19464 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19465 the relevant transport.
19466
19467 .vindex &$local_part_prefix_v$&
19468 If wildcarding (above) was used then the part of the prefix matching the
19469 wildcard is available in &$local_part_prefix_v$&.
19470
19471 When an address is being verified, &%local_part_prefix%& affects only the
19472 behaviour of the router. If the callout feature of verification is in use, this
19473 means that the full address, including the prefix, will be used during the
19474 callout.
19475
19476 The prefix facility is commonly used to handle local parts of the form
19477 &%owner-something%&. Another common use is to support local parts of the form
19478 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19479 to tell a user their forwarding is broken &-- by placing a router like this one
19480 immediately before the router that handles &_.forward_& files:
19481 .code
19482 real_localuser:
19483   driver = accept
19484   local_part_prefix = real-
19485   check_local_user
19486   transport = local_delivery
19487 .endd
19488 For security, it would probably be a good idea to restrict the use of this
19489 router to locally-generated messages, using a condition such as this:
19490 .code
19491   condition = ${if match {$sender_host_address}\
19492                          {\N^(|127\.0\.0\.1)$\N}}
19493 .endd
19494
19495 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19496 both conditions must be met if not optional. Care must be taken if wildcards
19497 are used in both a prefix and a suffix on the same router. Different
19498 separator characters must be used to avoid ambiguity.
19499
19500
19501 .option local_part_prefix_optional routers boolean false
19502 See &%local_part_prefix%& above.
19503
19504
19505
19506 .option local_part_suffix routers&!? "string list" unset
19507 .cindex "router" "suffix for local part"
19508 .cindex "suffix for local part" "used in router"
19509 This option operates in the same way as &%local_part_prefix%&, except that the
19510 local part must end (rather than start) with the given string, the
19511 &%local_part_suffix_optional%& option determines whether the suffix is
19512 mandatory, and the wildcard * character, if present, must be the last
19513 character of the suffix. This option facility is commonly used to handle local
19514 parts of the form &%something-request%& and multiple user mailboxes of the form
19515 &%username-foo%&.
19516
19517
19518 .option local_part_suffix_optional routers boolean false
19519 See &%local_part_suffix%& above.
19520
19521
19522
19523 .option local_parts routers&!? "local part list&!!" unset
19524 .cindex "router" "restricting to specific local parts"
19525 .cindex "local part" "checking in router"
19526 The router is run only if the local part of the address matches the list.
19527 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19528 are evaluated, and
19529 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19530 string is expanded, it is possible to make it depend on the domain, for
19531 example:
19532 .code
19533 local_parts = dbm;/usr/local/specials/$domain_data
19534 .endd
19535 .vindex "&$local_part_data$&"
19536 the data returned by the list check
19537 for the local part is placed in the variable &$local_part_data$& for use in
19538 expansions of the router's private options or in the transport.
19539 You might use this option, for
19540 example, if you have a large number of local virtual domains, and you want to
19541 send all postmaster mail to the same place without having to set up an alias in
19542 each virtual domain:
19543 .code
19544 postmaster:
19545   driver = redirect
19546   local_parts = postmaster
19547   data = postmaster@real.domain.example
19548 .endd
19549
19550
19551 .option log_as_local routers boolean "see below"
19552 .cindex "log" "delivery line"
19553 .cindex "delivery" "log line format"
19554 Exim has two logging styles for delivery, the idea being to make local
19555 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19556 recipient address is given just as the local part, without a domain. The use of
19557 this style is controlled by this option. It defaults to true for the &(accept)&
19558 router, and false for all the others. This option applies only when a
19559 router assigns an address to a transport. It has no effect on routers that
19560 redirect addresses.
19561
19562
19563
19564 .option more routers boolean&!! true
19565 The result of string expansion for this option must be a valid boolean value,
19566 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19567 result causes an error, and delivery is deferred. If the expansion is forced to
19568 fail, the default value for the option (true) is used. Other failures cause
19569 delivery to be deferred.
19570
19571 If this option is set false, and the router declines to handle the address, no
19572 further routers are tried, routing fails, and the address is bounced.
19573 .oindex "&%self%&"
19574 However, if the router explicitly passes an address to the following router by
19575 means of the setting
19576 .code
19577 self = pass
19578 .endd
19579 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19580 does not affect the behaviour if one of the precondition tests fails. In that
19581 case, the address is always passed to the next router.
19582
19583 Note that &%address_data%& is not considered to be a precondition. If its
19584 expansion is forced to fail, the router declines, and the value of &%more%&
19585 controls what happens next.
19586
19587
19588 .option pass_on_timeout routers boolean false
19589 .cindex "timeout" "of router"
19590 .cindex "router" "timeout"
19591 If a router times out during a host lookup, it normally causes deferral of the
19592 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19593 router, overriding &%no_more%&. This may be helpful for systems that are
19594 intermittently connected to the Internet, or those that want to pass to a smart
19595 host any messages that cannot immediately be delivered.
19596
19597 There are occasional other temporary errors that can occur while doing DNS
19598 lookups. They are treated in the same way as a timeout, and this option
19599 applies to all of them.
19600
19601
19602
19603 .option pass_router routers string unset
19604 .cindex "router" "go to after &""pass""&"
19605 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19606 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19607 routing to continue, and overriding a false setting of &%more%&. When one of
19608 these routers returns &"pass"&, the address is normally handed on to the next
19609 router in sequence. This can be changed by setting &%pass_router%& to the name
19610 of another router. However (unlike &%redirect_router%&) the named router must
19611 be below the current router, to avoid loops. Note that this option applies only
19612 to the special case of &"pass"&. It does not apply when a router returns
19613 &"decline"& because it cannot handle an address.
19614
19615
19616
19617 .option redirect_router routers string unset
19618 .cindex "router" "start at after redirection"
19619 Sometimes an administrator knows that it is pointless to reprocess addresses
19620 generated from alias or forward files with the same router again. For
19621 example, if an alias file translates real names into login ids there is no
19622 point searching the alias file a second time, especially if it is a large file.
19623
19624 The &%redirect_router%& option can be set to the name of any router instance.
19625 It causes the routing of any generated addresses to start at the named router
19626 instead of at the first router. This option has no effect if the router in
19627 which it is set does not generate new addresses.
19628
19629
19630
19631 .option require_files routers&!? "string list&!!" unset
19632 .cindex "file" "requiring for router"
19633 .cindex "router" "requiring file existence"
19634 This option provides a general mechanism for predicating the running of a
19635 router on the existence or non-existence of certain files or directories.
19636 Before running a router, as one of its precondition tests, Exim works its way
19637 through the &%require_files%& list, expanding each item separately.
19638
19639 Because the list is split before expansion, any colons in expansion items must
19640 be doubled, or the facility for using a different list separator must be used
19641 (&<<SECTlistsepchange>>&).
19642 If any expansion is forced to fail, the item is ignored. Other expansion
19643 failures cause routing of the address to be deferred.
19644
19645 If any expanded string is empty, it is ignored. Otherwise, except as described
19646 below, each string must be a fully qualified file path, optionally preceded by
19647 &"!"&. The paths are passed to the &[stat()]& function to test for the
19648 existence of the files or directories. The router is skipped if any paths not
19649 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19650
19651 .cindex "NFS"
19652 If &[stat()]& cannot determine whether a file exists or not, delivery of
19653 the message is deferred. This can happen when NFS-mounted filesystems are
19654 unavailable.
19655
19656 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19657 options, so you cannot use it to check for the existence of a file in which to
19658 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19659 full list of the order in which preconditions are evaluated.) However, as
19660 these options are all expanded, you can use the &%exists%& expansion condition
19661 to make such tests. The &%require_files%& option is intended for checking files
19662 that the router may be going to use internally, or which are needed by a
19663 transport (e.g., &_.procmailrc_&).
19664
19665 During delivery, the &[stat()]& function is run as root, but there is a
19666 facility for some checking of the accessibility of a file by another user.
19667 This is not a proper permissions check, but just a &"rough"& check that
19668 operates as follows:
19669
19670 If an item in a &%require_files%& list does not contain any forward slash
19671 characters, it is taken to be the user (and optional group, separated by a
19672 comma) to be checked for subsequent files in the list. If no group is specified
19673 but the user is specified symbolically, the gid associated with the uid is
19674 used. For example:
19675 .code
19676 require_files = mail:/some/file
19677 require_files = $local_part_data:$home/.procmailrc
19678 .endd
19679 If a user or group name in a &%require_files%& list does not exist, the
19680 &%require_files%& condition fails.
19681
19682 Exim performs the check by scanning along the components of the file path, and
19683 checking the access for the given uid and gid. It checks for &"x"& access on
19684 directories, and &"r"& access on the final file. Note that this means that file
19685 access control lists, if the operating system has them, are ignored.
19686
19687 &*Warning 1*&: When the router is being run to verify addresses for an
19688 incoming SMTP message, Exim is not running as root, but under its own uid. This
19689 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19690 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19691 user is not permitted to read one of the directories on the file's path.
19692
19693 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19694 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19695 without root access. In this case, if a check for access by a particular user
19696 is requested, Exim creates a subprocess that runs as that user, and tries the
19697 check again in that process.
19698
19699 The default action for handling an unresolved EACCES is to consider it to
19700 be caused by a configuration error, and routing is deferred because the
19701 existence or non-existence of the file cannot be determined. However, in some
19702 circumstances it may be desirable to treat this condition as if the file did
19703 not exist. If the filename (or the exclamation mark that precedes the filename
19704 for non-existence) is preceded by a plus sign, the EACCES error is treated
19705 as if the file did not exist. For example:
19706 .code
19707 require_files = +/some/file
19708 .endd
19709 If the router is not an essential part of verification (for example, it
19710 handles users' &_.forward_& files), another solution is to set the &%verify%&
19711 option false so that the router is skipped when verifying.
19712
19713
19714
19715 .option retry_use_local_part routers boolean "see below"
19716 .cindex "hints database" "retry keys"
19717 .cindex "local part" "in retry keys"
19718 When a delivery suffers a temporary routing failure, a retry record is created
19719 in Exim's hints database. For addresses whose routing depends only on the
19720 domain, the key for the retry record should not involve the local part, but for
19721 other addresses, both the domain and the local part should be included.
19722 Usually, remote routing is of the former kind, and local routing is of the
19723 latter kind.
19724
19725 This option controls whether the local part is used to form the key for retry
19726 hints for addresses that suffer temporary errors while being handled by this
19727 router. The default value is true for any router that has any of
19728 &%check_local_user%&,
19729 &%local_parts%&,
19730 &%condition%&,
19731 &%local_part_prefix%&,
19732 &%local_part_suffix%&,
19733 &%senders%& or
19734 &%require_files%&
19735 set, and false otherwise. Note that this option does not apply to hints keys
19736 for transport delays; they are controlled by a generic transport option of the
19737 same name.
19738
19739 Failing to set this option when it is needed
19740 (because a remote router handles only some of the local-parts for a domain)
19741 can result in incorrect error messages being generated.
19742
19743 The setting of &%retry_use_local_part%& applies only to the router on which it
19744 appears. If the router generates child addresses, they are routed
19745 independently; this setting does not become attached to them.
19746
19747
19748
19749 .option router_home_directory routers string&!! unset
19750 .cindex "router" "home directory for"
19751 .cindex "home directory" "for router"
19752 .vindex "&$home$&"
19753 This option sets a home directory for use while the router is running. (Compare
19754 &%transport_home_directory%&, which sets a home directory for later
19755 transporting.) In particular, if used on a &(redirect)& router, this option
19756 sets a value for &$home$& while a filter is running. The value is expanded;
19757 forced expansion failure causes the option to be ignored &-- other failures
19758 cause the router to defer.
19759
19760 Expansion of &%router_home_directory%& happens immediately after the
19761 &%check_local_user%& test (if configured), before any further expansions take
19762 place.
19763 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19764 are evaluated.)
19765 While the router is running, &%router_home_directory%& overrides the value of
19766 &$home$& that came from &%check_local_user%&.
19767
19768 When a router accepts an address and assigns it to a local transport (including
19769 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19770 delivery), the home directory setting for the transport is taken from the first
19771 of these values that is set:
19772
19773 .ilist
19774 The &%home_directory%& option on the transport;
19775 .next
19776 The &%transport_home_directory%& option on the router;
19777 .next
19778 The password data if &%check_local_user%& is set on the router;
19779 .next
19780 The &%router_home_directory%& option on the router.
19781 .endlist
19782
19783 In other words, &%router_home_directory%& overrides the password data for the
19784 router, but not for the transport.
19785
19786
19787
19788 .option self routers string freeze
19789 .cindex "MX record" "pointing to local host"
19790 .cindex "local host" "MX pointing to"
19791 This option applies to those routers that use a recipient address to find a
19792 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19793 and &(manualroute)& routers.
19794 Certain configurations of the &(queryprogram)& router can also specify a list
19795 of remote hosts.
19796 Usually such routers are configured to send the message to a remote host via an
19797 &(smtp)& transport. The &%self%& option specifies what happens when the first
19798 host on the list turns out to be the local host.
19799 The way in which Exim checks for the local host is described in section
19800 &<<SECTreclocipadd>>&.
19801
19802 Normally this situation indicates either an error in Exim's configuration (for
19803 example, the router should be configured not to process this domain), or an
19804 error in the DNS (for example, the MX should not point to this host). For this
19805 reason, the default action is to log the incident, defer the address, and
19806 freeze the message. The following alternatives are provided for use in special
19807 cases:
19808
19809 .vlist
19810 .vitem &%defer%&
19811 Delivery of the message is tried again later, but the message is not frozen.
19812
19813 .vitem "&%reroute%&: <&'domain'&>"
19814 The domain is changed to the given domain, and the address is passed back to
19815 be reprocessed by the routers. No rewriting of headers takes place. This
19816 behaviour is essentially a redirection.
19817
19818 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19819 The domain is changed to the given domain, and the address is passed back to be
19820 reprocessed by the routers. Any headers that contain the original domain are
19821 rewritten.
19822
19823 .vitem &%pass%&
19824 .oindex "&%more%&"
19825 .vindex "&$self_hostname$&"
19826 The router passes the address to the next router, or to the router named in the
19827 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19828 subsequent routing and delivery, the variable &$self_hostname$& contains the
19829 name of the local host that the router encountered. This can be used to
19830 distinguish between different cases for hosts with multiple names. The
19831 combination
19832 .code
19833 self = pass
19834 no_more
19835 .endd
19836 ensures that only those addresses that routed to the local host are passed on.
19837 Without &%no_more%&, addresses that were declined for other reasons would also
19838 be passed to the next router.
19839
19840 .vitem &%fail%&
19841 Delivery fails and an error report is generated.
19842
19843 .vitem &%send%&
19844 .cindex "local host" "sending to"
19845 The anomaly is ignored and the address is queued for the transport. This
19846 setting should be used with extreme caution. For an &(smtp)& transport, it
19847 makes sense only in cases where the program that is listening on the SMTP port
19848 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19849 different configuration file that handles the domain in another way.
19850 .endlist
19851
19852
19853
19854 .option senders routers&!? "address list&!!" unset
19855 .cindex "router" "checking senders"
19856 If this option is set, the router is skipped unless the message's sender
19857 address matches something on the list.
19858 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19859 are evaluated.
19860
19861 There are issues concerning verification when the running of routers is
19862 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19863 setting, it sets the sender to the null string. When using the &%-bt%& option
19864 to check a configuration file, it is necessary also to use the &%-f%& option to
19865 set an appropriate sender. For incoming mail, the sender is unset when
19866 verifying the sender, but is available when verifying any recipients. If the
19867 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19868 matters.
19869
19870
19871 .option set routers "string list" unset
19872 .cindex router variables
19873 This option may be used multiple times on a router;
19874 because of this the list aspect is mostly irrelevant.
19875 The list separator is a semicolon but can be changed in the
19876 usual way.
19877
19878 Each list-element given must be of the form &"name = value"&
19879 and the names used must start with the string &"r_"&.
19880 Values containing a list-separator should have them doubled.
19881 When a router runs, the strings are evaluated in order,
19882 to create variables which are added to the set associated with
19883 the address.
19884 This is done immediately after all the preconditions, before the
19885 evaluation of the &%address_data%& option.
19886 The variable is set with the expansion of the value.
19887 The variables can be used by the router options
19888 (not including any preconditions)
19889 and by the transport.
19890 Later definitions of a given named variable will override former ones.
19891 Variable use is via the usual &$r_...$& syntax.
19892
19893 This is similar to the &%address_data%& option, except that
19894 many independent variables can be used, with choice of naming.
19895
19896
19897 .option translate_ip_address routers string&!! unset
19898 .cindex "IP address" "translating"
19899 .cindex "packet radio"
19900 .cindex "router" "IP address translation"
19901 There exist some rare networking situations (for example, packet radio) where
19902 it is helpful to be able to translate IP addresses generated by normal routing
19903 mechanisms into other IP addresses, thus performing a kind of manual IP
19904 routing. This should be done only if the normal IP routing of the TCP/IP stack
19905 is inadequate or broken. Because this is an extremely uncommon requirement, the
19906 code to support this option is not included in the Exim binary unless
19907 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19908
19909 .vindex "&$host_address$&"
19910 The &%translate_ip_address%& string is expanded for every IP address generated
19911 by the router, with the generated address set in &$host_address$&. If the
19912 expansion is forced to fail, no action is taken.
19913 For any other expansion error, delivery of the message is deferred.
19914 If the result of the expansion is an IP address, that replaces the original
19915 address; otherwise the result is assumed to be a host name &-- this is looked
19916 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19917 produce one or more replacement IP addresses. For example, to subvert all IP
19918 addresses in some specific networks, this could be added to a router:
19919 .code
19920 translate_ip_address = \
19921   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19922     {$value}fail}}
19923 .endd
19924 The file would contain lines like
19925 .code
19926 10.2.3.128/26    some.host
19927 10.8.4.34/26     10.44.8.15
19928 .endd
19929 You should not make use of this facility unless you really understand what you
19930 are doing.
19931
19932
19933
19934 .option transport routers string&!! unset
19935 This option specifies the transport to be used when a router accepts an address
19936 and sets it up for delivery. A transport is never needed if a router is used
19937 only for verification. The value of the option is expanded at routing time,
19938 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19939 and result must be the name of one of the configured transports. If it is not,
19940 delivery is deferred.
19941
19942 The &%transport%& option is not used by the &(redirect)& router, but it does
19943 have some private options that set up transports for pipe and file deliveries
19944 (see chapter &<<CHAPredirect>>&).
19945
19946
19947
19948 .option transport_current_directory routers string&!! unset
19949 .cindex "current directory for local transport"
19950 This option associates a current directory with any address that is routed
19951 to a local transport. This can happen either because a transport is
19952 explicitly configured for the router, or because it generates a delivery to a
19953 file or a pipe. During the delivery process (that is, at transport time), this
19954 option string is expanded and is set as the current directory, unless
19955 overridden by a setting on the transport.
19956 If the expansion fails for any reason, including forced failure, an error is
19957 logged, and delivery is deferred.
19958 See chapter &<<CHAPenvironment>>& for details of the local delivery
19959 environment.
19960
19961
19962
19963
19964 .option transport_home_directory routers string&!! "see below"
19965 .cindex "home directory" "for local transport"
19966 This option associates a home directory with any address that is routed to a
19967 local transport. This can happen either because a transport is explicitly
19968 configured for the router, or because it generates a delivery to a file or a
19969 pipe. During the delivery process (that is, at transport time), the option
19970 string is expanded and is set as the home directory, unless overridden by a
19971 setting of &%home_directory%& on the transport.
19972 If the expansion fails for any reason, including forced failure, an error is
19973 logged, and delivery is deferred.
19974
19975 If the transport does not specify a home directory, and
19976 &%transport_home_directory%& is not set for the router, the home directory for
19977 the transport is taken from the password data if &%check_local_user%& is set for
19978 the router. Otherwise it is taken from &%router_home_directory%& if that option
19979 is set; if not, no home directory is set for the transport.
19980
19981 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19982 environment.
19983
19984
19985
19986
19987 .option unseen routers boolean&!! false
19988 .cindex "router" "carrying on after success"
19989 The result of string expansion for this option must be a valid boolean value,
19990 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19991 result causes an error, and delivery is deferred. If the expansion is forced to
19992 fail, the default value for the option (false) is used. Other failures cause
19993 delivery to be deferred.
19994
19995 When this option is set true, routing does not cease if the router accepts the
19996 address. Instead, a copy of the incoming address is passed to the next router,
19997 overriding a false setting of &%more%&. There is little point in setting
19998 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19999 the value of &%unseen%& contains expansion items (and therefore, presumably, is
20000 sometimes true and sometimes false).
20001
20002 .cindex "copy of message (&%unseen%& option)"
20003 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
20004 qualifier in filter files. It can be used to cause copies of messages to be
20005 delivered to some other destination, while also carrying out a normal delivery.
20006 In effect, the current address is made into a &"parent"& that has two children
20007 &-- one that is delivered as specified by this router, and a clone that goes on
20008 to be routed further. For this reason, &%unseen%& may not be combined with the
20009 &%one_time%& option in a &(redirect)& router.
20010
20011 &*Warning*&: Header lines added to the address (or specified for removal) by
20012 this router or by previous routers affect the &"unseen"& copy of the message
20013 only. The clone that continues to be processed by further routers starts with
20014 no added headers and none specified for removal. For a &%redirect%& router, if
20015 a generated address is the same as the incoming address, this can lead to
20016 duplicate addresses with different header modifications. Exim does not do
20017 duplicate deliveries (except, in certain circumstances, to pipes -- see section
20018 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
20019 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
20020 &%redirect%& router may be of help.
20021
20022 Unlike the handling of header modifications, any data that was set by the
20023 &%address_data%& option in the current or previous routers &'is'& passed on to
20024 subsequent routers.
20025
20026
20027 .option user routers string&!! "see below"
20028 .cindex "uid (user id)" "local delivery"
20029 .cindex "local transports" "uid and gid"
20030 .cindex "transport" "local"
20031 .cindex "router" "user for filter processing"
20032 .cindex "filter" "user for processing"
20033 When a router queues an address for a transport, and the transport does not
20034 specify a user, the user given here is used when running the delivery process.
20035 The user may be specified numerically or by name. If expansion fails, the
20036 error is logged and delivery is deferred.
20037 This user is also used by the &(redirect)& router when running a filter file.
20038 The default is unset, except when &%check_local_user%& is set. In this case,
20039 the default is taken from the password information. If the user is specified as
20040 a name, and &%group%& is not set, the group associated with the user is used.
20041 See also &%initgroups%& and &%group%& and the discussion in chapter
20042 &<<CHAPenvironment>>&.
20043
20044
20045
20046 .option verify routers&!? boolean true
20047 Setting this option has the effect of setting &%verify_sender%& and
20048 &%verify_recipient%& to the same value.
20049
20050
20051 .option verify_only routers&!? boolean false
20052 .cindex "EXPN" "with &%verify_only%&"
20053 .oindex "&%-bv%&"
20054 .cindex "router" "used only when verifying"
20055 If this option is set, the router is used only when verifying an address,
20056 delivering in cutthrough mode or
20057 testing with the &%-bv%& option, not when actually doing a delivery, testing
20058 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
20059 restricted to verifying only senders or recipients by means of
20060 &%verify_sender%& and &%verify_recipient%&.
20061
20062 &*Warning*&: When the router is being run to verify addresses for an incoming
20063 SMTP message, Exim is not running as root, but under its own uid. If the router
20064 accesses any files, you need to make sure that they are accessible to the Exim
20065 user or group.
20066
20067
20068 .option verify_recipient routers&!? boolean true
20069 If this option is false, the router is skipped when verifying recipient
20070 addresses,
20071 delivering in cutthrough mode
20072 or testing recipient verification using &%-bv%&.
20073 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20074 are evaluated.
20075 See also the &$verify_mode$& variable.
20076
20077
20078 .option verify_sender routers&!? boolean true
20079 If this option is false, the router is skipped when verifying sender addresses
20080 or testing sender verification using &%-bvs%&.
20081 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
20082 are evaluated.
20083 See also the &$verify_mode$& variable.
20084 .ecindex IIDgenoprou1
20085 .ecindex IIDgenoprou2
20086
20087
20088
20089
20090
20091
20092 . ////////////////////////////////////////////////////////////////////////////
20093 . ////////////////////////////////////////////////////////////////////////////
20094
20095 .chapter "The accept router" "CHID4"
20096 .cindex "&(accept)& router"
20097 .cindex "routers" "&(accept)&"
20098 The &(accept)& router has no private options of its own. Unless it is being
20099 used purely for verification (see &%verify_only%&) a transport is required to
20100 be defined by the generic &%transport%& option. If the preconditions that are
20101 specified by generic options are met, the router accepts the address and queues
20102 it for the given transport. The most common use of this router is for setting
20103 up deliveries to local mailboxes. For example:
20104 .code
20105 localusers:
20106   driver = accept
20107   domains = mydomain.example
20108   check_local_user
20109   transport = local_delivery
20110 .endd
20111 The &%domains%& condition in this example checks the domain of the address, and
20112 &%check_local_user%& checks that the local part is the login of a local user.
20113 When both preconditions are met, the &(accept)& router runs, and queues the
20114 address for the &(local_delivery)& transport.
20115
20116
20117
20118
20119
20120
20121 . ////////////////////////////////////////////////////////////////////////////
20122 . ////////////////////////////////////////////////////////////////////////////
20123
20124 .chapter "The dnslookup router" "CHAPdnslookup"
20125 .scindex IIDdnsrou1 "&(dnslookup)& router"
20126 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20127 The &(dnslookup)& router looks up the hosts that handle mail for the
20128 recipient's domain in the DNS. A transport must always be set for this router,
20129 unless &%verify_only%& is set.
20130
20131 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20132 SRV records. If none are found, or if SRV support is not configured,
20133 MX records are looked up. If no MX records exist, address records are sought.
20134 However, &%mx_domains%& can be set to disable the direct use of address
20135 records.
20136
20137 MX records of equal priority are sorted by Exim into a random order. Exim then
20138 looks for address records for the host names obtained from MX or SRV records.
20139 When a host has more than one IP address, they are sorted into a random order,
20140 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20141 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20142 generic option, the router declines.
20143
20144 Unless they have the highest priority (lowest MX value), MX records that point
20145 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20146 are discarded, together with any other MX records of equal or lower priority.
20147
20148 .cindex "MX record" "pointing to local host"
20149 .cindex "local host" "MX pointing to"
20150 .oindex "&%self%&" "in &(dnslookup)& router"
20151 If the host pointed to by the highest priority MX record, or looked up as an
20152 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20153 happens is controlled by the generic &%self%& option.
20154
20155
20156 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20157 There have been problems with DNS servers when SRV records are looked up.
20158 Some misbehaving servers return a DNS error or timeout when a non-existent
20159 SRV record is sought. Similar problems have in the past been reported for
20160 MX records. The global &%dns_again_means_nonexist%& option can help with this
20161 problem, but it is heavy-handed because it is a global option.
20162
20163 For this reason, there are two options, &%srv_fail_domains%& and
20164 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20165 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20166 an attempt to look up an SRV or MX record causes one of these results, and the
20167 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20168 such record"&. In the case of an SRV lookup, this means that the router
20169 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20170 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20171 case routing fails.
20172
20173
20174 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20175 .cindex "&(dnslookup)& router" "declines"
20176 There are a few cases where a &(dnslookup)& router will decline to accept
20177 an address; if such a router is expected to handle "all remaining non-local
20178 domains", then it is important to set &%no_more%&.
20179
20180 The router will defer rather than decline if the domain
20181 is found in the &%fail_defer_domains%& router option.
20182
20183 Reasons for a &(dnslookup)& router to decline currently include:
20184 .ilist
20185 The domain does not exist in DNS
20186 .next
20187 The domain exists but the MX record's host part is just "."; this is a common
20188 convention (borrowed from SRV) used to indicate that there is no such service
20189 for this domain and to not fall back to trying A/AAAA records.
20190 .next
20191 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20192 .next
20193 MX record points to a non-existent host.
20194 .next
20195 MX record points to an IP address and the main section option
20196 &%allow_mx_to_ip%& is not set.
20197 .next
20198 MX records exist and point to valid hosts, but all hosts resolve only to
20199 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20200 .next
20201 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20202 &%dns_check_names_pattern%& for handling one variant of this)
20203 .next
20204 &%check_secondary_mx%& is set on this router but the local host can
20205 not be found in the MX records (see below)
20206 .endlist
20207
20208
20209
20210
20211 .section "Private options for dnslookup" "SECID118"
20212 .cindex "options" "&(dnslookup)& router"
20213 The private options for the &(dnslookup)& router are as follows:
20214
20215 .option check_secondary_mx dnslookup boolean false
20216 .cindex "MX record" "checking for secondary"
20217 If this option is set, the router declines unless the local host is found in
20218 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20219 process domains for which the local host is a secondary mail exchanger
20220 differently to other domains. The way in which Exim decides whether a host is
20221 the local host is described in section &<<SECTreclocipadd>>&.
20222
20223
20224 .option check_srv dnslookup string&!! unset
20225 .cindex "SRV record" "enabling use of"
20226 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20227 addition to MX and address records. The support is disabled by default. To
20228 enable SRV support, set the &%check_srv%& option to the name of the service
20229 required. For example,
20230 .code
20231 check_srv = smtp
20232 .endd
20233 looks for SRV records that refer to the normal smtp service. The option is
20234 expanded, so the service name can vary from message to message or address
20235 to address. This might be helpful if SRV records are being used for a
20236 submission service. If the expansion is forced to fail, the &%check_srv%&
20237 option is ignored, and the router proceeds to look for MX records in the
20238 normal way.
20239
20240 When the expansion succeeds, the router searches first for SRV records for
20241 the given service (it assumes TCP protocol). A single SRV record with a
20242 host name that consists of just a single dot indicates &"no such service for
20243 this domain"&; if this is encountered, the router declines. If other kinds of
20244 SRV record are found, they are used to construct a host list for delivery
20245 according to the rules of RFC 2782. MX records are not sought in this case.
20246
20247 When no SRV records are found, MX records (and address records) are sought in
20248 the traditional way. In other words, SRV records take precedence over MX
20249 records, just as MX records take precedence over address records. Note that
20250 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20251 defined it. It is apparently believed that MX records are sufficient for email
20252 and that SRV records should not be used for this purpose. However, SRV records
20253 have an additional &"weight"& feature which some people might find useful when
20254 trying to split an SMTP load between hosts of different power.
20255
20256 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20257 when there is a DNS lookup error.
20258
20259
20260
20261
20262 .option fail_defer_domains dnslookup "domain list&!!" unset
20263 .cindex "MX record" "not found"
20264 DNS lookups for domains matching &%fail_defer_domains%&
20265 which find no matching record will cause the router to defer
20266 rather than the default behaviour of decline.
20267 This maybe be useful for queueing messages for a newly created
20268 domain while the DNS configuration is not ready.
20269 However, it will result in any message with mistyped domains
20270 also being queued.
20271
20272
20273 .option ipv4_only "string&!!" unset
20274 .cindex IPv6 disabling
20275 .cindex DNS "IPv6 disabling"
20276 The string is expanded, and if the result is anything but a forced failure,
20277 or an empty string, or one of the strings “0” or “no” or “false”
20278 (checked without regard to the case of the letters),
20279 only A records are used.
20280
20281 .option ipv4_prefer "string&!!" unset
20282 .cindex IPv4 preference
20283 .cindex DNS "IPv4 preference"
20284 The string is expanded, and if the result is anything but a forced failure,
20285 or an empty string, or one of the strings “0” or “no” or “false”
20286 (checked without regard to the case of the letters),
20287 A records are sorted before AAAA records (inverting the default).
20288
20289 .option mx_domains dnslookup "domain list&!!" unset
20290 .cindex "MX record" "required to exist"
20291 .cindex "SRV record" "required to exist"
20292 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20293 record in order to be recognized. (The name of this option could be improved.)
20294 For example, if all the mail hosts in &'fict.example'& are known to have MX
20295 records, except for those in &'discworld.fict.example'&, you could use this
20296 setting:
20297 .code
20298 mx_domains = ! *.discworld.fict.example : *.fict.example
20299 .endd
20300 This specifies that messages addressed to a domain that matches the list but
20301 has no MX record should be bounced immediately instead of being routed using
20302 the address record.
20303
20304
20305 .option mx_fail_domains dnslookup "domain list&!!" unset
20306 If the DNS lookup for MX records for one of the domains in this list causes a
20307 DNS lookup error, Exim behaves as if no MX records were found. See section
20308 &<<SECTprowitdnsloo>>& for more discussion.
20309
20310
20311
20312
20313 .option qualify_single dnslookup boolean true
20314 .cindex "DNS" "resolver options"
20315 .cindex "DNS" "qualifying single-component names"
20316 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20317 lookups. Typically, but not standardly, this causes the resolver to qualify
20318 single-component names with the default domain. For example, on a machine
20319 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20320 &'thesaurus.ref.example'& inside the resolver. For details of what your
20321 resolver actually does, consult your man pages for &'resolver'& and
20322 &'resolv.conf'&.
20323
20324
20325
20326 .option rewrite_headers dnslookup boolean true
20327 .cindex "rewriting" "header lines"
20328 .cindex "header lines" "rewriting"
20329 If the domain name in the address that is being processed is not fully
20330 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20331 an address is specified as &'dormouse@teaparty'&, the domain might be
20332 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20333 occur as a result of setting the &%widen_domains%& option. If
20334 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20335 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20336 header lines of the message are rewritten with the full domain name.
20337
20338 This option should be turned off only when it is known that no message is
20339 ever going to be sent outside an environment where the abbreviation makes
20340 sense.
20341
20342 When an MX record is looked up in the DNS and matches a wildcard record, name
20343 servers normally return a record containing the name that has been looked up,
20344 making it impossible to detect whether a wildcard was present or not. However,
20345 some name servers have recently been seen to return the wildcard entry. If the
20346 name returned by a DNS lookup begins with an asterisk, it is not used for
20347 header rewriting.
20348
20349
20350 .option same_domain_copy_routing dnslookup boolean false
20351 .cindex "address" "copying routing"
20352 Addresses with the same domain are normally routed by the &(dnslookup)& router
20353 to the same list of hosts. However, this cannot be presumed, because the router
20354 options and preconditions may refer to the local part of the address. By
20355 default, therefore, Exim routes each address in a message independently. DNS
20356 servers run caches, so repeated DNS lookups are not normally expensive, and in
20357 any case, personal messages rarely have more than a few recipients.
20358
20359 If you are running mailing lists with large numbers of subscribers at the same
20360 domain, and you are using a &(dnslookup)& router which is independent of the
20361 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20362 lookups for identical domains in one message. In this case, when &(dnslookup)&
20363 routes an address to a remote transport, any other unrouted addresses in the
20364 message that have the same domain are automatically given the same routing
20365 without processing them independently,
20366 provided the following conditions are met:
20367
20368 .ilist
20369 No router that processed the address specified &%headers_add%& or
20370 &%headers_remove%&.
20371 .next
20372 The router did not change the address in any way, for example, by &"widening"&
20373 the domain.
20374 .endlist
20375
20376
20377
20378
20379 .option search_parents dnslookup boolean false
20380 .cindex "DNS" "resolver options"
20381 When this option is true, the resolver option RES_DNSRCH is set for DNS
20382 lookups. This is different from the &%qualify_single%& option in that it
20383 applies to domains containing dots. Typically, but not standardly, it causes
20384 the resolver to search for the name in the current domain and in parent
20385 domains. For example, on a machine in the &'fict.example'& domain, if looking
20386 up &'teaparty.wonderland'& failed, the resolver would try
20387 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20388 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20389
20390 Setting this option true can cause problems in domains that have a wildcard MX
20391 record, because any domain that does not have its own MX record matches the
20392 local wildcard.
20393
20394
20395
20396 .option srv_fail_domains dnslookup "domain list&!!" unset
20397 If the DNS lookup for SRV records for one of the domains in this list causes a
20398 DNS lookup error, Exim behaves as if no SRV records were found. See section
20399 &<<SECTprowitdnsloo>>& for more discussion.
20400
20401
20402
20403
20404 .option widen_domains dnslookup "string list" unset
20405 .cindex "domain" "partial; widening"
20406 If a DNS lookup fails and this option is set, each of its strings in turn is
20407 added onto the end of the domain, and the lookup is tried again. For example,
20408 if
20409 .code
20410 widen_domains = fict.example:ref.example
20411 .endd
20412 is set and a lookup of &'klingon.dictionary'& fails,
20413 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20414 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20415 and &%search_parents%& options can cause some widening to be undertaken inside
20416 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20417 when verifying, unless &%rewrite_headers%& is false (not the default).
20418
20419
20420 .section "Effect of qualify_single and search_parents" "SECID119"
20421 When a domain from an envelope recipient is changed by the resolver as a result
20422 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20423 corresponding address in the message's header lines unless &%rewrite_headers%&
20424 is set false. Exim then re-routes the address, using the full domain.
20425
20426 These two options affect only the DNS lookup that takes place inside the router
20427 for the domain of the address that is being routed. They do not affect lookups
20428 such as that implied by
20429 .code
20430 domains = @mx_any
20431 .endd
20432 that may happen while processing a router precondition before the router is
20433 entered. No widening ever takes place for these lookups.
20434 .ecindex IIDdnsrou1
20435 .ecindex IIDdnsrou2
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445 . ////////////////////////////////////////////////////////////////////////////
20446 . ////////////////////////////////////////////////////////////////////////////
20447
20448 .chapter "The ipliteral router" "CHID5"
20449 .cindex "&(ipliteral)& router"
20450 .cindex "domain literal" "routing"
20451 .cindex "routers" "&(ipliteral)&"
20452 This router has no private options. Unless it is being used purely for
20453 verification (see &%verify_only%&) a transport is required to be defined by the
20454 generic &%transport%& option. The router accepts the address if its domain part
20455 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20456 router handles the address
20457 .code
20458 root@[192.168.1.1]
20459 .endd
20460 by setting up delivery to the host with that IP address. IPv4 domain literals
20461 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20462 are similar, but the address is preceded by &`ipv6:`&. For example:
20463 .code
20464 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20465 .endd
20466 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20467 grounds that sooner or later somebody will try it.
20468
20469 .oindex "&%self%&" "in &(ipliteral)& router"
20470 If the IP address matches something in &%ignore_target_hosts%&, the router
20471 declines. If an IP literal turns out to refer to the local host, the generic
20472 &%self%& option determines what happens.
20473
20474 The RFCs require support for domain literals; however, their use is
20475 controversial in today's Internet. If you want to use this router, you must
20476 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20477 Exim will not recognize the domain literal syntax in addresses.
20478
20479
20480
20481 . ////////////////////////////////////////////////////////////////////////////
20482 . ////////////////////////////////////////////////////////////////////////////
20483
20484 .chapter "The iplookup router" "CHID6"
20485 .cindex "&(iplookup)& router"
20486 .cindex "routers" "&(iplookup)&"
20487 The &(iplookup)& router was written to fulfil a specific requirement in
20488 Cambridge University (which in fact no longer exists). For this reason, it is
20489 not included in the binary of Exim by default. If you want to include it, you
20490 must set
20491 .code
20492 ROUTER_IPLOOKUP=yes
20493 .endd
20494 in your &_Local/Makefile_& configuration file.
20495
20496 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20497 connection to one or more specific hosts. The host can then return the same or
20498 a different address &-- in effect rewriting the recipient address in the
20499 message's envelope. The new address is then passed on to subsequent routers. If
20500 this process fails, the address can be passed on to other routers, or delivery
20501 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20502 must not be specified for it.
20503
20504 .cindex "options" "&(iplookup)& router"
20505 .option hosts iplookup string unset
20506 This option must be supplied. Its value is a colon-separated list of host
20507 names. The hosts are looked up using &[gethostbyname()]&
20508 (or &[getipnodebyname()]& when available)
20509 and are tried in order until one responds to the query. If none respond, what
20510 happens is controlled by &%optional%&.
20511
20512
20513 .option optional iplookup boolean false
20514 If &%optional%& is true, if no response is obtained from any host, the address
20515 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20516 delivery to the address is deferred.
20517
20518
20519 .option port iplookup integer 0
20520 .cindex "port" "&(iplookup)& router"
20521 This option must be supplied. It specifies the port number for the TCP or UDP
20522 call.
20523
20524
20525 .option protocol iplookup string udp
20526 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20527 protocols is to be used.
20528
20529
20530 .option query iplookup string&!! "see below"
20531 This defines the content of the query that is sent to the remote hosts. The
20532 default value is:
20533 .code
20534 $local_part@$domain $local_part@$domain
20535 .endd
20536 The repetition serves as a way of checking that a response is to the correct
20537 query in the default case (see &%response_pattern%& below).
20538
20539
20540 .option reroute iplookup string&!! unset
20541 If this option is not set, the rerouted address is precisely the byte string
20542 returned by the remote host, up to the first white space, if any. If set, the
20543 string is expanded to form the rerouted address. It can include parts matched
20544 in the response by &%response_pattern%& by means of numeric variables such as
20545 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20546 whether or not a pattern is in use. In all cases, the rerouted address must end
20547 up in the form &'local_part@domain'&.
20548
20549
20550 .option response_pattern iplookup string unset
20551 This option can be set to a regular expression that is applied to the string
20552 returned from the remote host. If the pattern does not match the response, the
20553 router declines. If &%response_pattern%& is not set, no checking of the
20554 response is done, unless the query was defaulted, in which case there is a
20555 check that the text returned after the first white space is the original
20556 address. This checks that the answer that has been received is in response to
20557 the correct question. For example, if the response is just a new domain, the
20558 following could be used:
20559 .code
20560 response_pattern = ^([^@]+)$
20561 reroute = $local_part@$1
20562 .endd
20563
20564 .option timeout iplookup time 5s
20565 This specifies the amount of time to wait for a response from the remote
20566 machine. The same timeout is used for the &[connect()]& function for a TCP
20567 call. It does not apply to UDP.
20568
20569
20570
20571
20572 . ////////////////////////////////////////////////////////////////////////////
20573 . ////////////////////////////////////////////////////////////////////////////
20574
20575 .chapter "The manualroute router" "CHID7"
20576 .scindex IIDmanrou1 "&(manualroute)& router"
20577 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20578 .cindex "domain" "manually routing"
20579 The &(manualroute)& router is so-called because it provides a way of manually
20580 routing an address according to its domain. It is mainly used when you want to
20581 route addresses to remote hosts according to your own rules, bypassing the
20582 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20583 route to local transports, a facility that may be useful if you want to save
20584 messages for dial-in hosts in local files.
20585
20586 The &(manualroute)& router compares a list of domain patterns with the domain
20587 it is trying to route. If there is no match, the router declines. Each pattern
20588 has associated with it a list of hosts and some other optional data, which may
20589 include a transport. The combination of a pattern and its data is called a
20590 &"routing rule"&. For patterns that do not have an associated transport, the
20591 generic &%transport%& option must specify a transport, unless the router is
20592 being used purely for verification (see &%verify_only%&).
20593
20594 .vindex "&$host$&"
20595 In the case of verification, matching the domain pattern is sufficient for the
20596 router to accept the address. When actually routing an address for delivery,
20597 an address that matches a domain pattern is queued for the associated
20598 transport. If the transport is not a local one, a host list must be associated
20599 with the pattern; IP addresses are looked up for the hosts, and these are
20600 passed to the transport along with the mail address. For local transports, a
20601 host list is optional. If it is present, it is passed in &$host$& as a single
20602 text string.
20603
20604 The list of routing rules can be provided as an inline string in
20605 &%route_list%&, or the data can be obtained by looking up the domain in a file
20606 or database by setting &%route_data%&. Only one of these settings may appear in
20607 any one instance of &(manualroute)&. The format of routing rules is described
20608 below, following the list of private options.
20609
20610
20611 .section "Private options for manualroute" "SECTprioptman"
20612
20613 .cindex "options" "&(manualroute)& router"
20614 The private options for the &(manualroute)& router are as follows:
20615
20616 .option host_all_ignored manualroute string defer
20617 See &%host_find_failed%&.
20618
20619 .option host_find_failed manualroute string freeze
20620 This option controls what happens when &(manualroute)& tries to find an IP
20621 address for a host, and the host does not exist. The option can be set to one
20622 of the following values:
20623 .code
20624 decline
20625 defer
20626 fail
20627 freeze
20628 ignore
20629 pass
20630 .endd
20631 The default (&"freeze"&) assumes that this state is a serious configuration
20632 error. The difference between &"pass"& and &"decline"& is that the former
20633 forces the address to be passed to the next router (or the router defined by
20634 &%pass_router%&),
20635 .oindex "&%more%&"
20636 overriding &%no_more%&, whereas the latter passes the address to the next
20637 router only if &%more%& is true.
20638
20639 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20640 cannot be found. If all the hosts in the list are ignored, the behaviour is
20641 controlled by the &%host_all_ignored%& option. This takes the same values
20642 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20643
20644 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20645 state; if a host lookup gets a temporary error, delivery is deferred unless the
20646 generic &%pass_on_timeout%& option is set.
20647
20648
20649 .option hosts_randomize manualroute boolean false
20650 .cindex "randomized host list"
20651 .cindex "host" "list of; randomized"
20652 If this option is set, the order of the items in a host list in a routing rule
20653 is randomized each time the list is used, unless an option in the routing rule
20654 overrides (see below). Randomizing the order of a host list can be used to do
20655 crude load sharing. However, if more than one mail address is routed by the
20656 same router to the same host list, the host lists are considered to be the same
20657 (even though they may be randomized into different orders) for the purpose of
20658 deciding whether to batch the deliveries into a single SMTP transaction.
20659
20660 When &%hosts_randomize%& is true, a host list may be split
20661 into groups whose order is separately randomized. This makes it possible to
20662 set up MX-like behaviour. The boundaries between groups are indicated by an
20663 item that is just &`+`& in the host list. For example:
20664 .code
20665 route_list = * host1:host2:host3:+:host4:host5
20666 .endd
20667 The order of the first three hosts and the order of the last two hosts is
20668 randomized for each use, but the first three always end up before the last two.
20669 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20670 randomized host list is passed to an &(smtp)& transport that also has
20671 &%hosts_randomize set%&, the list is not re-randomized.
20672
20673
20674 .option route_data manualroute string&!! unset
20675 If this option is set, it must expand to yield the data part of a routing rule.
20676 Typically, the expansion string includes a lookup based on the domain. For
20677 example:
20678 .code
20679 route_data = ${lookup{$domain}dbm{/etc/routes}}
20680 .endd
20681 If the expansion is forced to fail, or the result is an empty string, the
20682 router declines. Other kinds of expansion failure cause delivery to be
20683 deferred.
20684
20685
20686 .option route_list manualroute "string list" unset
20687 This string is a list of routing rules, in the form defined below. Note that,
20688 unlike most string lists, the items are separated by semicolons. This is so
20689 that they may contain colon-separated host lists.
20690
20691
20692 .option same_domain_copy_routing manualroute boolean false
20693 .cindex "address" "copying routing"
20694 Addresses with the same domain are normally routed by the &(manualroute)&
20695 router to the same list of hosts. However, this cannot be presumed, because the
20696 router options and preconditions may refer to the local part of the address. By
20697 default, therefore, Exim routes each address in a message independently. DNS
20698 servers run caches, so repeated DNS lookups are not normally expensive, and in
20699 any case, personal messages rarely have more than a few recipients.
20700
20701 If you are running mailing lists with large numbers of subscribers at the same
20702 domain, and you are using a &(manualroute)& router which is independent of the
20703 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20704 lookups for identical domains in one message. In this case, when
20705 &(manualroute)& routes an address to a remote transport, any other unrouted
20706 addresses in the message that have the same domain are automatically given the
20707 same routing without processing them independently. However, this is only done
20708 if &%headers_add%& and &%headers_remove%& are unset.
20709
20710
20711
20712
20713 .section "Routing rules in route_list" "SECID120"
20714 The value of &%route_list%& is a string consisting of a sequence of routing
20715 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20716 entered as two semicolons. Alternatively, the list separator can be changed as
20717 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20718 Empty rules are ignored. The format of each rule is
20719 .display
20720 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20721 .endd
20722 The following example contains two rules, each with a simple domain pattern and
20723 no options:
20724 .code
20725 route_list = \
20726   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20727   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20728 .endd
20729 The three parts of a rule are separated by white space. The pattern and the
20730 list of hosts can be enclosed in quotes if necessary, and if they are, the
20731 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20732 single domain pattern, which is the only mandatory item in the rule. The
20733 pattern is in the same format as one item in a domain list (see section
20734 &<<SECTdomainlist>>&),
20735 except that it may not be the name of an interpolated file.
20736 That is, it may be wildcarded, or a regular expression, or a file or database
20737 lookup (with semicolons doubled, because of the use of semicolon as a separator
20738 in a &%route_list%&).
20739
20740 The rules in &%route_list%& are searched in order until one of the patterns
20741 matches the domain that is being routed. The list of hosts and then options are
20742 then used as described below. If there is no match, the router declines. When
20743 &%route_list%& is set, &%route_data%& must not be set.
20744
20745
20746
20747 .section "Routing rules in route_data" "SECID121"
20748 The use of &%route_list%& is convenient when there are only a small number of
20749 routing rules. For larger numbers, it is easier to use a file or database to
20750 hold the routing information, and use the &%route_data%& option instead.
20751 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20752 Most commonly, &%route_data%& is set as a string that contains an
20753 expansion lookup. For example, suppose we place two routing rules in a file
20754 like this:
20755 .code
20756 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20757 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20758 .endd
20759 This data can be accessed by setting
20760 .code
20761 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20762 .endd
20763 Failure of the lookup results in an empty string, causing the router to
20764 decline. However, you do not have to use a lookup in &%route_data%&. The only
20765 requirement is that the result of expanding the string is a list of hosts,
20766 possibly followed by options, separated by white space. The list of hosts must
20767 be enclosed in quotes if it contains white space.
20768
20769
20770
20771
20772 .section "Format of the list of hosts" "SECID122"
20773 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20774 always separately expanded before use. If the expansion fails, the router
20775 declines. The result of the expansion must be a colon-separated list of names
20776 and/or IP addresses, optionally also including ports.
20777 If the list is written with spaces, it must be protected with quotes.
20778 The format of each item
20779 in the list is described in the next section. The list separator can be changed
20780 as described in section &<<SECTlistsepchange>>&.
20781
20782 If the list of hosts was obtained from a &%route_list%& item, the following
20783 variables are set during its expansion:
20784
20785 .ilist
20786 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20787 If the domain was matched against a regular expression, the numeric variables
20788 &$1$&, &$2$&, etc. may be set. For example:
20789 .code
20790 route_list = ^domain(\d+)   host-$1.text.example
20791 .endd
20792 .next
20793 &$0$& is always set to the entire domain.
20794 .next
20795 &$1$& is also set when partial matching is done in a file lookup.
20796
20797 .next
20798 .vindex "&$value$&"
20799 If the pattern that matched the domain was a lookup item, the data that was
20800 looked up is available in the expansion variable &$value$&. For example:
20801 .code
20802 route_list = lsearch;;/some/file.routes  $value
20803 .endd
20804 .endlist
20805
20806 Note the doubling of the semicolon in the pattern that is necessary because
20807 semicolon is the default route list separator.
20808
20809
20810
20811 .section "Format of one host item" "SECTformatonehostitem"
20812 Each item in the list of hosts can be either a host name or an IP address,
20813 optionally with an attached port number, or it can be a single "+"
20814 (see &%hosts_randomize%&).
20815 When no port is given, an IP address
20816 is not enclosed in brackets. When a port is specified, it overrides the port
20817 specification on the transport. The port is separated from the name or address
20818 by a colon. This leads to some complications:
20819
20820 .ilist
20821 Because colon is the default separator for the list of hosts, either
20822 the colon that specifies a port must be doubled, or the list separator must
20823 be changed. The following two examples have the same effect:
20824 .code
20825 route_list = * "host1.tld::1225 : host2.tld::1226"
20826 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20827 .endd
20828 .next
20829 When IPv6 addresses are involved, it gets worse, because they contain
20830 colons of their own. To make this case easier, it is permitted to
20831 enclose an IP address (either v4 or v6) in square brackets if a port
20832 number follows. For example:
20833 .code
20834 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20835 .endd
20836 .endlist
20837
20838 .section "How the list of hosts is used" "SECThostshowused"
20839 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20840 the hosts is tried, in the order specified, when carrying out the SMTP
20841 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20842 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20843 transport.
20844
20845 Hosts may be listed by name or by IP address. An unadorned name in the list of
20846 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20847 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20848 records in the DNS. For example:
20849 .code
20850 route_list = *  x.y.z:p.q.r/MX:e.f.g
20851 .endd
20852 If this feature is used with a port specifier, the port must come last. For
20853 example:
20854 .code
20855 route_list = *  dom1.tld/mx::1225
20856 .endd
20857 If the &%hosts_randomize%& option is set, the order of the items in the list is
20858 randomized before any lookups are done. Exim then scans the list; for any name
20859 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20860 be an interface on the local host and the item is not the first in the list,
20861 Exim discards it and any subsequent items. If it is the first item, what
20862 happens is controlled by the
20863 .oindex "&%self%&" "in &(manualroute)& router"
20864 &%self%& option of the router.
20865
20866 A name on the list that is followed by &`/MX`& is replaced with the list of
20867 hosts obtained by looking up MX records for the name. This is always a DNS
20868 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20869 below) are not relevant here. The order of these hosts is determined by the
20870 preference values in the MX records, according to the usual rules. Because
20871 randomizing happens before the MX lookup, it does not affect the order that is
20872 defined by MX preferences.
20873
20874 If the local host is present in the sublist obtained from MX records, but is
20875 not the most preferred host in that list, it and any equally or less
20876 preferred hosts are removed before the sublist is inserted into the main list.
20877
20878 If the local host is the most preferred host in the MX list, what happens
20879 depends on where in the original list of hosts the &`/MX`& item appears. If it
20880 is not the first item (that is, there are previous hosts in the main list),
20881 Exim discards this name and any subsequent items in the main list.
20882
20883 If the MX item is first in the list of hosts, and the local host is the
20884 most preferred host, what happens is controlled by the &%self%& option of the
20885 router.
20886
20887 DNS failures when lookup up the MX records are treated in the same way as DNS
20888 failures when looking up IP addresses: &%pass_on_timeout%& and
20889 &%host_find_failed%& are used when relevant.
20890
20891 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20892 whether obtained from an MX lookup or not.
20893
20894
20895
20896 .section "How the options are used" "SECThowoptused"
20897 The options are a sequence of words, space-separated.
20898 One of the words can be the name of a transport; this overrides the
20899 &%transport%& option on the router for this particular routing rule only. The
20900 other words (if present) control randomization of the list of hosts on a
20901 per-rule basis, and how the IP addresses of the hosts are to be found when
20902 routing to a remote transport. These options are as follows:
20903
20904 .ilist
20905 &%randomize%&: randomize the order of the hosts in this list, overriding the
20906 setting of &%hosts_randomize%& for this routing rule only.
20907 .next
20908 &%no_randomize%&: do not randomize the order of the hosts in this list,
20909 overriding the setting of &%hosts_randomize%& for this routing rule only.
20910 .next
20911 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20912 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20913 also look in &_/etc/hosts_& or other sources of information.
20914 .next
20915 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20916 no address records are found. If there is a temporary DNS error (such as a
20917 timeout), delivery is deferred.
20918 .next
20919 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20920 .next
20921 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20922 .endlist
20923
20924 For example:
20925 .code
20926 route_list = domain1  host1:host2:host3  randomize bydns;\
20927              domain2  host4:host5
20928 .endd
20929 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20930 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20931 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20932 or &[gethostbyname()]&, and the result of the lookup is the result of that
20933 call.
20934
20935 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20936 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20937 instead of TRY_AGAIN. That is why the default action is to try a DNS
20938 lookup first. Only if that gives a definite &"no such host"& is the local
20939 function called.
20940
20941 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20942 inadvertent constraint that a transport name as an option had to be the last
20943 option specified.
20944
20945
20946
20947 If no IP address for a host can be found, what happens is controlled by the
20948 &%host_find_failed%& option.
20949
20950 .vindex "&$host$&"
20951 When an address is routed to a local transport, IP addresses are not looked up.
20952 The host list is passed to the transport in the &$host$& variable.
20953
20954
20955
20956 .section "Manualroute examples" "SECID123"
20957 In some of the examples that follow, the presence of the &%remote_smtp%&
20958 transport, as defined in the default configuration file, is assumed:
20959
20960 .ilist
20961 .cindex "smart host" "example router"
20962 The &(manualroute)& router can be used to forward all external mail to a
20963 &'smart host'&. If you have set up, in the main part of the configuration, a
20964 named domain list that contains your local domains, for example:
20965 .code
20966 domainlist local_domains = my.domain.example
20967 .endd
20968 You can arrange for all other domains to be routed to a smart host by making
20969 your first router something like this:
20970 .code
20971 smart_route:
20972   driver = manualroute
20973   domains = !+local_domains
20974   transport = remote_smtp
20975   route_list = * smarthost.ref.example
20976 .endd
20977 This causes all non-local addresses to be sent to the single host
20978 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20979 they are tried in order
20980 (but you can use &%hosts_randomize%& to vary the order each time).
20981 Another way of configuring the same thing is this:
20982 .code
20983 smart_route:
20984   driver = manualroute
20985   transport = remote_smtp
20986   route_list = !+local_domains  smarthost.ref.example
20987 .endd
20988 There is no difference in behaviour between these two routers as they stand.
20989 However, they behave differently if &%no_more%& is added to them. In the first
20990 example, the router is skipped if the domain does not match the &%domains%&
20991 precondition; the following router is always tried. If the router runs, it
20992 always matches the domain and so can never decline. Therefore, &%no_more%&
20993 would have no effect. In the second case, the router is never skipped; it
20994 always runs. However, if it doesn't match the domain, it declines. In this case
20995 &%no_more%& would prevent subsequent routers from running.
20996
20997 .next
20998 .cindex "mail hub example"
20999 A &'mail hub'& is a host which receives mail for a number of domains via MX
21000 records in the DNS and delivers it via its own private routing mechanism. Often
21001 the final destinations are behind a firewall, with the mail hub being the one
21002 machine that can connect to machines both inside and outside the firewall. The
21003 &(manualroute)& router is usually used on a mail hub to route incoming messages
21004 to the correct hosts. For a small number of domains, the routing can be inline,
21005 using the &%route_list%& option, but for a larger number a file or database
21006 lookup is easier to manage.
21007
21008 If the domain names are in fact the names of the machines to which the mail is
21009 to be sent by the mail hub, the configuration can be quite simple. For
21010 example:
21011 .code
21012 hub_route:
21013   driver = manualroute
21014   transport = remote_smtp
21015   route_list = *.rhodes.tvs.example  $domain
21016 .endd
21017 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
21018 whose names are the same as the mail domains. A similar approach can be taken
21019 if the host name can be obtained from the domain name by a string manipulation
21020 that the expansion facilities can handle. Otherwise, a lookup based on the
21021 domain can be used to find the host:
21022 .code
21023 through_firewall:
21024   driver = manualroute
21025   transport = remote_smtp
21026   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
21027 .endd
21028 The result of the lookup must be the name or IP address of the host (or
21029 hosts) to which the address is to be routed. If the lookup fails, the route
21030 data is empty, causing the router to decline. The address then passes to the
21031 next router.
21032
21033 .next
21034 .cindex "batched SMTP output example"
21035 .cindex "SMTP" "batched outgoing; example"
21036 You can use &(manualroute)& to deliver messages to pipes or files in batched
21037 SMTP format for onward transportation by some other means. This is one way of
21038 storing mail for a dial-up host when it is not connected. The route list entry
21039 can be as simple as a single domain name in a configuration like this:
21040 .code
21041 save_in_file:
21042   driver = manualroute
21043   transport = batchsmtp_appendfile
21044   route_list = saved.domain.example
21045 .endd
21046 though often a pattern is used to pick up more than one domain. If there are
21047 several domains or groups of domains with different transport requirements,
21048 different transports can be listed in the routing information:
21049 .code
21050 save_in_file:
21051   driver = manualroute
21052   route_list = \
21053     *.saved.domain1.example  $domain  batch_appendfile; \
21054     *.saved.domain2.example  \
21055       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
21056       batch_pipe
21057 .endd
21058 .vindex "&$domain$&"
21059 .vindex "&$host$&"
21060 The first of these just passes the domain in the &$host$& variable, which
21061 doesn't achieve much (since it is also in &$domain$&), but the second does a
21062 file lookup to find a value to pass, causing the router to decline to handle
21063 the address if the lookup fails.
21064
21065 .next
21066 .cindex "UUCP" "example of router for"
21067 Routing mail directly to UUCP software is a specific case of the use of
21068 &(manualroute)& in a gateway to another mail environment. This is an example of
21069 one way it can be done:
21070 .code
21071 # Transport
21072 uucp:
21073   driver = pipe
21074   user = nobody
21075   command = /usr/local/bin/uux -r - \
21076     ${substr_-5:$host}!rmail ${local_part}
21077   return_fail_output = true
21078
21079 # Router
21080 uucphost:
21081   transport = uucp
21082   driver = manualroute
21083   route_data = \
21084     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21085 .endd
21086 The file &_/usr/local/exim/uucphosts_& contains entries like
21087 .code
21088 darksite.ethereal.example:           darksite.UUCP
21089 .endd
21090 It can be set up more simply without adding and removing &".UUCP"& but this way
21091 makes clear the distinction between the domain name
21092 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21093 .endlist
21094 .ecindex IIDmanrou1
21095 .ecindex IIDmanrou2
21096
21097
21098
21099
21100
21101
21102
21103
21104 . ////////////////////////////////////////////////////////////////////////////
21105 . ////////////////////////////////////////////////////////////////////////////
21106
21107 .chapter "The queryprogram router" "CHAPdriverlast"
21108 .scindex IIDquerou1 "&(queryprogram)& router"
21109 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21110 .cindex "routing" "by external program"
21111 The &(queryprogram)& router routes an address by running an external command
21112 and acting on its output. This is an expensive way to route, and is intended
21113 mainly for use in lightly-loaded systems, or for performing experiments.
21114 However, if it is possible to use the precondition options (&%domains%&,
21115 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21116 be used in special cases, even on a busy host. There are the following private
21117 options:
21118 .cindex "options" "&(queryprogram)& router"
21119
21120 .option command queryprogram string&!! unset
21121 This option must be set. It specifies the command that is to be run. The
21122 command is split up into a command name and arguments, and then each is
21123 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21124 &<<CHAPpipetransport>>&).
21125
21126
21127 .option command_group queryprogram string unset
21128 .cindex "gid (group id)" "in &(queryprogram)& router"
21129 This option specifies a gid to be set when running the command while routing an
21130 address for deliver. It must be set if &%command_user%& specifies a numerical
21131 uid. If it begins with a digit, it is interpreted as the numerical value of the
21132 gid. Otherwise it is looked up using &[getgrnam()]&.
21133
21134
21135 .option command_user queryprogram string unset
21136 .cindex "uid (user id)" "for &(queryprogram)&"
21137 This option must be set. It specifies the uid which is set when running the
21138 command while routing an address for delivery. If the value begins with a digit,
21139 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21140 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21141 not set, a value for the gid also.
21142
21143 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21144 root, which it does during a normal delivery in a conventional configuration.
21145 However, when an address is being verified during message reception, Exim is
21146 usually running as the Exim user, not as root. If the &(queryprogram)& router
21147 is called from a non-root process, Exim cannot change uid or gid before running
21148 the command. In this circumstance the command runs under the current uid and
21149 gid.
21150
21151
21152 .option current_directory queryprogram string /
21153 This option specifies an absolute path which is made the current directory
21154 before running the command.
21155
21156
21157 .option timeout queryprogram time 1h
21158 If the command does not complete within the timeout period, its process group
21159 is killed and the message is frozen. A value of zero time specifies no
21160 timeout.
21161
21162
21163 The standard output of the command is connected to a pipe, which is read when
21164 the command terminates. It should consist of a single line of output,
21165 containing up to five fields, separated by white space. The maximum length of
21166 the line is 1023 characters. Longer lines are silently truncated. The first
21167 field is one of the following words (case-insensitive):
21168
21169 .ilist
21170 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21171 below).
21172 .next
21173 &'Decline'&: the router declines; pass the address to the next router, unless
21174 &%no_more%& is set.
21175 .next
21176 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21177 subsequent text on the line is an error message. If the router is run as part
21178 of address verification during an incoming SMTP message, the message is
21179 included in the SMTP response.
21180 .next
21181 &'Defer'&: routing could not be completed at this time; try again later. Any
21182 subsequent text on the line is an error message which is logged. It is not
21183 included in any SMTP response.
21184 .next
21185 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21186 .next
21187 &'Pass'&: pass the address to the next router (or the router specified by
21188 &%pass_router%&), overriding &%no_more%&.
21189 .next
21190 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21191 new addresses, which are routed independently, starting with the first router,
21192 or the router specified by &%redirect_router%&, if set.
21193 .endlist
21194
21195 When the first word is &'accept'&, the remainder of the line consists of a
21196 number of keyed data values, as follows (split into two lines here, to fit on
21197 the page):
21198 .code
21199 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21200 LOOKUP=byname|bydns DATA=<text>
21201 .endd
21202 The data items can be given in any order, and all are optional. If no transport
21203 is included, the transport specified by the generic &%transport%& option is
21204 used. The list of hosts and the lookup type are needed only if the transport is
21205 an &(smtp)& transport that does not itself supply a list of hosts.
21206
21207 The format of the list of hosts is the same as for the &(manualroute)& router.
21208 As well as host names and IP addresses with optional port numbers, as described
21209 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21210 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21211 (see section &<<SECThostshowused>>&).
21212
21213 If the lookup type is not specified, Exim behaves as follows when trying to
21214 find an IP address for each host: First, a DNS lookup is done. If this yields
21215 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21216 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21217 result of the lookup is the result of that call.
21218
21219 .vindex "&$address_data$&"
21220 If the DATA field is set, its value is placed in the &$address_data$&
21221 variable. For example, this return line
21222 .code
21223 accept hosts=x1.y.example:x2.y.example data="rule1"
21224 .endd
21225 routes the address to the default transport, passing a list of two hosts. When
21226 the transport runs, the string &"rule1"& is in &$address_data$&.
21227 .ecindex IIDquerou1
21228 .ecindex IIDquerou2
21229
21230
21231
21232
21233 . ////////////////////////////////////////////////////////////////////////////
21234 . ////////////////////////////////////////////////////////////////////////////
21235
21236 .chapter "The redirect router" "CHAPredirect"
21237 .scindex IIDredrou1 "&(redirect)& router"
21238 .scindex IIDredrou2 "routers" "&(redirect)&"
21239 .cindex "alias file" "in a &(redirect)& router"
21240 .cindex "address redirection" "&(redirect)& router"
21241 The &(redirect)& router handles several kinds of address redirection. Its most
21242 common uses are for resolving local part aliases from a central alias file
21243 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21244 files, but it has many other potential uses. The incoming address can be
21245 redirected in several different ways:
21246
21247 .ilist
21248 It can be replaced by one or more new addresses which are themselves routed
21249 independently.
21250 .next
21251 It can be routed to be delivered to a given file or directory.
21252 .next
21253 It can be routed to be delivered to a specified pipe command.
21254 .next
21255 It can cause an automatic reply to be generated.
21256 .next
21257 It can be forced to fail, optionally with a custom error message.
21258 .next
21259 It can be temporarily deferred, optionally with a custom message.
21260 .next
21261 It can be discarded.
21262 .endlist
21263
21264 The generic &%transport%& option must not be set for &(redirect)& routers.
21265 However, there are some private options which define transports for delivery to
21266 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21267 &%pipe_transport%& and &%reply_transport%& descriptions below.
21268
21269 If success DSNs have been requested
21270 .cindex "DSN" "success"
21271 .cindex "Delivery Status Notification" "success"
21272 redirection triggers one and the DSN options are not passed any further.
21273
21274
21275
21276 .section "Redirection data" "SECID124"
21277 The router operates by interpreting a text string which it obtains either by
21278 expanding the contents of the &%data%& option, or by reading the entire
21279 contents of a file whose name is given in the &%file%& option. These two
21280 options are mutually exclusive. The first is commonly used for handling system
21281 aliases, in a configuration like this:
21282 .code
21283 system_aliases:
21284   driver = redirect
21285   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21286 .endd
21287 If the lookup fails, the expanded string in this example is empty. When the
21288 expansion of &%data%& results in an empty string, the router declines. A forced
21289 expansion failure also causes the router to decline; other expansion failures
21290 cause delivery to be deferred.
21291
21292 A configuration using &%file%& is commonly used for handling users'
21293 &_.forward_& files, like this:
21294 .code
21295 userforward:
21296   driver = redirect
21297   check_local_user
21298   file = $home/.forward
21299   no_verify
21300 .endd
21301 If the file does not exist, or causes no action to be taken (for example, it is
21302 empty or consists only of comments), the router declines. &*Warning*&: This
21303 is not the case when the file contains syntactically valid items that happen to
21304 yield empty addresses, for example, items containing only RFC 2822 address
21305 comments.
21306
21307 .cindex "tainted data" "in filenames"
21308 .cindex redirect "tainted data"
21309 Tainted data may not be used for a filename.
21310
21311 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21312 directly for redirection,
21313 as they are provided by a potential attacker.
21314 In the examples above, &$local_part$& is used for looking up data held locally
21315 on the system, and not used directly (the second example derives &$home$& via
21316 the passsword file or database, using &$local_part$&).
21317
21318
21319
21320 .section "Forward files and address verification" "SECID125"
21321 .cindex "address redirection" "while verifying"
21322 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21323 &_.forward_& files, as in the example above. There are two reasons for this:
21324
21325 .ilist
21326 When Exim is receiving an incoming SMTP message from a remote host, it is
21327 running under the Exim uid, not as root. Exim is unable to change uid to read
21328 the file as the user, and it may not be able to read it as the Exim user. So in
21329 practice the router may not be able to operate.
21330 .next
21331 However, even when the router can operate, the existence of a &_.forward_& file
21332 is unimportant when verifying an address. What should be checked is whether the
21333 local part is a valid user name or not. Cutting out the redirection processing
21334 saves some resources.
21335 .endlist
21336
21337
21338
21339
21340
21341
21342 .section "Interpreting redirection data" "SECID126"
21343 .cindex "Sieve filter" "specifying in redirection data"
21344 .cindex "filter" "specifying in redirection data"
21345 The contents of the data string, whether obtained from &%data%& or &%file%&,
21346 can be interpreted in two different ways:
21347
21348 .ilist
21349 If the &%allow_filter%& option is set true, and the data begins with the text
21350 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21351 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21352 respectively. Details of the syntax and semantics of filter files are described
21353 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21354 document is intended for use by end users.
21355 .next
21356 Otherwise, the data must be a comma-separated list of redirection items, as
21357 described in the next section.
21358 .endlist
21359
21360 When a message is redirected to a file (a &"mail folder"&), the filename given
21361 in a non-filter redirection list must always be an absolute path. A filter may
21362 generate a relative path &-- how this is handled depends on the transport's
21363 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21364 for the &(appendfile)& transport.
21365
21366
21367
21368 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21369 .cindex "address redirection" "non-filter list items"
21370 When the redirection data is not an Exim or Sieve filter, for example, if it
21371 comes from a conventional alias or forward file, it consists of a list of
21372 addresses, filenames, pipe commands, or certain special items (see section
21373 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21374 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21375 depending on their default values. The items in the list are separated by
21376 commas or newlines.
21377 If a comma is required in an item, the entire item must be enclosed in double
21378 quotes.
21379
21380 Lines starting with a # character are comments, and are ignored, and # may
21381 also appear following a comma, in which case everything between the # and the
21382 next newline character is ignored.
21383
21384 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21385 double quotes are retained because some forms of mail address require their use
21386 (but never to enclose the entire address). In the following description,
21387 &"item"& refers to what remains after any surrounding double quotes have been
21388 removed.
21389
21390 .vindex "&$local_part$&"
21391 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21392 and the expansion contains a reference to &$local_part$&, you should make use
21393 of the &%quote_local_part%& expansion operator, in case the local part contains
21394 special characters. For example, to redirect all mail for the domain
21395 &'obsolete.example'&, retaining the existing local part, you could use this
21396 setting:
21397 .code
21398 data = ${quote_local_part:$local_part}@newdomain.example
21399 .endd
21400
21401
21402 .section "Redirecting to a local mailbox" "SECTredlocmai"
21403 .cindex "routing" "loops in"
21404 .cindex "loop" "while routing, avoidance of"
21405 .cindex "address redirection" "to local mailbox"
21406 A redirection item may safely be the same as the address currently under
21407 consideration. This does not cause a routing loop, because a router is
21408 automatically skipped if any ancestor of the address that is being processed
21409 is the same as the current address and was processed by the current router.
21410 Such an address is therefore passed to the following routers, so it is handled
21411 as if there were no redirection. When making this loop-avoidance test, the
21412 complete local part, including any prefix or suffix, is used.
21413
21414 .cindex "address redirection" "local part without domain"
21415 Specifying the same local part without a domain is a common usage in personal
21416 filter files when the user wants to have messages delivered to the local
21417 mailbox and also forwarded elsewhere. For example, the user whose login is
21418 &'cleo'& might have a &_.forward_& file containing this:
21419 .code
21420 cleo, cleopatra@egypt.example
21421 .endd
21422 .cindex "backslash in alias file"
21423 .cindex "alias file" "backslash in"
21424 For compatibility with other MTAs, such unqualified local parts may be
21425 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21426 it does make a difference if more than one domain is being handled
21427 synonymously.
21428
21429 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21430 2822 address that does not include a domain, the item is qualified using the
21431 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21432 addresses are qualified using the value in &%qualify_recipient%&, but you can
21433 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21434
21435 Care must be taken if there are alias names for local users.
21436 Consider an MTA handling a single local domain where the system alias file
21437 contains:
21438 .code
21439 Sam.Reman: spqr
21440 .endd
21441 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21442 messages in the local mailbox, and also forward copies elsewhere. He creates
21443 this forward file:
21444 .code
21445 Sam.Reman, spqr@reme.elsewhere.example
21446 .endd
21447 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21448 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21449 second time round, because it has previously routed it,
21450 and the following routers presumably cannot handle the alias. The forward file
21451 should really contain
21452 .code
21453 spqr, spqr@reme.elsewhere.example
21454 .endd
21455 but because this is such a common error, the &%check_ancestor%& option (see
21456 below) exists to provide a way to get round it. This is normally set on a
21457 &(redirect)& router that is handling users' &_.forward_& files.
21458
21459
21460
21461 .section "Special items in redirection lists" "SECTspecitredli"
21462 In addition to addresses, the following types of item may appear in redirection
21463 lists (that is, in non-filter redirection data):
21464
21465 .ilist
21466 .cindex "pipe" "in redirection list"
21467 .cindex "address redirection" "to pipe"
21468 An item is treated as a pipe command if it begins with &"|"& and does not parse
21469 as a valid RFC 2822 address that includes a domain. A transport for running the
21470 command must be specified by the &%pipe_transport%& option.
21471 Normally, either the router or the transport specifies a user and a group under
21472 which to run the delivery. The default is to use the Exim user and group.
21473
21474 Single or double quotes can be used for enclosing the individual arguments of
21475 the pipe command; no interpretation of escapes is done for single quotes. If
21476 the command contains a comma character, it is necessary to put the whole item
21477 in double quotes, for example:
21478 .code
21479 "|/some/command ready,steady,go"
21480 .endd
21481 since items in redirection lists are terminated by commas. Do not, however,
21482 quote just the command. An item such as
21483 .code
21484 |"/some/command ready,steady,go"
21485 .endd
21486 is interpreted as a pipe with a rather strange command name, and no arguments.
21487
21488 Note that the above example assumes that the text comes from a lookup source
21489 of some sort, so that the quotes are part of the data.  If composing a
21490 redirect router with a &%data%& option directly specifying this command, the
21491 quotes will be used by the configuration parser to define the extent of one
21492 string, but will not be passed down into the redirect router itself.  There
21493 are two main approaches to get around this: escape quotes to be part of the
21494 data itself, or avoid using this mechanism and instead create a custom
21495 transport with the &%command%& option set and reference that transport from
21496 an &%accept%& router.
21497
21498 .next
21499 .cindex "file" "in redirection list"
21500 .cindex "address redirection" "to file"
21501 An item is interpreted as a path name if it begins with &"/"& and does not
21502 parse as a valid RFC 2822 address that includes a domain. For example,
21503 .code
21504 /home/world/minbari
21505 .endd
21506 is treated as a filename, but
21507 .code
21508 /s=molari/o=babylon/@x400gate.way
21509 .endd
21510 is treated as an address. For a filename, a transport must be specified using
21511 the &%file_transport%& option. However, if the generated path name ends with a
21512 forward slash character, it is interpreted as a directory name rather than a
21513 filename, and &%directory_transport%& is used instead.
21514
21515 Normally, either the router or the transport specifies a user and a group under
21516 which to run the delivery. The default is to use the Exim user and group.
21517
21518 .cindex "&_/dev/null_&"
21519 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21520 bypassed at a high level, and the log entry shows &"**bypassed**"&
21521 instead of a transport name. In this case the user and group are not used.
21522
21523 .next
21524 .cindex "included address list"
21525 .cindex "address redirection" "included external list"
21526 If an item is of the form
21527 .code
21528 :include:<path name>
21529 .endd
21530 a list of further items is taken from the given file and included at that
21531 point. &*Note*&: Such a file can not be a filter file; it is just an
21532 out-of-line addition to the list. The items in the included list are separated
21533 by commas or newlines and are not subject to expansion. If this is the first
21534 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21535 the alias name. This example is incorrect:
21536 .code
21537 list1    :include:/opt/lists/list1
21538 .endd
21539 It must be given as
21540 .code
21541 list1:   :include:/opt/lists/list1
21542 .endd
21543 .cindex "tainted data" "in filenames"
21544 .cindex redirect "tainted data"
21545 Tainted data may not be used for a filename.
21546 .next
21547 .cindex "address redirection" "to black hole"
21548 .cindex "delivery" "discard"
21549 .cindex "delivery" "blackhole"
21550 .cindex "black hole"
21551 .cindex "abandoning mail"
21552 Sometimes you want to throw away mail to a particular local part.  Making the
21553 &%data%& option expand to an empty string does not work, because that causes
21554 the router to decline. Instead, the alias item
21555 .code
21556 :blackhole:
21557 .endd
21558 can be used. It does what its name implies. No delivery is
21559 done, and no error message is generated. This has the same effect as specifying
21560 &_/dev/null_& as a destination, but it can be independently disabled.
21561
21562 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21563 delivery is done for the original local part, even if other redirection items
21564 are present. If you are generating a multi-item list (for example, by reading a
21565 database) and need the ability to provide a no-op item, you must use
21566 &_/dev/null_&.
21567
21568 .next
21569 .cindex "delivery" "forcing failure"
21570 .cindex "delivery" "forcing deferral"
21571 .cindex "failing delivery" "forcing"
21572 .cindex "deferred delivery, forcing"
21573 .cindex "customizing" "failure message"
21574 An attempt to deliver a particular address can be deferred or forced to fail by
21575 redirection items of the form
21576 .code
21577 :defer:
21578 :fail:
21579 .endd
21580 respectively. When a redirection list contains such an item, it applies
21581 to the entire redirection; any other items in the list are ignored. Any
21582 text following &':fail:'& or &':defer:'& is placed in the error text
21583 associated with the failure. For example, an alias file might contain:
21584 .code
21585 X.Employee:  :fail: Gone away, no forwarding address
21586 .endd
21587 In the case of an address that is being verified from an ACL or as the subject
21588 of a
21589 .cindex "VRFY" "error text, display of"
21590 VRFY command, the text is included in the SMTP error response by
21591 default.
21592 .cindex "EXPN" "error text, display of"
21593 The text is not included in the response to an EXPN command. In non-SMTP cases
21594 the text is included in the error message that Exim generates.
21595
21596 .cindex "SMTP" "error codes"
21597 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21598 &':fail:'&. However, if the message starts with three digits followed by a
21599 space, optionally followed by an extended code of the form &'n.n.n'&, also
21600 followed by a space, and the very first digit is the same as the default error
21601 code, the code from the message is used instead. If the very first digit is
21602 incorrect, a panic error is logged, and the default code is used. You can
21603 suppress the use of the supplied code in a redirect router by setting the
21604 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21605 ignored.
21606
21607 .vindex "&$acl_verify_message$&"
21608 In an ACL, an explicitly provided message overrides the default, but the
21609 default message is available in the variable &$acl_verify_message$& and can
21610 therefore be included in a custom message if this is desired.
21611
21612 Normally the error text is the rest of the redirection list &-- a comma does
21613 not terminate it &-- but a newline does act as a terminator. Newlines are not
21614 normally present in alias expansions. In &(lsearch)& lookups they are removed
21615 as part of the continuation process, but they may exist in other kinds of
21616 lookup and in &':include:'& files.
21617
21618 During routing for message delivery (as opposed to verification), a redirection
21619 containing &':fail:'& causes an immediate failure of the incoming address,
21620 whereas &':defer:'& causes the message to remain in the queue so that a
21621 subsequent delivery attempt can happen at a later time. If an address is
21622 deferred for too long, it will ultimately fail, because the normal retry
21623 rules still apply.
21624
21625 .next
21626 .cindex "alias file" "exception to default"
21627 Sometimes it is useful to use a single-key search type with a default (see
21628 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21629 for exceptions to the default. These can be handled by aliasing them to
21630 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21631 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21632 results in an empty redirection list has the same effect.
21633 .endlist
21634
21635
21636 .section "Duplicate addresses" "SECTdupaddr"
21637 .cindex "duplicate addresses"
21638 .cindex "address duplicate, discarding"
21639 .cindex "pipe" "duplicated"
21640 Exim removes duplicate addresses from the list to which it is delivering, so as
21641 to deliver just one copy to each address. This does not apply to deliveries
21642 routed to pipes by different immediate parent addresses, but an indirect
21643 aliasing scheme of the type
21644 .code
21645 pipe:       |/some/command $local_part
21646 localpart1: pipe
21647 localpart2: pipe
21648 .endd
21649 does not work with a message that is addressed to both local parts, because
21650 when the second is aliased to the intermediate local part &"pipe"& it gets
21651 discarded as being the same as a previously handled address. However, a scheme
21652 such as
21653 .code
21654 localpart1: |/some/command $local_part
21655 localpart2: |/some/command $local_part
21656 .endd
21657 does result in two different pipe deliveries, because the immediate parents of
21658 the pipes are distinct.
21659
21660
21661
21662 .section "Repeated redirection expansion" "SECID128"
21663 .cindex "repeated redirection expansion"
21664 .cindex "address redirection" "repeated for each delivery attempt"
21665 When a message cannot be delivered to all of its recipients immediately,
21666 leading to two or more delivery attempts, redirection expansion is carried out
21667 afresh each time for those addresses whose children were not all previously
21668 delivered. If redirection is being used as a mailing list, this can lead to new
21669 members of the list receiving copies of old messages. The &%one_time%& option
21670 can be used to avoid this.
21671
21672
21673 .section "Errors in redirection lists" "SECID129"
21674 .cindex "address redirection" "errors"
21675 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21676 error is skipped, and an entry is written to the main log. This may be useful
21677 for mailing lists that are automatically managed. Otherwise, if an error is
21678 detected while generating the list of new addresses, the original address is
21679 deferred. See also &%syntax_errors_to%&.
21680
21681
21682
21683 .section "Private options for the redirect router" "SECID130"
21684
21685 .cindex "options" "&(redirect)& router"
21686 The private options for the &(redirect)& router are as follows:
21687
21688
21689 .option allow_defer redirect boolean false
21690 Setting this option allows the use of &':defer:'& in non-filter redirection
21691 data, or the &%defer%& command in an Exim filter file.
21692
21693
21694 .option allow_fail redirect boolean false
21695 .cindex "failing delivery" "from filter"
21696 If this option is true, the &':fail:'& item can be used in a redirection list,
21697 and the &%fail%& command may be used in an Exim filter file.
21698
21699
21700 .option allow_filter redirect boolean false
21701 .cindex "filter" "enabling use of"
21702 .cindex "Sieve filter" "enabling use of"
21703 Setting this option allows Exim to interpret redirection data that starts with
21704 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21705 are some features of Exim filter files that some administrators may wish to
21706 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21707
21708 It is also possible to lock out Exim filters or Sieve filters while allowing
21709 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21710
21711
21712 The filter is run using the uid and gid set by the generic &%user%& and
21713 &%group%& options. These take their defaults from the password data if
21714 &%check_local_user%& is set, so in the normal case of users' personal filter
21715 files, the filter is run as the relevant user. When &%allow_filter%& is set
21716 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21717
21718
21719
21720 .option allow_freeze redirect boolean false
21721 .cindex "freezing messages" "allowing in filter"
21722 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21723 This command is more normally encountered in system filters, and is disabled by
21724 default for redirection filters because it isn't something you usually want to
21725 let ordinary users do.
21726
21727
21728
21729 .option check_ancestor redirect boolean false
21730 This option is concerned with handling generated addresses that are the same
21731 as some address in the list of redirection ancestors of the current address.
21732 Although it is turned off by default in the code, it is set in the default
21733 configuration file for handling users' &_.forward_& files. It is recommended
21734 for this use of the &(redirect)& router.
21735
21736 When &%check_ancestor%& is set, if a generated address (including the domain)
21737 is the same as any ancestor of the current address, it is replaced by a copy of
21738 the current address. This helps in the case where local part A is aliased to B,
21739 and B has a &_.forward_& file pointing back to A. For example, within a single
21740 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21741 &_&~jb/.forward_& contains:
21742 .code
21743 \Joe.Bloggs, <other item(s)>
21744 .endd
21745 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21746 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21747 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21748 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21749 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21750 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21751 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21752 original address. See also the &%repeat_use%& option below.
21753
21754
21755 .option check_group redirect boolean "see below"
21756 When the &%file%& option is used, the group owner of the file is checked only
21757 when this option is set. The permitted groups are those listed in the
21758 &%owngroups%& option, together with the user's default group if
21759 &%check_local_user%& is set. If the file has the wrong group, routing is
21760 deferred. The default setting for this option is true if &%check_local_user%&
21761 is set and the &%modemask%& option permits the group write bit, or if the
21762 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21763
21764
21765
21766 .option check_owner redirect boolean "see below"
21767 When the &%file%& option is used, the owner of the file is checked only when
21768 this option is set. If &%check_local_user%& is set, the local user is
21769 permitted; otherwise the owner must be one of those listed in the &%owners%&
21770 option. The default value for this option is true if &%check_local_user%& or
21771 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21772
21773
21774 .option data redirect string&!! unset
21775 This option is mutually exclusive with &%file%&. One or other of them must be
21776 set, but not both. The contents of &%data%& are expanded, and then used as the
21777 list of forwarding items, or as a set of filtering instructions. If the
21778 expansion is forced to fail, or the result is an empty string or a string that
21779 has no effect (consists entirely of comments), the router declines.
21780
21781 When filtering instructions are used, the string must begin with &"#Exim
21782 filter"&, and all comments in the string, including this initial one, must be
21783 terminated with newline characters. For example:
21784 .code
21785 data = #Exim filter\n\
21786        if $h_to: contains Exim then save $home/mail/exim endif
21787 .endd
21788 If you are reading the data from a database where newlines cannot be included,
21789 you can use the &${sg}$& expansion item to turn the escape string of your
21790 choice into a newline.
21791
21792
21793 .option directory_transport redirect string&!! unset
21794 A &(redirect)& router sets up a direct delivery to a directory when a path name
21795 ending with a slash is specified as a new &"address"&. The transport used is
21796 specified by this option, which, after expansion, must be the name of a
21797 configured transport. This should normally be an &(appendfile)& transport.
21798
21799
21800 .option file redirect string&!! unset
21801 This option specifies the name of a file that contains the redirection data. It
21802 is mutually exclusive with the &%data%& option. The string is expanded before
21803 use; if the expansion is forced to fail, the router declines. Other expansion
21804 failures cause delivery to be deferred. The result of a successful expansion
21805 must be an absolute path. The entire file is read and used as the redirection
21806 data. If the data is an empty string or a string that has no effect (consists
21807 entirely of comments), the router declines.
21808
21809 .cindex "NFS" "checking for file existence"
21810 If the attempt to open the file fails with a &"does not exist"& error, Exim
21811 runs a check on the containing directory,
21812 unless &%ignore_enotdir%& is true (see below).
21813 If the directory does not appear to exist, delivery is deferred. This can
21814 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21815 is a mount problem. If the containing directory does exist, but the file does
21816 not, the router declines.
21817
21818
21819 .option file_transport redirect string&!! unset
21820 .vindex "&$address_file$&"
21821 A &(redirect)& router sets up a direct delivery to a file when a path name not
21822 ending in a slash is specified as a new &"address"&. The transport used is
21823 specified by this option, which, after expansion, must be the name of a
21824 configured transport. This should normally be an &(appendfile)& transport. When
21825 it is running, the filename is in &$address_file$&.
21826
21827
21828 .option filter_prepend_home redirect boolean true
21829 When this option is true, if a &(save)& command in an Exim filter specifies a
21830 relative path, and &$home$& is defined, it is automatically prepended to the
21831 relative path. If this option is set false, this action does not happen. The
21832 relative path is then passed to the transport unmodified.
21833
21834
21835 .option forbid_blackhole redirect boolean false
21836 .cindex "restricting access to features"
21837 .cindex "filter" "locking out certain features"
21838 If this option is true, the &':blackhole:'& item may not appear in a
21839 redirection list.
21840
21841
21842 .option forbid_exim_filter redirect boolean false
21843 .cindex "restricting access to features"
21844 .cindex "filter" "locking out certain features"
21845 If this option is set true, only Sieve filters are permitted when
21846 &%allow_filter%& is true.
21847
21848
21849
21850
21851 .option forbid_file redirect boolean false
21852 .cindex "restricting access to features"
21853 .cindex "delivery" "to file; forbidding"
21854 .cindex "filter" "locking out certain features"
21855 .cindex "Sieve filter" "forbidding delivery to a file"
21856 .cindex "Sieve filter" "&""keep""& facility; disabling"
21857 If this option is true, this router may not generate a new address that
21858 specifies delivery to a local file or directory, either from a filter or from a
21859 conventional forward file. This option is forced to be true if &%one_time%& is
21860 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21861 locks out the Sieve's &"keep"& facility.
21862
21863
21864 .option forbid_filter_dlfunc redirect boolean false
21865 .cindex "restricting access to features"
21866 .cindex "filter" "locking out certain features"
21867 If this option is true, string expansions in Exim filters are not allowed to
21868 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21869 functions.
21870
21871 .option forbid_filter_existstest redirect boolean false
21872 .cindex "restricting access to features"
21873 .cindex "filter" "locking out certain features"
21874 .cindex "expansion" "statting a file"
21875 If this option is true, string expansions in Exim filters are not allowed to
21876 make use of the &%exists%& condition or the &%stat%& expansion item.
21877
21878 .option forbid_filter_logwrite redirect boolean false
21879 .cindex "restricting access to features"
21880 .cindex "filter" "locking out certain features"
21881 If this option is true, use of the logging facility in Exim filters is not
21882 permitted. Logging is in any case available only if the filter is being run
21883 under some unprivileged uid (which is normally the case for ordinary users'
21884 &_.forward_& files).
21885
21886
21887 .option forbid_filter_lookup redirect boolean false
21888 .cindex "restricting access to features"
21889 .cindex "filter" "locking out certain features"
21890 If this option is true, string expansions in Exim filter files are not allowed
21891 to make use of &%lookup%& items.
21892
21893
21894 .option forbid_filter_perl redirect boolean false
21895 .cindex "restricting access to features"
21896 .cindex "filter" "locking out certain features"
21897 This option has an effect only if Exim is built with embedded Perl support. If
21898 it is true, string expansions in Exim filter files are not allowed to make use
21899 of the embedded Perl support.
21900
21901
21902 .option forbid_filter_readfile redirect boolean false
21903 .cindex "restricting access to features"
21904 .cindex "filter" "locking out certain features"
21905 If this option is true, string expansions in Exim filter files are not allowed
21906 to make use of &%readfile%& items.
21907
21908
21909 .option forbid_filter_readsocket redirect boolean false
21910 .cindex "restricting access to features"
21911 .cindex "filter" "locking out certain features"
21912 If this option is true, string expansions in Exim filter files are not allowed
21913 to make use of &%readsocket%& items.
21914
21915
21916 .option forbid_filter_reply redirect boolean false
21917 .cindex "restricting access to features"
21918 .cindex "filter" "locking out certain features"
21919 If this option is true, this router may not generate an automatic reply
21920 message. Automatic replies can be generated only from Exim or Sieve filter
21921 files, not from traditional forward files. This option is forced to be true if
21922 &%one_time%& is set.
21923
21924
21925 .option forbid_filter_run redirect boolean false
21926 .cindex "restricting access to features"
21927 .cindex "filter" "locking out certain features"
21928 If this option is true, string expansions in Exim filter files are not allowed
21929 to make use of &%run%& items.
21930
21931
21932 .option forbid_include redirect boolean false
21933 .cindex "restricting access to features"
21934 .cindex "filter" "locking out certain features"
21935 If this option is true, items of the form
21936 .code
21937 :include:<path name>
21938 .endd
21939 are not permitted in non-filter redirection lists.
21940
21941
21942 .option forbid_pipe redirect boolean false
21943 .cindex "restricting access to features"
21944 .cindex "filter" "locking out certain features"
21945 .cindex "delivery" "to pipe; forbidding"
21946 If this option is true, this router may not generate a new address which
21947 specifies delivery to a pipe, either from an Exim filter or from a conventional
21948 forward file. This option is forced to be true if &%one_time%& is set.
21949
21950
21951 .option forbid_sieve_filter redirect boolean false
21952 .cindex "restricting access to features"
21953 .cindex "filter" "locking out certain features"
21954 If this option is set true, only Exim filters are permitted when
21955 &%allow_filter%& is true.
21956
21957
21958 .cindex "SMTP" "error codes"
21959 .option forbid_smtp_code redirect boolean false
21960 If this option is set true, any SMTP error codes that are present at the start
21961 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21962 the default codes (451 and 550, respectively) are always used.
21963
21964
21965
21966
21967 .option hide_child_in_errmsg redirect boolean false
21968 .cindex "bounce message" "redirection details; suppressing"
21969 If this option is true, it prevents Exim from quoting a child address if it
21970 generates a bounce or delay message for it. Instead it says &"an address
21971 generated from <&'the top level address'&>"&. Of course, this applies only to
21972 bounces generated locally. If a message is forwarded to another host, &'its'&
21973 bounce may well quote the generated address.
21974
21975
21976 .option ignore_eacces redirect boolean false
21977 .cindex "EACCES"
21978 If this option is set and an attempt to open a redirection file yields the
21979 EACCES error (permission denied), the &(redirect)& router behaves as if the
21980 file did not exist.
21981
21982
21983 .option ignore_enotdir redirect boolean false
21984 .cindex "ENOTDIR"
21985 If this option is set and an attempt to open a redirection file yields the
21986 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21987 router behaves as if the file did not exist.
21988
21989 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21990 router that has the &%file%& option set discovers that the file does not exist
21991 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21992 against unmounted NFS directories. If the parent can not be statted, delivery
21993 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21994 is set, because that option tells Exim to ignore &"something on the path is not
21995 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21996 that some operating systems give ENOENT where others give ENOTDIR.
21997
21998
21999
22000 .option include_directory redirect string unset
22001 If this option is set, the path names of any &':include:'& items in a
22002 redirection list must start with this directory.
22003
22004
22005 .option modemask redirect "octal integer" 022
22006 This specifies mode bits which must not be set for a file specified by the
22007 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
22008
22009
22010 .option one_time redirect boolean false
22011 .cindex "one-time aliasing/forwarding expansion"
22012 .cindex "alias file" "one-time expansion"
22013 .cindex "forward file" "one-time expansion"
22014 .cindex "mailing lists" "one-time expansion"
22015 .cindex "address redirection" "one-time expansion"
22016 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
22017 files each time it tries to deliver a message causes a problem when one or more
22018 of the generated addresses fails be delivered at the first attempt. The problem
22019 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
22020 but of what happens when the redirection list changes during the time that the
22021 message is on Exim's queue. This is particularly true in the case of mailing
22022 lists, where new subscribers might receive copies of messages that were posted
22023 before they subscribed.
22024
22025 If &%one_time%& is set and any addresses generated by the router fail to
22026 deliver at the first attempt, the failing addresses are added to the message as
22027 &"top level"& addresses, and the parent address that generated them is marked
22028 &"delivered"&. Thus, redirection does not happen again at the next delivery
22029 attempt.
22030
22031 &*Warning 1*&: Any header line addition or removal that is specified by this
22032 router would be lost if delivery did not succeed at the first attempt. For this
22033 reason, the &%headers_add%& and &%headers_remove%& generic options are not
22034 permitted when &%one_time%& is set.
22035
22036 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
22037 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
22038 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
22039
22040 &*Warning 3*&: The &%unseen%& generic router option may not be set with
22041 &%one_time%&.
22042
22043 The original top-level address is remembered with each of the generated
22044 addresses, and is output in any log messages. However, any intermediate parent
22045 addresses are not recorded. This makes a difference to the log only if
22046 &%all_parents%& log selector is set. It is expected that &%one_time%& will
22047 typically be used for mailing lists, where there is normally just one level of
22048 expansion.
22049
22050
22051 .option owners redirect "string list" unset
22052 .cindex "ownership" "alias file"
22053 .cindex "ownership" "forward file"
22054 .cindex "alias file" "ownership"
22055 .cindex "forward file" "ownership"
22056 This specifies a list of permitted owners for the file specified by &%file%&.
22057 This list is in addition to the local user when &%check_local_user%& is set.
22058 See &%check_owner%& above.
22059
22060
22061 .option owngroups redirect "string list" unset
22062 This specifies a list of permitted groups for the file specified by &%file%&.
22063 The list is in addition to the local user's primary group when
22064 &%check_local_user%& is set. See &%check_group%& above.
22065
22066
22067 .option pipe_transport redirect string&!! unset
22068 .vindex "&$address_pipe$&"
22069 A &(redirect)& router sets up a direct delivery to a pipe when a string
22070 starting with a vertical bar character is specified as a new &"address"&. The
22071 transport used is specified by this option, which, after expansion, must be the
22072 name of a configured transport. This should normally be a &(pipe)& transport.
22073 When the transport is run, the pipe command is in &$address_pipe$&.
22074
22075
22076 .option qualify_domain redirect string&!! unset
22077 .vindex "&$qualify_recipient$&"
22078 If this option is set, and an unqualified address (one without a domain) is
22079 generated, and that address would normally be qualified by the global setting
22080 in &%qualify_recipient%&, it is instead qualified with the domain specified by
22081 expanding this string. If the expansion fails, the router declines. If you want
22082 to revert to the default, you can have the expansion generate
22083 &$qualify_recipient$&.
22084
22085 This option applies to all unqualified addresses generated by Exim filters,
22086 but for traditional &_.forward_& files, it applies only to addresses that are
22087 not preceded by a backslash. Sieve filters cannot generate unqualified
22088 addresses.
22089
22090 .option qualify_preserve_domain redirect boolean false
22091 .cindex "domain" "in redirection; preserving"
22092 .cindex "preserving domain in redirection"
22093 .cindex "address redirection" "domain; preserving"
22094 If this option is set, the router's local &%qualify_domain%& option must not be
22095 set (a configuration error occurs if it is). If an unqualified address (one
22096 without a domain) is generated, it is qualified with the domain of the parent
22097 address (the immediately preceding ancestor) instead of the global
22098 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22099 this applies whether or not the address is preceded by a backslash.
22100
22101
22102 .option repeat_use redirect boolean true
22103 If this option is set false, the router is skipped for a child address that has
22104 any ancestor that was routed by this router. This test happens before any of
22105 the other preconditions are tested. Exim's default anti-looping rules skip
22106 only when the ancestor is the same as the current address. See also
22107 &%check_ancestor%& above and the generic &%redirect_router%& option.
22108
22109
22110 .option reply_transport redirect string&!! unset
22111 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22112 &%vacation%& command is used in a filter file. The transport used is specified
22113 by this option, which, after expansion, must be the name of a configured
22114 transport. This should normally be an &(autoreply)& transport. Other transports
22115 are unlikely to do anything sensible or useful.
22116
22117
22118 .option rewrite redirect boolean true
22119 .cindex "address redirection" "disabling rewriting"
22120 If this option is set false, addresses generated by the router are not
22121 subject to address rewriting. Otherwise, they are treated like new addresses
22122 and are rewritten according to the global rewriting rules.
22123
22124
22125 .option sieve_subaddress redirect string&!! unset
22126 The value of this option is passed to a Sieve filter to specify the
22127 :subaddress part of an address.
22128
22129 .option sieve_useraddress redirect string&!! unset
22130 The value of this option is passed to a Sieve filter to specify the :user part
22131 of an address. However, if it is unset, the entire original local part
22132 (including any prefix or suffix) is used for :user.
22133
22134
22135 .option sieve_vacation_directory redirect string&!! unset
22136 .cindex "Sieve filter" "vacation directory"
22137 To enable the &"vacation"& extension for Sieve filters, you must set
22138 &%sieve_vacation_directory%& to the directory where vacation databases are held
22139 (do not put anything else in that directory), and ensure that the
22140 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22141 needs their own directory; Exim will create it if necessary.
22142
22143
22144
22145 .option skip_syntax_errors redirect boolean false
22146 .cindex "forward file" "broken"
22147 .cindex "address redirection" "broken files"
22148 .cindex "alias file" "broken"
22149 .cindex "broken alias or forward files"
22150 .cindex "ignoring faulty addresses"
22151 .cindex "skipping faulty addresses"
22152 .cindex "error" "skipping bad syntax"
22153 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22154 non-filter redirection data are skipped, and each failing address is logged. If
22155 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22156 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22157 are expanded and placed at the head of the error message generated by
22158 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22159 be the same address as the generic &%errors_to%& option. The
22160 &%skip_syntax_errors%& option is often used when handling mailing lists.
22161
22162 If all the addresses in a redirection list are skipped because of syntax
22163 errors, the router declines to handle the original address, and it is passed to
22164 the following routers.
22165
22166 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22167 error in the filter causes filtering to be abandoned without any action being
22168 taken. The incident is logged, and the router declines to handle the address,
22169 so it is passed to the following routers.
22170
22171 .cindex "Sieve filter" "syntax errors in"
22172 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22173 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22174 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22175
22176 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22177 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22178 option, used with an address that does not get redirected, can be used to
22179 notify users of these errors, by means of a router like this:
22180 .code
22181 userforward:
22182   driver = redirect
22183   allow_filter
22184   check_local_user
22185   file = $home/.forward
22186   file_transport = address_file
22187   pipe_transport = address_pipe
22188   reply_transport = address_reply
22189   no_verify
22190   skip_syntax_errors
22191   syntax_errors_to = real-$local_part@$domain
22192   syntax_errors_text = \
22193    This is an automatically generated message. An error has\n\
22194    been found in your .forward file. Details of the error are\n\
22195    reported below. While this error persists, you will receive\n\
22196    a copy of this message for every message that is addressed\n\
22197    to you. If your .forward file is a filter file, or if it is\n\
22198    a non-filter file containing no valid forwarding addresses,\n\
22199    a copy of each incoming message will be put in your normal\n\
22200    mailbox. If a non-filter file contains at least one valid\n\
22201    forwarding address, forwarding to the valid addresses will\n\
22202    happen, and those will be the only deliveries that occur.
22203 .endd
22204 You also need a router to ensure that local addresses that are prefixed by
22205 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22206 put this immediately before the &(userforward)& router:
22207 .code
22208 real_localuser:
22209   driver = accept
22210   check_local_user
22211   local_part_prefix = real-
22212   transport = local_delivery
22213 .endd
22214 For security, it would probably be a good idea to restrict the use of this
22215 router to locally-generated messages, using a condition such as this:
22216 .code
22217   condition = ${if match {$sender_host_address}\
22218                          {\N^(|127\.0\.0\.1)$\N}}
22219 .endd
22220
22221
22222 .option syntax_errors_text redirect string&!! unset
22223 See &%skip_syntax_errors%& above.
22224
22225
22226 .option syntax_errors_to redirect string unset
22227 See &%skip_syntax_errors%& above.
22228 .ecindex IIDredrou1
22229 .ecindex IIDredrou2
22230
22231
22232
22233
22234
22235
22236 . ////////////////////////////////////////////////////////////////////////////
22237 . ////////////////////////////////////////////////////////////////////////////
22238
22239 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22240          "Environment for local transports"
22241 .scindex IIDenvlotra1 "local transports" "environment for"
22242 .scindex IIDenvlotra2 "environment" "local transports"
22243 .scindex IIDenvlotra3 "transport" "local; environment for"
22244 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22245 transport can be thought of as similar to a pipe.) Exim always runs transports
22246 in subprocesses, under specified uids and gids. Typical deliveries to local
22247 mailboxes run under the uid and gid of the local user.
22248
22249 Exim also sets a specific current directory while running the transport; for
22250 some transports a home directory setting is also relevant. The &(pipe)&
22251 transport is the only one that sets up environment variables; see section
22252 &<<SECTpipeenv>>& for details.
22253
22254 The values used for the uid, gid, and the directories may come from several
22255 different places. In many cases, the router that handles the address associates
22256 settings with that address as a result of its &%check_local_user%&, &%group%&,
22257 or &%user%& options. However, values may also be given in the transport's own
22258 configuration, and these override anything that comes from the router.
22259
22260
22261
22262 .section "Concurrent deliveries" "SECID131"
22263 .cindex "concurrent deliveries"
22264 .cindex "simultaneous deliveries"
22265 If two different messages for the same local recipient arrive more or less
22266 simultaneously, the two delivery processes are likely to run concurrently. When
22267 the &(appendfile)& transport is used to write to a file, Exim applies locking
22268 rules to stop concurrent processes from writing to the same file at the same
22269 time.
22270
22271 However, when you use a &(pipe)& transport, it is up to you to arrange any
22272 locking that is needed. Here is a silly example:
22273 .code
22274 my_transport:
22275   driver = pipe
22276   command = /bin/sh -c 'cat >>/some/file'
22277 .endd
22278 This is supposed to write the message at the end of the file. However, if two
22279 messages arrive at the same time, the file will be scrambled. You can use the
22280 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22281 file using the same algorithm that Exim itself uses.
22282
22283
22284
22285
22286 .section "Uids and gids" "SECTenvuidgid"
22287 .cindex "local transports" "uid and gid"
22288 .cindex "transport" "local; uid and gid"
22289 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22290 overrides any group that the router set in the address, even if &%user%& is not
22291 set for the transport. This makes it possible, for example, to run local mail
22292 delivery under the uid of the recipient (set by the router), but in a special
22293 group (set by the transport). For example:
22294 .code
22295 # Routers ...
22296 # User/group are set by check_local_user in this router
22297 local_users:
22298   driver = accept
22299   check_local_user
22300   transport = group_delivery
22301
22302 # Transports ...
22303 # This transport overrides the group
22304 group_delivery:
22305   driver = appendfile
22306   file = /var/spool/mail/$local_part_data
22307   group = mail
22308 .endd
22309 If &%user%& is set for a transport, its value overrides what is set in the
22310 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22311 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22312 set.
22313
22314 .oindex "&%initgroups%&"
22315 When the uid is taken from the transport's configuration, the &[initgroups()]&
22316 function is called for the groups associated with that uid if the
22317 &%initgroups%& option is set for the transport. When the uid is not specified
22318 by the transport, but is associated with the address by a router, the option
22319 for calling &[initgroups()]& is taken from the router configuration.
22320
22321 .cindex "&(pipe)& transport" "uid for"
22322 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22323 is set and &%user%& is not set, the uid of the process that called Exim to
22324 receive the message is used, and if &%group%& is not set, the corresponding
22325 original gid is also used.
22326
22327 This is the detailed preference order for obtaining a gid; the first of the
22328 following that is set is used:
22329
22330 .ilist
22331 A &%group%& setting of the transport;
22332 .next
22333 A &%group%& setting of the router;
22334 .next
22335 A gid associated with a user setting of the router, either as a result of
22336 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22337 .next
22338 The group associated with a non-numeric &%user%& setting of the transport;
22339 .next
22340 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22341 the uid is the creator's uid;
22342 .next
22343 The Exim gid if the Exim uid is being used as a default.
22344 .endlist
22345
22346 If, for example, the user is specified numerically on the router and there are
22347 no group settings, no gid is available. In this situation, an error occurs.
22348 This is different for the uid, for which there always is an ultimate default.
22349 The first of the following that is set is used:
22350
22351 .ilist
22352 A &%user%& setting of the transport;
22353 .next
22354 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22355 .next
22356 A &%user%& setting of the router;
22357 .next
22358 A &%check_local_user%& setting of the router;
22359 .next
22360 The Exim uid.
22361 .endlist
22362
22363 Of course, an error will still occur if the uid that is chosen is on the
22364 &%never_users%& list.
22365
22366
22367
22368
22369
22370 .section "Current and home directories" "SECID132"
22371 .cindex "current directory for local transport"
22372 .cindex "home directory" "for local transport"
22373 .cindex "transport" "local; home directory for"
22374 .cindex "transport" "local; current directory for"
22375 Routers may set current and home directories for local transports by means of
22376 the &%transport_current_directory%& and &%transport_home_directory%& options.
22377 However, if the transport's &%current_directory%& or &%home_directory%& options
22378 are set, they override the router's values. In detail, the home directory
22379 for a local transport is taken from the first of these values that is set:
22380
22381 .ilist
22382 The &%home_directory%& option on the transport;
22383 .next
22384 The &%transport_home_directory%& option on the router;
22385 .next
22386 The password data if &%check_local_user%& is set on the router;
22387 .next
22388 The &%router_home_directory%& option on the router.
22389 .endlist
22390
22391 The current directory is taken from the first of these values that is set:
22392
22393 .ilist
22394 The &%current_directory%& option on the transport;
22395 .next
22396 The &%transport_current_directory%& option on the router.
22397 .endlist
22398
22399
22400 If neither the router nor the transport sets a current directory, Exim uses the
22401 value of the home directory, if it is set. Otherwise it sets the current
22402 directory to &_/_& before running a local transport.
22403
22404
22405
22406 .section "Expansion variables derived from the address" "SECID133"
22407 .vindex "&$domain$&"
22408 .vindex "&$local_part$&"
22409 .vindex "&$original_domain$&"
22410 Normally a local delivery is handling a single address, and in that case the
22411 variables such as &$domain$& and &$local_part$& are set during local
22412 deliveries. However, in some circumstances more than one address may be handled
22413 at once (for example, while writing batch SMTP for onward transmission by some
22414 other means). In this case, the variables associated with the local part are
22415 never set, &$domain$& is set only if all the addresses have the same domain,
22416 and &$original_domain$& is never set.
22417 .ecindex IIDenvlotra1
22418 .ecindex IIDenvlotra2
22419 .ecindex IIDenvlotra3
22420
22421
22422
22423
22424
22425
22426
22427 . ////////////////////////////////////////////////////////////////////////////
22428 . ////////////////////////////////////////////////////////////////////////////
22429
22430 .chapter "Generic options for transports" "CHAPtransportgeneric"
22431 .scindex IIDgenoptra1 "generic options" "transport"
22432 .scindex IIDgenoptra2 "options" "generic; for transports"
22433 .scindex IIDgenoptra3 "transport" "generic options for"
22434 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22435 prior to Exim 4.95 names would be silently truncated at this length, but now
22436 it is enforced.
22437
22438 The following generic options apply to all transports:
22439
22440
22441 .option body_only transports boolean false
22442 .cindex "transport" "body only"
22443 .cindex "message" "transporting body only"
22444 .cindex "body of message" "transporting"
22445 If this option is set, the message's headers are not transported. It is
22446 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22447 or &(pipe)& transports, the settings of &%message_prefix%& and
22448 &%message_suffix%& should be checked, because this option does not
22449 automatically suppress them.
22450
22451
22452 .option current_directory transports string&!! unset
22453 .cindex "transport" "current directory for"
22454 This specifies the current directory that is to be set while running the
22455 transport, overriding any value that may have been set by the router.
22456 If the expansion fails for any reason, including forced failure, an error is
22457 logged, and delivery is deferred.
22458
22459
22460 .option disable_logging transports boolean false
22461 If this option is set true, nothing is logged for any
22462 deliveries by the transport or for any
22463 transport errors. You should not set this option unless you really, really know
22464 what you are doing.
22465
22466
22467 .option debug_print transports string&!! unset
22468 .cindex "testing" "variables in drivers"
22469 If this option is set and debugging is enabled (see the &%-d%& command line
22470 option), the string is expanded and included in the debugging output when the
22471 transport is run.
22472 If expansion of the string fails, the error message is written to the debugging
22473 output, and Exim carries on processing.
22474 This facility is provided to help with checking out the values of variables and
22475 so on when debugging driver configurations. For example, if a &%headers_add%&
22476 option is not working properly, &%debug_print%& could be used to output the
22477 variables it references. A newline is added to the text if it does not end with
22478 one.
22479 The variables &$transport_name$& and &$router_name$& contain the name of the
22480 transport and the router that called it.
22481
22482 .option delivery_date_add transports boolean false
22483 .cindex "&'Delivery-date:'& header line"
22484 If this option is true, a &'Delivery-date:'& header is added to the message.
22485 This gives the actual time the delivery was made. As this is not a standard
22486 header, Exim has a configuration option (&%delivery_date_remove%&) which
22487 requests its removal from incoming messages, so that delivered messages can
22488 safely be resent to other recipients.
22489
22490
22491 .option driver transports string unset
22492 This specifies which of the available transport drivers is to be used.
22493 There is no default, and this option must be set for every transport.
22494
22495
22496 .option envelope_to_add transports boolean false
22497 .cindex "&'Envelope-to:'& header line"
22498 If this option is true, an &'Envelope-to:'& header is added to the message.
22499 This gives the original address(es) in the incoming envelope that caused this
22500 delivery to happen. More than one address may be present if the transport is
22501 configured to handle several addresses at once, or if more than one original
22502 address was redirected to the same final address. As this is not a standard
22503 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22504 its removal from incoming messages, so that delivered messages can safely be
22505 resent to other recipients.
22506
22507 &*Note:*& If used on a transport handling multiple recipients
22508 (the smtp transport unless &%max_rcpt%& is 1, the appendfile, pipe or lmtp
22509 transport if &%batch_max%& is greater than 1)
22510 then information about Bcc recipients will be leaked.
22511 Doing so is generally not advised.
22512
22513
22514 .option event_action transports string&!! unset
22515 .cindex events
22516 This option declares a string to be expanded for Exim's events mechanism.
22517 For details see chapter &<<CHAPevents>>&.
22518
22519
22520 .option group transports string&!! "Exim group"
22521 .cindex "transport" "group; specifying"
22522 This option specifies a gid for running the transport process, overriding any
22523 value that the router supplies, and also overriding any value associated with
22524 &%user%& (see below).
22525
22526
22527 .option headers_add transports list&!! unset
22528 .cindex "header lines" "adding in transport"
22529 .cindex "transport" "header lines; adding"
22530 This option specifies a list of text headers,
22531 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22532 which are (separately) expanded and added to the header
22533 portion of a message as it is transported, as described in section
22534 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22535 routers. If the result of the expansion is an empty string, or if the expansion
22536 is forced to fail, no action is taken. Other expansion failures are treated as
22537 errors and cause the delivery to be deferred.
22538
22539 Unlike most options, &%headers_add%& can be specified multiple times
22540 for a transport; all listed headers are added.
22541
22542
22543 .option headers_only transports boolean false
22544 .cindex "transport" "header lines only"
22545 .cindex "message" "transporting headers only"
22546 .cindex "header lines" "transporting"
22547 If this option is set, the message's body is not transported. It is mutually
22548 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22549 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22550 checked, since this option does not automatically suppress them.
22551
22552
22553 .option headers_remove transports list&!! unset
22554 .cindex "header lines" "removing"
22555 .cindex "transport" "header lines; removing"
22556 This option specifies a list of text headers,
22557 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22558 to be removed from the message.
22559 However, the option has no effect when an address is just being verified.
22560 Each list item is separately expanded.
22561 If the result of the expansion is an empty string, or if the expansion
22562 is forced to fail, no action is taken. Other expansion failures are treated as
22563 errors and cause the delivery to be deferred.
22564 If an item ends in *, it will match any header with the given prefix.
22565
22566 Matching headers are omitted from the message as it is transported, as described
22567 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22568 routers.
22569
22570 Unlike most options, &%headers_remove%& can be specified multiple times
22571 for a transport; all listed headers are removed.
22572
22573 &*Warning*&: Because of the separate expansion of the list items,
22574 items that contain a list separator must have it doubled.
22575 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22576
22577
22578
22579 .option headers_rewrite transports string unset
22580 .cindex "transport" "header lines; rewriting"
22581 .cindex "rewriting" "at transport time"
22582 This option allows addresses in header lines to be rewritten at transport time,
22583 that is, as the message is being copied to its destination. The contents of the
22584 option are a colon-separated list of rewriting rules. Each rule is in exactly
22585 the same form as one of the general rewriting rules that are applied when a
22586 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22587 example,
22588 .code
22589 headers_rewrite = a@b c@d f : \
22590                   x@y w@z
22591 .endd
22592 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22593 &'w@z'& in all address-bearing header lines. The rules are applied to the
22594 header lines just before they are written out at transport time, so they affect
22595 only those copies of the message that pass through the transport. However, only
22596 the message's original header lines, and any that were added by a system
22597 filter, are rewritten. If a router or transport adds header lines, they are not
22598 affected by this option. These rewriting rules are &'not'& applied to the
22599 envelope. You can change the return path using &%return_path%&, but you cannot
22600 change envelope recipients at this time.
22601
22602
22603 .option home_directory transports string&!! unset
22604 .cindex "transport" "home directory for"
22605 .vindex "&$home$&"
22606 This option specifies a home directory setting for a local transport,
22607 overriding any value that may be set by the router. The home directory is
22608 placed in &$home$& while expanding the transport's private options. It is also
22609 used as the current directory if no current directory is set by the
22610 &%current_directory%& option on the transport or the
22611 &%transport_current_directory%& option on the router. If the expansion fails
22612 for any reason, including forced failure, an error is logged, and delivery is
22613 deferred.
22614
22615
22616 .option initgroups transports boolean false
22617 .cindex "additional groups"
22618 .cindex "groups" "additional"
22619 .cindex "transport" "group; additional"
22620 If this option is true and the uid for the delivery process is provided by the
22621 transport, the &[initgroups()]& function is called when running the transport
22622 to ensure that any additional groups associated with the uid are set up.
22623
22624
22625 .option max_parallel transports integer&!! unset
22626 .cindex limit "transport parallelism"
22627 .cindex transport "parallel processes"
22628 .cindex transport "concurrency limit"
22629 .cindex "delivery" "parallelism for transport"
22630 If this option is set and expands to an integer greater than zero
22631 it limits the number of concurrent runs of the transport.
22632 The control does not apply to shadow transports.
22633
22634 .cindex "hints database" "transport concurrency control"
22635 Exim implements this control by means of a hints database in which a record is
22636 incremented whenever a transport process is being created. The record
22637 is decremented and possibly removed when the process terminates.
22638 Obviously there is scope for
22639 records to get left lying around if there is a system or program crash. To
22640 guard against this, Exim ignores any records that are more than six hours old.
22641
22642 If you use this option, you should also arrange to delete the
22643 relevant hints database whenever your system reboots. The names of the files
22644 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22645 may be one or two files, depending on the type of DBM in use. The same files
22646 are used for ETRN and smtp transport serialization.
22647
22648
22649 .option message_size_limit transports string&!! 0
22650 .cindex "limit" "message size per transport"
22651 .cindex "size" "of message, limit"
22652 .cindex "transport" "message size; limiting"
22653 This option controls the size of messages passed through the transport. It is
22654 expanded before use; the result of the expansion must be a sequence of decimal
22655 digits, optionally followed by K or M. If the expansion fails for any reason,
22656 including forced failure, or if the result is not of the required form,
22657 delivery is deferred. If the value is greater than zero and the size of a
22658 message exceeds this limit, the address is failed. If there is any chance that
22659 the resulting bounce message could be routed to the same transport, you should
22660 ensure that &%return_size_limit%& is less than the transport's
22661 &%message_size_limit%&, as otherwise the bounce message will fail to get
22662 delivered.
22663
22664
22665
22666 .option rcpt_include_affixes transports boolean false
22667 .cindex "prefix" "for local part, including in envelope"
22668 .cindex "suffix for local part" "including in envelope"
22669 .cindex "local part" "prefix"
22670 .cindex "local part" "suffix"
22671 When this option is false (the default), and an address that has had any
22672 affixes (prefixes or suffixes) removed from the local part is delivered by any
22673 form of SMTP or LMTP, the affixes are not included. For example, if a router
22674 that contains
22675 .code
22676 local_part_prefix = *-
22677 .endd
22678 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22679 is delivered with
22680 .code
22681 RCPT TO:<xyz@some.domain>
22682 .endd
22683 This is also the case when an ACL-time callout is being used to verify a
22684 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22685 whole local part is included in the RCPT command. This option applies to BSMTP
22686 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22687 &(lmtp)& and &(smtp)& transports.
22688
22689
22690 .option retry_use_local_part transports boolean "see below"
22691 .cindex "hints database" "retry keys"
22692 When a delivery suffers a temporary failure, a retry record is created
22693 in Exim's hints database. For remote deliveries, the key for the retry record
22694 is based on the name and/or IP address of the failing remote host. For local
22695 deliveries, the key is normally the entire address, including both the local
22696 part and the domain. This is suitable for most common cases of local delivery
22697 temporary failure &-- for example, exceeding a mailbox quota should delay only
22698 deliveries to that mailbox, not to the whole domain.
22699
22700 However, in some special cases you may want to treat a temporary local delivery
22701 as a failure associated with the domain, and not with a particular local part.
22702 (For example, if you are storing all mail for some domain in files.) You can do
22703 this by setting &%retry_use_local_part%& false.
22704
22705 For all the local transports, its default value is true. For remote transports,
22706 the default value is false for tidiness, but changing the value has no effect
22707 on a remote transport in the current implementation.
22708
22709
22710 .option return_path transports string&!! unset
22711 .cindex "envelope sender"
22712 .cindex "envelope from"
22713 .cindex "transport" "return path; changing"
22714 .cindex "return path" "changing in transport"
22715 If this option is set, the string is expanded at transport time and replaces
22716 the existing return path (envelope sender) value in the copy of the message
22717 that is being delivered. An empty return path is permitted. This feature is
22718 designed for remote deliveries, where the value of this option is used in the
22719 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22720 only effect is to change the address that is placed in the &'Return-path:'&
22721 header line, if one is added to the message (see the next option).
22722
22723 &*Note:*& A changed return path is not logged unless you add
22724 &%return_path_on_delivery%& to the log selector.
22725
22726 .vindex "&$return_path$&"
22727 The expansion can refer to the existing value via &$return_path$&. This is
22728 either the message's envelope sender, or an address set by the
22729 &%errors_to%& option on a router. If the expansion is forced to fail, no
22730 replacement occurs; if it fails for another reason, delivery is deferred. This
22731 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22732 section &<<SECTverp>>&.
22733
22734 &*Note*&: If a delivery error is detected locally, including the case when a
22735 remote server rejects a message at SMTP time, the bounce message is not sent to
22736 the value of this option. It is sent to the previously set errors address.
22737 This defaults to the incoming sender address, but can be changed by setting
22738 &%errors_to%& in a router.
22739
22740
22741
22742 .option return_path_add transports boolean false
22743 .chindex Return-path:
22744 If this option is true, a &'Return-path:'& header is added to the message.
22745 Although the return path is normally available in the prefix line of BSD
22746 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22747 have easy access to it.
22748
22749 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22750 the delivery SMTP server makes the final delivery"&. This implies that this
22751 header should not be present in incoming messages. Exim has a configuration
22752 option, &%return_path_remove%&, which requests removal of this header from
22753 incoming messages, so that delivered messages can safely be resent to other
22754 recipients.
22755
22756
22757 .option shadow_condition transports string&!! unset
22758 See &%shadow_transport%& below.
22759
22760
22761 .option shadow_transport transports string unset
22762 .cindex "shadow transport"
22763 .cindex "transport" "shadow"
22764 A local transport may set the &%shadow_transport%& option to the name of
22765 another local transport. Shadow remote transports are not supported.
22766
22767 Whenever a delivery to the main transport succeeds, and either
22768 &%shadow_condition%& is unset, or its expansion does not result in the empty
22769 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22770 passed to the shadow transport, with the same delivery address or addresses. If
22771 expansion fails, no action is taken except that non-forced expansion failures
22772 cause a log line to be written.
22773
22774 The result of the shadow transport is discarded and does not affect the
22775 subsequent processing of the message. Only a single level of shadowing is
22776 provided; the &%shadow_transport%& option is ignored on any transport when it
22777 is running as a shadow. Options concerned with output from pipes are also
22778 ignored. The log line for the successful delivery has an item added on the end,
22779 of the form
22780 .code
22781 ST=<shadow transport name>
22782 .endd
22783 If the shadow transport did not succeed, the error message is put in
22784 parentheses afterwards. Shadow transports can be used for a number of different
22785 purposes, including keeping more detailed log information than Exim normally
22786 provides, and implementing automatic acknowledgment policies based on message
22787 headers that some sites insist on.
22788
22789
22790 .option transport_filter transports string&!! unset
22791 .cindex "transport" "filter"
22792 .cindex "filter" "transport filter"
22793 This option sets up a filtering (in the Unix shell sense) process for messages
22794 at transport time. It should not be confused with mail filtering as set up by
22795 individual users or via a system filter.
22796 If unset, or expanding to an empty string, no filtering is done.
22797
22798 When the message is about to be written out, the command specified by
22799 &%transport_filter%& is started up in a separate, parallel process, and
22800 the entire message, including the header lines, is passed to it on its standard
22801 input (this in fact is done from a third process, to avoid deadlock).
22802 The command must be specified as an absolute path.
22803
22804 The process run by the command must use its standard input as the message
22805 data to be transformed, and write the results on its standard output.
22806
22807 The lines of the message that are written to the transport filter are
22808 terminated by newline (&"\n"&). The message is passed to the filter before any
22809 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22810 lines beginning with a dot, and also before any processing implied by the
22811 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22812 &(pipe)& transports.
22813
22814 The standard error for the filter process is set to the same destination as its
22815 standard output; this is read and written to the message's ultimate
22816 destination. The process that writes the message to the filter, the
22817 filter itself, and the original process that reads the result and delivers it
22818 are all run in parallel, like a shell pipeline.
22819
22820 The filter can perform any transformations it likes, but of course should take
22821 care not to break RFC 2822 syntax. Exim does not check the result, except to
22822 test for a final newline when SMTP is in use. All messages transmitted over
22823 SMTP must end with a newline, so Exim supplies one if it is missing.
22824
22825 .cindex "content scanning" "per user"
22826 A transport filter can be used to provide content-scanning on a per-user basis
22827 at delivery time if the only required effect of the scan is to modify the
22828 message. For example, a content scan could insert a new header line containing
22829 a spam score. This could be interpreted by a filter in the user's MUA. It is
22830 not possible to discard a message at this stage.
22831
22832 .cindex "SIZE" "ESMTP extension"
22833 A problem might arise if the filter increases the size of a message that is
22834 being sent down an SMTP connection. If the receiving SMTP server has indicated
22835 support for the SIZE parameter, Exim will have sent the size of the message
22836 at the start of the SMTP session. If what is actually sent is substantially
22837 more, the server might reject the message. This can be worked round by setting
22838 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22839 additions to the message, or to disable the use of SIZE altogether.
22840
22841 .vindex "&$pipe_addresses$&"
22842 The value of the &%transport_filter%& option is the command string for starting
22843 the filter, which is run directly from Exim, not under a shell. The string is
22844 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22845 Exim breaks it up into arguments and then expands each argument separately (see
22846 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22847 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22848 of arguments, one for each address that applies to this delivery. (This isn't
22849 an ideal name for this feature here, but as it was already implemented for the
22850 &(pipe)& transport, it seemed sensible not to change it.)
22851
22852 .vindex "&$host$&"
22853 .vindex "&$host_address$&"
22854 The expansion variables &$host$& and &$host_address$& are available when the
22855 transport is a remote one. They contain the name and IP address of the host to
22856 which the message is being sent. For example:
22857 . used to have $sender_address in this cmdline, but it's tainted
22858 .code
22859 transport_filter = /some/directory/transport-filter.pl \
22860   $host $host_address $pipe_addresses
22861 .endd
22862
22863 Two problems arise if you want to use more complicated expansion items to
22864 generate transport filter commands, both of which due to the fact that the
22865 command is split up &'before'& expansion.
22866 .ilist
22867 If an expansion item contains white space, you must quote it, so that it is all
22868 part of the same command item. If the entire option setting is one such
22869 expansion item, you have to take care what kind of quoting you use. For
22870 example:
22871 .code
22872 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22873 .endd
22874 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22875 &(/bin/cmd2)& otherwise.
22876
22877 Option strings in general have any fully-surrounding double quote wrapping
22878 removed early in parsing (see &<<SECTstrings>>&).
22879 Then, for this option, quotes protect against whitespace being
22880 regarded as a separator while splitting into the command argument vector.
22881 Either double or single quotes can be used here;
22882 the former interprets backlash-quoted charachters
22883 and the latter does not.
22884
22885 If double quotes had been used in this example, they would have been
22886 stripped by Exim when it read the option's value. When the value is used, if
22887 the single quotes were missing, the line would be split into two items,
22888 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22889 Exim tried to expand the first one.
22890 .next
22891 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22892 expansion cannot generate multiple arguments, or a command name followed by
22893 arguments. Consider this example:
22894 .code
22895 transport_filter = ${lookup{$host}lsearch{/a/file}\
22896                     {$value}{/bin/cat}}
22897 .endd
22898 The result of the lookup is interpreted as the name of the command, even
22899 if it contains white space. The simplest way round this is to use a shell:
22900 .code
22901 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22902                                {$value}{/bin/cat}}
22903 .endd
22904 .endlist
22905
22906 The filter process is run under the same uid and gid as the normal delivery.
22907 For remote deliveries this is the Exim uid/gid by default. The command should
22908 normally yield a zero return code. Transport filters are not supposed to fail.
22909 A non-zero code is taken to mean that the transport filter encountered some
22910 serious problem. Delivery of the message is deferred; the message remains on
22911 the queue and is tried again later. It is not possible to cause a message to be
22912 bounced from a transport filter.
22913
22914 If a transport filter is set on an autoreply transport, the original message is
22915 passed through the filter as it is being copied into the newly generated
22916 message, which happens if the &%return_message%& option is set.
22917
22918
22919 .option transport_filter_timeout transports time 5m
22920 .cindex "transport" "filter, timeout"
22921 When Exim is reading the output of a transport filter, it applies a timeout
22922 that can be set by this option. Exceeding the timeout is normally treated as a
22923 temporary delivery failure. However, if a transport filter is used with a
22924 &(pipe)& transport, a timeout in the transport filter is treated in the same
22925 way as a timeout in the pipe command itself. By default, a timeout is a hard
22926 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22927 becomes a temporary error.
22928
22929
22930 .option user transports string&!! "Exim user"
22931 .cindex "uid (user id)" "local delivery"
22932 .cindex "transport" "user, specifying"
22933 This option specifies the user under whose uid the delivery process is to be
22934 run, overriding any uid that may have been set by the router. If the user is
22935 given as a name, the uid is looked up from the password data, and the
22936 associated group is taken as the value of the gid to be used if the &%group%&
22937 option is not set.
22938
22939 For deliveries that use local transports, a user and group are normally
22940 specified explicitly or implicitly (for example, as a result of
22941 &%check_local_user%&) by the router or transport.
22942
22943 .cindex "hints database" "access by remote transport"
22944 For remote transports, you should leave this option unset unless you really are
22945 sure you know what you are doing. When a remote transport is running, it needs
22946 to be able to access Exim's hints databases, because each host may have its own
22947 retry data.
22948 .ecindex IIDgenoptra1
22949 .ecindex IIDgenoptra2
22950 .ecindex IIDgenoptra3
22951
22952
22953
22954
22955
22956
22957 . ////////////////////////////////////////////////////////////////////////////
22958 . ////////////////////////////////////////////////////////////////////////////
22959
22960 .chapter "Address batching in local transports" "CHAPbatching" &&&
22961          "Address batching"
22962 .cindex "transport" "local; address batching in"
22963 The only remote transport (&(smtp)&) is normally configured to handle more than
22964 one address at a time, so that when several addresses are routed to the same
22965 remote host, just one copy of the message is sent. Local transports, however,
22966 normally handle one address at a time. That is, a separate instance of the
22967 transport is run for each address that is routed to the transport. A separate
22968 copy of the message is delivered each time.
22969
22970 .cindex "batched local delivery"
22971 .oindex "&%batch_max%&"
22972 .oindex "&%batch_id%&"
22973 In special cases, it may be desirable to handle several addresses at once in a
22974 local transport, for example:
22975
22976 .ilist
22977 In an &(appendfile)& transport, when storing messages in files for later
22978 delivery by some other means, a single copy of the message with multiple
22979 recipients saves space.
22980 .next
22981 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22982 a single copy saves time, and is the normal way LMTP is expected to work.
22983 .next
22984 In a &(pipe)& transport, when passing the message
22985 to a scanner program or
22986 to some other delivery mechanism such as UUCP, multiple recipients may be
22987 acceptable.
22988 .endlist
22989
22990 These three local transports all have the same options for controlling multiple
22991 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22992 repeating the information for each transport, these options are described here.
22993
22994 The &%batch_max%& option specifies the maximum number of addresses that can be
22995 delivered together in a single run of the transport. Its default value is one
22996 (no batching). When more than one address is routed to a transport that has a
22997 &%batch_max%& value greater than one, the addresses are delivered in a batch
22998 (that is, in a single run of the transport with multiple recipients), subject
22999 to certain conditions:
23000
23001 .ilist
23002 .vindex "&$local_part$&"
23003 If any of the transport's options contain a reference to &$local_part$&, no
23004 batching is possible.
23005 .next
23006 .vindex "&$domain$&"
23007 If any of the transport's options contain a reference to &$domain$&, only
23008 addresses with the same domain are batched.
23009 .next
23010 .cindex "customizing" "batching condition"
23011 If &%batch_id%& is set, it is expanded for each address, and only those
23012 addresses with the same expanded value are batched. This allows you to specify
23013 customized batching conditions. Failure of the expansion for any reason,
23014 including forced failure, disables batching, but it does not stop the delivery
23015 from taking place.
23016 .next
23017 Batched addresses must also have the same errors address (where to send
23018 delivery errors), the same header additions and removals, the same user and
23019 group for the transport, and if a host list is present, the first host must
23020 be the same.
23021 .endlist
23022
23023 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
23024 both when the file or pipe command is specified in the transport, and when it
23025 is specified by a &(redirect)& router, but all the batched addresses must of
23026 course be routed to the same file or pipe command. These two transports have an
23027 option called &%use_bsmtp%&, which causes them to deliver the message in
23028 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
23029 &%check_string%& and &%escape_string%& options are forced to the values
23030 .code
23031 check_string = "."
23032 escape_string = ".."
23033 .endd
23034 when batched SMTP is in use. A full description of the batch SMTP mechanism is
23035 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
23036 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
23037
23038 .cindex "&'Envelope-to:'& header line"
23039 If the generic &%envelope_to_add%& option is set for a batching transport, the
23040 &'Envelope-to:'& header that is added to the message contains all the addresses
23041 that are being processed together. If you are using a batching &(appendfile)&
23042 transport without &%use_bsmtp%&, the only way to preserve the recipient
23043 addresses is to set the &%envelope_to_add%& option.
23044
23045 .cindex "&(pipe)& transport" "with multiple addresses"
23046 .vindex "&$pipe_addresses$&"
23047 If you are using a &(pipe)& transport without BSMTP, and setting the
23048 transport's &%command%& option, you can include &$pipe_addresses$& as part of
23049 the command. This is not a true variable; it is a bit of magic that causes each
23050 of the recipient addresses to be inserted into the command as a separate
23051 argument. This provides a way of accessing all the addresses that are being
23052 delivered in the batch. &*Note:*& This is not possible for pipe commands that
23053 are specified by a &(redirect)& router.
23054
23055
23056
23057
23058 . ////////////////////////////////////////////////////////////////////////////
23059 . ////////////////////////////////////////////////////////////////////////////
23060
23061 .chapter "The appendfile transport" "CHAPappendfile"
23062 .scindex IIDapptra1 "&(appendfile)& transport"
23063 .scindex IIDapptra2 "transports" "&(appendfile)&"
23064 .cindex "directory creation"
23065 .cindex "creating directories"
23066 The &(appendfile)& transport delivers a message by appending it to an existing
23067 file, or by creating an entirely new file in a specified directory. Single
23068 files to which messages are appended can be in the traditional Unix mailbox
23069 format, or optionally in the MBX format supported by the Pine MUA and
23070 University of Washington IMAP daemon, &'inter alia'&. When each message is
23071 being delivered as a separate file, &"maildir"& format can optionally be used
23072 to give added protection against failures that happen part-way through the
23073 delivery. A third form of separate-file delivery known as &"mailstore"& is also
23074 supported. For all file formats, Exim attempts to create as many levels of
23075 directory as necessary, provided that &%create_directory%& is set.
23076
23077 The code for the optional formats is not included in the Exim binary by
23078 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
23079 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
23080 included.
23081
23082 .cindex "quota" "system"
23083 Exim recognizes system quota errors, and generates an appropriate message. Exim
23084 also supports its own quota control within the transport, for use when the
23085 system facility is unavailable or cannot be used for some reason.
23086
23087 If there is an error while appending to a file (for example, quota exceeded or
23088 partition filled), Exim attempts to reset the file's length and last
23089 modification time back to what they were before. If there is an error while
23090 creating an entirely new file, the new file is removed.
23091
23092 Before appending to a file, a number of security checks are made, and the
23093 file is locked. A detailed description is given below, after the list of
23094 private options.
23095
23096 The &(appendfile)& transport is most commonly used for local deliveries to
23097 users' mailboxes. However, it can also be used as a pseudo-remote transport for
23098 putting messages into files for remote delivery by some means other than Exim.
23099 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23100 option).
23101
23102
23103
23104 .section "The file and directory options" "SECTfildiropt"
23105 The &%file%& option specifies a single file, to which the message is appended;
23106 the &%directory%& option specifies a directory, in which a new file containing
23107 the message is created. Only one of these two options can be set, and for
23108 normal deliveries to mailboxes, one of them &'must'& be set.
23109
23110 .vindex "&$address_file$&"
23111 .vindex "&$local_part$&"
23112 However, &(appendfile)& is also used for delivering messages to files or
23113 directories whose names (or parts of names) are obtained from alias,
23114 forwarding, or filtering operations (for example, a &%save%& command in a
23115 user's Exim filter). When such a transport is running, &$local_part$& contains
23116 the local part that was aliased or forwarded, and &$address_file$& contains the
23117 name (or partial name) of the file or directory generated by the redirection
23118 operation. There are two cases:
23119
23120 .ilist
23121 If neither &%file%& nor &%directory%& is set, the redirection operation
23122 must specify an absolute path (one that begins with &`/`&). This is the most
23123 common case when users with local accounts use filtering to sort mail into
23124 different folders. See for example, the &(address_file)& transport in the
23125 default configuration. If the path ends with a slash, it is assumed to be the
23126 name of a directory. A delivery to a directory can also be forced by setting
23127 &%maildir_format%& or &%mailstore_format%&.
23128 .next
23129 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23130 used to determine the file or directory name for the delivery. Normally, the
23131 contents of &$address_file$& are used in some way in the string expansion.
23132 .endlist
23133 If the &%create_file%& option is set to a path which
23134 matches (see the option definition below for details)
23135 a file or directory name
23136 for the delivery, that name becomes de-tainted.
23137
23138 .cindex "tainted data" "in filenames"
23139 .cindex appendfile "tainted data"
23140 Tainted data may not be used for a file or directory name.
23141 This means that, for instance, &$local_part$& cannot be used directly
23142 as a component of a path.  It can however be used as the key for a lookup
23143 which returns a path (or component).
23144
23145
23146 .cindex "Sieve filter" "configuring &(appendfile)&"
23147 .cindex "Sieve filter" "relative mailbox path handling"
23148 As an example of the second case, consider an environment where users do not
23149 have home directories. They may be permitted to use Exim filter commands of the
23150 form:
23151 .code
23152 save folder23
23153 .endd
23154 or Sieve filter commands of the form:
23155 .code
23156 require "fileinto";
23157 fileinto "folder23";
23158 .endd
23159 In this situation, the expansion of &%file%& or &%directory%& in the transport
23160 must transform the relative path into an appropriate absolute filename. In the
23161 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23162 is used as a result of a &"keep"& action in the filter. This example shows one
23163 way of handling this requirement:
23164 .code
23165 file = ${if eq{$address_file}{inbox} \
23166             {/var/mail/$local_part_data} \
23167             {${if eq{${substr_0_1:$address_file}}{/} \
23168                   {$address_file} \
23169                   {$home/mail/$address_file} \
23170             }} \
23171        }
23172 .endd
23173 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23174 location, absolute paths are used without change, and other folders are in the
23175 &_mail_& directory within the home directory.
23176
23177 &*Note 1*&: While processing an Exim filter, a relative path such as
23178 &_folder23_& is turned into an absolute path if a home directory is known to
23179 the router. In particular, this is the case if &%check_local_user%& is set. If
23180 you want to prevent this happening at routing time, you can set
23181 &%router_home_directory%& empty. This forces the router to pass the relative
23182 path to the transport.
23183
23184 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23185 the &%file%& or &%directory%& option is still used if it is set.
23186
23187
23188
23189
23190 .section "Private options for appendfile" "SECID134"
23191 .cindex "options" "&(appendfile)& transport"
23192
23193
23194
23195 .option allow_fifo appendfile boolean false
23196 .cindex "fifo (named pipe)"
23197 .cindex "named pipe (fifo)"
23198 .cindex "pipe" "named (fifo)"
23199 Setting this option permits delivery to named pipes (FIFOs) as well as to
23200 regular files. If no process is reading the named pipe at delivery time, the
23201 delivery is deferred.
23202
23203
23204 .option allow_symlink appendfile boolean false
23205 .cindex "symbolic link" "to mailbox"
23206 .cindex "mailbox" "symbolic link"
23207 By default, &(appendfile)& will not deliver if the path name for the file is
23208 that of a symbolic link. Setting this option relaxes that constraint, but there
23209 are security issues involved in the use of symbolic links. Be sure you know
23210 what you are doing if you set this. Details of exactly what this option affects
23211 are included in the discussion which follows this list of options.
23212
23213
23214 .option batch_id appendfile string&!! unset
23215 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23216 However, batching is automatically disabled for &(appendfile)& deliveries that
23217 happen as a result of forwarding or aliasing or other redirection directly to a
23218 file.
23219
23220
23221 .option batch_max appendfile integer 1
23222 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23223
23224
23225 .option check_group appendfile boolean false
23226 When this option is set, the group owner of the file defined by the &%file%&
23227 option is checked to see that it is the same as the group under which the
23228 delivery process is running. The default setting is false because the default
23229 file mode is 0600, which means that the group is irrelevant.
23230
23231
23232 .option check_owner appendfile boolean true
23233 When this option is set, the owner of the file defined by the &%file%& option
23234 is checked to ensure that it is the same as the user under which the delivery
23235 process is running.
23236
23237
23238 .option check_string appendfile string "see below"
23239 .cindex "&""From""& line"
23240 As &(appendfile)& writes the message, the start of each line is tested for
23241 matching &%check_string%&, and if it does, the initial matching characters are
23242 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23243 a literal string, not a regular expression, and the case of any letters it
23244 contains is significant.
23245
23246 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23247 are forced to &"."& and &".."& respectively, and any settings in the
23248 configuration are ignored. Otherwise, they default to &"From&~"& and
23249 &">From&~"& when the &%file%& option is set, and unset when any of the
23250 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23251
23252 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23253 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23254 &"From&~"& indicates the start of a new message. All four options need changing
23255 if another format is used. For example, to deliver to mailboxes in MMDF format:
23256 .cindex "MMDF format mailbox"
23257 .cindex "mailbox" "MMDF format"
23258 .code
23259 check_string = "\1\1\1\1\n"
23260 escape_string = "\1\1\1\1 \n"
23261 message_prefix = "\1\1\1\1\n"
23262 message_suffix = "\1\1\1\1\n"
23263 .endd
23264 .option create_directory appendfile boolean true
23265 .cindex "directory creation"
23266 When this option is true, Exim attempts to create any missing superior
23267 directories for the file that it is about to write. A created directory's mode
23268 is given by the &%directory_mode%& option.
23269
23270 The group ownership of a newly created directory is highly dependent on the
23271 operating system (and possibly the file system) that is being used. For
23272 example, in Solaris, if the parent directory has the setgid bit set, its group
23273 is propagated to the child; if not, the currently set group is used. However,
23274 in FreeBSD, the parent's group is always used.
23275
23276
23277
23278 .option create_file appendfile string anywhere
23279 This option constrains the location of files and directories that are created
23280 by this transport. It applies to files defined by the &%file%& option and
23281 directories defined by the &%directory%& option. In the case of maildir
23282 delivery, it applies to the top level directory, not the maildir directories
23283 beneath.
23284
23285 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23286 &"belowhome"&, or to an absolute path.
23287
23288 In the second and third cases, a home directory must have been
23289 set for the transport, and the file or directory being created must
23290 reside within it.
23291 The "belowhome" checking additionally checks for attempts to use "../"
23292 to evade the testing.
23293 This option is not useful when an explicit filename is
23294 given for normal mailbox deliveries. It is intended for the case when filenames
23295 are generated from users' &_.forward_& files. These are usually handled
23296 by an &(appendfile)& transport called &%address_file%&. See also
23297 &%file_must_exist%&.
23298
23299 In the fourth case,
23300 the value given for this option must be an absolute path for an
23301 existing directory.
23302 The value is used for checking instead of a home directory;
23303 checking is done in "belowhome" mode.
23304
23305 .cindex "tainted data" "de-tainting"
23306 .cindex "de-tainting" "using appendfile create_file option"
23307 If "belowhome" checking is used, the file or directory path
23308 becomes de-tainted.
23309
23310
23311 .option directory appendfile string&!! unset
23312 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23313 or &%directory%& must be set, unless the delivery is the direct result of a
23314 redirection (see section &<<SECTfildiropt>>&).
23315
23316 When &%directory%& is set, the string is expanded, and the message is delivered
23317 into a new file or files in or below the given directory, instead of being
23318 appended to a single mailbox file. A number of different formats are provided
23319 (see &%maildir_format%& and &%mailstore_format%&), and see section
23320 &<<SECTopdir>>& for further details of this form of delivery.
23321
23322 The result of expansion must not be tainted, unless the &%create_file%& option
23323 specifies a path.
23324
23325
23326 .option directory_file appendfile string&!! "see below"
23327 .cindex "base62"
23328 .vindex "&$inode$&"
23329 When &%directory%& is set, but neither &%maildir_format%& nor
23330 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23331 whose name is obtained by expanding this string. The default value is:
23332 .code
23333 q${base62:$tod_epoch}-$inode
23334 .endd
23335 This generates a unique name from the current time, in base 62 form, and the
23336 inode of the file. The variable &$inode$& is available only when expanding this
23337 option.
23338
23339
23340 .option directory_mode appendfile "octal integer" 0700
23341 If &(appendfile)& creates any directories as a result of the
23342 &%create_directory%& option, their mode is specified by this option.
23343
23344
23345 .option escape_string appendfile string "see description"
23346 See &%check_string%& above.
23347
23348
23349 .option file appendfile string&!! unset
23350 This option is mutually exclusive with the &%directory%& option, but one of
23351 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23352 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23353 specifies a single file, to which the message is appended. One or more of
23354 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23355 &%file%&.
23356
23357 The result of expansion must not be tainted, unless the &%create_file%& option
23358 specifies a path.
23359
23360 .cindex "NFS" "lock file"
23361 .cindex "locking files"
23362 .cindex "lock files"
23363 If you are using more than one host to deliver over NFS into the same
23364 mailboxes, you should always use lock files.
23365
23366 The string value is expanded for each delivery, and must yield an absolute
23367 path. The most common settings of this option are variations on one of these
23368 examples:
23369 .code
23370 file = /var/spool/mail/$local_part_data
23371 file = /home/$local_part_data/inbox
23372 file = $home/inbox
23373 .endd
23374 .cindex "&""sticky""& bit"
23375 In the first example, all deliveries are done into the same directory. If Exim
23376 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23377 create a file in the directory, so the &"sticky"& bit must be turned on for
23378 deliveries to be possible, or alternatively the &%group%& option can be used to
23379 run the delivery under a group id which has write access to the directory.
23380
23381
23382
23383 .option file_format appendfile string unset
23384 .cindex "file" "mailbox; checking existing format"
23385 This option requests the transport to check the format of an existing file
23386 before adding to it. The check consists of matching a specific string at the
23387 start of the file. The value of the option consists of an even number of
23388 colon-separated strings. The first of each pair is the test string, and the
23389 second is the name of a transport. If the transport associated with a matched
23390 string is not the current transport, control is passed over to the other
23391 transport. For example, suppose the standard &(local_delivery)& transport has
23392 this added to it:
23393 .code
23394 file_format = "From       : local_delivery :\
23395                \1\1\1\1\n : local_mmdf_delivery"
23396 .endd
23397 Mailboxes that begin with &"From"& are still handled by this transport, but if
23398 a mailbox begins with four binary ones followed by a newline, control is passed
23399 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23400 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23401 is assumed to match the current transport. If the start of a mailbox doesn't
23402 match any string, or if the transport named for a given string is not defined,
23403 delivery is deferred.
23404
23405
23406 .option file_must_exist appendfile boolean false
23407 If this option is true, the file specified by the &%file%& option must exist.
23408 A temporary error occurs if it does not, causing delivery to be deferred.
23409 If this option is false, the file is created if it does not exist.
23410
23411
23412 .option lock_fcntl_timeout appendfile time 0s
23413 .cindex "timeout" "mailbox locking"
23414 .cindex "mailbox" "locking, blocking and non-blocking"
23415 .cindex "locking files"
23416 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23417 when locking an open mailbox file. If the call fails, the delivery process
23418 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23419 Non-blocking calls are used so that the file is not kept open during the wait
23420 for the lock; the reason for this is to make it as safe as possible for
23421 deliveries over NFS in the case when processes might be accessing an NFS
23422 mailbox without using a lock file. This should not be done, but
23423 misunderstandings and hence misconfigurations are not unknown.
23424
23425 On a busy system, however, the performance of a non-blocking lock approach is
23426 not as good as using a blocking lock with a timeout. In this case, the waiting
23427 is done inside the system call, and Exim's delivery process acquires the lock
23428 and can proceed as soon as the previous lock holder releases it.
23429
23430 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23431 timeout, are used. There may still be some retrying: the maximum number of
23432 retries is
23433 .code
23434 (lock_retries * lock_interval) / lock_fcntl_timeout
23435 .endd
23436 rounded up to the next whole number. In other words, the total time during
23437 which &(appendfile)& is trying to get a lock is roughly the same, unless
23438 &%lock_fcntl_timeout%& is set very large.
23439
23440 You should consider setting this option if you are getting a lot of delayed
23441 local deliveries because of errors of the form
23442 .code
23443 failed to lock mailbox /some/file (fcntl)
23444 .endd
23445
23446 .option lock_flock_timeout appendfile time 0s
23447 This timeout applies to file locking when using &[flock()]& (see
23448 &%use_flock%&); the timeout operates in a similar manner to
23449 &%lock_fcntl_timeout%&.
23450
23451
23452 .option lock_interval appendfile time 3s
23453 This specifies the time to wait between attempts to lock the file. See below
23454 for details of locking.
23455
23456
23457 .option lock_retries appendfile integer 10
23458 This specifies the maximum number of attempts to lock the file. A value of zero
23459 is treated as 1. See below for details of locking.
23460
23461
23462 .option lockfile_mode appendfile "octal integer" 0600
23463 This specifies the mode of the created lock file, when a lock file is being
23464 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23465
23466
23467 .option lockfile_timeout appendfile time 30m
23468 .cindex "timeout" "mailbox locking"
23469 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23470 exists and is older than this value, it is assumed to have been left behind by
23471 accident, and Exim attempts to remove it.
23472
23473
23474 .option mailbox_filecount appendfile string&!! unset
23475 .cindex "mailbox" "specifying size of"
23476 .cindex "size" "of mailbox"
23477 If this option is set, it is expanded, and the result is taken as the current
23478 number of files in the mailbox. It must be a decimal number, optionally
23479 followed by K or M. This provides a way of obtaining this information from an
23480 external source that maintains the data.
23481
23482
23483 .option mailbox_size appendfile string&!! unset
23484 .cindex "mailbox" "specifying size of"
23485 .cindex "size" "of mailbox"
23486 If this option is set, it is expanded, and the result is taken as the current
23487 size the mailbox. It must be a decimal number, optionally followed by K or M.
23488 This provides a way of obtaining this information from an external source that
23489 maintains the data. This is likely to be helpful for maildir deliveries where
23490 it is computationally expensive to compute the size of a mailbox.
23491
23492
23493
23494 .option maildir_format appendfile boolean false
23495 .cindex "maildir format" "specifying"
23496 If this option is set with the &%directory%& option, the delivery is into a new
23497 file, in the &"maildir"& format that is used by other mail software. When the
23498 transport is activated directly from a &(redirect)& router (for example, the
23499 &(address_file)& transport in the default configuration), setting
23500 &%maildir_format%& causes the path received from the router to be treated as a
23501 directory, whether or not it ends with &`/`&. This option is available only if
23502 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23503 &<<SECTmaildirdelivery>>& below for further details.
23504
23505
23506 .option maildir_quota_directory_regex appendfile string "See below"
23507 .cindex "maildir format" "quota; directories included in"
23508 .cindex "quota" "maildir; directories included in"
23509 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23510 a regular expression for specifying directories, relative to the quota
23511 directory (see &%quota_directory%&), that should be included in the quota
23512 calculation. The default value is:
23513 .code
23514 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23515 .endd
23516 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23517 (directories whose names begin with a dot). If you want to exclude the
23518 &_Trash_&
23519 folder from the count (as some sites do), you need to change this setting to
23520 .code
23521 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23522 .endd
23523 This uses a negative lookahead in the regular expression to exclude the
23524 directory whose name is &_.Trash_&. When a directory is excluded from quota
23525 calculations, quota processing is bypassed for any messages that are delivered
23526 directly into that directory.
23527
23528
23529 .option maildir_retries appendfile integer 10
23530 This option specifies the number of times to retry when writing a file in
23531 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23532
23533
23534 .option maildir_tag appendfile string&!! unset
23535 This option applies only to deliveries in maildir format, and is described in
23536 section &<<SECTmaildirdelivery>>& below.
23537
23538
23539 .option maildir_use_size_file appendfile&!! boolean false
23540 .cindex "maildir format" "&_maildirsize_& file"
23541 The result of string expansion for this option must be a valid boolean value.
23542 If it is true, it enables support for &_maildirsize_& files. Exim
23543 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23544 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23545 value is zero. See &%maildir_quota_directory_regex%& above and section
23546 &<<SECTmaildirdelivery>>& below for further details.
23547
23548 .option maildirfolder_create_regex appendfile string unset
23549 .cindex "maildir format" "&_maildirfolder_& file"
23550 .cindex "&_maildirfolder_&, creating"
23551 The value of this option is a regular expression. If it is unset, it has no
23552 effect. Otherwise, before a maildir delivery takes place, the pattern is
23553 matched against the name of the maildir directory, that is, the directory
23554 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23555 delivery. If there is a match, Exim checks for the existence of a file called
23556 &_maildirfolder_& in the directory, and creates it if it does not exist.
23557 See section &<<SECTmaildirdelivery>>& for more details.
23558
23559
23560 .option mailstore_format appendfile boolean false
23561 .cindex "mailstore format" "specifying"
23562 If this option is set with the &%directory%& option, the delivery is into two
23563 new files in  &"mailstore"& format. The option is available only if
23564 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23565 below for further details.
23566
23567
23568 .option mailstore_prefix appendfile string&!! unset
23569 This option applies only to deliveries in mailstore format, and is described in
23570 section &<<SECTopdir>>& below.
23571
23572
23573 .option mailstore_suffix appendfile string&!! unset
23574 This option applies only to deliveries in mailstore format, and is described in
23575 section &<<SECTopdir>>& below.
23576
23577
23578 .option mbx_format appendfile boolean false
23579 .cindex "locking files"
23580 .cindex "file" "locking"
23581 .cindex "file" "MBX format"
23582 .cindex "MBX format, specifying"
23583 This option is available only if Exim has been compiled with SUPPORT_MBX
23584 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23585 the message is appended to the mailbox file in MBX format instead of
23586 traditional Unix format. This format is supported by Pine4 and its associated
23587 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23588
23589 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23590 automatically changed by the use of &%mbx_format%&. They should normally be set
23591 empty when using MBX format, so this option almost always appears in this
23592 combination:
23593 .code
23594 mbx_format = true
23595 message_prefix =
23596 message_suffix =
23597 .endd
23598 If none of the locking options are mentioned in the configuration,
23599 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23600 is possible to specify the other kinds of locking with &%mbx_format%&, but
23601 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23602 interworks with &'c-client'&, providing for shared access to the mailbox. It
23603 should not be used if any program that does not use this form of locking is
23604 going to access the mailbox, nor should it be used if the mailbox file is NFS
23605 mounted, because it works only when the mailbox is accessed from a single host.
23606
23607 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23608 the standard version of &'c-client'&, because as long as it has a mailbox open
23609 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23610 append messages to it.
23611
23612
23613 .option message_prefix appendfile string&!! "see below"
23614 .cindex "&""From""& line"
23615 The string specified here is expanded and output at the start of every message.
23616 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23617 in which case it is:
23618 .code
23619 message_prefix = "From ${if def:return_path{$return_path}\
23620   {MAILER-DAEMON}} $tod_bsdinbox\n"
23621 .endd
23622 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23623 &`\n`& to &`\r\n`& in &%message_prefix%&.
23624
23625 .option message_suffix appendfile string&!! "see below"
23626 The string specified here is expanded and output at the end of every message.
23627 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23628 in which case it is a single newline character. The suffix can be suppressed by
23629 setting
23630 .code
23631 message_suffix =
23632 .endd
23633 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23634 &`\n`& to &`\r\n`& in &%message_suffix%&.
23635
23636 .option mode appendfile "octal integer" 0600
23637 If the output file is created, it is given this mode. If it already exists and
23638 has wider permissions, they are reduced to this mode. If it has narrower
23639 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23640 if the delivery is the result of a &%save%& command in a filter file specifying
23641 a particular mode, the mode of the output file is always forced to take that
23642 value, and this option is ignored.
23643
23644
23645 .option mode_fail_narrower appendfile boolean true
23646 This option applies in the case when an existing mailbox file has a narrower
23647 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23648 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23649 continues with the delivery attempt, using the existing mode of the file.
23650
23651
23652 .option notify_comsat appendfile boolean false
23653 If this option is true, the &'comsat'& daemon is notified after every
23654 successful delivery to a user mailbox. This is the daemon that notifies logged
23655 on users about incoming mail.
23656
23657
23658 .option quota appendfile string&!! unset
23659 .cindex "quota" "imposed by Exim"
23660 This option imposes a limit on the size of the file to which Exim is appending,
23661 or to the total space used in the directory tree when the &%directory%& option
23662 is set. In the latter case, computation of the space used is expensive, because
23663 all the files in the directory (and any sub-directories) have to be
23664 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23665 &%maildir_use_size_file%& for ways to avoid this in environments where users
23666 have no shell access to their mailboxes).
23667
23668 As there is no interlock against two simultaneous deliveries into a
23669 multi-file mailbox, it is possible for the quota to be overrun in this case.
23670 For single-file mailboxes, of course, an interlock is a necessity.
23671
23672 A file's size is taken as its &'used'& value. Because of blocking effects, this
23673 may be a lot less than the actual amount of disk space allocated to the file.
23674 If the sizes of a number of files are being added up, the rounding effect can
23675 become quite noticeable, especially on systems that have large block sizes.
23676 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23677 the obvious value which users understand most easily.
23678
23679 The value of the option is expanded, and must then be a numerical value
23680 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23681 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23682 and further option modifiers. If Exim is running on a system with
23683 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23684 be handled.
23685
23686 The option modifier &%no_check%& can be used to force delivery even if the over
23687 quota condition is met. The quota gets updated as usual.
23688
23689 &*Note*&: A value of zero is interpreted as &"no quota"&.
23690
23691 The expansion happens while Exim is running as root, before it changes uid for
23692 the delivery. This means that files that are inaccessible to the end user can
23693 be used to hold quota values that are looked up in the expansion. When delivery
23694 fails because this quota is exceeded, the handling of the error is as for
23695 system quota failures.
23696
23697 By default, Exim's quota checking mimics system quotas, and restricts the
23698 mailbox to the specified maximum size, though the value is not accurate to the
23699 last byte, owing to separator lines and additional headers that may get added
23700 during message delivery. When a mailbox is nearly full, large messages may get
23701 refused even though small ones are accepted, because the size of the current
23702 message is added to the quota when the check is made. This behaviour can be
23703 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23704 for exceeding the quota does not include the current message. Thus, deliveries
23705 continue until the quota has been exceeded; thereafter, no further messages are
23706 delivered. See also &%quota_warn_threshold%&.
23707
23708
23709 .option quota_directory appendfile string&!! unset
23710 This option defines the directory to check for quota purposes when delivering
23711 into individual files. The default is the delivery directory, or, if a file
23712 called &_maildirfolder_& exists in a maildir directory, the parent of the
23713 delivery directory.
23714
23715
23716 .option quota_filecount appendfile string&!! 0
23717 This option applies when the &%directory%& option is set. It limits the total
23718 number of files in the directory (compare the inode limit in system quotas). It
23719 can only be used if &%quota%& is also set. The value is expanded; an expansion
23720 failure causes delivery to be deferred. A value of zero is interpreted as
23721 &"no quota"&.
23722
23723 The option modifier &%no_check%& can be used to force delivery even if the over
23724 quota condition is met. The quota gets updated as usual.
23725
23726 .option quota_is_inclusive appendfile boolean true
23727 See &%quota%& above.
23728
23729
23730 .option quota_size_regex appendfile string unset
23731 This option applies when one of the delivery modes that writes a separate file
23732 for each message is being used. When Exim wants to find the size of one of
23733 these files in order to test the quota, it first checks &%quota_size_regex%&.
23734 If this is set to a regular expression that matches the filename, and it
23735 captures one string, that string is interpreted as a representation of the
23736 file's size. The value of &%quota_size_regex%& is not expanded.
23737
23738 This feature is useful only when users have no shell access to their mailboxes
23739 &-- otherwise they could defeat the quota simply by renaming the files. This
23740 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23741 the file length to the filename. For example:
23742 .code
23743 maildir_tag = ,S=$message_size
23744 quota_size_regex = ,S=(\d+)
23745 .endd
23746 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23747 number of lines in the message.
23748
23749 The regular expression should not assume that the length is at the end of the
23750 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23751 sometimes add other information onto the ends of message filenames.
23752
23753 Section &<<SECID136>>& contains further information.
23754
23755 This option should not be used when other message-handling software
23756 may duplicate messages by making hardlinks to the files.  When that is done Exim
23757 will count the message size once for each filename, in contrast with the actual
23758 disk usage.  When the option is not set, calculating total usage requires
23759 a system-call per file to get the size; the number of links is then available also
23760 as is used to adjust the effective size.
23761
23762
23763 .option quota_warn_message appendfile string&!! "see below"
23764 See below for the use of this option. If it is not set when
23765 &%quota_warn_threshold%& is set, it defaults to
23766 .code
23767 quota_warn_message = "\
23768   To: $local_part@$domain\n\
23769   Subject: Your mailbox\n\n\
23770   This message is automatically created \
23771   by mail delivery software.\n\n\
23772   The size of your mailbox has exceeded \
23773   a warning threshold that is\n\
23774   set by the system administrator.\n"
23775 .endd
23776
23777
23778 .option quota_warn_threshold appendfile string&!! 0
23779 .cindex "quota" "warning threshold"
23780 .cindex "mailbox" "size warning"
23781 .cindex "size" "of mailbox"
23782 This option is expanded in the same way as &%quota%& (see above). If the
23783 resulting value is greater than zero, and delivery of the message causes the
23784 size of the file or total space in the directory tree to cross the given
23785 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23786 may be specified as a percentage of it by following the value with a percent
23787 sign. For example:
23788 .code
23789 quota = 10M
23790 quota_warn_threshold = 75%
23791 .endd
23792 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23793 percent sign is ignored.
23794
23795 The warning message itself is specified by the &%quota_warn_message%& option,
23796 and it must start with a &'To:'& header line containing the recipient(s) of the
23797 warning message. These do not necessarily have to include the recipient(s) of
23798 the original message. A &'Subject:'& line should also normally be supplied. You
23799 can include any other header lines that you want. If you do not include a
23800 &'From:'& line, the default is:
23801 .code
23802 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23803 .endd
23804 .oindex &%errors_reply_to%&
23805 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23806 option.
23807
23808 The &%quota%& option does not have to be set in order to use this option; they
23809 are independent of one another except when the threshold is specified as a
23810 percentage.
23811
23812
23813 .option use_bsmtp appendfile boolean false
23814 .cindex "envelope from"
23815 .cindex "envelope sender"
23816 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23817 format, with the envelope sender and recipient(s) included as SMTP commands. If
23818 you want to include a leading HELO command with such messages, you can do
23819 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23820 for details of batch SMTP.
23821
23822
23823 .option use_crlf appendfile boolean false
23824 .cindex "carriage return"
23825 .cindex "linefeed"
23826 This option causes lines to be terminated with the two-character CRLF sequence
23827 (carriage return, linefeed) instead of just a linefeed character. In the case
23828 of batched SMTP, the byte sequence written to the file is then an exact image
23829 of what would be sent down a real SMTP connection.
23830
23831 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23832 (which are used to supply the traditional &"From&~"& and blank line separators
23833 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23834 carriage return characters if these are needed. In cases where these options
23835 have non-empty defaults, the values end with a single linefeed, so they must be
23836 changed to end with &`\r\n`& if &%use_crlf%& is set.
23837
23838
23839 .option use_fcntl_lock appendfile boolean "see below"
23840 This option controls the use of the &[fcntl()]& function to lock a file for
23841 exclusive use when a message is being appended. It is set by default unless
23842 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23843 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23844 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23845
23846
23847 .option use_flock_lock appendfile boolean false
23848 This option is provided to support the use of &[flock()]& for file locking, for
23849 the few situations where it is needed. Most modern operating systems support
23850 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23851 each other. Exim uses &[fcntl()]& locking by default.
23852
23853 This option is required only if you are using an operating system where
23854 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23855 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23856 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23857
23858 .cindex "Solaris" "&[flock()]& support"
23859 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23860 have it (and some, I think, provide a not quite right version built on top of
23861 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23862 the ability to use it, and any attempt to do so will cause a configuration
23863 error.
23864
23865 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23866 is just being mapped onto &[fcntl()]& by the OS).
23867
23868
23869 .option use_lockfile appendfile boolean "see below"
23870 If this option is turned off, Exim does not attempt to create a lock file when
23871 appending to a mailbox file. In this situation, the only locking is by
23872 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23873 sure that every MUA that is ever going to look at your users' mailboxes uses
23874 &[fcntl()]& rather than a lock file, and even then only when you are not
23875 delivering over NFS from more than one host.
23876
23877 .cindex "NFS" "lock file"
23878 In order to append to an NFS file safely from more than one host, it is
23879 necessary to take out a lock &'before'& opening the file, and the lock file
23880 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23881 file corruption.
23882
23883 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23884 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23885 except when &%mbx_format%& is set.
23886
23887
23888 .option use_mbx_lock appendfile boolean "see below"
23889 This option is available only if Exim has been compiled with SUPPORT_MBX
23890 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23891 locking rules be used. It is set by default if &%mbx_format%& is set and none
23892 of the locking options are mentioned in the configuration. The locking rules
23893 are the same as are used by the &'c-client'& library that underlies Pine and
23894 the IMAP4 and POP daemons that come with it (see the discussion below). The
23895 rules allow for shared access to the mailbox. However, this kind of locking
23896 does not work when the mailbox is NFS mounted.
23897
23898 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23899 &%use_flock_lock%& to control what kind of locking is used in implementing the
23900 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23901 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23902
23903
23904
23905
23906 .section "Operational details for appending" "SECTopappend"
23907 .cindex "appending to a file"
23908 .cindex "file" "appending"
23909 Before appending to a file, the following preparations are made:
23910
23911 .ilist
23912 If the name of the file is &_/dev/null_&, no action is taken, and a success
23913 return is given.
23914
23915 .next
23916 .cindex "directory creation"
23917 If any directories on the file's path are missing, Exim creates them if the
23918 &%create_directory%& option is set. A created directory's mode is given by the
23919 &%directory_mode%& option.
23920
23921 .next
23922 If &%file_format%& is set, the format of an existing file is checked. If this
23923 indicates that a different transport should be used, control is passed to that
23924 transport.
23925
23926 .next
23927 .cindex "file" "locking"
23928 .cindex "locking files"
23929 .cindex "NFS" "lock file"
23930 If &%use_lockfile%& is set, a lock file is built in a way that will work
23931 reliably over NFS, as follows:
23932
23933 .olist
23934 Create a &"hitching post"& file whose name is that of the lock file with the
23935 current time, primary host name, and process id added, by opening for writing
23936 as a new file. If this fails with an access error, delivery is deferred.
23937 .next
23938 Close the hitching post file, and hard link it to the lock filename.
23939 .next
23940 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23941 Unlink the hitching post name.
23942 .next
23943 Otherwise, use &[stat()]& to get information about the hitching post file, and
23944 then unlink hitching post name. If the number of links is exactly two, creation
23945 of the lock file succeeded but something (for example, an NFS server crash and
23946 restart) caused this fact not to be communicated to the &[link()]& call.
23947 .next
23948 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23949 up to &%lock_retries%& times. However, since any program that writes to a
23950 mailbox should complete its task very quickly, it is reasonable to time out old
23951 lock files that are normally the result of user agent and system crashes. If an
23952 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23953 it before trying again.
23954 .endlist olist
23955
23956 .next
23957 A call is made to &[lstat()]& to discover whether the main file exists, and if
23958 so, what its characteristics are. If &[lstat()]& fails for any reason other
23959 than non-existence, delivery is deferred.
23960
23961 .next
23962 .cindex "symbolic link" "to mailbox"
23963 .cindex "mailbox" "symbolic link"
23964 If the file does exist and is a symbolic link, delivery is deferred, unless the
23965 &%allow_symlink%& option is set, in which case the ownership of the link is
23966 checked, and then &[stat()]& is called to find out about the real file, which
23967 is then subjected to the checks below. The check on the top-level link
23968 ownership prevents one user creating a link for another's mailbox in a sticky
23969 directory, though allowing symbolic links in this case is definitely not a good
23970 idea. If there is a chain of symbolic links, the intermediate ones are not
23971 checked.
23972
23973 .next
23974 If the file already exists but is not a regular file, or if the file's owner
23975 and group (if the group is being checked &-- see &%check_group%& above) are
23976 different from the user and group under which the delivery is running,
23977 delivery is deferred.
23978
23979 .next
23980 If the file's permissions are more generous than specified, they are reduced.
23981 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23982 is set false, in which case the delivery is tried using the existing
23983 permissions.
23984
23985 .next
23986 The file's inode number is saved, and the file is then opened for appending.
23987 If this fails because the file has vanished, &(appendfile)& behaves as if it
23988 hadn't existed (see below). For any other failures, delivery is deferred.
23989
23990 .next
23991 If the file is opened successfully, check that the inode number hasn't
23992 changed, that it is still a regular file, and that the owner and permissions
23993 have not changed. If anything is wrong, defer delivery and freeze the message.
23994
23995 .next
23996 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23997 option is set. Otherwise, check that the file is being created in a permitted
23998 directory if the &%create_file%& option is set (deferring on failure), and then
23999 open for writing as a new file, with the O_EXCL and O_CREAT options,
24000 except when dealing with a symbolic link (the &%allow_symlink%& option must be
24001 set). In this case, which can happen if the link points to a non-existent file,
24002 the file is opened for writing using O_CREAT but not O_EXCL, because
24003 that prevents link following.
24004
24005 .next
24006 .cindex "loop" "while file testing"
24007 If opening fails because the file exists, obey the tests given above for
24008 existing files. However, to avoid looping in a situation where the file is
24009 being continuously created and destroyed, the exists/not-exists loop is broken
24010 after 10 repetitions, and the message is then frozen.
24011
24012 .next
24013 If opening fails with any other error, defer delivery.
24014
24015 .next
24016 .cindex "file" "locking"
24017 .cindex "locking files"
24018 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
24019 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
24020 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
24021 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
24022 file, and an exclusive lock on the file whose name is
24023 .code
24024 /tmp/.<device-number>.<inode-number>
24025 .endd
24026 using the device and inode numbers of the open mailbox file, in accordance with
24027 the MBX locking rules. This file is created with a mode that is specified by
24028 the &%lockfile_mode%& option.
24029
24030 If Exim fails to lock the file, there are two possible courses of action,
24031 depending on the value of the locking timeout. This is obtained from
24032 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
24033
24034 If the timeout value is zero, the file is closed, Exim waits for
24035 &%lock_interval%&, and then goes back and re-opens the file as above and tries
24036 to lock it again. This happens up to &%lock_retries%& times, after which the
24037 delivery is deferred.
24038
24039 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
24040 &[flock()]& are used (with the given timeout), so there has already been some
24041 waiting involved by the time locking fails. Nevertheless, Exim does not give up
24042 immediately. It retries up to
24043 .code
24044 (lock_retries * lock_interval) / <timeout>
24045 .endd
24046 times (rounded up).
24047 .endlist
24048
24049 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
24050 and/or &[flock()]& locks) and then deletes the lock file if one was created.
24051
24052
24053 .section "Operational details for delivery to a new file" "SECTopdir"
24054 .cindex "delivery" "to single file"
24055 .cindex "&""From""& line"
24056 When the &%directory%& option is set instead of &%file%&, each message is
24057 delivered into a newly-created file or set of files. When &(appendfile)& is
24058 activated directly from a &(redirect)& router, neither &%file%& nor
24059 &%directory%& is normally set, because the path for delivery is supplied by the
24060 router. (See for example, the &(address_file)& transport in the default
24061 configuration.) In this case, delivery is to a new file if either the path name
24062 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
24063
24064 No locking is required while writing the message to a new file, so the various
24065 locking options of the transport are ignored. The &"From"& line that by default
24066 separates messages in a single file is not normally needed, nor is the escaping
24067 of message lines that start with &"From"&, and there is no need to ensure a
24068 newline at the end of each message. Consequently, the default values for
24069 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
24070 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
24071
24072 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
24073 the files in the delivery directory by default. However, you can specify a
24074 different directory by setting &%quota_directory%&. Also, for maildir
24075 deliveries (see below) the &_maildirfolder_& convention is honoured.
24076
24077
24078 .cindex "maildir format"
24079 .cindex "mailstore format"
24080 There are three different ways in which delivery to individual files can be
24081 done, controlled by the settings of the &%maildir_format%& and
24082 &%mailstore_format%& options. Note that code to support maildir or mailstore
24083 formats is not included in the binary unless SUPPORT_MAILDIR or
24084 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
24085
24086 .cindex "directory creation"
24087 In all three cases an attempt is made to create the directory and any necessary
24088 sub-directories if they do not exist, provided that the &%create_directory%&
24089 option is set (the default). The location of a created directory can be
24090 constrained by setting &%create_file%&. A created directory's mode is given by
24091 the &%directory_mode%& option. If creation fails, or if the
24092 &%create_directory%& option is not set when creation is required, delivery is
24093 deferred.
24094
24095
24096
24097 .section "Maildir delivery" "SECTmaildirdelivery"
24098 .cindex "maildir format" "description of"
24099 If the &%maildir_format%& option is true, Exim delivers each message by writing
24100 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24101 directory that is defined by the &%directory%& option (the &"delivery
24102 directory"&). If the delivery is successful, the file is renamed into the
24103 &_new_& subdirectory.
24104
24105 In the filename, <&'stime'&> is the current time of day in seconds, and
24106 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24107 Exim checks that the time-of-day clock has moved on by at least one microsecond
24108 before terminating the delivery process. This guarantees uniqueness for the
24109 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24110 opening it. If any response other than ENOENT (does not exist) is given,
24111 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24112
24113 Before Exim carries out a maildir delivery, it ensures that subdirectories
24114 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24115 do not exist, Exim tries to create them and any superior directories in their
24116 path, subject to the &%create_directory%& and &%create_file%& options. If the
24117 &%maildirfolder_create_regex%& option is set, and the regular expression it
24118 contains matches the delivery directory, Exim also ensures that a file called
24119 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24120 &_maildirfolder_& file cannot be created, delivery is deferred.
24121
24122 These features make it possible to use Exim to create all the necessary files
24123 and directories in a maildir mailbox, including subdirectories for maildir++
24124 folders. Consider this example:
24125 .code
24126 maildir_format = true
24127 directory = /var/mail/$local_part_data\
24128            ${if eq{$local_part_suffix}{}{}\
24129            {/.${substr_1:$local_part_suffix}}}
24130 maildirfolder_create_regex = /\.[^/]+$
24131 .endd
24132 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24133 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24134 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24135 not match this name, so Exim will not look for or create the file
24136 &_/var/mail/pimbo/maildirfolder_&, though it will create
24137 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24138
24139 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24140 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24141 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24142 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24143 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24144
24145 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24146 not inadvertently match the toplevel maildir directory, because a
24147 &_maildirfolder_& file at top level would completely break quota calculations.
24148
24149 .cindex "quota" "in maildir delivery"
24150 .cindex "maildir++"
24151 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24152 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24153 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24154 Exim assumes the directory is a maildir++ folder directory, which is one level
24155 down from the user's top level mailbox directory. This causes it to start at
24156 the parent directory instead of the current directory when calculating the
24157 amount of space used.
24158
24159 One problem with delivering into a multi-file mailbox is that it is
24160 computationally expensive to compute the size of the mailbox for quota
24161 checking. Various approaches have been taken to reduce the amount of work
24162 needed. The next two sections describe two of them. A third alternative is to
24163 use some external process for maintaining the size data, and use the expansion
24164 of the &%mailbox_size%& option as a way of importing it into Exim.
24165
24166
24167
24168
24169 .section "Using tags to record message sizes" "SECID135"
24170 If &%maildir_tag%& is set, the string is expanded for each delivery.
24171 When the maildir file is renamed into the &_new_& sub-directory, the
24172 tag is added to its name. However, if adding the tag takes the length of the
24173 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24174 the tag is dropped and the maildir file is created with no tag.
24175
24176
24177 .vindex "&$message_size$&"
24178 Tags can be used to encode the size of files in their names; see
24179 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24180 happens after the message has been written. The value of the &$message_size$&
24181 variable is set to the number of bytes actually written. If the expansion is
24182 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24183 be deferred. The expanded tag may contain any printing characters except &"/"&.
24184 Non-printing characters in the string are ignored; if the resulting string is
24185 empty, it is ignored. If it starts with an alphanumeric character, a leading
24186 colon is inserted; this default has not proven to be the path that popular
24187 maildir implementations have chosen (but changing it in Exim would break
24188 backwards compatibility).
24189
24190 For one common implementation, you might set:
24191 .code
24192 maildir_tag = ,S=${message_size}
24193 .endd
24194 but you should check the documentation of the other software to be sure.
24195
24196 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24197 as this allows Exim to extract the size from your tag, instead of having to
24198 &[stat()]& each message file.
24199
24200
24201 .section "Using a maildirsize file" "SECID136"
24202 .cindex "quota" "in maildir delivery"
24203 .cindex "maildir format" "&_maildirsize_& file"
24204 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24205 storing quota and message size information in a file called &_maildirsize_&
24206 within the toplevel maildir directory. If this file does not exist, Exim
24207 creates it, setting the quota from the &%quota%& option of the transport. If
24208 the maildir directory itself does not exist, it is created before any attempt
24209 to write a &_maildirsize_& file.
24210
24211 The &_maildirsize_& file is used to hold information about the sizes of
24212 messages in the maildir, thus speeding up quota calculations. The quota value
24213 in the file is just a cache; if the quota is changed in the transport, the new
24214 value overrides the cached value when the next message is delivered. The cache
24215 is maintained for the benefit of other programs that access the maildir and
24216 need to know the quota.
24217
24218 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24219 file is maintained (with a zero quota setting), but no quota is imposed.
24220
24221 A regular expression is available for controlling which directories in the
24222 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24223 See the description of the &%maildir_quota_directory_regex%& option above for
24224 details.
24225
24226
24227 .section "Mailstore delivery" "SECID137"
24228 .cindex "mailstore format" "description of"
24229 If the &%mailstore_format%& option is true, each message is written as two
24230 files in the given directory. A unique base name is constructed from the
24231 message id and the current delivery process, and the files that are written use
24232 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24233 contains the message's envelope, and the &_.msg_& file contains the message
24234 itself. The base name is placed in the variable &$mailstore_basename$&.
24235
24236 During delivery, the envelope is first written to a file with the suffix
24237 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24238 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24239 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24240 file before accessing either of them. An alternative approach is to wait for
24241 the absence of a &_.tmp_& file.
24242
24243 The envelope file starts with any text defined by the &%mailstore_prefix%&
24244 option, expanded and terminated by a newline if there isn't one. Then follows
24245 the sender address on one line, then all the recipient addresses, one per line.
24246 There can be more than one recipient only if the &%batch_max%& option is set
24247 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24248 appended to the file, followed by a newline if it does not end with one.
24249
24250 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24251 failure, it is ignored. Other expansion errors are treated as serious
24252 configuration errors, and delivery is deferred. The variable
24253 &$mailstore_basename$& is available for use during these expansions.
24254
24255
24256 .section "Non-special new file delivery" "SECID138"
24257 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24258 file is created directly in the named directory. For example, when delivering
24259 messages into files in batched SMTP format for later delivery to some host (see
24260 section &<<SECTbatchSMTP>>&), a setting such as
24261 .code
24262 directory = /var/bsmtp/$host
24263 .endd
24264 might be used. A message is written to a file with a temporary name, which is
24265 then renamed when the delivery is complete. The final name is obtained by
24266 expanding the contents of the &%directory_file%& option.
24267 .ecindex IIDapptra1
24268 .ecindex IIDapptra2
24269
24270
24271
24272
24273
24274
24275 . ////////////////////////////////////////////////////////////////////////////
24276 . ////////////////////////////////////////////////////////////////////////////
24277
24278 .chapter "The autoreply transport" "CHID8"
24279 .scindex IIDauttra1 "transports" "&(autoreply)&"
24280 .scindex IIDauttra2 "&(autoreply)& transport"
24281 The &(autoreply)& transport is not a true transport in that it does not cause
24282 the message to be transmitted. Instead, it generates a new mail message as an
24283 automatic reply to the incoming message. &'References:'& and
24284 &'Auto-Submitted:'& header lines are included. These are constructed according
24285 to the rules in RFCs 2822 and 3834, respectively.
24286
24287 If the router that passes the message to this transport does not have the
24288 &%unseen%& option set, the original message (for the current recipient) is not
24289 delivered anywhere. However, when the &%unseen%& option is set on the router
24290 that passes the message to this transport, routing of the address continues, so
24291 another router can set up a normal message delivery.
24292
24293
24294 The &(autoreply)& transport is usually run as the result of mail filtering, a
24295 &"vacation"& message being the standard example. However, it can also be run
24296 directly from a router like any other transport. To reduce the possibility of
24297 message cascades, messages created by the &(autoreply)& transport always have
24298 empty envelope sender addresses, like bounce messages.
24299
24300 The parameters of the message to be sent can be specified in the configuration
24301 by options described below. However, these are used only when the address
24302 passed to the transport does not contain its own reply information. When the
24303 transport is run as a consequence of a
24304 &%mail%&
24305 or &%vacation%& command in a filter file, the parameters of the message are
24306 supplied by the filter, and passed with the address. The transport's options
24307 that define the message are then ignored (so they are not usually set in this
24308 case). The message is specified entirely by the filter or by the transport; it
24309 is never built from a mixture of options. However, the &%file_optional%&,
24310 &%mode%&, and &%return_message%& options apply in all cases.
24311
24312 &(Autoreply)& is implemented as a local transport. When used as a result of a
24313 command in a user's filter file, &(autoreply)& normally runs under the uid and
24314 gid of the user, and with appropriate current and home directories (see chapter
24315 &<<CHAPenvironment>>&).
24316
24317 There is a subtle difference between routing a message to a &(pipe)& transport
24318 that generates some text to be returned to the sender, and routing it to an
24319 &(autoreply)& transport. This difference is noticeable only if more than one
24320 address from the same message is so handled. In the case of a pipe, the
24321 separate outputs from the different addresses are gathered up and returned to
24322 the sender in a single message, whereas if &(autoreply)& is used, a separate
24323 message is generated for each address that is passed to it.
24324
24325 Non-printing characters are not permitted in the header lines generated for the
24326 message that &(autoreply)& creates, with the exception of newlines that are
24327 immediately followed by white space. If any non-printing characters are found,
24328 the transport defers.
24329 Whether characters with the top bit set count as printing characters or not is
24330 controlled by the &%print_topbitchars%& global option.
24331
24332 If any of the generic options for manipulating headers (for example,
24333 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24334 of the original message that is included in the generated message when
24335 &%return_message%& is set. They do not apply to the generated message itself.
24336
24337 .vindex "&$sender_address$&"
24338 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24339 the message, indicating that there were no recipients, it does not treat this
24340 as an error. This means that autoreplies sent to &$sender_address$& when this
24341 is empty (because the incoming message is a bounce message) do not cause
24342 problems. They are just discarded.
24343
24344
24345
24346 .section "Private options for autoreply" "SECID139"
24347 .cindex "options" "&(autoreply)& transport"
24348
24349 .option bcc autoreply string&!! unset
24350 This specifies the addresses that are to receive &"blind carbon copies"& of the
24351 message when the message is specified by the transport.
24352
24353
24354 .option cc autoreply string&!! unset
24355 This specifies recipients of the message and the contents of the &'Cc:'& header
24356 when the message is specified by the transport.
24357
24358
24359 .option file autoreply string&!! unset
24360 The contents of the file are sent as the body of the message when the message
24361 is specified by the transport. If both &%file%& and &%text%& are set, the text
24362 string comes first.
24363
24364
24365 .option file_expand autoreply boolean false
24366 If this is set, the contents of the file named by the &%file%& option are
24367 subjected to string expansion as they are added to the message.
24368
24369
24370 .option file_optional autoreply boolean false
24371 If this option is true, no error is generated if the file named by the &%file%&
24372 option or passed with the address does not exist or cannot be read.
24373
24374
24375 .option from autoreply string&!! unset
24376 This specifies the contents of the &'From:'& header when the message is
24377 specified by the transport.
24378
24379
24380 .option headers autoreply string&!! unset
24381 This specifies additional RFC 2822 headers that are to be added to the message
24382 when the message is specified by the transport. Several can be given by using
24383 &"\n"& to separate them. There is no check on the format.
24384
24385
24386 .option log autoreply string&!! unset
24387 This option names a file in which a record of every message sent is logged when
24388 the message is specified by the transport.
24389
24390
24391 .option mode autoreply "octal integer" 0600
24392 If either the log file or the &"once"& file has to be created, this mode is
24393 used.
24394
24395
24396 .option never_mail autoreply "address list&!!" unset
24397 If any run of the transport creates a message with a recipient that matches any
24398 item in the list, that recipient is quietly discarded. If all recipients are
24399 discarded, no message is created. This applies both when the recipients are
24400 generated by a filter and when they are specified in the transport.
24401
24402
24403
24404 .option once autoreply string&!! unset
24405 This option names a file or DBM database in which a record of each &'To:'&
24406 recipient is kept when the message is specified by the transport. &*Note*&:
24407 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24408
24409 If &%once%& is unset, or is set to an empty string, the message is always sent.
24410 By default, if &%once%& is set to a non-empty filename, the message
24411 is not sent if a potential recipient is already listed in the database.
24412 However, if the &%once_repeat%& option specifies a time greater than zero, the
24413 message is sent if that much time has elapsed since a message was last sent to
24414 this recipient. A setting of zero time for &%once_repeat%& (the default)
24415 prevents a message from being sent a second time &-- in this case, zero means
24416 infinity.
24417
24418 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24419 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24420 greater than zero, it changes the way Exim implements the &%once%& option.
24421 Instead of using a DBM file to record every recipient it sends to, it uses a
24422 regular file, whose size will never get larger than the given value.
24423
24424 In the file, Exim keeps a linear list of recipient addresses and the times at
24425 which they were sent messages. If the file is full when a new address needs to
24426 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24427 means that a given recipient may receive multiple messages, but at
24428 unpredictable intervals that depend on the rate of turnover of addresses in the
24429 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24430
24431
24432 .option once_file_size autoreply integer 0
24433 See &%once%& above.
24434
24435
24436 .option once_repeat autoreply time&!! 0s
24437 See &%once%& above.
24438 After expansion, the value of this option must be a valid time value.
24439
24440
24441 .option reply_to autoreply string&!! unset
24442 This specifies the contents of the &'Reply-To:'& header when the message is
24443 specified by the transport.
24444
24445
24446 .option return_message autoreply boolean false
24447 If this is set, a copy of the original message is returned with the new
24448 message, subject to the maximum size set in the &%return_size_limit%& global
24449 configuration option.
24450
24451
24452 .option subject autoreply string&!! unset
24453 This specifies the contents of the &'Subject:'& header when the message is
24454 specified by the transport. It is tempting to quote the original subject in
24455 automatic responses. For example:
24456 .code
24457 subject = Re: $h_subject:
24458 .endd
24459 There is a danger in doing this, however. It may allow a third party to
24460 subscribe your users to an opt-in mailing list, provided that the list accepts
24461 bounce messages as subscription confirmations. Well-managed lists require a
24462 non-bounce message to confirm a subscription, so the danger is relatively
24463 small.
24464
24465
24466
24467 .option text autoreply string&!! unset
24468 This specifies a single string to be used as the body of the message when the
24469 message is specified by the transport. If both &%text%& and &%file%& are set,
24470 the text comes first.
24471
24472
24473 .option to autoreply string&!! unset
24474 This specifies recipients of the message and the contents of the &'To:'& header
24475 when the message is specified by the transport.
24476 .ecindex IIDauttra1
24477 .ecindex IIDauttra2
24478
24479
24480
24481
24482 . ////////////////////////////////////////////////////////////////////////////
24483 . ////////////////////////////////////////////////////////////////////////////
24484
24485 .chapter "The lmtp transport" "CHAPLMTP"
24486 .cindex "transports" "&(lmtp)&"
24487 .cindex "&(lmtp)& transport"
24488 .cindex "LMTP" "over a pipe"
24489 .cindex "LMTP" "over a socket"
24490 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24491 specified command
24492 or by interacting with a Unix domain socket.
24493 This transport is something of a cross between the &(pipe)& and &(smtp)&
24494 transports. Exim also has support for using LMTP over TCP/IP; this is
24495 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24496 to be of minority interest, the default build-time configure in &_src/EDITME_&
24497 has it commented out. You need to ensure that
24498 .code
24499 TRANSPORT_LMTP=yes
24500 .endd
24501 .cindex "options" "&(lmtp)& transport"
24502 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24503 included in the Exim binary. The private options of the &(lmtp)& transport are
24504 as follows:
24505
24506 .option batch_id lmtp string&!! unset
24507 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24508
24509
24510 .option batch_max lmtp integer 1
24511 This limits the number of addresses that can be handled in a single delivery.
24512 Most LMTP servers can handle several addresses at once, so it is normally a
24513 good idea to increase this value. See the description of local delivery
24514 batching in chapter &<<CHAPbatching>>&.
24515
24516
24517 .option command lmtp string&!! unset
24518 This option must be set if &%socket%& is not set. The string is a command which
24519 is run in a separate process. It is split up into a command name and list of
24520 arguments, each of which is separately expanded (so expansion cannot change the
24521 number of arguments). The command is run directly, not via a shell. The message
24522 is passed to the new process using the standard input and output to operate the
24523 LMTP protocol.
24524
24525 .option ignore_quota lmtp boolean false
24526 .cindex "LMTP" "ignoring quota errors"
24527 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24528 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24529 in its response to the LHLO command.
24530
24531 .option socket lmtp string&!! unset
24532 This option must be set if &%command%& is not set. The result of expansion must
24533 be the name of a Unix domain socket. The transport connects to the socket and
24534 delivers the message to it using the LMTP protocol.
24535
24536
24537 .option timeout lmtp time 5m
24538 The transport is aborted if the created process or Unix domain socket does not
24539 respond to LMTP commands or message input within this timeout. Delivery
24540 is deferred, and will be tried again later. Here is an example of a typical
24541 LMTP transport:
24542 .code
24543 lmtp:
24544   driver = lmtp
24545   command = /some/local/lmtp/delivery/program
24546   batch_max = 20
24547   user = exim
24548 .endd
24549 This delivers up to 20 addresses at a time, in a mixture of domains if
24550 necessary, running as the user &'exim'&.
24551
24552
24553
24554 . ////////////////////////////////////////////////////////////////////////////
24555 . ////////////////////////////////////////////////////////////////////////////
24556
24557 .chapter "The pipe transport" "CHAPpipetransport"
24558 .scindex IIDpiptra1 "transports" "&(pipe)&"
24559 .scindex IIDpiptra2 "&(pipe)& transport"
24560 The &(pipe)& transport is used to deliver messages via a pipe to a command
24561 running in another process. One example is the use of &(pipe)& as a
24562 pseudo-remote transport for passing messages to some other delivery mechanism
24563 (such as UUCP). Another is the use by individual users to automatically process
24564 their incoming messages. The &(pipe)& transport can be used in one of the
24565 following ways:
24566
24567 .ilist
24568 .vindex "&$local_part$&"
24569 A router routes one address to a transport in the normal way, and the
24570 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24571 contains the local part of the address (as usual), and the command that is run
24572 is specified by the &%command%& option on the transport.
24573 .next
24574 .vindex "&$pipe_addresses$&"
24575 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24576 transport can handle more than one address in a single run. In this case, when
24577 more than one address is routed to the transport, &$local_part$& is not set
24578 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24579 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24580 that are routed to the transport.
24581 .next
24582 .vindex "&$address_pipe$&"
24583 A router redirects an address directly to a pipe command (for example, from an
24584 alias or forward file). In this case, &$address_pipe$& contains the text of the
24585 pipe command, and the &%command%& option on the transport is ignored unless
24586 &%force_command%& is set. If only one address is being transported
24587 (&%batch_max%& is not greater than one, or only one address was redirected to
24588 this pipe command), &$local_part$& contains the local part that was redirected.
24589 .endlist
24590
24591
24592 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24593 deliver messages over pipes using the LMTP interactive protocol. This is
24594 implemented by the &(lmtp)& transport.
24595
24596 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24597 &_.forward_& file, the command runs under the uid and gid of that user. In
24598 other cases, the uid and gid have to be specified explicitly, either on the
24599 transport or on the router that handles the address. Current and &"home"&
24600 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24601 details of the local delivery environment and chapter &<<CHAPbatching>>&
24602 for a discussion of local delivery batching.
24603
24604 .cindex "tainted data" "in pipe command"
24605 .cindex pipe "tainted data"
24606 Tainted data may not be used for the command name.
24607
24608
24609 .section "Concurrent delivery" "SECID140"
24610 If two messages arrive at almost the same time, and both are routed to a pipe
24611 delivery, the two pipe transports may be run concurrently. You must ensure that
24612 any pipe commands you set up are robust against this happening. If the commands
24613 write to a file, the &%exim_lock%& utility might be of use.
24614 Alternatively the &%max_parallel%& option could be used with a value
24615 of "1" to enforce serialization.
24616
24617
24618
24619
24620 .section "Returned status and data" "SECID141"
24621 .cindex "&(pipe)& transport" "returned data"
24622 If the command exits with a non-zero return code, the delivery is deemed to
24623 have failed, unless either the &%ignore_status%& option is set (in which case
24624 the return code is treated as zero), or the return code is one of those listed
24625 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24626 later"&. In this case, delivery is deferred. Details of a permanent failure are
24627 logged, but are not included in the bounce message, which merely contains
24628 &"local delivery failed"&.
24629
24630 If the command exits on a signal and the &%freeze_signal%& option is set then
24631 the message will be frozen in the queue. If that option is not set, a bounce
24632 will be sent as normal.
24633
24634 If the return code is greater than 128 and the command being run is a shell
24635 script, it normally means that the script was terminated by a signal whose
24636 value is the return code minus 128. The &%freeze_signal%& option does not
24637 apply in this case.
24638
24639 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24640 return code is set to 127. This is the value that a shell returns if it is
24641 asked to run a non-existent command. The wording for the log line suggests that
24642 a non-existent command may be the problem.
24643
24644 The &%return_output%& option can affect the result of a pipe delivery. If it is
24645 set and the command produces any output on its standard output or standard
24646 error streams, the command is considered to have failed, even if it gave a zero
24647 return code or if &%ignore_status%& is set. The output from the command is
24648 included as part of the bounce message. The &%return_fail_output%& option is
24649 similar, except that output is returned only when the command exits with a
24650 failure return code, that is, a value other than zero or a code that matches
24651 &%temp_errors%&.
24652
24653
24654
24655 .section "How the command is run" "SECThowcommandrun"
24656 .cindex "&(pipe)& transport" "path for command"
24657 The command line is (by default) broken down into a command name and arguments
24658 by the &(pipe)& transport itself. The &%allow_commands%& and
24659 &%restrict_to_path%& options can be used to restrict the commands that may be
24660 run.
24661
24662 .cindex "quoting" "in pipe command"
24663 Unquoted arguments are delimited by white space. If an argument appears in
24664 double quotes, backslash is interpreted as an escape character in the usual
24665 way. If an argument appears in single quotes, no escaping is done.
24666
24667 String expansion is applied to the command line except when it comes from a
24668 traditional &_.forward_& file (commands from a filter file are expanded). The
24669 expansion is applied to each argument in turn rather than to the whole line.
24670 For this reason, any string expansion item that contains white space must be
24671 quoted so as to be contained within a single argument. A setting such as
24672 .code
24673 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24674 .endd
24675 will not work, because the expansion item gets split between several
24676 arguments. You have to write
24677 .code
24678 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24679 .endd
24680 to ensure that it is all in one argument. The expansion is done in this way,
24681 argument by argument, so that the number of arguments cannot be changed as a
24682 result of expansion, and quotes or backslashes in inserted variables do not
24683 interact with external quoting. However, this leads to problems if you want to
24684 generate multiple arguments (or the command name plus arguments) from a single
24685 expansion. In this situation, the simplest solution is to use a shell. For
24686 example:
24687 .code
24688 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24689 .endd
24690
24691 .cindex "transport" "filter"
24692 .cindex "filter" "transport filter"
24693 .vindex "&$pipe_addresses$&"
24694 Special handling takes place when an argument consists of precisely the text
24695 &`$pipe_addresses`& (no quotes).
24696 This is not a general expansion variable; the only
24697 place this string is recognized is when it appears as an argument for a pipe or
24698 transport filter command. It causes each address that is being handled to be
24699 inserted in the argument list at that point &'as a separate argument'&. This
24700 avoids any problems with spaces or shell metacharacters, and is of use when a
24701 &(pipe)& transport is handling groups of addresses in a batch.
24702
24703 If &%force_command%& is enabled on the transport, special handling takes place
24704 for an argument that consists of precisely the text &`$address_pipe`&.  It
24705 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24706 argument is inserted in the argument list at that point
24707 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24708 the only item in the argument; in fact, if it were then &%force_command%&
24709 should behave as a no-op.  Rather, it should be used to adjust the command
24710 run while preserving the argument vector separation.
24711
24712 After splitting up into arguments and expansion, the resulting command is run
24713 in a subprocess directly from the transport, &'not'& under a shell. The
24714 message that is being delivered is supplied on the standard input, and the
24715 standard output and standard error are both connected to a single pipe that is
24716 read by Exim. The &%max_output%& option controls how much output the command
24717 may produce, and the &%return_output%& and &%return_fail_output%& options
24718 control what is done with it.
24719
24720 Not running the command under a shell (by default) lessens the security risks
24721 in cases when a command from a user's filter file is built out of data that was
24722 taken from an incoming message. If a shell is required, it can of course be
24723 explicitly specified as the command to be run. However, there are circumstances
24724 where existing commands (for example, in &_.forward_& files) expect to be run
24725 under a shell and cannot easily be modified. To allow for these cases, there is
24726 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24727 works. Instead of breaking up the command line as just described, it expands it
24728 as a single string and passes the result to &_/bin/sh_&. The
24729 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24730 with &%use_shell%&, and the whole mechanism is inherently less secure.
24731
24732
24733
24734 .section "Environment variables" "SECTpipeenv"
24735 .cindex "&(pipe)& transport" "environment for command"
24736 .cindex "environment" "&(pipe)& transport"
24737 The environment variables listed below are set up when the command is invoked.
24738 This list is a compromise for maximum compatibility with other MTAs. Note that
24739 the &%environment%& option can be used to add additional variables to this
24740 environment. The environment for the &(pipe)& transport is not subject
24741 to the &%add_environment%& and &%keep_environment%& main config options.
24742 &*Note*&: Using enviroment variables loses track of tainted data.
24743 Writers of &(pipe)& transport commands should be wary of data supplied
24744 by potential attackers.
24745 .display
24746 &`DOMAIN            `&   the domain of the address
24747 &`HOME              `&   the home directory, if set
24748 &`HOST              `&   the host name when called from a router (see below)
24749 &`LOCAL_PART        `&   see below
24750 &`LOCAL_PART_PREFIX `&   see below
24751 &`LOCAL_PART_SUFFIX `&   see below
24752 &`LOGNAME           `&   see below
24753 &`MESSAGE_ID        `&   Exim's local ID for the message
24754 &`PATH              `&   as specified by the &%path%& option below
24755 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24756 &`RECIPIENT         `&   the complete recipient address
24757 &`SENDER            `&   the sender of the message (empty if a bounce)
24758 &`SHELL             `&   &`/bin/sh`&
24759 &`TZ                `&   the value of the &%timezone%& option, if set
24760 &`USER              `&   see below
24761 .endd
24762 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24763 router, LOCAL_PART is set to the local part of the address. When it is
24764 called as a result of a forward or alias expansion, LOCAL_PART is set to
24765 the local part of the address that was expanded. In both cases, any affixes are
24766 removed from the local part, and made available in LOCAL_PART_PREFIX and
24767 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24768 same value as LOCAL_PART for compatibility with other MTAs.
24769
24770 .cindex "HOST"
24771 HOST is set only when a &(pipe)& transport is called from a router that
24772 associates hosts with an address, typically when using &(pipe)& as a
24773 pseudo-remote transport. HOST is set to the first host name specified by
24774 the router.
24775
24776 .cindex "HOME"
24777 If the transport's generic &%home_directory%& option is set, its value is used
24778 for the HOME environment variable. Otherwise, a home directory may be set
24779 by the router's &%transport_home_directory%& option, which defaults to the
24780 user's home directory if &%check_local_user%& is set.
24781
24782
24783 .section "Private options for pipe" "SECID142"
24784 .cindex "options" "&(pipe)& transport"
24785
24786
24787
24788 .option allow_commands pipe "string list&!!" unset
24789 .cindex "&(pipe)& transport" "permitted commands"
24790 The string is expanded, and is then interpreted as a colon-separated list of
24791 permitted commands. If &%restrict_to_path%& is not set, the only commands
24792 permitted are those in the &%allow_commands%& list. They need not be absolute
24793 paths; the &%path%& option is still used for relative paths. If
24794 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24795 in the &%allow_commands%& list, or a name without any slashes that is found on
24796 the path. In other words, if neither &%allow_commands%& nor
24797 &%restrict_to_path%& is set, there is no restriction on the command, but
24798 otherwise only commands that are permitted by one or the other are allowed. For
24799 example, if
24800 .code
24801 allow_commands = /usr/bin/vacation
24802 .endd
24803 and &%restrict_to_path%& is not set, the only permitted command is
24804 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24805 &%use_shell%& is set.
24806
24807
24808 .option batch_id pipe string&!! unset
24809 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24810
24811
24812 .option batch_max pipe integer 1
24813 This limits the number of addresses that can be handled in a single delivery.
24814 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24815
24816
24817 .option check_string pipe string unset
24818 As &(pipe)& writes the message, the start of each line is tested for matching
24819 &%check_string%&, and if it does, the initial matching characters are replaced
24820 by the contents of &%escape_string%&, provided both are set. The value of
24821 &%check_string%& is a literal string, not a regular expression, and the case of
24822 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24823 of &%check_string%& and &%escape_string%& are forced to values that implement
24824 the SMTP escaping protocol. Any settings made in the configuration file are
24825 ignored.
24826
24827
24828 .option command pipe string&!! unset
24829 This option need not be set when &(pipe)& is being used to deliver to pipes
24830 obtained directly from address redirections. In other cases, the option must be
24831 set, to provide a command to be run. It need not yield an absolute path (see
24832 the &%path%& option below). The command is split up into separate arguments by
24833 Exim, and each argument is separately expanded, as described in section
24834 &<<SECThowcommandrun>>& above.
24835
24836 .cindex "tainted data"
24837 No part of the resulting command may be tainted.
24838
24839
24840 .option environment pipe "string list&!!" unset
24841 .cindex "&(pipe)& transport" "environment for command"
24842 .cindex "environment" "&(pipe)& transport"
24843 This option is used to add additional variables to the environment in which the
24844 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24845 a string which is expanded, and then interpreted as a colon-separated list of
24846 environment settings of the form <&'name'&>=<&'value'&>.
24847
24848
24849 .option escape_string pipe string unset
24850 See &%check_string%& above.
24851
24852
24853 .option freeze_exec_fail pipe boolean false
24854 .cindex "exec failure"
24855 .cindex "failure of exec"
24856 .cindex "&(pipe)& transport" "failure of exec"
24857 Failure to exec the command in a pipe transport is by default treated like
24858 any other failure while running the command. However, if &%freeze_exec_fail%&
24859 is set, failure to exec is treated specially, and causes the message to be
24860 frozen, whatever the setting of &%ignore_status%&.
24861
24862
24863 .option freeze_signal pipe boolean false
24864 .cindex "signal exit"
24865 .cindex "&(pipe)& transport", "signal exit"
24866 Normally if the process run by a command in a pipe transport exits on a signal,
24867 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24868 frozen in Exim's queue instead.
24869
24870
24871 .option force_command pipe boolean false
24872 .cindex "force command"
24873 .cindex "&(pipe)& transport", "force command"
24874 Normally when a router redirects an address directly to a pipe command
24875 the &%command%& option on the transport is ignored.  If &%force_command%&
24876 is set, the &%command%& option will used. This is especially
24877 useful for forcing a wrapper or additional argument to be added to the
24878 command. For example:
24879 .code
24880 command = /usr/bin/remote_exec myhost -- $address_pipe
24881 force_command
24882 .endd
24883
24884 Note that &$address_pipe$& is handled specially in &%command%& when
24885 &%force_command%& is set, expanding out to the original argument vector as
24886 separate items, similarly to a Unix shell &`"$@"`& construct.
24887
24888
24889 .option ignore_status pipe boolean false
24890 If this option is true, the status returned by the subprocess that is set up to
24891 run the command is ignored, and Exim behaves as if zero had been returned.
24892 Otherwise, a non-zero status or termination by signal causes an error return
24893 from the transport unless the status value is one of those listed in
24894 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24895
24896 &*Note*&: This option does not apply to timeouts, which do not return a status.
24897 See the &%timeout_defer%& option for how timeouts are handled.
24898
24899
24900 .option log_defer_output pipe boolean false
24901 .cindex "&(pipe)& transport" "logging output"
24902 If this option is set, and the status returned by the command is
24903 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24904 and any output was produced on stdout or stderr, the first line of it is
24905 written to the main log.
24906
24907
24908 .option log_fail_output pipe boolean false
24909 If this option is set, and the command returns any output on stdout or
24910 stderr, and also ends with a return code that is neither zero nor one of
24911 the return codes listed in &%temp_errors%& (that is, the delivery
24912 failed), the first line of output is written to the main log. This
24913 option and &%log_output%& are mutually exclusive.  Only one of them may
24914 be set.
24915
24916
24917 .option log_output pipe boolean false
24918 If this option is set and the command returns any output on stdout or
24919 stderr, the first line of output is written to the main log, whatever
24920 the return code. This option and &%log_fail_output%& are mutually
24921 exclusive. Only one of them may be set.
24922
24923
24924 .option max_output pipe integer 20K
24925 This specifies the maximum amount of output that the command may produce on its
24926 standard output and standard error file combined. If the limit is exceeded, the
24927 process running the command is killed. This is intended as a safety measure to
24928 catch runaway processes. The limit is applied independently of the settings of
24929 the options that control what is done with such output (for example,
24930 &%return_output%&). Because of buffering effects, the amount of output may
24931 exceed the limit by a small amount before Exim notices.
24932
24933
24934 .option message_prefix pipe string&!! "see below"
24935 The string specified here is expanded and output at the start of every message.
24936 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24937 .code
24938 message_prefix = \
24939   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24940   ${tod_bsdinbox}\n
24941 .endd
24942 .cindex "Cyrus"
24943 .cindex "&%tmail%&"
24944 .cindex "&""From""& line"
24945 This is required by the commonly used &_/usr/bin/vacation_& program.
24946 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24947 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24948 setting
24949 .code
24950 message_prefix =
24951 .endd
24952 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24953 &`\n`& to &`\r\n`& in &%message_prefix%&.
24954
24955
24956 .option message_suffix pipe string&!! "see below"
24957 The string specified here is expanded and output at the end of every message.
24958 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24959 The suffix can be suppressed by setting
24960 .code
24961 message_suffix =
24962 .endd
24963 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24964 &`\n`& to &`\r\n`& in &%message_suffix%&.
24965
24966
24967 .option path pipe string&!! "/bin:/usr/bin"
24968 This option is expanded and
24969 specifies the string that is set up in the PATH environment
24970 variable of the subprocess.
24971 If the &%command%& option does not yield an absolute path name, the command is
24972 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24973 apply to a command specified as a transport filter.
24974
24975
24976 .option permit_coredump pipe boolean false
24977 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24978 a core-dump of a pipe command, enable this command.  This enables core-dumps
24979 during delivery and affects both the Exim binary and the pipe command run.
24980 It is recommended that this option remain off unless and until you have a need
24981 for it and that this only be enabled when needed, as the risk of excessive
24982 resource consumption can be quite high.  Note also that Exim is typically
24983 installed as a setuid binary and most operating systems will inhibit coredumps
24984 of these by default, so further OS-specific action may be required.
24985
24986
24987 .option pipe_as_creator pipe boolean false
24988 .cindex "uid (user id)" "local delivery"
24989 If the generic &%user%& option is not set and this option is true, the delivery
24990 process is run under the uid that was in force when Exim was originally called
24991 to accept the message. If the group id is not otherwise set (via the generic
24992 &%group%& option), the gid that was in force when Exim was originally called to
24993 accept the message is used.
24994
24995
24996 .option restrict_to_path pipe boolean false
24997 When this option is set, any command name not listed in &%allow_commands%& must
24998 contain no slashes. The command is searched for only in the directories listed
24999 in the &%path%& option. This option is intended for use in the case when a pipe
25000 command has been generated from a user's &_.forward_& file. This is usually
25001 handled by a &(pipe)& transport called &%address_pipe%&.
25002
25003
25004 .option return_fail_output pipe boolean false
25005 If this option is true, and the command produced any output and ended with a
25006 return code other than zero or one of the codes listed in &%temp_errors%& (that
25007 is, the delivery failed), the output is returned in the bounce message.
25008 However, if the message has a null sender (that is, it is itself a bounce
25009 message), output from the command is discarded. This option and
25010 &%return_output%& are mutually exclusive. Only one of them may be set.
25011
25012
25013
25014 .option return_output pipe boolean false
25015 If this option is true, and the command produced any output, the delivery is
25016 deemed to have failed whatever the return code from the command, and the output
25017 is returned in the bounce message. Otherwise, the output is just discarded.
25018 However, if the message has a null sender (that is, it is a bounce message),
25019 output from the command is always discarded, whatever the setting of this
25020 option. This option and &%return_fail_output%& are mutually exclusive. Only one
25021 of them may be set.
25022
25023
25024
25025 .option temp_errors pipe "string list" "see below"
25026 .cindex "&(pipe)& transport" "temporary failure"
25027 This option contains either a colon-separated list of numbers, or a single
25028 asterisk. If &%ignore_status%& is false
25029 and &%return_output%& is not set,
25030 and the command exits with a non-zero return code, the failure is treated as
25031 temporary and the delivery is deferred if the return code matches one of the
25032 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
25033 codes are treated as permanent errors. The default setting contains the codes
25034 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
25035 compiled on a system that does not define these macros, it assumes values of 75
25036 and 73, respectively.
25037
25038
25039 .option timeout pipe time 1h
25040 If the command fails to complete within this time, it is killed. This normally
25041 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
25042 specifies no timeout. In order to ensure that any subprocesses created by the
25043 command are also killed, Exim makes the initial process a process group leader,
25044 and kills the whole process group on a timeout. However, this can be defeated
25045 if one of the processes starts a new process group.
25046
25047 .option timeout_defer pipe boolean false
25048 A timeout in a &(pipe)& transport, either in the command that the transport
25049 runs, or in a transport filter that is associated with it, is by default
25050 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
25051 is set true, both kinds of timeout become temporary errors, causing the
25052 delivery to be deferred.
25053
25054 .option umask pipe "octal integer" 022
25055 This specifies the umask setting for the subprocess that runs the command.
25056
25057
25058 .option use_bsmtp pipe boolean false
25059 .cindex "envelope sender"
25060 If this option is set true, the &(pipe)& transport writes messages in &"batch
25061 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
25062 commands. If you want to include a leading HELO command with such messages,
25063 you can do so by setting the &%message_prefix%& option. See section
25064 &<<SECTbatchSMTP>>& for details of batch SMTP.
25065
25066 .option use_classresources pipe boolean false
25067 .cindex "class resources (BSD)"
25068 This option is available only when Exim is running on FreeBSD, NetBSD, or
25069 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
25070 resource limits when a &(pipe)& transport is run to perform a delivery. The
25071 limits for the uid under which the pipe is to run are obtained from the login
25072 class database.
25073
25074
25075 .option use_crlf pipe boolean false
25076 .cindex "carriage return"
25077 .cindex "linefeed"
25078 This option causes lines to be terminated with the two-character CRLF sequence
25079 (carriage return, linefeed) instead of just a linefeed character. In the case
25080 of batched SMTP, the byte sequence written to the pipe is then an exact image
25081 of what would be sent down a real SMTP connection.
25082
25083 The contents of the &%message_prefix%& and &%message_suffix%& options are
25084 written verbatim, so must contain their own carriage return characters if these
25085 are needed. When &%use_bsmtp%& is not set, the default values for both
25086 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
25087 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
25088
25089
25090 .option use_shell pipe boolean false
25091 .vindex "&$pipe_addresses$&"
25092 If this option is set, it causes the command to be passed to &_/bin/sh_&
25093 instead of being run directly from the transport, as described in section
25094 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
25095 where the command is expected to be run under a shell and cannot easily be
25096 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
25097 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
25098 command is expanded as a single string, and handed to &_/bin/sh_& as data for
25099 its &%-c%& option.
25100
25101
25102
25103 .section "Using an external local delivery agent" "SECID143"
25104 .cindex "local delivery" "using an external agent"
25105 .cindex "&'procmail'&"
25106 .cindex "external local delivery"
25107 .cindex "delivery" "&'procmail'&"
25108 .cindex "delivery" "by external agent"
25109 The &(pipe)& transport can be used to pass all messages that require local
25110 delivery to a separate local delivery agent such as &%procmail%&. When doing
25111 this, care must be taken to ensure that the pipe is run under an appropriate
25112 uid and gid. In some configurations one wants this to be a uid that is trusted
25113 by the delivery agent to supply the correct sender of the message. It may be
25114 necessary to recompile or reconfigure the delivery agent so that it trusts an
25115 appropriate user. The following is an example transport and router
25116 configuration for &%procmail%&:
25117 .code
25118 # transport
25119 procmail_pipe:
25120   driver = pipe
25121   command = /usr/local/bin/procmail -d $local_part_data
25122   return_path_add
25123   delivery_date_add
25124   envelope_to_add
25125   check_string = "From "
25126   escape_string = ">From "
25127   umask = 077
25128   user = $local_part_data
25129   group = mail
25130
25131 # router
25132 procmail:
25133   driver = accept
25134   check_local_user
25135   transport = procmail_pipe
25136 .endd
25137 In this example, the pipe is run as the local user, but with the group set to
25138 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25139 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25140 user to supply a correct sender address. If you do not specify either a
25141 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25142 home directory is the user's home directory by default.
25143
25144 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25145 .code
25146 IFS=" "
25147 .endd
25148 as shown in some &%procmail%& documentation, because Exim does not by default
25149 use a shell to run pipe commands.
25150
25151 .cindex "Cyrus"
25152 The next example shows a transport and a router for a system where local
25153 deliveries are handled by the Cyrus IMAP server.
25154 . Used to have R: local_part_suffix = .* +  T:   -m $local_part_suffix_v
25155 . but that suffix is tainted so cannot be used in a command arg
25156 . Really, you'd want to use a lookup for acceptable suffixes to do real detainting
25157 .code
25158 # transport
25159 local_delivery_cyrus:
25160   driver = pipe
25161   command = /usr/cyrus/bin/deliver \
25162             -- $local_part_data
25163   user = cyrus
25164   group = mail
25165   return_output
25166   log_output
25167   message_prefix =
25168   message_suffix =
25169
25170 # router
25171 local_user_cyrus:
25172   driver = accept
25173   check_local_user
25174   transport = local_delivery_cyrus
25175 .endd
25176 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25177 &%return_output%& to cause any text written by Cyrus to be returned to the
25178 sender.
25179 .ecindex IIDpiptra1
25180 .ecindex IIDpiptra2
25181
25182
25183 . ////////////////////////////////////////////////////////////////////////////
25184 . ////////////////////////////////////////////////////////////////////////////
25185
25186 .chapter "The smtp transport" "CHAPsmtptrans"
25187 .scindex IIDsmttra1 "transports" "&(smtp)&"
25188 .scindex IIDsmttra2 "&(smtp)& transport"
25189 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25190 or LMTP protocol. The list of hosts to try can either be taken from the address
25191 that is being processed (having been set up by the router), or specified
25192 explicitly for the transport. Timeout and retry processing (see chapter
25193 &<<CHAPretry>>&) is applied to each IP address independently.
25194
25195
25196 .section "Multiple messages on a single connection" "SECID144"
25197 The sending of multiple messages over a single TCP/IP connection can arise in
25198 two ways:
25199
25200 .ilist
25201 If a message contains more than &%max_rcpt%& (see below) addresses that are
25202 routed to the same host, more than one copy of the message has to be sent to
25203 that host. In this situation, multiple copies may be sent in a single run of
25204 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25205 does when it has too many addresses to send in one message also depends on the
25206 value of the global &%remote_max_parallel%& option. Details are given in
25207 section &<<SECToutSMTPTCP>>&.)
25208 .next
25209 .cindex "hints database" "remembering routing"
25210 When a message has been successfully delivered over a TCP/IP connection, Exim
25211 looks in its hints database to see if there are any other messages awaiting a
25212 connection to the same host. If there are, a new delivery process is started
25213 for one of them, and the current TCP/IP connection is passed on to it. The new
25214 process may in turn send multiple copies and possibly create yet another
25215 process.
25216 .endlist
25217
25218
25219 For each copy sent over the same TCP/IP connection, a sequence counter is
25220 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25221 no further messages are sent over that connection.
25222
25223
25224
25225 .section "Use of the $host and $host_address variables" "SECID145"
25226 .vindex "&$host$&"
25227 .vindex "&$host_address$&"
25228 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25229 &$host_address$& are the name and IP address of the first host on the host list
25230 passed by the router. However, when the transport is about to connect to a
25231 specific host, and while it is connected to that host, &$host$& and
25232 &$host_address$& are set to the values for that host. These are the values
25233 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25234 &%serialize_hosts%&, and the various TLS options are expanded.
25235
25236
25237 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25238 .vindex &$tls_bits$&
25239 .vindex &$tls_cipher$&
25240 .vindex &$tls_peerdn$&
25241 .vindex &$tls_sni$&
25242 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25243 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25244 are the values that were set when the message was received.
25245 These are the values that are used for options that are expanded before any
25246 SMTP connections are made. Just before each connection is made, these four
25247 variables are emptied. If TLS is subsequently started, they are set to the
25248 appropriate values for the outgoing connection, and these are the values that
25249 are in force when any authenticators are run and when the
25250 &%authenticated_sender%& option is expanded.
25251
25252 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25253 and will be removed in a future release.
25254
25255
25256 .section "Private options for smtp" "SECID146"
25257 .cindex "options" "&(smtp)& transport"
25258 The private options of the &(smtp)& transport are as follows:
25259
25260
25261 .option address_retry_include_sender smtp boolean true
25262 .cindex "4&'xx'& responses" "retrying after"
25263 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25264 is the combination of sender and recipient that is delayed in subsequent queue
25265 runs until the retry time is reached. You can delay the recipient without
25266 reference to the sender (which is what earlier versions of Exim did), by
25267 setting &%address_retry_include_sender%& false. However, this can lead to
25268 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25269
25270 .option allow_localhost smtp boolean false
25271 .cindex "local host" "sending to"
25272 .cindex "fallback" "hosts specified on transport"
25273 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25274 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25275 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25276 the delivery anyway. This should be used only in special cases when the
25277 configuration ensures that no looping will result (for example, a differently
25278 configured Exim is listening on the port to which the message is sent).
25279
25280
25281 .option authenticated_sender smtp string&!! unset
25282 .cindex "Cyrus"
25283 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25284 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25285 overriding any existing authenticated sender value. If the string expansion is
25286 forced to fail, the option is ignored. Other expansion failures cause delivery
25287 to be deferred. If the result of expansion is an empty string, that is also
25288 ignored.
25289
25290 The expansion happens after the outgoing connection has been made and TLS
25291 started, if required. This means that the &$host$&, &$host_address$&,
25292 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25293 particular connection.
25294
25295 If the SMTP session is not authenticated, the expansion of
25296 &%authenticated_sender%& still happens (and can cause the delivery to be
25297 deferred if it fails), but no AUTH= item is added to MAIL commands
25298 unless &%authenticated_sender_force%& is true.
25299
25300 This option allows you to use the &(smtp)& transport in LMTP mode to
25301 deliver mail to Cyrus IMAP and provide the proper local part as the
25302 &"authenticated sender"&, via a setting such as:
25303 .code
25304 authenticated_sender = $local_part
25305 .endd
25306 This removes the need for IMAP subfolders to be assigned special ACLs to
25307 allow direct delivery to those subfolders.
25308
25309 Because of expected uses such as that just described for Cyrus (when no
25310 domain is involved), there is no checking on the syntax of the provided
25311 value.
25312
25313
25314 .option authenticated_sender_force smtp boolean false
25315 If this option is set true, the &%authenticated_sender%& option's value
25316 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25317 authenticated as a client.
25318
25319
25320 .option command_timeout smtp time 5m
25321 .cindex timeout "smtp transport command"
25322 This sets a timeout for receiving a response to an SMTP command that has been
25323 sent out. It is also used when waiting for the initial banner line from the
25324 remote host. Its value must not be zero.
25325
25326
25327 .option connect_timeout smtp time 5m
25328 .cindex timeout "smtp transport connect"
25329 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25330 to a remote host. A setting of zero allows the system timeout (typically
25331 several minutes) to act. To have any effect, the value of this option must be
25332 less than the system timeout. However, it has been observed that on some
25333 systems there is no system timeout, which is why the default value for this
25334 option is 5 minutes, a value recommended by RFC 1123.
25335
25336
25337 .option connection_max_messages smtp integer 500
25338 .cindex "SMTP" "passed connection"
25339 .cindex "SMTP" "multiple deliveries"
25340 .cindex "multiple SMTP deliveries"
25341 This controls the maximum number of separate message deliveries that are sent
25342 over a single TCP/IP connection. If the value is zero, there is no limit.
25343 For testing purposes, this value can be overridden by the &%-oB%& command line
25344 option.
25345
25346
25347 .option dane_require_tls_ciphers smtp string&!! unset
25348 .cindex "TLS" "requiring specific ciphers for DANE"
25349 .cindex "cipher" "requiring specific"
25350 .cindex DANE "TLS ciphers"
25351 This option may be used to override &%tls_require_ciphers%& for connections
25352 where DANE has been determined to be in effect.
25353 If not set, then &%tls_require_ciphers%& will be used.
25354 Normal SMTP delivery is not able to make strong demands of TLS cipher
25355 configuration, because delivery will fall back to plaintext.  Once DANE has
25356 been determined to be in effect, there is no plaintext fallback and making the
25357 TLS cipherlist configuration stronger will increase security, rather than
25358 counter-intuitively decreasing it.
25359 If the option expands to be empty or is forced to fail, then it will
25360 be treated as unset and &%tls_require_ciphers%& will be used instead.
25361
25362
25363 .option data_timeout smtp time 5m
25364 .cindex timeout "for transmitted SMTP data blocks"
25365 This sets a timeout for the transmission of each block in the data portion of
25366 the message. As a result, the overall timeout for a message depends on the size
25367 of the message. Its value must not be zero. See also &%final_timeout%&.
25368
25369
25370 .option dkim_canon smtp string&!! unset
25371 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25372 .option dkim_domain smtp "string list&!!" unset
25373 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25374 .option dkim_hash smtp string&!! sha256
25375 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25376 .option dkim_identity smtp string&!! unset
25377 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25378 .option dkim_private_key smtp string&!! unset
25379 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25380 .option dkim_selector smtp string&!! unset
25381 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25382 .option dkim_strict smtp string&!! unset
25383 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25384 .option dkim_sign_headers smtp string&!! "per RFC"
25385 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25386 .option dkim_timestamps smtp string&!! unset
25387 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25388
25389
25390 .option delay_after_cutoff smtp boolean true
25391 .cindex "final cutoff" "retries, controlling"
25392 .cindex retry "final cutoff"
25393 This option controls what happens when all remote IP addresses for a given
25394 domain have been inaccessible for so long that they have passed their retry
25395 cutoff times.
25396
25397 In the default state, if the next retry time has not been reached for any of
25398 them, the address is bounced without trying any deliveries. In other words,
25399 Exim delays retrying an IP address after the final cutoff time until a new
25400 retry time is reached, and can therefore bounce an address without ever trying
25401 a delivery, when machines have been down for a long time. Some people are
25402 unhappy at this prospect, so...
25403
25404 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25405 addresses are past their final cutoff time, Exim tries to deliver to those
25406 IP addresses that have not been tried since the message arrived. If there are
25407 none, of if they all fail, the address is bounced. In other words, it does not
25408 delay when a new message arrives, but immediately tries those expired IP
25409 addresses that haven't been tried since the message arrived. If there is a
25410 continuous stream of messages for the dead hosts, unsetting
25411 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25412 to them.
25413
25414
25415 .option dns_qualify_single smtp boolean true
25416 If the &%hosts%& or &%fallback_hosts%& option is being used,
25417 and the &%gethostbyname%& option is false,
25418 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25419 in chapter &<<CHAPdnslookup>>& for more details.
25420
25421
25422 .option dns_search_parents smtp boolean false
25423 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25424 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25425 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25426 details.
25427
25428
25429 .option dnssec_request_domains smtp "domain list&!!" *
25430 .cindex "MX record" "security"
25431 .cindex "DNSSEC" "MX lookup"
25432 .cindex "security" "MX lookup"
25433 .cindex "DNS" "DNSSEC"
25434 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25435 the DNSSEC request bit set. Setting this transport option is only useful if the
25436 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25437 router option.
25438
25439
25440
25441 .option dnssec_require_domains smtp "domain list&!!" unset
25442 .cindex "MX record" "security"
25443 .cindex "DNSSEC" "MX lookup"
25444 .cindex "security" "MX lookup"
25445 .cindex "DNS" "DNSSEC"
25446 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25447 the DNSSEC request bit set.  Setting this transport option is only
25448 useful if the transport overrides or sets the host names. See the
25449 &%dnssec_require_domains%& router option.
25450
25451
25452
25453 .option dscp smtp string&!! unset
25454 .cindex "DCSP" "outbound"
25455 This option causes the DSCP value associated with a socket to be set to one
25456 of a number of fixed strings or to numeric value.
25457 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25458 Common values include &`throughput`&, &`mincost`&, and on newer systems
25459 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25460
25461 The outbound packets from Exim will be marked with this value in the header
25462 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25463 that these values will have any effect, not be stripped by networking
25464 equipment, or do much of anything without cooperation with your Network
25465 Engineer and those of all network operators between the source and destination.
25466
25467
25468 .option fallback_hosts smtp "string list" unset
25469 .cindex "fallback" "hosts specified on transport"
25470 String expansion is not applied to this option. The argument must be a
25471 colon-separated list of host names or IP addresses, optionally also including
25472 port numbers, though the separator can be changed, as described in section
25473 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25474 item in a &%route_list%& setting for the &(manualroute)& router, as described
25475 in section &<<SECTformatonehostitem>>&.
25476
25477 Fallback hosts can also be specified on routers, which associate them with the
25478 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25479 &%fallback_hosts%& specified on the transport is used only if the address does
25480 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25481 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25482 However, &%hosts_randomize%& does apply to fallback host lists.
25483
25484 If Exim is unable to deliver to any of the hosts for a particular address, and
25485 the errors are not permanent rejections, the address is put on a separate
25486 transport queue with its host list replaced by the fallback hosts, unless the
25487 address was routed via MX records and the current host was in the original MX
25488 list. In that situation, the fallback host list is not used.
25489
25490 Once normal deliveries are complete, the fallback queue is delivered by
25491 re-running the same transports with the new host lists. If several failing
25492 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25493 copy of the message is sent.
25494
25495 The resolution of the host names on the fallback list is controlled by the
25496 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25497 both to cases when the host list comes with the address and when it is taken
25498 from &%hosts%&. This option provides a &"use a smart host only if delivery
25499 fails"& facility.
25500
25501
25502 .option final_timeout smtp time 10m
25503 .cindex timeout "for transmitted SMTP data accept"
25504 This is the timeout that applies while waiting for the response to the final
25505 line containing just &"."& that terminates a message. Its value must not be
25506 zero.
25507
25508 .option gethostbyname smtp boolean false
25509 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25510 being used, names are looked up using &[gethostbyname()]&
25511 (or &[getipnodebyname()]& when available)
25512 instead of using the DNS. Of course, that function may in fact use the DNS, but
25513 it may also consult other sources of information such as &_/etc/hosts_&.
25514
25515 .option gnutls_compat_mode smtp boolean unset
25516 This option controls whether GnuTLS is used in compatibility mode in an Exim
25517 server. This reduces security slightly, but improves interworking with older
25518 implementations of TLS.
25519
25520 .option helo_data smtp string&!! "see below"
25521 .cindex "HELO" "argument, setting"
25522 .cindex "EHLO" "argument, setting"
25523 .cindex "LHLO argument setting"
25524 The value of this option is expanded after a connection to a another host has
25525 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25526 command that starts the outgoing SMTP or LMTP session. The default value of the
25527 option is:
25528 .code
25529 $primary_hostname
25530 .endd
25531 During the expansion, the variables &$host$& and &$host_address$& are set to
25532 the identity of the remote host, and the variables &$sending_ip_address$& and
25533 &$sending_port$& are set to the local IP address and port number that are being
25534 used. These variables can be used to generate different values for different
25535 servers or different local IP addresses. For example, if you want the string
25536 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25537 interface address, you could use this:
25538 .code
25539 helo_data = ${lookup dnsdb{ptr=$sending_ip_address} \
25540   {${listextract{1}{<\n $value}}} \
25541   {$primary_hostname}}
25542 .endd
25543 The use of &%helo_data%& applies both to sending messages and when doing
25544 callouts.
25545
25546 .option host_name_extract smtp "string list&!!" "see below"
25547 .cindex "load balancer" "hosts behind"
25548 .cindex TLS resumption
25549 Some mail-accepting sites
25550 (notably Microsoft)
25551 operate many servers behind a network load-balancer.  When this is done,
25552 with separated TLS session caches, TLS session resuption becomes problematic.
25553 It will only succeed when the same server happens to be selected by the
25554 load-balancer, matching the session stored in the client's cache.
25555
25556 Exim can pull out a server name, if there is one, from the response to the
25557 client's SMTP EHLO command.
25558 For normal STARTTLS use, the default value of this option:
25559 .code
25560     ${if and { {match {$host} {.outlook.com\$}} \
25561                {match {$item} {\N^250-([\w.]+)\s\N}} \
25562              } {$1}}
25563 .endd
25564 suffices for one known case.
25565
25566 During the expansion of this option the &$item$& variable will have the
25567 server's EHLO response.
25568
25569 .new
25570 For TLS-on-connect connections we do not have an EHLO
25571 response to use. Because of this the default value of this option is
25572 set to a static string for those cases, meaning that resumption will
25573 always be attempted if permitted by the &%tls_resumption_hosts%& option.
25574 .wen
25575
25576 The result of the option expansion is included in the key used to store and
25577 retrieve the TLS session, for session resumption.
25578
25579 Operators of high-load sites may wish to evaluate their logs for indications
25580 of other destination sites operating load-balancers, and develop a suitable
25581 expression for this option.
25582 The smtp:ehlo event and the &$tls_out_resumption$& variable
25583 will be useful for such work.
25584
25585 .option hosts smtp "string list&!!" unset
25586 Hosts are associated with an address by a router such as &(dnslookup)&, which
25587 finds the hosts by looking up the address domain in the DNS, or by
25588 &(manualroute)&, which has lists of hosts in its configuration. However,
25589 email addresses can be passed to the &(smtp)& transport by any router, and not
25590 all of them can provide an associated list of hosts.
25591
25592 The &%hosts%& option specifies a list of hosts to be used if the address being
25593 processed does not have any hosts associated with it. The hosts specified by
25594 &%hosts%& are also used, whether or not the address has its own hosts, if
25595 &%hosts_override%& is set.
25596
25597 The string is first expanded, before being interpreted as a colon-separated
25598 list of host names or IP addresses, possibly including port numbers. The
25599 separator may be changed to something other than colon, as described in section
25600 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25601 item in a &%route_list%& setting for the &(manualroute)& router, as described
25602 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25603 of the &(manualroute)& router is not available here.
25604
25605 If the expansion fails, delivery is deferred. Unless the failure was caused by
25606 the inability to complete a lookup, the error is logged to the panic log as
25607 well as the main log. Host names are looked up either by searching directly for
25608 address records in the DNS or by calling &[gethostbyname()]& (or
25609 &[getipnodebyname()]& when available), depending on the setting of the
25610 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25611 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25612 address are used.
25613
25614 During delivery, the hosts are tried in order, subject to their retry status,
25615 unless &%hosts_randomize%& is set.
25616
25617
25618 .option hosts_avoid_esmtp smtp "host list&!!" unset
25619 .cindex "ESMTP, avoiding use of"
25620 .cindex "HELO" "forcing use of"
25621 .cindex "EHLO" "avoiding use of"
25622 .cindex "PIPELINING" "avoiding the use of"
25623 This option is for use with broken hosts that announce ESMTP facilities (for
25624 example, PIPELINING) and then fail to implement them properly. When a host
25625 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25626 start of the SMTP session. This means that it cannot use any of the ESMTP
25627 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25628
25629
25630 .option hosts_avoid_pipelining smtp "host list&!!" unset
25631 .cindex "PIPELINING" "avoiding the use of"
25632 .cindex "ESMTP extensions" PIPELINING
25633 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25634 that matches this list, even if the server host advertises PIPELINING support.
25635
25636 .option hosts_pipe_connect smtp "host list&!!" unset
25637 .cindex "pipelining" "early connection"
25638 .cindex "pipelining" PIPECONNECT
25639 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25640 this option controls which to hosts the facility watched for
25641 and recorded, and used for subsequent connections.
25642
25643 The retry hints database is used for the record,
25644 and records are subject to the &%retry_data_expire%& option.
25645 When used, the pipelining saves on roundtrip times.
25646 It also turns SMTP into a client-first protocol
25647 so combines well with TCP Fast Open.
25648
25649 See also the &%pipelining_connect_advertise_hosts%& main option.
25650
25651 Note:
25652 When the facility is used, if the transport &%interface%& option is unset
25653 the &%helo_data%& option
25654 will be expanded before the &$sending_ip_address$& variable
25655 is filled in.
25656 A check is made for the use of that variable, without the
25657 presence of a &"def:"& test on it, but suitably complex coding
25658 can avoid the check and produce unexpected results.
25659 You have been warned.
25660
25661
25662 .option hosts_avoid_tls smtp "host list&!!" unset
25663 .cindex "TLS" "avoiding for certain hosts"
25664 Exim will not try to start a TLS session when delivering to any host that
25665 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25666
25667 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25668 .cindex "TLS" "avoiding for certain hosts"
25669 Exim will not try to start a TLS session for a verify callout,
25670 or when delivering in cutthrough mode,
25671 to any host that matches this list.
25672
25673
25674 .option hosts_max_try smtp integer 5
25675 .cindex "host" "maximum number to try"
25676 .cindex "limit" "number of hosts tried"
25677 .cindex "limit" "number of MX tried"
25678 .cindex "MX record" "maximum tried"
25679 This option limits the number of IP addresses that are tried for any one
25680 delivery in cases where there are temporary delivery errors. Section
25681 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25682
25683
25684 .option hosts_max_try_hardlimit smtp integer 50
25685 This is an additional check on the maximum number of IP addresses that Exim
25686 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25687 why it exists.
25688
25689
25690
25691 .option hosts_nopass_tls smtp "host list&!!" unset
25692 .cindex "TLS" "passing connection"
25693 .cindex "multiple SMTP deliveries"
25694 .cindex "TLS" "multiple message deliveries"
25695 For any host that matches this list, a connection on which a TLS session has
25696 been started will not be passed to a new delivery process for sending another
25697 message on the same connection. See section &<<SECTmulmessam>>& for an
25698 explanation of when this might be needed.
25699
25700 .option hosts_noproxy_tls smtp "host list&!!" unset
25701 .cindex "TLS" "passing connection"
25702 .cindex "multiple SMTP deliveries"
25703 .cindex "TLS" "multiple message deliveries"
25704 For any host that matches this list, a TLS session which has
25705 been started will not be passed to a new delivery process for sending another
25706 message on the same session.
25707
25708 The traditional implementation closes down TLS and re-starts it in the new
25709 process, on the same open TCP connection, for each successive message
25710 sent.  If permitted by this option a pipe to to the new process is set up
25711 instead, and the original process maintains the TLS connection and proxies
25712 the SMTP connection from and to the new process and any subsequents.
25713 The new process has no access to TLS information, so cannot include it in
25714 logging.
25715
25716
25717
25718 .option hosts_override smtp boolean false
25719 If this option is set and the &%hosts%& option is also set, any hosts that are
25720 attached to the address are ignored, and instead the hosts specified by the
25721 &%hosts%& option are always used. This option does not apply to
25722 &%fallback_hosts%&.
25723
25724
25725 .option hosts_randomize smtp boolean false
25726 .cindex "randomized host list"
25727 .cindex "host" "list of; randomized"
25728 .cindex "fallback" "randomized hosts"
25729 If this option is set, and either the list of hosts is taken from the
25730 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25731 were not obtained from MX records (this includes fallback hosts from the
25732 router), and were not randomized by the router, the order of trying the hosts
25733 is randomized each time the transport runs. Randomizing the order of a host
25734 list can be used to do crude load sharing.
25735
25736 When &%hosts_randomize%& is true, a host list may be split into groups whose
25737 order is separately randomized. This makes it possible to set up MX-like
25738 behaviour. The boundaries between groups are indicated by an item that is just
25739 &`+`& in the host list. For example:
25740 .code
25741 hosts = host1:host2:host3:+:host4:host5
25742 .endd
25743 The order of the first three hosts and the order of the last two hosts is
25744 randomized for each use, but the first three always end up before the last two.
25745 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25746
25747 .option hosts_require_auth smtp "host list&!!" unset
25748 .cindex "authentication" "required by client"
25749 This option provides a list of servers for which authentication must succeed
25750 before Exim will try to transfer a message. If authentication fails for
25751 servers which are not in this list, Exim tries to send unauthenticated. If
25752 authentication fails for one of these servers, delivery is deferred. This
25753 temporary error is detectable in the retry rules, so it can be turned into a
25754 hard failure if required. See also &%hosts_try_auth%&, and chapter
25755 &<<CHAPSMTPAUTH>>& for details of authentication.
25756
25757
25758 .option hosts_request_ocsp smtp "host list&!!" "see below"
25759 .cindex "TLS" "requiring for certain servers"
25760 Exim will request a Certificate Status on a
25761 TLS session for any host that matches this list.
25762 &%tls_verify_certificates%& should also be set for the transport.
25763
25764 The default is &"**"& if DANE is not in use for the connection,
25765 or if DANE-TA us used.
25766 It is empty if DANE-EE is used.
25767
25768 .option hosts_require_alpn smtp "host list&!!" unset
25769 .cindex ALPN "require negotiation in client"
25770 .cindex TLS ALPN
25771 .cindex TLS "Application Layer Protocol Names"
25772 If the TLS library supports ALPN
25773 then a successful negotiation of ALPN will be required for any host
25774 matching the list, for TLS to be used.
25775 See also the &%tls_alpn%& option.
25776
25777 &*Note*&: prevention of fallback to in-clear connection is not
25778 managed by this option; see &%hosts_require_tls%&.
25779
25780 .option hosts_require_dane smtp "host list&!!" unset
25781 .cindex DANE "transport options"
25782 .cindex DANE "requiring for certain servers"
25783 If built with DANE support, Exim  will require that a DNSSEC-validated
25784 TLSA record is present for any host matching the list,
25785 and that a DANE-verified TLS connection is made.
25786 There will be no fallback to in-clear communication.
25787 See the &%dnssec_request_domains%& router and transport options.
25788 See section &<<SECDANE>>&.
25789
25790 .option hosts_require_ocsp smtp "host list&!!" unset
25791 .cindex "TLS" "requiring for certain servers"
25792 Exim will request, and check for a valid Certificate Status being given, on a
25793 TLS session for any host that matches this list.
25794 &%tls_verify_certificates%& should also be set for the transport.
25795
25796 .option hosts_require_tls smtp "host list&!!" unset
25797 .cindex "TLS" "requiring for certain servers"
25798 Exim will insist on using a TLS session when delivering to any host that
25799 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25800 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25801 incoming messages, use an appropriate ACL.
25802
25803 .option hosts_try_auth smtp "host list&!!" unset
25804 .cindex "authentication" "optional in client"
25805 This option provides a list of servers to which, provided they announce
25806 authentication support, Exim will attempt to authenticate as a client when it
25807 connects. If authentication fails
25808 and &%hosts_require_auth%& permits,
25809 Exim will try to transfer the message unauthenticated.
25810 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25811
25812 .option hosts_try_chunking smtp "host list&!!" *
25813 .cindex CHUNKING "enabling, in client"
25814 .cindex BDAT "SMTP command"
25815 .cindex "RFC 3030" "CHUNKING"
25816 This option provides a list of servers to which, provided they announce
25817 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25818 Unless DKIM signing is being done,
25819 BDAT will not be used in conjunction with a transport filter.
25820
25821 .option hosts_try_dane smtp "host list&!!" *
25822 .cindex DANE "transport options"
25823 .cindex DANE "attempting for certain servers"
25824 If built with DANE support, Exim  will look up a
25825 TLSA record for any host matching the list,
25826 If one is found and that lookup was DNSSEC-validated,
25827 then Exim requires that a DANE-verified TLS connection is made for that host;
25828 there will be no fallback to in-clear communication.
25829 See the &%dnssec_request_domains%& router and transport options.
25830 See section &<<SECDANE>>&.
25831
25832 .option hosts_try_fastopen smtp "host list&!!" *
25833 .cindex "fast open, TCP" "enabling, in client"
25834 .cindex "TCP Fast Open" "enabling, in client"
25835 .cindex "RFC 7413" "TCP Fast Open"
25836 This option provides a list of servers to which, provided
25837 the facility is supported by this system, Exim will attempt to
25838 perform a TCP Fast Open.
25839 No data is sent on the SYN segment but, if the remote server also
25840 supports the facility, it can send its SMTP banner immediately after
25841 the SYN,ACK segment.  This can save up to one round-trip time.
25842
25843 The facility is only active for previously-contacted servers,
25844 as the initiator must present a cookie in the SYN segment.
25845
25846 On (at least some) current Linux distributions the facility must be enabled
25847 in the kernel by the sysadmin before the support is usable.
25848 There is no option for control of the server side; if the system supports
25849 it it is always enabled.  Note that lengthy operations in the connect ACL,
25850 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25851
25852 .option hosts_try_prdr smtp "host list&!!" *
25853 .cindex "PRDR" "enabling, optional in client"
25854 .cindex "ESMTP extensions" PRDR
25855 This option provides a list of servers to which, provided they announce
25856 PRDR support, Exim will attempt to negotiate PRDR
25857 for multi-recipient messages.
25858 The option can usually be left as default.
25859
25860 .option interface smtp "string list&!!" unset
25861 .cindex "bind IP address"
25862 .cindex "IP address" "binding"
25863 .vindex "&$host$&"
25864 .vindex "&$host_address$&"
25865 This option specifies which interface to bind to when making an outgoing SMTP
25866 call. The value is an IP address, not an interface name such as
25867 &`eth0`&. Do not confuse this with the interface address that was used when a
25868 message was received, which is in &$received_ip_address$&, formerly known as
25869 &$interface_address$&. The name was changed to minimize confusion with the
25870 outgoing interface address. There is no variable that contains an outgoing
25871 interface address because, unless it is set by this option, its value is
25872 unknown.
25873
25874 During the expansion of the &%interface%& option the variables &$host$& and
25875 &$host_address$& refer to the host to which a connection is about to be made
25876 during the expansion of the string. Forced expansion failure, or an empty
25877 string result causes the option to be ignored. Otherwise, after expansion, the
25878 string must be a list of IP addresses, colon-separated by default, but the
25879 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25880 For example:
25881 .code
25882 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25883 .endd
25884 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25885 connection. If none of them are the correct type, the option is ignored. If
25886 &%interface%& is not set, or is ignored, the system's IP functions choose which
25887 interface to use if the host has more than one.
25888
25889
25890 .option keepalive smtp boolean true
25891 .cindex "keepalive" "on outgoing connection"
25892 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25893 connections. When set, it causes the kernel to probe idle connections
25894 periodically, by sending packets with &"old"& sequence numbers. The other end
25895 of the connection should send a acknowledgment if the connection is still okay
25896 or a reset if the connection has been aborted. The reason for doing this is
25897 that it has the beneficial effect of freeing up certain types of connection
25898 that can get stuck when the remote host is disconnected without tidying up the
25899 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25900 unreachable hosts.
25901
25902
25903 .option lmtp_ignore_quota smtp boolean false
25904 .cindex "LMTP" "ignoring quota errors"
25905 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25906 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25907 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25908
25909 .option max_rcpt smtp integer&!! 100
25910 .cindex "RCPT" "maximum number of outgoing"
25911 This option,
25912 after expansion,
25913 limits the number of RCPT commands that are sent in a single
25914 SMTP message transaction.
25915 A value setting of zero disables the limit.
25916
25917 If a constant is given,
25918 each set of addresses is treated independently, and
25919 so can cause parallel connections to the same host if &%remote_max_parallel%&
25920 permits this.
25921
25922
25923 .option message_linelength_limit smtp integer 998
25924 .cindex "line length" limit
25925 This option sets the maximum line length, in bytes, that the transport
25926 will send.  Any messages with lines exceeding the given value
25927 (before a transport filter, if any)
25928 will fail and a failure-DSN ("bounce") message will if possible be returned
25929 to the sender.
25930 The default value is that defined by the SMTP standards.
25931
25932 It is generally wise to also check in the data ACL so that messages
25933 received via SMTP can be refused without producing a bounce.
25934
25935
25936 .option multi_domain smtp boolean&!! true
25937 .vindex "&$domain$&"
25938 When this option is set, the &(smtp)& transport can handle a number of
25939 addresses containing a mixture of different domains provided they all resolve
25940 to the same list of hosts. Turning the option off restricts the transport to
25941 handling only one domain at a time. This is useful if you want to use
25942 &$domain$& in an expansion for the transport, because it is set only when there
25943 is a single domain involved in a remote delivery.
25944
25945 It is expanded per-address and can depend on any of
25946 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25947 &$host$&, &$host_address$& and &$host_port$&.
25948
25949 If the connection is DANE-enabled then this option is ignored;
25950 only messages having the domain used for the DANE TLSA lookup are
25951 sent on the connection.
25952
25953 .option port smtp string&!! "see below"
25954 .cindex "port" "sending TCP/IP"
25955 .cindex "TCP/IP" "setting outgoing port"
25956 This option specifies the TCP/IP port on the server to which Exim connects.
25957 &*Note:*& Do not confuse this with the port that was used when a message was
25958 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25959 The name was changed to minimize confusion with the outgoing port. There is no
25960 variable that contains an outgoing port.
25961
25962 If the value of this option begins with a digit it is taken as a port number;
25963 otherwise it is looked up using &[getservbyname()]&. The default value is
25964 normally &"smtp"&,
25965 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25966 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25967 If the expansion fails, or if a port number cannot be found, delivery
25968 is deferred.
25969
25970 Note that at least one Linux distribution has been seen failing
25971 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25972
25973
25974
25975 .option protocol smtp string smtp
25976 .cindex "LMTP" "over TCP/IP"
25977 .cindex "ssmtp protocol" "outbound"
25978 .cindex "TLS" "SSL-on-connect outbound"
25979 .vindex "&$port$&"
25980 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25981 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25982 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25983 deliveries into closed message stores. Exim also has support for running LMTP
25984 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25985
25986 If this option is set to &"smtps"&, the default value for the &%port%& option
25987 changes to &"smtps"&, and the transport initiates TLS immediately after
25988 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25989 The Internet standards bodies used to strongly discourage use of this mode,
25990 but as of RFC 8314 it is preferred over STARTTLS for message submission
25991 (as distinct from MTA-MTA communication).
25992
25993
25994 .option retry_include_ip_address smtp boolean&!! true
25995 Exim normally includes both the host name and the IP address in the key it
25996 constructs for indexing retry data after a temporary delivery failure. This
25997 means that when one of several IP addresses for a host is failing, it gets
25998 tried periodically (controlled by the retry rules), but use of the other IP
25999 addresses is not affected.
26000
26001 However, in some dialup environments hosts are assigned a different IP address
26002 each time they connect. In this situation the use of the IP address as part of
26003 the retry key leads to undesirable behaviour. Setting this option false causes
26004 Exim to use only the host name.
26005 Since it is expanded it can be made to depend on the host or domain.
26006
26007
26008 .option serialize_hosts smtp "host list&!!" unset
26009 .cindex "serializing connections"
26010 .cindex "host" "serializing connections"
26011 Because Exim operates in a distributed manner, if several messages for the same
26012 host arrive at around the same time, more than one simultaneous connection to
26013 the remote host can occur. This is not usually a problem except when there is a
26014 slow link between the hosts. In that situation it may be helpful to restrict
26015 Exim to one connection at a time. This can be done by setting
26016 &%serialize_hosts%& to match the relevant hosts.
26017
26018 .cindex "hints database" "serializing deliveries to a host"
26019 Exim implements serialization by means of a hints database in which a record is
26020 written whenever a process connects to one of the restricted hosts. The record
26021 is deleted when the connection is completed. Obviously there is scope for
26022 records to get left lying around if there is a system or program crash. To
26023 guard against this, Exim ignores any records that are more than six hours old.
26024
26025 If you set up this kind of serialization, you should also arrange to delete the
26026 relevant hints database whenever your system reboots. The names of the files
26027 start with &_misc_& and they are kept in the &_spool/db_& directory. There
26028 may be one or two files, depending on the type of DBM in use. The same files
26029 are used for ETRN serialization.
26030
26031 See also the &%max_parallel%& generic transport option.
26032
26033
26034 .option size_addition smtp integer 1024
26035 .cindex "SIZE" "ESMTP extension"
26036 .cindex "message" "size issue for transport filter"
26037 .cindex "size" "of message"
26038 .cindex "transport" "filter"
26039 .cindex "filter" "transport filter"
26040 If a remote SMTP server indicates that it supports the SIZE option of the
26041 MAIL command, Exim uses this to pass over the message size at the start of
26042 an SMTP transaction. It adds the value of &%size_addition%& to the value it
26043 sends, to allow for headers and other text that may be added during delivery by
26044 configuration options or in a transport filter. It may be necessary to increase
26045 this if a lot of text is added to messages.
26046
26047 Alternatively, if the value of &%size_addition%& is set negative, it disables
26048 the use of the SIZE option altogether.
26049
26050
26051 .option socks_proxy smtp string&!! unset
26052 .cindex proxy SOCKS
26053 This option enables use of SOCKS proxies for connections made by the
26054 transport.  For details see section &<<SECTproxySOCKS>>&.
26055
26056
26057 .option tls_alpn smtp string&!! unset
26058 .cindex TLS "Application Layer Protocol Names"
26059 .cindex TLS ALPN
26060 .cindex ALPN "set name in client"
26061 If this option is set
26062 and the TLS library supports ALPN,
26063 the value given is used.
26064
26065 As of writing no value has been standardised for email use.
26066 The authors suggest using &"smtp"&.
26067
26068
26069
26070 .option tls_certificate smtp string&!! unset
26071 .cindex "TLS" "client certificate, location of"
26072 .cindex "certificate" "client, location of"
26073 .vindex "&$host$&"
26074 .vindex "&$host_address$&"
26075 The value of this option must be the absolute path to a file which contains the
26076 client's certificate, for possible use when sending a message over an encrypted
26077 connection. The values of &$host$& and &$host_address$& are set to the name and
26078 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
26079 details of TLS.
26080
26081 &*Note*&: This option must be set if you want Exim to be able to use a TLS
26082 certificate when sending messages as a client. The global option of the same
26083 name specifies the certificate for Exim as a server; it is not automatically
26084 assumed that the same certificate should be used when Exim is operating as a
26085 client.
26086
26087
26088 .option tls_crl smtp string&!! unset
26089 .cindex "TLS" "client certificate revocation list"
26090 .cindex "certificate" "revocation list for client"
26091 This option specifies a certificate revocation list. The expanded value must
26092 be the name of a file that contains a CRL in PEM format.
26093
26094
26095 .option tls_dh_min_bits smtp integer 1024
26096 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
26097 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
26098 key agreement is negotiated, the server will provide a large prime number
26099 for use.  This option establishes the minimum acceptable size of that number.
26100 If the parameter offered by the server is too small, then the TLS handshake
26101 will fail.
26102
26103 Only supported when using GnuTLS.
26104
26105
26106 .option tls_privatekey smtp string&!! unset
26107 .cindex "TLS" "client private key, location of"
26108 .vindex "&$host$&"
26109 .vindex "&$host_address$&"
26110 The value of this option must be the absolute path to a file which contains the
26111 client's private key. This is used when sending a message over an encrypted
26112 connection using a client certificate. The values of &$host$& and
26113 &$host_address$& are set to the name and address of the server during the
26114 expansion. If this option is unset, or the expansion is forced to fail, or the
26115 result is an empty string, the private key is assumed to be in the same file as
26116 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
26117
26118
26119 .option tls_require_ciphers smtp string&!! unset
26120 .cindex "TLS" "requiring specific ciphers"
26121 .cindex "cipher" "requiring specific"
26122 .vindex "&$host$&"
26123 .vindex "&$host_address$&"
26124 The value of this option must be a list of permitted cipher suites, for use
26125 when setting up an outgoing encrypted connection. (There is a global option of
26126 the same name for controlling incoming connections.) The values of &$host$& and
26127 &$host_address$& are set to the name and address of the server during the
26128 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
26129 is used in different ways by OpenSSL and GnuTLS (see sections
26130 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
26131 ciphers is a preference order.
26132
26133
26134 .option tls_resumption_hosts smtp "host list&!!" unset
26135 .cindex TLS resumption
26136 This option controls which connections to use the TLS resumption feature.
26137 See &<<SECTresumption>>& for details.
26138
26139
26140
26141 .option tls_sni smtp string&!! unset
26142 .cindex "TLS" "Server Name Indication"
26143 .cindex "TLS" SNI
26144 .cindex SNI "setting in client"
26145 .vindex "&$tls_sni$&"
26146 If this option is set
26147 and the connection is not DANE-validated
26148 then it sets the $tls_out_sni variable and causes any
26149 TLS session to pass this value as the Server Name Indication extension to
26150 the remote side, which can be used by the remote side to select an appropriate
26151 certificate and private key for the session.
26152
26153 See &<<SECTtlssni>>& for more information.
26154
26155 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26156 TLS extensions.
26157
26158
26159
26160
26161 .option tls_tempfail_tryclear smtp boolean true
26162 .cindex "4&'xx'& responses" "to STARTTLS"
26163 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26164 setting up a TLS session, this option determines whether or not Exim should try
26165 to deliver the message unencrypted. If it is set false, delivery to the
26166 current host is deferred; if there are other hosts, they are tried. If this
26167 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26168 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26169 TLS negotiation fails, Exim closes the current connection (because it is in an
26170 unknown state), opens a new one to the same host, and then tries the delivery
26171 in clear.
26172
26173
26174 .option tls_try_verify_hosts smtp "host list&!!" *
26175 .cindex "TLS" "server certificate verification"
26176 .cindex "certificate" "verification of server"
26177 This option gives a list of hosts for which, on encrypted connections,
26178 certificate verification will be tried but need not succeed.
26179 The &%tls_verify_certificates%& option must also be set.
26180 Note that unless the host is in this list
26181 TLS connections will be denied to hosts using self-signed certificates
26182 when &%tls_verify_certificates%& is matched.
26183 The &$tls_out_certificate_verified$& variable is set when
26184 certificate verification succeeds.
26185
26186
26187 .option tls_verify_cert_hostnames smtp "host list&!!" *
26188 .cindex "TLS" "server certificate hostname verification"
26189 .cindex "certificate" "verification of server"
26190 This option give a list of hosts for which,
26191 while verifying the server certificate,
26192 checks will be included on the host name
26193 (note that this will generally be the result of a DNS MX lookup)
26194 versus the Subject-Alternate-Name (or, if none, Subject-Name) fields.
26195 Wildcard names are permitted,
26196 limited to being the initial component of a 3-or-more component FQDN.
26197
26198 There is no equivalent checking on client certificates.
26199
26200
26201 .option tls_verify_certificates smtp string&!! system
26202 .cindex "TLS" "server certificate verification"
26203 .cindex "certificate" "verification of server"
26204 .vindex "&$host$&"
26205 .vindex "&$host_address$&"
26206 The value of this option must be either the
26207 word "system"
26208 or the absolute path to
26209 a file or directory containing permitted certificates for servers,
26210 for use when setting up an encrypted connection.
26211
26212 The "system" value for the option will use a location compiled into the SSL library.
26213 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26214 is taken as empty and an explicit location
26215 must be specified.
26216
26217 The use of a directory for the option value is not available for GnuTLS versions
26218 preceding 3.3.6 and a single file must be used.
26219
26220 With OpenSSL the certificates specified
26221 explicitly
26222 either by file or directory
26223 are added to those given by the system default location.
26224
26225 The values of &$host$& and
26226 &$host_address$& are set to the name and address of the server during the
26227 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26228
26229 For back-compatibility,
26230 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26231 (a single-colon empty list counts as being set)
26232 and certificate verification fails the TLS connection is closed.
26233
26234
26235 .option tls_verify_hosts smtp "host list&!!" unset
26236 .cindex "TLS" "server certificate verification"
26237 .cindex "certificate" "verification of server"
26238 This option gives a list of hosts for which, on encrypted connections,
26239 certificate verification must succeed.
26240 The &%tls_verify_certificates%& option must also be set.
26241 If both this option and &%tls_try_verify_hosts%& are unset
26242 operation is as if this option selected all hosts.
26243 &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
26244 that connections use TLS.
26245 Fallback to in-clear communication will be done unless restricted by
26246 the &%hosts_require_tls%& option.
26247
26248 .option utf8_downconvert smtp integer&!! -1
26249 .cindex utf8 "address downconversion"
26250 .cindex i18n "utf8 address downconversion"
26251 If built with internationalization support,
26252 this option controls conversion of UTF-8 in message envelope addresses
26253 to a-label form.
26254 If, after expansion, the value is 1, 0, or -1 then this value overrides
26255 any value previously set for the message.  Otherwise, any previously
26256 set value is used.  To permit use of a previous value,
26257 set this option to an empty string.
26258 For details on the values see section &<<SECTi18nMTA>>&.
26259
26260
26261
26262
26263 .section "How the limits for the number of hosts to try are used" &&&
26264          "SECTvalhosmax"
26265 .cindex "host" "maximum number to try"
26266 .cindex "limit" "hosts; maximum number tried"
26267 There are two options that are concerned with the number of hosts that are
26268 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26269 &%hosts_max_try_hardlimit%&.
26270
26271
26272 The &%hosts_max_try%& option limits the number of hosts that are tried
26273 for a single delivery. However, despite the term &"host"& in its name, the
26274 option actually applies to each IP address independently. In other words, a
26275 multihomed host is treated as several independent hosts, just as it is for
26276 retrying.
26277
26278 Many of the larger ISPs have multiple MX records which often point to
26279 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26280 created as a result of routing one of these domains.
26281
26282 Trying every single IP address on such a long list does not seem sensible; if
26283 several at the top of the list fail, it is reasonable to assume there is some
26284 problem that is likely to affect all of them. Roughly speaking, the value of
26285 &%hosts_max_try%& is the maximum number that are tried before deferring the
26286 delivery. However, the logic cannot be quite that simple.
26287
26288 Firstly, IP addresses that are skipped because their retry times have not
26289 arrived do not count, and in addition, addresses that are past their retry
26290 limits are also not counted, even when they are tried. This means that when
26291 some IP addresses are past their retry limits, more than the value of
26292 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26293 that all IP addresses are considered before timing out an email address (but
26294 see below for an exception).
26295
26296 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26297 list to see if there is a subsequent host with a different (higher valued) MX.
26298 If there is, that host is considered next, and the current IP address is used
26299 but not counted. This behaviour helps in the case of a domain with a retry rule
26300 that hardly ever delays any hosts, as is now explained:
26301
26302 Consider the case of a long list of hosts with one MX value, and a few with a
26303 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26304 hosts at the top of the list are tried at first. With the default retry rule,
26305 which specifies increasing retry times, the higher MX hosts are eventually
26306 tried when those at the top of the list are skipped because they have not
26307 reached their retry times.
26308
26309 However, it is common practice to put a fixed short retry time on domains for
26310 large ISPs, on the grounds that their servers are rarely down for very long.
26311 Unfortunately, these are exactly the domains that tend to resolve to long lists
26312 of hosts. The short retry time means that the lowest MX hosts are tried every
26313 time. The attempts may be in a different order because of random sorting, but
26314 without the special MX check, the higher MX hosts would never be tried until
26315 all the lower MX hosts had timed out (which might be several days), because
26316 there are always some lower MX hosts that have reached their retry times. With
26317 the special check, Exim considers at least one IP address from each MX value at
26318 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26319 reached.
26320
26321 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26322 particular, Exim normally eventually tries all the IP addresses before timing
26323 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26324 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26325 been set up with hundreds of IP addresses for some domains. It can
26326 take a very long time indeed for an address to time out in these cases.
26327
26328 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26329 Exim never tries more than this number of IP addresses; if it hits this limit
26330 and they are all timed out, the email address is bounced, even though not all
26331 possible IP addresses have been tried.
26332 .ecindex IIDsmttra1
26333 .ecindex IIDsmttra2
26334
26335
26336
26337
26338
26339 . ////////////////////////////////////////////////////////////////////////////
26340 . ////////////////////////////////////////////////////////////////////////////
26341
26342 .chapter "Address rewriting" "CHAPrewrite"
26343 .scindex IIDaddrew "rewriting" "addresses"
26344 There are some circumstances in which Exim automatically rewrites domains in
26345 addresses. The two most common are when an address is given without a domain
26346 (referred to as an &"unqualified address"&) or when an address contains an
26347 abbreviated domain that is expanded by DNS lookup.
26348
26349 Unqualified envelope addresses are accepted only for locally submitted
26350 messages, or for messages that are received from hosts matching
26351 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26352 appropriate. Unqualified addresses in header lines are qualified if they are in
26353 locally submitted messages, or messages from hosts that are permitted to send
26354 unqualified envelope addresses. Otherwise, unqualified addresses in header
26355 lines are neither qualified nor rewritten.
26356
26357 One situation in which Exim does &'not'& automatically rewrite a domain is
26358 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26359 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26360 do this. The new RFCs do not contain this suggestion.
26361
26362
26363 .section "Explicitly configured address rewriting" "SECID147"
26364 This chapter describes the rewriting rules that can be used in the
26365 main rewrite section of the configuration file, and also in the generic
26366 &%headers_rewrite%& option that can be set on any transport.
26367
26368 Some people believe that configured address rewriting is a Mortal Sin.
26369 Others believe that life is not possible without it. Exim provides the
26370 facility; you do not have to use it.
26371
26372 The main rewriting rules that appear in the &"rewrite"& section of the
26373 configuration file are applied to addresses in incoming messages, both envelope
26374 addresses and addresses in header lines. Each rule specifies the types of
26375 address to which it applies.
26376
26377 Whether or not addresses in header lines are rewritten depends on the origin of
26378 the headers and the type of rewriting. Global rewriting, that is, rewriting
26379 rules from the rewrite section of the configuration file, is applied only to
26380 those headers that were received with the message. Header lines that are added
26381 by ACLs or by a system filter or by individual routers or transports (which
26382 are specific to individual recipient addresses) are not rewritten by the global
26383 rules.
26384
26385 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26386 applies all headers except those added by routers and transports. That is, as
26387 well as the headers that were received with the message, it also applies to
26388 headers that were added by an ACL or a system filter.
26389
26390
26391 In general, rewriting addresses from your own system or domain has some
26392 legitimacy. Rewriting other addresses should be done only with great care and
26393 in special circumstances. The author of Exim believes that rewriting should be
26394 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26395 Although it can sometimes be used as a routing tool, this is very strongly
26396 discouraged.
26397
26398 There are two commonly encountered circumstances where rewriting is used, as
26399 illustrated by these examples:
26400
26401 .ilist
26402 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26403 exchange mail with each other behind a firewall, but there is only a single
26404 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26405 &'hitch.fict.example'& when sending mail off-site.
26406 .next
26407 A host rewrites the local parts of its own users so that, for example,
26408 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26409 .endlist
26410
26411
26412
26413 .section "When does rewriting happen?" "SECID148"
26414 .cindex "rewriting" "timing of"
26415 .cindex "&ACL;" "rewriting addresses in"
26416 Configured address rewriting can take place at several different stages of a
26417 message's processing.
26418
26419 .vindex "&$sender_address$&"
26420 At the start of an ACL for MAIL, the sender address may have been rewritten
26421 by a special SMTP-time rewrite rule (see section &<<SSECTrewriteS>>&), but no
26422 ordinary rewrite rules have yet been applied. If, however, the sender address
26423 is verified in the ACL, it is rewritten before verification, and remains
26424 rewritten thereafter. The subsequent value of &$sender_address$& is the
26425 rewritten address. This also applies if sender verification happens in a
26426 RCPT ACL. Otherwise, when the sender address is not verified, it is
26427 rewritten as soon as a message's header lines have been received.
26428
26429 .vindex "&$domain$&"
26430 .vindex "&$local_part$&"
26431 Similarly, at the start of an ACL for RCPT, the current recipient's address
26432 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26433 rewrite rules have yet been applied to it. However, the behaviour is different
26434 from the sender address when a recipient is verified. The address is rewritten
26435 for the verification, but the rewriting is not remembered at this stage. The
26436 value of &$local_part$& and &$domain$& after verification are always the same
26437 as they were before (that is, they contain the unrewritten &-- except for
26438 SMTP-time rewriting &-- address).
26439
26440 As soon as a message's header lines have been received, all the envelope
26441 recipient addresses are permanently rewritten, and rewriting is also applied to
26442 the addresses in the header lines (if configured). This happens before adding
26443 any header lines that were specified in MAIL or RCPT ACLs, and
26444 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26445 before the DATA ACL and &[local_scan()]& functions are run.
26446
26447 When an address is being routed, either for delivery or for verification,
26448 rewriting is applied immediately to child addresses that are generated by
26449 redirection, unless &%no_rewrite%& is set on the router.
26450
26451 .cindex "envelope from"
26452 .cindex "envelope sender" "rewriting at transport time"
26453 .cindex "rewriting" "at transport time"
26454 .cindex "header lines" "rewriting at transport time"
26455 At transport time, additional rewriting of addresses in header lines can be
26456 specified by setting the generic &%headers_rewrite%& option on a transport.
26457 This option contains rules that are identical in form to those in the rewrite
26458 section of the configuration file. They are applied to the original message
26459 header lines and any that were added by ACLs or a system filter. They are not
26460 applied to header lines that are added by routers or the transport.
26461
26462 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26463 transport option. However, it is not possible to rewrite envelope recipients at
26464 transport time.
26465
26466
26467
26468
26469 .section "Testing the rewriting rules that apply on input" "SECID149"
26470 .cindex "rewriting" "testing"
26471 .cindex "testing" "rewriting"
26472 Exim's input rewriting configuration appears in a part of the runtime
26473 configuration file headed by &"begin rewrite"&. It can be tested by the
26474 &%-brw%& command line option. This takes an address (which can be a full RFC
26475 2822 address) as its argument. The output is a list of how the address would be
26476 transformed by the rewriting rules for each of the different places it might
26477 appear in an incoming message, that is, for each different header and for the
26478 envelope sender and recipient fields. For example,
26479 .code
26480 exim -brw ph10@exim.workshop.example
26481 .endd
26482 might produce the output
26483 .code
26484 sender: Philip.Hazel@exim.workshop.example
26485 from: Philip.Hazel@exim.workshop.example
26486 to: ph10@exim.workshop.example
26487 cc: ph10@exim.workshop.example
26488 bcc: ph10@exim.workshop.example
26489 reply-to: Philip.Hazel@exim.workshop.example
26490 env-from: Philip.Hazel@exim.workshop.example
26491 env-to: ph10@exim.workshop.example
26492 .endd
26493 which shows that rewriting has been set up for that address when used in any of
26494 the source fields, but not when it appears as a recipient address. At the
26495 present time, there is no equivalent way of testing rewriting rules that are
26496 set for a particular transport.
26497
26498
26499 .section "Rewriting rules" "SECID150"
26500 .cindex "rewriting" "rules"
26501 The rewrite section of the configuration file consists of lines of rewriting
26502 rules in the form
26503 .display
26504 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26505 .endd
26506 Rewriting rules that are specified for the &%headers_rewrite%& generic
26507 transport option are given as a colon-separated list. Each item in the list
26508 takes the same form as a line in the main rewriting configuration (except that
26509 any colons must be doubled, of course).
26510
26511 The formats of source patterns and replacement strings are described below.
26512 Each is terminated by white space, unless enclosed in double quotes, in which
26513 case normal quoting conventions apply inside the quotes. The flags are single
26514 characters which may appear in any order. Spaces and tabs between them are
26515 ignored.
26516
26517 For each address that could potentially be rewritten, the rules are scanned in
26518 order, and replacements for the address from earlier rules can themselves be
26519 replaced by later rules (but see the &"q"& and &"R"& flags).
26520
26521 The order in which addresses are rewritten is undefined, may change between
26522 releases, and must not be relied on, with one exception: when a message is
26523 received, the envelope sender is always rewritten first, before any header
26524 lines are rewritten. For example, the replacement string for a rewrite of an
26525 address in &'To:'& must not assume that the message's address in &'From:'& has
26526 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26527 that the envelope sender has already been rewritten.
26528
26529 .vindex "&$domain$&"
26530 .vindex "&$local_part$&"
26531 The variables &$local_part$& and &$domain$& can be used in the replacement
26532 string to refer to the address that is being rewritten. Note that lookup-driven
26533 rewriting can be done by a rule of the form
26534 .code
26535 *@*   ${lookup ...
26536 .endd
26537 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26538 refer to the address that is being rewritten.
26539
26540
26541 .section "Rewriting patterns" "SECID151"
26542 .cindex "rewriting" "patterns"
26543 .cindex "address list" "in a rewriting pattern"
26544 The source pattern in a rewriting rule is any item which may appear in an
26545 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26546 single-item address list, which means that it is expanded before being tested
26547 against the address. As always, if you use a regular expression as a pattern,
26548 you must take care to escape dollar and backslash characters, or use the &`\N`&
26549 facility to suppress string expansion within the regular expression.
26550
26551 Domains in patterns should be given in lower case. Local parts in patterns are
26552 case-sensitive. If you want to do case-insensitive matching of local parts, you
26553 can use a regular expression that starts with &`^(?i)`&.
26554
26555 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26556 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26557 depending on the type of match which occurred. These can be used in the
26558 replacement string to insert portions of the incoming address. &$0$& always
26559 refers to the complete incoming address. When a regular expression is used, the
26560 numerical variables are set from its capturing subexpressions. For other types
26561 of pattern they are set as follows:
26562
26563 .ilist
26564 If a local part or domain starts with an asterisk, the numerical variables
26565 refer to the character strings matched by asterisks, with &$1$& associated with
26566 the first asterisk, and &$2$& with the second, if present. For example, if the
26567 pattern
26568 .code
26569 *queen@*.fict.example
26570 .endd
26571 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26572 .code
26573 $0 = hearts-queen@wonderland.fict.example
26574 $1 = hearts-
26575 $2 = wonderland
26576 .endd
26577 Note that if the local part does not start with an asterisk, but the domain
26578 does, it is &$1$& that contains the wild part of the domain.
26579
26580 .next
26581 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26582 of the domain are placed in the next available numerical variables. Suppose,
26583 for example, that the address &'foo@bar.baz.example'& is processed by a
26584 rewriting rule of the form
26585 .display
26586 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26587 .endd
26588 and the key in the file that matches the domain is &`*.baz.example`&. Then
26589 .code
26590 $1 = foo
26591 $2 = bar
26592 $3 = baz.example
26593 .endd
26594 If the address &'foo@baz.example'& is looked up, this matches the same
26595 wildcard file entry, and in this case &$2$& is set to the empty string, but
26596 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26597 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26598 whole domain. For non-partial domain lookups, no numerical variables are set.
26599 .endlist
26600
26601
26602 .section "Rewriting replacements" "SECID152"
26603 .cindex "rewriting" "replacements"
26604 If the replacement string for a rule is a single asterisk, addresses that
26605 match the pattern and the flags are &'not'& rewritten, and no subsequent
26606 rewriting rules are scanned. For example,
26607 .code
26608 hatta@lookingglass.fict.example  *  f
26609 .endd
26610 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26611 &'From:'& headers.
26612
26613 .vindex "&$domain$&"
26614 .vindex "&$local_part$&"
26615 If the replacement string is not a single asterisk, it is expanded, and must
26616 yield a fully qualified address. Within the expansion, the variables
26617 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26618 Any letters they contain retain their original case &-- they are not lower
26619 cased. The numerical variables are set up according to the type of pattern that
26620 matched the address, as described above. If the expansion is forced to fail by
26621 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26622 current rule is abandoned, but subsequent rules may take effect. Any other
26623 expansion failure causes the entire rewriting operation to be abandoned, and an
26624 entry written to the panic log.
26625
26626
26627
26628 .subsection "Rewriting flags" "SSECID153"
26629 There are three different kinds of flag that may appear on rewriting rules:
26630
26631 .ilist
26632 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26633 c, f, h, r, s, t.
26634 .next
26635 A flag that specifies rewriting at SMTP time: S.
26636 .next
26637 Flags that control the rewriting process: Q, q, R, w.
26638 .endlist
26639
26640 For rules that are part of the &%headers_rewrite%& generic transport option,
26641 E, F, T, and S are not permitted.
26642
26643
26644
26645 .subsection "Flags specifying which headers and envelope addresses to rewrite" &&&
26646          "SSECID154"
26647 .cindex rewriting flags
26648 If none of the following flag letters, nor the &"S"& flag (see section
26649 &<<SSECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26650 and to both the sender and recipient fields of the envelope, whereas a
26651 transport-time rewriting rule just applies to all headers. Otherwise, the
26652 rewriting rule is skipped unless the relevant addresses are being processed.
26653 .display
26654 &`E`&       rewrite all envelope fields
26655 &`F`&       rewrite the envelope From field
26656 &`T`&       rewrite the envelope To field
26657 &`b`&       rewrite the &'Bcc:'& header
26658 &`c`&       rewrite the &'Cc:'& header
26659 &`f`&       rewrite the &'From:'& header
26660 &`h`&       rewrite all headers
26661 &`r`&       rewrite the &'Reply-To:'& header
26662 &`s`&       rewrite the &'Sender:'& header
26663 &`t`&       rewrite the &'To:'& header
26664 .endd
26665 "All headers" means all of the headers listed above that can be selected
26666 individually, plus their &'Resent-'& versions. It does not include
26667 other headers such as &'Subject:'& etc.
26668
26669 You should be particularly careful about rewriting &'Sender:'& headers, and
26670 restrict this to special known cases in your own domains.
26671
26672
26673 .subsection "The SMTP-time rewriting flag" SSECTrewriteS
26674 .cindex SMTP "rewriting malformed addresses"
26675 .cindex RCPT "rewriting argument of"
26676 .cindex MAIL "rewriting argument of"
26677 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26678 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26679 before any other processing; even before syntax checking. The pattern is
26680 required to be a regular expression, and it is matched against the whole of the
26681 data for the command, including any surrounding angle brackets.
26682
26683 .vindex "&$domain$&"
26684 .vindex "&$local_part$&"
26685 This form of rewrite rule allows for the handling of addresses that are not
26686 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26687 input). Because the input is not required to be a syntactically valid address,
26688 the variables &$local_part$& and &$domain$& are not available during the
26689 expansion of the replacement string. The result of rewriting replaces the
26690 original address in the MAIL or RCPT command.
26691
26692
26693 .subsection "Flags controlling the rewriting process" SSECID155
26694 There are four flags which control the way the rewriting process works. These
26695 take effect only when a rule is invoked, that is, when the address is of the
26696 correct type (matches the flags) and matches the pattern:
26697
26698 .ilist
26699 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26700 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26701 absence of &"Q"& the rewritten address must always include a domain.
26702 .next
26703 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26704 even if no rewriting actually takes place because of a &"fail"& in the
26705 expansion. The &"q"& flag is not effective if the address is of the wrong type
26706 (does not match the flags) or does not match the pattern.
26707 .next
26708 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26709 address, up to ten times. It can be combined with the &"q"& flag, to stop
26710 rewriting once it fails to match (after at least one successful rewrite).
26711 .next
26712 .cindex "rewriting" "whole addresses"
26713 When an address in a header is rewritten, the rewriting normally applies only
26714 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26715 left unchanged. For example, rewriting might change
26716 .code
26717 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26718 .endd
26719 into
26720 .code
26721 From: Ford Prefect <prefectf@hitch.fict.example>
26722 .endd
26723 .cindex "RFC 2047"
26724 Sometimes there is a need to replace the whole address item, and this can be
26725 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26726 causes an address in a header line to be rewritten, the entire address is
26727 replaced, not just the working part. The replacement must be a complete RFC
26728 2822 address, including the angle brackets if necessary. If text outside angle
26729 brackets contains a character whose value is greater than 126 or less than 32
26730 (except for tab), the text is encoded according to RFC 2047. The character set
26731 is taken from &%headers_charset%&, which gets its default at build time.
26732
26733 When the &"w"& flag is set on a rule that causes an envelope address to be
26734 rewritten, all but the working part of the replacement address is discarded.
26735 .endlist
26736
26737
26738 .section "Rewriting examples" "SECID156"
26739 Here is an example of the two common rewriting paradigms:
26740 .code
26741 *@*.hitch.fict.example  $1@hitch.fict.example
26742 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26743                      {$value}fail}@hitch.fict.example bctfrF
26744 .endd
26745 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26746 the string expansion to fail if the lookup does not succeed. In this context it
26747 has the effect of leaving the original address unchanged, but Exim goes on to
26748 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26749 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26750 explicitly, which would cause the rewritten address to be the same as before,
26751 at the cost of a small bit of processing. Not supplying either of these is an
26752 error, since the rewritten address would then contain no local part.
26753
26754 The first example above replaces the domain with a superior, more general
26755 domain. This may not be desirable for certain local parts. If the rule
26756 .code
26757 root@*.hitch.fict.example  *
26758 .endd
26759 were inserted before the first rule, rewriting would be suppressed for the
26760 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26761
26762 Rewriting can be made conditional on a number of tests, by making use of
26763 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26764 messages that originate outside the local host:
26765 .code
26766 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26767                          {$1@hitch.fict.example}fail}"
26768 .endd
26769 The replacement string is quoted in this example because it contains white
26770 space.
26771
26772 .cindex "rewriting" "bang paths"
26773 .cindex "bang paths" "rewriting"
26774 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26775 an address it treats it as an unqualified local part which it qualifies with
26776 the local qualification domain (if the source of the message is local or if the
26777 remote host is permitted to send unqualified addresses). Rewriting can
26778 sometimes be used to handle simple bang paths with a fixed number of
26779 components. For example, the rule
26780 .code
26781 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26782 .endd
26783 rewrites a two-component bang path &'host.name!user'& as the domain address
26784 &'user@host.name'&. However, there is a security implication in using this as
26785 a global rewriting rule for envelope addresses. It can provide a backdoor
26786 method for using your system as a relay, because the incoming addresses appear
26787 to be local. If the bang path addresses are received via SMTP, it is safer to
26788 use the &"S"& flag to rewrite them as they are received, so that relay checking
26789 can be done on the rewritten addresses.
26790 .ecindex IIDaddrew
26791
26792
26793
26794
26795
26796 . ////////////////////////////////////////////////////////////////////////////
26797 . ////////////////////////////////////////////////////////////////////////////
26798
26799 .chapter "Retry configuration" "CHAPretry"
26800 .scindex IIDretconf1 "retry" "configuration, description of"
26801 .scindex IIDregconf2 "configuration file" "retry section"
26802 The &"retry"& section of the runtime configuration file contains a list of
26803 retry rules that control how often Exim tries to deliver messages that cannot
26804 be delivered at the first attempt. If there are no retry rules (the section is
26805 empty or not present), there are no retries. In this situation, temporary
26806 errors are treated as permanent. The default configuration contains a single,
26807 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26808 line option can be used to test which retry rule will be used for a given
26809 address, domain and error.
26810
26811 The most common cause of retries is temporary failure to deliver to a remote
26812 host because the host is down, or inaccessible because of a network problem.
26813 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26814 address) basis, not on a per-message basis. Thus, if one message has recently
26815 been delayed, delivery of a new message to the same host is not immediately
26816 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26817 log selector is set, the message
26818 .cindex "retry" "time not reached"
26819 &"retry time not reached"& is written to the main log whenever a delivery is
26820 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26821 the handling of errors during remote deliveries.
26822
26823 Retry processing applies to routing as well as to delivering, except as covered
26824 in the next paragraph. The retry rules do not distinguish between these
26825 actions. It is not possible, for example, to specify different behaviour for
26826 failures to route the domain &'snark.fict.example'& and failures to deliver to
26827 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26828 added complication, so did not implement it. However, although they share the
26829 same retry rule, the actual retry times for routing and transporting a given
26830 domain are maintained independently.
26831
26832 When a delivery is not part of a queue run (typically an immediate delivery on
26833 receipt of a message), the routers are always run, and local deliveries are
26834 always attempted, even if retry times are set for them. This makes for better
26835 behaviour if one particular message is causing problems (for example, causing
26836 quota overflow, or provoking an error in a filter file). If such a delivery
26837 suffers a temporary failure, the retry data is updated as normal, and
26838 subsequent delivery attempts from queue runs occur only when the retry time for
26839 the local address is reached.
26840
26841 .section "Changing retry rules" "SECID157"
26842 If you change the retry rules in your configuration, you should consider
26843 whether or not to delete the retry data that is stored in Exim's spool area in
26844 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26845 always safe; that is why they are called &"hints"&.
26846
26847 The hints retry data contains suggested retry times based on the previous
26848 rules. In the case of a long-running problem with a remote host, it might
26849 record the fact that the host has timed out. If your new rules increase the
26850 timeout time for such a host, you should definitely remove the old retry data
26851 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26852 messages that it should now be retaining.
26853
26854
26855
26856 .section "Format of retry rules" "SECID158"
26857 .cindex "retry" "rules"
26858 Each retry rule occupies one line and consists of three or four parts,
26859 separated by white space: a pattern, an error name, an optional list of sender
26860 addresses, and a list of retry parameters. The pattern and sender lists must be
26861 enclosed in double quotes if they contain white space. The rules are searched
26862 in order until one is found where the pattern, error name, and sender list (if
26863 present) match the failing host or address, the error that occurred, and the
26864 message's sender, respectively.
26865
26866
26867 The pattern is any single item that may appear in an address list (see section
26868 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26869 which means that it is expanded before being tested against the address that
26870 has been delayed. A negated address list item is permitted. Address
26871 list processing treats a plain domain name as if it were preceded by &"*@"&,
26872 which makes it possible for many retry rules to start with just a domain. For
26873 example,
26874 .code
26875 lookingglass.fict.example        *  F,24h,30m;
26876 .endd
26877 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26878 whereas
26879 .code
26880 alice@lookingglass.fict.example  *  F,24h,30m;
26881 .endd
26882 applies only to temporary failures involving the local part &%alice%&.
26883 In practice, almost all rules start with a domain name pattern without a local
26884 part.
26885
26886 .cindex "regular expressions" "in retry rules"
26887 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26888 must match a complete address, not just a domain, because that is how regular
26889 expressions work in address lists.
26890 .display
26891 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26892 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26893 .endd
26894
26895
26896 .section "Choosing which retry rule to use for address errors" "SECID159"
26897 When Exim is looking for a retry rule after a routing attempt has failed (for
26898 example, after a DNS timeout), each line in the retry configuration is tested
26899 against the complete address only if &%retry_use_local_part%& is set for the
26900 router. Otherwise, only the domain is used, except when matching against a
26901 regular expression, when the local part of the address is replaced with &"*"&.
26902 A domain on its own can match a domain pattern, or a pattern that starts with
26903 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26904 &%check_local_user%& is true, and false for other routers.
26905
26906 Similarly, when Exim is looking for a retry rule after a local delivery has
26907 failed (for example, after a mailbox full error), each line in the retry
26908 configuration is tested against the complete address only if
26909 &%retry_use_local_part%& is set for the transport (it defaults true for all
26910 local transports).
26911
26912 .cindex "4&'xx'& responses" "retry rules for"
26913 However, when Exim is looking for a retry rule after a remote delivery attempt
26914 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26915 whole address is always used as the key when searching the retry rules. The
26916 rule that is found is used to create a retry time for the combination of the
26917 failing address and the message's sender. It is the combination of sender and
26918 recipient that is delayed in subsequent queue runs until its retry time is
26919 reached. You can delay the recipient without regard to the sender by setting
26920 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26921 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26922 commands.
26923
26924
26925
26926 .section "Choosing which retry rule to use for host and message errors" &&&
26927          "SECID160"
26928 For a temporary error that is not related to an individual address (for
26929 example, a connection timeout), each line in the retry configuration is checked
26930 twice. First, the name of the remote host is used as a domain name (preceded by
26931 &"*@"& when matching a regular expression). If this does not match the line,
26932 the domain from the email address is tried in a similar fashion. For example,
26933 suppose the MX records for &'a.b.c.example'& are
26934 .code
26935 a.b.c.example  MX  5  x.y.z.example
26936                MX  6  p.q.r.example
26937                MX  7  m.n.o.example
26938 .endd
26939 and the retry rules are
26940 .code
26941 p.q.r.example    *      F,24h,30m;
26942 a.b.c.example    *      F,4d,45m;
26943 .endd
26944 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26945 first rule matches neither the host nor the domain, so Exim looks at the second
26946 rule. This does not match the host, but it does match the domain, so it is used
26947 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26948 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26949 first retry rule is used, because it matches the host.
26950
26951 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26952 first rule to determine retry times, but for all the other hosts for the domain
26953 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26954 routing to &'a.b.c.example'& suffers a temporary failure.
26955
26956 &*Note*&: The host name is used when matching the patterns, not its IP address.
26957 However, if a message is routed directly to an IP address without the use of a
26958 host name, for example, if a &(manualroute)& router contains a setting such as:
26959 .code
26960 route_list = *.a.example  192.168.34.23
26961 .endd
26962 then the &"host name"& that is used when searching for a retry rule is the
26963 textual form of the IP address.
26964
26965 .section "Retry rules for specific errors" "SECID161"
26966 .cindex "retry" "specific errors; specifying"
26967 The second field in a retry rule is the name of a particular error, or an
26968 asterisk, which matches any error. The errors that can be tested for are:
26969
26970 .vlist
26971 .vitem &%auth_failed%&
26972 Authentication failed when trying to send to a host in the
26973 &%hosts_require_auth%& list in an &(smtp)& transport.
26974
26975 .vitem &%data_4xx%&
26976 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26977 after the command, or after sending the message's data.
26978
26979 .vitem &%mail_4xx%&
26980 A 4&'xx'& error was received for an outgoing MAIL command.
26981
26982 .vitem &%rcpt_4xx%&
26983 A 4&'xx'& error was received for an outgoing RCPT command.
26984 .endlist
26985
26986 For the three 4&'xx'& errors, either the first or both of the x's can be given
26987 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26988 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26989 and have retries every ten minutes with a one-hour timeout, you could set up a
26990 retry rule of this form:
26991 .code
26992 the.domain.name  rcpt_452   F,1h,10m
26993 .endd
26994 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26995 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26996
26997 .vlist
26998 .vitem &%lost_connection%&
26999 A server unexpectedly closed the SMTP connection. There may, of course,
27000 legitimate reasons for this (host died, network died), but if it repeats a lot
27001 for the same host, it indicates something odd.
27002
27003 .vitem &%lookup%&
27004 A DNS lookup for a host failed.
27005 Note that a &%dnslookup%& router will need to have matched
27006 its &%fail_defer_domains%& option for this retry type to be usable.
27007 Also note that a &%manualroute%& router will probably need
27008 its &%host_find_failed%& option set to &%defer%&.
27009
27010 .vitem &%refused_MX%&
27011 A connection to a host obtained from an MX record was refused.
27012
27013 .vitem &%refused_A%&
27014 A connection to a host not obtained from an MX record was refused.
27015
27016 .vitem &%refused%&
27017 A connection was refused.
27018
27019 .vitem &%timeout_connect_MX%&
27020 A connection attempt to a host obtained from an MX record timed out.
27021
27022 .vitem &%timeout_connect_A%&
27023 A connection attempt to a host not obtained from an MX record timed out.
27024
27025 .vitem &%timeout_connect%&
27026 A connection attempt timed out.
27027
27028 .vitem &%timeout_MX%&
27029 There was a timeout while connecting or during an SMTP session with a host
27030 obtained from an MX record.
27031
27032 .vitem &%timeout_A%&
27033 There was a timeout while connecting or during an SMTP session with a host not
27034 obtained from an MX record.
27035
27036 .vitem &%timeout%&
27037 There was a timeout while connecting or during an SMTP session.
27038
27039 .vitem &%tls_required%&
27040 The server was required to use TLS (it matched &%hosts_require_tls%& in the
27041 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
27042 to STARTTLS, or there was a problem setting up the TLS connection.
27043
27044 .vitem &%quota%&
27045 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27046 transport.
27047
27048 .vitem &%quota_%&<&'time'&>
27049 .cindex "quota" "error testing in retry rule"
27050 .cindex "retry" "quota error testing"
27051 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
27052 transport, and the mailbox has not been accessed for <&'time'&>. For example,
27053 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
27054 for four days.
27055 .endlist
27056
27057 .cindex "mailbox" "time of last read"
27058 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
27059 timeouts when the mailbox is full and is not being read by its owner. Ideally,
27060 it should be based on the last time that the user accessed the mailbox.
27061 However, it is not always possible to determine this. Exim uses the following
27062 heuristic rules:
27063
27064 .ilist
27065 If the mailbox is a single file, the time of last access (the &"atime"&) is
27066 used. As no new messages are being delivered (because the mailbox is over
27067 quota), Exim does not access the file, so this is the time of last user access.
27068 .next
27069 .cindex "maildir format" "time of last read"
27070 For a maildir delivery, the time of last modification of the &_new_&
27071 subdirectory is used. As the mailbox is over quota, no new files are created in
27072 the &_new_& subdirectory, because no new messages are being delivered. Any
27073 change to the &_new_& subdirectory is therefore assumed to be the result of an
27074 MUA moving a new message to the &_cur_& directory when it is first read. The
27075 time that is used is therefore the last time that the user read a new message.
27076 .next
27077 For other kinds of multi-file mailbox, the time of last access cannot be
27078 obtained, so a retry rule that uses this type of error field is never matched.
27079 .endlist
27080
27081 The quota errors apply both to system-enforced quotas and to Exim's own quota
27082 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
27083 when a local delivery is deferred because a partition is full (the ENOSPC
27084 error).
27085
27086
27087
27088 .section "Retry rules for specified senders" "SECID162"
27089 .cindex "retry" "rules; sender-specific"
27090 You can specify retry rules that apply only when the failing message has a
27091 specific sender. In particular, this can be used to define retry rules that
27092 apply only to bounce messages. The third item in a retry rule can be of this
27093 form:
27094 .display
27095 &`senders=`&<&'address list'&>
27096 .endd
27097 The retry timings themselves are then the fourth item. For example:
27098 .code
27099 *   rcpt_4xx   senders=:   F,1h,30m
27100 .endd
27101 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
27102 host. If the address list contains white space, it must be enclosed in quotes.
27103 For example:
27104 .code
27105 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
27106 .endd
27107 &*Warning*&: This facility can be unhelpful if it is used for host errors
27108 (which do not depend on the recipient). The reason is that the sender is used
27109 only to match the retry rule. Once the rule has been found for a host error,
27110 its contents are used to set a retry time for the host, and this will apply to
27111 all messages, not just those with specific senders.
27112
27113 When testing retry rules using &%-brt%&, you can supply a sender using the
27114 &%-f%& command line option, like this:
27115 .code
27116 exim -f "" -brt user@dom.ain
27117 .endd
27118 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
27119 list is never matched.
27120
27121
27122
27123
27124
27125 .section "Retry parameters" "SECID163"
27126 .cindex "retry" "parameters in rules"
27127 The third (or fourth, if a senders list is present) field in a retry rule is a
27128 sequence of retry parameter sets, separated by semicolons. Each set consists of
27129 .display
27130 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
27131 .endd
27132 The letter identifies the algorithm for computing a new retry time; the cutoff
27133 time is the time beyond which this algorithm no longer applies, and the
27134 arguments vary the algorithm's action. The cutoff time is measured from the
27135 time that the first failure for the domain (combined with the local part if
27136 relevant) was detected, not from the time the message was received.
27137
27138 .cindex "retry" "algorithms"
27139 .cindex "retry" "fixed intervals"
27140 .cindex "retry" "increasing intervals"
27141 .cindex "retry" "random intervals"
27142 The available algorithms are:
27143
27144 .ilist
27145 &'F'&: retry at fixed intervals. There is a single time parameter specifying
27146 the interval.
27147 .next
27148 &'G'&: retry at geometrically increasing intervals. The first argument
27149 specifies a starting value for the interval, and the second a multiplier, which
27150 is used to increase the size of the interval at each retry.
27151 .next
27152 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
27153 retry, the previous interval is multiplied by the factor in order to get a
27154 maximum for the next interval. The minimum interval is the first argument of
27155 the parameter, and an actual interval is chosen randomly between them. Such a
27156 rule has been found to be helpful in cluster configurations when all the
27157 members of the cluster restart at once, and may therefore synchronize their
27158 queue processing times.
27159 .endlist
27160
27161 When computing the next retry time, the algorithm definitions are scanned in
27162 order until one whose cutoff time has not yet passed is reached. This is then
27163 used to compute a new retry time that is later than the current time. In the
27164 case of fixed interval retries, this simply means adding the interval to the
27165 current time. For geometrically increasing intervals, retry intervals are
27166 computed from the rule's parameters until one that is greater than the previous
27167 interval is found. The main configuration variable
27168 .cindex "limit" "retry interval"
27169 .cindex "retry" "interval, maximum"
27170 .oindex "&%retry_interval_max%&"
27171 &%retry_interval_max%& limits the maximum interval between retries. It
27172 cannot be set greater than &`24h`&, which is its default value.
27173
27174 A single remote domain may have a number of hosts associated with it, and each
27175 host may have more than one IP address. Retry algorithms are selected on the
27176 basis of the domain name, but are applied to each IP address independently. If,
27177 for example, a host has two IP addresses and one is unusable, Exim will
27178 generate retry times for it and will not try to use it until its next retry
27179 time comes. Thus the good IP address is likely to be tried first most of the
27180 time.
27181
27182 .cindex "hints database" "use for retrying"
27183 Retry times are hints rather than promises. Exim does not make any attempt to
27184 run deliveries exactly at the computed times. Instead, a queue runner process
27185 starts delivery processes for delayed messages periodically, and these attempt
27186 new deliveries only for those addresses that have passed their next retry time.
27187 If a new message arrives for a deferred address, an immediate delivery attempt
27188 occurs only if the address has passed its retry time. In the absence of new
27189 messages, the minimum time between retries is the interval between queue runner
27190 processes. There is not much point in setting retry times of five minutes if
27191 your queue runners happen only once an hour, unless there are a significant
27192 number of incoming messages (which might be the case on a system that is
27193 sending everything to a smart host, for example).
27194
27195 The data in the retry hints database can be inspected by using the
27196 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27197 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27198 &'exinext'& utility script can be used to find out what the next retry times
27199 are for the hosts associated with a particular mail domain, and also for local
27200 deliveries that have been deferred.
27201
27202
27203 .section "Retry rule examples" "SECID164"
27204 Here are some example retry rules:
27205 .code
27206 alice@wonderland.fict.example quota_5d  F,7d,3h
27207 wonderland.fict.example       quota_5d
27208 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27209 lookingglass.fict.example     *         F,24h,30m;
27210 *                 refused_A   F,2h,20m;
27211 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27212 .endd
27213 The first rule sets up special handling for mail to
27214 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27215 mailbox has not been read for at least 5 days. Retries continue every three
27216 hours for 7 days. The second rule handles over-quota errors for all other local
27217 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27218 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27219 fail are bounced immediately if the mailbox has not been read for at least 5
27220 days.
27221
27222 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27223 happen every 15 minutes for an hour, then with geometrically increasing
27224 intervals until two days have passed since a delivery first failed. After the
27225 first hour there is a delay of one hour, then two hours, then four hours, and
27226 so on (this is a rather extreme example).
27227
27228 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27229 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27230 all other domains, with special action for connection refusal from hosts that
27231 were not obtained from an MX record.
27232
27233 The final rule in a retry configuration should always have asterisks in the
27234 first two fields so as to provide a general catch-all for any addresses that do
27235 not have their own special handling. This example tries every 15 minutes for 2
27236 hours, then with intervals starting at one hour and increasing by a factor of
27237 1.5 up to 16 hours, then every 8 hours up to 5 days.
27238
27239
27240
27241 .section "Timeout of retry data" "SECID165"
27242 .cindex "timeout" "of retry data"
27243 .oindex "&%retry_data_expire%&"
27244 .cindex "hints database" "data expiry"
27245 .cindex "retry" "timeout of data"
27246 Exim timestamps the data that it writes to its retry hints database. When it
27247 consults the data during a delivery it ignores any that is older than the value
27248 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27249 been tried for 7 days, Exim will try to deliver to it immediately a message
27250 arrives, and if that fails, it will calculate a retry time as if it were
27251 failing for the first time.
27252
27253 This improves the behaviour for messages routed to rarely-used hosts such as MX
27254 backups. If such a host was down at one time, and happens to be down again when
27255 Exim tries a month later, using the old retry data would imply that it had been
27256 down all the time, which is not a justified assumption.
27257
27258 If a host really is permanently dead, this behaviour causes a burst of retries
27259 every now and again, but only if messages routed to it are rare. If there is a
27260 message at least once every 7 days the retry data never expires.
27261
27262
27263
27264
27265 .section "Long-term failures" "SECID166"
27266 .cindex "delivery failure, long-term"
27267 .cindex "retry" "after long-term failure"
27268 Special processing happens when an email address has been failing for so long
27269 that the cutoff time for the last algorithm is reached. For example, using the
27270 default retry rule:
27271 .code
27272 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27273 .endd
27274 the cutoff time is four days. Reaching the retry cutoff is independent of how
27275 long any specific message has been failing; it is the length of continuous
27276 failure for the recipient address that counts.
27277
27278 When the cutoff time is reached for a local delivery, or for all the IP
27279 addresses associated with a remote delivery, a subsequent delivery failure
27280 causes Exim to give up on the address, and a bounce message is generated.
27281 In order to cater for new messages that use the failing address, a next retry
27282 time is still computed from the final algorithm, and is used as follows:
27283
27284 For local deliveries, one delivery attempt is always made for any subsequent
27285 messages. If this delivery fails, the address fails immediately. The
27286 post-cutoff retry time is not used.
27287
27288 .cindex "final cutoff" "retries, controlling"
27289 .cindex retry "final cutoff"
27290 If the delivery is remote, there are two possibilities, controlled by the
27291 .oindex "&%delay_after_cutoff%&"
27292 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27293 default. Until the post-cutoff retry time for one of the IP addresses,
27294 as set by the &%retry_data_expire%& option, is
27295 reached, the failing email address is bounced immediately, without a delivery
27296 attempt taking place. After that time, one new delivery attempt is made to
27297 those IP addresses that are past their retry times, and if that still fails,
27298 the address is bounced and new retry times are computed.
27299
27300 In other words, when all the hosts for a given email address have been failing
27301 for a long time, Exim bounces rather then defers until one of the hosts' retry
27302 times is reached. Then it tries once, and bounces if that attempt fails. This
27303 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27304 to a broken destination, but if the host does recover, Exim will eventually
27305 notice.
27306
27307 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27308 addresses are past their final cutoff time, Exim tries to deliver to those IP
27309 addresses that have not been tried since the message arrived. If there are
27310 no suitable IP addresses, or if they all fail, the address is bounced. In other
27311 words, it does not delay when a new message arrives, but tries the expired
27312 addresses immediately, unless they have been tried since the message arrived.
27313 If there is a continuous stream of messages for the failing domains, setting
27314 &%delay_after_cutoff%& false means that there will be many more attempts to
27315 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27316 true.
27317
27318 .section "Deliveries that work intermittently" "SECID167"
27319 .cindex "retry" "intermittently working deliveries"
27320 Some additional logic is needed to cope with cases where a host is
27321 intermittently available, or when a message has some attribute that prevents
27322 its delivery when others to the same address get through. In this situation,
27323 because some messages are successfully delivered, the &"retry clock"& for the
27324 host or address keeps getting reset by the successful deliveries, and so
27325 failing messages remain in the queue for ever because the cutoff time is never
27326 reached.
27327
27328 Two exceptional actions are applied to prevent this happening. The first
27329 applies to errors that are related to a message rather than a remote host.
27330 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27331 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27332 commands, and quota failures. For this type of error, if a message's arrival
27333 time is earlier than the &"first failed"& time for the error, the earlier time
27334 is used when scanning the retry rules to decide when to try next and when to
27335 time out the address.
27336
27337 The exceptional second action applies in all cases. If a message has been on
27338 the queue for longer than the cutoff time of any applicable retry rule for a
27339 given address, a delivery is attempted for that address, even if it is not yet
27340 time, and if this delivery fails, the address is timed out. A new retry time is
27341 not computed in this case, so that other messages for the same address are
27342 considered immediately.
27343 .ecindex IIDretconf1
27344 .ecindex IIDregconf2
27345
27346
27347
27348
27349
27350
27351 . ////////////////////////////////////////////////////////////////////////////
27352 . ////////////////////////////////////////////////////////////////////////////
27353
27354 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27355 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27356 .scindex IIDauthconf2 "authentication"
27357 The &"authenticators"& section of Exim's runtime configuration is concerned
27358 with SMTP authentication. This facility is an extension to the SMTP protocol,
27359 described in RFC 2554, which allows a client SMTP host to authenticate itself
27360 to a server. This is a common way for a server to recognize clients that are
27361 permitted to use it as a relay. SMTP authentication is not of relevance to the
27362 transfer of mail between servers that have no managerial connection with each
27363 other.
27364
27365 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27366 prior to Exim 4.95 names would be silently truncated at this length, but now
27367 it is enforced.
27368
27369 .cindex "AUTH" "description of"
27370 .cindex "ESMTP extensions" AUTH
27371 Very briefly, the way SMTP authentication works is as follows:
27372
27373 .olist
27374 The server advertises a number of authentication &'mechanisms'& in response to
27375 the client's EHLO command.
27376 .next
27377 The client issues an AUTH command, naming a specific mechanism. The command
27378 may, optionally, contain some authentication data.
27379 .next
27380 The server may issue one or more &'challenges'&, to which the client must send
27381 appropriate responses. In simple authentication mechanisms, the challenges are
27382 just prompts for user names and passwords. The server does not have to issue
27383 any challenges &-- in some mechanisms the relevant data may all be transmitted
27384 with the AUTH command.
27385 .next
27386 The server either accepts or denies authentication.
27387 .next
27388 If authentication succeeds, the client may optionally make use of the AUTH
27389 option on the MAIL command to pass an authenticated sender in subsequent
27390 mail transactions. Authentication lasts for the remainder of the SMTP
27391 connection.
27392 .next
27393 If authentication fails, the client may give up, or it may try a different
27394 authentication mechanism, or it may try transferring mail over the
27395 unauthenticated connection.
27396 .endlist
27397
27398 If you are setting up a client, and want to know which authentication
27399 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27400 SMTP port) on the server, and issue an EHLO command. The response to this
27401 includes the list of supported mechanisms. For example:
27402 .display
27403 &`$ `&&*&`telnet server.example 25`&*&
27404 &`Trying 192.168.34.25...`&
27405 &`Connected to server.example.`&
27406 &`Escape character is &#x0027;^]&#x0027;.`&
27407 &`220 server.example ESMTP Exim 4.20 ...`&
27408 &*&`ehlo client.example`&*&
27409 &`250-server.example Hello client.example [10.8.4.5]`&
27410 &`250-SIZE 52428800`&
27411 &`250-PIPELINING`&
27412 &`250-AUTH PLAIN`&
27413 &`250 HELP`&
27414 .endd
27415 The second-last line of this example output shows that the server supports
27416 authentication using the PLAIN mechanism. In Exim, the different authentication
27417 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27418 routers and transports, which authenticators are included in the binary is
27419 controlled by build-time definitions. The following are currently available,
27420 included by setting
27421 .code
27422 AUTH_CRAM_MD5=yes
27423 AUTH_CYRUS_SASL=yes
27424 AUTH_DOVECOT=yes
27425 AUTH_EXTERNAL=yes
27426 AUTH_GSASL=yes
27427 AUTH_HEIMDAL_GSSAPI=yes
27428 AUTH_PLAINTEXT=yes
27429 AUTH_SPA=yes
27430 AUTH_TLS=yes
27431 .endd
27432 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27433 authentication mechanism (RFC 2195), and the second provides an interface to
27434 the Cyrus SASL authentication library.
27435 The third is an interface to Dovecot's authentication system, delegating the
27436 work via a socket interface.
27437 The fourth provides for negotiation of authentication done via non-SMTP means,
27438 as defined by RFC 4422 Appendix A.
27439 The fifth provides an interface to the GNU SASL authentication library, which
27440 provides mechanisms but typically not data sources.
27441 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27442 supporting setting a server keytab.
27443 The seventh can be configured to support
27444 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27445 not formally documented, but used by several MUAs.
27446 The eighth authenticator
27447 supports Microsoft's &'Secure Password Authentication'& mechanism.
27448 The last is an Exim authenticator but not an SMTP one;
27449 instead it can use information from a TLS negotiation.
27450
27451 The authenticators are configured using the same syntax as other drivers (see
27452 section &<<SECTfordricon>>&). If no authenticators are required, no
27453 authentication section need be present in the configuration file. Each
27454 authenticator can in principle have both server and client functions. When Exim
27455 is receiving SMTP mail, it is acting as a server; when it is sending out
27456 messages over SMTP, it is acting as a client. Authenticator configuration
27457 options are provided for use in both these circumstances.
27458
27459 To make it clear which options apply to which situation, the prefixes
27460 &%server_%& and &%client_%& are used on option names that are specific to
27461 either the server or the client function, respectively. Server and client
27462 functions are disabled if none of their options are set. If an authenticator is
27463 to be used for both server and client functions, a single definition, using
27464 both sets of options, is required. For example:
27465 .code
27466 cram:
27467   driver = cram_md5
27468   public_name = CRAM-MD5
27469   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27470   client_name = ph10
27471   client_secret = secret2
27472 .endd
27473 The &%server_%& option is used when Exim is acting as a server, and the
27474 &%client_%& options when it is acting as a client.
27475
27476 Descriptions of the individual authenticators are given in subsequent chapters.
27477 The remainder of this chapter covers the generic options for the
27478 authenticators, followed by general discussion of the way authentication works
27479 in Exim.
27480
27481 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27482 per-mechanism basis.  Please read carefully to determine which variables hold
27483 account labels such as usercodes and which hold passwords or other
27484 authenticating data.
27485
27486 Note that some mechanisms support two different identifiers for accounts: the
27487 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27488 and &'authz'& are commonly encountered.  The American spelling is standard here.
27489 Conceptually, authentication data such as passwords are tied to the identifier
27490 used to authenticate; servers may have rules to permit one user to act as a
27491 second user, so that after login the session is treated as though that second
27492 user had logged in.  That second user is the &'authorization id'&.  A robust
27493 configuration might confirm that the &'authz'& field is empty or matches the
27494 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27495 as verified data, the &'authz'& as an unverified request which the server might
27496 choose to honour.
27497
27498 A &'realm'& is a text string, typically a domain name, presented by a server
27499 to a client to help it select an account and credentials to use.  In some
27500 mechanisms, the client and server provably agree on the realm, but clients
27501 typically can not treat the realm as secure data to be blindly trusted.
27502
27503
27504
27505 .section "Generic options for authenticators" "SECID168"
27506 .cindex "authentication" "generic options"
27507 .cindex "options" "generic; for authenticators"
27508
27509 .option client_condition authenticators string&!! unset
27510 When Exim is authenticating as a client, it skips any authenticator whose
27511 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27512 used, for example, to skip plain text authenticators when the connection is not
27513 encrypted by a setting such as:
27514 .code
27515 client_condition = ${if !eq{$tls_out_cipher}{}}
27516 .endd
27517
27518
27519 .option client_set_id authenticators string&!! unset
27520 When client authentication succeeds, this condition is expanded; the
27521 result is used in the log lines for outbound messages.
27522 Typically it will be the user name used for authentication.
27523
27524
27525 .option driver authenticators string unset
27526 This option must always be set. It specifies which of the available
27527 authenticators is to be used.
27528
27529
27530 .option public_name authenticators string unset
27531 This option specifies the name of the authentication mechanism that the driver
27532 implements, and by which it is known to the outside world. These names should
27533 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27534 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27535 defaults to the driver's instance name.
27536
27537
27538 .option server_advertise_condition authenticators string&!! unset
27539 When a server is about to advertise an authentication mechanism, the condition
27540 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27541 mechanism is not advertised.
27542 If the expansion fails, the mechanism is not advertised. If the failure was not
27543 forced, and was not caused by a lookup defer, the incident is logged.
27544 See section &<<SECTauthexiser>>& below for further discussion.
27545
27546
27547 .option server_condition authenticators string&!! unset
27548 This option must be set for a &%plaintext%& server authenticator, where it
27549 is used directly to control authentication. See section &<<SECTplainserver>>&
27550 for details.
27551
27552 For the &(gsasl)& authenticator, this option is required for various
27553 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27554
27555 For the other authenticators, &%server_condition%& can be used as an additional
27556 authentication or authorization mechanism that is applied after the other
27557 authenticator conditions succeed. If it is set, it is expanded when the
27558 authenticator would otherwise return a success code. If the expansion is forced
27559 to fail, authentication fails. Any other expansion failure causes a temporary
27560 error code to be returned. If the result of a successful expansion is an empty
27561 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27562 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27563 other result, a temporary error code is returned, with the expanded string as
27564 the error text.
27565
27566
27567 .option server_debug_print authenticators string&!! unset
27568 If this option is set and authentication debugging is enabled (see the &%-d%&
27569 command line option), the string is expanded and included in the debugging
27570 output when the authenticator is run as a server. This can help with checking
27571 out the values of variables.
27572 If expansion of the string fails, the error message is written to the debugging
27573 output, and Exim carries on processing.
27574
27575
27576 .option server_set_id authenticators string&!! unset
27577 .vindex "&$authenticated_id$&"
27578 .vindex "&$authenticated_fail_id$&"
27579 When an Exim server successfully authenticates a client, this string is
27580 expanded using data from the authentication, and preserved for any incoming
27581 messages in the variable &$authenticated_id$&. It is also included in the log
27582 lines for incoming messages. For example, a user/password authenticator
27583 configuration might preserve the user name that was used to authenticate, and
27584 refer to it subsequently during delivery of the message.
27585 On a failing authentication the expansion result is instead saved in
27586 the &$authenticated_fail_id$& variable.
27587 If expansion fails, the option is ignored.
27588
27589
27590 .option server_mail_auth_condition authenticators string&!! unset
27591 This option allows a server to discard authenticated sender addresses supplied
27592 as part of MAIL commands in SMTP connections that are authenticated by the
27593 driver on which &%server_mail_auth_condition%& is set. The option is not used
27594 as part of the authentication process; instead its (unexpanded) value is
27595 remembered for later use.
27596 How it is used is described in the following section.
27597
27598
27599
27600
27601
27602 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27603 .cindex "authentication" "sender; authenticated"
27604 .cindex "AUTH" "on MAIL command"
27605 When a client supplied an AUTH= item on a MAIL command, Exim applies
27606 the following checks before accepting it as the authenticated sender of the
27607 message:
27608
27609 .ilist
27610 If the connection is not using extended SMTP (that is, HELO was used rather
27611 than EHLO), the use of AUTH= is a syntax error.
27612 .next
27613 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27614 .next
27615 .vindex "&$authenticated_sender$&"
27616 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27617 running, the value of &$authenticated_sender$& is set to the value obtained
27618 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27619 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27620 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27621 given for the MAIL command.
27622 .next
27623 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27624 is accepted and placed in &$authenticated_sender$& only if the client has
27625 authenticated.
27626 .next
27627 If the AUTH= value was accepted by either of the two previous rules, and
27628 the client has authenticated, and the authenticator has a setting for the
27629 &%server_mail_auth_condition%&, the condition is checked at this point. The
27630 valued that was saved from the authenticator is expanded. If the expansion
27631 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27632 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27633 the value of &$authenticated_sender$& is retained and passed on with the
27634 message.
27635 .endlist
27636
27637
27638 When &$authenticated_sender$& is set for a message, it is passed on to other
27639 hosts to which Exim authenticates as a client. Do not confuse this value with
27640 &$authenticated_id$&, which is a string obtained from the authentication
27641 process, and which is not usually a complete email address.
27642
27643 .vindex "&$sender_address$&"
27644 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27645 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27646 therefore make use of &$authenticated_sender$&. The converse is not true: the
27647 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27648 ACL is run.
27649
27650
27651
27652 .section "Authentication on an Exim server" "SECTauthexiser"
27653 .cindex "authentication" "on an Exim server"
27654 When Exim receives an EHLO command, it advertises the public names of those
27655 authenticators that are configured as servers, subject to the following
27656 conditions:
27657
27658 .ilist
27659 The client host must match &%auth_advertise_hosts%& (default *).
27660 .next
27661 If the &%server_advertise_condition%& option is set, its expansion must not
27662 yield the empty string, &"0"&, &"no"&, or &"false"&.
27663 .endlist
27664
27665 The order in which the authenticators are defined controls the order in which
27666 the mechanisms are advertised.
27667
27668 Some mail clients (for example, some versions of Netscape) require the user to
27669 provide a name and password for authentication whenever AUTH is advertised,
27670 even though authentication may not in fact be needed (for example, Exim may be
27671 set up to allow unconditional relaying from the client by an IP address check).
27672 You can make such clients more friendly by not advertising AUTH to them.
27673 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27674 that runs for RCPT) to relay without authentication, you should set
27675 .code
27676 auth_advertise_hosts = ! 10.9.8.0/24
27677 .endd
27678 so that no authentication mechanisms are advertised to them.
27679
27680 The &%server_advertise_condition%& controls the advertisement of individual
27681 authentication mechanisms. For example, it can be used to restrict the
27682 advertisement of a particular mechanism to encrypted connections, by a setting
27683 such as:
27684 .code
27685 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27686 .endd
27687 .vindex "&$tls_in_cipher$&"
27688 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27689 yields &"yes"&, which allows the advertisement to happen.
27690
27691 When an Exim server receives an AUTH command from a client, it rejects it
27692 immediately if AUTH was not advertised in response to an earlier EHLO
27693 command. This is the case if
27694
27695 .ilist
27696 The client host does not match &%auth_advertise_hosts%&; or
27697 .next
27698 No authenticators are configured with server options; or
27699 .next
27700 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27701 server authenticators.
27702 .endlist
27703
27704
27705 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27706 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27707 AUTH is accepted from any client host.
27708
27709 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27710 server authentication mechanism that was advertised in response to EHLO and
27711 that matches the one named in the AUTH command. If it finds one, it runs
27712 the appropriate authentication protocol, and authentication either succeeds or
27713 fails. If there is no matching advertised mechanism, the AUTH command is
27714 rejected with a 504 error.
27715
27716 .vindex "&$received_protocol$&"
27717 .vindex "&$sender_host_authenticated$&"
27718 When a message is received from an authenticated host, the value of
27719 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27720 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27721 public name) of the authenticator driver that successfully authenticated the
27722 client from which the message was received. This variable is empty if there was
27723 no successful authentication.
27724
27725 .cindex authentication "expansion item"
27726 Successful authentication sets up information used by the
27727 &%authresults%& expansion item.
27728
27729 .cindex authentication "failure event, server"
27730 If an authenticator is run and does not succeed,
27731 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27732 While the event is being processed the variables
27733 &$sender_host_authenticated$& (with the authenticator name)
27734 and &$authenticated_fail_id$& (as set by the authenticator &%server_set_id%& option)
27735 will be valid.
27736 If the event is serviced and a string is returned then the string will be logged
27737 instead of the default log line.
27738 See <<CHAPevents>> for details on events.
27739
27740
27741 .section "Testing server authentication" "SECID169"
27742 .cindex "authentication" "testing a server"
27743 .cindex "AUTH" "testing a server"
27744 .cindex "base64 encoding" "creating authentication test data"
27745 Exim's &%-bh%& option can be useful for testing server authentication
27746 configurations. The data for the AUTH command has to be sent using base64
27747 encoding. A quick way to produce such data for testing is the following Perl
27748 script:
27749 .code
27750 use MIME::Base64;
27751 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27752 .endd
27753 .cindex "binary zero" "in authentication data"
27754 This interprets its argument as a Perl string, and then encodes it. The
27755 interpretation as a Perl string allows binary zeros, which are required for
27756 some kinds of authentication, to be included in the data. For example, a
27757 command line to run this script on such data might be
27758 .code
27759 encode '\0user\0password'
27760 .endd
27761 Note the use of single quotes to prevent the shell interpreting the
27762 backslashes, so that they can be interpreted by Perl to specify characters
27763 whose code value is zero.
27764
27765 &*Warning 1*&: If either of the user or password strings starts with an octal
27766 digit, you must use three zeros instead of one after the leading backslash. If
27767 you do not, the octal digit that starts your string will be incorrectly
27768 interpreted as part of the code for the first character.
27769
27770 &*Warning 2*&: If there are characters in the strings that Perl interprets
27771 specially, you must use a Perl escape to prevent them being misinterpreted. For
27772 example, a command such as
27773 .code
27774 encode '\0user@domain.com\0pas$$word'
27775 .endd
27776 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27777
27778 If you have the &%mimencode%& command installed, another way to produce
27779 base64-encoded strings is to run the command
27780 .code
27781 echo -e -n `\0user\0password' | mimencode
27782 .endd
27783 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27784 in the argument, and the &%-n%& option specifies no newline at the end of its
27785 output. However, not all versions of &%echo%& recognize these options, so you
27786 should check your version before relying on this suggestion.
27787
27788
27789
27790 .section "Authentication by an Exim client" "SECID170"
27791 .cindex "authentication" "on an Exim client"
27792 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27793 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27794 announces support for authentication, and the host matches an entry in either
27795 of these options, Exim (as a client) tries to authenticate as follows:
27796
27797 .ilist
27798 For each authenticator that is configured as a client, in the order in which
27799 they are defined in the configuration, it searches the authentication
27800 mechanisms announced by the server for one whose name matches the public name
27801 of the authenticator.
27802 .next
27803 .vindex "&$host$&"
27804 .vindex "&$host_address$&"
27805 When it finds one that matches, it runs the authenticator's client code. The
27806 variables &$host$& and &$host_address$& are available for any string expansions
27807 that the client might do. They are set to the server's name and IP address. If
27808 any expansion is forced to fail, the authentication attempt is abandoned, and
27809 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27810 delivery to be deferred.
27811 .next
27812 If the result of the authentication attempt is a temporary error or a timeout,
27813 Exim abandons trying to send the message to the host for the moment. It will
27814 try again later. If there are any backup hosts available, they are tried in the
27815 usual way.
27816
27817 .next
27818 .cindex authentication "failure event, client"
27819 If the response to authentication is a permanent error (5&'xx'& code),
27820 an event (see &<<CHAPevents>>&) of type "auth:fail" is raised.
27821 While the event is being processed the variable
27822 &$sender_host_authenticated$& (with the authenticator name)
27823 will be valid.
27824 If the event is serviced and a string is returned then the string will be logged.
27825 See <<CHAPevents>> for details on events.
27826
27827 .next
27828 If the response to authentication is a permanent error (5&'xx'& code), Exim
27829 carries on searching the list of authenticators and tries another one if
27830 possible. If all authentication attempts give permanent errors, or if there are
27831 no attempts because no mechanisms match (or option expansions force failure),
27832 what happens depends on whether the host matches &%hosts_require_auth%& or
27833 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27834 delivery is deferred. The error can be detected in the retry rules, and thereby
27835 turned into a permanent error if you wish. In the second case, Exim tries to
27836 deliver the message unauthenticated.
27837 .endlist
27838
27839 Note that the hostlist test for whether to do authentication can be
27840 confused if name-IP lookups change between the time the peer is decided
27841 upon and the time that the transport runs.  For example, with a manualroute
27842 router given a host name, and with DNS "round-robin" used by that name: if
27843 the local resolver cache times out between the router and the transport
27844 running, the transport may get an IP for the name for its authentication
27845 check which does not match the connection peer IP.
27846 No authentication will then be done, despite the names being identical.
27847
27848 For such cases use a separate transport which always authenticates.
27849
27850 .cindex "AUTH" "on MAIL command"
27851 When Exim has authenticated itself to a remote server, it adds the AUTH
27852 parameter to the MAIL commands it sends, if it has an authenticated sender for
27853 the message. If the message came from a remote host, the authenticated sender
27854 is the one that was receiving on an incoming MAIL command, provided that the
27855 incoming connection was authenticated and the &%server_mail_auth%& condition
27856 allowed the authenticated sender to be retained. If a local process calls Exim
27857 to send a message, the sender address that is built from the login name and
27858 &%qualify_domain%& is treated as authenticated. However, if the
27859 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27860 the authenticated sender that was received with the message.
27861 .ecindex IIDauthconf1
27862 .ecindex IIDauthconf2
27863
27864
27865
27866
27867
27868
27869 . ////////////////////////////////////////////////////////////////////////////
27870 . ////////////////////////////////////////////////////////////////////////////
27871
27872 .chapter "The plaintext authenticator" "CHAPplaintext"
27873 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27874 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27875 The &(plaintext)& authenticator can be configured to support the PLAIN and
27876 LOGIN authentication mechanisms, both of which transfer authentication data as
27877 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27878 security risk; you are strongly advised to insist on the use of SMTP encryption
27879 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27880 use unencrypted plain text, you should not use the same passwords for SMTP
27881 connections as you do for login accounts.
27882
27883 .section "Avoiding cleartext use" "SECTplain_TLS"
27884 The following generic option settings will disable &(plaintext)& authenticators when
27885 TLS is not being used:
27886 .code
27887   server_advertise_condition = ${if def:tls_in_cipher }
27888   client_condition =           ${if def:tls_out_cipher}
27889 .endd
27890
27891 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27892 but is still vulnerable to a Man In The Middle attack unless certificates
27893 (including their names) have been properly verified.
27894
27895 .section "Plaintext server options" "SECID171"
27896 .cindex "options" "&(plaintext)& authenticator (server)"
27897 When configured as a server, &(plaintext)& uses the following options:
27898
27899 .option server_condition authenticators string&!! unset
27900 This is actually a global authentication option, but it must be set in order to
27901 configure the &(plaintext)& driver as a server. Its use is described below.
27902
27903 .option server_prompts plaintext "string list&!!" unset
27904 The contents of this option, after expansion, must be a colon-separated list of
27905 prompt strings. If expansion fails, a temporary authentication rejection is
27906 given.
27907
27908 .section "Using plaintext in a server" "SECTplainserver"
27909 .cindex "AUTH" "in &(plaintext)& authenticator"
27910 .cindex "binary zero" "in &(plaintext)& authenticator"
27911 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27912         "in &(plaintext)& authenticator"
27913 .vindex "&$auth1$&, &$auth2$&, etc"
27914 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27915
27916 When running as a server, &(plaintext)& performs the authentication test by
27917 expanding a string. The data sent by the client with the AUTH command, or in
27918 response to subsequent prompts, is base64 encoded, and so may contain any byte
27919 values when decoded. If any data is supplied with the command, it is treated as
27920 a list of strings, separated by NULs (binary zeros), the first three of which
27921 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27922 (neither LOGIN nor PLAIN uses more than three strings).
27923
27924 For compatibility with previous releases of Exim, the values are also placed in
27925 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27926 variables for this purpose is now deprecated, as it can lead to confusion in
27927 string expansions that also use them for other things.
27928
27929 If there are more strings in &%server_prompts%& than the number of strings
27930 supplied with the AUTH command, the remaining prompts are used to obtain more
27931 data. Each response from the client may be a list of NUL-separated strings.
27932
27933 .vindex "&$authenticated_id$&"
27934 Once a sufficient number of data strings have been received,
27935 &%server_condition%& is expanded. If the expansion is forced to fail,
27936 authentication fails. Any other expansion failure causes a temporary error code
27937 to be returned. If the result of a successful expansion is an empty string,
27938 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27939 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27940 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27941 For any other result, a temporary error code is returned, with the expanded
27942 string as the error text.
27943
27944 &*Warning*&: If you use a lookup in the expansion to find the user's
27945 password, be sure to make the authentication fail if the user is unknown.
27946 There are good and bad examples at the end of the next section.
27947
27948
27949
27950 .section "The PLAIN authentication mechanism" "SECID172"
27951 .cindex "PLAIN authentication mechanism"
27952 .cindex authentication PLAIN
27953 .cindex "binary zero" "in &(plaintext)& authenticator"
27954 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27955 sent as one item of data (that is, one combined string containing two NUL
27956 separators). The data is sent either as part of the AUTH command, or
27957 subsequently in response to an empty prompt from the server.
27958
27959 The second and third strings are a user name and a corresponding password.
27960 Using a single fixed user name and password as an example, this could be
27961 configured as follows:
27962 .code
27963 fixed_plain:
27964   driver = plaintext
27965   public_name = PLAIN
27966   server_prompts = :
27967   server_condition = \
27968     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27969   server_set_id = $auth2
27970 .endd
27971 Note that the default result strings from &%if%& (&"true"& or an empty string)
27972 are exactly what we want here, so they need not be specified. Obviously, if the
27973 password contains expansion-significant characters such as dollar, backslash,
27974 or closing brace, they have to be escaped.
27975
27976 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27977 the end of a string list are ignored). If all the data comes as part of the
27978 AUTH command, as is commonly the case, the prompt is not used. This
27979 authenticator is advertised in the response to EHLO as
27980 .code
27981 250-AUTH PLAIN
27982 .endd
27983 and a client host can authenticate itself by sending the command
27984 .code
27985 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27986 .endd
27987 As this contains three strings (more than the number of prompts), no further
27988 data is required from the client. Alternatively, the client may just send
27989 .code
27990 AUTH PLAIN
27991 .endd
27992 to initiate authentication, in which case the server replies with an empty
27993 prompt. The client must respond with the combined data string.
27994
27995 The data string is base64 encoded, as required by the RFC. This example,
27996 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27997 represents a zero byte. This is split up into three strings, the first of which
27998 is empty. The &%server_condition%& option in the authenticator checks that the
27999 second two are &`username`& and &`mysecret`& respectively.
28000
28001 Having just one fixed user name and password, as in this example, is not very
28002 realistic, though for a small organization with only a handful of
28003 authenticating clients it could make sense.
28004
28005 A more sophisticated instance of this authenticator could use the user name in
28006 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
28007 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
28008 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
28009 This is an incorrect example:
28010 .code
28011 server_condition = \
28012   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
28013 .endd
28014 The expansion uses the user name (&$auth2$&) as the key to look up a password,
28015 which it then compares to the supplied password (&$auth3$&). Why is this example
28016 incorrect? It works fine for existing users, but consider what happens if a
28017 non-existent user name is given. The lookup fails, but as no success/failure
28018 strings are given for the lookup, it yields an empty string. Thus, to defeat
28019 the authentication, all a client has to do is to supply a non-existent user
28020 name and an empty password. The correct way of writing this test is:
28021 .code
28022 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
28023   {${if eq{$value}{$auth3}}} {false}}
28024 .endd
28025 In this case, if the lookup succeeds, the result is checked; if the lookup
28026 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
28027 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
28028 always fails if its second argument is empty. However, the second way of
28029 writing the test makes the logic clearer.
28030
28031
28032 .section "The LOGIN authentication mechanism" "SECID173"
28033 .cindex "LOGIN authentication mechanism"
28034 .cindex authentication LOGIN
28035 The LOGIN authentication mechanism is not documented in any RFC, but is in use
28036 in a number of programs. No data is sent with the AUTH command. Instead, a
28037 user name and password are supplied separately, in response to prompts. The
28038 plaintext authenticator can be configured to support this as in this example:
28039 .code
28040 fixed_login:
28041   driver = plaintext
28042   public_name = LOGIN
28043   server_prompts = User Name : Password
28044   server_condition = \
28045     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
28046   server_set_id = $auth1
28047 .endd
28048 Because of the way plaintext operates, this authenticator accepts data supplied
28049 with the AUTH command (in contravention of the specification of LOGIN), but
28050 if the client does not supply it (as is the case for LOGIN clients), the prompt
28051 strings are used to obtain two data items.
28052
28053 Some clients are very particular about the precise text of the prompts. For
28054 example, Outlook Express is reported to recognize only &"Username:"& and
28055 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
28056 strings. It uses the &%ldapauth%& expansion condition to check the user
28057 name and password by binding to an LDAP server:
28058 .code
28059 login:
28060   driver = plaintext
28061   public_name = LOGIN
28062   server_prompts = Username:: : Password::
28063   server_condition = ${if and{{ \
28064     !eq{}{$auth1} }{ \
28065     ldapauth{\
28066       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
28067       pass=${quote:$auth2} \
28068       ldap://ldap.example.org/} }} }
28069   server_set_id = uid=$auth1,ou=people,o=example.org
28070 .endd
28071 We have to check that the username is not empty before using it, because LDAP
28072 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
28073 operator to correctly quote the DN for authentication. However, the basic
28074 &%quote%& operator, rather than any of the LDAP quoting operators, is the
28075 correct one to use for the password, because quoting is needed only to make
28076 the password conform to the Exim syntax. At the LDAP level, the password is an
28077 uninterpreted string.
28078
28079
28080 .section "Support for different kinds of authentication" "SECID174"
28081 A number of string expansion features are provided for the purpose of
28082 interfacing to different ways of user authentication. These include checking
28083 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
28084 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
28085 &<<SECTexpcond>>&.
28086
28087
28088
28089
28090 .section "Using plaintext in a client" "SECID175"
28091 .cindex "options" "&(plaintext)& authenticator (client)"
28092 The &(plaintext)& authenticator has two client options:
28093
28094 .option client_ignore_invalid_base64 plaintext boolean false
28095 If the client receives a server prompt that is not a valid base64 string,
28096 authentication is abandoned by default. However, if this option is set true,
28097 the error in the challenge is ignored and the client sends the response as
28098 usual.
28099
28100 .option client_send plaintext string&!! unset
28101 The string is a colon-separated list of authentication data strings. Each
28102 string is independently expanded before being sent to the server. The first
28103 string is sent with the AUTH command; any more strings are sent in response
28104 to prompts from the server. Before each string is expanded, the value of the
28105 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
28106 with &$auth1$& for the first prompt. Up to three prompts are stored in this
28107 way. Thus, the prompt that is received in response to sending the first string
28108 (with the AUTH command) can be used in the expansion of the second string, and
28109 so on. If an invalid base64 string is received when
28110 &%client_ignore_invalid_base64%& is set, an empty string is put in the
28111 &$auth$&<&'n'&> variable.
28112
28113 &*Note*&: You cannot use expansion to create multiple strings, because
28114 splitting takes priority and happens first.
28115
28116 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
28117 the data, further processing is applied to each string before it is sent. If
28118 there are any single circumflex characters in the string, they are converted to
28119 NULs. Should an actual circumflex be required as data, it must be doubled in
28120 the string.
28121
28122 This is an example of a client configuration that implements the PLAIN
28123 authentication mechanism with a fixed user name and password:
28124 .code
28125 fixed_plain:
28126   driver = plaintext
28127   public_name = PLAIN
28128   client_send = ^username^mysecret
28129 .endd
28130 The lack of colons means that the entire text is sent with the AUTH
28131 command, with the circumflex characters converted to NULs.
28132 Note that due to the ambiguity of parsing three consectutive circumflex characters
28133 there is no way to provide a password having a leading circumflex.
28134
28135
28136 A similar example
28137 that uses the LOGIN mechanism is:
28138 .code
28139 fixed_login:
28140   driver = plaintext
28141   public_name = LOGIN
28142   client_send = : username : mysecret
28143 .endd
28144 The initial colon means that the first string is empty, so no data is sent with
28145 the AUTH command itself. The remaining strings are sent in response to
28146 prompts.
28147 .ecindex IIDplaiauth1
28148 .ecindex IIDplaiauth2
28149
28150
28151
28152
28153 . ////////////////////////////////////////////////////////////////////////////
28154 . ////////////////////////////////////////////////////////////////////////////
28155
28156 .chapter "The cram_md5 authenticator" "CHID9"
28157 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
28158 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
28159 .cindex "CRAM-MD5 authentication mechanism"
28160 .cindex authentication CRAM-MD5
28161 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
28162 sends a challenge string to the client, and the response consists of a user
28163 name and the CRAM-MD5 digest of the challenge string combined with a secret
28164 string (password) which is known to both server and client. Thus, the secret
28165 is not sent over the network as plain text, which makes this authenticator more
28166 secure than &(plaintext)&. However, the downside is that the secret has to be
28167 available in plain text at either end.
28168
28169
28170 .section "Using cram_md5 as a server" "SECID176"
28171 .cindex "options" "&(cram_md5)& authenticator (server)"
28172 This authenticator has one server option, which must be set to configure the
28173 authenticator as a server:
28174
28175 .option server_secret cram_md5 string&!! unset
28176 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
28177 When the server receives the client's response, the user name is placed in
28178 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
28179 obtain the password for that user. The server then computes the CRAM-MD5 digest
28180 that the client should have sent, and checks that it received the correct
28181 string. If the expansion of &%server_secret%& is forced to fail, authentication
28182 fails. If the expansion fails for some other reason, a temporary error code is
28183 returned to the client.
28184
28185 For compatibility with previous releases of Exim, the user name is also placed
28186 in &$1$&. However, the use of this variables for this purpose is now
28187 deprecated, as it can lead to confusion in string expansions that also use
28188 numeric variables for other things.
28189
28190 For example, the following authenticator checks that the user name given by the
28191 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28192 user name, authentication fails.
28193 .code
28194 fixed_cram:
28195   driver = cram_md5
28196   public_name = CRAM-MD5
28197   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28198   server_set_id = $auth1
28199 .endd
28200 .vindex "&$authenticated_id$&"
28201 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28202 name in &$authenticated_id$&. A more typical configuration might look up the
28203 secret string in a file, using the user name as the key. For example:
28204 .code
28205 lookup_cram:
28206   driver = cram_md5
28207   public_name = CRAM-MD5
28208   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28209                   {$value}fail}
28210   server_set_id = $auth1
28211 .endd
28212 Note that this expansion explicitly forces failure if the lookup fails
28213 because &$auth1$& contains an unknown user name.
28214
28215 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28216 using the relevant libraries, you need to know the realm to specify in the
28217 lookup and then ask for the &"userPassword"& attribute for that user in that
28218 realm, with:
28219 .code
28220 cyrusless_crammd5:
28221   driver = cram_md5
28222   public_name = CRAM-MD5
28223   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28224                   dbmjz{/etc/sasldb2}{$value}fail}
28225   server_set_id = $auth1
28226 .endd
28227
28228 .section "Using cram_md5 as a client" "SECID177"
28229 .cindex "options" "&(cram_md5)& authenticator (client)"
28230 When used as a client, the &(cram_md5)& authenticator has two options:
28231
28232
28233
28234 .option client_name cram_md5 string&!! "the primary host name"
28235 This string is expanded, and the result used as the user name data when
28236 computing the response to the server's challenge.
28237
28238
28239 .option client_secret cram_md5 string&!! unset
28240 This option must be set for the authenticator to work as a client. Its value is
28241 expanded and the result used as the secret string when computing the response.
28242
28243
28244 .vindex "&$host$&"
28245 .vindex "&$host_address$&"
28246 Different user names and secrets can be used for different servers by referring
28247 to &$host$& or &$host_address$& in the options. Forced failure of either
28248 expansion string is treated as an indication that this authenticator is not
28249 prepared to handle this case. Exim moves on to the next configured client
28250 authenticator. Any other expansion failure causes Exim to give up trying to
28251 send the message to the current server.
28252
28253 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28254 strings, is:
28255 .code
28256 fixed_cram:
28257   driver = cram_md5
28258   public_name = CRAM-MD5
28259   client_name = ph10
28260   client_secret = secret
28261 .endd
28262 .ecindex IIDcramauth1
28263 .ecindex IIDcramauth2
28264
28265
28266
28267 . ////////////////////////////////////////////////////////////////////////////
28268 . ////////////////////////////////////////////////////////////////////////////
28269
28270 .chapter "The cyrus_sasl authenticator" "CHID10"
28271 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28272 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28273 .cindex "Cyrus" "SASL library"
28274 .cindex "Kerberos"
28275 The code for this authenticator was provided by Matthew Byng-Maddick while
28276 at A L Digital Ltd.
28277
28278 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28279 library implementation of the RFC 2222 (&"Simple Authentication and Security
28280 Layer"&). This library supports a number of authentication mechanisms,
28281 including PLAIN and LOGIN, but also several others that Exim does not support
28282 directly. In particular, there is support for Kerberos authentication.
28283
28284 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28285 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28286 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28287 name of the driver to determine which mechanism to support.
28288
28289 Where access to some kind of secret file is required, for example, in GSSAPI
28290 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28291 user, and that the Cyrus SASL library has no way of escalating privileges
28292 by default. You may also find you need to set environment variables,
28293 depending on the driver you are using.
28294
28295 The application name provided by Exim is &"exim"&, so various SASL options may
28296 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28297 Kerberos, note that because of limitations in the GSSAPI interface,
28298 changing the server keytab might need to be communicated down to the Kerberos
28299 layer independently. The mechanism for doing so is dependent upon the Kerberos
28300 implementation.
28301
28302 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28303 may be set to point to an alternative keytab file. Exim will pass this
28304 variable through from its own inherited environment when started as root or the
28305 Exim user. The keytab file needs to be readable by the Exim user.
28306 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28307 environment variable.  In practice, for those releases, the Cyrus authenticator
28308 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28309 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28310
28311
28312 .section "Using cyrus_sasl as a server" "SECID178"
28313 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28314 (on a successful authentication) into &$auth1$&. For compatibility with
28315 previous releases of Exim, the username is also placed in &$1$&. However, the
28316 use of this variable for this purpose is now deprecated, as it can lead to
28317 confusion in string expansions that also use numeric variables for other
28318 things.
28319
28320
28321 .option server_hostname cyrus_sasl string&!! "see below"
28322 This option selects the hostname that is used when communicating with the
28323 library. The default value is &`$primary_hostname`&. It is up to the underlying
28324 SASL plug-in what it does with this data.
28325
28326
28327 .option server_mech cyrus_sasl string "see below"
28328 This option selects the authentication mechanism this driver should use. The
28329 default is the value of the generic &%public_name%& option. This option allows
28330 you to use a different underlying mechanism from the advertised name. For
28331 example:
28332 .code
28333 sasl:
28334   driver = cyrus_sasl
28335   public_name = X-ANYTHING
28336   server_mech = CRAM-MD5
28337   server_set_id = $auth1
28338 .endd
28339
28340 .option server_realm cyrus_sasl string&!! unset
28341 This specifies the SASL realm that the server claims to be in.
28342
28343
28344 .option server_service cyrus_sasl string &`smtp`&
28345 This is the SASL service that the server claims to implement.
28346
28347
28348 For straightforward cases, you do not need to set any of the authenticator's
28349 private options. All you need to do is to specify an appropriate mechanism as
28350 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28351 PLAIN, you could have two authenticators as follows:
28352 .code
28353 sasl_cram_md5:
28354   driver = cyrus_sasl
28355   public_name = CRAM-MD5
28356   server_set_id = $auth1
28357
28358 sasl_plain:
28359   driver = cyrus_sasl
28360   public_name = PLAIN
28361   server_set_id = $auth2
28362 .endd
28363 Cyrus SASL does implement the LOGIN authentication method, even though it is
28364 not a standard method. It is disabled by default in the source distribution,
28365 but it is present in many binary distributions.
28366 .ecindex IIDcyrauth1
28367 .ecindex IIDcyrauth2
28368
28369
28370
28371
28372 . ////////////////////////////////////////////////////////////////////////////
28373 . ////////////////////////////////////////////////////////////////////////////
28374 .chapter "The dovecot authenticator" "CHAPdovecot"
28375 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28376 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28377 This authenticator is an interface to the authentication facility of the
28378 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28379 Note that Dovecot must be configured to use auth-client not auth-userdb.
28380 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28381 to use the same mechanisms for SMTP authentication. This is a server
28382 authenticator only. There is only one non-generic option:
28383
28384 .option server_socket dovecot string unset
28385
28386 This option must specify the UNIX socket that is the interface to Dovecot
28387 authentication. The &%public_name%& option must specify an authentication
28388 mechanism that Dovecot is configured to support. You can have several
28389 authenticators for different mechanisms. For example:
28390 .code
28391 dovecot_plain:
28392   driver = dovecot
28393   public_name = PLAIN
28394   server_advertise_condition = ${if def:tls_in_cipher}
28395   server_socket = /var/run/dovecot/auth-client
28396   server_set_id = $auth1
28397
28398 dovecot_ntlm:
28399   driver = dovecot
28400   public_name = NTLM
28401   server_socket = /var/run/dovecot/auth-client
28402   server_set_id = $auth1
28403 .endd
28404
28405 &*Note*&: plaintext authentication methods such as PLAIN and LOGIN
28406 should not be advertised on cleartext SMTP connections.
28407 See the discussion in section &<<SECTplain_TLS>>&.
28408
28409 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28410 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28411 option is passed in the Dovecot authentication command. If, for a TLS
28412 connection, a client certificate has been verified, the &"valid-client-cert"&
28413 option is passed. When authentication succeeds, the identity of the user
28414 who authenticated is placed in &$auth1$&.
28415
28416 The Dovecot configuration to match the above will look
28417 something like:
28418 .code
28419 conf.d/10-master.conf :-
28420
28421 service auth {
28422 ...
28423 #SASL
28424   unix_listener auth-client {
28425     mode = 0660
28426     user = mail
28427   }
28428 ...
28429 }
28430
28431 conf.d/10-auth.conf :-
28432
28433 auth_mechanisms = plain login ntlm
28434 .endd
28435
28436 .ecindex IIDdcotauth1
28437 .ecindex IIDdcotauth2
28438
28439
28440 . ////////////////////////////////////////////////////////////////////////////
28441 . ////////////////////////////////////////////////////////////////////////////
28442 .chapter "The gsasl authenticator" "CHAPgsasl"
28443 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28444 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28445 .cindex "authentication" "GNU SASL"
28446 .cindex "authentication" "SASL"
28447 .cindex "authentication" "EXTERNAL"
28448 .cindex "authentication" "ANONYMOUS"
28449 .cindex "authentication" "PLAIN"
28450 .cindex "authentication" "LOGIN"
28451 .cindex "authentication" "DIGEST-MD5"
28452 .cindex "authentication" "CRAM-MD5"
28453 .cindex "authentication" "SCRAM family"
28454 The &(gsasl)& authenticator provides integration for the GNU SASL
28455 library and the mechanisms it provides.  This is new as of the 4.80 release
28456 and there are a few areas where the library does not let Exim smoothly
28457 scale to handle future authentication mechanisms, so no guarantee can be
28458 made that any particular new authentication mechanism will be supported
28459 without code changes in Exim.
28460
28461 The library is expected to add support in an upcoming
28462 realease for the SCRAM-SHA-256 method.
28463 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28464 when this happens.
28465
28466 To see the list of mechanisms supported by the library run Exim with "auth" debug
28467 enabled and look for a line containing "GNU SASL supports".
28468 Note however that some may not have been tested from Exim.
28469
28470
28471 .option client_authz gsasl string&!! unset
28472 This option can be used to supply an &'authorization id'&
28473 which is different to the &'authentication_id'& provided
28474 by &%client_username%& option.
28475 If unset or (after expansion) empty it is not used,
28476 which is the common case.
28477
28478 .option client_channelbinding gsasl boolean false
28479 See &%server_channelbinding%& below.
28480
28481 .option client_password gsasl string&!! unset
28482 This option is exapanded before use, and should result in
28483 the password to be used, in clear.
28484
28485 .option client_username gsasl string&!! unset
28486 This option is exapanded before use, and should result in
28487 the account name to be used.
28488
28489
28490 .option client_spassword gsasl string&!! unset
28491 This option is only supported for library versions 1.9.1 and greater.
28492 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28493
28494 If a SCRAM mechanism is being used and this option is set
28495 and correctly sized
28496 it is used in preference to &%client_password%&.
28497 The value after expansion should be
28498 a 40 (for SHA-1) or 64 (for SHA-256) character string
28499 with the PBKDF2-prepared password, hex-encoded.
28500
28501 Note that this value will depend on the salt and iteration-count
28502 supplied by the server.
28503 The option is expanded before use.
28504 During the expansion &$auth1$& is set with the client username,
28505 &$auth2$& with the iteration count, and
28506 &$auth3$& with the salt.
28507
28508 The intent of this option
28509 is to support clients that can cache thes salted password
28510 to save on recalculation costs.
28511 The cache lookup should return an unusable value
28512 (eg. an empty string)
28513 if the salt or iteration count has changed
28514
28515 If the authentication succeeds then the above variables are set,
28516 .vindex "&$auth4$&"
28517 plus the calculated salted password value value in &$auth4$&,
28518 during the expansion of the &%client_set_id%& option.
28519 A side-effect of this expansion can be used to prime the cache.
28520
28521
28522 .option server_channelbinding gsasl boolean false
28523 Some authentication mechanisms are able to use external context at both ends
28524 of the session to bind the authentication to that context, and fail the
28525 authentication process if that context differs.  Specifically, some TLS
28526 ciphersuites can provide identifying information about the cryptographic
28527 context.
28528
28529 This should have meant that certificate identity and verification becomes a
28530 non-issue, as a man-in-the-middle attack will cause the correct client and
28531 server to see different identifiers and authentication will fail.
28532
28533 This is
28534 only usable by mechanisms which support "channel binding"; at time of
28535 writing, that's the SCRAM family.
28536 When using this feature the "-PLUS" variants of the method names need to be used.
28537
28538 This defaults off to ensure smooth upgrade across Exim releases, in case
28539 this option causes some clients to start failing.  Some future release
28540 of Exim might have switched the default to be true.
28541
28542 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28543 . Do not plan to rely upon this feature for security, ever, without consulting
28544 . with a subject matter expert (a cryptographic engineer).
28545
28546 This option was deprecated in previous releases due to doubts over
28547 the "Triple Handshake" vulnerability.
28548 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28549 Session Resumption was used) for safety.
28550
28551
28552 .option server_hostname gsasl string&!! "see below"
28553 This option selects the hostname that is used when communicating with the
28554 library. The default value is &`$primary_hostname`&.
28555 Some mechanisms will use this data.
28556
28557
28558 .option server_mech gsasl string "see below"
28559 This option selects the authentication mechanism this driver should use. The
28560 default is the value of the generic &%public_name%& option. This option allows
28561 you to use a different underlying mechanism from the advertised name. For
28562 example:
28563 .code
28564 sasl:
28565   driver = gsasl
28566   public_name = X-ANYTHING
28567   server_mech = CRAM-MD5
28568   server_set_id = $auth1
28569 .endd
28570
28571
28572 .option server_password gsasl string&!! unset
28573 Various mechanisms need access to the cleartext password on the server, so
28574 that proof-of-possession can be demonstrated on the wire, without sending
28575 the password itself.
28576
28577 The data available for lookup varies per mechanism.
28578 In all cases, &$auth1$& is set to the &'authentication id'&.
28579 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28580 if available, else the empty string.
28581 The &$auth3$& variable will always be the &'realm'& if available,
28582 else the empty string.
28583
28584 A forced failure will cause authentication to defer.
28585
28586 If using this option, it may make sense to set the &%server_condition%&
28587 option to be simply "true".
28588
28589
28590 .option server_realm gsasl string&!! unset
28591 This specifies the SASL realm that the server claims to be in.
28592 Some mechanisms will use this data.
28593
28594
28595 .option server_scram_iter gsasl string&!! 4096
28596 This option provides data for the SCRAM family of mechanisms.
28597 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28598 when this option is expanded.
28599
28600 The result of expansion should be a decimal number,
28601 and represents both a lower-bound on the security, and
28602 a compute cost factor imposed on the client
28603 (if it does not cache results, or the server changes
28604 either the iteration count or the salt).
28605 A minimum value of 4096 is required by the standards
28606 for all current SCRAM mechanism variants.
28607
28608 .option server_scram_salt gsasl string&!! unset
28609 This option provides data for the SCRAM family of mechanisms.
28610 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28611 when this option is expanded.
28612 The value should be a base64-encoded string,
28613 of random data typically 4-to-16 bytes long.
28614 If unset or empty after expansion the library will provides a value for the
28615 protocol conversation.
28616
28617
28618 .option server_key gsasl string&!! unset
28619 .option server_skey gsasl string&!! unset
28620 These options can be used for the SCRAM family of mechanisms
28621 to provide stored information related to a password,
28622 the storage of which is preferable to plaintext.
28623
28624 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28625 &%server_skey%& is StoredKey.
28626
28627 They are only available for version 1.9.0 (or later) of the gsasl library.
28628 When this is so, the macros
28629 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28630 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28631 will be defined.
28632
28633 The &$authN$& variables are available when these options are expanded.
28634
28635 If set, the results of expansion should for each
28636 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28637 of base64-coded data, and will be used in preference to the
28638 &%server_password%& option.
28639 If unset or not of the right length, &%server_password%& will be used.
28640
28641 The libgsasl library release includes a utility &'gsasl'& which can be used
28642 to generate these values.
28643
28644
28645 .option server_service gsasl string &`smtp`&
28646 This is the SASL service that the server claims to implement.
28647 Some mechanisms will use this data.
28648
28649
28650 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28651 .vindex "&$auth1$&, &$auth2$&, etc"
28652 These may be set when evaluating specific options, as detailed above.
28653 They will also be set when evaluating &%server_condition%&.
28654
28655 Unless otherwise stated below, the &(gsasl)& integration will use the following
28656 meanings for these variables:
28657
28658 .ilist
28659 .vindex "&$auth1$&"
28660 &$auth1$&: the &'authentication id'&
28661 .next
28662 .vindex "&$auth2$&"
28663 &$auth2$&: the &'authorization id'&
28664 .next
28665 .vindex "&$auth3$&"
28666 &$auth3$&: the &'realm'&
28667 .endlist
28668
28669 On a per-mechanism basis:
28670
28671 .ilist
28672 .cindex "authentication" "EXTERNAL"
28673 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28674 the &%server_condition%& option must be present.
28675 .next
28676 .cindex "authentication" "ANONYMOUS"
28677 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28678 the &%server_condition%& option must be present.
28679 .next
28680 .cindex "authentication" "GSSAPI"
28681 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28682 &$auth2$& will be set to the &'authorization id'&,
28683 the &%server_condition%& option must be present.
28684 .endlist
28685
28686 An &'anonymous token'& is something passed along as an unauthenticated
28687 identifier; this is analogous to FTP anonymous authentication passing an
28688 email address, or software-identifier@, as the "password".
28689
28690
28691 An example showing the password having the realm specified in the callback
28692 and demonstrating a Cyrus SASL to GSASL migration approach is:
28693 .code
28694 gsasl_cyrusless_crammd5:
28695   driver = gsasl
28696   public_name = CRAM-MD5
28697   server_realm = imap.example.org
28698   server_password = ${lookup{$auth1:$auth3:userPassword}\
28699                     dbmjz{/etc/sasldb2}{$value}fail}
28700   server_set_id = ${quote:$auth1}
28701   server_condition = yes
28702 .endd
28703
28704
28705 . ////////////////////////////////////////////////////////////////////////////
28706 . ////////////////////////////////////////////////////////////////////////////
28707
28708 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28709 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28710 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28711 .cindex "authentication" "GSSAPI"
28712 .cindex "authentication" "Kerberos"
28713 The &(heimdal_gssapi)& authenticator provides server integration for the
28714 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28715 reliably.
28716
28717 .option server_hostname heimdal_gssapi string&!! "see below"
28718 This option selects the hostname that is used, with &%server_service%&,
28719 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28720 identifier.  The default value is &`$primary_hostname`&.
28721
28722 .option server_keytab heimdal_gssapi string&!! unset
28723 If set, then Heimdal will not use the system default keytab (typically
28724 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28725 The value should be a pathname, with no &"file:"& prefix.
28726
28727 .option server_service heimdal_gssapi string&!! "smtp"
28728 This option specifies the service identifier used, in conjunction with
28729 &%server_hostname%&, for building the identifier for finding credentials
28730 from the keytab.
28731
28732
28733 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28734 Beware that these variables will typically include a realm, thus will appear
28735 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28736 not verified, so a malicious client can set it to anything.
28737
28738 The &$auth1$& field should be safely trustable as a value from the Key
28739 Distribution Center.  Note that these are not quite email addresses.
28740 Each identifier is for a role, and so the left-hand-side may include a
28741 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28742
28743 .vindex "&$auth1$&, &$auth2$&, etc"
28744 .ilist
28745 .vindex "&$auth1$&"
28746 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28747 .next
28748 .vindex "&$auth2$&"
28749 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28750 authentication.  If that was empty, this will also be set to the
28751 GSS Display Name.
28752 .endlist
28753
28754
28755 . ////////////////////////////////////////////////////////////////////////////
28756 . ////////////////////////////////////////////////////////////////////////////
28757
28758 .chapter "The spa authenticator" "CHAPspa"
28759 .scindex IIDspaauth1 "&(spa)& authenticator"
28760 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28761 .cindex "authentication" "Microsoft Secure Password"
28762 .cindex "authentication" "NTLM"
28763 .cindex "Microsoft Secure Password Authentication"
28764 .cindex "NTLM authentication"
28765 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28766 Password Authentication'& mechanism,
28767 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28768 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28769 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28770 server side was subsequently contributed by Tom Kistner. The mechanism works as
28771 follows:
28772
28773 .ilist
28774 After the AUTH command has been accepted, the client sends an SPA
28775 authentication request based on the user name and optional domain.
28776 .next
28777 The server sends back a challenge.
28778 .next
28779 The client builds a challenge response which makes use of the user's password
28780 and sends it to the server, which then accepts or rejects it.
28781 .endlist
28782
28783 Encryption is used to protect the password in transit.
28784
28785
28786
28787 .section "Using spa as a server" "SECID179"
28788 .cindex "options" "&(spa)& authenticator (server)"
28789 The &(spa)& authenticator has just one server option:
28790
28791 .option server_password spa string&!! unset
28792 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28793 This option is expanded, and the result must be the cleartext password for the
28794 authenticating user, whose name is at this point in &$auth1$&. For
28795 compatibility with previous releases of Exim, the user name is also placed in
28796 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28797 it can lead to confusion in string expansions that also use numeric variables
28798 for other things. For example:
28799 .code
28800 spa:
28801   driver = spa
28802   public_name = NTLM
28803   server_password = \
28804     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28805 .endd
28806 If the expansion is forced to fail, authentication fails. Any other expansion
28807 failure causes a temporary error code to be returned.
28808
28809
28810
28811
28812
28813 .section "Using spa as a client" "SECID180"
28814 .cindex "options" "&(spa)& authenticator (client)"
28815 The &(spa)& authenticator has the following client options:
28816
28817
28818
28819 .option client_domain spa string&!! unset
28820 This option specifies an optional domain for the authentication.
28821
28822
28823 .option client_password spa string&!! unset
28824 This option specifies the user's password, and must be set.
28825
28826
28827 .option client_username spa string&!! unset
28828 This option specifies the user name, and must be set. Here is an example of a
28829 configuration of this authenticator for use with the mail servers at
28830 &'msn.com'&:
28831 .code
28832 msn:
28833   driver = spa
28834   public_name = MSN
28835   client_username = msn/msn_username
28836   client_password = msn_plaintext_password
28837   client_domain = DOMAIN_OR_UNSET
28838 .endd
28839 .ecindex IIDspaauth1
28840 .ecindex IIDspaauth2
28841
28842
28843
28844
28845
28846 . ////////////////////////////////////////////////////////////////////////////
28847 . ////////////////////////////////////////////////////////////////////////////
28848
28849 .chapter "The external authenticator" "CHAPexternauth"
28850 .scindex IIDexternauth1 "&(external)& authenticator"
28851 .scindex IIDexternauth2 "authenticators" "&(external)&"
28852 .cindex "authentication" "Client Certificate"
28853 .cindex "authentication" "X509"
28854 .cindex "Certificate-based authentication"
28855 The &(external)& authenticator provides support for
28856 authentication based on non-SMTP information.
28857 The specification is in RFC 4422 Appendix A
28858 (&url(https://tools.ietf.org/html/rfc4422)).
28859 It is only a transport and negotiation mechanism;
28860 the process of authentication is entirely controlled
28861 by the server configuration.
28862
28863 The client presents an identity in-clear.
28864 It is probably wise for a server to only advertise,
28865 and for clients to only attempt,
28866 this authentication method on a secure (eg. under TLS) connection.
28867
28868 One possible use, compatible with the
28869 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28870 is for using X509 client certificates.
28871
28872 It thus overlaps in function with the TLS authenticator
28873 (see &<<CHAPtlsauth>>&)
28874 but is a full SMTP SASL authenticator
28875 rather than being implicit for TLS-connection carried
28876 client certificates only.
28877
28878 The examples and discussion in this chapter assume that
28879 client-certificate authentication is being done.
28880
28881 The client must present a certificate,
28882 for which it must have been requested via the
28883 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28884 (see &<<CHAPTLS>>&).
28885 For authentication to be effective the certificate should be
28886 verifiable against a trust-anchor certificate known to the server.
28887
28888 .section "External options" "SECTexternsoptions"
28889 .cindex "options" "&(external)& authenticator (server)"
28890 The &(external)& authenticator has two server options:
28891
28892 .option server_param2 external string&!! unset
28893 .option server_param3 external string&!! unset
28894 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28895 These options are expanded before the &%server_condition%& option
28896 and the result are placed in &$auth2$& and &$auth3$& resectively.
28897 If the expansion is forced to fail, authentication fails. Any other expansion
28898 failure causes a temporary error code to be returned.
28899
28900 They can be used to clarify the coding of a complex &%server_condition%&.
28901
28902 .section "Using external in a server" "SECTexternserver"
28903 .cindex "AUTH" "in &(external)& authenticator"
28904 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28905         "in &(external)& authenticator"
28906 .vindex "&$auth1$&, &$auth2$&, etc"
28907 .cindex "base64 encoding" "in &(external)& authenticator"
28908
28909 When running as a server, &(external)& performs the authentication test by
28910 expanding a string. The data sent by the client with the AUTH command, or in
28911 response to subsequent prompts, is base64 encoded, and so may contain any byte
28912 values when decoded. The decoded value is treated as
28913 an identity for authentication and
28914 placed in the expansion variable &$auth1$&.
28915
28916 For compatibility with previous releases of Exim, the value is also placed in
28917 the expansion variable &$1$&. However, the use of this
28918 variable for this purpose is now deprecated, as it can lead to confusion in
28919 string expansions that also use them for other things.
28920
28921 .vindex "&$authenticated_id$&"
28922 Once an identity has been received,
28923 &%server_condition%& is expanded. If the expansion is forced to fail,
28924 authentication fails. Any other expansion failure causes a temporary error code
28925 to be returned. If the result of a successful expansion is an empty string,
28926 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28927 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28928 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28929 For any other result, a temporary error code is returned, with the expanded
28930 string as the error text.
28931
28932 Example:
28933 .code
28934 ext_ccert_san_mail:
28935   driver =            external
28936   public_name =       EXTERNAL
28937
28938   server_advertise_condition = $tls_in_certificate_verified
28939   server_param2 =     ${certextract {subj_altname,mail,>:} \
28940                                     {$tls_in_peercert}}
28941   server_condition =  ${if forany {$auth2} \
28942                             {eq {$item}{$auth1}}}
28943   server_set_id =     $auth1
28944 .endd
28945 This accepts a client certificate that is verifiable against any
28946 of your configured trust-anchors
28947 (which usually means the full set of public CAs)
28948 and which has a mail-SAN matching the claimed identity sent by the client.
28949
28950 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28951 The account name is therefore guessable by an opponent.
28952 TLS 1.3 protects both server and client certificates, and is not vulnerable
28953 in this way.
28954
28955
28956 .section "Using external in a client" "SECTexternclient"
28957 .cindex "options" "&(external)& authenticator (client)"
28958 The &(external)& authenticator has one client option:
28959
28960 .option client_send external string&!! unset
28961 This option is expanded and sent with the AUTH command as the
28962 identity being asserted.
28963
28964 Example:
28965 .code
28966 ext_ccert:
28967   driver =      external
28968   public_name = EXTERNAL
28969
28970   client_condition = ${if !eq{$tls_out_cipher}{}}
28971   client_send = myaccount@smarthost.example.net
28972 .endd
28973
28974
28975 .ecindex IIDexternauth1
28976 .ecindex IIDexternauth2
28977
28978
28979
28980
28981
28982 . ////////////////////////////////////////////////////////////////////////////
28983 . ////////////////////////////////////////////////////////////////////////////
28984
28985 .chapter "The tls authenticator" "CHAPtlsauth"
28986 .scindex IIDtlsauth1 "&(tls)& authenticator"
28987 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28988 .cindex "authentication" "Client Certificate"
28989 .cindex "authentication" "X509"
28990 .cindex "Certificate-based authentication"
28991 The &(tls)& authenticator provides server support for
28992 authentication based on client certificates.
28993
28994 It is not an SMTP authentication mechanism and is not
28995 advertised by the server as part of the SMTP EHLO response.
28996 It is an Exim authenticator in the sense that it affects
28997 the protocol element of the log line, can be tested for
28998 by the &%authenticated%& ACL condition, and can set
28999 the &$authenticated_id$& variable.
29000
29001 The client must present a verifiable certificate,
29002 for which it must have been requested via the
29003 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
29004 (see &<<CHAPTLS>>&).
29005
29006 If an authenticator of this type is configured it is
29007 run immediately after a TLS connection being negotiated
29008 (due to either STARTTLS or TLS-on-connect)
29009 and can authenticate the connection.
29010 If it does, SMTP authentication is not subsequently offered.
29011
29012 A maximum of one authenticator of this type may be present.
29013
29014
29015 .cindex "options" "&(tls)& authenticator (server)"
29016 The &(tls)& authenticator has three server options:
29017
29018 .option server_param1 tls string&!! unset
29019 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
29020 This option is expanded after the TLS negotiation and
29021 the result is placed in &$auth1$&.
29022 If the expansion is forced to fail, authentication fails. Any other expansion
29023 failure causes a temporary error code to be returned.
29024
29025 .option server_param2 tls string&!! unset
29026 .option server_param3 tls string&!! unset
29027 As above, for &$auth2$& and &$auth3$&.
29028
29029 &%server_param1%& may also be spelled &%server_param%&.
29030
29031
29032 Example:
29033 .code
29034 tls:
29035   driver = tls
29036   server_param1 =     ${certextract {subj_altname,mail,>:} \
29037                                     {$tls_in_peercert}}
29038   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
29039                                  {forany {$auth1} \
29040                             {!= {0} \
29041                                 {${lookup ldap{ldap:///\
29042                          mailname=${quote_ldap_dn:${lc:$item}},\
29043                          ou=users,LDAP_DC?mailid} {$value}{0} \
29044                        }    }  } }}}
29045   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
29046 .endd
29047 This accepts a client certificate that is verifiable against any
29048 of your configured trust-anchors
29049 (which usually means the full set of public CAs)
29050 and which has a SAN with a good account name.
29051
29052 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
29053 The account name is therefore guessable by an opponent.
29054 TLS 1.3 protects both server and client certificates, and is not vulnerable
29055 in this way.
29056 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
29057
29058 . An alternative might use
29059 . .code
29060 .   server_param1 = ${sha256:$tls_in_peercert}
29061 . .endd
29062 . to require one of a set of specific certs that define a given account
29063 . (the verification is still required, but mostly irrelevant).
29064 . This would help for per-device use.
29065 .
29066 . However, for the future we really need support for checking a
29067 . user cert in LDAP - which probably wants a base-64 DER.
29068
29069 .ecindex IIDtlsauth1
29070 .ecindex IIDtlsauth2
29071
29072
29073 Note that because authentication is traditionally an SMTP operation,
29074 the &%authenticated%& ACL condition cannot be used in
29075 a connect- or helo-ACL.
29076
29077
29078
29079 . ////////////////////////////////////////////////////////////////////////////
29080 . ////////////////////////////////////////////////////////////////////////////
29081
29082 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
29083          "Encrypted SMTP connections"
29084 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
29085 .scindex IIDencsmtp2 "SMTP" "encryption"
29086 .cindex "TLS" "on SMTP connection"
29087 .cindex "OpenSSL"
29088 .cindex "GnuTLS"
29089 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
29090 Sockets Layer), is implemented by making use of the OpenSSL library or the
29091 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
29092 cryptographic code in the Exim distribution itself for implementing TLS. In
29093 order to use this feature you must install OpenSSL or GnuTLS, and then build a
29094 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
29095 You also need to understand the basic concepts of encryption at a managerial
29096 level, and in particular, the way that public keys, private keys, and
29097 certificates are used.
29098
29099 RFC 3207 defines how SMTP connections can make use of encryption. Once a
29100 connection is established, the client issues a STARTTLS command. If the
29101 server accepts this, the client and the server negotiate an encryption
29102 mechanism. If the negotiation succeeds, the data that subsequently passes
29103 between them is encrypted.
29104
29105 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
29106 and if so, what cipher suite is in use, whether the client supplied a
29107 certificate, and whether or not that certificate was verified. This makes it
29108 possible for an Exim server to deny or accept certain commands based on the
29109 encryption state.
29110
29111 &*Warning*&: Certain types of firewall and certain anti-virus products can
29112 disrupt TLS connections. You need to turn off SMTP scanning for these products
29113 in order to get TLS to work.
29114
29115
29116
29117 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
29118          "SECID284"
29119 .cindex "submissions protocol"
29120 .cindex "ssmtp protocol"
29121 .cindex "smtps protocol"
29122 .cindex "SMTP" "submissions protocol"
29123 .cindex "SMTP" "ssmtp protocol"
29124 .cindex "SMTP" "smtps protocol"
29125 The history of port numbers for TLS in SMTP is a little messy and has been
29126 contentious.  As of RFC 8314, the common practice of using the historically
29127 allocated port 465 for "email submission but with TLS immediately upon connect
29128 instead of using STARTTLS" is officially blessed by the IETF, and recommended
29129 by them in preference to STARTTLS.
29130
29131 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
29132 clarity emerged over the dual roles of SMTP, for MX delivery and Email
29133 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
29134
29135 This approach was, for a while, officially abandoned when encrypted SMTP was
29136 standardized, but many clients kept using it, even as the TCP port number was
29137 reassigned for other use.
29138 Thus you may encounter guidance claiming that you shouldn't enable use of
29139 this port.
29140 In practice, a number of mail-clients have only ever supported submissions,
29141 not submission with STARTTLS upgrade.
29142 Ideally, offer both submission (587) and submissions (465) service.
29143
29144 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
29145 global option. Its value must be a list of port numbers;
29146 the most common use is expected to be:
29147 .code
29148 tls_on_connect_ports = 465
29149 .endd
29150 The port numbers specified by this option apply to all SMTP connections, both
29151 via the daemon and via &'inetd'&. You still need to specify all the ports that
29152 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
29153 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
29154 an extra port &-- rather, it specifies different behaviour on a port that is
29155 defined elsewhere.
29156
29157 There is also a &%-tls-on-connect%& command line option. This overrides
29158 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
29159
29160
29161
29162
29163
29164
29165 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
29166 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
29167 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
29168 To build Exim to use OpenSSL you need to set
29169 .code
29170 USE_OPENSSL=yes
29171 .endd
29172 in Local/Makefile.
29173
29174 To build Exim to use GnuTLS, you need to set
29175 .code
29176 USE_GNUTLS=yes
29177 .endd
29178 in Local/Makefile.
29179
29180 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
29181 include files and libraries for GnuTLS can be found.
29182
29183 There are some differences in usage when using GnuTLS instead of OpenSSL:
29184
29185 .ilist
29186 The &%tls_verify_certificates%& option
29187 cannot be the path of a directory
29188 for GnuTLS versions before 3.3.6
29189 (for later versions, or OpenSSL, it can be either).
29190 .next
29191 The default value for &%tls_dhparam%& differs for historical reasons.
29192 .next
29193 .vindex "&$tls_in_peerdn$&"
29194 .vindex "&$tls_out_peerdn$&"
29195 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29196 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29197 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29198 .next
29199 OpenSSL identifies cipher suites using hyphens as separators, for example:
29200 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29201 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29202 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29203 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29204 to handle its own older variants) when processing lists of cipher suites in the
29205 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29206 option).
29207 .next
29208 The &%tls_require_ciphers%& options operate differently, as described in the
29209 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29210 .next
29211 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29212 When using OpenSSL, this option is ignored.
29213 (If an API is found to let OpenSSL be configured in this way,
29214 let the Exim Maintainers know and we'll likely use it).
29215 .next
29216 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option,
29217 it must be ordered to match the &%tls_certificate%& list.
29218 .next
29219 Some other recently added features may only be available in one or the other.
29220 This should be documented with the feature.  If the documentation does not
29221 explicitly state that the feature is infeasible in the other TLS
29222 implementation, then patches are welcome.
29223 .next
29224 The output from "exim -bV" will show which (if any) support was included
29225 in the build.
29226 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29227 .endlist
29228
29229
29230 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29231 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29232 an explicit path; if the latter, then the text about generation still applies,
29233 but not the chosen filename.
29234 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29235 See the documentation of &%tls_dhparam%& for more information.
29236
29237 GnuTLS uses D-H parameters that may take a substantial amount of time
29238 to compute. It is unreasonable to re-compute them for every TLS session.
29239 Therefore, Exim keeps this data in a file in its spool directory, called
29240 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29241 of bits requested.
29242 The file is owned by the Exim user and is readable only by
29243 its owner. Every Exim process that start up GnuTLS reads the D-H
29244 parameters from this file. If the file does not exist, the first Exim process
29245 that needs it computes the data and writes it to a temporary file which is
29246 renamed once it is complete. It does not matter if several Exim processes do
29247 this simultaneously (apart from wasting a few resources). Once a file is in
29248 place, new Exim processes immediately start using it.
29249
29250 For maximum security, the parameters that are stored in this file should be
29251 recalculated periodically, the frequency depending on your paranoia level.
29252 If you are avoiding using the fixed D-H primes published in RFCs, then you
29253 are concerned about some advanced attacks and will wish to do this; if you do
29254 not regenerate then you might as well stick to the standard primes.
29255
29256 Arranging this is easy in principle; just delete the file when you want new
29257 values to be computed. However, there may be a problem. The calculation of new
29258 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29259 If the system is not very active, &_/dev/random_& may delay returning data
29260 until enough randomness (entropy) is available. This may cause Exim to hang for
29261 a substantial amount of time, causing timeouts on incoming connections.
29262
29263 The solution is to generate the parameters externally to Exim. They are stored
29264 in &_gnutls-params-N_& in PEM format, which means that they can be
29265 generated externally using the &(certtool)& command that is part of GnuTLS.
29266
29267 To replace the parameters with new ones, instead of deleting the file
29268 and letting Exim re-create it, you can generate new parameters using
29269 &(certtool)& and, when this has been done, replace Exim's cache file by
29270 renaming. The relevant commands are something like this:
29271 .code
29272 # ls
29273 [ look for file; assume gnutls-params-2236 is the most recent ]
29274 # rm -f new-params
29275 # touch new-params
29276 # chown exim:exim new-params
29277 # chmod 0600 new-params
29278 # certtool --generate-dh-params --bits 2236 >>new-params
29279 # openssl dhparam -noout -text -in new-params | head
29280 [ check the first line, make sure it's not more than 2236;
29281   if it is, then go back to the start ("rm") and repeat
29282   until the size generated is at most the size requested ]
29283 # chmod 0400 new-params
29284 # mv new-params gnutls-params-2236
29285 .endd
29286 If Exim never has to generate the parameters itself, the possibility of
29287 stalling is removed.
29288
29289 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29290 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29291 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29292 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29293 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29294 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29295 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29296 which applies to all D-H usage, client or server.  If the value returned by
29297 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29298 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29299 limit, which is still much higher than Exim historically used.
29300
29301 The filename and bits used will change as the GnuTLS maintainers change the
29302 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29303 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29304 2432 bits, while NSS is limited to 2236 bits.
29305
29306 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29307 increase the chance of the generated prime actually being within acceptable
29308 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29309 procedure above.  There is no sane procedure available to Exim to double-check
29310 the size of the generated prime, so it might still be too large.
29311
29312
29313 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29314 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29315 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29316 There is a function in the OpenSSL library that can be passed a list of cipher
29317 suites before the cipher negotiation takes place. This specifies which ciphers
29318 are acceptable for TLS versions prior to 1.3.
29319 The list is colon separated and may contain names like
29320 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29321 directly to this function call.
29322 Many systems will install the OpenSSL manual-pages, so you may have
29323 &'ciphers(1)'& available to you.
29324 The following quotation from the OpenSSL
29325 documentation specifies what forms of item are allowed in the cipher string:
29326
29327 .ilist
29328 It can consist of a single cipher suite such as RC4-SHA.
29329 .next
29330 It can represent a list of cipher suites containing a certain algorithm,
29331 or cipher suites of a certain type. For example SHA1 represents all
29332 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29333 SSL v3 algorithms.
29334 .next
29335 Lists of cipher suites can be combined in a single cipher string using
29336 the + character. This is used as a logical and operation. For example
29337 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29338 algorithms.
29339 .endlist
29340
29341 Each cipher string can be optionally preceded by one of the characters &`!`&,
29342 &`-`& or &`+`&.
29343 .ilist
29344 If &`!`& is used, the ciphers are permanently deleted from the list. The
29345 ciphers deleted can never reappear in the list even if they are explicitly
29346 stated.
29347 .next
29348 If &`-`& is used, the ciphers are deleted from the list, but some or all
29349 of the ciphers can be added again by later options.
29350 .next
29351 If &`+`& is used, the ciphers are moved to the end of the list. This
29352 option does not add any new ciphers; it just moves matching existing ones.
29353 .endlist
29354
29355 If none of these characters is present, the string is interpreted as
29356 a list of ciphers to be appended to the current preference list. If the list
29357 includes any ciphers already present they will be ignored: that is, they will
29358 not be moved to the end of the list.
29359 .endlist
29360
29361 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29362 string:
29363 .code
29364 # note single-quotes to get ! past any shell history expansion
29365 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29366 .endd
29367
29368 This example will let the library defaults be permitted on the MX port, where
29369 there's probably no identity verification anyway, but ups the ante on the
29370 submission ports where the administrator might have some influence on the
29371 choice of clients used:
29372 .code
29373 # OpenSSL variant; see man ciphers(1)
29374 tls_require_ciphers = ${if =={$received_port}{25}\
29375                            {DEFAULT}\
29376                            {HIGH:!MD5:!SHA1}}
29377 .endd
29378
29379 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29380 .code
29381 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29382 .endd
29383
29384 For TLS version 1.3 the control available is less fine-grained
29385 and Exim does not provide access to it at present.
29386 The value of the &%tls_require_ciphers%& option is ignored when
29387 TLS version 1.3 is negotiated.
29388
29389 As of writing the library default cipher suite list for TLSv1.3 is
29390 .code
29391 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29392 .endd
29393
29394
29395 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29396          "SECTreqciphgnu"
29397 .cindex "GnuTLS" "specifying parameters for"
29398 .cindex "TLS" "specifying ciphers (GnuTLS)"
29399 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29400 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29401 .cindex "TLS" "specifying protocols (GnuTLS)"
29402 .cindex "TLS" "specifying priority string (GnuTLS)"
29403 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29404 The GnuTLS library allows the caller to provide a "priority string", documented
29405 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29406 ciphersuite specification in OpenSSL.
29407
29408 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29409 and controls both protocols and ciphers.
29410
29411 The &%tls_require_ciphers%& option is available both as an global option,
29412 controlling how Exim behaves as a server, and also as an option of the
29413 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29414 the value is string expanded.  The resulting string is not an Exim list and
29415 the string is given to the GnuTLS library, so that Exim does not need to be
29416 aware of future feature enhancements of GnuTLS.
29417
29418 Documentation of the strings accepted may be found in the GnuTLS manual, under
29419 "Priority strings".  This is online as
29420 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29421 but beware that this relates to GnuTLS 3, which may be newer than the version
29422 installed on your system.  If you are using GnuTLS 3,
29423 then the example code
29424 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29425 on that site can be used to test a given string.
29426
29427 For example:
29428 .code
29429 # Disable older versions of protocols
29430 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29431 .endd
29432
29433 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29434 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29435 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29436
29437 This example will let the library defaults be permitted on the MX port, where
29438 there's probably no identity verification anyway, and lowers security further
29439 by increasing compatibility; but this ups the ante on the submission ports
29440 where the administrator might have some influence on the choice of clients
29441 used:
29442 .code
29443 # GnuTLS variant
29444 tls_require_ciphers = ${if =={$received_port}{25}\
29445                            {NORMAL:%COMPAT}\
29446                            {SECURE128}}
29447 .endd
29448
29449
29450 .section "Configuring an Exim server to use TLS" "SECID182"
29451 .cindex "TLS" "configuring an Exim server"
29452 .cindex "ESMTP extensions" STARTTLS
29453 When Exim has been built with TLS support, it advertises the availability of
29454 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29455 but not to any others. The default value of this option is *, which means
29456 that STARTTLS is always advertised.  Set it to blank to never advertise;
29457 this is reasonable for systems that want to use TLS only as a client.
29458
29459 If STARTTLS is to be used you
29460 need to set some other options in order to make TLS available.
29461
29462 If a client issues a STARTTLS command and there is some configuration
29463 problem in the server, the command is rejected with a 454 error. If the client
29464 persists in trying to issue SMTP commands, all except QUIT are rejected
29465 with the error
29466 .code
29467 554 Security failure
29468 .endd
29469 If a STARTTLS command is issued within an existing TLS session, it is
29470 rejected with a 554 error code.
29471
29472 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29473 must be set to match some hosts. The default is * which matches all hosts.
29474
29475 If this is all you do, TLS encryption will be enabled but not authentication -
29476 meaning that the peer has no assurance it is actually you he is talking to.
29477 You gain protection from a passive sniffer listening on the wire but not
29478 from someone able to intercept the communication.
29479
29480 Further protection requires some further configuration at the server end.
29481
29482 To make TLS work you need to set, in the server,
29483 .code
29484 tls_certificate = /some/file/name
29485 tls_privatekey = /some/file/name
29486 .endd
29487 These options are, in fact, expanded strings, so you can make them depend on
29488 the identity of the client that is connected if you wish. The first file
29489 contains the server's X509 certificate, and the second contains the private key
29490 that goes with it. These files need to be
29491 PEM format and readable by the Exim user, and must
29492 always be given as full path names.
29493 The key must not be password-protected.
29494 They can be the same file if both the
29495 certificate and the key are contained within it. If &%tls_privatekey%& is not
29496 set, or if its expansion is forced to fail or results in an empty string, this
29497 is assumed to be the case. The certificate file may also contain intermediate
29498 certificates that need to be sent to the client to enable it to authenticate
29499 the server's certificate.
29500
29501 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29502 colon-separated lists of file paths.  Ciphers using given authentication
29503 algorithms require the presence of a suitable certificate to supply the
29504 public-key.  The server selects among the certificates to present to the
29505 client depending on the selected cipher, hence the priority ordering for
29506 ciphers will affect which certificate is used.
29507
29508 If you do not understand about certificates and keys, please try to find a
29509 source of this background information, which is not Exim-specific. (There are a
29510 few comments below in section &<<SECTcerandall>>&.)
29511
29512 &*Note*&: These options do not apply when Exim is operating as a client &--
29513 they apply only in the case of a server. If you need to use a certificate in an
29514 Exim client, you must set the options of the same names in an &(smtp)&
29515 transport.
29516
29517 With just these options, an Exim server will be able to use TLS. It does not
29518 require the client to have a certificate (but see below for how to insist on
29519 this). There is one other option that may be needed in other situations. If
29520 .code
29521 tls_dhparam = /some/file/name
29522 .endd
29523 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29524 with the parameters contained in the file.
29525 Set this to &`none`& to disable use of DH entirely, by making no prime
29526 available:
29527 .code
29528 tls_dhparam = none
29529 .endd
29530 This may also be set to a string identifying a standard prime to be used for
29531 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29532 used is &`ike23`&.  There are a few standard primes available, see the
29533 documentation for &%tls_dhparam%& for the complete list.
29534
29535 See the command
29536 .code
29537 openssl dhparam
29538 .endd
29539 for a way of generating file data.
29540
29541 The strings supplied for these three options are expanded every time a client
29542 host connects. It is therefore possible to use different certificates and keys
29543 for different hosts, if you so wish, by making use of the client's IP address
29544 in &$sender_host_address$& to control the expansion. If a string expansion is
29545 forced to fail, Exim behaves as if the option is not set.
29546
29547 .cindex "cipher" "logging"
29548 .cindex "log" "TLS cipher"
29549 .vindex "&$tls_in_cipher$&"
29550 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29551 an incoming TLS connection. It is included in the &'Received:'& header of an
29552 incoming message (by default &-- you can, of course, change this), and it is
29553 also included in the log line that records a message's arrival, keyed by
29554 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29555 condition can be used to test for specific cipher suites in ACLs.
29556
29557 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29558 can check the name of the cipher suite and vary their actions accordingly. The
29559 cipher suite names vary, depending on which TLS library is being used. For
29560 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29561 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29562 documentation for more details.
29563
29564 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29565 (again depending on the &%tls_cipher%& log selector).
29566
29567
29568 .subsection "Requesting and verifying client certificates"
29569 .cindex "certificate" "verification of client"
29570 .cindex "TLS" "client certificate verification"
29571 If you want an Exim server to request a certificate when negotiating a TLS
29572 session with a client, you must set either &%tls_verify_hosts%& or
29573 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29574 apply to all TLS connections. For any host that matches one of these options,
29575 Exim requests a certificate as part of the setup of the TLS session. The
29576 contents of the certificate are verified by comparing it with a list of
29577 expected trust-anchors or certificates.
29578 These may be the system default set (depending on library version),
29579 an explicit file or,
29580 depending on library version, a directory, identified by
29581 &%tls_verify_certificates%&.
29582
29583 A file can contain multiple certificates, concatenated end to end. If a
29584 directory is used
29585 (OpenSSL only),
29586 each certificate must be in a separate file, with a name (or a symbolic link)
29587 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29588 certificate. You can compute the relevant hash by running the command
29589 .code
29590 openssl x509 -hash -noout -in /cert/file
29591 .endd
29592 where &_/cert/file_& contains a single certificate.
29593
29594 There is no checking of names of the client against the certificate
29595 Subject Name or Subject Alternate Names.
29596
29597 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29598 what happens if the client does not supply a certificate, or if the certificate
29599 does not match any of the certificates in the collection named by
29600 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29601 attempt to set up a TLS session is aborted, and the incoming connection is
29602 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29603 session continues. ACLs that run for subsequent SMTP commands can detect the
29604 fact that no certificate was verified, and vary their actions accordingly. For
29605 example, you can insist on a certificate before accepting a message for
29606 relaying, but not when the message is destined for local delivery.
29607
29608 .vindex "&$tls_in_peerdn$&"
29609 When a client supplies a certificate (whether it verifies or not), the value of
29610 the Distinguished Name of the certificate is made available in the variable
29611 &$tls_in_peerdn$& during subsequent processing of the message.
29612
29613 .cindex "log" "distinguished name"
29614 Because it is often a long text string, it is not included in the log line or
29615 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29616 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29617 &%received_header_text%& to change the &'Received:'& header. When no
29618 certificate is supplied, &$tls_in_peerdn$& is empty.
29619
29620
29621 .subsection "Caching of static server configuration items" "SSECTserverTLScache"
29622 .cindex certificate caching
29623 .cindex privatekey caching
29624 .cindex crl caching
29625 .cindex ocsp caching
29626 .cindex ciphers caching
29627 .cindex "CA bundle" caching
29628 .cindex "certificate authorities" caching
29629 .cindex tls_certificate caching
29630 .cindex tls_privatekey caching
29631 .cindex tls_crl caching
29632 .cindex tls_ocsp_file caching
29633 .cindex tls_require_ciphers caching
29634 .cindex tls_verify_certificate caching
29635 .cindex caching certificate
29636 .cindex caching privatekey
29637 .cindex caching crl
29638 .cindex caching ocsp
29639 .cindex caching ciphers
29640 .cindex caching "certificate authorities
29641 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29642 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29643 expandable elements,
29644 then the associated information is loaded at daemon startup.
29645 It is made available
29646 to child processes forked for handling received SMTP connections.
29647
29648 This caching is currently only supported under Linux and FreeBSD.
29649
29650 If caching is not possible, for example if an item has to be dependent
29651 on the peer host so contains a &$sender_host_name$& expansion, the load
29652 of the associated information is done at the startup of the TLS connection.
29653
29654 The cache is invalidated and reloaded after any changes to the directories
29655 containing files specified by these options.
29656
29657 The information specified by the main option &%tls_verify_certificates%&
29658 is similarly cached so long as it specifies files explicitly
29659 or (under GnuTLS) is the string &"system,cache"&.
29660 The latter case is not automatically invalidated;
29661 it is the operator's responsibility to arrange for a daemon restart
29662 any time the system certificate authority bundle is updated.
29663 A HUP signal is sufficient for this.
29664 The value &"system"& results in no caching under GnuTLS.
29665
29666 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29667 is acceptable in configurations for the Exim executable.
29668
29669 Caching of the system Certificate Authorities bundle can
29670 save significant time and processing on every TLS connection
29671 accepted by Exim.
29672
29673
29674
29675
29676 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29677 .cindex "cipher" "logging"
29678 .cindex "log" "TLS cipher"
29679 .cindex "log" "distinguished name"
29680 .cindex "TLS" "configuring an Exim client"
29681 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29682 deliveries as well as to incoming, the latter one causing logging of the
29683 server certificate's DN. The remaining client configuration for TLS is all
29684 within the &(smtp)& transport.
29685
29686 .cindex "ESMTP extensions" STARTTLS
29687 It is not necessary to set any options to have TLS work in the &(smtp)&
29688 transport. If Exim is built with TLS support, and TLS is advertised by a
29689 server, the &(smtp)& transport always tries to start a TLS session. However,
29690 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29691 transport) to a list of server hosts for which TLS should not be used.
29692
29693 If you do not want Exim to attempt to send messages unencrypted when an attempt
29694 to set up an encrypted connection fails in any way, you can set
29695 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29696 those hosts, delivery is always deferred if an encrypted connection cannot be
29697 set up. If there are any other hosts for the address, they are tried in the
29698 usual way.
29699
29700 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29701 the message unencrypted. It always does this if the response to STARTTLS is
29702 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29703 session after a success response code, what happens is controlled by the
29704 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29705 delivery to this host is deferred, and other hosts (if available) are tried. If
29706 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29707 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29708 negotiation fails, Exim closes the current connection (because it is in an
29709 unknown state), opens a new one to the same host, and then tries the delivery
29710 unencrypted.
29711
29712 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29713 transport provide the client with a certificate, which is passed to the server
29714 if it requests it.
29715 This is an optional thing for TLS connections, although either end
29716 may insist on it.
29717 If the server is Exim, it will request a certificate only if
29718 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29719
29720 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29721 for client use (they are usable for server use).
29722 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29723 in failed connections.
29724
29725 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29726 specifies a collection of expected server certificates.
29727 These may be
29728 the system default set (depending on library version),
29729 a file,
29730 or (depending on library version) a directory.
29731 The client verifies the server's certificate
29732 against this collection, taking into account any revoked certificates that are
29733 in the list defined by &%tls_crl%&.
29734 Failure to verify fails the TLS connection unless either of the
29735 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29736
29737 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29738 certificate verification to the listed servers.  Verification either must
29739 or need not succeed respectively.
29740
29741 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29742 name checks are made on the server certificate.
29743 The match against this list is, as per other Exim usage, the
29744 IP for the host.  That is most closely associated with the
29745 name on the DNS A (or AAAA) record for the host.
29746 However, the name that needs to be in the certificate
29747 is the one at the head of any CNAME chain leading to the A record.
29748 The option defaults to always checking.
29749
29750 The &(smtp)& transport has two OCSP-related options:
29751 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29752 is requested and required for the connection to proceed.  The default
29753 value is empty.
29754 &%hosts_request_ocsp%&; a host-list for which (additionally)
29755 a Certificate Status is requested (but not necessarily verified).  The default
29756 value is "*" meaning that requests are made unless configured
29757 otherwise.
29758
29759 The host(s) should also be in &%hosts_require_tls%&, and
29760 &%tls_verify_certificates%& configured for the transport,
29761 for OCSP to be relevant.
29762
29763 If
29764 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29765 list of permitted cipher suites. If either of these checks fails, delivery to
29766 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29767 alternative hosts, if any.
29768
29769  &*Note*&:
29770 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29771 is operating as a client. Exim does not assume that a server certificate (set
29772 by the global options of the same name) should also be used when operating as a
29773 client.
29774
29775 .vindex "&$host$&"
29776 .vindex "&$host_address$&"
29777 All the TLS options in the &(smtp)& transport are expanded before use, with
29778 &$host$& and &$host_address$& containing the name and address of the server to
29779 which the client is connected. Forced failure of an expansion causes Exim to
29780 behave as if the relevant option were unset.
29781
29782 .vindex &$tls_out_bits$&
29783 .vindex &$tls_out_cipher$&
29784 .vindex &$tls_out_peerdn$&
29785 .vindex &$tls_out_sni$&
29786 Before an SMTP connection is established, the
29787 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29788 variables are emptied. (Until the first connection, they contain the values
29789 that were set when the message was received.) If STARTTLS is subsequently
29790 successfully obeyed, these variables are set to the relevant values for the
29791 outgoing connection.
29792
29793
29794
29795 .subsection "Caching of static client configuration items" SECTclientTLScache
29796 .cindex certificate caching
29797 .cindex privatekey caching
29798 .cindex crl caching
29799 .cindex ciphers caching
29800 .cindex "CA bundle" caching
29801 .cindex "certificate authorities" caching
29802 .cindex tls_certificate caching
29803 .cindex tls_privatekey caching
29804 .cindex tls_crl caching
29805 .cindex tls_require_ciphers caching
29806 .cindex tls_verify_certificate caching
29807 .cindex caching certificate
29808 .cindex caching privatekey
29809 .cindex caching crl
29810 .cindex caching ciphers
29811 .cindex caching "certificate authorities
29812 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29813 and &%tls_crl%& have values with no
29814 expandable elements,
29815 then the associated information is loaded per smtp transport
29816 at daemon startup, at the start of a queue run, or on a
29817 command-line specified message delivery.
29818 It is made available
29819 to child processes forked for handling making SMTP connections.
29820
29821 This caching is currently only supported under Linux.
29822
29823 If caching is not possible, the load
29824 of the associated information is done at the startup of the TLS connection.
29825
29826 The cache is invalidated in the daemon
29827 and reloaded after any changes to the directories
29828 containing files specified by these options.
29829
29830 The information specified by the main option &%tls_verify_certificates%&
29831 is similarly cached so long as it specifies files explicitly
29832 or (under GnuTLS) is the string &"system,cache"&.
29833 The latter case is not automatically invaludated;
29834 it is the operator's responsibility to arrange for a daemon restart
29835 any time the system certificate authority bundle is updated.
29836 A HUP signal is sufficient for this.
29837 The value &"system"& results in no caching under GnuTLS.
29838
29839 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29840 is acceptable in configurations for the Exim executable.
29841
29842 Caching of the system Certificate Authorities bundle can
29843 save significant time and processing on every TLS connection
29844 initiated by Exim.
29845
29846
29847
29848
29849 .section "Use of TLS Server Name Indication" "SECTtlssni"
29850 .cindex "TLS" "Server Name Indication"
29851 .cindex "TLS" SNI
29852 .cindex SNI
29853 .vindex "&$tls_in_sni$&"
29854 .oindex "&%tls_in_sni%&"
29855 With TLS1.0 or above, there is an extension mechanism by which extra
29856 information can be included at various points in the protocol.  One of these
29857 extensions, documented in RFC 6066 (and before that RFC 4366) is
29858 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29859 client in the initial handshake, so that the server can examine the servername
29860 within and possibly choose to use different certificates and keys (and more)
29861 for this session.
29862
29863 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29864 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29865 address.
29866
29867 With SMTP to MX, there are the same problems here as in choosing the identity
29868 against which to validate a certificate: you can't rely on insecure DNS to
29869 provide the identity which you then cryptographically verify.  So this will
29870 be of limited use in that environment.
29871
29872 With SMTP to Submission, there is a well-defined hostname which clients are
29873 connecting to and can validate certificates against.  Thus clients &*can*&
29874 choose to include this information in the TLS negotiation.  If this becomes
29875 wide-spread, then hosters can choose to present different certificates to
29876 different clients.  Or even negotiate different cipher suites.
29877
29878 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29879 if not empty, will be sent on a TLS session as part of the handshake.  There's
29880 nothing more to it.  Choosing a sensible value not derived insecurely is the
29881 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29882 for the lifetime of the client connection (including during authentication).
29883
29884 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29885 is forced to the name of the destination host, after any MX- or CNAME-following.
29886
29887 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29888 received from a client.
29889 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29890
29891 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29892 option (prior to expansion) then the following options will be re-expanded
29893 during TLS session handshake, to permit alternative values to be chosen:
29894
29895 .ilist
29896 &%tls_certificate%&
29897 .next
29898 &%tls_crl%&
29899 .next
29900 &%tls_privatekey%&
29901 .next
29902 &%tls_verify_certificates%&
29903 .next
29904 &%tls_ocsp_file%&
29905 .endlist
29906
29907 Great care should be taken to deal with matters of case, various injection
29908 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29909 can always be referenced; it is important to remember that &$tls_in_sni$& is
29910 arbitrary unverified data provided prior to authentication.
29911 Further, the initial certificate is loaded before SNI has arrived, so
29912 an expansion for &%tls_certificate%& must have a default which is used
29913 when &$tls_in_sni$& is empty.
29914
29915 The Exim developers are proceeding cautiously and so far no other TLS options
29916 are re-expanded.
29917
29918 When Exim is built against OpenSSL, OpenSSL must have been built with support
29919 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29920 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29921 see &`-servername`& in the output, then OpenSSL has support.
29922
29923 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29924 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29925 built, then you have SNI support).
29926
29927 .subsection ALPN
29928 .cindex TLS ALPN
29929 .cindex ALPN "general information"
29930 .cindex TLS "Application Layer Protocol Names"
29931 There is a TLS feature related to SNI
29932 called Application Layer Protocol Name (ALPN).
29933 This is intended to declare, or select, what protocol layer will be using a TLS
29934 connection.
29935 The client for the connection proposes a set of protocol names, and
29936 the server responds with a selected one.
29937 It is not, as of 2021, commonly used for SMTP connections.
29938 However, to guard against misdirected or malicious use of web clients
29939 (which often do use ALPN) against MTA ports, Exim by default check that
29940 there is no incompatible ALPN specified by a client for a TLS connection.
29941 If there is, the connection is rejected.
29942
29943 As a client Exim does not supply ALPN by default.
29944 The behaviour of both client and server can be configured using the options
29945 &%tls_alpn%& and &%hosts_require_alpn%&.
29946 There are no variables providing observability.
29947 Some feature-specific logging may appear on denied connections, but this
29948 depends on the behaviour of the peer
29949 (not all peers can send a feature-specific TLS Alert).
29950
29951 This feature is available when Exim is built with
29952 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29953 the macro _HAVE_TLS_ALPN will be defined when this is so.
29954
29955
29956
29957 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29958          "SECTmulmessam"
29959 .cindex "multiple SMTP deliveries with TLS"
29960 .cindex "TLS" "multiple message deliveries"
29961 Exim sends multiple messages down the same TCP/IP connection by starting up
29962 an entirely new delivery process for each message, passing the socket from
29963 one process to the next. This implementation does not fit well with the use
29964 of TLS, because there is quite a lot of state information associated with a TLS
29965 connection, not just a socket identification. Passing all the state information
29966 to a new process is not feasible. Consequently, for sending using TLS Exim
29967 starts an additional proxy process for handling the encryption, piping the
29968 unencrypted data stream from and to the delivery processes.
29969
29970 An older mode of operation can be enabled on a per-host basis by the
29971 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29972 this list the proxy process described above is not used; instead Exim
29973 shuts down an existing TLS session being run by the delivery process
29974 before passing the socket to a new process. The new process may then
29975 try to start a new TLS session, and if successful, may try to re-authenticate
29976 if AUTH is in use, before sending the next message.
29977
29978 The RFC is not clear as to whether or not an SMTP session continues in clear
29979 after TLS has been shut down, or whether TLS may be restarted again later, as
29980 just described. However, if the server is Exim, this shutdown and
29981 reinitialization works. It is not known which (if any) other servers operate
29982 successfully if the client closes a TLS session and continues with unencrypted
29983 SMTP, but there are certainly some that do not work. For such servers, Exim
29984 should not pass the socket to another process, because the failure of the
29985 subsequent attempt to use it would cause Exim to record a temporary host error,
29986 and delay other deliveries to that host.
29987
29988 To test for this case, Exim sends an EHLO command to the server after
29989 closing down the TLS session. If this fails in any way, the connection is
29990 closed instead of being passed to a new delivery process, but no retry
29991 information is recorded.
29992
29993 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29994 &(smtp)& transport to match those hosts for which Exim should not pass
29995 connections to new processes if TLS has been used.
29996
29997
29998
29999
30000 .section "Certificates and all that" "SECTcerandall"
30001 .cindex "certificate" "references to discussion"
30002 In order to understand fully how TLS works, you need to know about
30003 certificates, certificate signing, and certificate authorities.
30004 This is a large topic and an introductory guide is unsuitable for the Exim
30005 reference manual, so instead we provide pointers to existing documentation.
30006
30007 The Apache web-server was for a long time the canonical guide, so their
30008 documentation is a good place to start; their SSL module's Introduction
30009 document is currently at
30010 .display
30011 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
30012 .endd
30013 and their FAQ is at
30014 .display
30015 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
30016 .endd
30017
30018 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
30019 0-201-61598-3) in 2001, contains both introductory and more in-depth
30020 descriptions.
30021 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
30022 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
30023 Ivan is the author of the popular TLS testing tools at
30024 &url(https://www.ssllabs.com/).
30025
30026
30027 .subsection "Certificate chains" SECID186
30028 A file named by &%tls_certificate%& may contain more than one
30029 certificate. This is useful in the case where the certificate that is being
30030 sent is validated by an intermediate certificate which the other end does
30031 not have. Multiple certificates must be in the correct order in the file.
30032 First the host's certificate itself, then the first intermediate
30033 certificate to validate the issuer of the host certificate, then the next
30034 intermediate certificate to validate the issuer of the first intermediate
30035 certificate, and so on, until finally (optionally) the root certificate.
30036 The root certificate must already be trusted by the recipient for
30037 validation to succeed, of course, but if it's not preinstalled, sending the
30038 root certificate along with the rest makes it available for the user to
30039 install if the receiving end is a client MUA that can interact with a user.
30040
30041 Note that certificates using MD5 are unlikely to work on today's Internet;
30042 even if your libraries allow loading them for use in Exim when acting as a
30043 server, increasingly clients will not accept such certificates.  The error
30044 diagnostics in such a case can be frustratingly vague.
30045
30046
30047
30048 .subsection "Self-signed certificates" SECID187
30049 .cindex "certificate" "self-signed"
30050 You can create a self-signed certificate using the &'req'& command provided
30051 with OpenSSL, like this:
30052 . ==== Do not shorten the duration here without reading and considering
30053 . ==== the text below.  Please leave it at 9999 days.
30054 .code
30055 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
30056             -days 9999 -nodes
30057 .endd
30058 &_file1_& and &_file2_& can be the same file; the key and the certificate are
30059 delimited and so can be identified independently. The &%-days%& option
30060 specifies a period for which the certificate is valid. The &%-nodes%& option is
30061 important: if you do not set it, the key is encrypted with a passphrase
30062 that you are prompted for, and any use that is made of the key causes more
30063 prompting for the passphrase. This is not helpful if you are going to use
30064 this certificate and key in an MTA, where prompting is not possible.
30065
30066 . ==== I expect to still be working 26 years from now.  The less technical
30067 . ==== debt I create, in terms of storing up trouble for my later years, the
30068 . ==== happier I will be then.  We really have reached the point where we
30069 . ==== should start, at the very least, provoking thought and making folks
30070 . ==== pause before proceeding, instead of leaving all the fixes until two
30071 . ==== years before 2^31 seconds after the 1970 Unix epoch.
30072 . ==== -pdp, 2012
30073 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
30074 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
30075 the above command might produce a date in the past.  Think carefully about
30076 the lifetime of the systems you're deploying, and either reduce the duration
30077 of the certificate or reconsider your platform deployment.  (At time of
30078 writing, reducing the duration is the most likely choice, but the inexorable
30079 progression of time takes us steadily towards an era where this will not
30080 be a sensible resolution).
30081
30082 A self-signed certificate made in this way is sufficient for testing, and
30083 may be adequate for all your requirements if you are mainly interested in
30084 encrypting transfers, and not in secure identification.
30085
30086 However, many clients require that the certificate presented by the server be a
30087 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
30088 certificate. In this situation, the self-signed certificate described above
30089 must be installed on the client host as a trusted root &'certification
30090 authority'& (CA), and the certificate used by Exim must be a user certificate
30091 signed with that self-signed certificate.
30092
30093 For information on creating self-signed CA certificates and using them to sign
30094 user certificates, see the &'General implementation overview'& chapter of the
30095 Open-source PKI book, available online at
30096 &url(https://sourceforge.net/projects/ospkibook/).
30097
30098
30099 .subsection "Revoked certificates"
30100 .cindex "TLS" "revoked certificates"
30101 .cindex "revocation list"
30102 .cindex "certificate" "revocation list"
30103 .cindex "OCSP" "stapling"
30104 There are three ways for a certificate to be made unusable
30105 before its expiry.
30106
30107 .ilist
30108 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
30109 certificates are revoked. If you have such a list, you can pass it to an Exim
30110 server using the global option called &%tls_crl%& and to an Exim client using
30111 an identically named option for the &(smtp)& transport. In each case, the value
30112 of the option is expanded and must then be the name of a file that contains a
30113 CRL in PEM format.
30114 The downside is that clients have to periodically re-download a potentially huge
30115 file from every certificate authority they know of.
30116
30117 .next
30118 The way with most moving parts at query time is Online Certificate
30119 Status Protocol (OCSP), where the client verifies the certificate
30120 against an OCSP server run by the CA.  This lets the CA track all
30121 usage of the certs.  It requires running software with access to the
30122 private key of the CA, to sign the responses to the OCSP queries.  OCSP
30123 is based on HTTP and can be proxied accordingly.
30124
30125 The only widespread OCSP server implementation (known to this writer)
30126 comes as part of OpenSSL and aborts on an invalid request, such as
30127 connecting to the port and then disconnecting.  This requires
30128 re-entering the passphrase each time some random client does this.
30129
30130 .next
30131 The third way is OCSP Stapling; in this, the server using a certificate
30132 issued by the CA periodically requests an OCSP proof of validity from
30133 the OCSP server, then serves it up inline as part of the TLS
30134 negotiation.   This approach adds no extra round trips, does not let the
30135 CA track users, scales well with number of certs issued by the CA and is
30136 resilient to temporary OCSP server failures, as long as the server
30137 starts retrying to fetch an OCSP proof some time before its current
30138 proof expires.  The downside is that it requires server support.
30139
30140 Unless Exim is built with the support disabled,
30141 or with GnuTLS earlier than version 3.3.16 / 3.4.8
30142 support for OCSP stapling is included.
30143
30144 There is a global option called &%tls_ocsp_file%&.
30145 The file specified therein is expected to be in DER format, and contain
30146 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
30147 option will be re-expanded for SNI, if the &%tls_certificate%& option
30148 contains &`tls_in_sni`&, as per other TLS options.
30149
30150 Exim does not at this time implement any support for fetching a new OCSP
30151 proof.  The burden is on the administrator to handle this, outside of
30152 Exim.  The file specified should be replaced atomically, so that the
30153 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
30154 on each connection, so a new file will be handled transparently on the
30155 next connection.
30156
30157 When built with OpenSSL Exim will check for a valid next update timestamp
30158 in the OCSP proof; if not present, or if the proof has expired, it will be
30159 ignored.
30160
30161 For the client to be able to verify the stapled OCSP the server must
30162 also supply, in its stapled information, any intermediate
30163 certificates for the chain leading to the OCSP proof from the signer
30164 of the server certificate.  There may be zero or one such. These
30165 intermediate certificates should be added to the server OCSP stapling
30166 file named by &%tls_ocsp_file%&.
30167
30168 Note that the proof only covers the terminal server certificate,
30169 not any of the chain from CA to it.
30170
30171 There is no current way to staple a proof for a client certificate.
30172
30173 .code
30174   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
30175   OCSP server is supplied.  The server URL may be included in the
30176   server certificate, if the CA is helpful.
30177
30178   One failure mode seen was the OCSP Signer cert expiring before the end
30179   of validity of the OCSP proof. The checking done by Exim/OpenSSL
30180   noted this as invalid overall, but the re-fetch script did not.
30181 .endd
30182 .endlist
30183
30184
30185 .ecindex IIDencsmtp1
30186 .ecindex IIDencsmtp2
30187
30188
30189 .section "TLS Resumption" "SECTresumption"
30190 .cindex TLS resumption
30191 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
30192 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
30193 (or later).
30194
30195 Session resumption (this is the "stateless" variant) involves the server sending
30196 a "session ticket" to the client on one connection, which can be stored by the
30197 client and used for a later session.  The ticket contains sufficient state for
30198 the server to reconstruct the TLS session, avoiding some expensive crypto
30199 calculation and (on TLS1.2) one full packet roundtrip time.
30200
30201 .ilist
30202 Operational cost/benefit:
30203
30204  The extra data being transmitted costs a minor amount, and the client has
30205  extra costs in storing and retrieving the data.
30206
30207  In the Exim/Gnutls implementation the extra cost on an initial connection
30208  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30209  The saved cost on a subsequent connection is about 4ms; three or more
30210  connections become a net win.  On longer network paths, two or more
30211  connections will have an average lower startup time thanks to the one
30212  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30213  packet roundtrips.
30214
30215 .cindex "hints database" tls
30216  Since a new hints DB is used on the TLS client,
30217  the hints DB maintenance should be updated to additionally handle "tls".
30218
30219 .next
30220 Security aspects:
30221
30222  The session ticket is encrypted, but is obviously an additional security
30223  vulnarability surface.  An attacker able to decrypt it would have access
30224  all connections using the resumed session.
30225  The session ticket encryption key is not committed to storage by the server
30226  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30227  overlap; GnuTLS 6hr but does not specify any overlap).
30228  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30229  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30230
30231  There is a question-mark over the security of the Diffie-Helman parameters
30232  used for session negotiation.
30233
30234 .next
30235 Observability:
30236
30237  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30238  element.
30239
30240  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30241  have bits 0-4 indicating respectively
30242  support built, client requested ticket, client offered session,
30243  server issued ticket, resume used.  A suitable decode list is provided
30244  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30245
30246 .next
30247 Control:
30248
30249 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30250 exim, operating as a server, will offer resumption to clients.
30251 Current best practice is to not offer the feature to MUA connection.
30252 Commonly this can be done like this:
30253 .code
30254 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30255 .endd
30256 If the peer host matches the list after expansion then resumption
30257 is offered and/or accepted.
30258
30259 The &%tls_resumption_hosts%& smtp transport option performs the
30260 equivalent function for operation as a client.
30261 If the peer host matches the list after expansion then resumption
30262 is attempted (if a stored session is available) or the information
30263 stored (if supplied by the peer).
30264
30265
30266 .next
30267 Issues:
30268
30269  In a resumed session:
30270 .ilist
30271   The variables &$tls_{in,out}_cipher$& will have values different
30272  to the original (under GnuTLS).
30273 .next
30274   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30275  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30276 . XXX need to do something with that hosts_require_ocsp
30277 .endlist
30278
30279 .endlist
30280
30281
30282 .section DANE "SECDANE"
30283 .cindex DANE
30284 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30285 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30286 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30287 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30288 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30289 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30290
30291 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30292 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30293 by (a) is thought to be smaller than that of the set of root CAs.
30294
30295 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30296 fail to pass on a server's STARTTLS.
30297
30298 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30299 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30300 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30301
30302 DANE requires a server operator to do three things:
30303 .olist
30304 Run DNSSEC.  This provides assurance to clients
30305 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30306 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30307 DNSSEC.
30308 .next
30309 Add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30310 .next
30311 Offer a server certificate, or certificate chain, in TLS connections which is anchored by one of the TLSA records.
30312 .endlist
30313
30314 There are no changes to Exim specific to server-side operation of DANE.
30315 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30316 in &_Local/Makefile_&.
30317 If it has been included, the macro "_HAVE_DANE" will be defined.
30318
30319 .subsection "DNS records"
30320 A TLSA record consist of 4 fields, the "Certificate Usage", the
30321 "Selector", the "Matching type", and the "Certificate Association Data".
30322 For a detailed description of the TLSA record see
30323 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30324
30325 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30326 These are the "Trust Anchor" and "End Entity" variants.
30327 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30328 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30329 this is appropriate for a single system, using a self-signed certificate.
30330 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30331 well-known one.
30332 A private CA at simplest is just a self-signed certificate (with certain
30333 attributes) which is used to sign server certificates, but running one securely
30334 does require careful arrangement.
30335 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30336 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30337 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30338 all of which point to a single TLSA record.
30339 DANE-TA and DANE-EE can both be used together.
30340
30341 Our recommendation is to use DANE with a certificate from a public CA,
30342 because this enables a variety of strategies for remote clients to verify
30343 your certificate.
30344 You can then publish information both via DANE and another technology,
30345 "MTA-STS", described below.
30346
30347 When you use DANE-TA to publish trust anchor information, you ask entities
30348 outside your administrative control to trust the Certificate Authority for
30349 connections to you.
30350 If using a private CA then you should expect others to still apply the
30351 technical criteria they'd use for a public CA to your certificates.
30352 In particular, you should probably try to follow current best practices for CA
30353 operation around hash algorithms and key sizes.
30354 Do not expect other organizations to lower their security expectations just
30355 because a particular profile might be reasonable for your own internal use.
30356
30357 When this text was last updated, this in practice means to avoid use of SHA-1
30358 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30359 than 4096, for interoperability); to use keyUsage fields correctly; to use
30360 random serial numbers.
30361 The list of requirements is subject to change as best practices evolve.
30362 If you're not already using a private CA, or it doesn't meet these
30363 requirements, then we encourage you to avoid all these issues and use a public
30364 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30365
30366 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30367 a "Matching Type" (3rd) field of SHA2-512(2).
30368
30369 For the "Certificate Authority Data" (4th) field, commands like
30370
30371 .code
30372   openssl x509 -pubkey -noout <certificate.pem \
30373   | openssl rsa -outform der -pubin 2>/dev/null \
30374   | openssl sha512 \
30375   | awk '{print $2}'
30376 .endd
30377
30378 are workable to create a hash of the certificate's public key.
30379
30380 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30381
30382 .code
30383   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30384 .endd
30385
30386 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30387 is useful for quickly generating TLSA records.
30388
30389
30390 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30391
30392 The Certificate issued by the CA published in the DANE-TA model should be
30393 issued using a strong hash algorithm.
30394 Exim, and importantly various other MTAs sending to you, will not
30395 re-enable hash algorithms which have been disabled by default in TLS
30396 libraries.
30397 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30398 interoperability (and probably the maximum too, in 2018).
30399
30400 .subsection "Interaction with OCSP"
30401 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30402 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30403 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30404
30405 .code
30406   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30407                                  {= {4}{$tls_out_tlsa_usage}} } \
30408                          {*}{}}
30409 .endd
30410
30411 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30412 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30413 found. If the definition of &%hosts_request_ocsp%& includes the
30414 string "tls_out_tlsa_usage", they are re-expanded in time to
30415 control the OCSP request.
30416
30417 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30418 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30419
30420
30421 .subsection "Client configuration"
30422 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30423 and &%dane_require_tls_ciphers%&.
30424 The &"require"& variant will result in failure if the target host is not
30425 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30426 the &%dnssec_request_domains%& router or transport option.
30427
30428 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30429
30430 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30431 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30432 will be required for the host.  If it does not, the host will not
30433 be used; there is no fallback to non-DANE or non-TLS.
30434
30435 If DANE is requested and usable, then the TLS cipher list configuration
30436 prefers to use the option &%dane_require_tls_ciphers%& and falls
30437 back to &%tls_require_ciphers%& only if that is unset.
30438 This lets you configure "decent crypto" for DANE and "better than nothing
30439 crypto" as the default.  Note though that while GnuTLS lets the string control
30440 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30441 limited to ciphersuite constraints.
30442
30443 If DANE is requested and useable (see above) the following transport options are ignored:
30444 .code
30445   hosts_require_tls
30446   tls_verify_hosts
30447   tls_try_verify_hosts
30448   tls_verify_certificates
30449   tls_crl
30450   tls_verify_cert_hostnames
30451   tls_sni
30452 .endd
30453
30454 If DANE is not usable, whether requested or not, and CA-anchored
30455 verification evaluation is wanted, the above variables should be set appropriately.
30456
30457 The router and transport option &%dnssec_request_domains%& must not be
30458 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30459
30460 .subsection Observability
30461 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30462
30463 There is a new variable &$tls_out_dane$& which will have "yes" if
30464 verification succeeded using DANE and "no" otherwise (only useful
30465 in combination with events; see &<<CHAPevents>>&),
30466 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30467
30468 .cindex DANE reporting
30469 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30470 to achieve DANE-verified connection, if one was either requested and offered, or
30471 required.  This is intended to support TLS-reporting as defined in
30472 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30473 The &$event_data$& will be one of the Result Types defined in
30474 Section 4.3 of that document.
30475
30476 .subsection General
30477 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30478
30479 DANE is specified in published RFCs and decouples certificate authority trust
30480 selection from a "race to the bottom" of "you must trust everything for mail
30481 to get through".
30482 There is an alternative technology called MTA-STS, which
30483 instead publishes MX trust anchor information on an HTTPS website.  At the
30484 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30485 Exim has no support for MTA-STS as a client, but Exim mail server operators
30486 can choose to publish information describing their TLS configuration using
30487 MTA-STS to let those clients who do use that protocol derive trust
30488 information.
30489
30490 The MTA-STS design requires a certificate from a public Certificate Authority
30491 which is recognized by clients sending to you.
30492 That selection of which CAs are trusted by others is outside your control.
30493
30494 The most interoperable course of action is probably to use
30495 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30496 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30497 records for DANE clients (such as Exim and Postfix) and to publish anchor
30498 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30499 domain itself (with caveats around occasionally broken MTA-STS because of
30500 incompatible specification changes prior to reaching RFC status).
30501
30502
30503
30504 . ////////////////////////////////////////////////////////////////////////////
30505 . ////////////////////////////////////////////////////////////////////////////
30506
30507 .chapter "Access control lists" "CHAPACL"
30508 .scindex IIDacl "&ACL;" "description"
30509 .cindex "control of incoming mail"
30510 .cindex "message" "controlling incoming"
30511 .cindex "policy control" "access control lists"
30512 Access Control Lists (ACLs) are defined in a separate section of the runtime
30513 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30514 name, terminated by a colon. Here is a complete ACL section that contains just
30515 one very small ACL:
30516 .code
30517 begin acl
30518 small_acl:
30519   accept   hosts = one.host.only
30520 .endd
30521 You can have as many lists as you like in the ACL section, and the order in
30522 which they appear does not matter. The lists are self-terminating.
30523
30524 The majority of ACLs are used to control Exim's behaviour when it receives
30525 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30526 when a local process submits a message using SMTP by specifying the &%-bs%&
30527 option. The most common use is for controlling which recipients are accepted
30528 in incoming messages. In addition, you can define an ACL that is used to check
30529 local non-SMTP messages. The default configuration file contains an example of
30530 a realistic ACL for checking RCPT commands. This is discussed in chapter
30531 &<<CHAPdefconfil>>&.
30532
30533
30534 .section "Testing ACLs" "SECID188"
30535 The &%-bh%& command line option provides a way of testing your ACL
30536 configuration locally by running a fake SMTP session with which you interact.
30537
30538
30539 .section "Specifying when ACLs are used" "SECID189"
30540 .cindex "&ACL;" "options for specifying"
30541 In order to cause an ACL to be used, you have to name it in one of the relevant
30542 options in the main part of the configuration. These options are:
30543 .cindex "AUTH" "ACL for"
30544 .cindex "DATA" "ACLs for"
30545 .cindex "ETRN" "ACL for"
30546 .cindex "EXPN" "ACL for"
30547 .cindex "HELO" "ACL for"
30548 .cindex "EHLO" "ACL for"
30549 .cindex "DKIM" "ACL for"
30550 .cindex "MAIL" "ACL for"
30551 .cindex "QUIT, ACL for"
30552 .cindex "RCPT" "ACL for"
30553 .cindex "STARTTLS, ACL for"
30554 .cindex "VRFY" "ACL for"
30555 .cindex "SMTP" "connection, ACL for"
30556 .cindex "non-SMTP messages" "ACLs for"
30557 .cindex "MIME content scanning" "ACL for"
30558 .cindex "PRDR" "ACL for"
30559
30560 .table2 140pt
30561 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30562 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30563 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30564 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30565 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30566 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30567 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30568 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30569 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30570 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30571 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30572 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30573 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30574 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30575 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30576 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30577 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30578 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30579 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30580 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30581 .endtable
30582
30583 For example, if you set
30584 .code
30585 acl_smtp_rcpt = small_acl
30586 .endd
30587 the little ACL defined above is used whenever Exim receives a RCPT command
30588 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30589 done when RCPT commands arrive. A rejection of RCPT should cause the
30590 sending MTA to give up on the recipient address contained in the RCPT
30591 command, whereas rejection at other times may cause the client MTA to keep on
30592 trying to deliver the message. It is therefore recommended that you do as much
30593 testing as possible at RCPT time.
30594
30595
30596 .subsection "The non-SMTP ACLs" SECID190
30597 .cindex "non-SMTP messages" "ACLs for"
30598 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30599 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30600 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30601 the state of the SMTP connection such as encryption and authentication) are not
30602 relevant and are forbidden in these ACLs. However, the sender and recipients
30603 are known, so the &%senders%& and &%sender_domains%& conditions and the
30604 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30605 &$authenticated_sender$& are also available. You can specify added header lines
30606 in any of these ACLs.
30607
30608 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30609 non-SMTP message, before any of the message has been read. (This is the
30610 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30611 batched SMTP input, it runs after the DATA command has been reached. The
30612 result of this ACL is ignored; it cannot be used to reject a message. If you
30613 really need to, you could set a value in an ACL variable here and reject based
30614 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30615 controls, and in particular, it can be used to set
30616 .code
30617 control = suppress_local_fixups
30618 .endd
30619 This cannot be used in the other non-SMTP ACLs because by the time they are
30620 run, it is too late.
30621
30622 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30623 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30624
30625 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30626 kind of rejection is treated as permanent, because there is no way of sending a
30627 temporary error for these kinds of message.
30628
30629
30630 .subsection "The SMTP connect ACL" SECID191
30631 .cindex "SMTP" "connection, ACL for"
30632 .oindex &%smtp_banner%&
30633 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30634 session, after the test specified by &%host_reject_connection%& (which is now
30635 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30636 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30637 the message override the banner message that is otherwise specified by the
30638 &%smtp_banner%& option.
30639
30640 For tls-on-connect connections, the ACL is run before the TLS connection
30641 is accepted; if the ACL does not accept then the TCP connection is dropped without
30642 any TLS startup attempt and without any SMTP response being transmitted.
30643
30644
30645 .subsection "The EHLO/HELO ACL" SECID192
30646 .cindex "EHLO" "ACL for"
30647 .cindex "HELO" "ACL for"
30648 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30649 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30650 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30651 Note that a client may issue more than one EHLO or HELO command in an SMTP
30652 session, and indeed is required to issue a new EHLO or HELO after successfully
30653 setting up encryption following a STARTTLS command.
30654
30655 Note also that a deny neither forces the client to go away nor means that
30656 mail will be refused on the connection.  Consider checking for
30657 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30658
30659 If the command is accepted by an &%accept%& verb that has a &%message%&
30660 modifier, the message may not contain more than one line (it will be truncated
30661 at the first newline and a panic logged if it does). Such a message cannot
30662 affect the EHLO options that are listed on the second and subsequent lines of
30663 an EHLO response.
30664
30665
30666 .subsection "The DATA ACLs" SECID193
30667 .cindex "DATA" "ACLs for"
30668 Two ACLs are associated with the DATA command, because it is two-stage
30669 command, with two responses being sent to the client.
30670 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30671 is obeyed. This gives you control after all the RCPT commands, but before
30672 the message itself is received. It offers the opportunity to give a negative
30673 response to the DATA command before the data is transmitted. Header lines
30674 added by MAIL or RCPT ACLs are not visible at this time, but any that
30675 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30676
30677 You cannot test the contents of the message, for example, to verify addresses
30678 in the headers, at RCPT time or when the DATA command is received. Such
30679 tests have to appear in the ACL that is run after the message itself has been
30680 received, before the final response to the DATA command is sent. This is
30681 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30682 associated with the DATA command.
30683
30684 .cindex CHUNKING "BDAT command"
30685 .cindex BDAT "SMTP command"
30686 .cindex "RFC 3030" CHUNKING
30687 If CHUNKING was advertised and a BDAT command sequence is received,
30688 the &%acl_smtp_predata%& ACL is not run.
30689 . XXX why not?  It should be possible, for the first BDAT.
30690 The &%acl_smtp_data%& is run after the last BDAT command and all of
30691 the data specified is received.
30692
30693 For both of these ACLs, it is not possible to reject individual recipients. An
30694 error response rejects the entire message. Unfortunately, it is known that some
30695 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30696 before or after the data) correctly &-- they keep the message on their queues
30697 and try again later, but that is their problem, though it does waste some of
30698 your resources.
30699
30700 The &%acl_smtp_data%& ACL is run after
30701 the &%acl_smtp_data_prdr%&,
30702 the &%acl_smtp_dkim%&
30703 and the &%acl_smtp_mime%& ACLs.
30704
30705 .subsection "The SMTP DKIM ACL" SECTDKIMACL
30706 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30707 enabled (which is the default).
30708
30709 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30710 received, and is executed for each DKIM signature found in a message.  If not
30711 otherwise specified, the default action is to accept.
30712
30713 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30714
30715 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30716
30717
30718 .subsection "The SMTP MIME ACL" SECID194
30719 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30720 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30721
30722 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30723
30724
30725 .subsection "The SMTP PRDR ACL" SECTPRDRACL
30726 .cindex "PRDR" "ACL for"
30727 .oindex "&%prdr_enable%&"
30728 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30729 with PRDR support enabled (which is the default).
30730 It becomes active only when the PRDR feature is negotiated between
30731 client and server for a message, and more than one recipient
30732 has been accepted.
30733
30734 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30735 has been received, and is executed once for each recipient of the message
30736 with &$local_part$& and &$domain$& valid.
30737 The test may accept, defer or deny for individual recipients.
30738 The &%acl_smtp_data%& will still be called after this ACL and
30739 can reject the message overall, even if this ACL has accepted it
30740 for some or all recipients.
30741
30742 PRDR may be used to support per-user content filtering.  Without it
30743 one must defer any recipient after the first that has a different
30744 content-filter configuration.  With PRDR, the RCPT-time check
30745 .cindex "PRDR" "variable for"
30746 for this can be disabled when the variable &$prdr_requested$&
30747 is &"yes"&.
30748 Any required difference in behaviour of the main DATA-time
30749 ACL should however depend on the PRDR-time ACL having run, as Exim
30750 will avoid doing so in some situations (e.g. single-recipient mails).
30751
30752 See also the &%prdr_enable%& global option
30753 and the &%hosts_try_prdr%& smtp transport option.
30754
30755 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30756 If the ACL is not defined, processing completes as if
30757 the feature was not requested by the client.
30758
30759 .subsection "The QUIT ACL" SECTQUITACL
30760 .cindex "QUIT, ACL for"
30761 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30762 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30763 does not in fact control any access.
30764 For this reason, it may only accept
30765 or warn as its final result.
30766
30767 This ACL can be used for tasks such as custom logging at the end of an SMTP
30768 session. For example, you can use ACL variables in other ACLs to count
30769 messages, recipients, etc., and log the totals at QUIT time using one or
30770 more &%logwrite%& modifiers on a &%warn%& verb.
30771
30772 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30773 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30774
30775 You do not need to have a final &%accept%&, but if you do, you can use a
30776 &%message%& modifier to specify custom text that is sent as part of the 221
30777 response to QUIT.
30778
30779 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30780 failure (for example, failure to open a log file, or when Exim is bombing out
30781 because it has detected an unrecoverable error), all SMTP commands from the
30782 client are given temporary error responses until QUIT is received or the
30783 connection is closed. In these special cases, the QUIT ACL does not run.
30784
30785
30786 .subsection "The not-QUIT ACL" SECTNOTQUITACL
30787 .vindex &$acl_smtp_notquit$&
30788 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30789 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30790 trouble, such as being unable to write to its log files, this ACL is not run,
30791 because it might try to do things (such as write to log files) that make the
30792 situation even worse.
30793
30794 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30795 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30796 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30797 and &%warn%&.
30798
30799 .vindex &$smtp_notquit_reason$&
30800 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30801 to a string that indicates the reason for the termination of the SMTP
30802 connection. The possible values are:
30803 .table2
30804 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30805 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30806 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30807 .irow &`connection-lost`&          "The SMTP connection has been lost"
30808 .irow &`data-timeout`&             "Timeout while reading message data"
30809 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30810 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30811 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30812 .irow &`synchronization-error`&    "SMTP synchronization error"
30813 .irow &`tls-failed`&               "TLS failed to start"
30814 .endtable
30815 In most cases when an SMTP connection is closed without having received QUIT,
30816 Exim sends an SMTP response message before actually closing the connection.
30817 With the exception of the &`acl-drop`& case, the default message can be
30818 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30819 &%drop%& verb in another ACL, it is the message from the other ACL that is
30820 used.
30821
30822
30823 .section "Finding an ACL to use" "SECID195"
30824 .cindex "&ACL;" "finding which to use"
30825 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30826 you can use different ACLs in different circumstances. For example,
30827 .code
30828 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30829                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30830 .endd
30831 In the default configuration file there are some example settings for
30832 providing an RFC 4409 message &"submission"& service on port 587 and
30833 an RFC 8314 &"submissions"& service on port 465. You can use a string
30834 expansion like this to choose an ACL for MUAs on these ports which is
30835 more appropriate for this purpose than the default ACL on port 25.
30836
30837 The expanded string does not have to be the name of an ACL in the
30838 configuration file; there are other possibilities. Having expanded the
30839 string, Exim searches for an ACL as follows:
30840
30841 .ilist
30842 If the string begins with a slash, Exim uses it as a filename, and reads its
30843 contents as an ACL. The lines are processed in the same way as lines in the
30844 Exim configuration file. In particular, continuation lines are supported, blank
30845 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30846 If the file does not exist or cannot be read, an error occurs (typically
30847 causing a temporary failure of whatever caused the ACL to be run). For example:
30848 .code
30849 acl_smtp_data = /etc/acls/\
30850   ${lookup{$sender_host_address}lsearch\
30851   {/etc/acllist}{$value}{default}}
30852 .endd
30853 This looks up an ACL file to use on the basis of the host's IP address, falling
30854 back to a default if the lookup fails. If an ACL is successfully read from a
30855 file, it is retained in memory for the duration of the Exim process, so that it
30856 can be re-used without having to re-read the file.
30857 .next
30858 If the string does not start with a slash, and does not contain any spaces,
30859 Exim searches the ACL section of the configuration for an ACL whose name
30860 matches the string.
30861 .next
30862 If no named ACL is found, or if the string contains spaces, Exim parses
30863 the string as an inline ACL. This can save typing in cases where you just
30864 want to have something like
30865 .code
30866 acl_smtp_vrfy = accept
30867 .endd
30868 in order to allow free use of the VRFY command. Such a string may contain
30869 newlines; it is processed in the same way as an ACL that is read from a file.
30870 .endlist
30871
30872
30873
30874
30875 .section "ACL return codes" "SECID196"
30876 .cindex "&ACL;" "return codes"
30877 Except for the QUIT ACL, which does not affect the SMTP return code (see
30878 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30879 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30880 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30881 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30882 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30883 This also causes a 4&'xx'& return code.
30884
30885 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30886 &"deny"&, because there is no mechanism for passing temporary errors to the
30887 submitters of non-SMTP messages.
30888
30889
30890 ACLs that are relevant to message reception may also return &"discard"&. This
30891 has the effect of &"accept"&, but causes either the entire message or an
30892 individual recipient address to be discarded. In other words, it is a
30893 blackholing facility. Use it with care.
30894
30895 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30896 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30897 RCPT ACL is to discard just the one recipient address. If there are no
30898 recipients left when the message's data is received, the DATA ACL is not
30899 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30900 remaining recipients. The &"discard"& return is not permitted for the
30901 &%acl_smtp_predata%& ACL.
30902
30903 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30904 is done on the address and the result determines the SMTP response.
30905
30906
30907 .cindex "&[local_scan()]& function" "when all recipients discarded"
30908 The &[local_scan()]& function is always run, even if there are no remaining
30909 recipients; it may create new recipients.
30910
30911
30912
30913 .section "Unset ACL options" "SECID197"
30914 .cindex "&ACL;" "unset options"
30915 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30916 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30917 not defined at all. For any defined ACL, the default action when control
30918 reaches the end of the ACL statements is &"deny"&.
30919
30920 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30921 these two are ACLs that are used only for their side effects. They cannot be
30922 used to accept or reject anything.
30923
30924 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30925 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30926 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30927 when the ACL is not defined is &"accept"&.
30928
30929 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30930 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30931 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30932 messages over an SMTP connection. For an example, see the ACL in the default
30933 configuration file.
30934
30935
30936
30937
30938 .section "Data for message ACLs" "SECID198"
30939 .cindex "&ACL;" "data for message ACL"
30940 .vindex &$domain$&
30941 .vindex &$local_part$&
30942 .vindex &$sender_address$&
30943 .vindex &$sender_host_address$&
30944 .vindex &$smtp_command$&
30945 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30946 that contain information about the host and the message's sender (for example,
30947 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30948 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30949 &$local_part$& are set from the argument address. The entire SMTP command
30950 is available in &$smtp_command$&.
30951
30952 When an ACL for the AUTH parameter of MAIL is running, the variables that
30953 contain information about the host are set, but &$sender_address$& is not yet
30954 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30955 how it is used.
30956
30957 .vindex "&$message_size$&"
30958 The &$message_size$& variable is set to the value of the SIZE parameter on
30959 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30960 that parameter is not given. The value is updated to the true message size by
30961 the time the final DATA ACL is run (after the message data has been
30962 received).
30963
30964 .vindex "&$rcpt_count$&"
30965 .vindex "&$recipients_count$&"
30966 The &$rcpt_count$& variable increases by one for each RCPT command received.
30967 The &$recipients_count$& variable increases by one each time a RCPT command is
30968 accepted, so while an ACL for RCPT is being processed, it contains the number
30969 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30970 &$rcpt_count$& contains the total number of RCPT commands, and
30971 &$recipients_count$& contains the total number of accepted recipients.
30972
30973
30974
30975
30976
30977 .section "Data for non-message ACLs" "SECTdatfornon"
30978 .cindex "&ACL;" "data for non-message ACL"
30979 .vindex &$smtp_command_argument$&
30980 .vindex &$smtp_command$&
30981 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30982 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30983 and the entire SMTP command is available in &$smtp_command$&.
30984 These variables can be tested using a &%condition%& condition. For example,
30985 here is an ACL for use with AUTH, which insists that either the session is
30986 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30987 does not permit authentication methods that use cleartext passwords on
30988 unencrypted connections.
30989 .code
30990 acl_check_auth:
30991   accept encrypted = *
30992   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30993                      {CRAM-MD5}}
30994   deny   message   = TLS encryption or CRAM-MD5 required
30995 .endd
30996 (Another way of applying this restriction is to arrange for the authenticators
30997 that use cleartext passwords not to be advertised when the connection is not
30998 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30999 option to do this.)
31000
31001
31002
31003 .section "Format of an ACL" "SECID199"
31004 .cindex "&ACL;" "format of"
31005 .cindex "&ACL;" "verbs, definition of"
31006 An individual ACL consists of a number of statements. Each statement starts
31007 with a verb, optionally followed by a number of conditions and &"modifiers"&.
31008 Modifiers can change the way the verb operates, define error and log messages,
31009 set variables, insert delays, and vary the processing of accepted messages.
31010
31011 If all the conditions are met, the verb is obeyed. The same condition may be
31012 used (with different arguments) more than once in the same statement. This
31013 provides a means of specifying an &"and"& conjunction between conditions. For
31014 example:
31015 .code
31016 deny  dnslists = list1.example
31017       dnslists = list2.example
31018 .endd
31019 If there are no conditions, the verb is always obeyed. Exim stops evaluating
31020 the conditions and modifiers when it reaches a condition that fails. What
31021 happens then depends on the verb (and in one case, on a special modifier). Not
31022 all the conditions make sense at every testing point. For example, you cannot
31023 test a sender address in the ACL that is run for a VRFY command.
31024
31025
31026 .section "ACL verbs" "SECID200"
31027 The ACL verbs are as follows:
31028
31029 .ilist
31030 .cindex "&%accept%& ACL verb"
31031 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
31032 of the conditions are not met, what happens depends on whether &%endpass%&
31033 appears among the conditions (for syntax see below). If the failing condition
31034 is before &%endpass%&, control is passed to the next ACL statement; if it is
31035 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
31036 check a RCPT command:
31037 .code
31038 accept domains = +local_domains
31039        endpass
31040        verify = recipient
31041 .endd
31042 If the recipient domain does not match the &%domains%& condition, control
31043 passes to the next statement. If it does match, the recipient is verified, and
31044 the command is accepted if verification succeeds. However, if verification
31045 fails, the ACL yields &"deny"&, because the failing condition is after
31046 &%endpass%&.
31047
31048 The &%endpass%& feature has turned out to be confusing to many people, so its
31049 use is not recommended nowadays. It is always possible to rewrite an ACL so
31050 that &%endpass%& is not needed, and it is no longer used in the default
31051 configuration.
31052
31053 .cindex "&%message%& ACL modifier" "with &%accept%&"
31054 If a &%message%& modifier appears on an &%accept%& statement, its action
31055 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
31056 (when an &%accept%& verb either accepts or passes control to the next
31057 statement), &%message%& can be used to vary the message that is sent when an
31058 SMTP command is accepted. For example, in a RCPT ACL you could have:
31059 .display
31060 &`accept  `&<&'some conditions'&>
31061 &`        message = OK, I will allow you through today`&
31062 .endd
31063 You can specify an SMTP response code, optionally followed by an &"extended
31064 response code"& at the start of the message, but the first digit must be the
31065 same as would be sent by default, which is 2 for an &%accept%& verb.
31066
31067 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
31068 an error message that is used when access is denied. This behaviour is retained
31069 for backward compatibility, but current &"best practice"& is to avoid the use
31070 of &%endpass%&.
31071
31072
31073 .next
31074 .cindex "&%defer%& ACL verb"
31075 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
31076 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
31077 &%defer%& is the same as &%deny%&, because there is no way of sending a
31078 temporary error. For a RCPT command, &%defer%& is much the same as using a
31079 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
31080 be used in any ACL, and even for a recipient it might be a simpler approach.
31081
31082
31083 .next
31084 .cindex "&%deny%& ACL verb"
31085 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
31086 the conditions are not met, control is passed to the next ACL statement. For
31087 example,
31088 .code
31089 deny dnslists = blackholes.mail-abuse.org
31090 .endd
31091 rejects commands from hosts that are on a DNS black list.
31092
31093
31094 .next
31095 .cindex "&%discard%& ACL verb"
31096 &%discard%&: This verb behaves like &%accept%&, except that it returns
31097 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
31098 that are concerned with receiving messages. When all the conditions are true,
31099 the sending entity receives a &"success"& response. However, &%discard%& causes
31100 recipients to be discarded. If it is used in an ACL for RCPT, just the one
31101 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
31102 message's recipients are discarded. Recipients that are discarded before DATA
31103 do not appear in the log line when the &%received_recipients%& log selector is set.
31104
31105 If the &%log_message%& modifier is set when &%discard%& operates,
31106 its contents are added to the line that is automatically written to the log.
31107 The &%message%& modifier operates exactly as it does for &%accept%&.
31108
31109
31110 .next
31111 .cindex "&%drop%& ACL verb"
31112 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
31113 forcibly closed after the 5&'xx'& error message has been sent. For example:
31114 .code
31115 drop   condition = ${if > {$rcpt_count}{20}}
31116        message   = I don't take more than 20 RCPTs
31117 .endd
31118 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
31119 The connection is always dropped after sending a 550 response.
31120
31121 .next
31122 .cindex "&%require%& ACL verb"
31123 &%require%&: If all the conditions are met, control is passed to the next ACL
31124 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
31125 example, when checking a RCPT command,
31126 .code
31127 require message = Sender did not verify
31128         verify  = sender
31129 .endd
31130 passes control to subsequent statements only if the message's sender can be
31131 verified. Otherwise, it rejects the command. Note the positioning of the
31132 &%message%& modifier, before the &%verify%& condition. The reason for this is
31133 discussed in section &<<SECTcondmodproc>>&.
31134
31135 .next
31136 .cindex "&%warn%& ACL verb"
31137 &%warn%&: If all the conditions are true, a line specified by the
31138 &%log_message%& modifier is written to Exim's main log. Control always passes
31139 to the next ACL statement. If any condition is false, the log line is not
31140 written. If an identical log line is requested several times in the same
31141 message, only one copy is actually written to the log. If you want to force
31142 duplicates to be written, use the &%logwrite%& modifier instead.
31143
31144 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
31145 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
31146 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
31147 first failing condition. There is more about adding header lines in section
31148 &<<SECTaddheadacl>>&.
31149
31150 If any condition on a &%warn%& statement cannot be completed (that is, there is
31151 some sort of defer), the log line specified by &%log_message%& is not written.
31152 This does not include the case of a forced failure from a lookup, which
31153 is considered to be a successful completion. After a defer, no further
31154 conditions or modifiers in the &%warn%& statement are processed. The incident
31155 is logged, and the ACL continues to be processed, from the next statement
31156 onwards.
31157
31158
31159 .vindex "&$acl_verify_message$&"
31160 When one of the &%warn%& conditions is an address verification that fails, the
31161 text of the verification failure message is in &$acl_verify_message$&. If you
31162 want this logged, you must set it up explicitly. For example:
31163 .code
31164 warn   !verify = sender
31165        log_message = sender verify failed: $acl_verify_message
31166 .endd
31167 .endlist
31168
31169 At the end of each ACL there is an implicit unconditional &%deny%&.
31170
31171 As you can see from the examples above, the conditions and modifiers are
31172 written one to a line, with the first one on the same line as the verb, and
31173 subsequent ones on following lines. If you have a very long condition, you can
31174 continue it onto several physical lines by the usual backslash continuation
31175 mechanism. It is conventional to align the conditions vertically.
31176
31177
31178
31179 .section "ACL variables" "SECTaclvariables"
31180 .cindex "&ACL;" "variables"
31181 There are some special variables that can be set during ACL processing. They
31182 can be used to pass information between different ACLs, different invocations
31183 of the same ACL in the same SMTP connection, and between ACLs and the routers,
31184 transports, and filters that are used to deliver a message. The names of these
31185 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
31186 an underscore, but the remainder of the name can be any sequence of
31187 alphanumeric characters and underscores that you choose. There is no limit on
31188 the number of ACL variables. The two sets act as follows:
31189 .ilist
31190 The values of those variables whose names begin with &$acl_c$& persist
31191 throughout an SMTP connection. They are never reset. Thus, a value that is set
31192 while receiving one message is still available when receiving the next message
31193 on the same SMTP connection.
31194 .next
31195 The values of those variables whose names begin with &$acl_m$& persist only
31196 while a message is being received. They are reset afterwards. They are also
31197 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
31198 .endlist
31199
31200 When a message is accepted, the current values of all the ACL variables are
31201 preserved with the message and are subsequently made available at delivery
31202 time. The ACL variables are set by a modifier called &%set%&. For example:
31203 .code
31204 accept hosts = whatever
31205        set acl_m4 = some value
31206 accept authenticated = *
31207        set acl_c_auth = yes
31208 .endd
31209 &*Note*&: A leading dollar sign is not used when naming a variable that is to
31210 be set. If you want to set a variable without taking any action, you can use a
31211 &%warn%& verb without any other modifiers or conditions.
31212
31213 .oindex &%strict_acl_vars%&
31214 What happens if a syntactically valid but undefined ACL variable is
31215 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31216 false (the default), an empty string is substituted; if it is true, an
31217 error is generated.
31218
31219 Versions of Exim before 4.64 have a limited set of numbered variables, but
31220 their names are compatible, so there is no problem with upgrading.
31221
31222
31223 .section "Condition and modifier processing" "SECTcondmodproc"
31224 .cindex "&ACL;" "conditions; processing"
31225 .cindex "&ACL;" "modifiers; processing"
31226 An exclamation mark preceding a condition negates its result. For example:
31227 .code
31228 deny   domains = *.dom.example
31229       !verify  = recipient
31230 .endd
31231 causes the ACL to return &"deny"& if the recipient domain ends in
31232 &'dom.example'& and the recipient address cannot be verified. Sometimes
31233 negation can be used on the right-hand side of a condition. For example, these
31234 two statements are equivalent:
31235 .code
31236 deny  hosts = !192.168.3.4
31237 deny !hosts =  192.168.3.4
31238 .endd
31239 However, for many conditions (&%verify%& being a good example), only left-hand
31240 side negation of the whole condition is possible.
31241
31242 The arguments of conditions and modifiers are expanded. A forced failure
31243 of an expansion causes a condition to be ignored, that is, it behaves as if the
31244 condition is true. Consider these two statements:
31245 .code
31246 accept  senders = ${lookup{$host_name}lsearch\
31247                   {/some/file}{$value}fail}
31248 accept  senders = ${lookup{$host_name}lsearch\
31249                   {/some/file}{$value}{}}
31250 .endd
31251 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31252 the returned list is searched, but if the lookup fails the behaviour is
31253 different in the two cases. The &%fail%& in the first statement causes the
31254 condition to be ignored, leaving no further conditions. The &%accept%& verb
31255 therefore succeeds. The second statement, however, generates an empty list when
31256 the lookup fails. No sender can match an empty list, so the condition fails,
31257 and therefore the &%accept%& also fails.
31258
31259 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31260 specify actions that are taken as the conditions for a statement are checked;
31261 others specify text for messages that are used when access is denied or a
31262 warning is generated. The &%control%& modifier affects the way an incoming
31263 message is handled.
31264
31265 The positioning of the modifiers in an ACL statement is important, because the
31266 processing of a verb ceases as soon as its outcome is known. Only those
31267 modifiers that have already been encountered will take effect. For example,
31268 consider this use of the &%message%& modifier:
31269 .code
31270 require message = Can't verify sender
31271         verify  = sender
31272         message = Can't verify recipient
31273         verify  = recipient
31274         message = This message cannot be used
31275 .endd
31276 If sender verification fails, Exim knows that the result of the statement is
31277 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31278 so its text is used as the error message. If sender verification succeeds, but
31279 recipient verification fails, the second message is used. If recipient
31280 verification succeeds, the third message becomes &"current"&, but is never used
31281 because there are no more conditions to cause failure.
31282
31283 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31284 modifier that is used, because all the conditions must be true for rejection to
31285 happen. Specifying more than one &%message%& modifier does not make sense, and
31286 the message can even be specified after all the conditions. For example:
31287 .code
31288 deny   hosts = ...
31289       !senders = *@my.domain.example
31290        message = Invalid sender from client host
31291 .endd
31292 The &"deny"& result does not happen until the end of the statement is reached,
31293 by which time Exim has set up the message.
31294
31295
31296
31297 .section "ACL modifiers" "SECTACLmodi"
31298 .cindex "&ACL;" "modifiers; list of"
31299 The ACL modifiers are as follows:
31300
31301 .vlist
31302 .vitem &*add_header*&&~=&~<&'text'&>
31303 This modifier specifies one or more header lines that are to be added to an
31304 incoming message, assuming, of course, that the message is ultimately
31305 accepted. For details, see section &<<SECTaddheadacl>>&.
31306
31307 .vitem &*continue*&&~=&~<&'text'&>
31308 .cindex "&%continue%& ACL modifier"
31309 .cindex "database" "updating in ACL"
31310 This modifier does nothing of itself, and processing of the ACL always
31311 continues with the next condition or modifier. The value of &%continue%& is in
31312 the side effects of expanding its argument. Typically this could be used to
31313 update a database. It is really just a syntactic tidiness, to avoid having to
31314 write rather ugly lines like this:
31315 .display
31316 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31317 .endd
31318 Instead, all you need is
31319 .display
31320 &`continue = `&<&'some expansion'&>
31321 .endd
31322
31323 .vitem &*control*&&~=&~<&'text'&>
31324 .cindex "&%control%& ACL modifier"
31325 This modifier affects the subsequent processing of the SMTP connection or of an
31326 incoming message that is accepted. The effect of the first type of control
31327 lasts for the duration of the connection, whereas the effect of the second type
31328 lasts only until the current message has been received. The message-specific
31329 controls always apply to the whole message, not to individual recipients,
31330 even if the &%control%& modifier appears in a RCPT ACL.
31331
31332 As there are now quite a few controls that can be applied, they are described
31333 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31334 in several different ways. For example:
31335
31336 . ==== As this is a nested list, any displays it contains must be indented
31337 . ==== as otherwise they are too far to the left. That comment applies only
31338 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31339 . ==== way.
31340
31341 .ilist
31342 It can be at the end of an &%accept%& statement:
31343 .code
31344     accept  ...some conditions
31345             control = queue
31346 .endd
31347 In this case, the control is applied when this statement yields &"accept"&, in
31348 other words, when the conditions are all true.
31349
31350 .next
31351 It can be in the middle of an &%accept%& statement:
31352 .code
31353     accept  ...some conditions...
31354             control = queue
31355             ...some more conditions...
31356 .endd
31357 If the first set of conditions are true, the control is applied, even if the
31358 statement does not accept because one of the second set of conditions is false.
31359 In this case, some subsequent statement must yield &"accept"& for the control
31360 to be relevant.
31361
31362 .next
31363 It can be used with &%warn%& to apply the control, leaving the
31364 decision about accepting or denying to a subsequent verb. For
31365 example:
31366 .code
31367     warn    ...some conditions...
31368             control = freeze
31369     accept  ...
31370 .endd
31371 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31372 &%logwrite%&, so it does not add anything to the message and does not write a
31373 log entry.
31374
31375 .next
31376 If you want to apply a control unconditionally, you can use it with a
31377 &%require%& verb. For example:
31378 .code
31379     require  control = no_multiline_responses
31380 .endd
31381 .endlist
31382
31383 .vitem &*delay*&&~=&~<&'time'&>
31384 .cindex "&%delay%& ACL modifier"
31385 .oindex "&%-bh%&"
31386 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31387 the time interval before proceeding. However, when testing Exim using the
31388 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31389 output instead). The time is given in the usual Exim notation, and the delay
31390 happens as soon as the modifier is processed. In an SMTP session, pending
31391 output is flushed before the delay is imposed.
31392
31393 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31394 example:
31395 .code
31396 deny    ...some conditions...
31397         delay = 30s
31398 .endd
31399 The delay happens if all the conditions are true, before the statement returns
31400 &"deny"&. Compare this with:
31401 .code
31402 deny    delay = 30s
31403         ...some conditions...
31404 .endd
31405 which waits for 30s before processing the conditions. The &%delay%& modifier
31406 can also be used with &%warn%& and together with &%control%&:
31407 .code
31408 warn    ...some conditions...
31409         delay = 2m
31410         control = freeze
31411 accept  ...
31412 .endd
31413
31414 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31415 responses to several commands are no longer buffered and sent in one packet (as
31416 they would normally be) because all output is flushed before imposing the
31417 delay. This optimization is disabled so that a number of small delays do not
31418 appear to the client as one large aggregated delay that might provoke an
31419 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31420 using a &%control%& modifier to set &%no_delay_flush%&.
31421
31422
31423 .vitem &*endpass*&
31424 .cindex "&%endpass%& ACL modifier"
31425 This modifier, which has no argument, is recognized only in &%accept%& and
31426 &%discard%& statements. It marks the boundary between the conditions whose
31427 failure causes control to pass to the next statement, and the conditions whose
31428 failure causes the ACL to return &"deny"&. This concept has proved to be
31429 confusing to some people, so the use of &%endpass%& is no longer recommended as
31430 &"best practice"&. See the description of &%accept%& above for more details.
31431
31432
31433 .vitem &*log_message*&&~=&~<&'text'&>
31434 .cindex "&%log_message%& ACL modifier"
31435 This modifier sets up a message that is used as part of the log message if the
31436 ACL denies access or a &%warn%& statement's conditions are true. For example:
31437 .code
31438 require log_message = wrong cipher suite $tls_in_cipher
31439         encrypted   = DES-CBC3-SHA
31440 .endd
31441 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31442 example:
31443 .display
31444 &`discard `&<&'some conditions'&>
31445 &`        log_message = Discarded $local_part@$domain because...`&
31446 .endd
31447 When access is denied, &%log_message%& adds to any underlying error message
31448 that may exist because of a condition failure. For example, while verifying a
31449 recipient address, a &':fail:'& redirection might have already set up a
31450 message.
31451
31452 The message may be defined before the conditions to which it applies, because
31453 the string expansion does not happen until Exim decides that access is to be
31454 denied. This means that any variables that are set by the condition are
31455 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31456 variables are set after a DNS black list lookup succeeds. If the expansion of
31457 &%log_message%& fails, or if the result is an empty string, the modifier is
31458 ignored.
31459
31460 .vindex "&$acl_verify_message$&"
31461 If you want to use a &%warn%& statement to log the result of an address
31462 verification, you can use &$acl_verify_message$& to include the verification
31463 error message.
31464
31465 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31466 the start of the logged message. If the same warning log message is requested
31467 more than once while receiving  a single email message, only one copy is
31468 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31469 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31470 is logged for a successful &%warn%& statement.
31471
31472 If &%log_message%& is not present and there is no underlying error message (for
31473 example, from the failure of address verification), but &%message%& is present,
31474 the &%message%& text is used for logging rejections. However, if any text for
31475 logging contains newlines, only the first line is logged. In the absence of
31476 both &%log_message%& and &%message%&, a default built-in message is used for
31477 logging rejections.
31478
31479
31480 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31481 .cindex "&%log_reject_target%& ACL modifier"
31482 .cindex "logging in ACL" "specifying which log"
31483 This modifier makes it possible to specify which logs are used for messages
31484 about ACL rejections. Its argument is a colon-separated list of words that can
31485 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31486 may be empty, in which case a rejection is not logged at all. For example, this
31487 ACL fragment writes no logging information when access is denied:
31488 .display
31489 &`deny `&<&'some conditions'&>
31490 &`     log_reject_target =`&
31491 .endd
31492 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31493 permanent and temporary rejections. Its effect lasts for the rest of the
31494 current ACL.
31495
31496
31497 .vitem &*logwrite*&&~=&~<&'text'&>
31498 .cindex "&%logwrite%& ACL modifier"
31499 .cindex "logging in ACL" "immediate"
31500 This modifier writes a message to a log file as soon as it is encountered when
31501 processing an ACL. (Compare &%log_message%&, which, except in the case of
31502 &%warn%& and &%discard%&, is used only if the ACL statement denies
31503 access.) The &%logwrite%& modifier can be used to log special incidents in
31504 ACLs. For example:
31505 .display
31506 &`accept `&<&'some special conditions'&>
31507 &`       control  = freeze`&
31508 &`       logwrite = froze message because ...`&
31509 .endd
31510 By default, the message is written to the main log. However, it may begin
31511 with a colon, followed by a comma-separated list of log names, and then
31512 another colon, to specify exactly which logs are to be written. For
31513 example:
31514 .code
31515 logwrite = :main,reject: text for main and reject logs
31516 logwrite = :panic: text for panic log only
31517 .endd
31518
31519
31520 .vitem &*message*&&~=&~<&'text'&>
31521 .cindex "&%message%& ACL modifier"
31522 This modifier sets up a text string that is expanded and used as a response
31523 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31524 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31525 there is some complication if &%endpass%& is involved; see the description of
31526 &%accept%& for details.)
31527
31528 The expansion of the message happens at the time Exim decides that the ACL is
31529 to end, not at the time it processes &%message%&. If the expansion fails, or
31530 generates an empty string, the modifier is ignored. Here is an example where
31531 &%message%& must be specified first, because the ACL ends with a rejection if
31532 the &%hosts%& condition fails:
31533 .code
31534 require  message = Host not recognized
31535          hosts = 10.0.0.0/8
31536 .endd
31537 (Once a condition has failed, no further conditions or modifiers are
31538 processed.)
31539
31540 .cindex "SMTP" "error codes"
31541 .oindex "&%smtp_banner%&
31542 For ACLs that are triggered by SMTP commands, the message is returned as part
31543 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31544 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31545 is accepted. In the case of the connect ACL, accepting with a message modifier
31546 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31547 accept message may not contain more than one line (otherwise it will be
31548 truncated at the first newline and a panic logged), and it cannot affect the
31549 EHLO options.
31550
31551 When SMTP is involved, the message may begin with an overriding response code,
31552 consisting of three digits optionally followed by an &"extended response code"&
31553 of the form &'n.n.n'&, each code being followed by a space. For example:
31554 .code
31555 deny  message = 599 1.2.3 Host not welcome
31556       hosts = 192.168.34.0/24
31557 .endd
31558 The first digit of the supplied response code must be the same as would be sent
31559 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31560 access, but for the predata ACL, note that the default success code is 354, not
31561 2&'xx'&.
31562
31563 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31564 the message modifier cannot override the 221 response code.
31565
31566 The text in a &%message%& modifier is literal; any quotes are taken as
31567 literals, but because the string is expanded, backslash escapes are processed
31568 anyway.
31569 If the message contains newlines, this gives rise to a multi-line SMTP
31570 response.
31571 A long message line will also be split into multi-line SMTP responses,
31572 on word boundaries if possible.
31573
31574 .vindex "&$acl_verify_message$&"
31575 While the text is being expanded, the &$acl_verify_message$& variable
31576 contains any message previously set.
31577 Afterwards, &$acl_verify_message$& is cleared.
31578
31579 If &%message%& is used on a statement that verifies an address, the message
31580 specified overrides any message that is generated by the verification process.
31581 However, the original message is available in the variable
31582 &$acl_verify_message$&, so you can incorporate it into your message if you
31583 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31584 routers to be passed back as part of the SMTP response, you should either not
31585 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31586
31587 For compatibility with previous releases of Exim, a &%message%& modifier that
31588 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31589 modifier, but this usage is now deprecated. However, &%message%& acts only when
31590 all the conditions are true, wherever it appears in an ACL command, whereas
31591 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31592 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31593 effect.
31594
31595
31596 .vitem &*queue*&&~=&~<&'text'&>
31597 .cindex "&%queue%& ACL modifier"
31598 .cindex "named queues" "selecting in ACL"
31599 This modifier specifies the use of a named queue for spool files
31600 for the message.
31601 It can only be used before the message is received (i.e. not in
31602 the DATA ACL).
31603 This could be used, for example, for known high-volume burst sources
31604 of traffic, or for quarantine of messages.
31605 Separate queue-runner processes will be needed for named queues.
31606 If the text after expansion is empty, the default queue is used.
31607
31608
31609 .vitem &*remove_header*&&~=&~<&'text'&>
31610 This modifier specifies one or more header names in a colon-separated list
31611  that are to be removed from an incoming message, assuming, of course, that
31612 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31613
31614
31615 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31616 .cindex "&%set%& ACL modifier"
31617 This modifier puts a value into one of the ACL variables (see section
31618 &<<SECTaclvariables>>&).
31619
31620
31621 .vitem &*udpsend*&&~=&~<&'parameters'&>
31622 .cindex "UDP communications"
31623 This modifier sends a UDP packet, for purposes such as statistics
31624 collection or behaviour monitoring. The parameters are expanded, and
31625 the result of the expansion must be a colon-separated list consisting
31626 of a destination server, port number, and the packet contents. The
31627 server can be specified as a host name or IPv4 or IPv6 address. The
31628 separator can be changed with the usual angle bracket syntax. For
31629 example, you might want to collect information on which hosts connect
31630 when:
31631 .code
31632 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31633              $tod_zulu $sender_host_address
31634 .endd
31635 .endlist
31636
31637
31638
31639
31640 .section "Use of the control modifier" "SECTcontrols"
31641 .cindex "&%control%& ACL modifier"
31642 The &%control%& modifier supports the following settings:
31643
31644 .vlist
31645 .vitem &*control&~=&~allow_auth_unadvertised*&
31646 This modifier allows a client host to use the SMTP AUTH command even when it
31647 has not been advertised in response to EHLO. Furthermore, because there are
31648 apparently some really broken clients that do this, Exim will accept AUTH after
31649 HELO (rather than EHLO) when this control is set. It should be used only if you
31650 really need it, and you should limit its use to those broken clients that do
31651 not work without it. For example:
31652 .code
31653 warn hosts   = 192.168.34.25
31654      control = allow_auth_unadvertised
31655 .endd
31656 Normally, when an Exim server receives an AUTH command, it checks the name of
31657 the authentication mechanism that is given in the command to ensure that it
31658 matches an advertised mechanism. When this control is set, the check that a
31659 mechanism has been advertised is bypassed. Any configured mechanism can be used
31660 by the client. This control is permitted only in the connection and HELO ACLs.
31661
31662
31663 .vitem &*control&~=&~caseful_local_part*& &&&
31664        &*control&~=&~caselower_local_part*&
31665 .cindex "&ACL;" "case of local part in"
31666 .cindex "case of local parts"
31667 .vindex "&$local_part$&"
31668 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31669 (that is, during RCPT processing). By default, the contents of &$local_part$&
31670 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31671 any uppercase letters in the original local part are restored in &$local_part$&
31672 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31673 is encountered.
31674
31675 These controls affect only the current recipient. Moreover, they apply only to
31676 local part handling that takes place directly in the ACL (for example, as a key
31677 in lookups). If a test to verify the recipient is obeyed, the case-related
31678 handling of the local part during the verification is controlled by the router
31679 configuration (see the &%caseful_local_part%& generic router option).
31680
31681 This facility could be used, for example, to add a spam score to local parts
31682 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31683 spam score:
31684 .code
31685 warn  control = caseful_local_part
31686       set acl_m4 = ${eval:\
31687                      $acl_m4 + \
31688                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31689                     }
31690       control = caselower_local_part
31691 .endd
31692 Notice that we put back the lower cased version afterwards, assuming that
31693 is what is wanted for subsequent tests.
31694
31695
31696 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31697 .cindex "&ACL;" "cutthrough routing"
31698 .cindex "cutthrough" "requesting"
31699 This option requests delivery be attempted while the item is being received.
31700
31701 The option is usable in the RCPT ACL.
31702 If enabled for a message received via smtp and routed to an smtp transport,
31703 and only one transport, interface, destination host and port combination
31704 is used for all recipients of the message,
31705 then the delivery connection is made while the receiving connection is open
31706 and data is copied from one to the other.
31707
31708 An attempt to set this option for any recipient but the first
31709 for a mail will be quietly ignored.
31710 If a recipient-verify callout
31711 (with use_sender)
31712 connection is subsequently
31713 requested in the same ACL it is held open and used for
31714 any subsequent recipients and the data,
31715 otherwise one is made after the initial RCPT ACL completes.
31716
31717 Note that routers are used in verify mode,
31718 and cannot depend on content of received headers.
31719 Note also that headers cannot be
31720 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31721 Headers may be modified by routers (subject to the above) and transports.
31722 The &'Received-By:'& header is generated as soon as the body reception starts,
31723 rather than the traditional time after the full message is received;
31724 this will affect the timestamp.
31725
31726 All the usual ACLs are called; if one results in the message being
31727 rejected, all effort spent in delivery (including the costs on
31728 the ultimate destination) will be wasted.
31729 Note that in the case of data-time ACLs this includes the entire
31730 message body.
31731
31732 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31733 of outgoing messages is done, because it sends data to the ultimate destination
31734 before the entire message has been received from the source.
31735 It is not supported for messages received with the SMTP PRDR
31736 or CHUNKING
31737 options in use.
31738
31739 Should the ultimate destination system positively accept or reject the mail,
31740 a corresponding indication is given to the source system and nothing is queued.
31741 If the item is successfully delivered in cutthrough mode
31742 the delivery log lines are tagged with ">>" rather than "=>" and appear
31743 before the acceptance "<=" line.
31744
31745 If there is a temporary error the item is queued for later delivery in the
31746 usual fashion.
31747 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31748 to the control; the default value is &"spool"& and the alternate value
31749 &"pass"& copies an SMTP defer response from the target back to the initiator
31750 and does not queue the message.
31751 Note that this is independent of any recipient verify conditions in the ACL.
31752
31753 Delivery in this mode avoids the generation of a bounce mail to a
31754 (possibly faked)
31755 sender when the destination system is doing content-scan based rejection.
31756
31757
31758 .vitem &*control&~=&~debug/*&<&'options'&>
31759 .cindex "&ACL;" "enabling debug logging"
31760 .cindex "debugging" "enabling from an ACL"
31761 This control turns on debug logging, almost as though Exim had been invoked
31762 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31763 by default called &'debuglog'&.
31764
31765 Logging set up by the control will be maintained across spool residency.
31766
31767 Options are a slash-separated list.
31768 If an option takes an argument, the option name and argument are separated by
31769 an equals character.
31770 Several options are supported:
31771 .display
31772 tag=<&'suffix'&>         The filename can be adjusted with thise option.
31773                      The argument, which may access any variables already defined,
31774                      is appended to the default name.
31775
31776 opts=<&'debug&~options'&> The argument specififes what is to be logged,
31777                      using the same values as the &`-d`& command-line option.
31778
31779 stop                 Logging started with this control may be
31780                      stopped by using this option.
31781
31782 kill                 Logging started with this control may be
31783                      stopped by using this option.
31784                      Additionally the debug file will be removed,
31785                      providing one means for speculative debug tracing.
31786
31787 pretrigger=<&'size'&>    This option specifies a memory buffuer to be used
31788                      for pre-trigger debug capture.
31789                      Debug lines are recorded in the buffer until
31790                      and if) a trigger occurs; at which time they are
31791                      dumped to the debug file.  Newer lines displace the
31792                      oldest if the buffer is full.  After a trigger,
31793                      immediate writes to file are done as normal.
31794
31795 trigger=<&'reason'&>     This option selects cause for the pretrigger buffer
31796                      see above) to be copied to file.  A reason of &*now*&
31797                      take effect immediately; one of &*paniclog*& triggers
31798                      on a write to the panic log.
31799 .endd
31800
31801 Some examples (which depend on variables that don't exist in all
31802 contexts):
31803 .code
31804       control = debug
31805       control = debug/tag=.$sender_host_address
31806       control = debug/opts=+expand+acl
31807       control = debug/tag=.$message_exim_id/opts=+expand
31808       control = debug/kill
31809       control = debug/opts=+all/pretrigger=1024/trigger=paniclog
31810       control = debug/trigger=now
31811 .endd
31812
31813
31814 .vitem &*control&~=&~dkim_disable_verify*&
31815 .cindex "disable DKIM verify"
31816 .cindex "DKIM" "disable verify"
31817 This control turns off DKIM verification processing entirely.  For details on
31818 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31819
31820
31821 .vitem &*control&~=&~dmarc_disable_verify*&
31822 .cindex "disable DMARC verify"
31823 .cindex "DMARC" "disable verify"
31824 This control turns off DMARC verification processing entirely.  For details on
31825 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31826
31827
31828 .vitem &*control&~=&~dscp/*&<&'value'&>
31829 .cindex "&ACL;" "setting DSCP value"
31830 .cindex "DSCP" "inbound"
31831 This option causes the DSCP value associated with the socket for the inbound
31832 connection to be adjusted to a given value, given as one of a number of fixed
31833 strings or to numeric value.
31834 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31835 Common values include &`throughput`&, &`mincost`&, and on newer systems
31836 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31837
31838 The outbound packets from Exim will be marked with this value in the header
31839 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31840 that these values will have any effect, not be stripped by networking
31841 equipment, or do much of anything without cooperation with your Network
31842 Engineer and those of all network operators between the source and destination.
31843
31844
31845 .vitem &*control&~=&~enforce_sync*& &&&
31846        &*control&~=&~no_enforce_sync*&
31847 .cindex "SMTP" "synchronization checking"
31848 .cindex "synchronization checking in SMTP"
31849 These controls make it possible to be selective about when SMTP synchronization
31850 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31851 state of the switch (it is true by default). See the description of this option
31852 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31853
31854 The effect of these two controls lasts for the remainder of the SMTP
31855 connection. They can appear in any ACL except the one for the non-SMTP
31856 messages. The most straightforward place to put them is in the ACL defined by
31857 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31858 before the first synchronization check. The expected use is to turn off the
31859 synchronization checks for badly-behaved hosts that you nevertheless need to
31860 work with.
31861
31862
31863 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31864 .cindex "fake defer"
31865 .cindex "defer, fake"
31866 .cindex fakedefer
31867 This control works in exactly the same way as &%fakereject%& (described below)
31868 except that it causes an SMTP 450 response after the message data instead of a
31869 550 response. You must take care when using &%fakedefer%& because it causes the
31870 messages to be duplicated when the sender retries. Therefore, you should not
31871 use &%fakedefer%& if the message is to be delivered normally.
31872
31873 .vitem &*control&~=&~fakereject/*&<&'message'&>
31874 .cindex "fake rejection"
31875 .cindex "rejection, fake"
31876 .cindex fakereject
31877 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31878 words, only when an SMTP message is being received. If Exim accepts the
31879 message, instead the final 250 response, a 550 rejection message is sent.
31880 However, Exim proceeds to deliver the message as normal. The control applies
31881 only to the current message, not to any subsequent ones that may be received in
31882 the same SMTP connection.
31883
31884 The text for the 550 response is taken from the &%control%& modifier. If no
31885 message is supplied, the following is used:
31886 .code
31887 550-Your message has been rejected but is being
31888 550-kept for evaluation.
31889 550-If it was a legitimate message, it may still be
31890 550 delivered to the target recipient(s).
31891 .endd
31892 This facility should be used with extreme caution.
31893
31894 .vitem &*control&~=&~freeze*&
31895 .cindex "frozen messages" "forcing in ACL"
31896 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31897 other words, only when a message is being received. If the message is accepted,
31898 it is placed on Exim's queue and frozen. The control applies only to the
31899 current message, not to any subsequent ones that may be received in the same
31900 SMTP connection.
31901
31902 This modifier can optionally be followed by &`/no_tell`&. If the global option
31903 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31904 is told about the freezing), provided all the &*control=freeze*& modifiers that
31905 are obeyed for the current message have the &`/no_tell`& option.
31906
31907 .vitem &*control&~=&~no_delay_flush*&
31908 .cindex "SMTP" "output flushing, disabling for delay"
31909 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31910 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31911 use. This control, as long as it is encountered before the &%delay%& modifier,
31912 disables such output flushing.
31913
31914 .vitem &*control&~=&~no_callout_flush*&
31915 .cindex "SMTP" "output flushing, disabling for callout"
31916 Exim normally flushes SMTP output before performing a callout in an ACL, to
31917 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31918 use. This control, as long as it is encountered before the &%verify%& condition
31919 that causes the callout, disables such output flushing.
31920
31921 .vitem &*control&~=&~no_mbox_unspool*&
31922 This control is available when Exim is compiled with the content scanning
31923 extension. Content scanning may require a copy of the current message, or parts
31924 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31925 or spam scanner. Normally, such copies are deleted when they are no longer
31926 needed. If this control is set, the copies are not deleted. The control applies
31927 only to the current message, not to any subsequent ones that may be received in
31928 the same SMTP connection. It is provided for debugging purposes and is unlikely
31929 to be useful in production.
31930
31931 .vitem &*control&~=&~no_multiline_responses*&
31932 .cindex "multiline responses, suppressing"
31933 This control is permitted for any ACL except the one for non-SMTP messages.
31934 It seems that there are broken clients in use that cannot handle multiline
31935 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31936
31937 If this control is set, multiline SMTP responses from ACL rejections are
31938 suppressed. One way of doing this would have been to put out these responses as
31939 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31940 (&"use multiline responses for more"& it says &-- ha!), and some of the
31941 responses might get close to that. So this facility, which is after all only a
31942 sop to broken clients, is implemented by doing two very easy things:
31943
31944 .ilist
31945 Extra information that is normally output as part of a rejection caused by
31946 sender verification failure is omitted. Only the final line (typically &"sender
31947 verification failed"&) is sent.
31948 .next
31949 If a &%message%& modifier supplies a multiline response, only the first
31950 line is output.
31951 .endlist
31952
31953 The setting of the switch can, of course, be made conditional on the
31954 calling host. Its effect lasts until the end of the SMTP connection.
31955
31956 .vitem &*control&~=&~no_pipelining*&
31957 .cindex "PIPELINING" "suppressing advertising"
31958 .cindex "ESMTP extensions" PIPELINING
31959 This control turns off the advertising of the PIPELINING extension to SMTP in
31960 the current session. To be useful, it must be obeyed before Exim sends its
31961 response to an EHLO command. Therefore, it should normally appear in an ACL
31962 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31963 &%pipelining_advertise_hosts%&.
31964
31965 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31966        &*control&~=&~queue_only*&
31967 .oindex "&%queue%&"
31968 .oindex "&%queue_only%&"
31969 .cindex "queueing incoming messages"
31970 .cindex queueing "forcing in ACL"
31971 .cindex "first pass routing"
31972 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31973 other words, only when a message is being received. If the message is accepted,
31974 it is placed on Exim's queue and left there for delivery by a subsequent queue
31975 runner.
31976 If used with no options set,
31977 no immediate delivery process is started. In other words, it has the
31978 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31979
31980 If the &'first_pass_route'& option is given then
31981 the behaviour is like the command-line &'-oqds'& option;
31982 a delivery process is started which stops short of making
31983 any SMTP delivery.  The benefit is that the hints database will be updated for
31984 the message being waiting for a specific host, and a later queue run will be
31985 able to send all such messages on a single connection.
31986
31987 The control only applies to the current message, not to any subsequent ones that
31988  may be received in the same SMTP connection.
31989
31990 .vitem &*control&~=&~submission/*&<&'options'&>
31991 .cindex "message" "submission"
31992 .cindex "submission mode"
31993 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31994 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31995 the current message is a submission from a local MUA. In this case, Exim
31996 operates in &"submission mode"&, and applies certain fixups to the message if
31997 necessary. For example, it adds a &'Date:'& header line if one is not present.
31998 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31999 late (the message has already been created).
32000
32001 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
32002 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
32003 submission mode; the available options for this control are described there.
32004 The control applies only to the current message, not to any subsequent ones
32005 that may be received in the same SMTP connection.
32006
32007 .vitem &*control&~=&~suppress_local_fixups*&
32008 .cindex "submission fixups, suppressing"
32009 This control applies to locally submitted (non TCP/IP) messages, and is the
32010 complement of &`control = submission`&. It disables the fixups that are
32011 normally applied to locally-submitted messages. Specifically:
32012
32013 .ilist
32014 Any &'Sender:'& header line is left alone (in this respect, it is a
32015 dynamic version of &%local_sender_retain%&).
32016 .next
32017 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
32018 .next
32019 There is no check that &'From:'& corresponds to the actual sender.
32020 .endlist ilist
32021
32022 This control may be useful when a remotely-originated message is accepted,
32023 passed to some scanning program, and then re-submitted for delivery. It can be
32024 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32025 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
32026 data is read.
32027
32028 &*Note:*& This control applies only to the current message, not to any others
32029 that are being submitted at the same time using &%-bs%& or &%-bS%&.
32030
32031 .vitem &*control&~=&~utf8_downconvert*&
32032 This control enables conversion of UTF-8 in message envelope addresses
32033 to a-label form.
32034 For details see section &<<SECTi18nMTA>>&.
32035 .endlist vlist
32036
32037
32038 .section "Summary of message fixup control" "SECTsummesfix"
32039 All four possibilities for message fixups can be specified:
32040
32041 .ilist
32042 Locally submitted, fixups applied: the default.
32043 .next
32044 Locally submitted, no fixups applied: use
32045 &`control = suppress_local_fixups`&.
32046 .next
32047 Remotely submitted, no fixups applied: the default.
32048 .next
32049 Remotely submitted, fixups applied: use &`control = submission`&.
32050 .endlist
32051
32052
32053
32054 .section "Adding header lines in ACLs" "SECTaddheadacl"
32055 .cindex "header lines" "adding in an ACL"
32056 .cindex "header lines" "position of added lines"
32057 .cindex "&%add_header%& ACL modifier"
32058 The &%add_header%& modifier can be used to add one or more extra header lines
32059 to an incoming message, as in this example:
32060 .code
32061 warn dnslists = sbl.spamhaus.org : \
32062                 dialup.mail-abuse.org
32063      add_header = X-blacklisted-at: $dnslist_domain
32064 .endd
32065 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32066 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32067 receiving a message). The message must ultimately be accepted for
32068 &%add_header%& to have any significant effect. You can use &%add_header%& with
32069 any ACL verb, including &%deny%& (though this is potentially useful only in a
32070 RCPT ACL).
32071
32072 Headers will not be added to the message if the modifier is used in
32073 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32074
32075 Leading and trailing newlines are removed from
32076 the data for the &%add_header%& modifier; if it then
32077 contains one or more newlines that
32078 are not followed by a space or a tab, it is assumed to contain multiple header
32079 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
32080 front of any line that is not a valid header line.
32081
32082 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
32083 They are added to the message before processing the DATA and MIME ACLs.
32084 However, if an identical header line is requested more than once, only one copy
32085 is actually added to the message. Further header lines may be accumulated
32086 during the DATA and MIME ACLs, after which they are added to the message, again
32087 with duplicates suppressed. Thus, it is possible to add two identical header
32088 lines to an SMTP message, but only if one is added before DATA and one after.
32089 In the case of non-SMTP messages, new headers are accumulated during the
32090 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
32091 message is rejected after DATA or by the non-SMTP ACL, all added header lines
32092 are included in the entry that is written to the reject log.
32093
32094 .cindex "header lines" "added; visibility of"
32095 Header lines are not visible in string expansions
32096 of message headers
32097 until they are added to the
32098 message. It follows that header lines defined in the MAIL, RCPT, and predata
32099 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
32100 header lines that are added by the DATA or MIME ACLs are not visible in those
32101 ACLs. Because of this restriction, you cannot use header lines as a way of
32102 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
32103 this, you can use ACL variables, as described in section
32104 &<<SECTaclvariables>>&.
32105
32106 The list of headers yet to be added is given by the &%$headers_added%& variable.
32107
32108 The &%add_header%& modifier acts immediately as it is encountered during the
32109 processing of an ACL. Notice the difference between these two cases:
32110 .display
32111 &`accept add_header = ADDED: some text`&
32112 &`       `&<&'some condition'&>
32113
32114 &`accept `&<&'some condition'&>
32115 &`       add_header = ADDED: some text`&
32116 .endd
32117 In the first case, the header line is always added, whether or not the
32118 condition is true. In the second case, the header line is added only if the
32119 condition is true. Multiple occurrences of &%add_header%& may occur in the same
32120 ACL statement. All those that are encountered before a condition fails are
32121 honoured.
32122
32123 .cindex "&%warn%& ACL verb"
32124 For compatibility with previous versions of Exim, a &%message%& modifier for a
32125 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
32126 effect only if all the conditions are true, even if it appears before some of
32127 them. Furthermore, only the last occurrence of &%message%& is honoured. This
32128 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
32129 are present on a &%warn%& verb, both are processed according to their
32130 specifications.
32131
32132 By default, new header lines are added to a message at the end of the existing
32133 header lines. However, you can specify that any particular header line should
32134 be added right at the start (before all the &'Received:'& lines), immediately
32135 after the first block of &'Received:'& lines, or immediately before any line
32136 that is not a &'Received:'& or &'Resent-something:'& header.
32137
32138 This is done by specifying &":at_start:"&, &":after_received:"&, or
32139 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
32140 header line, respectively. (Header text cannot start with a colon, as there has
32141 to be a header name first.) For example:
32142 .code
32143 warn add_header = \
32144        :after_received:X-My-Header: something or other...
32145 .endd
32146 If more than one header line is supplied in a single &%add_header%& modifier,
32147 each one is treated independently and can therefore be placed differently. If
32148 you add more than one line at the start, or after the Received: block, they end
32149 up in reverse order.
32150
32151 &*Warning*&: This facility currently applies only to header lines that are
32152 added in an ACL. It does NOT work for header lines that are added in a
32153 system filter or in a router or transport.
32154
32155
32156
32157 .section "Removing header lines in ACLs" "SECTremoveheadacl"
32158 .cindex "header lines" "removing in an ACL"
32159 .cindex "header lines" "position of removed lines"
32160 .cindex "&%remove_header%& ACL modifier"
32161 The &%remove_header%& modifier can be used to remove one or more header lines
32162 from an incoming message, as in this example:
32163 .code
32164 warn   message        = Remove internal headers
32165        remove_header  = x-route-mail1 : x-route-mail2
32166 .endd
32167 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
32168 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
32169 receiving a message). The message must ultimately be accepted for
32170 &%remove_header%& to have any significant effect. You can use &%remove_header%&
32171 with any ACL verb, including &%deny%&, though this is really not useful for
32172 any verb that doesn't result in a delivered message.
32173
32174 Headers will not be removed from the message if the modifier is used in
32175 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
32176
32177 More than one header can be removed at the same time by using a colon separated
32178 list of header specifiers.
32179 If a specifier does not start with a circumflex (^)
32180 then it is treated as a header name.
32181 The header name matching is case insensitive.
32182 If it does, then it is treated as a (front-anchored)
32183 regular expression applied to the whole header.
32184
32185 &*Note*&: The colon terminating a header name will need to be doubled
32186 if used in an RE, and there can legitimately be whitepace before it.
32187
32188 Example:
32189 .code
32190 remove_header = \N^(?i)Authentication-Results\s*::\s*example.org;\N
32191 .endd
32192
32193 List expansion is not performed, so you cannot use hostlists to
32194 create a list of headers, however both connection and message variable expansion
32195 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
32196 .code
32197 warn   hosts           = +internal_hosts
32198        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
32199 warn   message         = Remove internal headers
32200        remove_header   = $acl_c_ihdrs
32201 .endd
32202 Header specifiers for removal are accumulated during the MAIL, RCPT, and predata ACLs.
32203 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
32204 If multiple header lines match, all are removed.
32205 There is no harm in attempting to remove the same header twice nor in removing
32206 a non-existent header. Further header specifiers for removal may be accumulated
32207 during the DATA and MIME ACLs, after which matching headers are removed
32208 if present. In the case of non-SMTP messages, remove specifiers are
32209 accumulated during the non-SMTP ACLs, and are acted on after
32210 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
32211 ACL, there really is no effect because there is no logging of what headers
32212 would have been removed.
32213
32214 .cindex "header lines" "removed; visibility of"
32215 Header lines are not visible in string expansions until the DATA phase when it
32216 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
32217 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
32218 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
32219 this restriction, you cannot use header lines as a way of controlling data
32220 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
32221 you should instead use ACL variables, as described in section
32222 &<<SECTaclvariables>>&.
32223
32224 The &%remove_header%& modifier acts immediately as it is encountered during the
32225 processing of an ACL. Notice the difference between these two cases:
32226 .display
32227 &`accept remove_header = X-Internal`&
32228 &`       `&<&'some condition'&>
32229
32230 &`accept `&<&'some condition'&>
32231 &`       remove_header = X-Internal`&
32232 .endd
32233 In the first case, the header line is always removed, whether or not the
32234 condition is true. In the second case, the header line is removed only if the
32235 condition is true. Multiple occurrences of &%remove_header%& may occur in the
32236 same ACL statement. All those that are encountered before a condition fails
32237 are honoured.
32238
32239 &*Warning*&: This facility currently applies only to header lines that are
32240 present during ACL processing. It does NOT remove header lines that are added
32241 in a system filter or in a router or transport.
32242
32243
32244
32245
32246 .section "ACL conditions" "SECTaclconditions"
32247 .cindex "&ACL;" "conditions; list of"
32248 Some of the conditions listed in this section are available only when Exim is
32249 compiled with the content-scanning extension. They are included here briefly
32250 for completeness. More detailed descriptions can be found in the discussion on
32251 content scanning in chapter &<<CHAPexiscan>>&.
32252
32253 Not all conditions are relevant in all circumstances. For example, testing
32254 senders and recipients does not make sense in an ACL that is being run as the
32255 result of the arrival of an ETRN command, and checks on message headers can be
32256 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
32257 can use the same condition (with different parameters) more than once in the
32258 same ACL statement. This provides a way of specifying an &"and"& conjunction.
32259 The conditions are as follows:
32260
32261
32262 .vlist
32263 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32264 .cindex "&ACL;" "nested"
32265 .cindex "&ACL;" "indirect"
32266 .cindex "&ACL;" "arguments"
32267 .cindex "&%acl%& ACL condition"
32268 The possible values of the argument are the same as for the
32269 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32270 &"accept"& the condition is true; if it returns &"deny"& the condition is
32271 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32272 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32273 condition false. This means that further processing of the &%warn%& verb
32274 ceases, but processing of the ACL continues.
32275
32276 If the argument is a named ACL, up to nine space-separated optional values
32277 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32278 and $acl_narg is set to the count of values.
32279 Previous values of these variables are restored after the call returns.
32280 The name and values are expanded separately.
32281 Note that spaces in complex expansions which are used as arguments
32282 will act as argument separators.
32283
32284 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32285 the connection is dropped. If it returns &"discard"&, the verb must be
32286 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32287 conditions are tested.
32288
32289 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32290 loops. This condition allows you to use different ACLs in different
32291 circumstances. For example, different ACLs can be used to handle RCPT commands
32292 for different local users or different local domains.
32293
32294 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32295 .cindex "&%authenticated%& ACL condition"
32296 .cindex "authentication" "ACL checking"
32297 .cindex "&ACL;" "testing for authentication"
32298 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32299 the name of the authenticator is tested against the list. To test for
32300 authentication by any authenticator, you can set
32301 .code
32302 authenticated = *
32303 .endd
32304
32305 .vitem &*condition&~=&~*&<&'string'&>
32306 .cindex "&%condition%& ACL condition"
32307 .cindex "customizing" "ACL condition"
32308 .cindex "&ACL;" "customized test"
32309 .cindex "&ACL;" "testing, customized"
32310 This feature allows you to make up custom conditions. If the result of
32311 expanding the string is an empty string, the number zero, or one of the strings
32312 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32313 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32314 any other value, some error is assumed to have occurred, and the ACL returns
32315 &"defer"&. However, if the expansion is forced to fail, the condition is
32316 ignored. The effect is to treat it as true, whether it is positive or
32317 negative.
32318
32319 .vitem &*decode&~=&~*&<&'location'&>
32320 .cindex "&%decode%& ACL condition"
32321 This condition is available only when Exim is compiled with the
32322 content-scanning extension, and it is allowed only in the ACL defined by
32323 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32324 If all goes well, the condition is true. It is false only if there are
32325 problems such as a syntax error or a memory shortage. For more details, see
32326 chapter &<<CHAPexiscan>>&.
32327
32328 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32329 .cindex "&%dnslists%& ACL condition"
32330 .cindex "DNS list" "in ACL"
32331 .cindex "black list (DNS)"
32332 .cindex "&ACL;" "testing a DNS list"
32333 This condition checks for entries in DNS black lists. These are also known as
32334 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32335 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32336 different variants of this condition to describe briefly here. See sections
32337 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32338
32339 .vitem &*domains&~=&~*&<&'domain&~list'&>
32340 .cindex "&%domains%& ACL condition"
32341 .cindex "domain" "ACL checking"
32342 .cindex "&ACL;" "testing a recipient domain"
32343 .vindex "&$domain_data$&"
32344 This condition is relevant only in a RCPT ACL. It checks that the domain
32345 of the recipient address is in the domain list. If percent-hack processing is
32346 enabled, it is done before this test is done. If the check succeeds with a
32347 lookup, the result of the lookup is placed in &$domain_data$& until the next
32348 &%domains%& test.
32349
32350 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32351 use &%domains%& in a DATA ACL.
32352
32353
32354 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32355 .cindex "&%encrypted%& ACL condition"
32356 .cindex "encryption" "checking in an ACL"
32357 .cindex "&ACL;" "testing for encryption"
32358 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32359 name of the cipher suite in use is tested against the list. To test for
32360 encryption without testing for any specific cipher suite(s), set
32361 .code
32362 encrypted = *
32363 .endd
32364
32365
32366 .vitem &*hosts&~=&~*&<&'host&~list'&>
32367 .cindex "&%hosts%& ACL condition"
32368 .cindex "host" "ACL checking"
32369 .cindex "&ACL;" "testing the client host"
32370 This condition tests that the calling host matches the host list. If you have
32371 name lookups or wildcarded host names and IP addresses in the same host list,
32372 you should normally put the IP addresses first. For example, you could have:
32373 .code
32374 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32375 .endd
32376 The lookup in this example uses the host name for its key. This is implied by
32377 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32378 and it wouldn't matter which way round you had these two items.)
32379
32380 The reason for the problem with host names lies in the left-to-right way that
32381 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32382 but when it reaches an item that requires a host name, it fails if it cannot
32383 find a host name to compare with the pattern. If the above list is given in the
32384 opposite order, the &%accept%& statement fails for a host whose name cannot be
32385 found, even if its IP address is 10.9.8.7.
32386
32387 If you really do want to do the name check first, and still recognize the IP
32388 address even if the name lookup fails, you can rewrite the ACL like this:
32389 .code
32390 accept hosts = dbm;/etc/friendly/hosts
32391 accept hosts = 10.9.8.7
32392 .endd
32393 The default action on failing to find the host name is to assume that the host
32394 is not in the list, so the first &%accept%& statement fails. The second
32395 statement can then check the IP address.
32396
32397 .vindex "&$host_data$&"
32398 If a &%hosts%& condition is satisfied by means of a lookup, the result
32399 of the lookup is made available in the &$host_data$& variable. This
32400 allows you, for example, to set up a statement like this:
32401 .code
32402 deny  hosts = net-lsearch;/some/file
32403       message = $host_data
32404 .endd
32405 which gives a custom error message for each denied host.
32406
32407 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32408 .cindex "&%local_parts%& ACL condition"
32409 .cindex "local part" "ACL checking"
32410 .cindex "&ACL;" "testing a local part"
32411 .vindex "&$local_part_data$&"
32412 This condition is relevant only in a RCPT ACL. It checks that the local
32413 part of the recipient address is in the list. If percent-hack processing is
32414 enabled, it is done before this test. If the check succeeds with a lookup, the
32415 result of the lookup is placed in &$local_part_data$&, which remains set until
32416 the next &%local_parts%& test.
32417
32418 .vitem &*malware&~=&~*&<&'option'&>
32419 .cindex "&%malware%& ACL condition"
32420 .cindex "&ACL;" "virus scanning"
32421 .cindex "&ACL;" "scanning for viruses"
32422 This condition is available only when Exim is compiled with the
32423 content-scanning extension
32424 and only after a DATA command.
32425 It causes the incoming message to be scanned for
32426 viruses. For details, see chapter &<<CHAPexiscan>>&.
32427
32428 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32429 .cindex "&%mime_regex%& ACL condition"
32430 .cindex "&ACL;" "testing by regex matching"
32431 This condition is available only when Exim is compiled with the
32432 content-scanning extension, and it is allowed only in the ACL defined by
32433 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32434 with any of the regular expressions. For details, see chapter
32435 &<<CHAPexiscan>>&.
32436
32437 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32438 .cindex "rate limiting"
32439 This condition can be used to limit the rate at which a user or host submits
32440 messages. Details are given in section &<<SECTratelimiting>>&.
32441
32442 .vitem &*recipients&~=&~*&<&'address&~list'&>
32443 .cindex "&%recipients%& ACL condition"
32444 .cindex "recipient" "ACL checking"
32445 .cindex "&ACL;" "testing a recipient"
32446 This condition is relevant only in a RCPT ACL. It checks the entire
32447 recipient address against a list of recipients.
32448
32449 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32450 .cindex "&%regex%& ACL condition"
32451 .cindex "&ACL;" "testing by regex matching"
32452 This condition is available only when Exim is compiled with the
32453 content-scanning extension, and is available only in the DATA, MIME, and
32454 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32455 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32456
32457 .vitem &*seen&~=&~*&<&'parameters'&>
32458 .cindex "&%seen%& ACL condition"
32459 This condition can be used to test if a situation has been previously met,
32460 for example for greylisting.
32461 Details are given in section &<<SECTseen>>&.
32462
32463 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32464 .cindex "&%sender_domains%& ACL condition"
32465 .cindex "sender" "ACL checking"
32466 .cindex "&ACL;" "testing a sender domain"
32467 .vindex "&$domain$&"
32468 .vindex "&$sender_address_domain$&"
32469 This condition tests the domain of the sender of the message against the given
32470 domain list. &*Note*&: The domain of the sender address is in
32471 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32472 of this condition. This is an exception to the general rule for testing domain
32473 lists. It is done this way so that, if this condition is used in an ACL for a
32474 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32475 influence the sender checking.
32476
32477 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32478 relaying, because sender addresses are easily, and commonly, forged.
32479
32480 .vitem &*senders&~=&~*&<&'address&~list'&>
32481 .cindex "&%senders%& ACL condition"
32482 .cindex "sender" "ACL checking"
32483 .cindex "&ACL;" "testing a sender"
32484 This condition tests the sender of the message against the given list. To test
32485 for a bounce message, which has an empty sender, set
32486 .code
32487 senders = :
32488 .endd
32489 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32490 relaying, because sender addresses are easily, and commonly, forged.
32491
32492 .vitem &*spam&~=&~*&<&'username'&>
32493 .cindex "&%spam%& ACL condition"
32494 .cindex "&ACL;" "scanning for spam"
32495 This condition is available only when Exim is compiled with the
32496 content-scanning extension. It causes the incoming message to be scanned by
32497 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32498
32499 .vitem &*verify&~=&~certificate*&
32500 .cindex "&%verify%& ACL condition"
32501 .cindex "TLS" "client certificate verification"
32502 .cindex "certificate" "verification of client"
32503 .cindex "&ACL;" "certificate verification"
32504 .cindex "&ACL;" "testing a TLS certificate"
32505 This condition is true in an SMTP session if the session is encrypted, and a
32506 certificate was received from the client, and the certificate was verified. The
32507 server requests a certificate only if the client matches &%tls_verify_hosts%&
32508 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32509
32510 .vitem &*verify&~=&~csa*&
32511 .cindex "CSA verification"
32512 This condition checks whether the sending host (the client) is authorized to
32513 send email. Details of how this works are given in section
32514 &<<SECTverifyCSA>>&.
32515
32516 .vitem &*verify&~=&~header_names_ascii*&
32517 .cindex "&%verify%& ACL condition"
32518 .cindex "&ACL;" "verifying header names only ASCII"
32519 .cindex "header lines" "verifying header names only ASCII"
32520 .cindex "verifying" "header names only ASCII"
32521 This condition is relevant only in an ACL that is run after a message has been
32522 received.
32523 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32524 It checks all header names (not the content) to make sure
32525 there are no non-ASCII characters, also excluding control characters.  The
32526 allowable characters are decimal ASCII values 33 through 126.
32527
32528 Exim itself will handle headers with non-ASCII characters, but it can cause
32529 problems for downstream applications, so this option will allow their
32530 detection and rejection in the DATA ACL's.
32531
32532 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32533 .cindex "&%verify%& ACL condition"
32534 .cindex "&ACL;" "verifying sender in the header"
32535 .cindex "header lines" "verifying the sender in"
32536 .cindex "sender" "verifying in header"
32537 .cindex "verifying" "sender in header"
32538 This condition is relevant only in an ACL that is run after a message has been
32539 received, that is, in an ACL specified by &%acl_smtp_data%& or
32540 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32541 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32542 is loosely thought of as a &"sender"& address (hence the name of the test).
32543 However, an address that appears in one of these headers need not be an address
32544 that accepts bounce messages; only sender addresses in envelopes are required
32545 to accept bounces. Therefore, if you use the callout option on this check, you
32546 might want to arrange for a non-empty address in the MAIL command.
32547
32548 Details of address verification and the options are given later, starting at
32549 section &<<SECTaddressverification>>& (callouts are described in section
32550 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32551 condition to restrict it to bounce messages only:
32552 .code
32553 deny    senders = :
32554        !verify  = header_sender
32555         message = A valid sender header is required for bounces
32556 .endd
32557
32558 .vitem &*verify&~=&~header_syntax*&
32559 .cindex "&%verify%& ACL condition"
32560 .cindex "&ACL;" "verifying header syntax"
32561 .cindex "header lines" "verifying syntax"
32562 .cindex "verifying" "header syntax"
32563 This condition is relevant only in an ACL that is run after a message has been
32564 received, that is, in an ACL specified by &%acl_smtp_data%& or
32565 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32566 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32567 and &'Bcc:'&), returning true if there are no problems.
32568 Unqualified addresses (local parts without domains) are
32569 permitted only in locally generated messages and from hosts that match
32570 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32571 appropriate.
32572
32573 Note that this condition is a syntax check only. However, a common spamming
32574 ploy used to be to send syntactically invalid headers such as
32575 .code
32576 To: @
32577 .endd
32578 and this condition can be used to reject such messages, though they are not as
32579 common as they used to be.
32580
32581 .vitem &*verify&~=&~helo*&
32582 .cindex "&%verify%& ACL condition"
32583 .cindex "&ACL;" "verifying HELO/EHLO"
32584 .cindex "HELO" "verifying"
32585 .cindex "EHLO" "verifying"
32586 .cindex "verifying" "EHLO"
32587 .cindex "verifying" "HELO"
32588 This condition is true if a HELO or EHLO command has been received from the
32589 client host, and its contents have been verified. If there has been no previous
32590 attempt to verify the HELO/EHLO contents, it is carried out when this
32591 condition is encountered. See the description of the &%helo_verify_hosts%& and
32592 &%helo_try_verify_hosts%& options for details of how to request verification
32593 independently of this condition, and for detail of the verification.
32594
32595 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32596 option), this condition is always true.
32597
32598
32599 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32600 .cindex "verifying" "not blind"
32601 .cindex "bcc recipients, verifying none"
32602 This condition checks that there are no blind (bcc) recipients in the message.
32603 Every envelope recipient must appear either in a &'To:'& header line or in a
32604 &'Cc:'& header line for this condition to be true. Local parts are checked
32605 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32606 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32607 used only in a DATA or non-SMTP ACL.
32608
32609 There is one possible option, &`case_insensitive`&.  If this is present then
32610 local parts are checked case-insensitively.
32611
32612 There are, of course, many legitimate messages that make use of blind (bcc)
32613 recipients. This check should not be used on its own for blocking messages.
32614
32615
32616 .vitem &*verify&~=&~recipient/*&<&'options'&>
32617 .cindex "&%verify%& ACL condition"
32618 .cindex "&ACL;" "verifying recipient"
32619 .cindex "recipient" "verifying"
32620 .cindex "verifying" "recipient"
32621 .vindex "&$address_data$&"
32622 This condition is relevant only after a RCPT command. It verifies the current
32623 recipient. Details of address verification are given later, starting at section
32624 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32625 of &$address_data$& is the last value that was set while routing the address.
32626 This applies even if the verification fails. When an address that is being
32627 verified is redirected to a single address, verification continues with the new
32628 address, and in that case, the subsequent value of &$address_data$& is the
32629 value for the child address.
32630
32631 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32632 .cindex "&%verify%& ACL condition"
32633 .cindex "&ACL;" "verifying host reverse lookup"
32634 .cindex "host" "verifying reverse lookup"
32635 This condition ensures that a verified host name has been looked up from the IP
32636 address of the client host. (This may have happened already if the host name
32637 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32638 Verification ensures that the host name obtained from a reverse DNS lookup, or
32639 one of its aliases, does, when it is itself looked up in the DNS, yield the
32640 original IP address.
32641
32642 There is one possible option, &`defer_ok`&.  If this is present and a
32643 DNS operation returns a temporary error, the verify condition succeeds.
32644
32645 If this condition is used for a locally generated message (that is, when there
32646 is no client host involved), it always succeeds.
32647
32648 .vitem &*verify&~=&~sender/*&<&'options'&>
32649 .cindex "&%verify%& ACL condition"
32650 .cindex "&ACL;" "verifying sender"
32651 .cindex "sender" "verifying"
32652 .cindex "verifying" "sender"
32653 This condition is relevant only after a MAIL or RCPT command, or after a
32654 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32655 the message's sender is empty (that is, this is a bounce message), the
32656 condition is true. Otherwise, the sender address is verified.
32657
32658 .vindex "&$address_data$&"
32659 .vindex "&$sender_address_data$&"
32660 If there is data in the &$address_data$& variable at the end of routing, its
32661 value is placed in &$sender_address_data$& at the end of verification. This
32662 value can be used in subsequent conditions and modifiers in the same ACL
32663 statement. It does not persist after the end of the current statement. If you
32664 want to preserve the value for longer, you can save it in an ACL variable.
32665
32666 Details of verification are given later, starting at section
32667 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32668 to avoid doing it more than once per message.
32669
32670 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32671 .cindex "&%verify%& ACL condition"
32672 This is a variation of the previous option, in which a modified address is
32673 verified as a sender.
32674
32675 Note that '/' is legal in local-parts; if the address may have such
32676 (eg. is generated from the received message)
32677 they must be protected from the options parsing by doubling:
32678 .code
32679 verify = sender=${listquote{/}{${address:$h_sender:}}}
32680 .endd
32681 .endlist
32682
32683
32684
32685 .section "Using DNS lists" "SECTmorednslists"
32686 .cindex "DNS list" "in ACL"
32687 .cindex "black list (DNS)"
32688 .cindex "&ACL;" "testing a DNS list"
32689 In its simplest form, the &%dnslists%& condition tests whether the calling host
32690 is on at least one of a number of DNS lists by looking up the inverted IP
32691 address in one or more DNS domains. (Note that DNS list domains are not mail
32692 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32693 special options instead.) For example, if the calling host's IP
32694 address is 192.168.62.43, and the ACL statement is
32695 .code
32696 deny dnslists = blackholes.mail-abuse.org : \
32697                 dialups.mail-abuse.org
32698 .endd
32699 the following records are looked up:
32700 .code
32701 43.62.168.192.blackholes.mail-abuse.org
32702 43.62.168.192.dialups.mail-abuse.org
32703 .endd
32704 As soon as Exim finds an existing DNS record, processing of the list stops.
32705 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32706 to test that a host is on more than one list (an &"and"& conjunction), you can
32707 use two separate conditions:
32708 .code
32709 deny dnslists = blackholes.mail-abuse.org
32710      dnslists = dialups.mail-abuse.org
32711 .endd
32712 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32713 behaves as if the host does not match the list item, that is, as if the DNS
32714 record does not exist. If there are further items in the DNS list, they are
32715 processed.
32716
32717 This is usually the required action when &%dnslists%& is used with &%deny%&
32718 (which is the most common usage), because it prevents a DNS failure from
32719 blocking mail. However, you can change this behaviour by putting one of the
32720 following special items in the list:
32721 .itable none 0 0 2 25* left 75* left
32722 .irow "+include_unknown"   "behave as if the item is on the list"
32723 .irow "+exclude_unknown"   "behave as if the item is not on the list (default)"
32724 .irow "+defer_unknown  "   "give a temporary error"
32725 .endtable
32726 .cindex "&`+include_unknown`&"
32727 .cindex "&`+exclude_unknown`&"
32728 .cindex "&`+defer_unknown`&"
32729 Each of these applies to any subsequent items on the list. For example:
32730 .code
32731 deny dnslists = +defer_unknown : foo.bar.example
32732 .endd
32733 Testing the list of domains stops as soon as a match is found. If you want to
32734 warn for one list and block for another, you can use two different statements:
32735 .code
32736 deny  dnslists = blackholes.mail-abuse.org
32737 warn  dnslists = dialups.mail-abuse.org
32738       message  = X-Warn: sending host is on dialups list
32739 .endd
32740 .cindex caching "of dns lookup"
32741 .cindex DNS TTL
32742 DNS list lookups are cached by Exim for the duration of the SMTP session
32743 (but limited by the DNS return TTL value),
32744 so a lookup based on the IP address is done at most once for any incoming
32745 connection (assuming long-enough TTL).
32746 Exim does not share information between multiple incoming
32747 connections (but your local name server cache should be active).
32748
32749 There are a number of DNS lists to choose from, some commercial, some free,
32750 or free for small deployments.  An overview can be found at
32751 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32752
32753
32754
32755 .subsection "Specifying the IP address for a DNS list lookup" SECID201
32756 .cindex "DNS list" "keyed by explicit IP address"
32757 By default, the IP address that is used in a DNS list lookup is the IP address
32758 of the calling host. However, you can specify another IP address by listing it
32759 after the domain name, introduced by a slash. For example:
32760 .code
32761 deny dnslists = black.list.tld/192.168.1.2
32762 .endd
32763 This feature is not very helpful with explicit IP addresses; it is intended for
32764 use with IP addresses that are looked up, for example, the IP addresses of the
32765 MX hosts or nameservers of an email sender address. For an example, see section
32766 &<<SECTmulkeyfor>>& below.
32767
32768
32769
32770
32771 .subsection "DNS lists keyed on domain names" SECID202
32772 .cindex "DNS list" "keyed by domain name"
32773 There are some lists that are keyed on domain names rather than inverted IP
32774 addresses (see, e.g., the &'domain based zones'& link at
32775 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32776 with these lists. You can change the name that is looked up in a DNS list by
32777 listing it after the domain name, introduced by a slash. For example,
32778 .code
32779 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32780       message  = Sender's domain is listed at $dnslist_domain
32781 .endd
32782 This particular example is useful only in ACLs that are obeyed after the
32783 RCPT or DATA commands, when a sender address is available. If (for
32784 example) the message's sender is &'user@tld.example'& the name that is looked
32785 up by this example is
32786 .code
32787 tld.example.dsn.rfc-ignorant.org
32788 .endd
32789 A single &%dnslists%& condition can contain entries for both names and IP
32790 addresses. For example:
32791 .code
32792 deny dnslists = sbl.spamhaus.org : \
32793                 dsn.rfc-ignorant.org/$sender_address_domain
32794 .endd
32795 The first item checks the sending host's IP address; the second checks a domain
32796 name. The whole condition is true if either of the DNS lookups succeeds.
32797
32798
32799
32800
32801 .subsection "Multiple explicit keys for a DNS list" SECTmulkeyfor
32802 .cindex "DNS list" "multiple keys for"
32803 The syntax described above for looking up explicitly-defined values (either
32804 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32805 name for the DNS list, what follows the slash can in fact be a list of items.
32806 As with all lists in Exim, the default separator is a colon. However, because
32807 this is a sublist within the list of DNS blacklist domains, it is necessary
32808 either to double the separators like this:
32809 .code
32810 dnslists = black.list.tld/name.1::name.2
32811 .endd
32812 or to change the separator character, like this:
32813 .code
32814 dnslists = black.list.tld/<;name.1;name.2
32815 .endd
32816 If an item in the list is an IP address, it is inverted before the DNS
32817 blacklist domain is appended. If it is not an IP address, no inversion
32818 occurs. Consider this condition:
32819 .code
32820 dnslists = black.list.tld/<;192.168.1.2;a.domain
32821 .endd
32822 The DNS lookups that occur are:
32823 .code
32824 2.1.168.192.black.list.tld
32825 a.domain.black.list.tld
32826 .endd
32827 Once a DNS record has been found (that matches a specific IP return
32828 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32829 are done. If there is a temporary DNS error, the rest of the sublist of domains
32830 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32831 only if no other DNS lookup in this sublist succeeds. In other words, a
32832 successful lookup for any of the items in the sublist overrides a temporary
32833 error for a previous item.
32834
32835 The ability to supply a list of items after the slash is in some sense just a
32836 syntactic convenience. These two examples have the same effect:
32837 .code
32838 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32839 dnslists = black.list.tld/a.domain::b.domain
32840 .endd
32841 However, when the data for the list is obtained from a lookup, the second form
32842 is usually much more convenient. Consider this example:
32843 .code
32844 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32845                                    ${lookup dnsdb {>|mxh=\
32846                                    $sender_address_domain} }} }
32847      message  = The mail servers for the domain \
32848                 $sender_address_domain \
32849                 are listed at $dnslist_domain ($dnslist_value); \
32850                 see $dnslist_text.
32851 .endd
32852 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32853 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32854 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32855 of expanding the condition might be something like this:
32856 .code
32857 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32858 .endd
32859 Thus, this example checks whether or not the IP addresses of the sender
32860 domain's mail servers are on the Spamhaus black list.
32861
32862 The key that was used for a successful DNS list lookup is put into the variable
32863 &$dnslist_matched$& (see section &<<SECID204>>&).
32864
32865
32866
32867
32868 .subsection "Data returned by DNS lists" SECID203
32869 .cindex "DNS list" "data returned from"
32870 DNS lists are constructed using address records in the DNS. The original RBL
32871 just used the address 127.0.0.1 on the right hand side of each record, but the
32872 RBL+ list and some other lists use a number of values with different meanings.
32873 The values used on the RBL+ list are:
32874 .itable none 0 0 2 20* left 80* left
32875 .irow 127.1.0.1  "RBL"
32876 .irow 127.1.0.2  "DUL"
32877 .irow 127.1.0.3  "DUL and RBL"
32878 .irow 127.1.0.4  "RSS"
32879 .irow 127.1.0.5  "RSS and RBL"
32880 .irow 127.1.0.6  "RSS and DUL"
32881 .irow 127.1.0.7  "RSS and DUL and RBL"
32882 .endtable
32883 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32884 different values. Some DNS lists may return more than one address record;
32885 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32886
32887 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32888 range. If a DNSBL operator loses control of the domain, lookups on it
32889 may start returning other addresses.  Because of this, Exim now ignores
32890 returned values outside the 127/8 region.
32891
32892
32893 .subsection "Variables set from DNS lists" SECID204
32894 .cindex "expansion" "variables, set from DNS list"
32895 .cindex "DNS list" "variables set from"
32896 .vindex "&$dnslist_domain$&"
32897 .vindex "&$dnslist_matched$&"
32898 .vindex "&$dnslist_text$&"
32899 .vindex "&$dnslist_value$&"
32900 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32901 the name of the overall domain that matched (for example,
32902 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32903 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32904 the DNS record. When the key is an IP address, it is not reversed in
32905 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32906 cases, for example:
32907 .code
32908 deny dnslists = spamhaus.example
32909 .endd
32910 the key is also available in another variable (in this case,
32911 &$sender_host_address$&). In more complicated cases, however, this is not true.
32912 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32913 might generate a dnslists lookup like this:
32914 .code
32915 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32916 .endd
32917 If this condition succeeds, the value in &$dnslist_matched$& might be
32918 &`192.168.6.7`& (for example).
32919
32920 If more than one address record is returned by the DNS lookup, all the IP
32921 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32922 The variable &$dnslist_text$& contains the contents of any associated TXT
32923 record. For lists such as RBL+ the TXT record for a merged entry is often not
32924 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32925 information.
32926
32927 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32928 &-- even if these appear before the condition in the ACL, they are not
32929 expanded until after it has failed. For example:
32930 .code
32931 deny    hosts = !+local_networks
32932         message = $sender_host_address is listed \
32933                   at $dnslist_domain
32934         dnslists = rbl-plus.mail-abuse.example
32935 .endd
32936
32937
32938
32939 .subsection "Additional matching conditions for DNS lists" SECTaddmatcon
32940 .cindex "DNS list" "matching specific returned data"
32941 You can add an equals sign and an IP address after a &%dnslists%& domain name
32942 in order to restrict its action to DNS records with a matching right hand side.
32943 For example,
32944 .code
32945 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32946 .endd
32947 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32948 any address record is considered to be a match. For the moment, we assume
32949 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32950 describes how multiple records are handled.
32951
32952 More than one IP address may be given for checking, using a comma as a
32953 separator. These are alternatives &-- if any one of them matches, the
32954 &%dnslists%& condition is true. For example:
32955 .code
32956 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32957 .endd
32958 If you want to specify a constraining address list and also specify names or IP
32959 addresses to be looked up, the constraining address list must be specified
32960 first. For example:
32961 .code
32962 deny dnslists = dsn.rfc-ignorant.org\
32963                 =127.0.0.2/$sender_address_domain
32964 .endd
32965
32966 If the character &`&&`& is used instead of &`=`&, the comparison for each
32967 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32968 In other words, the listed addresses are used as bit masks. The comparison is
32969 true if all the bits in the mask are present in the address that is being
32970 tested. For example:
32971 .code
32972 dnslists = a.b.c&0.0.0.3
32973 .endd
32974 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32975 want to test whether one bit or another bit is present (as opposed to both
32976 being present), you must use multiple values. For example:
32977 .code
32978 dnslists = a.b.c&0.0.0.1,0.0.0.2
32979 .endd
32980 matches if the final component of the address is an odd number or two times
32981 an odd number.
32982
32983
32984
32985 .subsection "Negated DNS matching conditions" SECID205
32986 You can supply a negative list of IP addresses as part of a &%dnslists%&
32987 condition. Whereas
32988 .code
32989 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32990 .endd
32991 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32992 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32993 .code
32994 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32995 .endd
32996 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32997 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32998 words, the result of the test is inverted if an exclamation mark appears before
32999 the &`=`& (or the &`&&`&) sign.
33000
33001 &*Note*&: This kind of negation is not the same as negation in a domain,
33002 host, or address list (which is why the syntax is different).
33003
33004 If you are using just one list, the negation syntax does not gain you much. The
33005 previous example is precisely equivalent to
33006 .code
33007 deny  dnslists = a.b.c
33008      !dnslists = a.b.c=127.0.0.2,127.0.0.3
33009 .endd
33010 However, if you are using multiple lists, the negation syntax is clearer.
33011 Consider this example:
33012 .code
33013 deny  dnslists = sbl.spamhaus.org : \
33014                  list.dsbl.org : \
33015                  dnsbl.njabl.org!=127.0.0.3 : \
33016                  relays.ordb.org
33017 .endd
33018 Using only positive lists, this would have to be:
33019 .code
33020 deny  dnslists = sbl.spamhaus.org : \
33021                  list.dsbl.org
33022 deny  dnslists = dnsbl.njabl.org
33023      !dnslists = dnsbl.njabl.org=127.0.0.3
33024 deny  dnslists = relays.ordb.org
33025 .endd
33026 which is less clear, and harder to maintain.
33027
33028 Negation can also be used with a bitwise-and restriction.
33029 The dnslists condition with only be trus if a result is returned
33030 by the lookup which, anded with the restriction, is all zeroes.
33031 For example:
33032 .code
33033 deny dnslists = zen.spamhaus.org!&0.255.255.0
33034 .endd
33035
33036
33037
33038
33039 .subsection "Handling multiple DNS records from a DNS list" SECThanmuldnsrec
33040 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
33041 thereby providing more than one IP address. When an item in a &%dnslists%& list
33042 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
33043 the match to specific results from the DNS lookup, there are two ways in which
33044 the checking can be handled. For example, consider the condition:
33045 .code
33046 dnslists = a.b.c=127.0.0.1
33047 .endd
33048 What happens if the DNS lookup for the incoming IP address yields both
33049 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
33050 condition true because at least one given value was found, or is it false
33051 because at least one of the found values was not listed? And how does this
33052 affect negated conditions? Both possibilities are provided for with the help of
33053 additional separators &`==`& and &`=&&`&.
33054
33055 .ilist
33056 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
33057 IP addresses matches one of the listed addresses. For the example above, the
33058 condition is true because 127.0.0.1 matches.
33059 .next
33060 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
33061 looked up IP addresses matches one of the listed addresses. If the condition is
33062 changed to:
33063 .code
33064 dnslists = a.b.c==127.0.0.1
33065 .endd
33066 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33067 false because 127.0.0.2 is not listed. You would need to have:
33068 .code
33069 dnslists = a.b.c==127.0.0.1,127.0.0.2
33070 .endd
33071 for the condition to be true.
33072 .endlist
33073
33074 When &`!`& is used to negate IP address matching, it inverts the result, giving
33075 the precise opposite of the behaviour above. Thus:
33076 .ilist
33077 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
33078 addresses matches one of the listed addresses. Consider:
33079 .code
33080 dnslists = a.b.c!&0.0.0.1
33081 .endd
33082 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33083 false because 127.0.0.1 matches.
33084 .next
33085 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
33086 looked up IP address that does not match. Consider:
33087 .code
33088 dnslists = a.b.c!=&0.0.0.1
33089 .endd
33090 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
33091 true, because 127.0.0.2 does not match. You would need to have:
33092 .code
33093 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
33094 .endd
33095 for the condition to be false.
33096 .endlist
33097 When the DNS lookup yields only a single IP address, there is no difference
33098 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
33099
33100
33101
33102
33103 .subsection "Detailed information from merged DNS lists" SECTmordetinf
33104 .cindex "DNS list" "information from merged"
33105 When the facility for restricting the matching IP values in a DNS list is used,
33106 the text from the TXT record that is set in &$dnslist_text$& may not reflect
33107 the true reason for rejection. This happens when lists are merged and the IP
33108 address in the A record is used to distinguish them; unfortunately there is
33109 only one TXT record. One way round this is not to use merged lists, but that
33110 can be inefficient because it requires multiple DNS lookups where one would do
33111 in the vast majority of cases when the host of interest is not on any of the
33112 lists.
33113
33114 A less inefficient way of solving this problem is available. If
33115 two domain names, comma-separated, are given, the second is used first to
33116 do an initial check, making use of any IP value restrictions that are set.
33117 If there is a match, the first domain is used, without any IP value
33118 restrictions, to get the TXT record. As a byproduct of this, there is also
33119 a check that the IP being tested is indeed on the first list. The first
33120 domain is the one that is put in &$dnslist_domain$&. For example:
33121 .code
33122 deny   dnslists = \
33123          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
33124          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33125        message  = \
33126          rejected because $sender_host_address is blacklisted \
33127          at $dnslist_domain\n$dnslist_text
33128 .endd
33129 For the first blacklist item, this starts by doing a lookup in
33130 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
33131 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
33132 value, and as long as something is found, it looks for the corresponding TXT
33133 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
33134 The second blacklist item is processed similarly.
33135
33136 If you are interested in more than one merged list, the same list must be
33137 given several times, but because the results of the DNS lookups are cached,
33138 the DNS calls themselves are not repeated. For example:
33139 .code
33140 deny dnslists = \
33141          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
33142          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
33143          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
33144          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
33145 .endd
33146 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
33147 values matches (or if no record is found), this is the only lookup that is
33148 done. Only if there is a match is one of the more specific lists consulted.
33149
33150
33151
33152 .subsection "DNS lists and IPv6" SECTmorednslistslast
33153 .cindex "IPv6" "DNS black lists"
33154 .cindex "DNS list" "IPv6 usage"
33155 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
33156 nibble by nibble. For example, if the calling host's IP address is
33157 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
33158 .code
33159 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
33160   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
33161 .endd
33162 (split over two lines here to fit on the page). Unfortunately, some of the DNS
33163 lists contain wildcard records, intended for IPv4, that interact badly with
33164 IPv6. For example, the DNS entry
33165 .code
33166 *.3.some.list.example.    A    127.0.0.1
33167 .endd
33168 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
33169 Unfortunately, it also matches the entire 3::/4 IPv6 network.
33170
33171 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
33172 &%condition%& condition, as in this example:
33173 .code
33174 deny   condition = ${if isip4{$sender_host_address}}
33175        dnslists  = some.list.example
33176 .endd
33177
33178 If an explicit key is being used for a DNS lookup and it may be an IPv6
33179 address you should specify alternate list separators for both the outer
33180 (DNS list name) list and inner (lookup keys) list:
33181 .code
33182        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
33183 .endd
33184
33185
33186 .section "Previously seen user and hosts" "SECTseen"
33187 .cindex "&%seen%& ACL condition"
33188 .cindex greylisting
33189 The &%seen%& ACL condition can be used to test whether a
33190 situation has been previously met.
33191 It uses a hints database to record a timestamp against a key.
33192 The syntax of the condition is:
33193 .display
33194 &`seen =`& <&'optional flag'&><&'time interval'&> &`/`& <&'options'&>
33195 .endd
33196
33197 For example,
33198 .code
33199 defer   seen = -5m / key=${sender_host_address}_$local_part@$domain
33200 .endd
33201 in a RCPT ACL will implement simple greylisting.
33202
33203 The parameters for the condition are
33204 a possible minus sign,
33205 then an interval,
33206 then, slash-separated, a list of options.
33207 The interval is taken as an offset before the current time,
33208 and used for the test.
33209 If the interval is preceded by a minus sign then the condition returns
33210 whether a record is found which is before the test time.
33211 Otherwise, the condition returns whether one is found which is since the
33212 test time.
33213
33214 Options are read in order with later ones overriding earlier ones.
33215
33216 The default key is &$sender_host_address$&.
33217 An explicit key can be set using a &%key=value%& option.
33218
33219 If a &%readonly%& option is given then
33220 no record create or update is done.
33221 If a &%write%& option is given then
33222 a record create or update is always done.
33223 An update is done if the test is for &"since"&.
33224 If none of those hold and there was no existing record,
33225 a record is created.
33226
33227 Creates and updates are marked with the current time.
33228
33229 Finally, a &"before"& test which succeeds, and for which the record
33230 is old enough, will be refreshed with a timestamp of the test time.
33231 This can prevent tidying of the database from removing the entry.
33232 The interval for this is, by default, 10 days.
33233 An explicit interval can be set using a
33234 &%refresh=value%& option.
33235
33236 Note that &"seen"& should be added to the list of hints databases
33237 for maintenance if this ACL condition is used.
33238
33239
33240 .section "Rate limiting incoming messages" "SECTratelimiting"
33241 .cindex "rate limiting" "client sending"
33242 .cindex "limiting client sending rates"
33243 .oindex "&%smtp_ratelimit_*%&"
33244 The &%ratelimit%& ACL condition can be used to measure and control the rate at
33245 which clients can send email. This is more powerful than the
33246 &%smtp_ratelimit_*%& options, because those options control the rate of
33247 commands in a single SMTP session only, whereas the &%ratelimit%& condition
33248 works across all connections (concurrent and sequential) from the same client
33249 host. The syntax of the &%ratelimit%& condition is:
33250 .display
33251 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
33252 .endd
33253 If the average client sending rate is less than &'m'& messages per time
33254 period &'p'& then the condition is false; otherwise it is true.
33255
33256 As a side-effect, the &%ratelimit%& condition sets the expansion variable
33257 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
33258 configured value of &'m'&, and &$sender_rate_period$& to the configured value
33259 of &'p'&.
33260
33261 The parameter &'p'& is the smoothing time constant, in the form of an Exim
33262 time interval, for example, &`8h`& for eight hours. A larger time constant
33263 means that it takes Exim longer to forget a client's past behaviour. The
33264 parameter &'m'& is the maximum number of messages that a client is permitted to
33265 send in each time interval. It also specifies the number of messages permitted
33266 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
33267 constant, you can allow a client to send more messages in a burst without
33268 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
33269 both small, messages must be sent at an even rate.
33270
33271 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
33272 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
33273 when deploying the &%ratelimit%& ACL condition. The script prints usage
33274 instructions when it is run with no arguments.
33275
33276 The key is used to look up the data for calculating the client's average
33277 sending rate. This data is stored in Exim's spool directory, alongside the
33278 retry and other hints databases. The default key is &$sender_host_address$&,
33279 which means Exim computes the sending rate of each client host IP address.
33280 By changing the key you can change how Exim identifies clients for the purpose
33281 of ratelimiting. For example, to limit the sending rate of each authenticated
33282 user, independent of the computer they are sending from, set the key to
33283 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
33284 example, &$authenticated_id$& is only meaningful if the client has
33285 authenticated (which you can check with the &%authenticated%& ACL condition).
33286
33287 The lookup key does not have to identify clients: If you want to limit the
33288 rate at which a recipient receives messages, you can use the key
33289 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
33290 ACL.
33291
33292 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
33293 specifies what Exim measures the rate of, for example, messages or recipients
33294 or bytes. You can adjust the measurement using the &%unique=%& and/or
33295 &%count=%& options. You can also control when Exim updates the recorded rate
33296 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
33297 separated by a slash, like the other parameters. They may appear in any order.
33298
33299 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
33300 any options that alter the meaning of the stored data. The limit &'m'& is not
33301 stored, so you can alter the configured maximum rate and Exim will still
33302 remember clients' past behaviour. If you change the &%per_*%& mode or add or
33303 remove the &%unique=%& option, the lookup key changes so Exim will forget past
33304 behaviour. The lookup key is not affected by changes to the update mode and
33305 the &%count=%& option.
33306
33307
33308 .subsection "Ratelimit options for what is being measured" ratoptmea
33309 .cindex "rate limiting" "per_* options"
33310 .vlist
33311 .vitem per_conn
33312 .cindex "rate limiting" per_conn
33313 This option limits the client's connection rate. It is not
33314 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
33315 &%acl_not_smtp_start%& ACLs.
33316
33317 .vitem per_mail
33318 .cindex "rate limiting" per_conn
33319 This option limits the client's rate of sending messages. This is
33320 the default if none of the &%per_*%& options is specified. It can be used in
33321 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
33322 &%acl_smtp_data%&, or &%acl_not_smtp%&.
33323
33324 .vitem per_byte
33325 .cindex "rate limiting" per_conn
33326 This option limits the sender's email bandwidth. It can be used in
33327 the same ACLs as the &%per_mail%& option, though it is best to use this option
33328 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
33329 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
33330 in its MAIL command, which may be inaccurate or completely missing. You can
33331 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33332 in kilobytes, megabytes, or gigabytes, respectively.
33333
33334 .vitem per_rcpt
33335 .cindex "rate limiting" per_rcpt
33336 This option causes Exim to limit the rate at which recipients are
33337 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33338 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33339 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33340 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33341 in either case the rate limiting engine will see a message with many
33342 recipients as a large high-speed burst.
33343
33344 .vitem per_addr
33345 .cindex "rate limiting" per_addr
33346 This option is like the &%per_rcpt%& option, except it counts the
33347 number of different recipients that the client has sent messages to in the
33348 last time period. That is, if the client repeatedly sends messages to the same
33349 recipient, its measured rate is not increased. This option can only be used in
33350 &%acl_smtp_rcpt%&.
33351
33352 .vitem per_cmd
33353 .cindex "rate limiting" per_cmd
33354 This option causes Exim to recompute the rate every time the
33355 condition is processed. This can be used to limit the rate of any SMTP
33356 command. If it is used in multiple ACLs it can limit the aggregate rate of
33357 multiple different commands.
33358
33359 .vitem count
33360 .cindex "rate limiting" count
33361 This option can be used to alter how much Exim adds to the client's
33362 measured rate.
33363 A value is required, after an equals sign.
33364 For example, the &%per_byte%& option is equivalent to
33365 &`per_mail/count=$message_size`&.
33366 If there is no &%count=%& option, Exim
33367 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33368 other than &%acl_smtp_rcpt%&).
33369 The count does not have to be an integer.
33370
33371 .vitem unique
33372 .cindex "rate limiting" unique
33373 This option is described in section &<<ratoptuniq>>& below.
33374 .endlist
33375
33376
33377 .subsection "Ratelimit update modes" ratoptupd
33378 .cindex "rate limiting" "reading data without updating"
33379 You can specify one of three options with the &%ratelimit%& condition to
33380 control when its database is updated. This section describes the &%readonly%&
33381 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33382
33383 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33384 previously-computed rate to check against the limit.
33385
33386 For example, you can test the client's sending rate and deny it access (when
33387 it is too fast) in the connect ACL. If the client passes this check then it
33388 can go on to send a message, in which case its recorded rate will be updated
33389 in the MAIL ACL. Subsequent connections from the same client will check this
33390 new rate.
33391 .code
33392 acl_check_connect:
33393  deny ratelimit = 100 / 5m / readonly
33394       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33395                   (max $sender_rate_limit)
33396 # ...
33397 acl_check_mail:
33398  warn ratelimit = 100 / 5m / strict
33399       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33400                   (max $sender_rate_limit)
33401 .endd
33402
33403 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33404 processing a message then it may increase the client's measured rate more than
33405 it should. For example, this will happen if you check the &%per_rcpt%& option
33406 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33407 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33408 multiple update problems by using the &%readonly%& option on later ratelimit
33409 checks.
33410
33411 The &%per_*%& options described above do not make sense in some ACLs. If you
33412 use a &%per_*%& option in an ACL where it is not normally permitted then the
33413 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33414 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33415 next section) so you must specify the &%readonly%& option explicitly.
33416
33417
33418 .subsection "Ratelimit options for handling fast clients" ratoptfast
33419 .cindex "rate limiting" "strict and leaky modes"
33420 If a client's average rate is greater than the maximum, the rate limiting
33421 engine can react in two possible ways, depending on the presence of the
33422 &%strict%& or &%leaky%& update modes. This is independent of the other
33423 counter-measures (such as rejecting the message) that may be specified by the
33424 rest of the ACL.
33425
33426 The &%leaky%& (default) option means that the client's recorded rate is not
33427 updated if it is above the limit. The effect of this is that Exim measures the
33428 client's average rate of successfully sent email,
33429 up to the given limit.
33430 This is appropriate if the countermeasure when the condition is true
33431 consists of refusing the message, and
33432 is generally the better choice if you have clients that retry automatically.
33433 If the action when true is anything more complex then this option is
33434 likely not what is wanted.
33435
33436 The &%strict%& option means that the client's recorded rate is always
33437 updated. The effect of this is that Exim measures the client's average rate
33438 of attempts to send email, which can be much higher than the maximum it is
33439 actually allowed. If the client is over the limit it may be subjected to
33440 counter-measures by the ACL. It must slow down and allow sufficient time to
33441 pass that its computed rate falls below the maximum before it can send email
33442 again. The time (the number of smoothing periods) it must wait and not
33443 attempt to send mail can be calculated with this formula:
33444 .code
33445         ln(peakrate/maxrate)
33446 .endd
33447
33448
33449 .subsection "Limiting the rate of different events" ratoptuniq
33450 .cindex "rate limiting" "counting unique events"
33451 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33452 rate of different events. For example, the &%per_addr%& option uses this
33453 mechanism to count the number of different recipients that the client has
33454 sent messages to in the last time period; it is equivalent to
33455 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33456 measure the rate that a client uses different sender addresses with the
33457 options &`per_mail/unique=$sender_address`&.
33458
33459 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33460 has seen for that key. The whole set is thrown away when it is older than the
33461 rate smoothing period &'p'&, so each different event is counted at most once
33462 per period. In the &%leaky%& update mode, an event that causes the client to
33463 go over the limit is not added to the set, in the same way that the client's
33464 recorded rate is not updated in the same situation.
33465
33466 When you combine the &%unique=%& and &%readonly%& options, the specific
33467 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33468 rate.
33469
33470 The &%unique=%& mechanism needs more space in the ratelimit database than the
33471 other &%ratelimit%& options in order to store the event set. The number of
33472 unique values is potentially as large as the rate limit, so the extra space
33473 required increases with larger limits.
33474
33475 The uniqueification is not perfect: there is a small probability that Exim
33476 will think a new event has happened before. If the sender's rate is less than
33477 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33478 the measured rate can go above the limit, in which case Exim may under-count
33479 events by a significant margin. Fortunately, if the rate is high enough (2.7
33480 times the limit) that the false positive rate goes above 9%, then Exim will
33481 throw away the over-full event set before the measured rate falls below the
33482 limit. Therefore the only harm should be that exceptionally high sending rates
33483 are logged incorrectly; any countermeasures you configure will be as effective
33484 as intended.
33485
33486
33487 .subsection "Using rate limiting" useratlim
33488 Exim's other ACL facilities are used to define what counter-measures are taken
33489 when the rate limit is exceeded. This might be anything from logging a warning
33490 (for example, while measuring existing sending rates in order to define
33491 policy), through time delays to slow down fast senders, up to rejecting the
33492 message. For example:
33493 .code
33494 # Log all senders' rates
33495 warn ratelimit = 0 / 1h / strict
33496      log_message = Sender rate $sender_rate / $sender_rate_period
33497
33498 # Slow down fast senders; note the need to truncate $sender_rate
33499 # at the decimal point.
33500 warn ratelimit = 100 / 1h / per_rcpt / strict
33501      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33502                    $sender_rate_limit }s
33503
33504 # Keep authenticated users under control
33505 deny authenticated = *
33506      ratelimit = 100 / 1d / strict / $authenticated_id
33507
33508 # System-wide rate limit
33509 defer ratelimit = 10 / 1s / $primary_hostname
33510       message = Sorry, too busy. Try again later.
33511
33512 # Restrict incoming rate from each host, with a default
33513 # set using a macro and special cases looked up in a table.
33514 defer ratelimit = ${lookup {$sender_host_address} \
33515                    cdb {DB/ratelimits.cdb} \
33516                    {$value} {RATELIMIT} }
33517       message = Sender rate exceeds $sender_rate_limit \
33518                messages per $sender_rate_period
33519 .endd
33520 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33521 especially with the &%per_rcpt%& option, you may suffer from a performance
33522 bottleneck caused by locking on the ratelimit hints database. Apart from
33523 making your ACLs less complicated, you can reduce the problem by using a
33524 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33525 this means that Exim will lose its hints data after a reboot (including retry
33526 hints, the callout cache, and ratelimit data).
33527
33528
33529
33530 .section "Address verification" "SECTaddressverification"
33531 .cindex "verifying address" "options for"
33532 .cindex "policy control" "address verification"
33533 Several of the &%verify%& conditions described in section
33534 &<<SECTaclconditions>>& cause addresses to be verified. Section
33535 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33536 The verification conditions can be followed by options that modify the
33537 verification process. The options are separated from the keyword and from each
33538 other by slashes, and some of them contain parameters. For example:
33539 .code
33540 verify = sender/callout
33541 verify = recipient/defer_ok/callout=10s,defer_ok
33542 .endd
33543 The first stage of address verification, which always happens, is to run the
33544 address through the routers, in &"verify mode"&. Routers can detect the
33545 difference between verification and routing for delivery, and their actions can
33546 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33547 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33548 The available options are as follows:
33549
33550 .ilist
33551 If the &%callout%& option is specified, successful routing to one or more
33552 remote hosts is followed by a &"callout"& to those hosts as an additional
33553 check. Callouts and their sub-options are discussed in the next section.
33554 .next
33555 If there is a defer error while doing verification routing, the ACL
33556 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33557 options, the condition is forced to be true instead. Note that this is a main
33558 verification option as well as a suboption for callouts.
33559 .next
33560 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33561 discusses the reporting of sender address verification failures.
33562 .next
33563 The &%success_on_redirect%& option causes verification always to succeed
33564 immediately after a successful redirection. By default, if a redirection
33565 generates just one address, that address is also verified. See further
33566 discussion in section &<<SECTredirwhilveri>>&.
33567 .next
33568 If the &%quota%& option is specified for recipient verify,
33569 successful routing to an appendfile transport is followed by a call into
33570 the transport to evaluate the quota status for the recipient.
33571 No actual delivery is done, but verification will succeed if the quota
33572 is sufficient for the message (if the sender gave a message size) or
33573 not already exceeded (otherwise).
33574 .endlist
33575
33576 .cindex "verifying address" "differentiating failures"
33577 .vindex "&$recipient_verify_failure$&"
33578 .vindex "&$sender_verify_failure$&"
33579 .vindex "&$acl_verify_message$&"
33580 After an address verification failure, &$acl_verify_message$& contains the
33581 error message that is associated with the failure. It can be preserved by
33582 coding like this:
33583 .code
33584 warn  !verify = sender
33585        set acl_m0 = $acl_verify_message
33586 .endd
33587 If you are writing your own custom rejection message or log message when
33588 denying access, you can use this variable to include information about the
33589 verification failure.
33590 This variable is cleared at the end of processing the ACL verb.
33591
33592 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33593 appropriate) contains one of the following words:
33594
33595 .ilist
33596 &%qualify%&: The address was unqualified (no domain), and the message
33597 was neither local nor came from an exempted host.
33598 .next
33599 &%route%&: Routing failed.
33600 .next
33601 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33602 occurred at or before the MAIL command (that is, on initial
33603 connection, HELO, or MAIL).
33604 .next
33605 &%recipient%&: The RCPT command in a callout was rejected.
33606 .next
33607 &%postmaster%&: The postmaster check in a callout was rejected.
33608 .next
33609 &%quota%&: The quota check for a local recipient did non pass.
33610 .endlist
33611
33612 The main use of these variables is expected to be to distinguish between
33613 rejections of MAIL and rejections of RCPT in callouts.
33614
33615 The above variables may also be set after a &*successful*&
33616 address verification to:
33617
33618 .ilist
33619 &%random%&: A random local-part callout succeeded
33620 .endlist
33621
33622
33623
33624
33625 .section "Callout verification" "SECTcallver"
33626 .cindex "verifying address" "by callout"
33627 .cindex "callout" "verification"
33628 .cindex "SMTP" "callout verification"
33629 For non-local addresses, routing verifies the domain, but is unable to do any
33630 checking of the local part. There are situations where some means of verifying
33631 the local part is desirable. One way this can be done is to make an SMTP
33632 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33633 a subsequent host for a recipient address, to see if the host accepts the
33634 address. We use the term &'callout'& to cover both cases. Note that for a
33635 sender address, the callback is not to the client host that is trying to
33636 deliver the message, but to one of the hosts that accepts incoming mail for the
33637 sender's domain.
33638
33639 Exim does not do callouts by default. If you want them to happen, you must
33640 request them by setting appropriate options on the &%verify%& condition, as
33641 described below. This facility should be used with care, because it can add a
33642 lot of resource usage to the cost of verifying an address. However, Exim does
33643 cache the results of callouts, which helps to reduce the cost. Details of
33644 caching are in section &<<SECTcallvercache>>&.
33645
33646 Recipient callouts are usually used only between hosts that are controlled by
33647 the same administration. For example, a corporate gateway host could use
33648 callouts to check for valid recipients on an internal mailserver. A successful
33649 callout does not guarantee that a real delivery to the address would succeed;
33650 on the other hand, a failing callout does guarantee that a delivery would fail.
33651
33652 If the &%callout%& option is present on a condition that verifies an address, a
33653 second stage of verification occurs if the address is successfully routed to
33654 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33655 &(manualroute)& router, where the router specifies the hosts. However, if a
33656 router that does not set up hosts routes to an &(smtp)& transport with a
33657 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33658 &%hosts_override%& set, its hosts are always used, whether or not the router
33659 supplies a host list.
33660 Callouts are only supported on &(smtp)& transports.
33661
33662 The port that is used is taken from the transport, if it is specified and is a
33663 remote transport. (For routers that do verification only, no transport need be
33664 specified.) Otherwise, the default SMTP port is used. If a remote transport
33665 specifies an outgoing interface, this is used; otherwise the interface is not
33666 specified. Likewise, the text that is used for the HELO command is taken from
33667 the transport's &%helo_data%& option; if there is no transport, the value of
33668 &$smtp_active_hostname$& is used.
33669
33670 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33671 test whether a bounce message could be delivered to the sender address. The
33672 following SMTP commands are sent:
33673 .display
33674 &`HELO `&<&'local host name'&>
33675 &`MAIL FROM:<>`&
33676 &`RCPT TO:`&<&'the address to be tested'&>
33677 &`QUIT`&
33678 .endd
33679 LHLO is used instead of HELO if the transport's &%protocol%& option is
33680 set to &"lmtp"&.
33681
33682 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33683 settings.
33684
33685 A recipient callout check is similar. By default, it also uses an empty address
33686 for the sender. This default is chosen because most hosts do not make use of
33687 the sender address when verifying a recipient. Using the same address means
33688 that a single cache entry can be used for each recipient. Some sites, however,
33689 do make use of the sender address when verifying. These are catered for by the
33690 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33691
33692 If the response to the RCPT command is a 2&'xx'& code, the verification
33693 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33694 Exim tries the next host, if any. If there is a problem with all the remote
33695 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33696 &%callout%& option is given, in which case the condition is forced to succeed.
33697
33698 .cindex "SMTP" "output flushing, disabling for callout"
33699 A callout may take a little time. For this reason, Exim normally flushes SMTP
33700 output before performing a callout in an ACL, to avoid unexpected timeouts in
33701 clients when the SMTP PIPELINING extension is in use. The flushing can be
33702 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33703
33704 .cindex "tainted data" "de-tainting"
33705 .cindex "de-tainting" "using recipient verify"
33706 A recipient callout which gets a 2&'xx'& code
33707 will assign untainted values to the
33708 &$domain_data$& and &$local_part_data$& variables,
33709 corresponding to the domain and local parts of the recipient address.
33710
33711
33712
33713
33714 .subsection "Additional parameters for callouts" CALLaddparcall
33715 .cindex "callout" "additional parameters for"
33716 The &%callout%& option can be followed by an equals sign and a number of
33717 optional parameters, separated by commas. For example:
33718 .code
33719 verify = recipient/callout=10s,defer_ok
33720 .endd
33721 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33722 separate verify options, is retained for backwards compatibility, but is now
33723 deprecated. The additional parameters for &%callout%& are as follows:
33724
33725
33726 .vlist
33727 .vitem <&'a&~time&~interval'&>
33728 .cindex "callout" "timeout, specifying"
33729 This specifies the timeout that applies for the callout attempt to each host.
33730 For example:
33731 .code
33732 verify = sender/callout=5s
33733 .endd
33734 The default is 30 seconds. The timeout is used for each response from the
33735 remote host. It is also used for the initial connection, unless overridden by
33736 the &%connect%& parameter.
33737
33738
33739 .vitem &*connect&~=&~*&<&'time&~interval'&>
33740 .cindex "callout" "connection timeout, specifying"
33741 This parameter makes it possible to set a different (usually smaller) timeout
33742 for making the SMTP connection. For example:
33743 .code
33744 verify = sender/callout=5s,connect=1s
33745 .endd
33746 If not specified, this timeout defaults to the general timeout value.
33747
33748 .vitem &*defer_ok*&
33749 .cindex "callout" "defer, action on"
33750 When this parameter is present, failure to contact any host, or any other kind
33751 of temporary error, is treated as success by the ACL. However, the cache is not
33752 updated in this circumstance.
33753
33754 .vitem &*fullpostmaster*&
33755 .cindex "callout" "full postmaster check"
33756 This operates like the &%postmaster%& option (see below), but if the check for
33757 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33758 accordance with the specification in RFC 2821. The RFC states that the
33759 unqualified address &'postmaster'& should be accepted.
33760
33761
33762 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33763 .cindex "callout" "sender when verifying header"
33764 When verifying addresses in header lines using the &%header_sender%&
33765 verification option, Exim behaves by default as if the addresses are envelope
33766 sender addresses from a message. Callout verification therefore tests to see
33767 whether a bounce message could be delivered, by using an empty address in the
33768 MAIL command. However, it is arguable that these addresses might never be used
33769 as envelope senders, and could therefore justifiably reject bounce messages
33770 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33771 address to use in the MAIL command. For example:
33772 .code
33773 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33774 .endd
33775 This parameter is available only for the &%header_sender%& verification option.
33776
33777
33778 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33779 .cindex "callout" "overall timeout, specifying"
33780 This parameter sets an overall timeout for performing a callout verification.
33781 For example:
33782 .code
33783 verify = sender/callout=5s,maxwait=30s
33784 .endd
33785 This timeout defaults to four times the callout timeout for individual SMTP
33786 commands. The overall timeout applies when there is more than one host that can
33787 be tried. The timeout is checked before trying the next host. This prevents
33788 very long delays if there are a large number of hosts and all are timing out
33789 (for example, when network connections are timing out).
33790
33791
33792 .vitem &*no_cache*&
33793 .cindex "callout" "cache, suppressing"
33794 .cindex "caching callout, suppressing"
33795 When this parameter is given, the callout cache is neither read nor updated.
33796
33797 .vitem &*postmaster*&
33798 .cindex "callout" "postmaster; checking"
33799 When this parameter is set, a successful callout check is followed by a similar
33800 check for the local part &'postmaster'& at the same domain. If this address is
33801 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33802 the postmaster check is recorded in a cache record; if it is a failure, this is
33803 used to fail subsequent callouts for the domain without a connection being
33804 made, until the cache record expires.
33805
33806 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33807 The postmaster check uses an empty sender in the MAIL command by default.
33808 You can use this parameter to do a postmaster check using a different address.
33809 For example:
33810 .code
33811 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33812 .endd
33813 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33814 one overrides. The &%postmaster%& parameter is equivalent to this example:
33815 .code
33816 require  verify = sender/callout=postmaster_mailfrom=
33817 .endd
33818 &*Warning*&: The caching arrangements for postmaster checking do not take
33819 account of the sender address. It is assumed that either the empty address or
33820 a fixed non-empty address will be used. All that Exim remembers is that the
33821 postmaster check for the domain succeeded or failed.
33822
33823
33824 .vitem &*random*&
33825 .cindex "callout" "&""random""& check"
33826 When this parameter is set, before doing the normal callout check, Exim does a
33827 check for a &"random"& local part at the same domain. The local part is not
33828 really random &-- it is defined by the expansion of the option
33829 &%callout_random_local_part%&, which defaults to
33830 .code
33831 $primary_hostname-$tod_epoch-testing
33832 .endd
33833 The idea here is to try to determine whether the remote host accepts all local
33834 parts without checking. If it does, there is no point in doing callouts for
33835 specific local parts. If the &"random"& check succeeds, the result is saved in
33836 a cache record, and used to force the current and subsequent callout checks to
33837 succeed without a connection being made, until the cache record expires.
33838
33839 .vitem &*use_postmaster*&
33840 .cindex "callout" "sender for recipient check"
33841 This parameter applies to recipient callouts only. For example:
33842 .code
33843 deny  !verify = recipient/callout=use_postmaster
33844 .endd
33845 .vindex "&$qualify_domain$&"
33846 It causes a non-empty postmaster address to be used in the MAIL command when
33847 performing the callout for the recipient, and also for a &"random"& check if
33848 that is configured. The local part of the address is &`postmaster`& and the
33849 domain is the contents of &$qualify_domain$&.
33850
33851 .vitem &*use_sender*&
33852 This option applies to recipient callouts only. For example:
33853 .code
33854 require  verify = recipient/callout=use_sender
33855 .endd
33856 It causes the message's actual sender address to be used in the MAIL
33857 command when performing the callout, instead of an empty address. There is no
33858 need to use this option unless you know that the called hosts make use of the
33859 sender when checking recipients. If used indiscriminately, it reduces the
33860 usefulness of callout caching.
33861
33862 .vitem &*hold*&
33863 This option applies to recipient callouts only. For example:
33864 .code
33865 require  verify = recipient/callout=use_sender,hold
33866 .endd
33867 It causes the connection to be held open and used for any further recipients
33868 and for eventual delivery (should that be done quickly).
33869 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33870 when that is used for the connections.
33871 The advantage is only gained if there are no callout cache hits
33872 (which could be enforced by the no_cache option),
33873 if the use_sender option is used,
33874 if neither the random nor the use_postmaster option is used,
33875 and if no other callouts intervene.
33876 .endlist
33877
33878 If you use any of the parameters that set a non-empty sender for the MAIL
33879 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33880 &%use_sender%&), you should think about possible loops. Recipient checking is
33881 usually done between two hosts that are under the same management, and the host
33882 that receives the callouts is not normally configured to do callouts itself.
33883 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33884 these circumstances.
33885
33886 However, if you use a non-empty sender address for a callout to an arbitrary
33887 host, there is the likelihood that the remote host will itself initiate a
33888 callout check back to your host. As it is checking what appears to be a message
33889 sender, it is likely to use an empty address in MAIL, thus avoiding a
33890 callout loop. However, to be on the safe side it would be best to set up your
33891 own ACLs so that they do not do sender verification checks when the recipient
33892 is the address you use for header sender or postmaster callout checking.
33893
33894 Another issue to think about when using non-empty senders for callouts is
33895 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33896 by the sender/recipient combination; thus, for any given recipient, many more
33897 actual callouts are performed than when an empty sender or postmaster is used.
33898
33899
33900
33901
33902 .subsection "Callout caching" SECTcallvercache
33903 .cindex "hints database" "callout cache"
33904 .cindex "callout" "cache, description of"
33905 .cindex "caching" "callout"
33906 Exim caches the results of callouts in order to reduce the amount of resources
33907 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33908 option. A hints database called &"callout"& is used for the cache. Two
33909 different record types are used: one records the result of a callout check for
33910 a specific address, and the other records information that applies to the
33911 entire domain (for example, that it accepts the local part &'postmaster'&).
33912
33913 When an original callout fails, a detailed SMTP error message is given about
33914 the failure. However, for subsequent failures that use the cache data, this message
33915 is not available.
33916
33917 The expiry times for negative and positive address cache records are
33918 independent, and can be set by the global options &%callout_negative_expire%&
33919 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33920
33921 If a host gives a negative response to an SMTP connection, or rejects any
33922 commands up to and including
33923 .code
33924 MAIL FROM:<>
33925 .endd
33926 (but not including the MAIL command with a non-empty address),
33927 any callout attempt is bound to fail. Exim remembers such failures in a
33928 domain cache record, which it uses to fail callouts for the domain without
33929 making new connections, until the domain record times out. There are two
33930 separate expiry times for domain cache records:
33931 &%callout_domain_negative_expire%& (default 3h) and
33932 &%callout_domain_positive_expire%& (default 7d).
33933
33934 Domain records expire when the negative expiry time is reached if callouts
33935 cannot be made for the domain, or if the postmaster check failed.
33936 Otherwise, they expire when the positive expiry time is reached. This
33937 ensures that, for example, a host that stops accepting &"random"& local parts
33938 will eventually be noticed.
33939
33940 The callout caching mechanism is based on the domain of the address that is
33941 being tested. If the domain routes to several hosts, it is assumed that their
33942 behaviour will be the same.
33943
33944
33945
33946 .section "Quota caching" "SECTquotacache"
33947 .cindex "hints database" "quota cache"
33948 .cindex "quota" "cache, description of"
33949 .cindex "caching" "quota"
33950 Exim caches the results of quota verification
33951 in order to reduce the amount of resources used.
33952 The &"callout"& hints database is used.
33953
33954 The default cache periods are five minutes for a positive (good) result
33955 and one hour for a negative result.
33956 To change the periods the &%quota%& option can be followed by an equals sign
33957 and a number of optional paramemters, separated by commas.
33958 For example:
33959 .code
33960 verify = recipient/quota=cachepos=1h,cacheneg=1d
33961 .endd
33962 Possible parameters are:
33963 .vlist
33964 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33965 .cindex "quota cache" "positive entry expiry, specifying"
33966 Set the lifetime for a positive cache entry.
33967 A value of zero seconds is legitimate.
33968
33969 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33970 .cindex "quota cache" "negative entry expiry, specifying"
33971 As above, for a negative entry.
33972
33973 .vitem &*no_cache*&
33974 Set both positive and negative lifetimes to zero.
33975
33976 .section "Sender address verification reporting" "SECTsenaddver"
33977 .cindex "verifying" "suppressing error details"
33978 See section &<<SECTaddressverification>>& for a general discussion of
33979 verification. When sender verification fails in an ACL, the details of the
33980 failure are given as additional output lines before the 550 response to the
33981 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33982 you might see:
33983 .code
33984 MAIL FROM:<xyz@abc.example>
33985 250 OK
33986 RCPT TO:<pqr@def.example>
33987 550-Verification failed for <xyz@abc.example>
33988 550-Called:   192.168.34.43
33989 550-Sent:     RCPT TO:<xyz@abc.example>
33990 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33991 550 Sender verification failed
33992 .endd
33993 If more than one RCPT command fails in the same way, the details are given
33994 only for the first of them. However, some administrators do not want to send
33995 out this much information. You can suppress the details by adding
33996 &`/no_details`& to the ACL statement that requests sender verification. For
33997 example:
33998 .code
33999 verify = sender/no_details
34000 .endd
34001
34002 .section "Redirection while verifying" "SECTredirwhilveri"
34003 .cindex "verifying" "redirection while"
34004 .cindex "address redirection" "while verifying"
34005 A dilemma arises when a local address is redirected by aliasing or forwarding
34006 during verification: should the generated addresses themselves be verified,
34007 or should the successful expansion of the original address be enough to verify
34008 it? By default, Exim takes the following pragmatic approach:
34009
34010 .ilist
34011 When an incoming address is redirected to just one child address, verification
34012 continues with the child address, and if that fails to verify, the original
34013 verification also fails.
34014 .next
34015 When an incoming address is redirected to more than one child address,
34016 verification does not continue. A success result is returned.
34017 .endlist
34018
34019 This seems the most reasonable behaviour for the common use of aliasing as a
34020 way of redirecting different local parts to the same mailbox. It means, for
34021 example, that a pair of alias entries of the form
34022 .code
34023 A.Wol:   aw123
34024 aw123:   :fail: Gone away, no forwarding address
34025 .endd
34026 work as expected, with both local parts causing verification failure. When a
34027 redirection generates more than one address, the behaviour is more like a
34028 mailing list, where the existence of the alias itself is sufficient for
34029 verification to succeed.
34030
34031 It is possible, however, to change the default behaviour so that all successful
34032 redirections count as successful verifications, however many new addresses are
34033 generated. This is specified by the &%success_on_redirect%& verification
34034 option. For example:
34035 .code
34036 require verify = recipient/success_on_redirect/callout=10s
34037 .endd
34038 In this example, verification succeeds if a router generates a new address, and
34039 the callout does not occur, because no address was routed to a remote host.
34040
34041 When verification is being tested via the &%-bv%& option, the treatment of
34042 redirections is as just described, unless the &%-v%& or any debugging option is
34043 also specified. In that case, full verification is done for every generated
34044 address and a report is output for each of them.
34045
34046
34047
34048 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
34049 .cindex "CSA" "verifying"
34050 Client SMTP Authorization is a system that allows a site to advertise
34051 which machines are and are not permitted to send email. This is done by placing
34052 special SRV records in the DNS; these are looked up using the client's HELO
34053 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
34054 Authorization checks in Exim are performed by the ACL condition:
34055 .code
34056 verify = csa
34057 .endd
34058 This fails if the client is not authorized. If there is a DNS problem, or if no
34059 valid CSA SRV record is found, or if the client is authorized, the condition
34060 succeeds. These three cases can be distinguished using the expansion variable
34061 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
34062 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
34063 be likely to cause problems for legitimate email.
34064
34065 The error messages produced by the CSA code include slightly more
34066 detail. If &$csa_status$& is &"defer"&, this may be because of problems
34067 looking up the CSA SRV record, or problems looking up the CSA target
34068 address record. There are four reasons for &$csa_status$& being &"fail"&:
34069
34070 .ilist
34071 The client's host name is explicitly not authorized.
34072 .next
34073 The client's IP address does not match any of the CSA target IP addresses.
34074 .next
34075 The client's host name is authorized but it has no valid target IP addresses
34076 (for example, the target's addresses are IPv6 and the client is using IPv4).
34077 .next
34078 The client's host name has no CSA SRV record but a parent domain has asserted
34079 that all subdomains must be explicitly authorized.
34080 .endlist
34081
34082 The &%csa%& verification condition can take an argument which is the domain to
34083 use for the DNS query. The default is:
34084 .code
34085 verify = csa/$sender_helo_name
34086 .endd
34087 This implementation includes an extension to CSA. If the query domain
34088 is an address literal such as [192.0.2.95], or if it is a bare IP
34089 address, Exim searches for CSA SRV records in the reverse DNS as if
34090 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
34091 meaningful to say:
34092 .code
34093 verify = csa/$sender_host_address
34094 .endd
34095 In fact, this is the check that Exim performs if the client does not say HELO.
34096 This extension can be turned off by setting the main configuration option
34097 &%dns_csa_use_reverse%& to be false.
34098
34099 If a CSA SRV record is not found for the domain itself, a search
34100 is performed through its parent domains for a record which might be
34101 making assertions about subdomains. The maximum depth of this search is limited
34102 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
34103 default. Exim does not look for CSA SRV records in a top level domain, so the
34104 default settings handle HELO domains as long as seven
34105 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
34106 of legitimate HELO domains.
34107
34108 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
34109 direct SRV lookups, this is not sufficient because of the extra parent domain
34110 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
34111 addresses into lookups in the reverse DNS space. The result of a successful
34112 lookup such as:
34113 .code
34114 ${lookup dnsdb {csa=$sender_helo_name}}
34115 .endd
34116 has two space-separated fields: an authorization code and a target host name.
34117 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
34118 authorization required but absent, or &"?"& for unknown.
34119
34120
34121
34122
34123 .section "Bounce address tag validation" "SECTverifyPRVS"
34124 .cindex "BATV, verifying"
34125 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
34126 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
34127 Genuine incoming bounce messages should therefore always be addressed to
34128 recipients that have a valid tag. This scheme is a way of detecting unwanted
34129 bounce messages caused by sender address forgeries (often called &"collateral
34130 spam"&), because the recipients of such messages do not include valid tags.
34131
34132 There are two expansion items to help with the implementation of the BATV
34133 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
34134 the original envelope sender address by using a simple key to add a hash of the
34135 address and some time-based randomizing information. The &%prvs%& expansion
34136 item creates a signed address, and the &%prvscheck%& expansion item checks one.
34137 The syntax of these expansion items is described in section
34138 &<<SECTexpansionitems>>&.
34139 The validity period on signed addresses is seven days.
34140
34141 As an example, suppose the secret per-address keys are stored in an MySQL
34142 database. A query to look up the key for an address could be defined as a macro
34143 like this:
34144 .code
34145 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
34146                 WHERE sender='${quote_mysql:$prvscheck_address}'\
34147                 }{$value}}
34148 .endd
34149 Suppose also that the senders who make use of BATV are defined by an address
34150 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
34151 use this:
34152 .code
34153 # Bounces: drop unsigned addresses for BATV senders
34154 deny senders = :
34155      recipients = +batv_senders
34156      message = This address does not send an unsigned reverse path
34157
34158 # Bounces: In case of prvs-signed address, check signature.
34159 deny senders = :
34160      condition  = ${prvscheck {$local_part@$domain}\
34161                   {PRVSCHECK_SQL}{1}}
34162      !condition = $prvscheck_result
34163      message = Invalid reverse path signature.
34164 .endd
34165 The first statement rejects recipients for bounce messages that are addressed
34166 to plain BATV sender addresses, because it is known that BATV senders do not
34167 send out messages with plain sender addresses. The second statement rejects
34168 recipients that are prvs-signed, but with invalid signatures (either because
34169 the key is wrong, or the signature has timed out).
34170
34171 A non-prvs-signed address is not rejected by the second statement, because the
34172 &%prvscheck%& expansion yields an empty string if its first argument is not a
34173 prvs-signed address, thus causing the &%condition%& condition to be false. If
34174 the first argument is a syntactically valid prvs-signed address, the yield is
34175 the third string (in this case &"1"&), whether or not the cryptographic and
34176 timeout checks succeed. The &$prvscheck_result$& variable contains the result
34177 of the checks (empty for failure, &"1"& for success).
34178
34179 There is one more issue you must consider when implementing prvs-signing:
34180 you have to ensure that the routers accept prvs-signed addresses and
34181 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
34182 router to remove the signature with a configuration along these lines:
34183 .code
34184 batv_redirect:
34185   driver = redirect
34186   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
34187 .endd
34188 This works because, if the third argument of &%prvscheck%& is empty, the result
34189 of the expansion of a prvs-signed address is the decoded value of the original
34190 address. This router should probably be the first of your routers that handles
34191 local addresses.
34192
34193 To create BATV-signed addresses in the first place, a transport of this form
34194 can be used:
34195 .code
34196 external_smtp_batv:
34197   driver = smtp
34198   return_path = ${prvs {$return_path} \
34199                        {${lookup mysql{SELECT \
34200                        secret FROM batv_prvs WHERE \
34201                        sender='${quote_mysql:$sender_address}'} \
34202                        {$value}fail}}}
34203 .endd
34204 If no key can be found for the existing return path, no signing takes place.
34205
34206
34207
34208 .section "Using an ACL to control relaying" "SECTrelaycontrol"
34209 .cindex "&ACL;" "relay control"
34210 .cindex "relaying" "control by ACL"
34211 .cindex "policy control" "relay control"
34212 An MTA is said to &'relay'& a message if it receives it from some host and
34213 delivers it directly to another host as a result of a remote address contained
34214 within it. Redirecting a local address via an alias or forward file and then
34215 passing the message on to another host is not relaying,
34216 .cindex "&""percent hack""&"
34217 but a redirection as a result of the &"percent hack"& is.
34218
34219 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
34220 A host which is acting as a gateway or an MX backup is concerned with incoming
34221 relaying from arbitrary hosts to a specific set of domains. On the other hand,
34222 a host which is acting as a smart host for a number of clients is concerned
34223 with outgoing relaying from those clients to the Internet at large. Often the
34224 same host is fulfilling both functions,
34225 . ///
34226 . as illustrated in the diagram below,
34227 . ///
34228 but in principle these two kinds of relaying are entirely independent. What is
34229 not wanted is the transmission of mail from arbitrary remote hosts through your
34230 system to arbitrary domains.
34231
34232
34233 You can implement relay control by means of suitable statements in the ACL that
34234 runs for each RCPT command. For convenience, it is often easiest to use
34235 Exim's named list facility to define the domains and hosts involved. For
34236 example, suppose you want to do the following:
34237
34238 .ilist
34239 Deliver a number of domains to mailboxes on the local host (or process them
34240 locally in some other way). Let's say these are &'my.dom1.example'& and
34241 &'my.dom2.example'&.
34242 .next
34243 Relay mail for a number of other domains for which you are the secondary MX.
34244 These might be &'friend1.example'& and &'friend2.example'&.
34245 .next
34246 Relay mail from the hosts on your local LAN, to whatever domains are involved.
34247 Suppose your LAN is 192.168.45.0/24.
34248 .endlist
34249
34250
34251 In the main part of the configuration, you put the following definitions:
34252 .code
34253 domainlist local_domains    = my.dom1.example : my.dom2.example
34254 domainlist relay_to_domains = friend1.example : friend2.example
34255 hostlist   relay_from_hosts = 192.168.45.0/24
34256 .endd
34257 Now you can use these definitions in the ACL that is run for every RCPT
34258 command:
34259 .code
34260 acl_check_rcpt:
34261   accept domains = +local_domains : +relay_to_domains
34262   accept hosts   = +relay_from_hosts
34263 .endd
34264 The first statement accepts any RCPT command that contains an address in
34265 the local or relay domains. For any other domain, control passes to the second
34266 statement, which accepts the command only if it comes from one of the relay
34267 hosts. In practice, you will probably want to make your ACL more sophisticated
34268 than this, for example, by including sender and recipient verification. The
34269 default configuration includes a more comprehensive example, which is described
34270 in chapter &<<CHAPdefconfil>>&.
34271
34272
34273
34274 .section "Checking a relay configuration" "SECTcheralcon"
34275 .cindex "relaying" "checking control of"
34276 You can check the relay characteristics of your configuration in the same way
34277 that you can test any ACL behaviour for an incoming SMTP connection, by using
34278 the &%-bh%& option to run a fake SMTP session with which you interact.
34279 .ecindex IIDacl
34280
34281
34282
34283 . ////////////////////////////////////////////////////////////////////////////
34284 . ////////////////////////////////////////////////////////////////////////////
34285
34286 .chapter "Content scanning at ACL time" "CHAPexiscan"
34287 .scindex IIDcosca "content scanning" "at ACL time"
34288 The extension of Exim to include content scanning at ACL time, formerly known
34289 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
34290 was integrated into the main source for Exim release 4.50, and Tom continues to
34291 maintain it. Most of the wording of this chapter is taken from Tom's
34292 specification.
34293
34294 It is also possible to scan the content of messages at other times. The
34295 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
34296 scanning after all the ACLs have run. A transport filter can be used to scan
34297 messages at delivery time (see the &%transport_filter%& option, described in
34298 chapter &<<CHAPtransportgeneric>>&).
34299
34300 If you want to include the ACL-time content-scanning features when you compile
34301 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
34302 &_Local/Makefile_&. When you do that, the Exim binary is built with:
34303
34304 .ilist
34305 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
34306 for all MIME parts for SMTP and non-SMTP messages, respectively.
34307 .next
34308 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
34309 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
34310 run at the end of message reception (the &%acl_smtp_data%& ACL).
34311 .next
34312 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
34313 of messages, or parts of messages, for debugging purposes.
34314 .next
34315 Additional expansion variables that are set in the new ACL and by the new
34316 conditions.
34317 .next
34318 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
34319 .endlist
34320
34321 Content-scanning is continually evolving, and new features are still being
34322 added. While such features are still unstable and liable to incompatible
34323 changes, they are made available in Exim by setting options whose names begin
34324 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
34325 this manual. You can find out about them by reading the file called
34326 &_doc/experimental.txt_&.
34327
34328 All the content-scanning facilities work on a MBOX copy of the message that is
34329 temporarily created in a file called:
34330 .display
34331 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
34332 .endd
34333 The &_.eml_& extension is a friendly hint to virus scanners that they can
34334 expect an MBOX-like structure inside that file. The file is created when the
34335 first content scanning facility is called. Subsequent calls to content
34336 scanning conditions open the same file again. The directory is recursively
34337 removed when the &%acl_smtp_data%& ACL has finished running, unless
34338 .code
34339 control = no_mbox_unspool
34340 .endd
34341 has been encountered. When the MIME ACL decodes files, they are put into the
34342 same directory by default.
34343
34344
34345
34346 .section "Scanning for viruses" "SECTscanvirus"
34347 .cindex "virus scanning"
34348 .cindex "content scanning" "for viruses"
34349 .cindex "content scanning" "the &%malware%& condition"
34350 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
34351 It supports a &"generic"& interface to scanners called via the shell, and
34352 specialized interfaces for &"daemon"& type virus scanners, which are resident
34353 in memory and thus are much faster.
34354
34355 Since message data needs to have arrived,
34356 the condition may be only called in ACL defined by
34357 &%acl_smtp_data%&,
34358 &%acl_smtp_data_prdr%&,
34359 &%acl_smtp_mime%& or
34360 &%acl_smtp_dkim%&
34361
34362 A timeout of 2 minutes is applied to a scanner call (by default);
34363 if it expires then a defer action is taken.
34364
34365 .oindex "&%av_scanner%&"
34366 You can set the &%av_scanner%& option in the main part of the configuration
34367 to specify which scanner to use, together with any additional options that
34368 are needed. The basic syntax is as follows:
34369 .display
34370 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34371 .endd
34372 If you do not set &%av_scanner%&, it defaults to
34373 .code
34374 av_scanner = sophie:/var/run/sophie
34375 .endd
34376 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34377 before use.
34378 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34379 The following scanner types are supported in this release,
34380 though individual ones can be included or not at build time:
34381
34382 .vlist
34383 .vitem &%avast%&
34384 .cindex "virus scanners" "avast"
34385 This is the scanner daemon of Avast. It has been tested with Avast Core
34386 Security (currently at version 2.2.0).
34387 You can get a trial version at &url(https://www.avast.com) or for Linux
34388 at &url(https://www.avast.com/linux-server-antivirus).
34389 This scanner type takes one option,
34390 which can be either a full path to a UNIX socket,
34391 or host and port specifiers separated by white space.
34392 The host may be a name or an IP address; the port is either a
34393 single number or a pair of numbers with a dash between.
34394 A list of options may follow. These options are interpreted on the
34395 Exim's side of the malware scanner, or are given on separate lines to
34396 the daemon as options before the main scan command.
34397
34398 .cindex &`pass_unscanned`& "avast"
34399 If &`pass_unscanned`&
34400 is set, any files the Avast scanner can't scan (e.g.
34401 decompression bombs, or invalid archives) are considered clean. Use with
34402 care.
34403
34404 For example:
34405 .code
34406 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34407 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34408 av_scanner = avast:192.168.2.22 5036
34409 .endd
34410 If you omit the argument, the default path
34411 &_/var/run/avast/scan.sock_&
34412 is used.
34413 If you use a remote host,
34414 you need to make Exim's spool directory available to it,
34415 as the scanner is passed a file path, not file contents.
34416 For information about available commands and their options you may use
34417 .code
34418 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34419     FLAGS
34420     SENSITIVITY
34421     PACK
34422 .endd
34423
34424 If the scanner returns a temporary failure (e.g. license issues, or
34425 permission problems), the message is deferred and a paniclog entry is
34426 written.  The usual &`defer_ok`& option is available.
34427
34428 .vitem &%aveserver%&
34429 .cindex "virus scanners" "Kaspersky"
34430 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34431 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34432 which is the path to the daemon's UNIX socket. The default is shown in this
34433 example:
34434 .code
34435 av_scanner = aveserver:/var/run/aveserver
34436 .endd
34437
34438
34439 .vitem &%clamd%&
34440 .cindex "virus scanners" "clamd"
34441 This daemon-type scanner is GPL and free. You can get it at
34442 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34443 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34444 in the MIME ACL. This is no longer believed to be necessary.
34445
34446 The options are a list of server specifiers, which may be
34447 a UNIX socket specification,
34448 a TCP socket specification,
34449 or a (global) option.
34450
34451 A socket specification consists of a space-separated list.
34452 For a Unix socket the first element is a full path for the socket,
34453 for a TCP socket the first element is the IP address
34454 and the second a port number,
34455 Any further elements are per-server (non-global) options.
34456 These per-server options are supported:
34457 .code
34458 retry=<timespec>        Retry on connect fail
34459 .endd
34460
34461 The &`retry`& option specifies a time after which a single retry for
34462 a failed connect is made.  The default is to not retry.
34463
34464 If a Unix socket file is specified, only one server is supported.
34465
34466 Examples:
34467 .code
34468 av_scanner = clamd:/opt/clamd/socket
34469 av_scanner = clamd:192.0.2.3 1234
34470 av_scanner = clamd:192.0.2.3 1234:local
34471 av_scanner = clamd:192.0.2.3 1234 retry=10s
34472 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34473 .endd
34474 If the value of av_scanner points to a UNIX socket file or contains the
34475 &`local`&
34476 option, then the ClamAV interface will pass a filename containing the data
34477 to be scanned, which should normally result in less I/O happening and be
34478 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34479 Exim does not assume that there is a common filesystem with the remote host.
34480
34481 The final example shows that multiple TCP targets can be specified.  Exim will
34482 randomly use one for each incoming email (i.e. it load balances them).  Note
34483 that only TCP targets may be used if specifying a list of scanners; a UNIX
34484 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34485 unavailable, Exim will try the remaining one(s) until it finds one that works.
34486 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34487 not keep track of scanner state between multiple messages, and the scanner
34488 selection is random, so the message will get logged in the mainlog for each
34489 email that the down scanner gets chosen first (message wrapped to be readable):
34490 .code
34491 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34492    clamd: connection to localhost, port 3310 failed
34493    (Connection refused)
34494 .endd
34495
34496 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34497 contributing the code for this scanner.
34498
34499 .vitem &%cmdline%&
34500 .cindex "virus scanners" "command line interface"
34501 This is the keyword for the generic command line scanner interface. It can be
34502 used to attach virus scanners that are invoked from the shell. This scanner
34503 type takes 3 mandatory options:
34504
34505 .olist
34506 The full path and name of the scanner binary, with all command line options,
34507 and a placeholder (&`%s`&) for the directory to scan.
34508
34509 .next
34510 A regular expression to match against the STDOUT and STDERR output of the
34511 virus scanner. If the expression matches, a virus was found. You must make
34512 absolutely sure that this expression matches on &"virus found"&. This is called
34513 the &"trigger"& expression.
34514
34515 .next
34516 Another regular expression, containing exactly one pair of parentheses, to
34517 match the name of the virus found in the scanners output. This is called the
34518 &"name"& expression.
34519 .endlist olist
34520
34521 For example, Sophos Sweep reports a virus on a line like this:
34522 .code
34523 Virus 'W32/Magistr-B' found in file ./those.bat
34524 .endd
34525 For the trigger expression, we can match the phrase &"found in file"&. For the
34526 name expression, we want to extract the W32/Magistr-B string, so we can match
34527 for the single quotes left and right of it. Altogether, this makes the
34528 configuration setting:
34529 .code
34530 av_scanner = cmdline:\
34531              /path/to/sweep -ss -all -rec -archive %s:\
34532              found in file:'(.+)'
34533 .endd
34534 .vitem &%drweb%&
34535 .cindex "virus scanners" "DrWeb"
34536 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34537 takes one option,
34538 either a full path to a UNIX socket,
34539 or host and port specifiers separated by white space.
34540 The host may be a name or an IP address; the port is either a
34541 single number or a pair of numbers with a dash between.
34542 For example:
34543 .code
34544 av_scanner = drweb:/var/run/drwebd.sock
34545 av_scanner = drweb:192.168.2.20 31337
34546 .endd
34547 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34548 is used. Thanks to Alex Miller for contributing the code for this scanner.
34549
34550 .vitem &%f-protd%&
34551 .cindex "virus scanners" "f-protd"
34552 The f-protd scanner is accessed via HTTP over TCP.
34553 One argument is taken, being a space-separated hostname and port number
34554 (or port-range).
34555 For example:
34556 .code
34557 av_scanner = f-protd:localhost 10200-10204
34558 .endd
34559 If you omit the argument, the default values shown above are used.
34560
34561 .vitem &%f-prot6d%&
34562 .cindex "virus scanners" "f-prot6d"
34563 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34564 One argument is taken, being a space-separated hostname and port number.
34565 For example:
34566 .code
34567 av_scanner = f-prot6d:localhost 10200
34568 .endd
34569 If you omit the argument, the default values show above are used.
34570
34571 .vitem &%fsecure%&
34572 .cindex "virus scanners" "F-Secure"
34573 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34574 argument which is the path to a UNIX socket. For example:
34575 .code
34576 av_scanner = fsecure:/path/to/.fsav
34577 .endd
34578 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34579 Thelmen for contributing the code for this scanner.
34580
34581 .vitem &%kavdaemon%&
34582 .cindex "virus scanners" "Kaspersky"
34583 This is the scanner daemon of Kaspersky Version 4. This version of the
34584 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34585 scanner type takes one option, which is the path to the daemon's UNIX socket.
34586 For example:
34587 .code
34588 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34589 .endd
34590 The default path is &_/var/run/AvpCtl_&.
34591
34592 .vitem &%mksd%&
34593 .cindex "virus scanners" "mksd"
34594 This was a daemon type scanner that is aimed mainly at Polish users,
34595 though some documentation was available in English.
34596 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34597 and this appears to be a candidate for removal from Exim, unless
34598 we are informed of other virus scanners which use the same protocol
34599 to integrate.
34600 The only option for this scanner type is
34601 the maximum number of processes used simultaneously to scan the attachments,
34602 provided that mksd has
34603 been run with at least the same number of child processes. For example:
34604 .code
34605 av_scanner = mksd:2
34606 .endd
34607 You can safely omit this option (the default value is 1).
34608
34609 .vitem &%sock%&
34610 .cindex "virus scanners" "simple socket-connected"
34611 This is a general-purpose way of talking to simple scanner daemons
34612 running on the local machine.
34613 There are four options:
34614 an address (which may be an IP address and port, or the path of a Unix socket),
34615 a commandline to send (may include a single %s which will be replaced with
34616 the path to the mail file to be scanned),
34617 an RE to trigger on from the returned data,
34618 and an RE to extract malware_name from the returned data.
34619 For example:
34620 .code
34621 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34622 .endd
34623 Note that surrounding whitespace is stripped from each option, meaning
34624 there is no way to specify a trailing newline.
34625 The socket specifier and both regular-expressions are required.
34626 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34627 specify an empty element to get this.
34628
34629 .vitem &%sophie%&
34630 .cindex "virus scanners" "Sophos and Sophie"
34631 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34632 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34633 for this scanner type is the path to the UNIX socket that Sophie uses for
34634 client communication. For example:
34635 .code
34636 av_scanner = sophie:/tmp/sophie
34637 .endd
34638 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34639 the option.
34640 .endlist
34641
34642 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34643 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34644 ACL.
34645
34646 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34647 makes it possible to use different scanners. See further below for an example.
34648 The &%malware%& condition caches its results, so when you use it multiple times
34649 for the same message, the actual scanning process is only carried out once.
34650 However, using expandable items in &%av_scanner%& disables this caching, in
34651 which case each use of the &%malware%& condition causes a new scan of the
34652 message.
34653
34654 The &%malware%& condition takes a right-hand argument that is expanded before
34655 use and taken as a list, slash-separated by default.
34656 The first element can then be one of
34657
34658 .ilist
34659 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34660 The condition succeeds if a virus was found, and fail otherwise. This is the
34661 recommended usage.
34662 .next
34663 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34664 the condition fails immediately.
34665 .next
34666 A regular expression, in which case the message is scanned for viruses. The
34667 condition succeeds if a virus is found and its name matches the regular
34668 expression. This allows you to take special actions on certain types of virus.
34669 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34670 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34671 .endlist
34672
34673 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34674 messages even if there is a problem with the virus scanner.
34675 Otherwise, such a problem causes the ACL to defer.
34676
34677 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34678 specify a non-default timeout.  The default is two minutes.
34679 For example:
34680 .code
34681 malware = * / defer_ok / tmo=10s
34682 .endd
34683 A timeout causes the ACL to defer.
34684
34685 .vindex "&$callout_address$&"
34686 When a connection is made to the scanner the expansion variable &$callout_address$&
34687 is set to record the actual address used.
34688
34689 .vindex "&$malware_name$&"
34690 When a virus is found, the condition sets up an expansion variable called
34691 &$malware_name$& that contains the name of the virus. You can use it in a
34692 &%message%& modifier that specifies the error returned to the sender, and/or in
34693 logging data.
34694
34695 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34696 imposed by your anti-virus scanner.
34697
34698 Here is a very simple scanning example:
34699 .code
34700 deny malware = *
34701      message = This message contains malware ($malware_name)
34702 .endd
34703 The next example accepts messages when there is a problem with the scanner:
34704 .code
34705 deny malware = */defer_ok
34706      message = This message contains malware ($malware_name)
34707 .endd
34708 The next example shows how to use an ACL variable to scan with both sophie and
34709 aveserver. It assumes you have set:
34710 .code
34711 av_scanner = $acl_m0
34712 .endd
34713 in the main Exim configuration.
34714 .code
34715 deny set acl_m0 = sophie
34716      malware = *
34717      message = This message contains malware ($malware_name)
34718
34719 deny set acl_m0 = aveserver
34720      malware = *
34721      message = This message contains malware ($malware_name)
34722 .endd
34723
34724
34725 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34726 .cindex "content scanning" "for spam"
34727 .cindex "spam scanning"
34728 .cindex "SpamAssassin"
34729 .cindex "Rspamd"
34730 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34731 score and a report for the message.
34732 Support is also provided for Rspamd.
34733
34734 For more information about installation and configuration of SpamAssassin or
34735 Rspamd refer to their respective websites at
34736 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34737
34738 SpamAssassin can be installed with CPAN by running:
34739 .code
34740 perl -MCPAN -e 'install Mail::SpamAssassin'
34741 .endd
34742 SpamAssassin has its own set of configuration files. Please review its
34743 documentation to see how you can tweak it. The default installation should work
34744 nicely, however.
34745
34746 .oindex "&%spamd_address%&"
34747 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34748 intend to use an instance running on the local host you do not need to set
34749 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34750 you must set the &%spamd_address%& option in the global part of the Exim
34751 configuration as follows (example):
34752 .code
34753 spamd_address = 192.168.99.45 783
34754 .endd
34755 The SpamAssassin protocol relies on a TCP half-close from the client.
34756 If your SpamAssassin client side is running a Linux system with an
34757 iptables firewall, consider setting
34758 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34759 timeout, Exim uses when waiting for a response from the SpamAssassin
34760 server (currently defaulting to 120s).  With a lower value the Linux
34761 connection tracking may consider your half-closed connection as dead too
34762 soon.
34763
34764
34765 To use Rspamd (which by default listens on all local addresses
34766 on TCP port 11333)
34767 you should add &%variant=rspamd%& after the address/port pair, for example:
34768 .code
34769 spamd_address = 127.0.0.1 11333 variant=rspamd
34770 .endd
34771
34772 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34773 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34774 filename instead of an address/port pair:
34775 .code
34776 spamd_address = /var/run/spamd_socket
34777 .endd
34778 You can have multiple &%spamd%& servers to improve scalability. These can
34779 reside on other hardware reachable over the network. To specify multiple
34780 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34781 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34782 .code
34783 spamd_address = 192.168.2.10 783 : \
34784                 192.168.2.11 783 : \
34785                 192.168.2.12 783
34786 .endd
34787 Up to 32 &%spamd%& servers are supported.
34788 When a server fails to respond to the connection attempt, all other
34789 servers are tried until one succeeds. If no server responds, the &%spam%&
34790 condition defers.
34791
34792 Unix and TCP socket specifications may be mixed in any order.
34793 Each element of the list is a list itself, space-separated by default
34794 and changeable in the usual way (&<<SECTlistsepchange>>&);
34795 take care to not double the separator.
34796
34797 For TCP socket specifications a host name or IP (v4 or v6, but
34798 subject to list-separator quoting rules) address can be used,
34799 and the port can be one or a dash-separated pair.
34800 In the latter case, the range is tried in strict order.
34801
34802 Elements after the first for Unix sockets, or second for TCP socket,
34803 are options.
34804 The supported options are:
34805 .code
34806 pri=<priority>      Selection priority
34807 weight=<value>      Selection bias
34808 time=<start>-<end>  Use only between these times of day
34809 retry=<timespec>    Retry on connect fail
34810 tmo=<timespec>      Connection time limit
34811 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34812 .endd
34813
34814 The &`pri`& option specifies a priority for the server within the list,
34815 higher values being tried first.
34816 The default priority is 1.
34817
34818 The &`weight`& option specifies a selection bias.
34819 Within a priority set
34820 servers are queried in a random fashion, weighted by this value.
34821 The default value for selection bias is 1.
34822
34823 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34824 in the local time zone; each element being one or more digits.
34825 Either the seconds or both minutes and seconds, plus the leading &`.`&
34826 characters, may be omitted and will be taken as zero.
34827
34828 Timeout specifications for the &`retry`& and &`tmo`& options
34829 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34830
34831 The &`tmo`& option specifies an overall timeout for communication.
34832 The default value is two minutes.
34833
34834 The &`retry`& option specifies a time after which a single retry for
34835 a failed connect is made.
34836 The default is to not retry.
34837
34838 The &%spamd_address%& variable is expanded before use if it starts with
34839 a dollar sign. In this case, the expansion may return a string that is
34840 used as the list so that multiple spamd servers can be the result of an
34841 expansion.
34842
34843 .vindex "&$callout_address$&"
34844 When a connection is made to the server the expansion variable &$callout_address$&
34845 is set to record the actual address used.
34846
34847 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34848 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34849 .code
34850 deny spam = joe
34851      message = This message was classified as SPAM
34852 .endd
34853 The right-hand side of the &%spam%& condition specifies a name. This is
34854 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34855 to scan using a specific profile, but rather use the SpamAssassin system-wide
34856 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34857 Rspamd does not use this setting. However, you must put something on the
34858 right-hand side.
34859
34860 The name allows you to use per-domain or per-user antispam profiles in
34861 principle, but this is not straightforward in practice, because a message may
34862 have multiple recipients, not necessarily all in the same domain. Because the
34863 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34864 read the contents of the message, the variables &$local_part$& and &$domain$&
34865 are not set.
34866 Careful enforcement of single-recipient messages
34867 (e.g. by responding with defer in the recipient ACL for all recipients
34868 after the first),
34869 or the use of PRDR,
34870 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34871 are needed to use this feature.
34872
34873 The right-hand side of the &%spam%& condition is expanded before being used, so
34874 you can put lookups or conditions there. When the right-hand side evaluates to
34875 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34876
34877
34878 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34879 large ones may cause significant performance degradation. As most spam messages
34880 are quite small, it is recommended that you do not scan the big ones. For
34881 example:
34882 .code
34883 deny condition = ${if < {$message_size}{10K}}
34884      spam = nobody
34885      message = This message was classified as SPAM
34886 .endd
34887
34888 The &%spam%& condition returns true if the threshold specified in the user's
34889 SpamAssassin profile has been matched or exceeded. If you want to use the
34890 &%spam%& condition for its side effects (see the variables below), you can make
34891 it always return &"true"& by appending &`:true`& to the username.
34892
34893 .cindex "spam scanning" "returned variables"
34894 When the &%spam%& condition is run, it sets up a number of expansion
34895 variables.
34896 Except for &$spam_report$&,
34897 these variables are saved with the received message so are
34898 available for use at delivery time.
34899
34900 .vlist
34901 .vitem &$spam_score$&
34902 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34903 for inclusion in log or reject messages.
34904
34905 .vitem &$spam_score_int$&
34906 The spam score of the message, multiplied by ten, as an integer value. For
34907 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34908 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34909 The integer value is useful for numeric comparisons in conditions.
34910
34911 .vitem &$spam_bar$&
34912 A string consisting of a number of &"+"& or &"-"& characters, representing the
34913 integer part of the spam score value. A spam score of 4.4 would have a
34914 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34915 headers, since MUAs can match on such strings. The maximum length of the
34916 spam bar is 50 characters.
34917
34918 .vitem &$spam_report$&
34919 A multiline text table, containing the full SpamAssassin report for the
34920 message. Useful for inclusion in headers or reject messages.
34921 This variable is only usable in a DATA-time ACL.
34922 Beware that SpamAssassin may return non-ASCII characters, especially
34923 when running in country-specific locales, which are not legal
34924 unencoded in headers.
34925
34926 .vitem &$spam_action$&
34927 For SpamAssassin either 'reject' or 'no action' depending on the
34928 spam score versus threshold.
34929 For Rspamd, the recommended action.
34930
34931 .endlist
34932
34933 The &%spam%& condition caches its results unless expansion in
34934 spamd_address was used. If you call it again with the same user name, it
34935 does not scan again, but rather returns the same values as before.
34936
34937 The &%spam%& condition returns DEFER if there is any error while running
34938 the message through SpamAssassin or if the expansion of spamd_address
34939 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34940 statement block), append &`/defer_ok`& to the right-hand side of the
34941 spam condition, like this:
34942 .code
34943 deny spam    = joe/defer_ok
34944      message = This message was classified as SPAM
34945 .endd
34946 This causes messages to be accepted even if there is a problem with &%spamd%&.
34947
34948 Here is a longer, commented example of the use of the &%spam%&
34949 condition:
34950 .code
34951 # put headers in all messages (no matter if spam or not)
34952 warn  spam = nobody:true
34953       add_header = X-Spam-Score: $spam_score ($spam_bar)
34954       add_header = X-Spam-Report: $spam_report
34955
34956 # add second subject line with *SPAM* marker when message
34957 # is over threshold
34958 warn  spam = nobody
34959       add_header = Subject: *SPAM* $h_Subject:
34960
34961 # reject spam at high scores (> 12)
34962 deny  spam = nobody:true
34963       condition = ${if >{$spam_score_int}{120}{1}{0}}
34964       message = This message scored $spam_score spam points.
34965 .endd
34966
34967
34968
34969 .section "Scanning MIME parts" "SECTscanmimepart"
34970 .cindex "content scanning" "MIME parts"
34971 .cindex "MIME content scanning"
34972 .oindex "&%acl_smtp_mime%&"
34973 .oindex "&%acl_not_smtp_mime%&"
34974 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34975 each MIME part of an SMTP message, including multipart types, in the sequence
34976 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34977 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34978 options may both refer to the same ACL if you want the same processing in both
34979 cases.
34980
34981 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34982 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34983 the case of a non-SMTP message. However, a MIME ACL is called only if the
34984 message contains a &'Content-Type:'& header line. When a call to a MIME
34985 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34986 result code is sent to the client. In the case of an SMTP message, the
34987 &%acl_smtp_data%& ACL is not called when this happens.
34988
34989 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34990 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34991 condition to match against the raw MIME part. You can also use the
34992 &%mime_regex%& condition to match against the decoded MIME part (see section
34993 &<<SECTscanregex>>&).
34994
34995 At the start of a MIME ACL, a number of variables are set from the header
34996 information for the relevant MIME part. These are described below. The contents
34997 of the MIME part are not by default decoded into a disk file except for MIME
34998 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34999 part into a disk file, you can use the &%decode%& condition. The general
35000 syntax is:
35001 .display
35002 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
35003 .endd
35004 The right hand side is expanded before use. After expansion,
35005 the value can be:
35006
35007 .olist
35008 &"0"& or &"false"&, in which case no decoding is done.
35009 .next
35010 The string &"default"&. In that case, the file is put in the temporary
35011 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
35012 a sequential filename consisting of the message id and a sequence number. The
35013 full path and name is available in &$mime_decoded_filename$& after decoding.
35014 .next
35015 A full path name starting with a slash. If the full name is an existing
35016 directory, it is used as a replacement for the default directory. The filename
35017 is then sequentially assigned. If the path does not exist, it is used as
35018 the full path and filename.
35019 .next
35020 If the string does not start with a slash, it is used as the
35021 filename, and the default path is then used.
35022 .endlist
35023 The &%decode%& condition normally succeeds. It is only false for syntax
35024 errors or unusual circumstances such as memory shortages. You can easily decode
35025 a file with its original, proposed filename using
35026 .code
35027 decode = $mime_filename
35028 .endd
35029 However, you should keep in mind that &$mime_filename$& might contain
35030 anything. If you place files outside of the default path, they are not
35031 automatically unlinked.
35032
35033 For RFC822 attachments (these are messages attached to messages, with a
35034 content-type of &"message/rfc822"&), the ACL is called again in the same manner
35035 as for the primary message, only that the &$mime_is_rfc822$& expansion
35036 variable is set (see below). Attached messages are always decoded to disk
35037 before being checked, and the files are unlinked once the check is done.
35038
35039 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
35040 used to match regular expressions against raw and decoded MIME parts,
35041 respectively. They are described in section &<<SECTscanregex>>&.
35042
35043 .cindex "MIME content scanning" "returned variables"
35044 The following list describes all expansion variables that are
35045 available in the MIME ACL:
35046
35047 .vlist
35048 .vitem &$mime_anomaly_level$& &&&
35049        &$mime_anomaly_text$&
35050 .vindex &$mime_anomaly_level$&
35051 .vindex &$mime_anomaly_text$&
35052 If there are problems decoding, these variables contain information on
35053 the detected issue.
35054
35055 .vitem &$mime_boundary$&
35056 .vindex &$mime_boundary$&
35057 If the current part is a multipart (see &$mime_is_multipart$& below), it should
35058 have a boundary string, which is stored in this variable. If the current part
35059 has no boundary parameter in the &'Content-Type:'& header, this variable
35060 contains the empty string.
35061
35062 .vitem &$mime_charset$&
35063 .vindex &$mime_charset$&
35064 This variable contains the character set identifier, if one was found in the
35065 &'Content-Type:'& header. Examples for charset identifiers are:
35066 .code
35067 us-ascii
35068 gb2312 (Chinese)
35069 iso-8859-1
35070 .endd
35071 Please note that this value is not normalized, so you should do matches
35072 case-insensitively.
35073
35074 .vitem &$mime_content_description$&
35075 .vindex &$mime_content_description$&
35076 This variable contains the normalized content of the &'Content-Description:'&
35077 header. It can contain a human-readable description of the parts content. Some
35078 implementations repeat the filename for attachments here, but they are usually
35079 only used for display purposes.
35080
35081 .vitem &$mime_content_disposition$&
35082 .vindex &$mime_content_disposition$&
35083 This variable contains the normalized content of the &'Content-Disposition:'&
35084 header. You can expect strings like &"attachment"& or &"inline"& here.
35085
35086 .vitem &$mime_content_id$&
35087 .vindex &$mime_content_id$&
35088 This variable contains the normalized content of the &'Content-ID:'& header.
35089 This is a unique ID that can be used to reference a part from another part.
35090
35091 .vitem &$mime_content_size$&
35092 .vindex &$mime_content_size$&
35093 This variable is set only after the &%decode%& modifier (see above) has been
35094 successfully run. It contains the size of the decoded part in kilobytes. The
35095 size is always rounded up to full kilobytes, so only a completely empty part
35096 has a &$mime_content_size$& of zero.
35097
35098 .vitem &$mime_content_transfer_encoding$&
35099 .vindex &$mime_content_transfer_encoding$&
35100 This variable contains the normalized content of the
35101 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
35102 type. Typical values are &"base64"& and &"quoted-printable"&.
35103
35104 .vitem &$mime_content_type$&
35105 .vindex &$mime_content_type$&
35106 If the MIME part has a &'Content-Type:'& header, this variable contains its
35107 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
35108 are some examples of popular MIME types, as they may appear in this variable:
35109 .code
35110 text/plain
35111 text/html
35112 application/octet-stream
35113 image/jpeg
35114 audio/midi
35115 .endd
35116 If the MIME part has no &'Content-Type:'& header, this variable contains the
35117 empty string.
35118
35119 .vitem &$mime_decoded_filename$&
35120 .vindex &$mime_decoded_filename$&
35121 This variable is set only after the &%decode%& modifier (see above) has been
35122 successfully run. It contains the full path and filename of the file
35123 containing the decoded data.
35124 .endlist
35125
35126 .cindex "RFC 2047"
35127 .vlist
35128 .vitem &$mime_filename$&
35129 .vindex &$mime_filename$&
35130 This is perhaps the most important of the MIME variables. It contains a
35131 proposed filename for an attachment, if one was found in either the
35132 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
35133 RFC2047
35134 or RFC2231
35135 decoded, but no additional sanity checks are done.
35136  If no filename was
35137 found, this variable contains the empty string.
35138
35139 .vitem &$mime_is_coverletter$&
35140 .vindex &$mime_is_coverletter$&
35141 This variable attempts to differentiate the &"cover letter"& of an e-mail from
35142 attached data. It can be used to clamp down on flashy or unnecessarily encoded
35143 content in the cover letter, while not restricting attachments at all.
35144
35145 The variable contains 1 (true) for a MIME part believed to be part of the
35146 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
35147 follows:
35148
35149 .olist
35150 The outermost MIME part of a message is always a cover letter.
35151
35152 .next
35153 If a multipart/alternative or multipart/related MIME part is a cover letter,
35154 so are all MIME subparts within that multipart.
35155
35156 .next
35157 If any other multipart is a cover letter, the first subpart is a cover letter,
35158 and the rest are attachments.
35159
35160 .next
35161 All parts contained within an attachment multipart are attachments.
35162 .endlist olist
35163
35164 As an example, the following will ban &"HTML mail"& (including that sent with
35165 alternative plain text), while allowing HTML files to be attached. HTML
35166 coverletter mail attached to non-HTML coverletter mail will also be allowed:
35167 .code
35168 deny !condition = $mime_is_rfc822
35169      condition = $mime_is_coverletter
35170      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
35171      message = HTML mail is not accepted here
35172 .endd
35173
35174 .vitem &$mime_is_multipart$&
35175 .vindex &$mime_is_multipart$&
35176 This variable has the value 1 (true) when the current part has the main type
35177 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
35178 Since multipart entities only serve as containers for other parts, you may not
35179 want to carry out specific actions on them.
35180
35181 .vitem &$mime_is_rfc822$&
35182 .vindex &$mime_is_rfc822$&
35183 This variable has the value 1 (true) if the current part is not a part of the
35184 checked message itself, but part of an attached message. Attached message
35185 decoding is fully recursive.
35186
35187 .vitem &$mime_part_count$&
35188 .vindex &$mime_part_count$&
35189 This variable is a counter that is raised for each processed MIME part. It
35190 starts at zero for the very first part (which is usually a multipart). The
35191 counter is per-message, so it is reset when processing RFC822 attachments (see
35192 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
35193 complete, so you can use it in the DATA ACL to determine the number of MIME
35194 parts of a message. For non-MIME messages, this variable contains the value -1.
35195 .endlist
35196
35197
35198
35199 .section "Scanning with regular expressions" "SECTscanregex"
35200 .cindex "content scanning" "with regular expressions"
35201 .cindex "regular expressions" "content scanning with"
35202 You can specify your own custom regular expression matches on the full body of
35203 the message, or on individual MIME parts.
35204
35205 The &%regex%& condition takes one or more regular expressions as arguments and
35206 matches them against the full message (when called in the DATA ACL) or a raw
35207 MIME part (when called in the MIME ACL). The &%regex%& condition matches
35208 linewise, with a maximum line length of 32K characters. That means you cannot
35209 have multiline matches with the &%regex%& condition.
35210
35211 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
35212 to 32K of decoded content (the whole content at once, not linewise). If the
35213 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
35214 is decoded automatically when &%mime_regex%& is executed (using default path
35215 and filename values). If the decoded data is larger than  32K, only the first
35216 32K characters are checked.
35217
35218 The regular expressions are passed as a colon-separated list. To include a
35219 literal colon, you must double it. Since the whole right-hand side string is
35220 expanded before being used, you must also escape dollar signs and backslashes
35221 with more backslashes, or use the &`\N`& facility to disable expansion.
35222 Here is a simple example that contains two regular expressions:
35223 .code
35224 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
35225      message = contains blacklisted regex ($regex_match_string)
35226 .endd
35227 The conditions returns true if any one of the regular expressions matches. The
35228 &$regex_match_string$& expansion variable is then set up and contains the
35229 matching regular expression.
35230 The expansion variables &$regex1$& &$regex2$& etc
35231 are set to any substrings captured by the regular expression.
35232
35233 &*Warning*&: With large messages, these conditions can be fairly
35234 CPU-intensive.
35235
35236 .ecindex IIDcosca
35237
35238
35239
35240
35241 . ////////////////////////////////////////////////////////////////////////////
35242 . ////////////////////////////////////////////////////////////////////////////
35243
35244 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
35245          "Local scan function"
35246 .scindex IIDlosca "&[local_scan()]& function" "description of"
35247 .cindex "customizing" "input scan using C function"
35248 .cindex "policy control" "by local scan function"
35249 In these days of email worms, viruses, and ever-increasing spam, some sites
35250 want to apply a lot of checking to messages before accepting them.
35251
35252 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
35253 passing messages to external virus and spam scanning software. You can also do
35254 a certain amount in Exim itself through string expansions and the &%condition%&
35255 condition in the ACL that runs after the SMTP DATA command or the ACL for
35256 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
35257
35258 To allow for further customization to a site's own requirements, there is the
35259 possibility of linking Exim with a private message scanning function, written
35260 in C. If you want to run code that is written in something other than C, you
35261 can of course use a little C stub to call it.
35262
35263 The local scan function is run once for every incoming message, at the point
35264 when Exim is just about to accept the message.
35265 It can therefore be used to control non-SMTP messages from local processes as
35266 well as messages arriving via SMTP.
35267
35268 Exim applies a timeout to calls of the local scan function, and there is an
35269 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
35270 Zero means &"no timeout"&.
35271 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
35272 before calling the local scan function, so that the most common types of crash
35273 are caught. If the timeout is exceeded or one of those signals is caught, the
35274 incoming message is rejected with a temporary error if it is an SMTP message.
35275 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
35276 code. The incident is logged on the main and reject logs.
35277
35278
35279
35280 .section "Building Exim to use a local scan function" "SECID207"
35281 .cindex "&[local_scan()]& function" "building Exim to use"
35282 To make use of the local scan function feature, you must tell Exim where your
35283 function is before building Exim, by setting
35284 both HAVE_LOCAL_SCAN and
35285 LOCAL_SCAN_SOURCE in your
35286 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
35287 directory, so you might set
35288 .code
35289 HAVE_LOCAL_SCAN=yes
35290 LOCAL_SCAN_SOURCE=Local/local_scan.c
35291 .endd
35292 for example. The function must be called &[local_scan()]&;
35293 the source file(s) for it should first #define LOCAL_SCAN
35294 and then #include "local_scan.h".
35295 It is called by
35296 Exim after it has received a message, when the success return code is about to
35297 be sent. This is after all the ACLs have been run. The return code from your
35298 function controls whether the message is actually accepted or not. There is a
35299 commented template function (that just accepts the message) in the file
35300 _src/local_scan.c_.
35301
35302 If you want to make use of Exim's runtime configuration file to set options
35303 for your &[local_scan()]& function, you must also set
35304 .code
35305 LOCAL_SCAN_HAS_OPTIONS=yes
35306 .endd
35307 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
35308
35309
35310
35311
35312 .section "API for local_scan()" "SECTapiforloc"
35313 .cindex "&[local_scan()]& function" "API description"
35314 .cindex &%dlfunc%& "API description"
35315 You must include this line near the start of your code:
35316 .code
35317 #define LOCAL_SCAN
35318 #include "local_scan.h"
35319 .endd
35320 This header file defines a number of variables and other values, and the
35321 prototype for the function itself. Exim is coded to use unsigned char values
35322 almost exclusively, and one of the things this header defines is a shorthand
35323 for &`unsigned char`& called &`uschar`&.
35324 It also makes available the following macro definitions, to simplify casting character
35325 strings and pointers to character strings:
35326 .code
35327 #define CS   (char *)
35328 #define CCS  (const char *)
35329 #define CSS  (char **)
35330 #define US   (unsigned char *)
35331 #define CUS  (const unsigned char *)
35332 #define USS  (unsigned char **)
35333 .endd
35334 The function prototype for &[local_scan()]& is:
35335 .code
35336 extern int local_scan(int fd, uschar **return_text);
35337 .endd
35338 The arguments are as follows:
35339
35340 .ilist
35341 &%fd%& is a file descriptor for the file that contains the body of the message
35342 (the -D file). The file is open for reading and writing, but updating it is not
35343 recommended. &*Warning*&: You must &'not'& close this file descriptor.
35344
35345 The descriptor is positioned at character 26 of the file, which is the first
35346 character of the body itself, because the first 26 characters (19 characters
35347 before Exim  4.97) are the message id followed by &`-D`& and a newline.
35348 If you rewind the file, you should use the
35349 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
35350 case this changes in some future version.
35351 .next
35352 &%return_text%& is an address which you can use to return a pointer to a text
35353 string at the end of the function. The value it points to on entry is NULL.
35354 .endlist
35355
35356 The function must return an &%int%& value which is one of the following macros:
35357
35358 .vlist
35359 .vitem &`LOCAL_SCAN_ACCEPT`&
35360 .vindex "&$local_scan_data$&"
35361 The message is accepted. If you pass back a string of text, it is saved with
35362 the message, and made available in the variable &$local_scan_data$&. No
35363 newlines are permitted (if there are any, they are turned into spaces) and the
35364 maximum length of text is 1000 characters.
35365
35366 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35367 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35368 queued without immediate delivery, and is frozen.
35369
35370 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35371 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35372 queued without immediate delivery.
35373
35374 .vitem &`LOCAL_SCAN_REJECT`&
35375 The message is rejected; the returned text is used as an error message which is
35376 passed back to the sender and which is also logged. Newlines are permitted &--
35377 they cause a multiline response for SMTP rejections, but are converted to
35378 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35379 used.
35380
35381 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35382 The message is temporarily rejected; the returned text is used as an error
35383 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35384 problem"& is used.
35385
35386 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35387 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35388 message is not written to the reject log. It has the effect of unsetting the
35389 &%rejected_header%& log selector for just this rejection. If
35390 &%rejected_header%& is already unset (see the discussion of the
35391 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35392 same as LOCAL_SCAN_REJECT.
35393
35394 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35395 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35396 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35397 .endlist
35398
35399 If the message is not being received by interactive SMTP, rejections are
35400 reported by writing to &%stderr%& or by sending an email, as configured by the
35401 &%-oe%& command line options.
35402
35403
35404
35405 .section "Configuration options for local_scan()" "SECTconoptloc"
35406 .cindex "&[local_scan()]& function" "configuration options"
35407 It is possible to have option settings in the main configuration file
35408 that set values in static variables in the &[local_scan()]& module. If you
35409 want to do this, you must have the line
35410 .code
35411 LOCAL_SCAN_HAS_OPTIONS=yes
35412 .endd
35413 in your &_Local/Makefile_& when you build Exim. (This line is in
35414 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35415 file, you must define static variables to hold the option values, and a table
35416 to define them.
35417
35418 The table must be a vector called &%local_scan_options%&, of type
35419 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35420 and a pointer to the variable that holds the value. The entries must appear in
35421 alphabetical order. Following &%local_scan_options%& you must also define a
35422 variable called &%local_scan_options_count%& that contains the number of
35423 entries in the table. Here is a short example, showing two kinds of option:
35424 .code
35425 static int my_integer_option = 42;
35426 static uschar *my_string_option = US"a default string";
35427
35428 optionlist local_scan_options[] = {
35429   { "my_integer", opt_int,       &my_integer_option },
35430   { "my_string",  opt_stringptr, &my_string_option }
35431 };
35432
35433 int local_scan_options_count =
35434   sizeof(local_scan_options)/sizeof(optionlist);
35435 .endd
35436 The values of the variables can now be changed from Exim's runtime
35437 configuration file by including a local scan section as in this example:
35438 .code
35439 begin local_scan
35440 my_integer = 99
35441 my_string = some string of text...
35442 .endd
35443 The available types of option data are as follows:
35444
35445 .vlist
35446 .vitem &*opt_bool*&
35447 This specifies a boolean (true/false) option. The address should point to a
35448 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35449 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35450 whether such a variable has been set at all, you can initialize it to
35451 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35452 values.)
35453
35454 .vitem &*opt_fixed*&
35455 This specifies a fixed point number, such as is used for load averages.
35456 The address should point to a variable of type &`int`&. The value is stored
35457 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35458
35459 .vitem &*opt_int*&
35460 This specifies an integer; the address should point to a variable of type
35461 &`int`&. The value may be specified in any of the integer formats accepted by
35462 Exim.
35463
35464 .vitem &*opt_mkint*&
35465 This is the same as &%opt_int%&, except that when such a value is output in a
35466 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35467 printed with the suffix K or M.
35468
35469 .vitem &*opt_octint*&
35470 This also specifies an integer, but the value is always interpreted as an
35471 octal integer, whether or not it starts with the digit zero, and it is
35472 always output in octal.
35473
35474 .vitem &*opt_stringptr*&
35475 This specifies a string value; the address must be a pointer to a
35476 variable that points to a string (for example, of type &`uschar *`&).
35477
35478 .vitem &*opt_time*&
35479 This specifies a time interval value. The address must point to a variable of
35480 type &`int`&. The value that is placed there is a number of seconds.
35481 .endlist
35482
35483 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35484 out the values of all the &[local_scan()]& options.
35485
35486
35487
35488 .section "Available Exim variables" "SECID208"
35489 .cindex "&[local_scan()]& function" "available Exim variables"
35490 The header &_local_scan.h_& gives you access to a number of C variables. These
35491 are the only ones that are guaranteed to be maintained from release to release.
35492 Note, however, that you can obtain the value of any Exim expansion variable,
35493 including &$recipients$&, by calling &'expand_string()'&. The exported
35494 C variables are as follows:
35495
35496 .vlist
35497 .vitem &*int&~body_linecount*&
35498 This variable contains the number of lines in the message's body.
35499 It is not valid if the &%spool_wireformat%& option is used.
35500
35501 .vitem &*int&~body_zerocount*&
35502 This variable contains the number of binary zero bytes in the message's body.
35503 It is not valid if the &%spool_wireformat%& option is used.
35504
35505 .vitem &*unsigned&~int&~debug_selector*&
35506 This variable is set to zero when no debugging is taking place. Otherwise, it
35507 is a bitmap of debugging selectors. Two bits are identified for use in
35508 &[local_scan()]&; they are defined as macros:
35509
35510 .ilist
35511 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35512 testing option that is not privileged &-- any caller may set it. All the
35513 other selector bits can be set only by admin users.
35514
35515 .next
35516 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35517 by the &`+local_scan`& debug selector. It is not included in the default set
35518 of debugging bits.
35519 .endlist ilist
35520
35521 Thus, to write to the debugging output only when &`+local_scan`& has been
35522 selected, you should use code like this:
35523 .code
35524 if ((debug_selector & D_local_scan) != 0)
35525   debug_printf("xxx", ...);
35526 .endd
35527 .vitem &*uschar&~*expand_string_message*&
35528 After a failing call to &'expand_string()'& (returned value NULL), the
35529 variable &%expand_string_message%& contains the error message, zero-terminated.
35530
35531 .vitem &*header_line&~*header_list*&
35532 A pointer to a chain of header lines. The &%header_line%& structure is
35533 discussed below.
35534
35535 .vitem &*header_line&~*header_last*&
35536 A pointer to the last of the header lines.
35537
35538 .vitem &*const&~uschar&~*headers_charset*&
35539 The value of the &%headers_charset%& configuration option.
35540
35541 .vitem &*BOOL&~host_checking*&
35542 This variable is TRUE during a host checking session that is initiated by the
35543 &%-bh%& command line option.
35544
35545 .vitem &*uschar&~*interface_address*&
35546 The IP address of the interface that received the message, as a string. This
35547 is NULL for locally submitted messages.
35548
35549 .vitem &*int&~interface_port*&
35550 The port on which this message was received. When testing with the &%-bh%&
35551 command line option, the value of this variable is -1 unless a port has been
35552 specified via the &%-oMi%& option.
35553
35554 .vitem &*uschar&~*message_id*&
35555 This variable contains Exim's message id for the incoming message (the value of
35556 &$message_exim_id$&) as a zero-terminated string.
35557
35558 .vitem &*uschar&~*received_protocol*&
35559 The name of the protocol by which the message was received.
35560
35561 .vitem &*int&~recipients_count*&
35562 The number of accepted recipients.
35563
35564 .vitem &*recipient_item&~*recipients_list*&
35565 .cindex "recipient" "adding in local scan"
35566 .cindex "recipient" "removing in local scan"
35567 The list of accepted recipients, held in a vector of length
35568 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35569 can add additional recipients by calling &'receive_add_recipient()'& (see
35570 below). You can delete recipients by removing them from the vector and
35571 adjusting the value in &%recipients_count%&. In particular, by setting
35572 &%recipients_count%& to zero you remove all recipients. If you then return the
35573 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35574 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35575 and then call &'receive_add_recipient()'& as often as needed.
35576
35577 .vitem &*uschar&~*sender_address*&
35578 The envelope sender address. For bounce messages this is the empty string.
35579
35580 .vitem &*uschar&~*sender_host_address*&
35581 The IP address of the sending host, as a string. This is NULL for
35582 locally-submitted messages.
35583
35584 .vitem &*uschar&~*sender_host_authenticated*&
35585 The name of the authentication mechanism that was used, or NULL if the message
35586 was not received over an authenticated SMTP connection.
35587
35588 .vitem &*uschar&~*sender_host_name*&
35589 The name of the sending host, if known.
35590
35591 .vitem &*int&~sender_host_port*&
35592 The port on the sending host.
35593
35594 .vitem &*BOOL&~smtp_input*&
35595 This variable is TRUE for all SMTP input, including BSMTP.
35596
35597 .vitem &*BOOL&~smtp_batched_input*&
35598 This variable is TRUE for BSMTP input.
35599
35600 .vitem &*int&~store_pool*&
35601 The contents of this variable control which pool of memory is used for new
35602 requests. See section &<<SECTmemhanloc>>& for details.
35603 .endlist
35604
35605
35606 .section "Structure of header lines" "SECID209"
35607 The &%header_line%& structure contains the members listed below.
35608 You can add additional header lines by calling the &'header_add()'& function
35609 (see below). You can cause header lines to be ignored (deleted) by setting
35610 their type to *.
35611
35612
35613 .vlist
35614 .vitem &*struct&~header_line&~*next*&
35615 A pointer to the next header line, or NULL for the last line.
35616
35617 .vitem &*int&~type*&
35618 A code identifying certain headers that Exim recognizes. The codes are printing
35619 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35620 Notice in particular that any header line whose type is * is not transmitted
35621 with the message. This flagging is used for header lines that have been
35622 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35623 lines.) Effectively, * means &"deleted"&.
35624
35625 .vitem &*int&~slen*&
35626 The number of characters in the header line, including the terminating and any
35627 internal newlines.
35628
35629 .vitem &*uschar&~*text*&
35630 A pointer to the text of the header. It always ends with a newline, followed by
35631 a zero byte. Internal newlines are preserved.
35632 .endlist
35633
35634
35635
35636 .section "Structure of recipient items" "SECID210"
35637 The &%recipient_item%& structure contains these members:
35638
35639 .vlist
35640 .vitem &*uschar&~*address*&
35641 This is a pointer to the recipient address as it was received.
35642
35643 .vitem &*int&~pno*&
35644 This is used in later Exim processing when top level addresses are created by
35645 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35646 and must always contain -1 at this stage.
35647
35648 .vitem &*uschar&~*errors_to*&
35649 If this value is not NULL, bounce messages caused by failing to deliver to the
35650 recipient are sent to the address it contains. In other words, it overrides the
35651 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35652 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35653 an unqualified address, Exim qualifies it using the domain from
35654 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35655 is NULL for all recipients.
35656 .endlist
35657
35658
35659
35660 .section "Available Exim functions" "SECID211"
35661 .cindex "&[local_scan()]& function" "available Exim functions"
35662 The header &_local_scan.h_& gives you access to a number of Exim functions.
35663 These are the only ones that are guaranteed to be maintained from release to
35664 release:
35665
35666 .vlist
35667 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35668        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35669
35670 This function creates a child process that runs the command specified by
35671 &%argv%&. The environment for the process is specified by &%envp%&, which can
35672 be NULL if no environment variables are to be passed. A new umask is supplied
35673 for the process in &%newumask%&.
35674
35675 Pipes to the standard input and output of the new process are set up
35676 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35677 standard error is cloned to the standard output. If there are any file
35678 descriptors &"in the way"& in the new process, they are closed. If the final
35679 argument is TRUE, the new process is made into a process group leader.
35680
35681 The function returns the pid of the new process, or -1 if things go wrong.
35682
35683 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35684 This function waits for a child process to terminate, or for a timeout (in
35685 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35686 return value is as follows:
35687
35688 .ilist
35689 >= 0
35690
35691 The process terminated by a normal exit and the value is the process
35692 ending status.
35693
35694 .next
35695 < 0 and > &--256
35696
35697 The process was terminated by a signal and the value is the negation of the
35698 signal number.
35699
35700 .next
35701 &--256
35702
35703 The process timed out.
35704 .next
35705 &--257
35706
35707 The was some other error in wait(); &%errno%& is still set.
35708 .endlist
35709
35710 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35711 This function provide you with a means of submitting a new message to
35712 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35713 want, but this packages it all up for you.) The function creates a pipe,
35714 forks a subprocess that is running
35715 .code
35716 exim -t -oem -oi -f <>
35717 .endd
35718 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35719 that is connected to the standard input. The yield of the function is the PID
35720 of the subprocess. You can then write a message to the file descriptor, with
35721 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35722
35723 When you have finished, call &'child_close()'& to wait for the process to
35724 finish and to collect its ending status. A timeout value of zero is usually
35725 fine in this circumstance. Unless you have made a mistake with the recipient
35726 addresses, you should get a return code of zero.
35727
35728
35729 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35730        *sender_authentication)*&
35731 This function is a more sophisticated version of &'child_open()'&. The command
35732 that it runs is:
35733 .display
35734 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35735 .endd
35736 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35737
35738
35739 .vitem &*void&~debug_printf(char&~*,&~...)*&
35740 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35741 output is written to the standard error stream. If no debugging is selected,
35742 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35743 conditional on the &`local_scan`& debug selector by coding like this:
35744 .code
35745 if ((debug_selector & D_local_scan) != 0)
35746   debug_printf("xxx", ...);
35747 .endd
35748
35749 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35750 This is an interface to Exim's string expansion code. The return value is the
35751 expanded string, or NULL if there was an expansion failure.
35752 The C variable &%expand_string_message%& contains an error message after an
35753 expansion failure. If expansion does not change the string, the return value is
35754 the pointer to the input string. Otherwise, the return value points to a new
35755 block of memory that was obtained by a call to &'store_get()'&. See section
35756 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35757
35758 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35759 This function allows you to an add additional header line at the end of the
35760 existing ones. The first argument is the type, and should normally be a space
35761 character. The second argument is a format string and any number of
35762 substitution arguments as for &[sprintf()]&. You may include internal newlines
35763 if you want, and you must ensure that the string ends with a newline.
35764
35765 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35766         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35767 This function adds a new header line at a specified point in the header
35768 chain. The header itself is specified as for &'header_add()'&.
35769
35770 If &%name%& is NULL, the new header is added at the end of the chain if
35771 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35772 NULL, the header lines are searched for the first non-deleted header that
35773 matches the name. If one is found, the new header is added before it if
35774 &%after%& is false. If &%after%& is true, the new header is added after the
35775 found header and any adjacent subsequent ones with the same name (even if
35776 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35777 option controls where the header is added. If it is true, addition is at the
35778 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35779 headers, or at the top if there are no &'Received:'& headers, you could use
35780 .code
35781 header_add_at_position(TRUE, US"Received", TRUE,
35782   ' ', "X-xxx: ...");
35783 .endd
35784 Normally, there is always at least one non-deleted &'Received:'& header, but
35785 there may not be if &%received_header_text%& expands to an empty string.
35786
35787
35788 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35789 This function removes header lines. If &%occurrence%& is zero or negative, all
35790 occurrences of the header are removed. If occurrence is greater than zero, that
35791 particular instance of the header is removed. If no header(s) can be found that
35792 match the specification, the function does nothing.
35793
35794
35795 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35796         int&~length,&~BOOL&~notdel)*&"
35797 This function tests whether the given header has the given name. It is not just
35798 a string comparison, because white space is permitted between the name and the
35799 colon. If the &%notdel%& argument is true, a false return is forced for all
35800 &"deleted"& headers; otherwise they are not treated specially. For example:
35801 .code
35802 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35803 .endd
35804 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35805 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35806 This function base64-encodes a string, which is passed by address and length.
35807 The text may contain bytes of any value, including zero. The result is passed
35808 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35809 zero-terminated.
35810
35811 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35812 This function decodes a base64-encoded string. Its arguments are a
35813 zero-terminated base64-encoded string and the address of a variable that is set
35814 to point to the result, which is in dynamic memory. The length of the decoded
35815 string is the yield of the function. If the input is invalid base64 data, the
35816 yield is -1. A zero byte is added to the end of the output string to make it
35817 easy to interpret as a C string (assuming it contains no zeros of its own). The
35818 added zero byte is not included in the returned count.
35819
35820 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35821 This function checks for a match in a domain list. Domains are always
35822 matched caselessly. The return value is one of the following:
35823 .itable none 0 0 2 15* left 85* left
35824 .irow &`OK`&    "match succeeded"
35825 .irow &`FAIL`&  "match failed"
35826 .irow &`DEFER`& "match deferred"
35827 .endtable
35828 DEFER is usually caused by some kind of lookup defer, such as the
35829 inability to contact a database.
35830
35831 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35832         BOOL&~caseless)*&"
35833 This function checks for a match in a local part list. The third argument
35834 controls case-sensitivity. The return values are as for
35835 &'lss_match_domain()'&.
35836
35837 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35838         BOOL&~caseless)*&"
35839 This function checks for a match in an address list. The third argument
35840 controls the case-sensitivity of the local part match. The domain is always
35841 matched caselessly. The return values are as for &'lss_match_domain()'&.
35842
35843 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35844         uschar&~*list)*&"
35845 This function checks for a match in a host list. The most common usage is
35846 expected to be
35847 .code
35848 lss_match_host(sender_host_name, sender_host_address, ...)
35849 .endd
35850 .vindex "&$sender_host_address$&"
35851 An empty address field matches an empty item in the host list. If the host name
35852 is NULL, the name corresponding to &$sender_host_address$& is automatically
35853 looked up if a host name is required to match an item in the list. The return
35854 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35855 returns ERROR in the case when it had to look up a host name, but the lookup
35856 failed.
35857
35858 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35859         *format,&~...)*&"
35860 This function writes to Exim's log files. The first argument should be zero (it
35861 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35862 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35863 them. It specifies to which log or logs the message is written. The remaining
35864 arguments are a format and relevant insertion arguments. The string should not
35865 contain any newlines, not even at the end.
35866
35867
35868 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35869 This function adds an additional recipient to the message. The first argument
35870 is the recipient address. If it is unqualified (has no domain), it is qualified
35871 with the &%qualify_recipient%& domain. The second argument must always be -1.
35872
35873 This function does not allow you to specify a private &%errors_to%& address (as
35874 described with the structure of &%recipient_item%& above), because it pre-dates
35875 the addition of that field to the structure. However, it is easy to add such a
35876 value afterwards. For example:
35877 .code
35878  receive_add_recipient(US"monitor@mydom.example", -1);
35879  recipients_list[recipients_count-1].errors_to =
35880    US"postmaster@mydom.example";
35881 .endd
35882
35883 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35884 This is a convenience function to remove a named recipient from the list of
35885 recipients. It returns true if a recipient was removed, and false if no
35886 matching recipient could be found. The argument must be a complete email
35887 address.
35888 .endlist
35889
35890
35891 .cindex "RFC 2047"
35892 .vlist
35893 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35894   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35895 This function decodes strings that are encoded according to RFC 2047. Typically
35896 these are the contents of header lines. First, each &"encoded word"& is decoded
35897 from the Q or B encoding into a byte-string. Then, if provided with the name of
35898 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35899 made  to translate the result to the named character set. If this fails, the
35900 binary string is returned with an error message.
35901
35902 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35903 maximum MIME word length is enforced. The third argument is the target
35904 encoding, or NULL if no translation is wanted.
35905
35906 .cindex "binary zero" "in RFC 2047 decoding"
35907 .cindex "RFC 2047" "binary zero in"
35908 If a binary zero is encountered in the decoded string, it is replaced by the
35909 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35910 not be 0 because header lines are handled as zero-terminated strings.
35911
35912 The function returns the result of processing the string, zero-terminated; if
35913 &%lenptr%& is not NULL, the length of the result is set in the variable to
35914 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35915
35916 If an error is encountered, the function returns NULL and uses the &%error%&
35917 argument to return an error message. The variable pointed to by &%error%& is
35918 set to NULL if there is no error; it may be set non-NULL even when the function
35919 returns a non-NULL value if decoding was successful, but there was a problem
35920 with translation.
35921
35922
35923 .vitem &*int&~smtp_fflush(void)*&
35924 This function is used in conjunction with &'smtp_printf()'&, as described
35925 below.
35926
35927 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35928 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35929 output stream. You should use this function only when there is an SMTP output
35930 stream, that is, when the incoming message is being received via interactive
35931 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35932 is FALSE. If you want to test for an incoming message from another host (as
35933 opposed to a local process that used the &%-bs%& command line option), you can
35934 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35935 is involved.
35936
35937 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35938 output function, so it can be used for all forms of SMTP connection.
35939
35940 The second argument is used to request that the data be buffered
35941 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35942 This is advisory only, but likely to save on system-calls and packets
35943 sent when a sequence of calls to the function are made.
35944
35945 The argument was added in Exim version 4.90 - changing the API/ABI.
35946 Nobody noticed until 4.93 was imminent, at which point the
35947 ABI version number was incremented.
35948
35949 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35950 must start with an appropriate response code: 550 if you are going to return
35951 LOCAL_SCAN_REJECT, 451 if you are going to return
35952 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35953 initial lines of a multi-line response, the code must be followed by a hyphen
35954 to indicate that the line is not the final response line. You must also ensure
35955 that the lines you write terminate with CRLF. For example:
35956 .code
35957 smtp_printf("550-this is some extra info\r\n");
35958 return LOCAL_SCAN_REJECT;
35959 .endd
35960 Note that you can also create multi-line responses by including newlines in
35961 the data returned via the &%return_text%& argument. The added value of using
35962 &'smtp_printf()'& is that, for instance, you could introduce delays between
35963 multiple output lines.
35964
35965 The &'smtp_printf()'& function does not return any error indication, because it
35966 does not
35967 guarantee a flush of
35968 pending output, and therefore does not test
35969 the state of the stream. (In the main code of Exim, flushing and error
35970 detection is done when Exim is ready for the next SMTP input command.) If
35971 you want to flush the output and check for an error (for example, the
35972 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35973 arguments. It flushes the output stream, and returns a non-zero value if there
35974 is an error.
35975
35976 .vitem &*void&~*store_get(int,BOOL)*&
35977 This function accesses Exim's internal store (memory) manager. It gets a new
35978 chunk of memory whose size is given by the first argument.
35979 The second argument should be given as TRUE if the memory will be used for
35980 data possibly coming from an attacker (eg. the message content),
35981 FALSE if it is locally-sourced.
35982 Exim bombs out if it ever
35983 runs out of memory. See the next section for a discussion of memory handling.
35984
35985 .vitem &*void&~*store_get_perm(int,BOOL)*&
35986 This function is like &'store_get()'&, but it always gets memory from the
35987 permanent pool. See the next section for a discussion of memory handling.
35988
35989 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35990 See below.
35991
35992 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35993 See below.
35994
35995 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35996 These three functions create strings using Exim's dynamic memory facilities.
35997 The first makes a copy of an entire string. The second copies up to a maximum
35998 number of characters, indicated by the second argument. The third uses a format
35999 and insertion arguments to create a new string. In each case, the result is a
36000 pointer to a new string in the current memory pool. See the next section for
36001 more discussion.
36002 .endlist
36003
36004
36005
36006 .section "More about Exim's memory handling" "SECTmemhanloc"
36007 .cindex "&[local_scan()]& function" "memory handling"
36008 No function is provided for freeing memory, because that is never needed.
36009 The dynamic memory that Exim uses when receiving a message is automatically
36010 recycled if another message is received by the same process (this applies only
36011 to incoming SMTP connections &-- other input methods can supply only one
36012 message at a time). After receiving the last message, a reception process
36013 terminates.
36014
36015 Because it is recycled, the normal dynamic memory cannot be used for holding
36016 data that must be preserved over a number of incoming messages on the same SMTP
36017 connection. However, Exim in fact uses two pools of dynamic memory; the second
36018 one is not recycled, and can be used for this purpose.
36019
36020 If you want to allocate memory that remains available for subsequent messages
36021 in the same SMTP connection, you should set
36022 .code
36023 store_pool = POOL_PERM
36024 .endd
36025 before calling the function that does the allocation. There is no need to
36026 restore the value if you do not need to; however, if you do want to revert to
36027 the normal pool, you can either restore the previous value of &%store_pool%& or
36028 set it explicitly to POOL_MAIN.
36029
36030 The pool setting applies to all functions that get dynamic memory, including
36031 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
36032 There is also a convenience function called &'store_get_perm()'& that gets a
36033 block of memory from the permanent pool while preserving the value of
36034 &%store_pool%&.
36035 .ecindex IIDlosca
36036
36037
36038
36039
36040 . ////////////////////////////////////////////////////////////////////////////
36041 . ////////////////////////////////////////////////////////////////////////////
36042
36043 .chapter "System-wide message filtering" "CHAPsystemfilter"
36044 .scindex IIDsysfil1 "filter" "system filter"
36045 .scindex IIDsysfil2 "filtering all mail"
36046 .scindex IIDsysfil3 "system filter"
36047 The previous chapters (on ACLs and the local scan function) describe checks
36048 that can be applied to messages before they are accepted by a host. There is
36049 also a mechanism for checking messages once they have been received, but before
36050 they are delivered. This is called the &'system filter'&.
36051
36052 The system filter operates in a similar manner to users' filter files, but it
36053 is run just once per message (however many recipients the message has).
36054 It should not normally be used as a substitute for routing, because &%deliver%&
36055 commands in a system router provide new envelope recipient addresses.
36056 The system filter must be an Exim filter. It cannot be a Sieve filter.
36057
36058 The system filter is run at the start of a delivery attempt, before any routing
36059 is done. If a message fails to be completely delivered at the first attempt,
36060 the system filter is run again at the start of every retry.
36061 If you want your filter to do something only once per message, you can make use
36062 .cindex retry condition
36063 of the &%first_delivery%& condition in an &%if%& command in the filter to
36064 prevent it happening on retries.
36065
36066 .vindex "&$domain$&"
36067 .vindex "&$local_part$&"
36068 &*Warning*&: Because the system filter runs just once, variables that are
36069 specific to individual recipient addresses, such as &$local_part$& and
36070 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
36071 you want to run a centrally-specified filter for each recipient address
36072 independently, you can do so by setting up a suitable &(redirect)& router, as
36073 described in section &<<SECTperaddfil>>& below.
36074
36075
36076 .section "Specifying a system filter" "SECID212"
36077 .cindex "uid (user id)" "system filter"
36078 .cindex "gid (group id)" "system filter"
36079 The name of the file that contains the system filter must be specified by
36080 setting &%system_filter%&. If you want the filter to run under a uid and gid
36081 other than root, you must also set &%system_filter_user%& and
36082 &%system_filter_group%& as appropriate. For example:
36083 .code
36084 system_filter = /etc/mail/exim.filter
36085 system_filter_user = exim
36086 .endd
36087 If a system filter generates any deliveries directly to files or pipes (via the
36088 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
36089 specified by setting &%system_filter_file_transport%& and
36090 &%system_filter_pipe_transport%&, respectively. Similarly,
36091 &%system_filter_reply_transport%& must be set to handle any messages generated
36092 by the &%reply%& command.
36093
36094
36095 .section "Testing a system filter" "SECID213"
36096 You can run simple tests of a system filter in the same way as for a user
36097 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
36098 are permitted only in system filters are recognized.
36099
36100 If you want to test the combined effect of a system filter and a user filter,
36101 you can use both &%-bF%& and &%-bf%& on the same command line.
36102
36103
36104
36105 .section "Contents of a system filter" "SECID214"
36106 The language used to specify system filters is the same as for users' filter
36107 files. It is described in the separate end-user document &'Exim's interface to
36108 mail filtering'&. However, there are some additional features that are
36109 available only in system filters; these are described in subsequent sections.
36110 If they are encountered in a user's filter file or when testing with &%-bf%&,
36111 they cause errors.
36112
36113 .cindex "frozen messages" "manual thaw; testing in filter"
36114 There are two special conditions which, though available in users' filter
36115 files, are designed for use in system filters. The condition &%first_delivery%&
36116 is true only for the first attempt at delivering a message, and
36117 &%manually_thawed%& is true only if the message has been frozen, and
36118 subsequently thawed by an admin user. An explicit forced delivery counts as a
36119 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
36120
36121 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
36122 specify an &"unseen"& (non-significant) delivery, and that delivery does not
36123 succeed, it will not be tried again.
36124 If you want Exim to retry an unseen delivery until it succeeds, you should
36125 arrange to set it up every time the filter runs.
36126
36127 When a system filter finishes running, the values of the variables &$n0$& &--
36128 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
36129 users' filter files. Thus a system filter can, for example, set up &"scores"&
36130 to which users' filter files can refer.
36131
36132
36133
36134 .section "Additional variable for system filters" "SECID215"
36135 .vindex "&$recipients$&"
36136 The expansion variable &$recipients$&, containing a list of all the recipients
36137 of the message (separated by commas and white space), is available in system
36138 filters. It is not available in users' filters for privacy reasons.
36139
36140
36141
36142 .section "Defer, freeze, and fail commands for system filters" "SECID216"
36143 .cindex "freezing messages"
36144 .cindex "message" "freezing"
36145 .cindex "message" "forced failure"
36146 .cindex "&%fail%&" "in system filter"
36147 .cindex "&%freeze%& in system filter"
36148 .cindex "&%defer%& in system filter"
36149 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
36150 always available in system filters, but are not normally enabled in users'
36151 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
36152 for the &(redirect)& router.) These commands can optionally be followed by the
36153 word &%text%& and a string containing an error message, for example:
36154 .code
36155 fail text "this message looks like spam to me"
36156 .endd
36157 The keyword &%text%& is optional if the next character is a double quote.
36158
36159 The &%defer%& command defers delivery of the original recipients of the
36160 message. The &%fail%& command causes all the original recipients to be failed,
36161 and a bounce message to be created. The &%freeze%& command suspends all
36162 delivery attempts for the original recipients. In all cases, any new deliveries
36163 that are specified by the filter are attempted as normal after the filter has
36164 run.
36165
36166 The &%freeze%& command is ignored if the message has been manually unfrozen and
36167 not manually frozen since. This means that automatic freezing by a system
36168 filter can be used as a way of checking out suspicious messages. If a message
36169 is found to be all right, manually unfreezing it allows it to be delivered.
36170
36171 .cindex "log" "&%fail%& command log line"
36172 .cindex "&%fail%&" "log line; reducing"
36173 The text given with a fail command is used as part of the bounce message as
36174 well as being written to the log. If the message is quite long, this can fill
36175 up a lot of log space when such failures are common. To reduce the size of the
36176 log message, Exim interprets the text in a special way if it starts with the
36177 two characters &`<<`& and contains &`>>`& later. The text between these two
36178 strings is written to the log, and the rest of the text is used in the bounce
36179 message. For example:
36180 .code
36181 fail "<<filter test 1>>Your message is rejected \
36182      because it contains attachments that we are \
36183      not prepared to receive."
36184 .endd
36185
36186 .cindex "loop" "caused by &%fail%&"
36187 Take great care with the &%fail%& command when basing the decision to fail on
36188 the contents of the message, because the bounce message will of course include
36189 the contents of the original message and will therefore trigger the &%fail%&
36190 command again (causing a mail loop) unless steps are taken to prevent this.
36191 Testing the &%error_message%& condition is one way to prevent this. You could
36192 use, for example
36193 .code
36194 if $message_body contains "this is spam" and not error_message
36195 then fail text "spam is not wanted here" endif
36196 .endd
36197 though of course that might let through unwanted bounce messages. The
36198 alternative is clever checking of the body and/or headers to detect bounces
36199 generated by the filter.
36200
36201 The interpretation of a system filter file ceases after a
36202 &%defer%&,
36203 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
36204 set up earlier in the filter file are honoured, so you can use a sequence such
36205 as
36206 .code
36207 mail ...
36208 freeze
36209 .endd
36210 to send a specified message when the system filter is freezing (or deferring or
36211 failing) a message. The normal deliveries for the message do not, of course,
36212 take place.
36213
36214
36215
36216 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
36217 .cindex "header lines" "adding; in system filter"
36218 .cindex "header lines" "removing; in system filter"
36219 .cindex "filter" "header lines; adding/removing"
36220 Two filter commands that are available only in system filters are:
36221 .code
36222 headers add <string>
36223 headers remove <string>
36224 .endd
36225 The argument for the &%headers add%& is a string that is expanded and then
36226 added to the end of the message's headers. It is the responsibility of the
36227 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
36228 space is ignored, and if the string is otherwise empty, or if the expansion is
36229 forced to fail, the command has no effect.
36230
36231 You can use &"\n"& within the string, followed by white space, to specify
36232 continued header lines. More than one header may be added in one command by
36233 including &"\n"& within the string without any following white space. For
36234 example:
36235 .code
36236 headers add "X-header-1: ....\n  \
36237              continuation of X-header-1 ...\n\
36238              X-header-2: ...."
36239 .endd
36240 Note that the header line continuation white space after the first newline must
36241 be placed before the backslash that continues the input string, because white
36242 space after input continuations is ignored.
36243
36244 The argument for &%headers remove%& is a colon-separated list of header names.
36245 This command applies only to those headers that are stored with the message;
36246 those that are added at delivery time (such as &'Envelope-To:'& and
36247 &'Return-Path:'&) cannot be removed by this means. If there is more than one
36248 header with the same name, they are all removed.
36249
36250 The &%headers%& command in a system filter makes an immediate change to the set
36251 of header lines that was received with the message (with possible additions
36252 from ACL processing). Subsequent commands in the system filter operate on the
36253 modified set, which also forms the basis for subsequent message delivery.
36254 Unless further modified during routing or transporting, this set of headers is
36255 used for all recipients of the message.
36256
36257 During routing and transporting, the variables that refer to the contents of
36258 header lines refer only to those lines that are in this set. Thus, header lines
36259 that are added by a system filter are visible to users' filter files and to all
36260 routers and transports. This contrasts with the manipulation of header lines by
36261 routers and transports, which is not immediate, but which instead is saved up
36262 until the message is actually being written (see section
36263 &<<SECTheadersaddrem>>&).
36264
36265 If the message is not delivered at the first attempt, header lines that were
36266 added by the system filter are stored with the message, and so are still
36267 present at the next delivery attempt. Header lines that were removed are still
36268 present, but marked &"deleted"& so that they are not transported with the
36269 message. For this reason, it is usual to make the &%headers%& command
36270 conditional on &%first_delivery%& so that the set of header lines is not
36271 modified more than once.
36272
36273 Because header modification in a system filter acts immediately, you have to
36274 use an indirect approach if you want to modify the contents of a header line.
36275 For example:
36276 .code
36277 headers add "Old-Subject: $h_subject:"
36278 headers remove "Subject"
36279 headers add "Subject: new subject (was: $h_old-subject:)"
36280 headers remove "Old-Subject"
36281 .endd
36282
36283
36284
36285 .section "Setting an errors address in a system filter" "SECID217"
36286 .cindex "envelope from"
36287 .cindex "envelope sender"
36288 In a system filter, if a &%deliver%& command is followed by
36289 .code
36290 errors_to <some address>
36291 .endd
36292 in order to change the envelope sender (and hence the error reporting) for that
36293 delivery, any address may be specified. (In a user filter, only the current
36294 user's address can be set.) For example, if some mail is being monitored, you
36295 might use
36296 .code
36297 unseen deliver monitor@spying.example errors_to root@local.example
36298 .endd
36299 to take a copy which would not be sent back to the normal error reporting
36300 address if its delivery failed.
36301
36302
36303
36304 .section "Per-address filtering" "SECTperaddfil"
36305 .vindex "&$domain_data$&"
36306 .vindex "&$local_part_data$&"
36307 In contrast to the system filter, which is run just once per message for each
36308 delivery attempt, it is also possible to set up a system-wide filtering
36309 operation that runs once for each recipient address. In this case, variables
36310 such as &$local_part_data$& and &$domain_data$& can be used,
36311 and indeed, the choice of filter file could be made dependent on them.
36312 This is an example of a router which implements such a filter:
36313 .code
36314 central_filter:
36315   check_local_user
36316   driver = redirect
36317   domains = +local_domains
36318   file = /central/filters/$local_part_data
36319   no_verify
36320   allow_filter
36321   allow_freeze
36322 .endd
36323 The filter is run in a separate process under its own uid. Therefore, either
36324 &%check_local_user%& must be set (as above), in which case the filter is run as
36325 the local user, or the &%user%& option must be used to specify which user to
36326 use. If both are set, &%user%& overrides.
36327
36328 Care should be taken to ensure that none of the commands in the filter file
36329 specify a significant delivery if the message is to go on to be delivered to
36330 its intended recipient. The router will not then claim to have dealt with the
36331 address, so it will be passed on to subsequent routers to be delivered in the
36332 normal way.
36333 .ecindex IIDsysfil1
36334 .ecindex IIDsysfil2
36335 .ecindex IIDsysfil3
36336
36337
36338
36339
36340
36341
36342 . ////////////////////////////////////////////////////////////////////////////
36343 . ////////////////////////////////////////////////////////////////////////////
36344
36345 .chapter "Message processing" "CHAPmsgproc"
36346 .scindex IIDmesproc "message" "general processing"
36347 Exim performs various transformations on the sender and recipient addresses of
36348 all messages that it handles, and also on the messages' header lines. Some of
36349 these are optional and configurable, while others always take place. All of
36350 this processing, except rewriting as a result of routing, and the addition or
36351 removal of header lines while delivering, happens when a message is received,
36352 before it is placed on Exim's queue.
36353
36354 Some of the automatic processing takes place by default only for
36355 &"locally-originated"& messages. This adjective is used to describe messages
36356 that are not received over TCP/IP, but instead are passed to an Exim process on
36357 its standard input. This includes the interactive &"local SMTP"& case that is
36358 set up by the &%-bs%& command line option.
36359
36360 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36361 or ::1) are not considered to be locally-originated. Exim does not treat the
36362 loopback interface specially in any way.
36363
36364 If you want the loopback interface to be treated specially, you must ensure
36365 that there are appropriate entries in your ACLs.
36366
36367
36368
36369
36370 .section "Submission mode for non-local messages" "SECTsubmodnon"
36371 .cindex "message" "submission"
36372 .cindex "submission mode"
36373 Processing that happens automatically for locally-originated messages (unless
36374 &%suppress_local_fixups%& is set) can also be requested for messages that are
36375 received over TCP/IP. The term &"submission mode"& is used to describe this
36376 state. Submission mode is set by the modifier
36377 .code
36378 control = submission
36379 .endd
36380 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36381 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36382 a local submission, and is normally used when the source of the message is
36383 known to be an MUA running on a client host (as opposed to an MTA). For
36384 example, to set submission mode for messages originating on the IPv4 loopback
36385 interface, you could include the following in the MAIL ACL:
36386 .code
36387 warn  hosts = 127.0.0.1
36388       control = submission
36389 .endd
36390 .cindex "&%sender_retain%& submission option"
36391 There are some options that can be used when setting submission mode. A slash
36392 is used to separate options. For example:
36393 .code
36394 control = submission/sender_retain
36395 .endd
36396 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36397 true and &%local_from_check%& false for the current incoming message. The first
36398 of these allows an existing &'Sender:'& header in the message to remain, and
36399 the second suppresses the check to ensure that &'From:'& matches the
36400 authenticated sender. With this setting, Exim still fixes up messages by adding
36401 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36402 attempt to check sender authenticity in header lines.
36403
36404 When &%sender_retain%& is not set, a submission mode setting may specify a
36405 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36406 example:
36407 .code
36408 control = submission/domain=some.domain
36409 .endd
36410 The domain may be empty. How this value is used is described in sections
36411 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36412 that allows you to specify the user's full name for inclusion in a created
36413 &'Sender:'& or &'From:'& header line. For example:
36414 .code
36415 accept authenticated = *
36416        control = submission/domain=wonderland.example/\
36417                             name=${lookup {$authenticated_id} \
36418                                    lsearch {/etc/exim/namelist}}
36419 .endd
36420 Because the name may contain any characters, including slashes, the &%name%&
36421 option must be given last. The remainder of the string is used as the name. For
36422 the example above, if &_/etc/exim/namelist_& contains:
36423 .code
36424 bigegg:  Humpty Dumpty
36425 .endd
36426 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36427 line would be:
36428 .code
36429 Sender: Humpty Dumpty <bigegg@wonderland.example>
36430 .endd
36431 .cindex "return path" "in submission mode"
36432 By default, submission mode forces the return path to the same address as is
36433 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36434 specified, the return path is also left unchanged.
36435
36436 &*Note*&: The changes caused by submission mode take effect after the predata
36437 ACL. This means that any sender checks performed before the fix-ups use the
36438 untrusted sender address specified by the user, not the trusted sender address
36439 specified by submission mode. Although this might be slightly unexpected, it
36440 does mean that you can configure ACL checks to spot that a user is trying to
36441 spoof another's address.
36442
36443 .section "Line endings" "SECTlineendings"
36444 .cindex "line endings"
36445 .cindex "carriage return"
36446 .cindex "linefeed"
36447 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36448 linefeed) is the line ending for messages transmitted over the Internet using
36449 SMTP over TCP/IP. However, within individual operating systems, different
36450 conventions are used. For example, Unix-like systems use just LF, but others
36451 use CRLF or just CR.
36452
36453 Exim was designed for Unix-like systems, and internally, it stores messages
36454 using the system's convention of a single LF as a line terminator. When
36455 receiving a message, all line endings are translated to this standard format.
36456 Originally, it was thought that programs that passed messages directly to an
36457 MTA within an operating system would use that system's convention. Experience
36458 has shown that this is not the case; for example, there are Unix applications
36459 that use CRLF in this circumstance. For this reason, and for compatibility with
36460 other MTAs, the way Exim handles line endings for all messages is now as
36461 follows:
36462
36463 .ilist
36464 CR is treated as a line ending; if it is immediately followed by LF, the LF
36465 is ignored.
36466 .next
36467 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36468 nor a local message in the state where a line containing only a dot is a
36469 terminator.
36470 .next
36471 If a bare CR is encountered within a header line, an extra space is added after
36472 the line terminator so as not to end the header line. The reasoning behind this
36473 is that bare CRs in header lines are most likely either to be mistakes, or
36474 people trying to play silly games.
36475 .next
36476 If the first header line received in a message ends with CRLF, a subsequent
36477 bare LF in a header line is treated in the same way as a bare CR in a header
36478 line and a bare LF in a body line is replaced with a space.
36479 .next
36480 If the first header line received in a message does not end with CRLF, a subsequent
36481 LF not preceded by CR is treated as a line ending.
36482 .endlist
36483
36484
36485
36486
36487
36488 .section "Unqualified addresses" "SECID218"
36489 .cindex "unqualified addresses"
36490 .cindex "address" "qualification"
36491 By default, Exim expects every envelope address it receives from an external
36492 host to be fully qualified. Unqualified addresses cause negative responses to
36493 SMTP commands. However, because SMTP is used as a means of transporting
36494 messages from MUAs running on personal workstations, there is sometimes a
36495 requirement to accept unqualified addresses from specific hosts or IP networks.
36496
36497 Exim has two options that separately control which hosts may send unqualified
36498 sender or recipient addresses in SMTP commands, namely
36499 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36500 cases, if an unqualified address is accepted, it is qualified by adding the
36501 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36502
36503 .oindex "&%qualify_domain%&"
36504 .oindex "&%qualify_recipient%&"
36505 Unqualified addresses in header lines are automatically qualified for messages
36506 that are locally originated, unless the &%-bnq%& option is given on the command
36507 line. For messages received over SMTP, unqualified addresses in header lines
36508 are qualified only if unqualified addresses are permitted in SMTP commands. In
36509 other words, such qualification is also controlled by
36510 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36511
36512
36513
36514
36515 .section "The UUCP From line" "SECID219"
36516 .cindex "&""From""& line"
36517 .cindex "UUCP" "&""From""& line"
36518 .cindex "sender" "address"
36519 .oindex "&%uucp_from_pattern%&"
36520 .oindex "&%uucp_from_sender%&"
36521 .cindex "envelope from"
36522 .cindex "envelope sender"
36523 .cindex "Sendmail compatibility" "&""From""& line"
36524 Messages that have come from UUCP (and some other applications) often begin
36525 with a line containing the envelope sender and a timestamp, following the word
36526 &"From"&. Examples of two common formats are:
36527 .code
36528 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36529 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36530 .endd
36531 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36532 Exim recognizes such lines at the start of messages that are submitted to it
36533 via the command line (that is, on the standard input). It does not recognize
36534 such lines in incoming SMTP messages, unless the sending host matches
36535 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36536 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36537 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36538 default value matches the two common cases shown above and puts the address
36539 that follows &"From"& into &$1$&.
36540
36541 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36542 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36543 a trusted user, the message's sender address is constructed by expanding the
36544 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36545 then parsed as an RFC 2822 address. If there is no domain, the local part is
36546 qualified with &%qualify_domain%& unless it is the empty string. However, if
36547 the command line &%-f%& option is used, it overrides the &"From"& line.
36548
36549 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36550 sender address is not changed. This is also the case for incoming SMTP messages
36551 that are permitted to contain &"From"& lines.
36552
36553 Only one &"From"& line is recognized. If there is more than one, the second is
36554 treated as a data line that starts the body of the message, as it is not valid
36555 as a header line. This also happens if a &"From"& line is present in an
36556 incoming SMTP message from a source that is not permitted to send them.
36557
36558
36559
36560 .section "Header lines"
36561 .subsection "Resent- header lines" SECID220
36562 .chindex Resent-
36563 RFC 2822 makes provision for sets of header lines starting with the string
36564 &`Resent-`& to be added to a message when it is resent by the original
36565 recipient to somebody else. These headers are &'Resent-Date:'&,
36566 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36567 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36568
36569 .blockquote
36570 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36571 processing of replies or other such automatic actions on messages.'&
36572 .endblockquote
36573
36574 This leaves things a bit vague as far as other processing actions such as
36575 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36576 follows:
36577
36578 .ilist
36579 A &'Resent-From:'& line that just contains the login id of the submitting user
36580 is automatically rewritten in the same way as &'From:'& (see below).
36581 .next
36582 If there's a rewriting rule for a particular header line, it is also applied to
36583 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36584 &'From:'& also rewrites &'Resent-From:'&.
36585 .next
36586 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36587 also removed.
36588 .next
36589 For a locally-submitted message,
36590 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36591 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36592 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36593 included in log lines in this case.
36594 .next
36595 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36596 &%Resent-%& header lines are present.
36597 .endlist
36598
36599
36600
36601
36602 .subsection Auto-Submitted: SECID221
36603 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36604 includes the header line:
36605 .code
36606 Auto-Submitted: auto-replied
36607 .endd
36608
36609 .subsection Bcc: SECID222
36610 .cindex "&'Bcc:'& header line"
36611 If Exim is called with the &%-t%& option, to take recipient addresses from a
36612 message's header, it removes any &'Bcc:'& header line that may exist (after
36613 extracting its addresses). If &%-t%& is not present on the command line, any
36614 existing &'Bcc:'& is not removed.
36615
36616
36617 .subsection Date: SECID223
36618 .cindex Date:
36619 If a locally-generated or submission-mode message has no &'Date:'& header line,
36620 Exim adds one, using the current date and time, unless the
36621 &%suppress_local_fixups%& control has been specified.
36622
36623 .subsection Delivery-date: SECID224
36624 .cindex "&'Delivery-date:'& header line"
36625 .oindex "&%delivery_date_remove%&"
36626 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36627 set. Exim can be configured to add them to the final delivery of messages. (See
36628 the generic &%delivery_date_add%& transport option.) They should not be present
36629 in messages in transit. If the &%delivery_date_remove%& configuration option is
36630 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36631 messages.
36632
36633
36634 .subsection Envelope-to: SECID225
36635 .chindex Envelope-to:
36636 .oindex "&%envelope_to_remove%&"
36637 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36638 Exim can be configured to add them to the final delivery of messages. (See the
36639 generic &%envelope_to_add%& transport option.) They should not be present in
36640 messages in transit. If the &%envelope_to_remove%& configuration option is set
36641 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36642 messages.
36643
36644
36645 .subsection From: SECTthefrohea
36646 .chindex From:
36647 .cindex "Sendmail compatibility" "&""From""& line"
36648 .cindex "message" "submission"
36649 .cindex "submission mode"
36650 If a submission-mode message does not contain a &'From:'& header line, Exim
36651 adds one if either of the following conditions is true:
36652
36653 .ilist
36654 The envelope sender address is not empty (that is, this is not a bounce
36655 message). The added header line copies the envelope sender address.
36656 .next
36657 .vindex "&$authenticated_id$&"
36658 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36659 .olist
36660 .vindex "&$qualify_domain$&"
36661 If no domain is specified by the submission control, the local part is
36662 &$authenticated_id$& and the domain is &$qualify_domain$&.
36663 .next
36664 If a non-empty domain is specified by the submission control, the local
36665 part is &$authenticated_id$&, and the domain is the specified domain.
36666 .next
36667 If an empty domain is specified by the submission control,
36668 &$authenticated_id$& is assumed to be the complete address.
36669 .endlist
36670 .endlist
36671
36672 A non-empty envelope sender takes precedence.
36673
36674 If a locally-generated incoming message does not contain a &'From:'& header
36675 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36676 containing the sender's address. The calling user's login name and full name
36677 are used to construct the address, as described in section &<<SECTconstr>>&.
36678 They are obtained from the password data by calling &[getpwuid()]& (but see the
36679 &%unknown_login%& configuration option). The address is qualified with
36680 &%qualify_domain%&.
36681
36682 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36683 &'From:'& header line containing just the unqualified login name of the calling
36684 user, this is replaced by an address containing the user's login name and full
36685 name as described in section &<<SECTconstr>>&.
36686
36687
36688 .subsection Message-ID: SECID226
36689 .chindex Message-ID:
36690 .cindex "message" "submission"
36691 .oindex "&%message_id_header_text%&"
36692 If a locally-generated or submission-mode incoming message does not contain a
36693 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36694 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36695 to the message. If there are any &'Resent-:'& headers in the message, it
36696 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36697 message id, preceded by the letter E to ensure it starts with a letter, and
36698 followed by @ and the primary host name. Additional information can be included
36699 in this header line by setting the &%message_id_header_text%& and/or
36700 &%message_id_header_domain%& options.
36701
36702
36703 .subsection Received: SECID227
36704 .chindex Received:
36705 A &'Received:'& header line is added at the start of every message. The
36706 contents are defined by the &%received_header_text%& configuration option, and
36707 Exim automatically adds a semicolon and a timestamp to the configured string.
36708
36709 The &'Received:'& header is generated as soon as the message's header lines
36710 have been received. At this stage, the timestamp in the &'Received:'& header
36711 line is the time that the message started to be received. This is the value
36712 that is seen by the DATA ACL and by the &[local_scan()]& function.
36713
36714 Once a message is accepted, the timestamp in the &'Received:'& header line is
36715 changed to the time of acceptance, which is (apart from a small delay while the
36716 -H spool file is written) the earliest time at which delivery could start.
36717
36718
36719 .subsection References: SECID228
36720 .chindex References:
36721 Messages created by the &(autoreply)& transport include a &'References:'&
36722 header line. This is constructed according to the rules that are described in
36723 section 3.64 of RFC 2822 (which states that replies should contain such a
36724 header line), and section 3.14 of RFC 3834 (which states that automatic
36725 responses are not different in this respect). However, because some mail
36726 processing software does not cope well with very long header lines, no more
36727 than 12 message IDs are copied from the &'References:'& header line in the
36728 incoming message. If there are more than 12, the first one and then the final
36729 11 are copied, before adding the message ID of the incoming message.
36730
36731
36732
36733 .subsection Return-path: SECID229
36734 .chindex Return-path:
36735 .oindex "&%return_path_remove%&"
36736 &'Return-path:'& header lines are defined as something an MTA may insert when
36737 it does the final delivery of messages. (See the generic &%return_path_add%&
36738 transport option.) Therefore, they should not be present in messages in
36739 transit. If the &%return_path_remove%& configuration option is set (the
36740 default), Exim removes &'Return-path:'& header lines from incoming messages.
36741
36742
36743
36744 .subsection Sender: SECTthesenhea
36745 .cindex "&'Sender:'& header line"
36746 .cindex "message" "submission"
36747 .chindex Sender:
36748 For a locally-originated message from an untrusted user, Exim may remove an
36749 existing &'Sender:'& header line, and it may add a new one. You can modify
36750 these actions by setting the &%local_sender_retain%& option true, the
36751 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36752 control setting.
36753
36754 When a local message is received from an untrusted user and
36755 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36756 control has not been set, a check is made to see if the address given in the
36757 &'From:'& header line is the correct (local) sender of the message. The address
36758 that is expected has the login name as the local part and the value of
36759 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36760 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36761 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36762 line is added to the message.
36763
36764 If you set &%local_from_check%& false, this checking does not occur. However,
36765 the removal of an existing &'Sender:'& line still happens, unless you also set
36766 &%local_sender_retain%& to be true. It is not possible to set both of these
36767 options true at the same time.
36768
36769 .cindex "submission mode"
36770 By default, no processing of &'Sender:'& header lines is done for messages
36771 received over TCP/IP or for messages submitted by trusted users. However, when
36772 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36773 not specified on the submission control, the following processing takes place:
36774
36775 .vindex "&$authenticated_id$&"
36776 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36777 authenticated, and &$authenticated_id$& is not empty, a sender address is
36778 created as follows:
36779
36780 .ilist
36781 .vindex "&$qualify_domain$&"
36782 If no domain is specified by the submission control, the local part is
36783 &$authenticated_id$& and the domain is &$qualify_domain$&.
36784 .next
36785 If a non-empty domain is specified by the submission control, the local part
36786 is &$authenticated_id$&, and the domain is the specified domain.
36787 .next
36788 If an empty domain is specified by the submission control,
36789 &$authenticated_id$& is assumed to be the complete address.
36790 .endlist
36791
36792 This address is compared with the address in the &'From:'& header line. If they
36793 are different, a &'Sender:'& header line containing the created address is
36794 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36795 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36796
36797 .cindex "return path" "created from &'Sender:'&"
36798 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36799 the message (the envelope sender address) is changed to be the same address,
36800 except in the case of submission mode when &%sender_retain%& is specified.
36801
36802
36803
36804 .section "Adding and removing header lines in routers and transports" &&&
36805          "SECTheadersaddrem"
36806 .cindex "header lines" "adding; in router or transport"
36807 .cindex "header lines" "removing; in router or transport"
36808 When a message is delivered, the addition and removal of header lines can be
36809 specified in a system filter, or on any of the routers and transports that
36810 process the message. Section &<<SECTaddremheasys>>& contains details about
36811 modifying headers in a system filter. Header lines can also be added in an ACL
36812 as a message is received (see section &<<SECTaddheadacl>>&).
36813
36814 In contrast to what happens in a system filter, header modifications that are
36815 specified on routers and transports apply only to the particular recipient
36816 addresses that are being processed by those routers and transports. These
36817 changes do not actually take place until a copy of the message is being
36818 transported. Therefore, they do not affect the basic set of header lines, and
36819 they do not affect the values of the variables that refer to header lines.
36820
36821 &*Note*&: In particular, this means that any expansions in the configuration of
36822 the transport cannot refer to the modified header lines, because such
36823 expansions all occur before the message is actually transported.
36824
36825 For both routers and transports, the argument of a &%headers_add%&
36826 option must be in the form of one or more RFC 2822 header lines, separated by
36827 newlines (coded as &"\n"&). For example:
36828 .code
36829 headers_add = X-added-header: added by $primary_hostname\n\
36830               X-added-second: another added header line
36831 .endd
36832 Exim does not check the syntax of these added header lines.
36833
36834 Multiple &%headers_add%& options for a single router or transport can be
36835 specified; the values will append to a single list of header lines.
36836 Each header-line is separately expanded.
36837
36838 The argument of a &%headers_remove%& option must consist of a colon-separated
36839 list of header names. This is confusing, because header names themselves are
36840 often terminated by colons. In this case, the colons are the list separators,
36841 not part of the names. For example:
36842 .code
36843 headers_remove = return-receipt-to:acknowledge-to
36844 .endd
36845
36846 Multiple &%headers_remove%& options for a single router or transport can be
36847 specified; the arguments will append to a single header-names list.
36848 Each item is separately expanded.
36849 Note that colons in complex expansions which are used to
36850 form all or part of a &%headers_remove%& list
36851 will act as list separators.
36852
36853 When &%headers_add%& or &%headers_remove%& is specified on a router,
36854 items are expanded at routing time,
36855 and then associated with all addresses that are
36856 accepted by that router, and also with any new addresses that it generates. If
36857 an address passes through several routers as a result of aliasing or
36858 forwarding, the changes are cumulative.
36859
36860 .oindex "&%unseen%&"
36861 However, this does not apply to multiple routers that result from the use of
36862 the &%unseen%& option. Any header modifications that were specified by the
36863 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36864
36865 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36866 settings cannot be delivered together in a batch, so a transport is always
36867 dealing with a set of addresses that have the same header-processing
36868 requirements.
36869
36870 The transport starts by writing the original set of header lines that arrived
36871 with the message, possibly modified by the system filter. As it writes out
36872 these lines, it consults the list of header names that were attached to the
36873 recipient address(es) by &%headers_remove%& options in routers, and it also
36874 consults the transport's own &%headers_remove%& option. Header lines whose
36875 names are on either of these lists are not written out. If there are multiple
36876 instances of any listed header, they are all skipped.
36877
36878 After the remaining original header lines have been written, new header
36879 lines that were specified by routers' &%headers_add%& options are written, in
36880 the order in which they were attached to the address. These are followed by any
36881 header lines specified by the transport's &%headers_add%& option.
36882
36883 This way of handling header line modifications in routers and transports has
36884 the following consequences:
36885
36886 .ilist
36887 The original set of header lines, possibly modified by the system filter,
36888 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36889 to it, at all times.
36890 .next
36891 Header lines that are added by a router's
36892 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36893 expansion syntax in subsequent routers or the transport.
36894 .next
36895 Conversely, header lines that are specified for removal by &%headers_remove%&
36896 in a router remain visible to subsequent routers and the transport.
36897 .next
36898 Headers added to an address by &%headers_add%& in a router cannot be removed by
36899 a later router or by a transport.
36900 .next
36901 An added header can refer to the contents of an original header that is to be
36902 removed, even it has the same name as the added header. For example:
36903 .code
36904 headers_remove = subject
36905 headers_add = Subject: new subject (was: $h_subject:)
36906 .endd
36907 .endlist
36908
36909 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36910 for a &(redirect)& router that has the &%one_time%& option set.
36911
36912
36913
36914
36915
36916 .section "Constructed addresses" "SECTconstr"
36917 .cindex "address" "constructed"
36918 .cindex "constructed address"
36919 When Exim constructs a sender address for a locally-generated message, it uses
36920 the form
36921 .display
36922 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36923 .endd
36924 For example:
36925 .code
36926 Zaphod Beeblebrox <zaphod@end.univ.example>
36927 .endd
36928 The user name is obtained from the &%-F%& command line option if set, or
36929 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36930 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36931 ampersand character, this is replaced by the login name with the first letter
36932 upper cased, as is conventional in a number of operating systems. See the
36933 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36934 The &%unknown_username%& option can be used to specify user names in cases when
36935 there is no password file entry.
36936
36937 .cindex "RFC 2047"
36938 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36939 parts of it if necessary. In addition, if it contains any non-printing
36940 characters, it is encoded as described in RFC 2047, which defines a way of
36941 including non-ASCII characters in header lines. The value of the
36942 &%headers_charset%& option specifies the name of the encoding that is used (the
36943 characters are assumed to be in this encoding). The setting of
36944 &%print_topbitchars%& controls whether characters with the top bit set (that
36945 is, with codes greater than 127) count as printing characters or not.
36946
36947
36948
36949 .section "Case of local parts" "SECID230"
36950 .cindex "case of local parts"
36951 .cindex "local part" "case of"
36952 RFC 2822 states that the case of letters in the local parts of addresses cannot
36953 be assumed to be non-significant. Exim preserves the case of local parts of
36954 addresses, but by default it uses a lower-cased form when it is routing,
36955 because on most Unix systems, usernames are in lower case and case-insensitive
36956 routing is required. However, any particular router can be made to use the
36957 original case for local parts by setting the &%caseful_local_part%& generic
36958 router option.
36959
36960 .cindex "mixed-case login names"
36961 If you must have mixed-case user names on your system, the best way to proceed,
36962 assuming you want case-independent handling of incoming email, is to set up
36963 your first router to convert incoming local parts in your domains to the
36964 correct case by means of a file lookup. For example:
36965 .code
36966 correct_case:
36967   driver = redirect
36968   domains = +local_domains
36969   data = ${lookup{$local_part}cdb\
36970               {/etc/usercased.cdb}{$value}fail}\
36971               @$domain
36972 .endd
36973 For this router, the local part is forced to lower case by the default action
36974 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36975 up a new local part in the correct case. If you then set &%caseful_local_part%&
36976 on any subsequent routers which process your domains, they will operate on
36977 local parts with the correct case in a case-sensitive manner.
36978
36979
36980
36981 .section "Dots in local parts" "SECID231"
36982 .cindex "dot" "in local part"
36983 .cindex "local part" "dots in"
36984 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36985 part may not begin or end with a dot, nor have two consecutive dots in the
36986 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36987 empty components for compatibility.
36988
36989
36990
36991 .section "Rewriting addresses" "SECID232"
36992 .cindex "rewriting" "addresses"
36993 Rewriting of sender and recipient addresses, and addresses in headers, can
36994 happen automatically, or as the result of configuration options, as described
36995 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36996 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36997
36998 Automatic rewriting includes qualification, as mentioned above. The other case
36999 in which it can happen is when an incomplete non-local domain is given. The
37000 routing process may cause this to be expanded into the full domain name. For
37001 example, a header such as
37002 .code
37003 To: hare@teaparty
37004 .endd
37005 might get rewritten as
37006 .code
37007 To: hare@teaparty.wonderland.fict.example
37008 .endd
37009 Rewriting as a result of routing is the one kind of message processing that
37010 does not happen at input time, as it cannot be done until the address has
37011 been routed.
37012
37013 Strictly, one should not do &'any'& deliveries of a message until all its
37014 addresses have been routed, in case any of the headers get changed as a
37015 result of routing. However, doing this in practice would hold up many
37016 deliveries for unreasonable amounts of time, just because one address could not
37017 immediately be routed. Exim therefore does not delay other deliveries when
37018 routing of one or more addresses is deferred.
37019 .ecindex IIDmesproc
37020
37021
37022
37023 . ////////////////////////////////////////////////////////////////////////////
37024 . ////////////////////////////////////////////////////////////////////////////
37025
37026 .chapter "SMTP processing" "CHAPSMTP"
37027 .scindex IIDsmtpproc1 "SMTP" "processing details"
37028 .scindex IIDsmtpproc2 "LMTP" "processing details"
37029 Exim supports a number of different ways of using the SMTP protocol, and its
37030 LMTP variant, which is an interactive protocol for transferring messages into a
37031 closed mail store application. This chapter contains details of how SMTP is
37032 processed. For incoming mail, the following are available:
37033
37034 .ilist
37035 SMTP over TCP/IP (Exim daemon or &'inetd'&);
37036 .next
37037 SMTP over the standard input and output (the &%-bs%& option);
37038 .next
37039 Batched SMTP on the standard input (the &%-bS%& option).
37040 .endlist
37041
37042 For mail delivery, the following are available:
37043
37044 .ilist
37045 SMTP over TCP/IP (the &(smtp)& transport);
37046 .next
37047 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
37048 &"lmtp"&);
37049 .next
37050 LMTP over a pipe to a process running in the local host (the &(lmtp)&
37051 transport);
37052 .next
37053 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
37054 the &%use_bsmtp%& option set).
37055 .endlist
37056
37057 &'Batched SMTP'& is the name for a process in which batches of messages are
37058 stored in or read from files (or pipes), in a format in which SMTP commands are
37059 used to contain the envelope information.
37060
37061
37062
37063 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
37064 .cindex "SMTP" "outgoing over TCP/IP"
37065 .cindex "outgoing SMTP over TCP/IP"
37066 .cindex "LMTP" "over TCP/IP"
37067 .cindex "outgoing LMTP over TCP/IP"
37068 .cindex "EHLO"
37069 .cindex "HELO"
37070 .cindex "SIZE" "option on MAIL command"
37071 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
37072 The &%protocol%& option selects which protocol is to be used, but the actual
37073 processing is the same in both cases.
37074
37075 .cindex "ESMTP extensions" SIZE
37076 If, in response to its EHLO command, Exim is told that the SIZE
37077 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
37078 command. The value of <&'n'&> is the message size plus the value of the
37079 &%size_addition%& option (default 1024) to allow for additions to the message
37080 such as per-transport header lines, or changes made in a
37081 .cindex "transport" "filter"
37082 .cindex "filter" "transport filter"
37083 transport filter. If &%size_addition%& is set negative, the use of SIZE is
37084 suppressed.
37085
37086 If the remote server advertises support for PIPELINING, Exim uses the
37087 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
37088 required for the transaction.
37089
37090 If the remote server advertises support for the STARTTLS command, and Exim
37091 was built to support TLS encryption, it tries to start a TLS session unless the
37092 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
37093 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
37094 is called for verification.
37095
37096 If the remote server advertises support for the AUTH command, Exim scans
37097 the authenticators configuration for any suitable client settings, as described
37098 in chapter &<<CHAPSMTPAUTH>>&.
37099
37100 .cindex "carriage return"
37101 .cindex "linefeed"
37102 Responses from the remote host are supposed to be terminated by CR followed by
37103 LF. However, there are known to be hosts that do not send CR characters, so in
37104 order to be able to interwork with such hosts, Exim treats LF on its own as a
37105 line terminator.
37106
37107 If a message contains a number of different addresses, all those with the same
37108 characteristics (for example, the same envelope sender) that resolve to the
37109 same set of hosts, in the same order, are sent in a single SMTP transaction,
37110 even if they are for different domains, unless there are more than the setting
37111 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
37112 they are split into groups containing no more than &%max_rcpt%&s addresses
37113 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
37114 in parallel sessions. The order of hosts with identical MX values is not
37115 significant when checking whether addresses can be batched in this way.
37116
37117 When the &(smtp)& transport suffers a temporary failure that is not
37118 message-related, Exim updates its transport-specific database, which contains
37119 records indexed by host name that remember which messages are waiting for each
37120 particular host. It also updates the retry database with new retry times.
37121
37122 .cindex "hints database" "retry keys"
37123 Exim's retry hints are based on host name plus IP address, so if one address of
37124 a multi-homed host is broken, it will soon be skipped most of the time.
37125 See the next section for more detail about error handling.
37126
37127 .cindex "SMTP" "passed connection"
37128 .cindex "SMTP" "batching over TCP/IP"
37129 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
37130 looks in the hints database for the transport to see if there are any queued
37131 messages waiting for the host to which it is connected. If it finds one, it
37132 creates a new Exim process using the &%-MC%& option (which can only be used by
37133 a process running as root or the Exim user) and passes the TCP/IP socket to it
37134 so that it can deliver another message using the same socket. The new process
37135 does only those deliveries that are routed to the connected host, and may in
37136 turn pass the socket on to a third process, and so on.
37137
37138 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
37139 limit the number of messages sent down a single TCP/IP connection.
37140
37141 .cindex "asterisk" "after IP address"
37142 The second and subsequent messages delivered down an existing connection are
37143 identified in the main log by the addition of an asterisk after the closing
37144 square bracket of the IP address.
37145
37146
37147
37148
37149 .subsection "Errors in outgoing SMTP" SECToutSMTPerr
37150 .cindex "error" "in outgoing SMTP"
37151 .cindex "SMTP" "errors in outgoing"
37152 .cindex "host" "error"
37153 Three different kinds of error are recognized for outgoing SMTP: host errors,
37154 message errors, and recipient errors.
37155
37156 .vlist
37157 .vitem "&*Host errors*&"
37158 A host error is not associated with a particular message or with a
37159 particular recipient of a message. The host errors are:
37160
37161 .ilist
37162 Connection refused or timed out,
37163 .next
37164 Any error response code on connection,
37165 .next
37166 Any error response code to EHLO or HELO,
37167 .next
37168 Loss of connection at any time, except after &"."&,
37169 .next
37170 I/O errors at any time,
37171 .next
37172 Timeouts during the session, other than in response to MAIL, RCPT or
37173 the &"."& at the end of the data.
37174 .endlist ilist
37175
37176 For a host error, a permanent error response on connection, or in response to
37177 EHLO, causes all addresses routed to the host to be failed. Any other host
37178 error causes all addresses to be deferred, and retry data to be created for the
37179 host. It is not tried again, for any message, until its retry time arrives. If
37180 the current set of addresses are not all delivered in this run (to some
37181 alternative host), the message is added to the list of those waiting for this
37182 host, so if it is still undelivered when a subsequent successful delivery is
37183 made to the host, it will be sent down the same SMTP connection.
37184
37185 .vitem "&*Message errors*&"
37186 .cindex "message" "error"
37187 A message error is associated with a particular message when sent to a
37188 particular host, but not with a particular recipient of the message. The
37189 message errors are:
37190
37191 .ilist
37192 Any error response code to MAIL, DATA, or the &"."& that terminates
37193 the data,
37194 .next
37195 Timeout after MAIL,
37196 .next
37197 Timeout or loss of connection after the &"."& that terminates the data. A
37198 timeout after the DATA command itself is treated as a host error, as is loss of
37199 connection at any other time.
37200 .endlist ilist
37201
37202 For a message error, a permanent error response (5&'xx'&) causes all addresses
37203 to be failed, and a delivery error report to be returned to the sender. A
37204 temporary error response (4&'xx'&), or one of the timeouts, causes all
37205 addresses to be deferred. Retry data is not created for the host, but instead,
37206 a retry record for the combination of host plus message id is created. The
37207 message is not added to the list of those waiting for this host. This ensures
37208 that the failing message will not be sent to this host again until the retry
37209 time arrives. However, other messages that are routed to the host are not
37210 affected, so if it is some property of the message that is causing the error,
37211 it will not stop the delivery of other mail.
37212
37213 If the remote host specified support for the SIZE parameter in its response
37214 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
37215 over-large message will cause a message error because the error arrives as a
37216 response to MAIL.
37217
37218 .vitem "&*Recipient errors*&"
37219 .cindex "recipient" "error"
37220 A recipient error is associated with a particular recipient of a message. The
37221 recipient errors are:
37222
37223 .ilist
37224 Any error response to RCPT,
37225 .next
37226 Timeout after RCPT.
37227 .endlist
37228
37229 For a recipient error, a permanent error response (5&'xx'&) causes the
37230 recipient address to be failed, and a bounce message to be returned to the
37231 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
37232 address to be deferred, and routing retry data to be created for it. This is
37233 used to delay processing of the address in subsequent queue runs, until its
37234 routing retry time arrives. This applies to all messages, but because it
37235 operates only in queue runs, one attempt will be made to deliver a new message
37236 to the failing address before the delay starts to operate. This ensures that,
37237 if the failure is really related to the message rather than the recipient
37238 (&"message too big for this recipient"& is a possible example), other messages
37239 have a chance of getting delivered. If a delivery to the address does succeed,
37240 the retry information gets cleared, so all stuck messages get tried again, and
37241 the retry clock is reset.
37242
37243 The message is not added to the list of those waiting for this host. Use of the
37244 host for other messages is unaffected, and except in the case of a timeout,
37245 other recipients are processed independently, and may be successfully delivered
37246 in the current SMTP session. After a timeout it is of course impossible to
37247 proceed with the session, so all addresses get deferred. However, those other
37248 than the one that failed do not suffer any subsequent retry delays. Therefore,
37249 if one recipient is causing trouble, the others have a chance of getting
37250 through when a subsequent delivery attempt occurs before the failing
37251 recipient's retry time.
37252 .endlist
37253
37254 In all cases, if there are other hosts (or IP addresses) available for the
37255 current set of addresses (for example, from multiple MX records), they are
37256 tried in this run for any undelivered addresses, subject of course to their
37257 own retry data. In other words, recipient error retry data does not take effect
37258 until the next delivery attempt.
37259
37260 Some hosts have been observed to give temporary error responses to every
37261 MAIL command at certain times (&"insufficient space"& has been seen). It
37262 would be nice if such circumstances could be recognized, and defer data for the
37263 host itself created, but this is not possible within the current Exim design.
37264 What actually happens is that retry data for every (host, message) combination
37265 is created.
37266
37267 The reason that timeouts after MAIL and RCPT are treated specially is that
37268 these can sometimes arise as a result of the remote host's verification
37269 procedures. Exim makes this assumption, and treats them as if a temporary error
37270 response had been received. A timeout after &"."& is treated specially because
37271 it is known that some broken implementations fail to recognize the end of the
37272 message if the last character of the last line is a binary zero. Thus, it is
37273 helpful to treat this case as a message error.
37274
37275 Timeouts at other times are treated as host errors, assuming a problem with the
37276 host, or the connection to it. If a timeout after MAIL, RCPT,
37277 or &"."& is really a connection problem, the assumption is that at the next try
37278 the timeout is likely to occur at some other point in the dialogue, causing it
37279 then to be treated as a host error.
37280
37281 There is experimental evidence that some MTAs drop the connection after the
37282 terminating &"."& if they do not like the contents of the message for some
37283 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
37284 should be given. That is why Exim treats this case as a message rather than a
37285 host error, in order not to delay other messages to the same host.
37286
37287
37288
37289
37290 .section "Incoming SMTP messages over TCP/IP" "SECID233"
37291 .cindex "SMTP" "incoming over TCP/IP"
37292 .cindex "incoming SMTP over TCP/IP"
37293 .cindex "inetd"
37294 .cindex "daemon"
37295 Incoming SMTP messages can be accepted in one of two ways: by running a
37296 listening daemon, or by using &'inetd'&. In the latter case, the entry in
37297 &_/etc/inetd.conf_& should be like this:
37298 .code
37299 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
37300 .endd
37301 Exim distinguishes between this case and the case of a locally running user
37302 agent using the &%-bs%& option by checking whether or not the standard input is
37303 a socket. When it is, either the port must be privileged (less than 1024), or
37304 the caller must be root or the Exim user. If any other user passes a socket
37305 with an unprivileged port number, Exim prints a message on the standard error
37306 stream and exits with an error code.
37307
37308 By default, Exim does not make a log entry when a remote host connects or
37309 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
37310 unexpected. It can be made to write such log entries by setting the
37311 &%smtp_connection%& log selector.
37312
37313 .cindex "carriage return"
37314 .cindex "linefeed"
37315 Commands from the remote host are supposed to be terminated by CR followed by
37316 LF. However, there are known to be hosts that do not send CR characters. In
37317 order to be able to interwork with such hosts, Exim treats LF on its own as a
37318 line terminator.
37319 Furthermore, because common code is used for receiving messages from all
37320 sources, a CR on its own is also interpreted as a line terminator. However, the
37321 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
37322
37323 .cindex "EHLO" "invalid data"
37324 .cindex "HELO" "invalid data"
37325 One area that sometimes gives rise to problems concerns the EHLO or
37326 HELO commands. Some clients send syntactically invalid versions of these
37327 commands, which Exim rejects by default. (This is nothing to do with verifying
37328 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
37329 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
37330 match the broken hosts that send invalid commands.
37331
37332 .cindex "SIZE option on MAIL command"
37333 .cindex "MAIL" "SIZE option"
37334 The amount of disk space available is checked whenever SIZE is received on
37335 a MAIL command, independently of whether &%message_size_limit%& or
37336 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
37337 false. A temporary error is given if there is not enough space. If
37338 &%check_spool_space%& is set, the check is for that amount of space plus the
37339 value given with SIZE, that is, it checks that the addition of the incoming
37340 message will not reduce the space below the threshold.
37341
37342 When a message is successfully received, Exim includes the local message id in
37343 its response to the final &"."& that terminates the data. If the remote host
37344 logs this text it can help with tracing what has happened to a message.
37345
37346 The Exim daemon can limit the number of simultaneous incoming connections it is
37347 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
37348 number of simultaneous incoming connections from a single remote host (see the
37349 &%smtp_accept_max_per_host%& option). Additional connection attempts are
37350 rejected using the SMTP temporary error code 421.
37351
37352 The Exim daemon does not rely on the SIGCHLD signal to detect when a
37353 subprocess has finished, as this can get lost at busy times. Instead, it looks
37354 for completed subprocesses every time it wakes up. Provided there are other
37355 things happening (new incoming calls, starts of queue runs), completed
37356 processes will be noticed and tidied away. On very quiet systems you may
37357 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37358 it will be noticed when the daemon next wakes up.
37359
37360 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37361 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37362 high system load &-- for details see the &%smtp_accept_reserve%&,
37363 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37364 applies in both the daemon and &'inetd'& cases.
37365
37366 Exim normally starts a delivery process for each message received, though this
37367 can be varied by means of the &%-odq%& command line option and the
37368 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37369 number of simultaneously running delivery processes started in this way from
37370 SMTP input can be limited by the &%smtp_accept_queue%& and
37371 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37372 subsequently received messages are just put on the input queue without starting
37373 a delivery process.
37374
37375 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37376 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37377 started up from the &'inetd'& daemon, because in that case each connection is
37378 handled by an entirely independent Exim process. Control by load average is,
37379 however, available with &'inetd'&.
37380
37381 Exim can be configured to verify addresses in incoming SMTP commands as they
37382 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37383 to rewrite addresses at this time &-- before any syntax checking is done. See
37384 section &<<SSECTrewriteS>>&.
37385
37386 Exim can also be configured to limit the rate at which a client host submits
37387 MAIL and RCPT commands in a single SMTP session. See the
37388 &%smtp_ratelimit_hosts%& option.
37389
37390
37391
37392 .subsection "Unrecognized SMTP commands" SECID234
37393 .cindex "SMTP" "unrecognized commands"
37394 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37395 commands during a single SMTP connection, it drops the connection after sending
37396 the error response to the last command. The default value for
37397 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37398 abuse that subvert web servers into making connections to SMTP ports; in these
37399 circumstances, a number of non-SMTP lines are sent first.
37400
37401
37402 .subsection "Syntax and protocol errors in SMTP commands" SECID235
37403 .cindex "SMTP" "syntax errors"
37404 .cindex "SMTP" "protocol errors"
37405 A syntax error is detected if an SMTP command is recognized, but there is
37406 something syntactically wrong with its data, for example, a malformed email
37407 address in a RCPT command. Protocol errors include invalid command
37408 sequencing such as RCPT before MAIL. If Exim receives more than
37409 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37410 drops the connection after sending the error response to the last command. The
37411 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37412 broken clients that loop sending bad commands (yes, it has been seen).
37413
37414
37415
37416 .subsection "Use of non-mail SMTP commands" SECID236
37417 .cindex "SMTP" "non-mail commands"
37418 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37419 DATA. Exim counts such commands, and drops the connection if there are too
37420 many of them in a single SMTP session. This action catches some
37421 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37422 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37423 defines what &"too many"& means. Its default value is 10.
37424
37425 When a new message is expected, one occurrence of RSET is not counted. This
37426 allows a client to send one RSET between messages (this is not necessary,
37427 but some clients do it). Exim also allows one uncounted occurrence of HELO
37428 or EHLO, and one occurrence of STARTTLS between messages. After
37429 starting up a TLS session, another EHLO is expected, and so it too is not
37430 counted.
37431
37432 The first occurrence of AUTH in a connection, or immediately following
37433 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37434 RCPT, DATA, and QUIT are counted.
37435
37436 You can control which hosts are subject to the limit set by
37437 &%smtp_accept_max_nonmail%& by setting
37438 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37439 the limit apply to all hosts. This option means that you can exclude any
37440 specific badly-behaved hosts that you have to live with.
37441
37442
37443
37444
37445 .subsection "The VRFY and EXPN commands" SECID237
37446 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37447 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37448 appropriate) in order to decide whether the command should be accepted or not.
37449
37450 .cindex "VRFY" "processing"
37451 When no ACL is defined for VRFY, or if it rejects without
37452 setting an explicit response code, the command is accepted
37453 (with a 252 SMTP response code)
37454 in order to support awkward clients that do a VRFY before every RCPT.
37455 When VRFY is accepted, it runs exactly the same code as when Exim is
37456 called with the &%-bv%& option, and returns 250/451/550
37457 SMTP response codes.
37458
37459 .cindex "EXPN" "processing"
37460 If no ACL for EXPN is defined, the command is rejected.
37461 When EXPN is accepted, a single-level expansion of the address is done.
37462 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37463 than a verification (the &%-bv%& option). If an unqualified local part is given
37464 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37465 of VRFY and EXPN commands are logged on the main and reject logs, and
37466 VRFY verification failures are logged in the main log for consistency with
37467 RCPT failures.
37468
37469
37470
37471 .subsection "The ETRN command" SECTETRN
37472 .cindex "ETRN" "processing"
37473 .cindex "ESMTP extensions" ETRN
37474 RFC 1985 describes an ESMTP command called ETRN that is designed to
37475 overcome the security problems of the TURN command (which has fallen into
37476 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37477 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37478 should be accepted or not. If no ACL is defined, the command is rejected.
37479
37480 The ETRN command is concerned with &"releasing"& messages that are awaiting
37481 delivery to certain hosts. As Exim does not organize its message queue by host,
37482 the only form of ETRN that is supported by default is the one where the
37483 text starts with the &"#"& prefix, in which case the remainder of the text is
37484 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37485 the &%-R%& option to happen, with the remainder of the ETRN text as its
37486 argument. For example,
37487 .code
37488 ETRN #brigadoon
37489 .endd
37490 runs the command
37491 .code
37492 exim -R brigadoon
37493 .endd
37494 which causes a delivery attempt on all messages with undelivered addresses
37495 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37496 default), Exim prevents the simultaneous execution of more than one queue run
37497 for the same argument string as a result of an ETRN command. This stops
37498 a misbehaving client from starting more than one queue runner at once.
37499
37500 .cindex "hints database" "ETRN serialization"
37501 Exim implements the serialization by means of a hints database in which a
37502 record is written whenever a process is started by ETRN, and deleted when
37503 the process completes. However, Exim does not keep the SMTP session waiting for
37504 the ETRN process to complete. Once ETRN is accepted, the client is sent
37505 a &"success"& return code. Obviously there is scope for hints records to get
37506 left lying around if there is a system or program crash. To guard against this,
37507 Exim ignores any records that are more than six hours old.
37508
37509 .oindex "&%smtp_etrn_command%&"
37510 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37511 used. This specifies a command that is run whenever ETRN is received,
37512 whatever the form of its argument. For
37513 example:
37514 .code
37515 smtp_etrn_command = /etc/etrn_command $domain \
37516                     $sender_host_address
37517 .endd
37518 .vindex "&$domain$&"
37519 The string is split up into arguments which are independently expanded. The
37520 expansion variable &$domain$& is set to the argument of the ETRN command,
37521 and no syntax checking is done on the contents of this argument. Exim does not
37522 wait for the command to complete, so its status code is not checked. Exim runs
37523 under its own uid and gid when receiving incoming SMTP, so it is not possible
37524 for it to change them before running the command.
37525
37526
37527
37528 .section "Incoming local SMTP" "SECID238"
37529 .cindex "SMTP" "local incoming"
37530 Some user agents use SMTP to pass messages to their local MTA using the
37531 standard input and output, as opposed to passing the envelope on the command
37532 line and writing the message to the standard input. This is supported by the
37533 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37534 messages over TCP/IP (including the use of ACLs), except that the envelope
37535 sender given in a MAIL command is ignored unless the caller is trusted. In
37536 an ACL you can detect this form of SMTP input by testing for an empty host
37537 identification. It is common to have this as the first line in the ACL that
37538 runs for RCPT commands:
37539 .code
37540 accept hosts = :
37541 .endd
37542 This accepts SMTP messages from local processes without doing any other tests.
37543
37544
37545
37546 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37547 .cindex "SMTP" "batched outgoing"
37548 .cindex "batched SMTP output"
37549 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37550 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37551 be output in BSMTP format. No SMTP responses are possible for this form of
37552 delivery. All it is doing is using SMTP commands as a way of transmitting the
37553 envelope along with the message.
37554
37555 The message is written to the file or pipe preceded by the SMTP commands
37556 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37557 the message that start with a dot have an extra dot added. The SMTP command
37558 HELO is not normally used. If it is required, the &%message_prefix%& option
37559 can be used to specify it.
37560
37561 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37562 one recipient address at a time by default. However, you can arrange for them
37563 to handle several addresses at once by setting the &%batch_max%& option. When
37564 this is done for BSMTP, messages may contain multiple RCPT commands. See
37565 chapter &<<CHAPbatching>>& for more details.
37566
37567 .vindex "&$host$&"
37568 When one or more addresses are routed to a BSMTP transport by a router that
37569 sets up a host list, the name of the first host on the list is available to the
37570 transport in the variable &$host$&. Here is an example of such a transport and
37571 router:
37572 .code
37573 begin routers
37574 route_append:
37575   driver = manualroute
37576   transport = smtp_appendfile
37577   route_list = domain.example  batch.host.example
37578
37579 begin transports
37580 smtp_appendfile:
37581   driver = appendfile
37582   directory = /var/bsmtp/$host
37583   batch_max = 1000
37584   use_bsmtp
37585   user = exim
37586 .endd
37587 This causes messages addressed to &'domain.example'& to be written in BSMTP
37588 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37589 message (unless there are more than 1000 recipients).
37590
37591
37592
37593 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37594 .cindex "SMTP" "batched incoming"
37595 .cindex "batched SMTP input"
37596 The &%-bS%& command line option causes Exim to accept one or more messages by
37597 reading SMTP on the standard input, but to generate no responses. If the caller
37598 is trusted, the senders in the MAIL commands are believed; otherwise the
37599 sender is always the caller of Exim. Unqualified senders and receivers are not
37600 rejected (there seems little point) but instead just get qualified. HELO
37601 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37602 as NOOP; QUIT quits.
37603
37604 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37605 ACL is run in the same way as for non-SMTP local input.
37606
37607 If an error is detected while reading a message, including a missing &"."& at
37608 the end, Exim gives up immediately. It writes details of the error to the
37609 standard output in a stylized way that the calling program should be able to
37610 make some use of automatically, for example:
37611 .code
37612 554 Unexpected end of file
37613 Transaction started in line 10
37614 Error detected in line 14
37615 .endd
37616 It writes a more verbose version, for human consumption, to the standard error
37617 file, for example:
37618 .code
37619 An error was detected while processing a file of BSMTP input.
37620 The error message was:
37621
37622 501 '>' missing at end of address
37623
37624 The SMTP transaction started in line 10.
37625 The error was detected in line 12.
37626 The SMTP command at fault was:
37627
37628 rcpt to:<malformed@in.com.plete
37629
37630 1 previous message was successfully processed.
37631 The rest of the batch was abandoned.
37632 .endd
37633 The return code from Exim is zero only if there were no errors. It is 1 if some
37634 messages were accepted before an error was detected, and 2 if no messages were
37635 accepted.
37636 .ecindex IIDsmtpproc1
37637 .ecindex IIDsmtpproc2
37638
37639
37640
37641 . ////////////////////////////////////////////////////////////////////////////
37642 . ////////////////////////////////////////////////////////////////////////////
37643
37644 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37645          "Customizing messages"
37646 When a message fails to be delivered, or remains in the queue for more than a
37647 configured amount of time, Exim sends a message to the original sender, or
37648 to an alternative configured address. The text of these messages is built into
37649 the code of Exim, but it is possible to change it, either by adding a single
37650 string, or by replacing each of the paragraphs by text supplied in a file.
37651
37652 The &'From:'& and &'To:'& header lines are automatically generated; you can
37653 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37654 option. Exim also adds the line
37655 .code
37656 Auto-Submitted: auto-generated
37657 .endd
37658 to all warning and bounce messages,
37659
37660
37661 .section "Customizing bounce messages" "SECID239"
37662 .cindex "customizing" "bounce message"
37663 .cindex "bounce message" "customizing"
37664 If &%bounce_message_text%& is set, its contents are included in the default
37665 message immediately after &"This message was created automatically by mail
37666 delivery software."& The string is not expanded. It is not used if
37667 &%bounce_message_file%& is set.
37668
37669 When &%bounce_message_file%& is set, it must point to a template file for
37670 constructing error messages. The file consists of a series of text items,
37671 separated by lines consisting of exactly four asterisks. If the file cannot be
37672 opened, default text is used and a message is written to the main and panic
37673 logs. If any text item in the file is empty, default text is used for that
37674 item.
37675
37676 .vindex "&$bounce_recipient$&"
37677 .vindex "&$bounce_return_size_limit$&"
37678 Each item of text that is read from the file is expanded, and there are two
37679 expansion variables which can be of use here: &$bounce_recipient$& is set to
37680 the recipient of an error message while it is being created, and
37681 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37682 option, rounded to a whole number.
37683
37684 The items must appear in the file in the following order:
37685
37686 .ilist
37687 The first item is included in the headers, and should include at least a
37688 &'Subject:'& header. Exim does not check the syntax of these headers.
37689 .next
37690 The second item forms the start of the error message. After it, Exim lists the
37691 failing addresses with their error messages.
37692 .next
37693 The third item is used to introduce any text from pipe transports that is to be
37694 returned to the sender. It is omitted if there is no such text.
37695 .next
37696 The fourth, fifth and sixth items will be ignored and may be empty.
37697 The fields exist for back-compatibility
37698 .endlist
37699
37700 The default state (&%bounce_message_file%& unset) is equivalent to the
37701 following file, in which the sixth item is empty. The &'Subject:'& and some
37702 other lines have been split in order to fit them on the page:
37703 .code
37704 Subject: Mail delivery failed
37705   ${if eq{$sender_address}{$bounce_recipient}
37706   {: returning message to sender}}
37707 ****
37708 This message was created automatically by mail delivery software.
37709
37710 A message ${if eq{$sender_address}{$bounce_recipient}
37711   {that you sent }{sent by
37712
37713 <$sender_address>
37714
37715 }}could not be delivered to all of its recipients.
37716 This is a permanent error. The following address(es) failed:
37717 ****
37718 The following text was generated during the delivery attempt(s):
37719 ****
37720 ------ This is a copy of the message, including all the headers.
37721   ------
37722 ****
37723 ------ The body of the message is $message_size characters long;
37724   only the first
37725 ------ $bounce_return_size_limit or so are included here.
37726 ****
37727 .endd
37728 .section "Customizing warning messages" "SECTcustwarn"
37729 .cindex "customizing" "warning message"
37730 .cindex "warning of delay" "customizing the message"
37731 The option &%warn_message_file%& can be pointed at a template file for use when
37732 warnings about message delays are created. In this case there are only three
37733 text sections:
37734
37735 .ilist
37736 The first item is included in the headers, and should include at least a
37737 &'Subject:'& header. Exim does not check the syntax of these headers.
37738 .next
37739 The second item forms the start of the warning message. After it, Exim lists
37740 the delayed addresses.
37741 .next
37742 The third item then ends the message.
37743 .endlist
37744
37745 The default state is equivalent to the following file, except that some lines
37746 have been split here, in order to fit them on the page:
37747 .code
37748 Subject: Warning: message $message_exim_id delayed
37749   $warn_message_delay
37750 ****
37751 This message was created automatically by mail delivery software.
37752
37753 A message ${if eq{$sender_address}{$warn_message_recipients}
37754 {that you sent }{sent by
37755
37756 <$sender_address>
37757
37758 }}has not been delivered to all of its recipients after
37759 more than $warn_message_delay in the queue on $primary_hostname.
37760
37761 The message identifier is:     $message_exim_id
37762 The subject of the message is: $h_subject
37763 The date of the message is:    $h_date
37764
37765 The following address(es) have not yet been delivered:
37766 ****
37767 No action is required on your part. Delivery attempts will
37768 continue for some time, and this warning may be repeated at
37769 intervals if the message remains undelivered. Eventually the
37770 mail delivery software will give up, and when that happens,
37771 the message will be returned to you.
37772 .endd
37773 .vindex "&$warn_message_delay$&"
37774 .vindex "&$warn_message_recipients$&"
37775 However, in the default state the subject and date lines are omitted if no
37776 appropriate headers exist. During the expansion of this file,
37777 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37778 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37779 of recipients for the warning message. There may be more than one if there are
37780 multiple addresses with different &%errors_to%& settings on the routers that
37781 handled them.
37782
37783
37784
37785
37786 . ////////////////////////////////////////////////////////////////////////////
37787 . ////////////////////////////////////////////////////////////////////////////
37788
37789 .chapter "Some common configuration settings" "CHAPcomconreq"
37790 This chapter discusses some configuration settings that seem to be fairly
37791 common. More examples and discussion can be found in the Exim book.
37792
37793
37794
37795 .section "Sending mail to a smart host" "SECID240"
37796 .cindex "smart host" "example router"
37797 If you want to send all mail for non-local domains to a &"smart host"&, you
37798 should replace the default &(dnslookup)& router with a router which does the
37799 routing explicitly:
37800 .code
37801 send_to_smart_host:
37802   driver = manualroute
37803   route_list = !+local_domains smart.host.name
37804   transport = remote_smtp
37805 .endd
37806 You can use the smart host's IP address instead of the name if you wish.
37807 If you are using Exim only to submit messages to a smart host, and not for
37808 receiving incoming messages, you can arrange for it to do the submission
37809 synchronously by setting the &%mua_wrapper%& option (see chapter
37810 &<<CHAPnonqueueing>>&).
37811
37812
37813
37814
37815 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37816 .cindex "mailing lists"
37817 Exim can be used to run simple mailing lists, but for large and/or complicated
37818 requirements, the use of additional specialized mailing list software such as
37819 Majordomo or Mailman is recommended.
37820
37821 The &(redirect)& router can be used to handle mailing lists where each list
37822 is maintained in a separate file, which can therefore be managed by an
37823 independent manager. The &%domains%& router option can be used to run these
37824 lists in a separate domain from normal mail. For example:
37825 .code
37826 lists:
37827   driver = redirect
37828   domains = lists.example
37829   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37830   forbid_pipe
37831   forbid_file
37832   errors_to = ${quote_local_part:$local_part-request}@lists.example
37833   no_more
37834 .endd
37835 This router is skipped for domains other than &'lists.example'&. For addresses
37836 in that domain, it looks for a file that matches the local part. If there is no
37837 such file, the router declines, but because &%no_more%& is set, no subsequent
37838 routers are tried, and so the whole delivery fails.
37839
37840 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37841 expanded into a filename or a pipe delivery, which is usually inappropriate in
37842 a mailing list.
37843
37844 .oindex "&%errors_to%&"
37845 The &%errors_to%& option specifies that any delivery errors caused by addresses
37846 taken from a mailing list are to be sent to the given address rather than the
37847 original sender of the message. However, before acting on this, Exim verifies
37848 the error address, and ignores it if verification fails.
37849
37850 For example, using the configuration above, mail sent to
37851 &'dicts@lists.example'& is passed on to those addresses contained in
37852 &_/usr/lists/dicts_&, with error reports directed to
37853 &'dicts-request@lists.example'&, provided that this address can be verified.
37854 There could be a file called &_/usr/lists/dicts-request_& containing
37855 the address(es) of this particular list's manager(s), but other approaches,
37856 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37857 or &%local_part_suffix%& options) to handle addresses of the form
37858 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37859
37860
37861
37862 .section "Syntax errors in mailing lists" "SECID241"
37863 .cindex "mailing lists" "syntax errors in"
37864 If an entry in redirection data contains a syntax error, Exim normally defers
37865 delivery of the original address. That means that a syntax error in a mailing
37866 list holds up all deliveries to the list. This may not be appropriate when a
37867 list is being maintained automatically from data supplied by users, and the
37868 addresses are not rigorously checked.
37869
37870 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37871 entries that fail to parse, noting the incident in the log. If in addition
37872 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37873 whenever a broken address is skipped. It is usually appropriate to set
37874 &%syntax_errors_to%& to the same address as &%errors_to%&.
37875
37876
37877
37878 .section "Re-expansion of mailing lists" "SECID242"
37879 .cindex "mailing lists" "re-expansion of"
37880 Exim remembers every individual address to which a message has been delivered,
37881 in order to avoid duplication, but it normally stores only the original
37882 recipient addresses with a message. If all the deliveries to a mailing list
37883 cannot be done at the first attempt, the mailing list is re-expanded when the
37884 delivery is next tried. This means that alterations to the list are taken into
37885 account at each delivery attempt, so addresses that have been added to
37886 the list since the message arrived will therefore receive a copy of the
37887 message, even though it pre-dates their subscription.
37888
37889 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37890 on the &(redirect)& router. If this is done, any addresses generated by the
37891 router that fail to deliver at the first attempt are added to the message as
37892 &"top level"& addresses, and the parent address that generated them is marked
37893 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37894 subsequent delivery attempts. The disadvantage of this is that if any of the
37895 failing addresses are incorrect, correcting them in the file has no effect on
37896 pre-existing messages.
37897
37898 The original top-level address is remembered with each of the generated
37899 addresses, and is output in any log messages. However, any intermediate parent
37900 addresses are not recorded. This makes a difference to the log only if the
37901 &%all_parents%& selector is set, but for mailing lists there is normally only
37902 one level of expansion anyway.
37903
37904
37905
37906 .section "Closed mailing lists" "SECID243"
37907 .cindex "mailing lists" "closed"
37908 The examples so far have assumed open mailing lists, to which anybody may
37909 send mail. It is also possible to set up closed lists, where mail is accepted
37910 from specified senders only. This is done by making use of the generic
37911 &%senders%& option to restrict the router that handles the list.
37912
37913 The following example uses the same file as a list of recipients and as a list
37914 of permitted senders. It requires three routers:
37915 .code
37916 lists_request:
37917   driver = redirect
37918   domains = lists.example
37919   local_part_suffix = -request
37920   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37921   file = /usr/lists/${local_part_data}-request
37922   no_more
37923
37924 lists_post:
37925   driver = redirect
37926   domains = lists.example
37927   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37928   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37929   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37930   forbid_pipe
37931   forbid_file
37932   errors_to = ${quote_local_part:$local_part-request}@lists.example
37933   no_more
37934
37935 lists_closed:
37936   driver = redirect
37937   domains = lists.example
37938   allow_fail
37939   data = :fail: $local_part@lists.example is a closed mailing list
37940 .endd
37941 All three routers have the same &%domains%& setting, so for any other domains,
37942 they are all skipped. The first router runs only if the local part ends in
37943 &%-request%&. It handles messages to the list manager(s) by means of an open
37944 mailing list.
37945
37946 The second router runs only if the &%senders%& precondition is satisfied. It
37947 checks for the existence of a list that corresponds to the local part, and then
37948 checks that the sender is on the list by means of a linear search. It is
37949 necessary to check for the existence of the file before trying to search it,
37950 because otherwise Exim thinks there is a configuration error. If the file does
37951 not exist, the expansion of &%senders%& is *, which matches all senders. This
37952 means that the router runs, but because there is no list, declines, and
37953 &%no_more%& ensures that no further routers are run. The address fails with an
37954 &"unrouteable address"& error.
37955
37956 The third router runs only if the second router is skipped, which happens when
37957 a mailing list exists, but the sender is not on it. This router forcibly fails
37958 the address, giving a suitable error message.
37959
37960
37961
37962
37963 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37964 .cindex "VERP"
37965 .cindex "Variable Envelope Return Paths"
37966 .cindex "envelope from"
37967 .cindex "envelope sender"
37968 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37969 are a way of helping mailing list administrators discover which subscription
37970 address is the cause of a particular delivery failure. The idea is to encode
37971 the original recipient address in the outgoing envelope sender address, so that
37972 if the message is forwarded by another host and then subsequently bounces, the
37973 original recipient can be extracted from the recipient address of the bounce.
37974
37975 .oindex &%errors_to%&
37976 .oindex &%return_path%&
37977 Envelope sender addresses can be modified by Exim using two different
37978 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37979 list examples), or the &%return_path%& option on a transport. The second of
37980 these is effective only if the message is successfully delivered to another
37981 host; it is not used for errors detected on the local host (see the description
37982 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37983 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37984 .code
37985 verp_smtp:
37986   driver = smtp
37987   max_rcpt = 1
37988   return_path = \
37989     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37990       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37991 .endd
37992 This has the effect of rewriting the return path (envelope sender) on outgoing
37993 SMTP messages, if the local part of the original return path ends in
37994 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37995 local part and domain of the recipient into the return path. Suppose, for
37996 example, that a message whose return path has been set to
37997 &'somelist-request@your.dom.example'& is sent to
37998 &'subscriber@other.dom.example'&. In the transport, the return path is
37999 rewritten as
38000 .code
38001 somelist-request+subscriber=other.dom.example@your.dom.example
38002 .endd
38003 .vindex "&$local_part$&"
38004 For this to work, you must tell Exim to send multiple copies of messages that
38005 have more than one recipient, so that each copy has just one recipient. This is
38006 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
38007 might be sent to several different recipients in the same domain, in which case
38008 &$local_part$& is not available in the transport, because it is not unique.
38009
38010 Unless your host is doing nothing but mailing list deliveries, you should
38011 probably use a separate transport for the VERP deliveries, so as not to use
38012 extra resources in making one-per-recipient copies for other deliveries. This
38013 can easily be done by expanding the &%transport%& option in the router:
38014 .code
38015 dnslookup:
38016   driver = dnslookup
38017   domains = ! +local_domains
38018   transport = \
38019     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
38020       {verp_smtp}{remote_smtp}}
38021   no_more
38022 .endd
38023 If you want to change the return path using &%errors_to%& in a router instead
38024 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
38025 routers that handle mailing list addresses. This will ensure that all delivery
38026 errors, including those detected on the local host, are sent to the VERP
38027 address.
38028
38029 On a host that does no local deliveries and has no manual routing, only the
38030 &(dnslookup)& router needs to be changed. A special transport is not needed for
38031 SMTP deliveries. Every mailing list recipient has its own return path value,
38032 and so Exim must hand them to the transport one at a time. Here is an example
38033 of a &(dnslookup)& router that implements VERP:
38034 .code
38035 verp_dnslookup:
38036   driver = dnslookup
38037   domains = ! +local_domains
38038   transport = remote_smtp
38039   errors_to = \
38040     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
38041      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
38042   no_more
38043 .endd
38044 Before you start sending out messages with VERPed return paths, you must also
38045 configure Exim to accept the bounce messages that come back to those paths.
38046 Typically this is done by setting a &%local_part_suffix%& option for a
38047 router, and using this to route the messages to wherever you want to handle
38048 them.
38049
38050 The overhead incurred in using VERP depends very much on the size of the
38051 message, the number of recipient addresses that resolve to the same remote
38052 host, and the speed of the connection over which the message is being sent. If
38053 a lot of addresses resolve to the same host and the connection is slow, sending
38054 a separate copy of the message for each address may take substantially longer
38055 than sending a single copy with many recipients (for which VERP cannot be
38056 used).
38057
38058
38059
38060
38061
38062
38063 .section "Virtual domains" "SECTvirtualdomains"
38064 .cindex "virtual domains"
38065 .cindex "domain" "virtual"
38066 The phrase &'virtual domain'& is unfortunately used with two rather different
38067 meanings:
38068
38069 .ilist
38070 A domain for which there are no real mailboxes; all valid local parts are
38071 aliases for other email addresses. Common examples are organizational
38072 top-level domains and &"vanity"& domains.
38073 .next
38074 One of a number of independent domains that are all handled by the same host,
38075 with mailboxes on that host, but where the mailbox owners do not necessarily
38076 have login accounts on that host.
38077 .endlist
38078
38079 The first usage is probably more common, and does seem more &"virtual"& than
38080 the second. This kind of domain can be handled in Exim with a straightforward
38081 aliasing router. One approach is to create a separate alias file for each
38082 virtual domain. Exim can test for the existence of the alias file to determine
38083 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
38084 to a router of this form:
38085 .code
38086 virtual:
38087   driver = redirect
38088   domains = dsearch;/etc/mail/virtual
38089   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
38090   no_more
38091 .endd
38092 The &%domains%& option specifies that the router is to be skipped, unless there
38093 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
38094 domain that is being processed.
38095 The &(dsearch)& lookup used results in an untainted version of &$domain$&
38096 being placed into the &$domain_data$& variable.
38097
38098 When the router runs, it looks up the local
38099 part in the file to find a new address (or list of addresses). The &%no_more%&
38100 setting ensures that if the lookup fails (leading to &%data%& being an empty
38101 string), Exim gives up on the address without trying any subsequent routers.
38102
38103 This one router can handle all the virtual domains because the alias filenames
38104 follow a fixed pattern. Permissions can be arranged so that appropriate people
38105 can edit the different alias files. A successful aliasing operation results in
38106 a new envelope recipient address, which is then routed from scratch.
38107
38108 The other kind of &"virtual"& domain can also be handled in a straightforward
38109 way. One approach is to create a file for each domain containing a list of
38110 valid local parts, and use it in a router like this:
38111 .code
38112 my_domains:
38113   driver = accept
38114   domains = dsearch;/etc/mail/domains
38115   local_parts = lsearch;/etc/mail/domains/$domain
38116   transport = my_mailboxes
38117 .endd
38118 The address is accepted if there is a file for the domain, and the local part
38119 can be found in the file. The &%domains%& option is used to check for the
38120 file's existence because &%domains%& is tested before the &%local_parts%&
38121 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
38122 because that option is tested after &%local_parts%&. The transport is as
38123 follows:
38124 .code
38125 my_mailboxes:
38126   driver = appendfile
38127   file = /var/mail/$domain_data/$local_part_data
38128   user = mail
38129 .endd
38130 This uses a directory of mailboxes for each domain. The &%user%& setting is
38131 required, to specify which uid is to be used for writing to the mailboxes.
38132
38133 The configuration shown here is just one example of how you might support this
38134 requirement. There are many other ways this kind of configuration can be set
38135 up, for example, by using a database instead of separate files to hold all the
38136 information about the domains.
38137
38138
38139
38140 .section "Multiple user mailboxes" "SECTmulbox"
38141 .cindex "multiple mailboxes"
38142 .cindex "mailbox" "multiple"
38143 .cindex "local part" "prefix"
38144 .cindex "local part" "suffix"
38145 Heavy email users often want to operate with multiple mailboxes, into which
38146 incoming mail is automatically sorted. A popular way of handling this is to
38147 allow users to use multiple sender addresses, so that replies can easily be
38148 identified. Users are permitted to add prefixes or suffixes to their local
38149 parts for this purpose. The wildcard facility of the generic router options
38150 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
38151 example, consider this router:
38152 .code
38153 userforward:
38154   driver = redirect
38155   check_local_user
38156   file = $home/.forward
38157   local_part_suffix = -*
38158   local_part_suffix_optional
38159   allow_filter
38160 .endd
38161 .vindex "&$local_part_suffix$&"
38162 It runs a user's &_.forward_& file for all local parts of the form
38163 &'username-*'&. Within the filter file the user can distinguish different
38164 cases by testing the variable &$local_part_suffix$&. For example:
38165 .code
38166 if $local_part_suffix contains -special then
38167 save /home/$local_part_data/Mail/special
38168 endif
38169 .endd
38170 If the filter file does not exist, or does not deal with such addresses, they
38171 fall through to subsequent routers, and, assuming no subsequent use of the
38172 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
38173 control over which suffixes are valid.
38174
38175 Alternatively, a suffix can be used to trigger the use of a different
38176 &_.forward_& file &-- which is the way a similar facility is implemented in
38177 another MTA:
38178 .code
38179 userforward:
38180   driver = redirect
38181   check_local_user
38182   local_part_suffix = -*
38183   local_part_suffix_optional
38184   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
38185   allow_filter
38186 .endd
38187 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
38188 example, &_.forward-special_& is used. Once again, if the appropriate file
38189 does not exist, or does not deal with the address, it is passed on to
38190 subsequent routers, which could, if required, look for an unqualified
38191 &_.forward_& file to use as a default.
38192
38193
38194
38195 .section "Simplified vacation processing" "SECID244"
38196 .cindex "vacation processing"
38197 The traditional way of running the &'vacation'& program is for a user to set up
38198 a pipe command in a &_.forward_& file
38199 (see section &<<SECTspecitredli>>& for syntax details).
38200 This is prone to error by inexperienced users. There are two features of Exim
38201 that can be used to make this process simpler for users:
38202
38203 .ilist
38204 A local part prefix such as &"vacation-"& can be specified on a router which
38205 can cause the message to be delivered directly to the &'vacation'& program, or
38206 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
38207 &_.forward_& file are then much simpler. For example:
38208 .code
38209 spqr, vacation-spqr
38210 .endd
38211 .next
38212 The &%require_files%& generic router option can be used to trigger a
38213 vacation delivery by checking for the existence of a certain file in the
38214 user's home directory. The &%unseen%& generic option should also be used, to
38215 ensure that the original delivery also proceeds. In this case, all the user has
38216 to do is to create a file called, say, &_.vacation_&, containing a vacation
38217 message.
38218 .endlist
38219
38220 Another advantage of both these methods is that they both work even when the
38221 use of arbitrary pipes by users is locked out.
38222
38223
38224
38225 .section "Taking copies of mail" "SECID245"
38226 .cindex "message" "copying every"
38227 Some installations have policies that require archive copies of all messages to
38228 be made. A single copy of each message can easily be taken by an appropriate
38229 command in a system filter, which could, for example, use a different file for
38230 each day's messages.
38231
38232 There is also a shadow transport mechanism that can be used to take copies of
38233 messages that are successfully delivered by local transports, one copy per
38234 delivery. This could be used, &'inter alia'&, to implement automatic
38235 notification of delivery by sites that insist on doing such things.
38236
38237
38238
38239 .section "Intermittently connected hosts" "SECID246"
38240 .cindex "intermittently connected hosts"
38241 It has become quite common (because it is cheaper) for hosts to connect to the
38242 Internet periodically rather than remain connected all the time. The normal
38243 arrangement is that mail for such hosts accumulates on a system that is
38244 permanently connected.
38245
38246 Exim was designed for use on permanently connected hosts, and so it is not
38247 particularly well-suited to use in an intermittently connected environment.
38248 Nevertheless there are some features that can be used.
38249
38250
38251 .section "Exim on the upstream server host" "SECID247"
38252 It is tempting to arrange for incoming mail for the intermittently connected
38253 host to remain in Exim's queue until the client connects. However, this
38254 approach does not scale very well. Two different kinds of waiting message are
38255 being mixed up in the same queue &-- those that cannot be delivered because of
38256 some temporary problem, and those that are waiting for their destination host
38257 to connect. This makes it hard to manage the queue, as well as wasting
38258 resources, because each queue runner scans the entire queue.
38259
38260 A better approach is to separate off those messages that are waiting for an
38261 intermittently connected host. This can be done by delivering these messages
38262 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
38263 format, from where they are transmitted by other software when their
38264 destination connects. This makes it easy to collect all the mail for one host
38265 in a single directory, and to apply local timeout rules on a per-message basis
38266 if required.
38267
38268 On a very small scale, leaving the mail on Exim's queue can be made to work. If
38269 you are doing this, you should configure Exim with a long retry period for the
38270 intermittent host. For example:
38271 .code
38272 cheshire.wonderland.fict.example    *   F,5d,24h
38273 .endd
38274 This stops a lot of failed delivery attempts from occurring, but Exim remembers
38275 which messages it has queued up for that host. Once the intermittent host comes
38276 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
38277 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
38278 causes all the queued up messages to be delivered, often down a single SMTP
38279 connection. While the host remains connected, any new messages get delivered
38280 immediately.
38281
38282 If the connecting hosts do not have fixed IP addresses, that is, if a host is
38283 issued with a different IP address each time it connects, Exim's retry
38284 mechanisms on the holding host get confused, because the IP address is normally
38285 used as part of the key string for holding retry information. This can be
38286 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
38287 Since this has disadvantages for permanently connected hosts, it is best to
38288 arrange a separate transport for the intermittently connected ones.
38289
38290
38291
38292 .section "Exim on the intermittently connected client host" "SECID248"
38293 The value of &%smtp_accept_queue_per_connection%& should probably be
38294 increased, or even set to zero (that is, disabled) on the intermittently
38295 connected host, so that all incoming messages down a single connection get
38296 delivered immediately.
38297
38298 .cindex "SMTP" "passed connection"
38299 .cindex "SMTP" "multiple deliveries"
38300 .cindex "multiple SMTP deliveries"
38301 .cindex "first pass routing"
38302 Mail waiting to be sent from an intermittently connected host will probably
38303 not have been routed, because without a connection DNS lookups are not
38304 possible. This means that if a normal queue run is done at connection time,
38305 each message is likely to be sent in a separate SMTP session. This can be
38306 avoided by starting the queue run with a command line option beginning with
38307 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
38308 first pass, routing is done but no deliveries take place. The second pass is a
38309 normal queue run; since all the messages have been previously routed, those
38310 destined for the same host are likely to get sent as multiple deliveries in a
38311 single SMTP connection.
38312
38313
38314
38315 . ////////////////////////////////////////////////////////////////////////////
38316 . ////////////////////////////////////////////////////////////////////////////
38317
38318 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
38319          "Exim as a non-queueing client"
38320 .cindex "client, non-queueing"
38321 .cindex "smart host" "suppressing queueing"
38322 On a personal computer, it is a common requirement for all
38323 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
38324 configured to operate that way, for all the popular operating systems.
38325 However, there are some MUAs for Unix-like systems that cannot be so
38326 configured: they submit messages using the command line interface of
38327 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
38328 messages this way.
38329
38330 If the personal computer runs continuously, there is no problem, because it can
38331 run a conventional MTA that handles delivery to the smart host, and deal with
38332 any delays via its queueing mechanism. However, if the computer does not run
38333 continuously or runs different operating systems at different times, queueing
38334 email is not desirable.
38335
38336 There is therefore a requirement for something that can provide the
38337 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
38338 any queueing or retrying facilities. Furthermore, the delivery to the smart
38339 host should be synchronous, so that if it fails, the sending MUA is immediately
38340 informed. In other words, we want something that extends an MUA that submits
38341 to a local MTA via the command line so that it behaves like one that submits
38342 to a remote smart host using TCP/SMTP.
38343
38344 There are a number of applications (for example, there is one called &'ssmtp'&)
38345 that do this job. However, people have found them to be lacking in various
38346 ways. For instance, you might want to allow aliasing and forwarding to be done
38347 before sending a message to the smart host.
38348
38349 Exim already had the necessary infrastructure for doing this job. Just a few
38350 tweaks were needed to make it behave as required, though it is somewhat of an
38351 overkill to use a fully-featured MTA for this purpose.
38352
38353 .oindex "&%mua_wrapper%&"
38354 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
38355 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
38356 assumes that it is being used to &"wrap"& a command-line MUA in the manner
38357 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38358 compatible router and transport configuration. Typically there will be just one
38359 router and one transport, sending everything to a smart host.
38360
38361 When run in MUA wrapping mode, the behaviour of Exim changes in the
38362 following ways:
38363
38364 .ilist
38365 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38366 In other words, the only way to submit messages is via the command line.
38367 .next
38368 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38369 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38370 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38371 does not finish until the delivery attempt is complete. If the delivery is
38372 successful, a zero return code is given.
38373 .next
38374 Address redirection is permitted, but the final routing for all addresses must
38375 be to the same remote transport, and to the same list of hosts. Furthermore,
38376 the return address (envelope sender) must be the same for all recipients, as
38377 must any added or deleted header lines. In other words, it must be possible to
38378 deliver the message in a single SMTP transaction, however many recipients there
38379 are.
38380 .next
38381 If these conditions are not met, or if routing any address results in a
38382 failure or defer status, or if Exim is unable to deliver all the recipients
38383 successfully to one of the smart hosts, delivery of the entire message fails.
38384 .next
38385 Because no queueing is allowed, all failures are treated as permanent; there
38386 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38387 smart host. Furthermore, because only a single yes/no response can be given to
38388 the caller, it is not possible to deliver to some recipients and not others. If
38389 there is an error (temporary or permanent) for any recipient, all are failed.
38390 .next
38391 If more than one smart host is listed, Exim will try another host after a
38392 connection failure or a timeout, in the normal way. However, if this kind of
38393 failure happens for all the hosts, the delivery fails.
38394 .next
38395 When delivery fails, an error message is written to the standard error stream
38396 (as well as to Exim's log), and Exim exits to the caller with a return code
38397 value 1. The message is expunged from Exim's spool files. No bounce messages
38398 are ever generated.
38399 .next
38400 No retry data is maintained, and any retry rules are ignored.
38401 .next
38402 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38403 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38404 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38405 .endlist
38406
38407 The overall effect is that Exim makes a single synchronous attempt to deliver
38408 the message, failing if there is any kind of problem. Because no local
38409 deliveries are done and no daemon can be run, Exim does not need root
38410 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38411 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38412 the advantages and disadvantages of running without root privilege.
38413
38414
38415
38416
38417 . ////////////////////////////////////////////////////////////////////////////
38418 . ////////////////////////////////////////////////////////////////////////////
38419
38420 .chapter "Log files" "CHAPlog"
38421 .scindex IIDloggen "log" "general description"
38422 .cindex "log" "types of"
38423 Exim writes three different logs, referred to as the main log, the reject log,
38424 and the panic log:
38425
38426 .ilist
38427 .cindex "main log"
38428 The main log records the arrival of each message and each delivery in a single
38429 line in each case. The format is as compact as possible, in an attempt to keep
38430 down the size of log files. Two-character flag sequences make it easy to pick
38431 out these lines. A number of other events are recorded in the main log. Some of
38432 them are optional, in which case the &%log_selector%& option controls whether
38433 they are included or not. A Perl script called &'eximstats'&, which does simple
38434 analysis of main log files, is provided in the Exim distribution (see section
38435 &<<SECTmailstat>>&).
38436 .next
38437 .cindex "reject log"
38438 The reject log records information from messages that are rejected as a result
38439 of a configuration option (that is, for policy reasons).
38440 The first line of each rejection is a copy of the line that is also written to
38441 the main log. Then, if the message's header has been read at the time the log
38442 is written, its contents are written to this log. Only the original header
38443 lines are available; header lines added by ACLs are not logged. You can use the
38444 reject log to check that your policy controls are working correctly; on a busy
38445 host this may be easier than scanning the main log for rejection messages. You
38446 can suppress the writing of the reject log by setting &%write_rejectlog%&
38447 false.
38448 .next
38449 .cindex "panic log"
38450 .cindex "system log"
38451 When certain serious errors occur, Exim writes entries to its panic log. If the
38452 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38453 are usually written to the main log as well, but can get lost amid the mass of
38454 other entries. The panic log should be empty under normal circumstances. It is
38455 therefore a good idea to check it (or to have a &'cron'& script check it)
38456 regularly, in order to become aware of any problems. When Exim cannot open its
38457 panic log, it tries as a last resort to write to the system log (syslog). This
38458 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38459 message itself is written at priority LOG_CRIT.
38460 .endlist
38461
38462 Every log line starts with a timestamp, in the format shown in the following
38463 example. Note that many of the examples shown in this chapter are line-wrapped.
38464 In the log file, this would be all on one line:
38465 .code
38466 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38467   by QUIT
38468 .endd
38469 By default, the timestamps are in the local timezone. There are two
38470 ways of changing this:
38471
38472 .ilist
38473 You can set the &%timezone%& option to a different time zone; in particular, if
38474 you set
38475 .code
38476 timezone = UTC
38477 .endd
38478 the timestamps will be in UTC (aka GMT).
38479 .next
38480 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38481 example:
38482 .code
38483 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38484 .endd
38485 .endlist
38486
38487 .cindex "log" "process ids in"
38488 .cindex "pid (process id)" "in log lines"
38489 Exim does not include its process id in log lines by default, but you can
38490 request that it does so by specifying the &`pid`& log selector (see section
38491 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38492 brackets, immediately after the time and date.
38493
38494
38495
38496
38497 .section "Where the logs are written" "SECTwhelogwri"
38498 .cindex "log" "destination"
38499 .cindex "log" "to file"
38500 .cindex "log" "to syslog"
38501 .cindex "syslog"
38502 The logs may be written to local files, or to syslog, or both. However, it
38503 should be noted that many syslog implementations use UDP as a transport, and
38504 are therefore unreliable in the sense that messages are not guaranteed to
38505 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38506 It has also been reported that on large log files (tens of megabytes) you may
38507 need to tweak syslog to prevent it syncing the file with each write &-- on
38508 Linux this has been seen to make syslog take 90% plus of CPU time.
38509
38510 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38511 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38512 configuration. This latter string is expanded, so it can contain, for example,
38513 references to the host name:
38514 .code
38515 log_file_path = /var/log/$primary_hostname/exim_%slog
38516 .endd
38517 It is generally advisable, however, to set the string in &_Local/Makefile_&
38518 rather than at runtime, because then the setting is available right from the
38519 start of Exim's execution. Otherwise, if there's something it wants to log
38520 before it has read the configuration file (for example, an error in the
38521 configuration file) it will not use the path you want, and may not be able to
38522 log at all.
38523
38524 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38525 list, currently limited to at most two items. This is one option where the
38526 facility for changing a list separator may not be used. The list must always be
38527 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38528 otherwise the item must either be an absolute path, containing &`%s`& at the
38529 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38530 implying the use of a default path.
38531
38532 When Exim encounters an empty item in the list, it searches the list defined by
38533 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38534 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38535 mean &"use the path specified at build time"&. If no such item exists, log
38536 files are written in the &_log_& subdirectory of the spool directory. This is
38537 equivalent to the configuration file setting:
38538 .code
38539 log_file_path = $spool_directory/log/%slog
38540 .endd
38541 If you do not specify anything at build time or runtime,
38542 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38543 that is where the logs are written.
38544
38545 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38546 are in use &-- see section &<<SECTdatlogfil>>& below.
38547
38548 Here are some examples of possible Makefile settings:
38549 .display
38550 &`LOG_FILE_PATH=syslog                    `& syslog only
38551 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38552 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38553 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38554 .endd
38555 If there are more than two paths in the list, the first is used and a panic
38556 error is logged.
38557
38558
38559
38560 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38561 .cindex "log" "cycling local files"
38562 .cindex "cycling logs"
38563 .cindex "&'exicyclog'&"
38564 .cindex "log" "local files; writing to"
38565 Some operating systems provide centralized and standardized methods for cycling
38566 log files. For those that do not, a utility script called &'exicyclog'& is
38567 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38568 main and reject logs each time it is called. The maximum number of old logs to
38569 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38570
38571 An Exim delivery process opens the main log when it first needs to write to it,
38572 and it keeps the file open in case subsequent entries are required &-- for
38573 example, if a number of different deliveries are being done for the same
38574 message. However, remote SMTP deliveries can take a long time, and this means
38575 that the file may be kept open long after it is renamed if &'exicyclog'& or
38576 something similar is being used to rename log files on a regular basis. To
38577 ensure that a switch of log files is noticed as soon as possible, Exim calls
38578 &[stat()]& on the main log's name before reusing an open file, and if the file
38579 does not exist, or its inode has changed, the old file is closed and Exim
38580 tries to open the main log from scratch. Thus, an old log file may remain open
38581 for quite some time, but no Exim processes should write to it once it has been
38582 renamed.
38583
38584
38585
38586 .section "Datestamped log files" "SECTdatlogfil"
38587 .cindex "log" "datestamped files"
38588 Instead of cycling the main and reject log files by renaming them
38589 periodically, some sites like to use files whose names contain a datestamp,
38590 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38591 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38592 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38593 point where the datestamp is required. For example:
38594 .code
38595 log_file_path = /var/spool/exim/log/%slog-%D
38596 log_file_path = /var/log/exim-%s-%D.log
38597 log_file_path = /var/spool/exim/log/%D-%slog
38598 log_file_path = /var/log/exim/%s.%M
38599 .endd
38600 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38601 examples of names generated by the above examples:
38602 .code
38603 /var/spool/exim/log/mainlog-20021225
38604 /var/log/exim-reject-20021225.log
38605 /var/spool/exim/log/20021225-mainlog
38606 /var/log/exim/main.200212
38607 .endd
38608 When this form of log file is specified, Exim automatically switches to new
38609 files at midnight. It does not make any attempt to compress old logs; you
38610 will need to write your own script if you require this. You should not
38611 run &'exicyclog'& with this form of logging.
38612
38613 The location of the panic log is also determined by &%log_file_path%&, but it
38614 is not datestamped, because rotation of the panic log does not make sense.
38615 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38616 the string. In addition, if it immediately follows a slash, a following
38617 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38618 character is removed. Thus, the four examples above would give these panic
38619 log names:
38620 .code
38621 /var/spool/exim/log/paniclog
38622 /var/log/exim-panic.log
38623 /var/spool/exim/log/paniclog
38624 /var/log/exim/panic
38625 .endd
38626
38627
38628 .section "Logging to syslog" "SECID249"
38629 .cindex "log" "syslog; writing to"
38630 The use of syslog does not change what Exim logs or the format of its messages,
38631 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38632 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38633 that, the same strings are written to syslog as to log files. The syslog
38634 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38635 by default, but you can change these by setting the &%syslog_facility%& and
38636 &%syslog_processname%& options, respectively. If Exim was compiled with
38637 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38638 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38639 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38640 the time and host name to each line.
38641 The three log streams are mapped onto syslog priorities as follows:
38642
38643 .ilist
38644 &'mainlog'& is mapped to LOG_INFO
38645 .next
38646 &'rejectlog'& is mapped to LOG_NOTICE
38647 .next
38648 &'paniclog'& is mapped to LOG_ALERT
38649 .endlist
38650
38651 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38652 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38653 these are routed by syslog to the same place. You can suppress this duplication
38654 by setting &%syslog_duplication%& false.
38655
38656 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38657 entries contain multiple lines when headers are included. To cope with both
38658 these cases, entries written to syslog are split into separate &[syslog()]&
38659 calls at each internal newline, and also after a maximum of
38660 870 data characters. (This allows for a total syslog line length of 1024, when
38661 additions such as timestamps are added.) If you are running a syslog
38662 replacement that can handle lines longer than the 1024 characters allowed by
38663 RFC 3164, you should set
38664 .code
38665 SYSLOG_LONG_LINES=yes
38666 .endd
38667 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38668 lines, but it still splits at internal newlines in &'reject'& log entries.
38669
38670 To make it easy to re-assemble split lines later, each component of a split
38671 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38672 where <&'n'&> is the component number and <&'m'&> is the total number of
38673 components in the entry. The / delimiter is used when the line was split
38674 because it was too long; if it was split because of an internal newline, the \
38675 delimiter is used. For example, supposing the length limit to be 50 instead of
38676 870, the following would be the result of a typical rejection message to
38677 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38678 name, and pid as added by syslog:
38679 .code
38680 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38681 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38682 [3/5]  when scanning for sender: missing or malformed lo
38683 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38684 [5/5] mple>)
38685 .endd
38686 The same error might cause the following lines to be written to &"rejectlog"&
38687 (LOG_NOTICE):
38688 .code
38689 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38690 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38691 [3/18] er when scanning for sender: missing or malformed
38692 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38693 [5\18] .example>)
38694 [6\18] Recipients: ph10@some.domain.cam.example
38695 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38696 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38697 [9\18]        id 16RdAL-0006pc-00
38698 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38699 [11\18] 09:43 +0100
38700 [12\18] F From: <>
38701 [13\18]   Subject: this is a test header
38702 [18\18]   X-something: this is another header
38703 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38704 [16\18] le>
38705 [17\18] B Bcc:
38706 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38707 .endd
38708 Log lines that are neither too long nor contain newlines are written to syslog
38709 without modification.
38710
38711 If only syslog is being used, the Exim monitor is unable to provide a log tail
38712 display, unless syslog is routing &'mainlog'& to a file on the local host and
38713 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38714 where it is.
38715
38716
38717
38718 .section "Log line flags" "SECID250"
38719 One line is written to the main log for each message received, and for each
38720 successful, unsuccessful, and delayed delivery. These lines can readily be
38721 picked out by the distinctive two-character flags that immediately follow the
38722 timestamp. The flags are:
38723 .itable none 0 0 2 10* left 90* left
38724 .irow &%<=%&     "message arrival"
38725 .irow &%(=%&     "message fakereject"
38726 .irow &%=>%&     "normal message delivery"
38727 .irow &%->%&     "additional address in same delivery"
38728 .irow &%>>%&     "cutthrough message delivery"
38729 .irow &%*>%&     "delivery suppressed by &%-N%&"
38730 .irow &%**%&     "delivery failed; address bounced"
38731 .irow &%==%&     "delivery deferred; temporary problem"
38732 .endtable
38733
38734
38735 .section "Logging message reception" "SECID251"
38736 .cindex "log" "reception line"
38737 The format of the single-line entry in the main log that is written for every
38738 message received is shown in the basic example below, which is split over
38739 several lines in order to fit it on the page:
38740 .code
38741 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38742   H=mailer.fict.example [192.168.123.123] U=exim
38743   P=smtp S=5678 id=<incoming message id>
38744 .endd
38745 The address immediately following &"<="& is the envelope sender address. A
38746 bounce message is shown with the sender address &"<>"&, and if it is locally
38747 generated, this is followed by an item of the form
38748 .code
38749 R=<message id>
38750 .endd
38751 which is a reference to the message that caused the bounce to be sent.
38752
38753 .cindex "HELO"
38754 .cindex "EHLO"
38755 For messages from other hosts, the H and U fields identify the remote host and
38756 record the RFC 1413 identity of the user that sent the message, if one was
38757 received. The number given in square brackets is the IP address of the sending
38758 host. If there is a single, unparenthesized  host name in the H field, as
38759 above, it has been verified to correspond to the IP address (see the
38760 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38761 by the remote host in the SMTP HELO or EHLO command, and has not been
38762 verified. If verification yields a different name to that given for HELO or
38763 EHLO, the verified name appears first, followed by the HELO or EHLO
38764 name in parentheses.
38765
38766 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38767 without brackets, in the HELO or EHLO command, leading to entries in
38768 the log containing text like these examples:
38769 .code
38770 H=(10.21.32.43) [192.168.8.34]
38771 H=([10.21.32.43]) [192.168.8.34]
38772 .endd
38773 This can be confusing. Only the final address in square brackets can be relied
38774 on.
38775
38776 For locally generated messages (that is, messages not received over TCP/IP),
38777 the H field is omitted, and the U field contains the login name of the caller
38778 of Exim.
38779
38780 .cindex "authentication" "logging"
38781 .cindex "AUTH" "logging"
38782 For all messages, the P field specifies the protocol used to receive the
38783 message. This is the value that is stored in &$received_protocol$&. In the case
38784 of incoming SMTP messages, the value indicates whether or not any SMTP
38785 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38786 session was encrypted, there is an additional X field that records the cipher
38787 suite that was used.
38788
38789 .cindex log protocol
38790 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38791 hosts that have authenticated themselves using the SMTP AUTH command. The first
38792 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38793 there is an additional item A= followed by the name of the authenticator that
38794 was used. If an authenticated identification was set up by the authenticator's
38795 &%server_set_id%& option, this is logged too, separated by a colon from the
38796 authenticator name.
38797
38798 .cindex "size" "of message"
38799 The id field records the existing message id, if present. The size of the
38800 received message is given by the S field. When the message is delivered,
38801 headers may be removed or added, so that the size of delivered copies of the
38802 message may not correspond with this value (and indeed may be different to each
38803 other).
38804
38805 The &%log_selector%& option can be used to request the logging of additional
38806 data when a message is received. See section &<<SECTlogselector>>& below.
38807
38808
38809
38810 .section "Logging deliveries" "SECID252"
38811 .cindex "log" "delivery line"
38812 The format of the single-line entry in the main log that is written for every
38813 delivery is shown in one of the examples below, for local and remote
38814 deliveries, respectively. Each example has been split into multiple lines in order
38815 to fit it on the page:
38816 .code
38817 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38818   <marv@hitch.fict.example> R=localuser T=local_delivery
38819 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38820   monk@holistic.fict.example R=dnslookup T=remote_smtp
38821   H=holistic.fict.example [192.168.234.234]
38822 .endd
38823 For ordinary local deliveries, the original address is given in angle brackets
38824 after the final delivery address, which might be a pipe or a file. If
38825 intermediate address(es) exist between the original and the final address, the
38826 last of these is given in parentheses after the final address. The R and T
38827 fields record the router and transport that were used to process the address.
38828
38829 If SMTP AUTH was used for the delivery there is an additional item A=
38830 followed by the name of the authenticator that was used.
38831 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38832 option, this is logged too, as a second colon-separated list item.
38833 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38834
38835 If a shadow transport was run after a successful local delivery, the log line
38836 for the successful delivery has an item added on the end, of the form
38837 .display
38838 &`ST=<`&&'shadow transport name'&&`>`&
38839 .endd
38840 If the shadow transport did not succeed, the error message is put in
38841 parentheses afterwards.
38842
38843 .cindex "asterisk" "after IP address"
38844 When more than one address is included in a single delivery (for example, two
38845 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38846 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38847 down a single SMTP connection, an asterisk follows the
38848 remote IP address (and port if enabled)
38849 in the log lines for the second and subsequent messages.
38850 When two or more messages are delivered down a single TLS connection, the
38851 DNS and some TLS-related information logged for the first message delivered
38852 will not be present in the log lines for the second and subsequent messages.
38853 TLS cipher information is still available.
38854
38855 .cindex "delivery" "cutthrough; logging"
38856 .cindex "cutthrough" "logging"
38857 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38858 line precedes the reception line, since cutthrough waits for a possible
38859 rejection from the destination in case it can reject the sourced item.
38860
38861 The generation of a reply message by a filter file gets logged as a
38862 &"delivery"& to the addressee, preceded by &">"&.
38863
38864 The &%log_selector%& option can be used to request the logging of additional
38865 data when a message is delivered. See section &<<SECTlogselector>>& below.
38866
38867
38868 .section "Discarded deliveries" "SECID253"
38869 .cindex "discarded messages"
38870 .cindex "message" "discarded"
38871 .cindex "delivery" "discarded; logging"
38872 When a message is discarded as a result of the command &"seen finish"& being
38873 obeyed in a filter file which generates no deliveries, a log entry of the form
38874 .code
38875 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38876   <low.club@bridge.example> R=userforward
38877 .endd
38878 is written, to record why no deliveries are logged. When a message is discarded
38879 because it is aliased to &":blackhole:"& the log line is like this:
38880 .code
38881 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38882   <hole@nowhere.example> R=blackhole_router
38883 .endd
38884
38885
38886 .section "Deferred deliveries" "SECID254"
38887 When a delivery is deferred, a line of the following form is logged:
38888 .code
38889 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38890   R=dnslookup T=smtp defer (146): Connection refused
38891 .endd
38892 In the case of remote deliveries, the error is the one that was given for the
38893 last IP address that was tried. Details of individual SMTP failures are also
38894 written to the log, so the above line would be preceded by something like
38895 .code
38896 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38897   mail1.endrest.example [192.168.239.239]: Connection refused
38898 .endd
38899 When a deferred address is skipped because its retry time has not been reached,
38900 a message is written to the log, but this can be suppressed by setting an
38901 appropriate value in &%log_selector%&.
38902
38903
38904
38905 .section "Delivery failures" "SECID255"
38906 .cindex "delivery" "failure; logging"
38907 If a delivery fails because an address cannot be routed, a line of the
38908 following form is logged:
38909 .code
38910 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38911   <jim@trek99.example>: unknown mail domain
38912 .endd
38913 If a delivery fails at transport time, the router and transport are shown, and
38914 the response from the remote host is included, as in this example:
38915 .code
38916 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38917   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38918   after pipelined RCPT TO:<ace400@pb.example>: host
38919   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38920   <ace400@pb.example>...Addressee unknown
38921 .endd
38922 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38923 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38924 disabling PIPELINING. The log lines for all forms of delivery failure are
38925 flagged with &`**`&.
38926
38927
38928
38929 .section "Fake deliveries" "SECID256"
38930 .cindex "delivery" "fake; logging"
38931 If a delivery does not actually take place because the &%-N%& option has been
38932 used to suppress it, a normal delivery line is written to the log, except that
38933 &"=>"& is replaced by &"*>"&.
38934
38935
38936
38937 .section "Completion" "SECID257"
38938 A line of the form
38939 .code
38940 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38941 .endd
38942 is written to the main log when a message is about to be removed from the spool
38943 at the end of its processing.
38944
38945
38946
38947
38948 .section "Summary of Fields in Log Lines" "SECID258"
38949 .cindex "log" "summary of fields"
38950 A summary of the field identifiers that are used in log lines is shown in
38951 the following table:
38952 .display
38953 &`A   `&        authenticator name (and optional id and sender)
38954 &`C   `&        SMTP confirmation on delivery
38955 &`Ci  `&        connection identifier
38956 &`    `&        command list for &"no mail in SMTP session"&
38957 &`CV  `&        certificate verification status
38958 &`D   `&        duration of &"no mail in SMTP session"&
38959 &`DKIM`&        domain verified in incoming message
38960 &`DN  `&        distinguished name from peer certificate
38961 &`DS  `&        DNSSEC secured lookups
38962 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38963 &`F   `&        sender address (on delivery lines)
38964 &`H   `&        host name and IP address
38965 &`I   `&        local interface used
38966 &`id  `&        message id (from header) for incoming message
38967 &`K   `&        CHUNKING extension used
38968 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38969 &`M8S `&        8BITMIME status for incoming message
38970 &`P   `&        on &`<=`& lines: protocol used
38971 &`    `&        on &`=>`& and &`**`& lines: return path
38972 &`PRDR`&        PRDR extension used
38973 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38974 &`Q   `&        alternate queue name
38975 &`QT  `&        on &`=>`& lines: time spent on queue so far
38976 &`    `&        on &"Completed"& lines: time spent on queue
38977 &`R   `&        on &`<=`& lines: reference for local bounce
38978 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38979 &`RT  `&        on &`<=`& lines: time taken for reception
38980 &`S   `&        size of message in bytes
38981 &`SNI `&        server name indication from TLS client hello
38982 &`ST  `&        shadow transport name
38983 &`T   `&        on &`<=`& lines: message subject (topic)
38984 &`TFO `&        connection took advantage of TCP Fast Open
38985 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38986 &`U   `&        local user or RFC 1413 identity
38987 &`X   `&        TLS cipher suite
38988 .endd
38989
38990
38991 .section "Other log entries" "SECID259"
38992 Various other types of log entry are written from time to time. Most should be
38993 self-explanatory. Among the more common are:
38994
38995 .ilist
38996 .cindex "retry" "time not reached"
38997 &'retry time not reached'&&~&~An address previously suffered a temporary error
38998 during routing or local delivery, and the time to retry has not yet arrived.
38999 This message is not written to an individual message log file unless it happens
39000 during the first delivery attempt.
39001 .next
39002 &'retry time not reached for any host'&&~&~An address previously suffered
39003 temporary errors during remote delivery, and the retry time has not yet arrived
39004 for any of the hosts to which it is routed.
39005 .next
39006 .cindex "spool directory" "file locked"
39007 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
39008 some other Exim process is already working on the message. This can be quite
39009 common if queue running processes are started at frequent intervals. The
39010 &'exiwhat'& utility script can be used to find out what Exim processes are
39011 doing.
39012 .next
39013 .cindex "error" "ignored"
39014 &'error ignored'&&~&~There are several circumstances that give rise to this
39015 message:
39016 .olist
39017 Exim failed to deliver a bounce message whose age was greater than
39018 &%ignore_bounce_errors_after%&. The bounce was discarded.
39019 .next
39020 A filter file set up a delivery using the &"noerror"& option, and the delivery
39021 failed. The delivery was discarded.
39022 .next
39023 A delivery set up by a router configured with
39024 . ==== As this is a nested list, any displays it contains must be indented
39025 . ==== as otherwise they are too far to the left.
39026 .code
39027     errors_to = <>
39028 .endd
39029 failed. The delivery was discarded.
39030 .endlist olist
39031 .next
39032 .cindex DKIM "log line"
39033 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
39034 logging and the message has a DKIM signature header.
39035 .endlist ilist
39036
39037
39038
39039
39040
39041 .section "Reducing or increasing what is logged" "SECTlogselector"
39042 .cindex "log" "selectors"
39043 By setting the &%log_selector%& global option, you can disable some of Exim's
39044 default logging to the main log, or you can request additional logging. The value of
39045 &%log_selector%& is made up of names preceded by plus or minus characters. For
39046 example:
39047 .code
39048 log_selector = +arguments -retry_defer
39049 .endd
39050 The list of optional log items is in the following table, with the default
39051 selection marked by asterisks:
39052 .itable none 0 0 3 2.8in left 10pt center 3in left
39053 .irow &`8bitmime`&                      &nbsp; "received 8BITMIME status"
39054 .irow &`acl_warn_skipped`&              *       "skipped &%warn%& statement in ACL"
39055 .irow &`address_rewrite`&               &nbsp; "address rewriting"
39056 .irow &`all_parents`&                   &nbsp; "all parents in => lines"
39057 .irow &`arguments`&                     &nbsp; "command line arguments"
39058 .irow &`connection_id`&                 &nbsp;  "connection identifier"
39059 .irow &`connection_reject`&             *       "connection rejections"
39060 .irow &`delay_delivery`&                *       "immediate delivery delayed"
39061 .irow &`deliver_time`&                  &nbsp; "time taken to attempt delivery"
39062 .irow &`delivery_size`&                 &nbsp; "add &`S=`&&'nnn'& to => lines"
39063 .irow &`dkim`&                          *       "DKIM verified domain on <= lines"
39064 .irow &`dkim_verbose`&                  &nbsp; "separate full DKIM verification result line, per signature; DKIM signing"
39065 .irow &`dnslist_defer`&                 *       "defers of DNS list (aka RBL) lookups"
39066 .irow &`dnssec`&                        &nbsp; "DNSSEC secured lookups"
39067 .irow &`etrn`&                          *       "ETRN commands"
39068 .irow &`host_lookup_failed`&            *       "as it says"
39069 .irow &`ident_timeout`&                 &nbsp; "timeout for ident connection"
39070 .irow &`incoming_interface`&            &nbsp; "local interface &amp; port on <= and => lines"
39071 .irow &`incoming_port`&                 &nbsp; "remote port on <= lines"
39072 .irow &`lost_incoming_connection`&      *       "as it says (includes timeouts)"
39073 .irow &`millisec`&                      &nbsp; "millisecond timestamps and RT,QT,DT,D times"
39074 .irow &`msg_id`&                        *       "on <= lines, Message-ID: header value"
39075 .irow &`msg_id_created`&                &nbsp; "on <= lines, Message-ID: header value when one had to be added"
39076 .irow &`outgoing_interface`&            &nbsp; "local interface on => lines"
39077 .irow &`outgoing_port`&                 &nbsp; "add remote port to => lines"
39078 .irow &`queue_run`&                     *       "start and end queue runs"
39079 .irow &`queue_time`&                    &nbsp; "time on queue for one recipient"
39080 .irow &`queue_time_exclusive`&          &nbsp; "exclude recieve time from QT times"
39081 .irow &`queue_time_overall`&            &nbsp; "time on queue for whole message"
39082 .irow &`pid`&                           &nbsp; "Exim process id"
39083 .irow &`pipelining`&                    &nbsp; "PIPELINING use, on <= and => lines"
39084 .irow &`proxy`&                         &nbsp; "proxy address on <= and => lines"
39085 .irow &`receive_time`&                  &nbsp; "time taken to receive message"
39086 .irow &`received_recipients`&           &nbsp; "recipients on <= lines"
39087 .irow &`received_sender`&               &nbsp; "sender on <= lines"
39088 .irow &`rejected_header`&               *       "header contents on reject log"
39089 .irow &`retry_defer`&                   *       "&<quote>&retry time not reached&</quote>&"
39090 .irow &`return_path_on_delivery`&       &nbsp; "put return path on => and ** lines"
39091 .irow &`sender_on_delivery`&            &nbsp; "add sender to => lines"
39092 .irow &`sender_verify_fail`&            *       "sender verification failures"
39093 .irow &`size_reject`&                   *       "rejection because too big"
39094 .irow &`skip_delivery`&                 *       "delivery skipped in a queue run"
39095 .irow &`smtp_confirmation`&             *       "SMTP confirmation on => lines"
39096 .irow &`smtp_connection`&               &nbsp; "incoming SMTP connections"
39097 .irow &`smtp_incomplete_transaction`&   &nbsp; "incomplete SMTP transactions"
39098 .irow &`smtp_mailauth`&                 &nbsp; "AUTH argument to MAIL commands"
39099 .irow &`smtp_no_mail`&                  &nbsp; "session with no MAIL commands"
39100 .irow &`smtp_protocol_error`&           &nbsp; "SMTP protocol errors"
39101 .irow &`smtp_syntax_error`&             &nbsp; "SMTP syntax errors"
39102 .irow &`subject`&                       &nbsp; "contents of &'Subject:'& on <= lines"
39103 .irow &`tls_certificate_verified`&      *       "certificate verification status"
39104 .irow &`tls_cipher`&                    *       "TLS cipher suite on <= and => lines"
39105 .irow &`tls_peerdn`&                    &nbsp; "TLS peer DN on <= and => lines"
39106 .irow &`tls_resumption`&                &nbsp; "append * to cipher field"
39107 .irow &`tls_sni`&                       &nbsp; "TLS SNI on <= lines"
39108 .irow &`unknown_in_list`&               &nbsp; "lookup failed in list match"
39109 .irow &`all`&                           &nbsp; "&*all of the above*&"
39110 .endtable
39111 See also the &%slow_lookup_log%& main configuration option,
39112 section &<<SECID99>>&
39113
39114 More details on each of these items follows:
39115
39116 .ilist
39117 .cindex "8BITMIME"
39118 .cindex "log" "8BITMIME"
39119 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
39120 which may help in tracking down interoperability issues with ancient MTAs
39121 that are not 8bit clean.  This is added to the &"<="& line, tagged with
39122 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
39123 &`7BIT`& and &`8BITMIME`& respectively.
39124 .next
39125 .cindex "&%warn%& ACL verb" "log when skipping"
39126 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
39127 its conditions cannot be evaluated, a log line to this effect is written if
39128 this log selector is set.
39129 .next
39130 .cindex "log" "rewriting"
39131 .cindex "rewriting" "logging"
39132 &%address_rewrite%&: This applies both to global rewrites and per-transport
39133 rewrites, but not to rewrites in filters run as an unprivileged user (because
39134 such users cannot access the log).
39135 .next
39136 .cindex "log" "full parentage"
39137 &%all_parents%&: Normally only the original and final addresses are logged on
39138 delivery lines; with this selector, intermediate parents are given in
39139 parentheses between them.
39140 .next
39141 .cindex "log" "Exim arguments"
39142 .cindex "Exim arguments, logging"
39143 &%arguments%&: This causes Exim to write the arguments with which it was called
39144 to the main log, preceded by the current working directory. This is a debugging
39145 feature, added to make it easier to find out how certain MUAs call
39146 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
39147 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
39148 that are empty or that contain white space are quoted. Non-printing characters
39149 are shown as escape sequences. This facility cannot log unrecognized arguments,
39150 because the arguments are checked before the configuration file is read. The
39151 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
39152 between the caller and Exim.
39153 .next
39154 .cindex "log" "connection identifier"
39155 &%connection_identifier%&: An identifier for the accepted connection is added to
39156 connection start and end lines and to message accept lines.
39157 The identifier is tagged by Ci=.
39158 The value is PID-based, so will reset on reboot and will wrap.
39159 .next
39160 .cindex "log" "connection rejections"
39161 &%connection_reject%&: A log entry is written whenever an incoming SMTP
39162 connection is rejected, for whatever reason.
39163 .next
39164 .cindex "log" "delayed delivery"
39165 .cindex "delayed delivery, logging"
39166 &%delay_delivery%&: A log entry is written whenever a delivery process is not
39167 started for an incoming message because the load is too high or too many
39168 messages were received on one connection. Logging does not occur if no delivery
39169 process is started because &%queue_only%& is set or &%-odq%& was used.
39170 .next
39171 .cindex "log" "delivery duration"
39172 &%deliver_time%&: For each delivery, the amount of real time it has taken to
39173 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
39174 If millisecond logging is enabled, short times will be shown with greater
39175 precision, eg. &`DT=0.304s`&.
39176 .next
39177 .cindex "log" "message size on delivery"
39178 .cindex "size" "of message"
39179 &%delivery_size%&: For each delivery, the size of message delivered is added to
39180 the &"=>"& line, tagged with S=.
39181 .next
39182 .cindex log "DKIM verification"
39183 .cindex DKIM "verification logging"
39184 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
39185 verifies successfully a tag of DKIM is added, with one of the verified domains.
39186 .next
39187 .cindex log "DKIM verification"
39188 .cindex DKIM "verification logging"
39189 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
39190 .new
39191 Also, on message delivery lines signing information (domain and selector)
39192 is added, tagged with DKIM=.
39193 .wen
39194 .next
39195 .cindex "log" "dnslist defer"
39196 .cindex "DNS list" "logging defer"
39197 .cindex "black list (DNS)"
39198 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
39199 DNS black list suffers a temporary error.
39200 .next
39201 .cindex log dnssec
39202 .cindex dnssec logging
39203 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
39204 dns lookups gave secure results a tag of DS is added.
39205 For acceptance this covers the reverse and forward lookups for host name verification.
39206 It does not cover helo-name verification.
39207 For delivery this covers the SRV, MX, A and/or AAAA lookups.
39208 .next
39209 .cindex "log" "ETRN commands"
39210 .cindex "ETRN" "logging"
39211 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
39212 is run to determine whether or not it is actually accepted. An invalid ETRN
39213 command, or one received within a message transaction is not logged by this
39214 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
39215 .next
39216 .cindex "log" "host lookup failure"
39217 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
39218 any addresses, or when a lookup of an IP address fails to find a host name, a
39219 log line is written. This logging does not apply to direct DNS lookups when
39220 routing email addresses, but it does apply to &"byname"& lookups.
39221 .next
39222 .cindex "log" "ident timeout"
39223 .cindex "RFC 1413" "logging timeout"
39224 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
39225 client's ident port times out.
39226 .next
39227 .cindex "log" "incoming interface"
39228 .cindex "log" "outgoing interface"
39229 .cindex "log" "local interface"
39230 .cindex "log" "local address and port"
39231 .cindex "TCP/IP" "logging local address and port"
39232 .cindex "interface" "logging"
39233 &%incoming_interface%&: The interface on which a message was received is added
39234 to the &"<="& line as an IP address in square brackets, tagged by I= and
39235 followed by a colon and the port number. The local interface and port are also
39236 added to other SMTP log lines, for example, &"SMTP connection from"&, to
39237 rejection lines, and (despite the name) to outgoing
39238 &"=>"&, &"->"&, &"=="& and &"**"& lines.
39239 The latter can be disabled by turning off the &%outgoing_interface%& option.
39240 .next
39241 .cindex log "incoming proxy address"
39242 .cindex proxy "logging proxy address"
39243 .cindex "TCP/IP" "logging proxy address"
39244 &%proxy%&: The internal (closest to the system running Exim) IP address
39245 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
39246 on a proxied connection
39247 or the &"=>"& line for a message delivered on a proxied connection.
39248 See &<<SECTproxyInbound>>& for more information.
39249 .next
39250 .cindex "log" "incoming remote port"
39251 .cindex "port" "logging remote"
39252 .cindex "TCP/IP" "logging incoming remote port"
39253 .vindex "&$sender_fullhost$&"
39254 .vindex "&$sender_rcvhost$&"
39255 &%incoming_port%&: The remote port number from which a message was received is
39256 added to log entries and &'Received:'& header lines, following the IP address
39257 in square brackets, and separated from it by a colon. This is implemented by
39258 changing the value that is put in the &$sender_fullhost$& and
39259 &$sender_rcvhost$& variables. Recording the remote port number has become more
39260 important with the widening use of NAT (see RFC 2505).
39261 .next
39262 .cindex "log" "dropped connection"
39263 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
39264 connection is unexpectedly dropped.
39265 .next
39266 .cindex "log" "millisecond timestamps"
39267 .cindex millisecond logging
39268 .cindex timestamps "millisecond, in logs"
39269 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
39270 appended to the seconds value.
39271 .next
39272 .cindex "log" "message id"
39273 &%msg_id%&: The value of the Message-ID: header.
39274 .next
39275 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
39276 This will be either because the message is a bounce, or was submitted locally
39277 (submission mode) without one.
39278 The field identifier will have an asterix appended: &"id*="&.
39279 .next
39280 .cindex "log" "outgoing interface"
39281 .cindex "log" "local interface"
39282 .cindex "log" "local address and port"
39283 .cindex "TCP/IP" "logging local address and port"
39284 .cindex "interface" "logging"
39285 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
39286 interface on which a message was sent is added to delivery lines as an I= tag
39287 followed by IP address in square brackets. You can disable this by turning
39288 off the &%outgoing_interface%& option.
39289 .next
39290 .cindex "log" "outgoing remote port"
39291 .cindex "port" "logging outgoing remote"
39292 .cindex "TCP/IP" "logging outgoing remote port"
39293 &%outgoing_port%&: The remote port number is added to delivery log lines (those
39294 containing => tags) following the IP address.
39295 The local port is also added if &%incoming_interface%& and
39296 &%outgoing_interface%& are both enabled.
39297 This option is not included in the default setting, because for most ordinary
39298 configurations, the remote port number is always 25 (the SMTP port), and the
39299 local port is a random ephemeral port.
39300 .next
39301 .cindex "log" "process ids in"
39302 .cindex "pid (process id)" "in log lines"
39303 &%pid%&: The current process id is added to every log line, in square brackets,
39304 immediately after the time and date.
39305 .next
39306 .cindex log pipelining
39307 .cindex pipelining "logging outgoing"
39308 &%pipelining%&: A field is added to delivery and accept
39309 log lines when the ESMTP PIPELINING extension was used.
39310 The field is a single "L".
39311
39312 On accept lines, where PIPELINING was offered but not used by the client,
39313 the field has a minus appended.
39314
39315 .cindex "pipelining" "early connection"
39316 If Exim is built without the DISABLE_PIPE_CONNECT build option
39317 accept "L" fields have a period appended if the feature was
39318 offered but not used, or an asterisk appended if used.
39319 Delivery "L" fields have an asterisk appended if used.
39320
39321 .next
39322 .cindex "log" "queue run"
39323 .cindex "queue runner" "logging"
39324 &%queue_run%&: The start and end of every queue run are logged.
39325 .next
39326 .cindex "log" "queue time"
39327 &%queue_time%&: The amount of time the message has been in the queue on the
39328 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
39329 &`QT=3m45s`&.
39330 If millisecond logging is enabled, short times will be shown with greater
39331 precision, eg. &`QT=1.578s`&.
39332 .next
39333 &%queue_time_overall%&: The amount of time the message has been in the queue on
39334 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
39335 example, &`QT=3m45s`&.
39336 .next
39337 .cindex "log" "receive duration"
39338 &%receive_time%&: For each message, the amount of real time it has taken to
39339 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
39340 If millisecond logging is enabled, short times will be shown with greater
39341 precision, eg. &`RT=0.204s`&.
39342 .next
39343 .cindex "log" "recipients"
39344 &%received_recipients%&: The recipients of a message are listed in the main log
39345 as soon as the message is received. The list appears at the end of the log line
39346 that is written when a message is received, preceded by the word &"for"&. The
39347 addresses are listed after they have been qualified, but before any rewriting
39348 has taken place.
39349 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
39350 in the list.
39351 .next
39352 .cindex "log" "sender reception"
39353 &%received_sender%&: The unrewritten original sender of a message is added to
39354 the end of the log line that records the message's arrival, after the word
39355 &"from"& (before the recipients if &%received_recipients%& is also set).
39356 .next
39357 .cindex "log" "header lines for rejection"
39358 &%rejected_header%&: If a message's header has been received at the time a
39359 rejection is written to the reject log, the complete header is added to the
39360 log. Header logging can be turned off individually for messages that are
39361 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
39362 .next
39363 .cindex "log" "retry defer"
39364 &%retry_defer%&: A log line is written if a delivery is deferred because a
39365 retry time has not yet been reached. However, this &"retry time not reached"&
39366 message is always omitted from individual message logs after the first delivery
39367 attempt.
39368 .next
39369 .cindex "log" "return path"
39370 &%return_path_on_delivery%&: The return path that is being transmitted with
39371 the message is included in delivery and bounce lines, using the tag P=.
39372 This is omitted if no delivery actually happens, for example, if routing fails,
39373 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39374 .next
39375 .cindex "log" "sender on delivery"
39376 &%sender_on_delivery%&: The message's sender address is added to every delivery
39377 and bounce line, tagged by F= (for &"from"&).
39378 This is the original sender that was received with the message; it is not
39379 necessarily the same as the outgoing return path.
39380 .next
39381 .cindex "log" "sender verify failure"
39382 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39383 gives details of a sender verification failure is not written. Log lines for
39384 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39385 detail is lost.
39386 .next
39387 .cindex "log" "size rejection"
39388 &%size_reject%&: A log line is written whenever a message is rejected because
39389 it is too big.
39390 .next
39391 .cindex "log" "frozen messages; skipped"
39392 .cindex "frozen messages" "logging skipping"
39393 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39394 queue run because it another process is already delivering it or because
39395 it is frozen.
39396 .cindex "&""spool file is locked""&"
39397 .cindex "&""message is frozen""&"
39398 The message that is written is either &"spool file is locked"& or
39399 &"message is frozen"&.
39400 .next
39401 .cindex "log" "smtp confirmation"
39402 .cindex "SMTP" "logging confirmation"
39403 .cindex "LMTP" "logging confirmation"
39404 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39405 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39406 A number of MTAs (including Exim) return an identifying string in this
39407 response.
39408 .next
39409 .cindex "log" "SMTP connections"
39410 .cindex "SMTP" "logging connections"
39411 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39412 established or closed, unless the connection is from a host that matches
39413 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39414 only when the closure is unexpected.) This applies to connections from local
39415 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39416 dropped in the middle of a message, a log line is always written, whether or
39417 not this selector is set, but otherwise nothing is written at the start and end
39418 of connections unless this selector is enabled.
39419
39420 For TCP/IP connections to an Exim daemon, the current number of connections is
39421 included in the log message for each new connection, but note that the count is
39422 reset if the daemon is restarted.
39423 Also, because connections are closed (and the closure is logged) in
39424 subprocesses, the count may not include connections that have been closed but
39425 whose termination the daemon has not yet noticed. Thus, while it is possible to
39426 match up the opening and closing of connections in the log, the value of the
39427 logged counts may not be entirely accurate.
39428 .next
39429 .cindex "log" "SMTP transaction; incomplete"
39430 .cindex "SMTP" "logging incomplete transactions"
39431 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39432 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39433 and the message sender plus any accepted recipients are included in the log
39434 line. This can provide evidence of dictionary attacks.
39435 .next
39436 .cindex "log" "non-MAIL SMTP sessions"
39437 .cindex "MAIL" "logging session without"
39438 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39439 connection terminates without having issued a MAIL command. This includes both
39440 the case when the connection is dropped, and the case when QUIT is used. It
39441 does not include cases where the connection is rejected right at the start (by
39442 an ACL, or because there are too many connections, or whatever). These cases
39443 already have their own log lines.
39444
39445 The log line that is written contains the identity of the client in the usual
39446 way, followed by D= and a time, which records the duration of the connection.
39447 If the connection was authenticated, this fact is logged exactly as it is for
39448 an incoming message, with an A= item. If the connection was encrypted, CV=,
39449 DN=, and X= items may appear as they do for an incoming message, controlled by
39450 the same logging options.
39451
39452 Finally, if any SMTP commands were issued during the connection, a C= item
39453 is added to the line, listing the commands that were used. For example,
39454 .code
39455 C=EHLO,QUIT
39456 .endd
39457 shows that the client issued QUIT straight after EHLO. If there were fewer
39458 than 20 commands, they are all listed. If there were more than 20 commands,
39459 the last 20 are listed, preceded by &"..."&. However, with the default
39460 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39461 have been aborted before 20 non-mail commands are processed.
39462 .next
39463 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39464 colon-separated, is appended to the A= item for a message arrival or delivery
39465 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39466 was accepted or used.
39467 .next
39468 .cindex "log" "SMTP protocol error"
39469 .cindex "SMTP" "logging protocol error"
39470 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39471 encountered. Exim does not have perfect detection of all protocol errors
39472 because of transmission delays and the use of pipelining. If PIPELINING has
39473 been advertised to a client, an Exim server assumes that the client will use
39474 it, and therefore it does not count &"expected"& errors (for example, RCPT
39475 received after rejecting MAIL) as protocol errors.
39476 .next
39477 .cindex "SMTP" "logging syntax errors"
39478 .cindex "SMTP" "syntax errors; logging"
39479 .cindex "SMTP" "unknown command; logging"
39480 .cindex "log" "unknown SMTP command"
39481 .cindex "log" "SMTP syntax error"
39482 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39483 encountered. An unrecognized command is treated as a syntax error. For an
39484 external connection, the host identity is given; for an internal connection
39485 using &%-bs%& the sender identification (normally the calling user) is given.
39486 .next
39487 .cindex "log" "subject"
39488 .cindex "subject, logging"
39489 &%subject%&: The subject of the message is added to the arrival log line,
39490 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39491 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39492 specifies whether characters with values greater than 127 should be logged
39493 unchanged, or whether they should be rendered as escape sequences.
39494 .next
39495 .cindex "log" "certificate verification"
39496 .cindex log DANE
39497 .cindex DANE logging
39498 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39499 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39500 verified
39501 using a CA trust anchor,
39502 &`CV=dane`& if using a DNS trust anchor,
39503 and &`CV=no`& if not.
39504 .next
39505 .cindex "log" "TLS cipher"
39506 .cindex "TLS" "logging cipher"
39507 &%tls_cipher%&: When a message is sent or received over an encrypted
39508 connection, the cipher suite used is added to the log line, preceded by X=.
39509 .next
39510 .cindex "log" "TLS peer DN"
39511 .cindex "TLS" "logging peer DN"
39512 &%tls_peerdn%&: When a message is sent or received over an encrypted
39513 connection, and a certificate is supplied by the remote host, the peer DN is
39514 added to the log line, preceded by DN=.
39515 .next
39516 .cindex "log" "TLS resumption"
39517 .cindex "TLS" "logging session resumption"
39518 &%tls_resumption%&: When a message is sent or received over an encrypted
39519 connection and the TLS session resumed one used on a previous TCP connection,
39520 an asterisk is appended to the X= cipher field in the log line.
39521 .next
39522 .cindex "log" "TLS SNI"
39523 .cindex "TLS" "logging SNI"
39524 .cindex SNI logging
39525 &%tls_sni%&: When a message is received over an encrypted connection, and
39526 the remote host provided the Server Name Indication extension, the SNI is
39527 added to the log line, preceded by SNI=.
39528 .next
39529 .cindex "log" "DNS failure in list"
39530 &%unknown_in_list%&: This setting causes a log entry to be written when the
39531 result of a list match is failure because a DNS lookup failed, or because
39532 a bad IP address was in the list.
39533 .endlist
39534
39535
39536 .section "Message log" "SECID260"
39537 .cindex "message" "log file for"
39538 .cindex "log" "message log; description of"
39539 .cindex "&_msglog_& directory"
39540 .oindex "&%preserve_message_logs%&"
39541 In addition to the general log files, Exim writes a log file for each message
39542 that it handles. The names of these per-message logs are the message ids, and
39543 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39544 message log contains copies of the log lines that apply to the message. This
39545 makes it easier to inspect the status of an individual message without having
39546 to search the main log. A message log is deleted when processing of the message
39547 is complete, unless &%preserve_message_logs%& is set, but this should be used
39548 only with great care because they can fill up your disk very quickly.
39549
39550 On a heavily loaded system, it may be desirable to disable the use of
39551 per-message logs, in order to reduce disk I/O. This can be done by setting the
39552 &%message_logs%& option false.
39553 .ecindex IIDloggen
39554
39555
39556
39557
39558 . ////////////////////////////////////////////////////////////////////////////
39559 . ////////////////////////////////////////////////////////////////////////////
39560
39561 .chapter "Exim utilities" "CHAPutils"
39562 .scindex IIDutils "utilities"
39563 A number of utility scripts and programs are supplied with Exim and are
39564 described in this chapter. There is also the Exim Monitor, which is covered in
39565 the next chapter. The utilities described here are:
39566
39567 .itable none 0 0 3  7* left  15* left  40* left
39568 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39569   "list what Exim processes are doing"
39570 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39571 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39572 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39573 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39574                                                 various criteria"
39575 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39576 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39577   "extract statistics from the log"
39578 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39579   "check address acceptance from given IP"
39580 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39581 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39582 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39583 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39584 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39585 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39586 .irow &<<SECTexim_msgdate>>&  &'exim_msgdate'&  "Message Ids for humans (exim_msgdate)"
39587 .endtable
39588
39589 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39590 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39591 &url(https://duncanthrax.net/exilog/) for details.
39592
39593
39594
39595
39596 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39597 .cindex "&'exiwhat'&"
39598 .cindex "process, querying"
39599 .cindex "SIGUSR1"
39600 On operating systems that can restart a system call after receiving a signal
39601 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39602 a line describing what it is doing to the file &_exim-process.info_& in the
39603 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39604 processes it can find, having first emptied the file. It then waits for one
39605 second to allow the Exim processes to react before displaying the results. In
39606 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39607 send the signal to the Exim processes, so it is normally run as root.
39608
39609 &*Warning*&: This is not an efficient process. It is intended for occasional
39610 use by system administrators. It is not sensible, for example, to set up a
39611 script that sends SIGUSR1 signals to Exim processes at short intervals.
39612
39613
39614 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39615 varies in different operating systems. Not only are different options used,
39616 but the format of the output is different. For this reason, there are some
39617 system configuration options that configure exactly how &'exiwhat'& works. If
39618 it doesn't seem to be working for you, check the following compile-time
39619 options:
39620 .itable none 0 0 2 30* left 70* left
39621 .irow &`EXIWHAT_PS_CMD`&        "the command for running &'ps'&"
39622 .irow &`EXIWHAT_PS_ARG`&        "the argument for &'ps'&"
39623 .irow &`EXIWHAT_EGREP_ARG`&     "the argument for &'egrep'& to select from &'ps'& output"
39624 .irow &`EXIWHAT_KILL_ARG`&      "the argument for the &'kill'& command"
39625 .endtable
39626 An example of typical output from &'exiwhat'& is
39627 .code
39628 164 daemon: -q1h, listening on port 25
39629 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39630 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39631   [10.19.42.42] (editor@ref.example)
39632 10592 handling incoming call from [192.168.243.242]
39633 10628 accepting a local non-SMTP message
39634 .endd
39635 The first number in the output line is the process number. The third line has
39636 been split here, in order to fit it on the page.
39637
39638
39639
39640 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39641 .cindex "&'exiqgrep'&"
39642 .cindex "queue" "grepping"
39643 This utility is a Perl script contributed by Matt Hubbard. It runs
39644 .code
39645 exim -bpu
39646 .endd
39647 or (in case &*-a*& switch is specified)
39648 .code
39649 exim -bp
39650 .endd
39651 to obtain a queue listing, and then greps the output to select messages
39652 that match given criteria. The following selection options are available:
39653
39654 .vlist
39655 .vitem &*-f*&&~<&'regex'&>
39656 Match the sender address using a case-insensitive search. The field that is
39657 tested is enclosed in angle brackets, so you can test for bounce messages with
39658 .code
39659 exiqgrep -f '^<>$'
39660 .endd
39661 .vitem &*-r*&&~<&'regex'&>
39662 Match a recipient address using a case-insensitive search. The field that is
39663 tested is not enclosed in angle brackets.
39664
39665 .vitem &*-s*&&~<&'regex'&>
39666 Match against the size field.
39667
39668 .vitem &*-y*&&~<&'seconds'&>
39669 Match messages that are younger than the given time.
39670
39671 .vitem &*-o*&&~<&'seconds'&>
39672 Match messages that are older than the given time.
39673
39674 .vitem &*-z*&
39675 Match only frozen messages.
39676
39677 .vitem &*-x*&
39678 Match only non-frozen messages.
39679
39680 .vitem &*-G*&&~<&'queuename'&>
39681 Match only messages in the given queue.  Without this, the default queue is searched.
39682 .endlist
39683
39684 The following options control the format of the output:
39685
39686 .vlist
39687 .vitem &*-c*&
39688 Display only the count of matching messages.
39689
39690 .vitem &*-l*&
39691 Long format &-- display the full message information as output by Exim. This is
39692 the default.
39693
39694 .vitem &*-i*&
39695 Display message ids only.
39696
39697 .vitem &*-b*&
39698 Brief format &-- one line per message.
39699
39700 .vitem &*-R*&
39701 Display messages in reverse order.
39702
39703 .vitem &*-a*&
39704 Include delivered recipients in queue listing.
39705 .endlist
39706
39707 The following options give alternates for configuration:
39708
39709 .vlist
39710 .vitem &*-C*&&~<&'config&~file'&>
39711 is used to specify an alternate &_exim.conf_& which might
39712 contain alternate exim configuration the queue management might be using.
39713
39714 .vitem &*-E*&&~<&'path'&>
39715 can be used to specify a path for the exim binary,
39716 overriding the built-in one.
39717 .endlist
39718
39719 There is one more option, &%-h%&, which outputs a list of options.
39720 At least one selection option, or either the &*-c*& or &*-h*& option, must be given.
39721
39722
39723
39724 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39725 .cindex "&'exiqsumm'&"
39726 .cindex "queue" "summary"
39727 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39728 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39729 running a command such as
39730 .code
39731 exim -bp | exiqsumm
39732 .endd
39733 The output consists of one line for each domain that has messages waiting for
39734 it, as in the following example:
39735 .code
39736 3   2322   74m   66m  msn.com.example
39737 .endd
39738 Each line lists the number of pending deliveries for a domain, their total
39739 volume, and the length of time that the oldest and the newest messages have
39740 been waiting. Note that the number of pending deliveries is greater than the
39741 number of messages when messages have more than one recipient.
39742
39743 A summary line is output at the end. By default the output is sorted on the
39744 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39745 the output to be sorted by oldest message and by count of messages,
39746 respectively. There are also three options that split the messages for each
39747 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39748 separates frozen messages, and &%-s%& separates messages according to their
39749 sender.
39750
39751 The output of &'exim -bp'& contains the original addresses in the message, so
39752 this also applies to the output from &'exiqsumm'&. No domains from addresses
39753 generated by aliasing or forwarding are included (unless the &%one_time%&
39754 option of the &(redirect)& router has been used to convert them into &"top
39755 level"& addresses).
39756
39757
39758
39759
39760 .section "Extracting specific information from the log (exigrep)" &&&
39761          "SECTextspeinf"
39762 .cindex "&'exigrep'&"
39763 .cindex "log" "extracts; grepping for"
39764 The &'exigrep'& utility is a Perl script that searches one or more main log
39765 files for entries that match a given pattern. When it finds a match, it
39766 extracts all the log entries for the relevant message, not just those that
39767 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39768 given message, or all mail for a given user, or for a given host, for example.
39769 The input files can be in Exim log format or syslog format.
39770 If a matching log line is not associated with a specific message, it is
39771 included in &'exigrep'&'s output without any additional lines. The usage is:
39772 .display
39773 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39774 .endd
39775 If no log filenames are given on the command line, the standard input is read.
39776
39777 The &%-t%& argument specifies a number of seconds. It adds an additional
39778 condition for message selection. Messages that are complete are shown only if
39779 they spent more than <&'n'&> seconds in the queue.
39780
39781 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39782 makes it case-sensitive. This may give a performance improvement when searching
39783 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39784 option; with &%-I%& they do not. In both cases it is possible to change the
39785 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39786
39787 The &%-l%& option means &"literal"&, that is, treat all characters in the
39788 pattern as standing for themselves. Otherwise the pattern must be a Perl
39789 regular expression.
39790
39791 The &%-v%& option inverts the matching condition. That is, a line is selected
39792 if it does &'not'& match the pattern.
39793
39794 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39795 that are generated as a result/response to a message that &'exigrep'& matched
39796 normally.
39797
39798 Example of &%-M%&:
39799 user_a sends a message to user_b, which generates a bounce back to user_b. If
39800 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39801 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39802 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39803 when searching for &"user_a"& will show both messages since the bounce is
39804 &"related"& to or a &"result"& of the first message that was found by the
39805 search term.
39806
39807 If the location of a &'zcat'& command is known from the definition of
39808 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39809 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39810 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39811 autodetection of some well known compression extensions.
39812
39813
39814 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39815 .cindex "&'exipick'&"
39816 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39817 lists messages from the queue according to a variety of criteria. For details
39818 of &'exipick'&'s facilities, run &'exipick'& with
39819 the &%--help%& option.
39820
39821
39822 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39823 .cindex "log" "cycling local files"
39824 .cindex "cycling logs"
39825 .cindex "&'exicyclog'&"
39826 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39827 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39828 you are using log files with datestamps in their names (see section
39829 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39830 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39831 There are two command line options for &'exicyclog'&:
39832 .ilist
39833 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39834 default that is set when Exim is built. The default default is 10.
39835 .next
39836 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39837 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39838 overriding the script's default, which is to find the setting from Exim's
39839 configuration.
39840 .endlist
39841
39842 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39843 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39844 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39845 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39846 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39847 logs are handled similarly.
39848
39849 If the limit is greater than 99, the script uses 3-digit numbers such as
39850 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39851 to one that is greater, or &'vice versa'&, you will have to fix the names of
39852 any existing log files.
39853
39854 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39855 the end are deleted. All files with numbers greater than 01 are compressed,
39856 using a compression command which is configured by the COMPRESS_COMMAND
39857 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39858 root &%crontab%& entry of the form
39859 .code
39860 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39861 .endd
39862 assuming you have used the name &"exim"& for the Exim user. You can run
39863 &'exicyclog'& as root if you wish, but there is no need.
39864
39865
39866
39867 .section "Mail statistics (eximstats)" "SECTmailstat"
39868 .cindex "statistics"
39869 .cindex "&'eximstats'&"
39870 A Perl script called &'eximstats'& is provided for extracting statistical
39871 information from log files. The output is either plain text, or HTML.
39872 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39873 . --- 404 error and everything else points to that.
39874
39875 The &'eximstats'& script has been hacked about quite a bit over time. The
39876 latest version is the result of some extensive revision by Steve Campbell. A
39877 lot of information is given by default, but there are options for suppressing
39878 various parts of it. Following any options, the arguments to the script are a
39879 list of files, which should be main log files. For example:
39880 .code
39881 eximstats -nr /var/spool/exim/log/mainlog.01
39882 .endd
39883 By default, &'eximstats'& extracts information about the number and volume of
39884 messages received from or delivered to various hosts. The information is sorted
39885 both by message count and by volume, and the top fifty hosts in each category
39886 are listed on the standard output. Similar information, based on email
39887 addresses or domains instead of hosts can be requested by means of various
39888 options. For messages delivered and received locally, similar statistics are
39889 also produced per user.
39890
39891 The output also includes total counts and statistics about delivery errors, and
39892 histograms showing the number of messages received and deliveries made in each
39893 hour of the day. A delivery with more than one address in its envelope (for
39894 example, an SMTP transaction with more than one RCPT command) is counted
39895 as a single delivery by &'eximstats'&.
39896
39897 Though normally more deliveries than receipts are reported (as messages may
39898 have multiple recipients), it is possible for &'eximstats'& to report more
39899 messages received than delivered, even though the queue is empty at the start
39900 and end of the period in question. If an incoming message contains no valid
39901 recipients, no deliveries are recorded for it. A bounce message is handled as
39902 an entirely separate message.
39903
39904 &'eximstats'& always outputs a grand total summary giving the volume and number
39905 of messages received and deliveries made, and the number of hosts involved in
39906 each case. It also outputs the number of messages that were delayed (that is,
39907 not completely delivered at the first attempt), and the number that had at
39908 least one address that failed.
39909
39910 The remainder of the output is in sections that can be independently disabled
39911 or modified by various options. It consists of a summary of deliveries by
39912 transport, histograms of messages received and delivered per time interval
39913 (default per hour), information about the time messages spent in the queue,
39914 a list of relayed messages, lists of the top fifty sending hosts, local
39915 senders, destination hosts, and destination local users by count and by volume,
39916 and a list of delivery errors that occurred.
39917
39918 The relay information lists messages that were actually relayed, that is, they
39919 came from a remote host and were directly delivered to some other remote host,
39920 without being processed (for example, for aliasing or forwarding) locally.
39921
39922 There are quite a few options for &'eximstats'& to control exactly what it
39923 outputs. These are documented in the Perl script itself, and can be extracted
39924 by running the command &(perldoc)& on the script. For example:
39925 .code
39926 perldoc /usr/exim/bin/eximstats
39927 .endd
39928
39929 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39930 .cindex "&'exim_checkaccess'&"
39931 .cindex "policy control" "checking access"
39932 .cindex "checking access"
39933 The &%-bh%& command line argument allows you to run a fake SMTP session with
39934 debugging output, in order to check what Exim is doing when it is applying
39935 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39936 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39937 sometimes you just want to answer the question &"Does this address have
39938 access?"& without bothering with any further details.
39939
39940 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39941 two arguments, an IP address and an email address:
39942 .code
39943 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39944 .endd
39945 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39946 given email address would be accepted in a RCPT command in a TCP/IP
39947 connection from the host with the given IP address. The output of the utility
39948 is either the word &"accepted"&, or the SMTP error response, for example:
39949 .code
39950 Rejected:
39951 550 Relay not permitted
39952 .endd
39953 When running this test, the utility uses &`<>`& as the envelope sender address
39954 for the MAIL command, but you can change this by providing additional
39955 options. These are passed directly to the Exim command. For example, to specify
39956 that the test is to be run with the sender address &'himself@there.example'&
39957 you can use:
39958 .code
39959 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39960                  -f himself@there.example
39961 .endd
39962 Note that these additional Exim command line items must be given after the two
39963 mandatory arguments.
39964
39965 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39966 while running its checks. You can run checks that include callouts by using
39967 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39968
39969
39970
39971 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39972 .cindex "DBM" "building dbm files"
39973 .cindex "building DBM files"
39974 .cindex "&'exim_dbmbuild'&"
39975 .cindex "lower casing"
39976 .cindex "binary zero" "in lookup key"
39977 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39978 the format used by the &(lsearch)& lookup (see section
39979 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39980 names as keys and the remainder of the information as data. The lower-casing
39981 can be prevented by calling the program with the &%-nolc%& option.
39982
39983 A terminating zero is included as part of the key string. This is expected by
39984 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39985 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39986 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39987 files.
39988
39989 The program requires two arguments: the name of the input file (which can be a
39990 single hyphen to indicate the standard input), and the name of the output file.
39991 It creates the output under a temporary name, and then renames it if all went
39992 well.
39993
39994 .cindex "USE_DB"
39995 If the native DB interface is in use (USE_DB is set in a compile-time
39996 configuration file &-- this is common in free versions of Unix) the two
39997 filenames must be different, because in this mode the Berkeley DB functions
39998 create a single output file using exactly the name given. For example,
39999 .code
40000 exim_dbmbuild /etc/aliases /etc/aliases.db
40001 .endd
40002 reads the system alias file and creates a DBM version of it in
40003 &_/etc/aliases.db_&.
40004
40005 In systems that use the &'ndbm'& routines (mostly proprietary versions of
40006 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
40007 environment, the suffixes are added to the second argument of
40008 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
40009 when the Berkeley functions are used in compatibility mode (though this is not
40010 recommended), because in that case it adds a &_.db_& suffix to the filename.
40011
40012 If a duplicate key is encountered, the program outputs a warning, and when it
40013 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
40014 option is used. By default, only the first of a set of duplicates is used &--
40015 this makes it compatible with &(lsearch)& lookups. There is an option
40016 &%-lastdup%& which causes it to use the data for the last duplicate instead.
40017 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
40018 &%stderr%&. For other errors, where it doesn't actually make a new file, the
40019 return code is 2.
40020
40021
40022
40023
40024 .section "Finding individual retry times (exinext)" "SECTfinindret"
40025 .cindex "retry" "times"
40026 .cindex "&'exinext'&"
40027 A utility called &'exinext'& (mostly a Perl script) provides the ability to
40028 fish specific information out of the retry database. Given a mail domain (or a
40029 complete address), it looks up the hosts for that domain, and outputs any retry
40030 information for the hosts or for the domain. At present, the retry information
40031 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
40032 output. For example:
40033 .code
40034 $ exinext piglet@milne.fict.example
40035 kanga.milne.example:192.168.8.1 error 146: Connection refused
40036   first failed: 21-Feb-1996 14:57:34
40037   last tried:   21-Feb-1996 14:57:34
40038   next try at:  21-Feb-1996 15:02:34
40039 roo.milne.example:192.168.8.3 error 146: Connection refused
40040   first failed: 20-Jan-1996 13:12:08
40041   last tried:   21-Feb-1996 11:42:03
40042   next try at:  21-Feb-1996 19:42:03
40043   past final cutoff time
40044 .endd
40045 You can also give &'exinext'& a local part, without a domain, and it
40046 will give any retry information for that local part in your default domain.
40047 A message id can be used to obtain retry information pertaining to a specific
40048 message. This exists only when an attempt to deliver a message to a remote host
40049 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
40050 &'exinext'& is not particularly efficient, but then it is not expected to be
40051 run very often.
40052
40053 The &'exinext'& utility calls Exim to find out information such as the location
40054 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
40055 passed on to the &'exim'& commands. The first specifies an alternate Exim
40056 configuration file, and the second sets macros for use within the configuration
40057 file. These features are mainly to help in testing, but might also be useful in
40058 environments where more than one configuration file is in use.
40059
40060
40061
40062 .section "Hints database maintenance" "SECThindatmai"
40063 .cindex "hints database" "maintenance"
40064 .cindex "maintaining Exim's hints database"
40065 Three utility programs are provided for maintaining the DBM files that Exim
40066 uses to contain its delivery hint information. Each program requires two
40067 arguments. The first specifies the name of Exim's spool directory, and the
40068 second is the name of the database it is to operate on. These are as follows:
40069
40070 .ilist
40071 &'retry'&: the database of retry information
40072 .next
40073 &'wait-'&<&'transport name'&>: databases of information about messages waiting
40074 for remote hosts
40075 .next
40076 &'callout'&: the callout cache
40077 .next
40078 &'ratelimit'&: the data for implementing the ratelimit ACL condition
40079 .next
40080 &'tls'&: TLS session resumption data
40081 .next
40082 &'misc'&: other hints data
40083 .endlist
40084
40085 The &'misc'& database is used for
40086
40087 .ilist
40088 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
40089 .next
40090 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
40091 &(smtp)& transport)
40092 .next
40093 Limiting the concurrency of specific transports (when &%max_parallel%& is set
40094 in a transport)
40095 .next
40096 Recording EHLO-time facilities advertised by hosts
40097 .endlist
40098
40099
40100
40101 .section "exim_dumpdb" "SECTdumpdb"
40102 .cindex "&'exim_dumpdb'&"
40103 The entire contents of a database are written to the standard output by the
40104 &'exim_dumpdb'& program,
40105 taking as arguments the spool and database names.
40106 An option &'-z'& may be given to request times in UTC;
40107 otherwise times are in the local timezone.
40108 An option &'-k'& may be given to dump only the record keys.
40109 For example, to dump the retry database:
40110 .code
40111 exim_dumpdb /var/spool/exim retry
40112 .endd
40113 For the retry database
40114 two lines of output are produced for each entry:
40115 .code
40116 T:mail.ref.example:192.168.242.242 146 77 Connection refused
40117 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
40118 .endd
40119 The first item on the first line is the key of the record. It starts with one
40120 of the letters R, or T, depending on whether it refers to a routing or
40121 transport retry. For a local delivery, the next part is the local address; for
40122 a remote delivery it is the name of the remote host, followed by its failing IP
40123 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
40124 transport). If the remote port is not the standard one (port 25), it is added
40125 to the IP address. Then there follows an error code, an additional error code,
40126 and a textual description of the error.
40127
40128 The three times on the second line are the time of first failure, the time of
40129 the last delivery attempt, and the computed time for the next attempt. The line
40130 ends with an asterisk if the cutoff time for the last retry rule has been
40131 exceeded.
40132
40133 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
40134 consists of a host name followed by a list of ids for messages that are or were
40135 waiting to be delivered to that host. If there are a very large number for any
40136 one host, continuation records, with a sequence number added to the host name,
40137 may be seen. The data in these records is often out of date, because a message
40138 may be routed to several alternative hosts, and Exim makes no effort to keep
40139 cross-references.
40140
40141
40142
40143 .section "exim_tidydb" "SECTtidydb"
40144 .cindex "&'exim_tidydb'&"
40145 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
40146 database. If run with no options, it removes all records that are more than 30
40147 days old. The age is calculated from the date and time that the record was last
40148 updated. Note that, in the case of the retry database, it is &'not'& the time
40149 since the first delivery failure. Information about a host that has been down
40150 for more than 30 days will remain in the database, provided that the record is
40151 updated sufficiently often.
40152
40153 The cutoff date can be altered by means of the &%-t%& option, which must be
40154 followed by a time. For example, to remove all records older than a week from
40155 the retry database:
40156 .code
40157 exim_tidydb -t 7d /var/spool/exim retry
40158 .endd
40159 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
40160 message ids. In the former these appear as data in records keyed by host &--
40161 they were messages that were waiting for that host &-- and in the latter they
40162 are the keys for retry information for messages that have suffered certain
40163 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
40164 message ids in database records are those of messages that are still on the
40165 queue. Message ids for messages that no longer exist are removed from
40166 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
40167 For the &'retry'& database, records whose keys are non-existent message ids are
40168 removed. The &'exim_tidydb'& utility outputs comments on the standard output
40169 whenever it removes information from the database.
40170
40171 Certain records are automatically removed by Exim when they are no longer
40172 needed, but others are not. For example, if all the MX hosts for a domain are
40173 down, a retry record is created for each one. If the primary MX host comes back
40174 first, its record is removed when Exim successfully delivers to it, but the
40175 records for the others remain because Exim has not tried to use those hosts.
40176
40177 It is important, therefore, to run &'exim_tidydb'& periodically on all the
40178 hints databases. You should do this at a quiet time of day, because it requires
40179 a database to be locked (and therefore inaccessible to Exim) while it does its
40180 work. Removing records from a DBM file does not normally make the file smaller,
40181 but all the common DBM libraries are able to re-use the space that is released.
40182 After an initial phase of increasing in size, the databases normally reach a
40183 point at which they no longer get any bigger, as long as they are regularly
40184 tidied.
40185
40186 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
40187 databases is likely to keep on increasing.
40188
40189
40190
40191
40192 .section "exim_fixdb" "SECTfixdb"
40193 .cindex "&'exim_fixdb'&"
40194 The &'exim_fixdb'& program is a utility for interactively modifying databases.
40195 Its main use is for testing Exim, but it might also be occasionally useful for
40196 getting round problems in a live system. Its interface
40197 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
40198 key of a database record can then be entered, and the data for that record is
40199 displayed.
40200
40201 If &"d"& is typed at the next prompt, the entire record is deleted. For all
40202 except the &'retry'& database, that is the only operation that can be carried
40203 out. For the &'retry'& database, each field is output preceded by a number, and
40204 data for individual fields can be changed by typing the field number followed
40205 by new data, for example:
40206 .code
40207 > 4 951102:1000
40208 .endd
40209 resets the time of the next delivery attempt. Time values are given as a
40210 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
40211 used as optional separators.
40212
40213 Both displayed and input times are in the local timezone by default.
40214 If an option &'-z'& is used on the command line, displayed times
40215 are in UTC.
40216
40217
40218
40219
40220 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
40221 .cindex "mailbox" "maintenance"
40222 .cindex "&'exim_lock'&"
40223 .cindex "locking mailboxes"
40224 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
40225 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
40226 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
40227 a user agent while investigating a problem. The utility requires the name of
40228 the file as its first argument. If the locking is successful, the second
40229 argument is run as a command (using C's &[system()]& function); if there is no
40230 second argument, the value of the SHELL environment variable is used; if this
40231 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
40232 is unlocked and the utility ends. The following options are available:
40233
40234 .vlist
40235 .vitem &%-fcntl%&
40236 Use &[fcntl()]& locking on the open mailbox.
40237
40238 .vitem &%-flock%&
40239 Use &[flock()]& locking on the open mailbox, provided the operating system
40240 supports it.
40241
40242 .vitem &%-interval%&
40243 This must be followed by a number, which is a number of seconds; it sets the
40244 interval to sleep between retries (default 3).
40245
40246 .vitem &%-lockfile%&
40247 Create a lock file before opening the mailbox.
40248
40249 .vitem &%-mbx%&
40250 Lock the mailbox using MBX rules.
40251
40252 .vitem &%-q%&
40253 Suppress verification output.
40254
40255 .vitem &%-retries%&
40256 This must be followed by a number; it sets the number of times to try to get
40257 the lock (default 10).
40258
40259 .vitem &%-restore_time%&
40260 This option causes &%exim_lock%& to restore the modified and read times to the
40261 locked file before exiting. This allows you to access a locked mailbox (for
40262 example, to take a backup copy) without disturbing the times that the user
40263 subsequently sees.
40264
40265 .vitem &%-timeout%&
40266 This must be followed by a number, which is a number of seconds; it sets a
40267 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
40268 default), a non-blocking call is used.
40269
40270 .vitem &%-v%&
40271 Generate verbose output.
40272 .endlist
40273
40274 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
40275 default is to create a lock file and also to use &[fcntl()]& locking on the
40276 mailbox, which is the same as Exim's default. The use of &%-flock%& or
40277 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
40278 requires that the directory containing the file be writeable. Locking by lock
40279 file does not last forever; Exim assumes that a lock file is expired if it is
40280 more than 30 minutes old.
40281
40282 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
40283 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
40284 to be taken out on the open mailbox, and an exclusive lock on the file
40285 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
40286 number of the mailbox file. When the locking is released, if an exclusive lock
40287 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
40288
40289 The default output contains verification of the locking that takes place. The
40290 &%-v%& option causes some additional information to be given. The &%-q%& option
40291 suppresses all output except error messages.
40292
40293 A command such as
40294 .code
40295 exim_lock /var/spool/mail/spqr
40296 .endd
40297 runs an interactive shell while the file is locked, whereas
40298 .display
40299 &`exim_lock -q /var/spool/mail/spqr <<End`&
40300 <&'some commands'&>
40301 &`End`&
40302 .endd
40303 runs a specific non-interactive sequence of commands while the file is locked,
40304 suppressing all verification output. A single command can be run by a command
40305 such as
40306 .code
40307 exim_lock -q /var/spool/mail/spqr \
40308   "cp /var/spool/mail/spqr /some/where"
40309 .endd
40310 Note that if a command is supplied, it must be entirely contained within the
40311 second argument &-- hence the quotes.
40312
40313
40314 .section "Message Ids for humans (exim_msgdate)" "SECTexim_msgdate"
40315 .cindex "exim_msgdate"
40316 The &'exim_msgdate'& utility is written by Andrew Aitchison and included in the Exim distribution.
40317 This Perl script converts an Exim Mesage ID back into a human readable form.
40318 For details of &'exim_msgdate'&'s options, run &'exim_msgdate'& with the &%--help%& option.
40319
40320 Section &<<SECTmessiden>>& (Message identification) describes Exim Mesage IDs.
40321 .ecindex IIDutils
40322 . ////////////////////////////////////////////////////////////////////////////
40323 . ////////////////////////////////////////////////////////////////////////////
40324
40325 .chapter "The Exim monitor" "CHAPeximon"
40326 .scindex IIDeximon "Exim monitor" "description"
40327 .cindex "X-windows"
40328 .cindex "&'eximon'&"
40329 .cindex "Local/eximon.conf"
40330 .cindex "&_exim_monitor/EDITME_&"
40331 The Exim monitor is an application which displays in an X window information
40332 about the state of Exim's queue and what Exim is doing. An admin user can
40333 perform certain operations on messages from this GUI interface; however all
40334 such facilities are also available from the command line, and indeed, the
40335 monitor itself makes use of the command line to perform any actions requested.
40336
40337
40338
40339 .section "Running the monitor" "SECID264"
40340 The monitor is started by running the script called &'eximon'&. This is a shell
40341 script that sets up a number of environment variables, and then runs the
40342 binary called &_eximon.bin_&. The default appearance of the monitor window can
40343 be changed by editing the &_Local/eximon.conf_& file created by editing
40344 &_exim_monitor/EDITME_&. Comments in that file describe what the various
40345 parameters are for.
40346
40347 The parameters that get built into the &'eximon'& script can be overridden for
40348 a particular invocation by setting up environment variables of the same names,
40349 preceded by &`EXIMON_`&. For example, a shell command such as
40350 .code
40351 EXIMON_LOG_DEPTH=400 eximon
40352 .endd
40353 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
40354 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
40355 overrides the Exim log file configuration. This makes it possible to have
40356 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
40357 syslog messages are routed to a file on the local host.
40358
40359 X resources can be used to change the appearance of the window in the normal
40360 way. For example, a resource setting of the form
40361 .code
40362 Eximon*background: gray94
40363 .endd
40364 changes the colour of the background to light grey rather than white. The
40365 stripcharts are drawn with both the data lines and the reference lines in
40366 black. This means that the reference lines are not visible when on top of the
40367 data. However, their colour can be changed by setting a resource called
40368 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
40369 For example, if your X server is running Unix, you could set up lighter
40370 reference lines in the stripcharts by obeying
40371 .code
40372 xrdb -merge <<End
40373 Eximon*highlight: gray
40374 End
40375 .endd
40376 .cindex "admin user"
40377 In order to see the contents of messages in the queue, and to operate on them,
40378 &'eximon'& must either be run as root or by an admin user.
40379
40380 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
40381 contain X11 resource parameters interpreted by the X11 library.  In addition,
40382 if the first parameter starts with the string "gdb" then it is removed and the
40383 binary is invoked under gdb (the parameter is used as the gdb command-name, so
40384 versioned variants of gdb can be invoked).
40385
40386 The monitor's window is divided into three parts. The first contains one or
40387 more stripcharts and two action buttons, the second contains a &"tail"& of the
40388 main log file, and the third is a display of the queue of messages awaiting
40389 delivery, with two more action buttons. The following sections describe these
40390 different parts of the display.
40391
40392
40393
40394
40395 .section "The stripcharts" "SECID265"
40396 .cindex "stripchart"
40397 The first stripchart is always a count of messages in the queue. Its name can
40398 be configured by setting QUEUE_STRIPCHART_NAME in the
40399 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40400 configuration script by regular expression matches on log file entries, making
40401 it possible to display, for example, counts of messages delivered to certain
40402 hosts or using certain transports. The supplied defaults display counts of
40403 received and delivered messages, and of local and SMTP deliveries. The default
40404 period between stripchart updates is one minute; this can be adjusted by a
40405 parameter in the &_Local/eximon.conf_& file.
40406
40407 The stripchart displays rescale themselves automatically as the value they are
40408 displaying changes. There are always 10 horizontal lines in each chart; the
40409 title string indicates the value of each division when it is greater than one.
40410 For example, &"x2"& means that each division represents a value of 2.
40411
40412 It is also possible to have a stripchart which shows the percentage fullness of
40413 a particular disk partition, which is useful when local deliveries are confined
40414 to a single partition.
40415
40416 .cindex "&%statvfs%& function"
40417 This relies on the availability of the &[statvfs()]& function or equivalent in
40418 the operating system. Most, but not all versions of Unix that support Exim have
40419 this. For this particular stripchart, the top of the chart always represents
40420 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40421 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40422 &_Local/eximon.conf_& file.
40423
40424
40425
40426
40427 .section "Main action buttons" "SECID266"
40428 .cindex "size" "of monitor window"
40429 .cindex "Exim monitor" "window size"
40430 .cindex "window size"
40431 Below the stripcharts there is an action button for quitting the monitor. Next
40432 to this is another button marked &"Size"&. They are placed here so that
40433 shrinking the window to its default minimum size leaves just the queue count
40434 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40435 the window to expand to its maximum size, unless it is already at the maximum,
40436 in which case it is reduced to its minimum.
40437
40438 When expanding to the maximum, if the window cannot be fully seen where it
40439 currently is, it is moved back to where it was the last time it was at full
40440 size. When it is expanding from its minimum size, the old position is
40441 remembered, and next time it is reduced to the minimum it is moved back there.
40442
40443 The idea is that you can keep a reduced window just showing one or two
40444 stripcharts at a convenient place on your screen, easily expand it to show
40445 the full window when required, and just as easily put it back to what it was.
40446 The idea is copied from what the &'twm'& window manager does for its
40447 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40448 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40449
40450 Normally, the monitor starts up with the window at its full size, but it can be
40451 built so that it starts up with the window at its smallest size, by setting
40452 START_SMALL=yes in &_Local/eximon.conf_&.
40453
40454
40455
40456 .section "The log display" "SECID267"
40457 .cindex "log" "tail of; in monitor"
40458 The second section of the window is an area in which a display of the tail of
40459 the main log is maintained.
40460 To save space on the screen, the timestamp on each log line is shortened by
40461 removing the date and, if &%log_timezone%& is set, the timezone.
40462 The log tail is not available when the only destination for logging data is
40463 syslog, unless the syslog lines are routed to a local file whose name is passed
40464 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40465
40466 The log sub-window has a scroll bar at its lefthand side which can be used to
40467 move back to look at earlier text, and the up and down arrow keys also have a
40468 scrolling effect. The amount of log that is kept depends on the setting of
40469 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40470 to use. When this is full, the earlier 50% of data is discarded &-- this is
40471 much more efficient than throwing it away line by line. The sub-window also has
40472 a horizontal scroll bar for accessing the ends of long log lines. This is the
40473 only means of horizontal scrolling; the right and left arrow keys are not
40474 available. Text can be cut from this part of the window using the mouse in the
40475 normal way. The size of this subwindow is controlled by parameters in the
40476 configuration file &_Local/eximon.conf_&.
40477
40478 Searches of the text in the log window can be carried out by means of the ^R
40479 and ^S keystrokes, which default to a reverse and a forward search,
40480 respectively. The search covers only the text that is displayed in the window.
40481 It cannot go further back up the log.
40482
40483 The point from which the search starts is indicated by a caret marker. This is
40484 normally at the end of the text in the window, but can be positioned explicitly
40485 by pointing and clicking with the left mouse button, and is moved automatically
40486 by a successful search. If new text arrives in the window when it is scrolled
40487 back, the caret remains where it is, but if the window is not scrolled back,
40488 the caret is moved to the end of the new text.
40489
40490 Pressing ^R or ^S pops up a window into which the search text can be typed.
40491 There are buttons for selecting forward or reverse searching, for carrying out
40492 the search, and for cancelling. If the &"Search"& button is pressed, the search
40493 happens and the window remains so that further searches can be done. If the
40494 &"Return"& key is pressed, a single search is done and the window is closed. If
40495 ^C is typed the search is cancelled.
40496
40497 The searching facility is implemented using the facilities of the Athena text
40498 widget. By default this pops up a window containing both &"search"& and
40499 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40500 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40501 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40502 provided version of &%TextPop%& when the remaining parts of the text widget
40503 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40504 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40505 on these systems, at the expense of having unwanted items in the search popup
40506 window.
40507
40508
40509
40510 .section "The queue display" "SECID268"
40511 .cindex "queue" "display in monitor"
40512 The bottom section of the monitor window contains a list of all messages that
40513 are in the queue, which includes those currently being received or delivered,
40514 as well as those awaiting delivery. The size of this subwindow is controlled by
40515 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40516 at which it is updated is controlled by another parameter in the same file &--
40517 the default is 5 minutes, since queue scans can be quite expensive. However,
40518 there is an &"Update"& action button just above the display which can be used
40519 to force an update of the queue display at any time.
40520
40521 When a host is down for some time, a lot of pending mail can build up for it,
40522 and this can make it hard to deal with other messages in the queue. To help
40523 with this situation there is a button next to &"Update"& called &"Hide"&. If
40524 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40525 type anything in here and press &"Return"&, the text is added to a chain of
40526 such texts, and if every undelivered address in a message matches at least one
40527 of the texts, the message is not displayed.
40528
40529 If there is an address that does not match any of the texts, all the addresses
40530 are displayed as normal. The matching happens on the ends of addresses so, for
40531 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40532 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40533 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40534 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40535 a hide request is automatically cancelled after one hour.
40536
40537 While the dialogue box is displayed, you can't press any buttons or do anything
40538 else to the monitor window. For this reason, if you want to cut text from the
40539 queue display to use in the dialogue box, you have to do the cutting before
40540 pressing the &"Hide"& button.
40541
40542 The queue display contains, for each unhidden queued message, the length of
40543 time it has been in the queue, the size of the message, the message id, the
40544 message sender, and the first undelivered recipient, all on one line. If it is
40545 a bounce message, the sender is shown as &"<>"&. If there is more than one
40546 recipient to which the message has not yet been delivered, subsequent ones are
40547 listed on additional lines, up to a maximum configured number, following which
40548 an ellipsis is displayed. Recipients that have already received the message are
40549 not shown.
40550
40551 .cindex "frozen messages" "display"
40552 If a message is frozen, an asterisk is displayed at the left-hand side.
40553
40554 The queue display has a vertical scroll bar, and can also be scrolled by means
40555 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40556 The text searching facilities, as described above for the log window, are also
40557 available, but the caret is always moved to the end of the text when the queue
40558 display is updated.
40559
40560
40561
40562 .section "The queue menu" "SECID269"
40563 .cindex "queue" "menu in monitor"
40564 If the &%shift%& key is held down and the left button is clicked when the mouse
40565 pointer is over the text for any message, an action menu pops up, and the first
40566 line of the queue display for the message is highlighted. This does not affect
40567 any selected text.
40568
40569 If you want to use some other event for popping up the menu, you can set the
40570 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40571 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40572 value set in this parameter is a standard X event description. For example, to
40573 run eximon using &%ctrl%& rather than &%shift%& you could use
40574 .code
40575 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40576 .endd
40577 The title of the menu is the message id, and it contains entries which act as
40578 follows:
40579
40580 .ilist
40581 &'message log'&: The contents of the message log for the message are displayed
40582 in a new text window.
40583 .next
40584 &'headers'&: Information from the spool file that contains the envelope
40585 information and headers is displayed in a new text window. See chapter
40586 &<<CHAPspool>>& for a description of the format of spool files.
40587 .next
40588 &'body'&: The contents of the spool file containing the body of the message are
40589 displayed in a new text window. There is a default limit of 20,000 bytes to the
40590 amount of data displayed. This can be changed by setting the BODY_MAX
40591 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40592 .next
40593 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40594 delivery of the message. This causes an automatic thaw if the message is
40595 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40596 a new text window. The delivery is run in a separate process, to avoid holding
40597 up the monitor while the delivery proceeds.
40598 .next
40599 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40600 that the message be frozen.
40601 .next
40602 .cindex "thawing messages"
40603 .cindex "unfreezing messages"
40604 .cindex "frozen messages" "thawing"
40605 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40606 that the message be thawed.
40607 .next
40608 .cindex "delivery" "forcing failure"
40609 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40610 that Exim gives up trying to deliver the message. A bounce message is generated
40611 for any remaining undelivered addresses.
40612 .next
40613 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40614 that the message be deleted from the system without generating a bounce
40615 message.
40616 .next
40617 &'add recipient'&: A dialog box is displayed into which a recipient address can
40618 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40619 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40620 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40621 causes a call to Exim to be made using the &%-Mar%& option to request that an
40622 additional recipient be added to the message, unless the entry box is empty, in
40623 which case no action is taken.
40624 .next
40625 &'mark delivered'&: A dialog box is displayed into which a recipient address
40626 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40627 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40628 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40629 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40630 recipient address as already delivered, unless the entry box is empty, in which
40631 case no action is taken.
40632 .next
40633 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40634 mark all recipient addresses as already delivered.
40635 .next
40636 &'edit sender'&: A dialog box is displayed initialized with the current
40637 sender's address. Pressing RETURN causes a call to Exim to be made using the
40638 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40639 in which case no action is taken. If you want to set an empty sender (as in
40640 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40641 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40642 the address is qualified with that domain.
40643 .endlist
40644
40645 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40646 other cases when a call to Exim is made, if there is any output from Exim (in
40647 particular, if the command fails) a window containing the command and the
40648 output is displayed. Otherwise, the results of the action are normally apparent
40649 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40650 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40651 if no output is generated.
40652
40653 The queue display is automatically updated for actions such as freezing and
40654 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40655 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40656 force an update of the display after one of these actions.
40657
40658 In any text window that is displayed as result of a menu action, the normal
40659 cut-and-paste facility is available, and searching can be carried out using ^R
40660 and ^S, as described above for the log tail window.
40661 .ecindex IIDeximon
40662
40663
40664
40665
40666
40667 . ////////////////////////////////////////////////////////////////////////////
40668 . ////////////////////////////////////////////////////////////////////////////
40669
40670 .chapter "Security considerations" "CHAPsecurity"
40671 .scindex IIDsecurcon "security" "discussion of"
40672 This chapter discusses a number of issues concerned with security, some of
40673 which are also covered in other parts of this manual.
40674
40675 For reasons that this author does not understand, some people have promoted
40676 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40677 existence of this chapter in the documentation. However, the intent of the
40678 chapter is simply to describe the way Exim works in relation to certain
40679 security concerns, not to make any specific claims about the effectiveness of
40680 its security as compared with other MTAs.
40681
40682 What follows is a description of the way Exim is supposed to be. Best efforts
40683 have been made to try to ensure that the code agrees with the theory, but an
40684 absence of bugs can never be guaranteed. Any that are reported will get fixed
40685 as soon as possible.
40686
40687
40688 .section "Building a more &""hardened""& Exim" "SECID286"
40689 .cindex "security" "build-time features"
40690 There are a number of build-time options that can be set in &_Local/Makefile_&
40691 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40692 Exim administrator who does not have the root password, or by someone who has
40693 penetrated the Exim (but not the root) account. These options are as follows:
40694
40695 .ilist
40696 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40697 start of any filenames used with the &%-C%& option. When it is set, these
40698 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40699 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40700 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40701 default setting for &%ALT_CONFIG_PREFIX%&.
40702
40703 If the permitted configuration files are confined to a directory to
40704 which only root has access, this guards against someone who has broken
40705 into the Exim account from running a privileged Exim with an arbitrary
40706 configuration file, and using it to break into other accounts.
40707 .next
40708
40709 If a non-trusted configuration file (i.e. not the default configuration file
40710 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40711 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40712 the next item), then root privilege is retained only if the caller of Exim is
40713 root. This locks out the possibility of testing a configuration using &%-C%&
40714 right through message reception and delivery, even if the caller is root. The
40715 reception works, but by that time, Exim is running as the Exim user, so when
40716 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40717 privilege to be lost. However, root can test reception and delivery using two
40718 separate commands.
40719
40720 .next
40721 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40722 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40723 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40724 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40725 the restrictive side.  Requiring build-time selection of safe macros is onerous
40726 but this option is intended solely as a transition mechanism to permit
40727 previously-working configurations to continue to work after release 4.73.
40728 .next
40729 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40730 is disabled.
40731 .next
40732 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40733 never to be used for any deliveries. This is like the &%never_users%& runtime
40734 option, but it cannot be overridden; the runtime option adds additional users
40735 to the list. The default setting is &"root"&; this prevents a non-root user who
40736 is permitted to modify the runtime file from using Exim as a way to get root.
40737 .endlist
40738
40739
40740
40741 .section "Root privilege" "SECID270"
40742 .cindex "setuid"
40743 .cindex "root privilege"
40744 The Exim binary is normally setuid to root, which means that it gains root
40745 privilege (runs as root) when it starts execution. In some special cases (for
40746 example, when the daemon is not in use and there are no local deliveries), it
40747 may be possible to run Exim setuid to some user other than root. This is
40748 discussed in the next section. However, in most installations, root privilege
40749 is required for two things:
40750
40751 .ilist
40752 To set up a socket connected to the standard SMTP port (25) when initialising
40753 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40754 not required.
40755 .next
40756 To be able to change uid and gid in order to read users' &_.forward_& files and
40757 perform local deliveries as the receiving user or as specified in the
40758 configuration.
40759 .endlist
40760
40761 It is not necessary to be root to do any of the other things Exim does, such as
40762 receiving messages and delivering them externally over SMTP, and it is
40763 obviously more secure if Exim does not run as root except when necessary.
40764 For this reason, a user and group for Exim to use must be defined in
40765 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40766 group"&. Their values can be changed by the runtime configuration, though this
40767 is not recommended. Often a user called &'exim'& is used, but some sites use
40768 &'mail'& or another user name altogether.
40769
40770 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40771 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40772 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40773
40774 After a new Exim process has interpreted its command line options, it changes
40775 uid and gid in the following cases:
40776
40777 .ilist
40778 .oindex "&%-C%&"
40779 .oindex "&%-D%&"
40780 If the &%-C%& option is used to specify an alternate configuration file, or if
40781 the &%-D%& option is used to define macro values for the configuration, and the
40782 calling process is not running as root, the uid and gid are changed to those of
40783 the calling process.
40784 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40785 option may not be used at all.
40786 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40787 can be supplied if the calling process is running as root, the Exim run-time
40788 user or CONFIGURE_OWNER, if defined.
40789 .next
40790 .oindex "&%-be%&"
40791 .oindex "&%-bf%&"
40792 .oindex "&%-bF%&"
40793 If the expansion test option (&%-be%&) or one of the filter testing options
40794 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40795 calling process.
40796 .next
40797 If the process is not a daemon process or a queue runner process or a delivery
40798 process or a process for testing address routing (started with &%-bt%&), the
40799 uid and gid are changed to the Exim user and group. This means that Exim always
40800 runs under its own uid and gid when receiving messages. This also applies when
40801 testing address verification
40802 .oindex "&%-bv%&"
40803 .oindex "&%-bh%&"
40804 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40805 option).
40806 .next
40807 For a daemon, queue runner, delivery, or address testing process, the uid
40808 remains as root at this stage, but the gid is changed to the Exim group.
40809 .endlist
40810
40811 The processes that initially retain root privilege behave as follows:
40812
40813 .ilist
40814 A daemon process changes the gid to the Exim group and the uid to the Exim
40815 user after setting up one or more listening sockets. The &[initgroups()]&
40816 function is called, so that if the Exim user is in any additional groups, they
40817 will be used during message reception.
40818 .next
40819 A queue runner process retains root privilege throughout its execution. Its
40820 job is to fork a controlled sequence of delivery processes.
40821 .next
40822 A delivery process retains root privilege throughout most of its execution,
40823 but any actual deliveries (that is, the transports themselves) are run in
40824 subprocesses which always change to a non-root uid and gid. For local
40825 deliveries this is typically the uid and gid of the owner of the mailbox; for
40826 remote deliveries, the Exim uid and gid are used. Once all the delivery
40827 subprocesses have been run, a delivery process changes to the Exim uid and gid
40828 while doing post-delivery tidying up such as updating the retry database and
40829 generating bounce and warning messages.
40830
40831 While the recipient addresses in a message are being routed, the delivery
40832 process runs as root. However, if a user's filter file has to be processed,
40833 this is done in a subprocess that runs under the individual user's uid and
40834 gid. A system filter is run as root unless &%system_filter_user%& is set.
40835 .next
40836 A process that is testing addresses (the &%-bt%& option) runs as root so that
40837 the routing is done in the same environment as a message delivery.
40838 .endlist
40839
40840
40841
40842
40843 .section "Running Exim without privilege" "SECTrunexiwitpri"
40844 .cindex "privilege, running without"
40845 .cindex "unprivileged running"
40846 .cindex "root privilege" "running without"
40847 Some installations like to run Exim in an unprivileged state for more of its
40848 operation, for added security. Support for this mode of operation is provided
40849 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40850 gid are changed to the Exim user and group at the start of a delivery process
40851 (and also queue runner and address testing processes). This means that address
40852 routing is no longer run as root, and the deliveries themselves cannot change
40853 to any other uid.
40854
40855 .cindex SIGHUP
40856 .cindex "daemon" "restarting"
40857 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40858 that the daemon can still be started in the usual way, and it can respond
40859 correctly to SIGHUP because the re-invocation regains root privilege.
40860
40861 An alternative approach is to make Exim setuid to the Exim user and also setgid
40862 to the Exim group. If you do this, the daemon must be started from a root
40863 process. (Calling Exim from a root process makes it behave in the way it does
40864 when it is setuid root.) However, the daemon cannot restart itself after a
40865 SIGHUP signal because it cannot regain privilege.
40866
40867 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40868 stops Exim from trying to re-invoke itself to do a delivery after a message has
40869 been received. Such a re-invocation is a waste of resources because it has no
40870 effect.
40871
40872 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40873 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40874 to the Exim user seems a clean approach, but there is one complication:
40875
40876 In this style of operation, Exim is running with the real uid and gid set to
40877 those of the calling process, and the effective uid/gid set to Exim's values.
40878 Ideally, any association with the calling process' uid/gid should be dropped,
40879 that is, the real uid/gid should be reset to the effective values so as to
40880 discard any privileges that the caller may have. While some operating systems
40881 have a function that permits this action for a non-root effective uid, quite a
40882 number of them do not. Because of this lack of standardization, Exim does not
40883 address this problem at this time.
40884
40885 For this reason, the recommended approach for &"mostly unprivileged"& running
40886 is to keep the Exim binary setuid to root, and to set
40887 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40888 be used in the most straightforward way.
40889
40890 If you configure Exim not to run delivery processes as root, there are a
40891 number of restrictions on what you can do:
40892
40893 .ilist
40894 You can deliver only as the Exim user/group. You should  explicitly use the
40895 &%user%& and &%group%& options to override routers or local transports that
40896 normally deliver as the recipient. This makes sure that configurations that
40897 work in this mode function the same way in normal mode. Any implicit or
40898 explicit specification of another user causes an error.
40899 .next
40900 Use of &_.forward_& files is severely restricted, such that it is usually
40901 not worthwhile to include them in the configuration.
40902 .next
40903 Users who wish to use &_.forward_& would have to make their home directory and
40904 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40905 and their equivalents in Exim filters, cannot be used. While they could be
40906 enabled in the Exim user's name, that would be insecure and not very useful.
40907 .next
40908 Unless the local user mailboxes are all owned by the Exim user (possible in
40909 some POP3 or IMAP-only environments):
40910
40911 .olist
40912 They must be owned by the Exim group and be writeable by that group. This
40913 implies you must set &%mode%& in the appendfile configuration, as well as the
40914 mode of the mailbox files themselves.
40915 .next
40916 You must set &%no_check_owner%&, since most or all of the files will not be
40917 owned by the Exim user.
40918 .next
40919 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40920 on a newly created mailbox when unprivileged. This also implies that new
40921 mailboxes need to be created manually.
40922 .endlist olist
40923 .endlist ilist
40924
40925
40926 These restrictions severely restrict what can be done in local deliveries.
40927 However, there are no restrictions on remote deliveries. If you are running a
40928 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40929 gives more security at essentially no cost.
40930
40931 If you are using the &%mua_wrapper%& facility (see chapter
40932 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40933
40934
40935
40936
40937 .section "Delivering to local files" "SECID271"
40938 Full details of the checks applied by &(appendfile)& before it writes to a file
40939 are given in chapter &<<CHAPappendfile>>&.
40940
40941
40942
40943 .section "Running local commands" "SECTsecconslocalcmds"
40944 .cindex "security" "local commands"
40945 .cindex "security" "command injection attacks"
40946 There are a number of ways in which an administrator can configure Exim to run
40947 commands based upon received, untrustworthy, data. Further, in some
40948 configurations a user who can control a &_.forward_& file can also arrange to
40949 run commands. Configuration to check includes, but is not limited to:
40950
40951 .ilist
40952 Use of &%use_shell%& in the pipe transport: various forms of shell command
40953 injection may be possible with this option present. It is dangerous and should
40954 be used only with considerable caution. Consider constraints which whitelist
40955 allowed characters in a variable which is to be used in a pipe transport that
40956 has &%use_shell%& enabled.
40957 .next
40958 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40959 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40960 &_.forward_& files in a redirect router. If Exim is running on a central mail
40961 hub to which ordinary users do not have shell access, but home directories are
40962 NFS mounted (for instance) then administrators should review the list of these
40963 forbid options available, and should bear in mind that the options that may
40964 need forbidding can change as new features are added between releases.
40965 .next
40966 The &%${run...}%& expansion item does not use a shell by default, but
40967 administrators can configure use of &_/bin/sh_& as part of the command.
40968 Such invocations should be viewed with prejudicial suspicion.
40969 .next
40970 Administrators who use embedded Perl are advised to explore how Perl's
40971 taint checking might apply to their usage.
40972 .next
40973 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40974 administrators are well advised to view its use with suspicion, in case (for
40975 instance) it allows a local-part to contain embedded Exim directives.
40976 .next
40977 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40978 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40979 each can reference arbitrary lists and files, rather than just being a list
40980 of opaque strings.
40981 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40982 real-world security vulnerabilities caused by its use with untrustworthy data
40983 injected in, for SQL injection attacks.
40984 Consider the use of the &%inlisti%& expansion condition instead.
40985 .endlist
40986
40987
40988
40989
40990 .section "Trust in configuration data" "SECTsecconfdata"
40991 .cindex "security" "data sources"
40992 .cindex "security" "regular expressions"
40993 .cindex "regular expressions" "security"
40994 .cindex "PCRE2" "security"
40995 If configuration data for Exim can come from untrustworthy sources, there
40996 are some issues to be aware of:
40997
40998 .ilist
40999 Use of &%${expand...}%& may provide a path for shell injection attacks.
41000 .next
41001 Letting untrusted data provide a regular expression is unwise.
41002 .next
41003 Using &%${match...}%& to apply a fixed regular expression against untrusted
41004 data may result in pathological behaviour within PCRE2.  Be aware of what
41005 "backtracking" means and consider options for being more strict with a regular
41006 expression. Avenues to explore include limiting what can match (avoiding &`.`&
41007 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
41008 possessive quantifiers or just not using regular expressions against untrusted
41009 data.
41010 .next
41011 It can be important to correctly use &%${quote:...}%&,
41012 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
41013 items to ensure that data is correctly constructed.
41014 .next
41015 Some lookups might return multiple results, even though normal usage is only
41016 expected to yield one result.
41017 .endlist
41018
41019
41020
41021
41022 .section "IPv4 source routing" "SECID272"
41023 .cindex "source routing" "in IP packets"
41024 .cindex "IP source routing"
41025 Many operating systems suppress IP source-routed packets in the kernel, but
41026 some cannot be made to do this, so Exim does its own check. It logs incoming
41027 IPv4 source-routed TCP calls, and then drops them. Things are all different in
41028 IPv6. No special checking is currently done.
41029
41030
41031
41032 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
41033 Support for these SMTP commands is disabled by default. If required, they can
41034 be enabled by defining suitable ACLs.
41035
41036
41037
41038
41039 .section "Privileged users" "SECID274"
41040 .cindex "trusted users"
41041 .cindex "admin user"
41042 .cindex "privileged user"
41043 .cindex "user" "trusted"
41044 .cindex "user" "admin"
41045 Exim recognizes two sets of users with special privileges. Trusted users are
41046 able to submit new messages to Exim locally, but supply their own sender
41047 addresses and information about a sending host. For other users submitting
41048 local messages, Exim sets up the sender address from the uid, and doesn't
41049 permit a remote host to be specified.
41050
41051 .oindex "&%-f%&"
41052 However, an untrusted user is permitted to use the &%-f%& command line option
41053 in the special form &%-f <>%& to indicate that a delivery failure for the
41054 message should not cause an error report. This affects the message's envelope,
41055 but it does not affect the &'Sender:'& header. Untrusted users may also be
41056 permitted to use specific forms of address with the &%-f%& option by setting
41057 the &%untrusted_set_sender%& option.
41058
41059 Trusted users are used to run processes that receive mail messages from some
41060 other mail domain and pass them on to Exim for delivery either locally, or over
41061 the Internet. Exim trusts a caller that is running as root, as the Exim user,
41062 as any user listed in the &%trusted_users%& configuration option, or under any
41063 group listed in the &%trusted_groups%& option.
41064
41065 Admin users are permitted to do things to the messages on Exim's queue. They
41066 can freeze or thaw messages, cause them to be returned to their senders, remove
41067 them entirely, or modify them in various ways. In addition, admin users can run
41068 the Exim monitor and see all the information it is capable of providing, which
41069 includes the contents of files on the spool.
41070
41071 .oindex "&%-M%&"
41072 .oindex "&%-q%&"
41073 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
41074 delivery of messages on its queue is restricted to admin users. This
41075 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
41076 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
41077 queue is also restricted to admin users. This restriction can be relaxed by
41078 setting &%no_queue_list_requires_admin%&.
41079
41080 Exim recognizes an admin user if the calling process is running as root or as
41081 the Exim user or if any of the groups associated with the calling process is
41082 the Exim group. It is not necessary actually to be running under the Exim
41083 group. However, if admin users who are not root or the Exim user are to access
41084 the contents of files on the spool via the Exim monitor (which runs
41085 unprivileged), Exim must be built to allow group read access to its spool
41086 files.
41087
41088 By default, regular users are trusted to perform basic testing and
41089 introspection commands, as themselves.  This setting can be tightened by
41090 setting the &%commandline_checks_require_admin%& option.
41091 This affects most of the checking options,
41092 such as &%-be%& and anything else &%-b*%&.
41093
41094
41095 .section "Spool files" "SECID275"
41096 .cindex "spool directory" "files"
41097 Exim's spool directory and everything it contains is owned by the Exim user and
41098 set to the Exim group. The mode for spool files is defined in the
41099 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
41100 any user who is a member of the Exim group can access these files.
41101
41102
41103
41104 .section "Use of argv[0]" "SECID276"
41105 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
41106 of specific strings, Exim assumes certain options. For example, calling Exim
41107 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
41108 to calling it with the option &%-bS%&. There are no security implications in
41109 this.
41110
41111
41112
41113 .section "Use of %f formatting" "SECID277"
41114 The only use made of &"%f"& by Exim is in formatting load average values. These
41115 are actually stored in integer variables as 1000 times the load average.
41116 Consequently, their range is limited and so therefore is the length of the
41117 converted output.
41118
41119
41120
41121 .section "Embedded Exim path" "SECID278"
41122 Exim uses its own path name, which is embedded in the code, only when it needs
41123 to re-exec in order to regain root privilege. Therefore, it is not root when it
41124 does so. If some bug allowed the path to get overwritten, it would lead to an
41125 arbitrary program's being run as exim, not as root.
41126
41127
41128
41129 .section "Dynamic module directory" "SECTdynmoddir"
41130 Any dynamically loadable modules must be installed into the directory
41131 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
41132 loading it.
41133
41134
41135 .section "Use of sprintf()" "SECID279"
41136 .cindex "&[sprintf()]&"
41137 A large number of occurrences of &"sprintf"& in the code are actually calls to
41138 &'string_sprintf()'&, a function that returns the result in malloc'd store.
41139 The intermediate formatting is done into a large fixed buffer by a function
41140 that runs through the format string itself, and checks the length of each
41141 conversion before performing it, thus preventing buffer overruns.
41142
41143 The remaining uses of &[sprintf()]& happen in controlled circumstances where
41144 the output buffer is known to be sufficiently long to contain the converted
41145 string.
41146
41147
41148
41149 .section "Use of debug_printf() and log_write()" "SECID280"
41150 Arbitrary strings are passed to both these functions, but they do their
41151 formatting by calling the function &'string_vformat()'&, which runs through
41152 the format string itself, and checks the length of each conversion.
41153
41154
41155
41156 .section "Use of strcat() and strcpy()" "SECID281"
41157 These are used only in cases where the output buffer is known to be large
41158 enough to hold the result.
41159 .ecindex IIDsecurcon
41160
41161
41162
41163
41164 . ////////////////////////////////////////////////////////////////////////////
41165 . ////////////////////////////////////////////////////////////////////////////
41166
41167 .chapter "Format of spool files" "CHAPspool"
41168 .scindex IIDforspo1 "format" "spool files"
41169 .scindex IIDforspo2 "spool directory" "format of files"
41170 .scindex IIDforspo3 "spool files" "format of"
41171 .cindex "spool files" "editing"
41172 A message on Exim's queue consists of two files, whose names are the message id
41173 followed by -D and -H, respectively. The data portion of the message is kept in
41174 the -D file on its own. The message's envelope, status, and headers are all
41175 kept in the -H file, whose format is described in this chapter. Each of these
41176 two files contains the final component of its own name as its first line. This
41177 is insurance against disk crashes where the directory is lost but the files
41178 themselves are recoverable.
41179
41180 The file formats may be changed, or new formats added, at any release.
41181 Spool files are not intended as an interface to other programs
41182 and should not be used as such.
41183
41184 Some people are tempted into editing -D files in order to modify messages. You
41185 need to be extremely careful if you do this; it is not recommended and you are
41186 on your own if you do it. Here are some of the pitfalls:
41187
41188 .ilist
41189 You must ensure that Exim does not try to deliver the message while you are
41190 fiddling with it. The safest way is to take out a write lock on the -D file,
41191 which is what Exim itself does, using &[fcntl()]&. If you update the file in
41192 place, the lock will be retained. If you write a new file and rename it, the
41193 lock will be lost at the instant of rename.
41194 .next
41195 .vindex "&$body_linecount$&"
41196 If you change the number of lines in the file, the value of
41197 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
41198 cause incomplete transmission of messages or undeliverable messages.
41199 .next
41200 If the message is in MIME format, you must take care not to break it.
41201 .next
41202 If the message is cryptographically signed, any change will invalidate the
41203 signature.
41204 .endlist
41205 All in all, modifying -D files is fraught with danger.
41206
41207 Files whose names end with -J may also be seen in the &_input_& directory (or
41208 its subdirectories when &%split_spool_directory%& is set). These are journal
41209 files, used to record addresses to which the message has been delivered during
41210 the course of a delivery attempt. If there are still undelivered recipients at
41211 the end, the -H file is updated, and the -J file is deleted. If, however, there
41212 is some kind of crash (for example, a power outage) before this happens, the -J
41213 file remains in existence. When Exim next processes the message, it notices the
41214 -J file and uses it to update the -H file before starting the next delivery
41215 attempt.
41216
41217 Files whose names end with -K or .eml may also be seen in the spool.
41218 These are temporaries used for DKIM or malware processing, when that is used.
41219 They should be tidied up by normal operations; any old ones are probably
41220 relics of crashes and can be removed.
41221
41222 .section "Format of the -H file" "SECID282"
41223 .cindex "uid (user id)" "in spool file"
41224 .cindex "gid (group id)" "in spool file"
41225 The second line of the -H file contains the login name for the uid of the
41226 process that called Exim to read the message, followed by the numerical uid and
41227 gid. For a locally generated message, this is normally the user who sent the
41228 message. For a message received over TCP/IP via the daemon, it is
41229 normally the Exim user.
41230
41231 The third line of the file contains the address of the message's sender as
41232 transmitted in the envelope, contained in angle brackets. The sender address is
41233 empty for bounce messages. For incoming SMTP mail, the sender address is given
41234 in the MAIL command. For locally generated mail, the sender address is
41235 created by Exim from the login name of the current user and the configured
41236 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
41237 leading &"From&~"& line if the caller is trusted, or if the supplied address is
41238 &"<>"& or an address that matches &%untrusted_set_senders%&.
41239
41240 The fourth line contains two numbers. The first is the time that the message
41241 was received, in the conventional Unix form &-- the number of seconds since the
41242 start of the epoch. The second number is a count of the number of messages
41243 warning of delayed delivery that have been sent to the sender.
41244
41245 There follow a number of lines starting with a hyphen.
41246 These contain variables, can appear in any
41247 order, and are omitted when not relevant.
41248
41249 If there is a second hyphen after the first,
41250 the corresponding data is tainted.
41251 If there is a value in parentheses, the data is quoted for a lookup.
41252
41253 The following word specifies a variable,
41254 and the remainder of the item depends on the variable.
41255
41256 .vlist
41257 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
41258 This item is obsolete, and is not generated from Exim release 4.61 onwards;
41259 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
41260 recognized, to provide backward compatibility. In the old format, a line of
41261 this form is present for every ACL variable that is not empty. The number
41262 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
41263 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
41264 the data string for the variable. The string itself starts at the beginning of
41265 the next line, and is followed by a newline character. It may contain internal
41266 newlines.
41267
41268 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
41269 A line of this form is present for every ACL connection variable that is
41270 defined. Note that there is a space between &%-aclc%& and the rest of the name.
41271 The length is the length of the data string for the variable. The string itself
41272 starts at the beginning of the next line, and is followed by a newline
41273 character. It may contain internal newlines.
41274
41275 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
41276 A line of this form is present for every ACL message variable that is defined.
41277 Note that there is a space between &%-aclm%& and the rest of the name. The
41278 length is the length of the data string for the variable. The string itself
41279 starts at the beginning of the next line, and is followed by a newline
41280 character. It may contain internal newlines.
41281
41282 .vitem "&%-active_hostname%&&~<&'hostname'&>"
41283 This is present if, when the message was received over SMTP, the value of
41284 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
41285
41286 .vitem &%-allow_unqualified_recipient%&
41287 This is present if unqualified recipient addresses are permitted in header
41288 lines (to stop such addresses from being qualified if rewriting occurs at
41289 transport time). Local messages that were input using &%-bnq%& and remote
41290 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
41291
41292 .vitem &%-allow_unqualified_sender%&
41293 This is present if unqualified sender addresses are permitted in header lines
41294 (to stop such addresses from being qualified if rewriting occurs at transport
41295 time). Local messages that were input using &%-bnq%& and remote messages from
41296 hosts that match &%sender_unqualified_hosts%& set this flag.
41297
41298 .vitem "&%-auth_id%&&~<&'text'&>"
41299 The id information for a message received on an authenticated SMTP connection
41300 &-- the value of the &$authenticated_id$& variable.
41301
41302 .vitem "&%-auth_sender%&&~<&'address'&>"
41303 The address of an authenticated sender &-- the value of the
41304 &$authenticated_sender$& variable.
41305
41306 .vitem "&%-body_linecount%&&~<&'number'&>"
41307 This records the number of lines in the body of the message, and is
41308 present unless &%-spool_file_wireformat%& is.
41309
41310 .vitem "&%-body_zerocount%&&~<&'number'&>"
41311 This records the number of binary zero bytes in the body of the message, and is
41312 present if the number is greater than zero.
41313
41314 .vitem &%-deliver_firsttime%&
41315 This is written when a new message is first added to the spool. When the spool
41316 file is updated after a deferral, it is omitted.
41317
41318 .vitem "&%-frozen%&&~<&'time'&>"
41319 .cindex "frozen messages" "spool data"
41320 The message is frozen, and the freezing happened at <&'time'&>.
41321
41322 .vitem "&%-helo_name%&&~<&'text'&>"
41323 This records the host name as specified by a remote host in a HELO or EHLO
41324 command.
41325
41326 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
41327 This records the IP address of the host from which the message was received and
41328 the remote port number that was used. It is omitted for locally generated
41329 messages.
41330
41331 .vitem "&%-host_auth%&&~<&'text'&>"
41332 If the message was received on an authenticated SMTP connection, this records
41333 the name of the authenticator &-- the value of the
41334 &$sender_host_authenticated$& variable.
41335
41336 .vitem &%-host_lookup_failed%&
41337 This is present if an attempt to look up the sending host's name from its IP
41338 address failed. It corresponds to the &$host_lookup_failed$& variable.
41339
41340 .vitem "&%-host_name%&&~<&'text'&>"
41341 .cindex "reverse DNS lookup"
41342 .cindex "DNS" "reverse lookup"
41343 This records the name of the remote host from which the message was received,
41344 if the host name was looked up from the IP address when the message was being
41345 received. It is not present if no reverse lookup was done.
41346
41347 .vitem "&%-ident%&&~<&'text'&>"
41348 For locally submitted messages, this records the login of the originating user,
41349 unless it was a trusted user and the &%-oMt%& option was used to specify an
41350 ident value. For messages received over TCP/IP, this records the ident string
41351 supplied by the remote host, if any.
41352
41353 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
41354 This records the IP address of the local interface and the port number through
41355 which a message was received from a remote host. It is omitted for locally
41356 generated messages.
41357
41358 .vitem &%-local%&
41359 The message is from a local sender.
41360
41361 .vitem &%-localerror%&
41362 The message is a locally-generated bounce message.
41363
41364 .vitem "&%-local_scan%&&~<&'string'&>"
41365 This records the data string that was returned by the &[local_scan()]& function
41366 when the message was received &-- the value of the &$local_scan_data$&
41367 variable. It is omitted if no data was returned.
41368
41369 .vitem &%-manual_thaw%&
41370 The message was frozen but has been thawed manually, that is, by an explicit
41371 Exim command rather than via the auto-thaw process.
41372
41373 .vitem &%-N%&
41374 A testing delivery process was started using the &%-N%& option to suppress any
41375 actual deliveries, but delivery was deferred. At any further delivery attempts,
41376 &%-N%& is assumed.
41377
41378 .vitem &%-received_protocol%&
41379 This records the value of the &$received_protocol$& variable, which contains
41380 the name of the protocol by which the message was received.
41381
41382 .vitem &%-sender_set_untrusted%&
41383 The envelope sender of this message was set by an untrusted local caller (used
41384 to ensure that the caller is displayed in queue listings).
41385
41386 .vitem "&%-spam_score_int%&&~<&'number'&>"
41387 If a message was scanned by SpamAssassin, this is present. It records the value
41388 of &$spam_score_int$&.
41389
41390 .vitem &%-spool_file_wireformat%&
41391 The -D file for this message is in wire-format (for ESMTP CHUNKING)
41392 rather than Unix-format.
41393 The line-ending is CRLF rather than newline.
41394 There is still, however, no leading-dot-stuffing.
41395
41396 .vitem &%-tls_certificate_verified%&
41397 A TLS certificate was received from the client that sent this message, and the
41398 certificate was verified by the server.
41399
41400 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41401 When the message was received over an encrypted connection, this records the
41402 name of the cipher suite that was used.
41403
41404 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41405 When the message was received over an encrypted connection, and a certificate
41406 was received from the client, this records the Distinguished Name from that
41407 certificate.
41408 .endlist
41409
41410 Following the options there is a list of those addresses to which the message
41411 is not to be delivered. This set of addresses is initialized from the command
41412 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41413 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41414 the address is added to this set. The addresses are kept internally as a
41415 balanced binary tree, and it is a representation of that tree which is written
41416 to the spool file. If an address is expanded via an alias or forward file, the
41417 original address is added to the tree when deliveries to all its child
41418 addresses are complete.
41419
41420 If the tree is empty, there is a single line in the spool file containing just
41421 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41422 Y or N, followed by an address. The address is the value for the node of the
41423 tree, and the letters indicate whether the node has a left branch and/or a
41424 right branch attached to it, respectively. If branches exist, they immediately
41425 follow. Here is an example of a three-node tree:
41426 .code
41427 YY darcy@austen.fict.example
41428 NN alice@wonderland.fict.example
41429 NN editor@thesaurus.ref.example
41430 .endd
41431 After the non-recipients tree, there is a list of the message's recipients.
41432 This is a simple list, preceded by a count. It includes all the original
41433 recipients of the message, including those to whom the message has already been
41434 delivered. In the simplest case, the list contains one address per line. For
41435 example:
41436 .code
41437 4
41438 editor@thesaurus.ref.example
41439 darcy@austen.fict.example
41440 rdo@foundation
41441 alice@wonderland.fict.example
41442 .endd
41443 However, when a child address has been added to the top-level addresses as a
41444 result of the use of the &%one_time%& option on a &(redirect)& router, each
41445 line is of the following form:
41446 .display
41447 <&'top-level address'&> <&'errors_to address'&> &&&
41448   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41449 .endd
41450 The 01 flag bit indicates the presence of the three other fields that follow
41451 the top-level address. Other bits may be used in future to support additional
41452 fields. The <&'parent number'&> is the offset in the recipients list of the
41453 original parent of the &"one time"& address. The first two fields are the
41454 envelope sender that is associated with this address and its length. If the
41455 length is zero, there is no special envelope sender (there are then two space
41456 characters in the line). A non-empty field can arise from a &(redirect)& router
41457 that has an &%errors_to%& setting.
41458
41459
41460 A blank line separates the envelope and status information from the headers
41461 which follow. A header may occupy several lines of the file, and to save effort
41462 when reading it in, each header is preceded by a number and an identifying
41463 character. The number is the number of characters in the header, including any
41464 embedded newlines and the terminating newline. The character is one of the
41465 following:
41466
41467 .table2 50pt
41468 .row <&'blank'&>         "header in which Exim has no special interest"
41469 .row &`B`&               "&'Bcc:'& header"
41470 .row &`C`&               "&'Cc:'& header"
41471 .row &`F`&               "&'From:'& header"
41472 .row &`I`&               "&'Message-id:'& header"
41473 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41474 .row &`R`&               "&'Reply-To:'& header"
41475 .row &`S`&               "&'Sender:'& header"
41476 .row &`T`&               "&'To:'& header"
41477 .row &`*`&               "replaced or deleted header"
41478 .endtable
41479
41480 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41481 purposes. They are not transmitted when the message is delivered. Here is a
41482 typical set of headers:
41483 .code
41484 111P Received: by hobbit.fict.example with local (Exim 4.00)
41485 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41486 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41487 038* X-rewrote-sender: bb@hobbit.fict.example
41488 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41489 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41490 099* To: alice@wonderland.fict.example, rdo@foundation,
41491 darcy@austen.fict.example, editor@thesaurus.ref.example
41492 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41493 darcy@austen.fict.example, editor@thesaurus.ref.example
41494 038  Date: Fri, 11 May 2001 10:28:59 +0100
41495 .endd
41496 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41497 &'To:'& header have been rewritten, the last one because routing expanded the
41498 unqualified domain &'foundation'&.
41499 .ecindex IIDforspo1
41500 .ecindex IIDforspo2
41501 .ecindex IIDforspo3
41502
41503 .section "Format of the -D file" "SECID282a"
41504 The data file is traditionally in Unix-standard format: lines are ended with
41505 an ASCII newline character.
41506 However, when the &%spool_wireformat%& main option is used some -D files
41507 can have an alternate format.
41508 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41509 The -D file lines (not including the first name-component line) are
41510 suitable for direct copying to the wire when transmitting using the
41511 ESMTP CHUNKING option, meaning lower processing overhead.
41512 Lines are terminated with an ASCII CRLF pair.
41513 There is no dot-stuffing (and no dot-termination).
41514
41515 . ////////////////////////////////////////////////////////////////////////////
41516 . ////////////////////////////////////////////////////////////////////////////
41517
41518 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41519          "DKIM, SPF, SRS and DMARC Support"
41520
41521 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41522 .cindex "DKIM"
41523
41524 DKIM is a mechanism by which messages sent by some entity can be provably
41525 linked to a domain which that entity controls.  It permits reputation to
41526 be tracked on a per-domain basis, rather than merely upon source IP address.
41527 DKIM is documented in RFC 6376.
41528
41529 As DKIM relies on the message being unchanged in transit, messages handled
41530 by a mailing-list (which traditionally adds to the message) will not match
41531 any original DKIM signature.
41532
41533 DKIM support is compiled into Exim by default if TLS support is present.
41534 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41535
41536 Exim's DKIM implementation allows for
41537 .olist
41538 Signing outgoing messages: This function is implemented in the SMTP transport.
41539 It can co-exist with all other Exim features
41540 (including transport filters)
41541 except cutthrough delivery.
41542 .next
41543 Verifying signatures in incoming messages: This is implemented by an additional
41544 ACL (acl_smtp_dkim), which can be called several times per message, with
41545 different signature contexts.
41546 .endlist
41547
41548 In typical Exim style, the verification implementation does not include any
41549 default "policy". Instead it enables you to build your own policy using
41550 Exim's standard controls.
41551
41552 Please note that verification of DKIM signatures in incoming mail is turned
41553 on by default for logging (in the <= line) purposes.
41554
41555 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41556 When set, for each signature in incoming email,
41557 exim will log a line displaying the most important signature details, and the
41558 signature status. Here is an example (with line-breaks added for clarity):
41559 .code
41560 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41561     d=facebookmail.com s=q1-2009b
41562     c=relaxed/relaxed a=rsa-sha1
41563     i=@facebookmail.com t=1252484542 [verification succeeded]
41564 .endd
41565
41566 You might want to turn off DKIM verification processing entirely for internal
41567 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41568 control modifier. This should typically be done in the RCPT ACL, at points
41569 where you accept mail from relay sources (internal hosts or authenticated
41570 senders).
41571
41572
41573 .subsection "Signing outgoing messages" SECDKIMSIGN
41574 .cindex DKIM signing
41575
41576 For signing to be usable you must have published a DKIM record in DNS.
41577 Note that RFC 8301 (which does not cover EC keys) says:
41578 .code
41579 rsa-sha1 MUST NOT be used for signing or verifying.
41580
41581 Signers MUST use RSA keys of at least 1024 bits for all keys.
41582 Signers SHOULD use RSA keys of at least 2048 bits.
41583 .endd
41584
41585 Note also that the key content (the 'p=' field)
41586 in the DNS record is different between RSA and EC keys;
41587 for the former it is the base64 of the ASN.1 for the RSA public key
41588 (equivalent to the private-key .pem with the header/trailer stripped)
41589 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41590
41591 Signing is enabled by setting private options on the SMTP transport.
41592 These options take (expandable) strings as arguments.
41593
41594 .option dkim_domain smtp "string list&!!" unset
41595 The domain(s) you want to sign with.
41596 After expansion, this can be a list.
41597 Each element in turn,
41598 lowercased,
41599 .vindex "&$dkim_domain$&"
41600 is put into the &%$dkim_domain%& expansion variable
41601 while expanding the remaining signing options.
41602 If it is empty after expansion, DKIM signing is not done,
41603 and no error will result even if &%dkim_strict%& is set.
41604
41605 .option dkim_selector smtp "string list&!!" unset
41606 This sets the key selector string.
41607 After expansion, which can use &$dkim_domain$&, this can be a list.
41608 Each element in turn is put in the expansion
41609 .vindex "&$dkim_selector$&"
41610 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41611 option along with &%$dkim_domain%&.
41612 If the option is empty after expansion, DKIM signing is not done for this domain,
41613 and no error will result even if &%dkim_strict%& is set.
41614
41615 To do, for example, dual-signing with RSA and EC keys
41616 this could be be used:
41617 .code
41618 dkim_selector = ec_sel : rsa_sel
41619 dkim_private_key = KEYS_DIR/$dkim_selector
41620 .endd
41621
41622 .option dkim_private_key smtp string&!! unset
41623 This sets the private key to use.
41624 You can use the &%$dkim_domain%& and
41625 &%$dkim_selector%& expansion variables to determine the private key to use.
41626 The result can either
41627 .ilist
41628 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41629 .next
41630 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41631 be a valid Ed25519 private key (same format as above)
41632 .next
41633 start with a slash, in which case it is treated as a file that contains
41634 the private key
41635 .next
41636 be "0", "false" or the empty string, in which case the message will not
41637 be signed. This case will not result in an error, even if &%dkim_strict%&
41638 is set.
41639 .endlist
41640
41641 To generate keys under OpenSSL:
41642 .code
41643 openssl genrsa -out dkim_rsa.private 2048
41644 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41645 .endd
41646 The result file from the first command should be retained, and
41647 this option set to use it.
41648 Take the base-64 lines from the output of the second command, concatenated,
41649 for the DNS TXT record.
41650 See section 3.6 of RFC6376 for the record specification.
41651
41652 Under GnuTLS:
41653 .code
41654 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41655 certtool --load-privkey=dkim_rsa.private --pubkey-info
41656 .endd
41657
41658 Note that RFC 8301 says:
41659 .code
41660 Signers MUST use RSA keys of at least 1024 bits for all keys.
41661 Signers SHOULD use RSA keys of at least 2048 bits.
41662 .endd
41663
41664 EC keys for DKIM are defined by RFC 8463.
41665 They are considerably smaller than RSA keys for equivalent protection.
41666 As they are a recent development, users should consider dual-signing
41667 (by setting a list of selectors, and an expansion for this option)
41668 for some transition period.
41669 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41670 for EC keys.
41671
41672 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41673 .code
41674 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41675 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41676 .endd
41677
41678 To produce the required public key value for a DNS record:
41679 .code
41680 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41681 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41682 .endd
41683
41684 Exim also supports an alternate format
41685 of Ed25519 keys in DNS which was a candidate during development
41686 of the standard, but not adopted.
41687 A future release will probably drop that support.
41688
41689 .option dkim_hash smtp string&!! sha256
41690 Can be set to any one of the supported hash methods, which are:
41691 .ilist
41692 &`sha1`& &-- should not be used, is old and insecure
41693 .next
41694 &`sha256`& &-- the default
41695 .next
41696 &`sha512`& &-- possibly more secure but less well supported
41697 .endlist
41698
41699 Note that RFC 8301 says:
41700 .code
41701 rsa-sha1 MUST NOT be used for signing or verifying.
41702 .endd
41703
41704 .option dkim_identity smtp string&!! unset
41705 If set after expansion, the value is used to set an "i=" tag in
41706 the signing header.  The DKIM standards restrict the permissible
41707 syntax of this optional tag to a mail address, with possibly-empty
41708 local part, an @, and a domain identical to or subdomain of the "d="
41709 tag value.  Note that Exim does not check the value.
41710
41711 .option dkim_canon smtp string&!! unset
41712 This option sets the canonicalization method used when signing a message.
41713 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41714 The option defaults to "relaxed" when unset. Note: the current implementation
41715 only supports signing with the same canonicalization method for both headers and body.
41716
41717 .option dkim_strict smtp string&!! unset
41718 This  option  defines  how  Exim  behaves  when  signing a message that
41719 should be signed fails for some reason.  When the expansion evaluates to
41720 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41721 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41722 variables here.
41723
41724 .option dkim_sign_headers smtp string&!! "see below"
41725 If set, this option must expand to a colon-separated
41726 list of header names.
41727 Headers with these names, or the absence of such a header, will be included
41728 in the message signature.
41729 When unspecified, the header names listed in RFC4871 will be used,
41730 whether or not each header is present in the message.
41731 The default list is available for the expansion in the macro
41732 &"_DKIM_SIGN_HEADERS"&
41733 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41734
41735 If a name is repeated, multiple headers by that name (or the absence thereof)
41736 will be signed.  The textually later headers in the headers part of the
41737 message are signed first, if there are multiples.
41738
41739 A name can be prefixed with either an &"="& or a &"+"& character.
41740 If an &"="& prefix is used, all headers that are present with this name
41741 will be signed.
41742 If a &"+"& prefix if used, all headers that are present with this name
41743 will be signed, and one signature added for a missing header with the
41744 name will be appended.
41745
41746 .option dkim_timestamps smtp integer&!! unset
41747 This option controls the inclusion of timestamp information in the signature.
41748 If not set, no such information will be included.
41749 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41750 for the expiry tag
41751 (eg. 1209600 for two weeks);
41752 both creation (t=) and expiry (x=) tags will be included.
41753
41754 RFC 6376 lists these tags as RECOMMENDED.
41755
41756
41757 .subsection "Verifying DKIM signatures in incoming mail" SECDKIMVFY
41758 .cindex DKIM verification
41759
41760 Verification of DKIM signatures in SMTP incoming email is done for all
41761 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41762
41763 .cindex DKIM "selecting signature algorithms"
41764 Individual classes of DKIM signature algorithm can be ignored by changing
41765 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41766 The &%dkim_verify_minimal%& option can be set to cease verification
41767 processing for a message once the first passing signature is found.
41768
41769 .cindex authentication "expansion item"
41770 Performing verification sets up information used by the
41771 &%authresults%& expansion item.
41772
41773 For most purposes the default option settings suffice and the remainder
41774 of this section can be ignored.
41775
41776 The results of verification are made available to the
41777 &%acl_smtp_dkim%& ACL, which (for complex needs) can examine and modify them.
41778 A missing ACL definition defaults to accept.
41779 By default, the ACL is called once for each
41780 syntactically(!) correct signature in the incoming message.
41781 If any ACL call does not accept, the message is not accepted.
41782 If a cutthrough delivery was in progress for the message, that is
41783 summarily dropped (having wasted the transmission effort).
41784
41785 To evaluate the verification result in the ACL
41786 a large number of expansion variables
41787 containing the signature status and its details are set up during the
41788 runtime of the ACL.
41789
41790 Calling the ACL only for existing signatures is not sufficient to build
41791 more advanced policies. For that reason, the main option
41792 &%dkim_verify_signers%&, and an expansion variable
41793 &%$dkim_signers%& exist.
41794
41795 The main option &%dkim_verify_signers%& can be set to a colon-separated
41796 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41797 called. It is expanded when the message has been received. At this point,
41798 the expansion variable &%$dkim_signers%& already contains a colon-separated
41799 list of signer domains and identities for the message. When
41800 &%dkim_verify_signers%& is not specified in the main configuration,
41801 it defaults as:
41802 .code
41803 dkim_verify_signers = $dkim_signers
41804 .endd
41805 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41806 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41807 call the ACL for known domains or identities. This would be achieved as follows:
41808 .code
41809 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41810 .endd
41811 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41812 and "ebay.com", plus all domains and identities that have signatures in the message.
41813 You can also be more creative in constructing your policy. For example:
41814 .code
41815 dkim_verify_signers = $sender_address_domain:$dkim_signers
41816 .endd
41817
41818 If a domain or identity is listed several times in the (expanded) value of
41819 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41820
41821 Note that if the option is set using untrustworthy data
41822 (such as the From: header)
41823 care should be taken to force lowercase for domains
41824 and for the domain part if identities.
41825 The default setting can be regarded as trustworthy in this respect.
41826
41827 If multiple signatures match a domain (or identity), the ACL is called once
41828 for each matching signature.
41829
41830
41831 Inside the DKIM ACL, the following expansion variables are
41832 available (from most to least important):
41833
41834
41835 .vlist
41836 .vitem &%$dkim_cur_signer%&
41837 The signer that is being evaluated in this ACL run. This can be a domain or
41838 an identity. This is one of the list items from the expanded main option
41839 &%dkim_verify_signers%& (see above).
41840
41841 .vitem &%$dkim_verify_status%&
41842 So long as a DKIM ACL is defined
41843 (it need do no more than accept, which is the default),
41844 after all the DKIM ACL runs have completed, the value becomes a
41845 colon-separated list of the values after each run.
41846 The value is maintained for the MIME, PRDR and DATA ACLs.
41847
41848 Within the DKIM ACL,
41849 a string describing the general status of the signature. One of
41850 .ilist
41851 &%none%&: There is no signature in the message for the current domain or
41852 identity (as reflected by &%$dkim_cur_signer%&).
41853 .next
41854 &%invalid%&: The signature could not be verified due to a processing error.
41855 More detail is available in &%$dkim_verify_reason%&.
41856 .next
41857 &%fail%&: Verification of the signature failed.  More detail is
41858 available in &%$dkim_verify_reason%&.
41859 .next
41860 &%pass%&: The signature passed verification. It is valid.
41861 .endlist
41862
41863 This variable can be overwritten using an ACL 'set' modifier.
41864 This might, for instance, be done to enforce a policy restriction on
41865 hash-method or key-size:
41866 .code
41867   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41868        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41869        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41870                                   {< {$dkim_key_length}{1024}}}}
41871        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41872        set dkim_verify_status = fail
41873        set dkim_verify_reason = hash too weak or key too short
41874 .endd
41875
41876 .vitem &%$dkim_verify_reason%&
41877 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41878 "fail" or "invalid". One of
41879 .ilist
41880 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41881 key for the domain could not be retrieved. This may be a temporary problem.
41882 .next
41883 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41884 record for the domain is syntactically invalid.
41885 .next
41886 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41887 body hash does not match the one specified in the signature header. This
41888 means that the message body was modified in transit.
41889 .next
41890 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41891 could not be verified. This may mean that headers were modified,
41892 re-written or otherwise changed in a way which is incompatible with
41893 DKIM verification. It may of course also mean that the signature is forged.
41894 .endlist
41895
41896 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41897
41898 .vitem &%$dkim_domain%&
41899 The signing domain. IMPORTANT: This variable is only populated if there is
41900 an actual signature in the message for the current domain or identity (as
41901 reflected by &%$dkim_cur_signer%&).
41902
41903 .vitem &%$dkim_identity%&
41904 The signing identity, if present. IMPORTANT: This variable is only populated
41905 if there is an actual signature in the message for the current domain or
41906 identity (as reflected by &%$dkim_cur_signer%&).
41907
41908 .vitem &%$dkim_selector%&
41909 The key record selector string.
41910
41911 .vitem &%$dkim_algo%&
41912 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41913 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41914 may also be 'ed25519-sha256'.
41915 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41916 for EC keys.
41917
41918 Note that RFC 8301 says:
41919 .code
41920 rsa-sha1 MUST NOT be used for signing or verifying.
41921
41922 DKIM signatures identified as having been signed with historic
41923 algorithms (currently, rsa-sha1) have permanently failed evaluation
41924 .endd
41925
41926 To enforce this you must either have a DKIM ACL which checks this variable
41927 and overwrites the &$dkim_verify_status$& variable as discussed above,
41928 or have set the main option &%dkim_verify_hashes%& to exclude
41929 processing of such signatures.
41930
41931 .vitem &%$dkim_canon_body%&
41932 The body canonicalization method. One of 'relaxed' or 'simple'.
41933
41934 .vitem &%$dkim_canon_headers%&
41935 The header canonicalization method. One of 'relaxed' or 'simple'.
41936
41937 .vitem &%$dkim_copiedheaders%&
41938 A transcript of headers and their values which are included in the signature
41939 (copied from the 'z=' tag of the signature).
41940 Note that RFC6376 requires that verification fail if the From: header is
41941 not included in the signature.  Exim does not enforce this; sites wishing
41942 strict enforcement should code the check explicitly.
41943
41944 .vitem &%$dkim_bodylength%&
41945 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41946 limit was set by the signer, "9999999999999" is returned. This makes sure
41947 that this variable always expands to an integer value.
41948 &*Note:*& The presence of the signature tag specifying a signing body length
41949 is one possible route to spoofing of valid DKIM signatures.
41950 A paranoid implementation might wish to regard signature where this variable
41951 shows less than the "no limit" return as being invalid.
41952
41953 .vitem &%$dkim_created%&
41954 UNIX timestamp reflecting the date and time when the signature was created.
41955 When this was not specified by the signer, "0" is returned.
41956
41957 .vitem &%$dkim_expires%&
41958 UNIX timestamp reflecting the date and time when the signer wants the
41959 signature to be treated as "expired". When this was not specified by the
41960 signer, "9999999999999" is returned. This makes it possible to do useful
41961 integer size comparisons against this value.
41962 Note that Exim does not check this value.
41963
41964 .vitem &%$dkim_headernames%&
41965 A colon-separated list of names of headers included in the signature.
41966
41967 .vitem &%$dkim_key_testing%&
41968 "1" if the key record has the "testing" flag set, "0" if not.
41969
41970 .vitem &%$dkim_key_nosubdomains%&
41971 "1" if the key record forbids subdomaining, "0" otherwise.
41972
41973 .vitem &%$dkim_key_srvtype%&
41974 Service type (tag s=) from the key record. Defaults to "*" if not specified
41975 in the key record.
41976
41977 .vitem &%$dkim_key_granularity%&
41978 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41979 in the key record.
41980
41981 .vitem &%$dkim_key_notes%&
41982 Notes from the key record (tag n=).
41983
41984 .vitem &%$dkim_key_length%&
41985 Number of bits in the key.
41986 Valid only once the key is loaded, which is at the time the header signature
41987 is verified, which is after the body hash is.
41988
41989 Note that RFC 8301 says:
41990 .code
41991 Verifiers MUST NOT consider signatures using RSA keys of
41992 less than 1024 bits as valid signatures.
41993 .endd
41994
41995 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41996 option.
41997
41998 .endlist
41999
42000 In addition, two ACL conditions are provided:
42001
42002 .vlist
42003 .vitem &%dkim_signers%&
42004 ACL condition that checks a colon-separated list of domains or identities
42005 for a match against the domain or identity that the ACL is currently verifying
42006 (reflected by &%$dkim_cur_signer%&).
42007 This condition is only usable in a DKIM ACL.
42008 This is typically used to restrict an ACL
42009 verb to a group of domains or identities. For example:
42010
42011 .code
42012 # Warn when Mail purportedly from GMail has no gmail signature
42013 warn sender_domains = gmail.com
42014      dkim_signers = gmail.com
42015      dkim_status = none
42016      log_message = GMail sender without gmail.com DKIM signature
42017 .endd
42018
42019 Note that the above does not check for a total lack of DKIM signing;
42020 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
42021
42022 .vitem &%dkim_status%&
42023 ACL condition that checks a colon-separated list of possible DKIM verification
42024 results against the actual result of verification,
42025 given by &$dkim_verify_status$& if that is non-empty or "none" if empty.
42026 .new
42027 This condition may be used in DKIM, MIME, PRDR and DATA ACLs.
42028 .wen
42029
42030 A basic verification might be:
42031 .code
42032 deny !dkim_status = pass:none:invalid
42033 .endd
42034
42035 A more complex use could be
42036 to restrict an ACL verb to a list of verification outcomes, for example:
42037
42038 .code
42039 deny sender_domains = paypal.com:paypal.de
42040      dkim_signers = paypal.com:paypal.de
42041      dkim_status = none:invalid:fail
42042      message = Mail from Paypal with invalid/missing signature
42043 .endd
42044
42045 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
42046 see the documentation of the &%$dkim_verify_status%& expansion variable above
42047 for more information of what they mean.
42048
42049 The condition is true if the status
42050 .new
42051 (or any of the list of status values)
42052 .wen
42053 is any one of the supplied list.
42054 .endlist
42055
42056
42057
42058
42059 .section "SPF (Sender Policy Framework)" SECSPF
42060 .cindex SPF verification
42061
42062 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
42063 messages with its domain in the envelope from, documented by RFC 7208.
42064 For more information on SPF see &url(http://www.open-spf.org), a static copy of
42065 the &url(http://openspf.org).
42066 . --- 2019-10-28: still not https, open-spf.org is told to be a
42067 . --- web-archive copy of the now dead openspf.org site
42068 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
42069 . --- discussion.
42070
42071 Messages sent by a system not authorised will fail checking of such assertions.
42072 This includes retransmissions done by traditional forwarders.
42073
42074 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
42075 &_Local/Makefile_&.  The support uses the &_libspf2_& library
42076 &url(https://www.libspf2.org/).
42077 There is no Exim involvement in the transmission of messages;
42078 publishing certain DNS records is all that is required.
42079
42080 For verification, an ACL condition and an expansion lookup are provided.
42081 .cindex authentication "expansion item"
42082 Performing verification sets up information used by the
42083 &%authresults%& expansion item.
42084
42085
42086 .cindex SPF "ACL condition"
42087 .cindex ACL "spf condition"
42088 The ACL condition "spf" can be used at or after the MAIL ACL.
42089 It takes as an argument a list of strings giving the outcome of the SPF check,
42090 and will succeed for any matching outcome.
42091 Valid strings are:
42092 .vlist
42093 .vitem &%pass%&
42094 The SPF check passed, the sending host is positively verified by SPF.
42095
42096 .vitem &%fail%&
42097 The SPF check failed, the sending host is NOT allowed to send mail for the
42098 domain in the envelope-from address.
42099
42100 .vitem &%softfail%&
42101 The SPF check failed, but the queried domain can't absolutely confirm that this
42102 is a forgery.
42103
42104 .vitem &%none%&
42105 The queried domain does not publish SPF records.
42106
42107 .vitem &%neutral%&
42108 The SPF check returned a "neutral" state.  This means the queried domain has
42109 published a SPF record, but wants to allow outside servers to send mail under
42110 its domain as well.  This should be treated like "none".
42111
42112 .vitem &%permerror%&
42113 This indicates a syntax error in the SPF record of the queried domain.
42114 You may deny messages when this occurs.
42115
42116 .vitem &%temperror%&
42117 This indicates a temporary error during all processing, including Exim's
42118 SPF processing.  You may defer messages when this occurs.
42119
42120 .vitem &%invalid%&
42121 There was an error during processing of the SPF lookup
42122 .endlist
42123
42124 You can prefix each string with an exclamation mark to  invert
42125 its meaning,  for example  "!fail" will  match all  results but
42126 "fail".  The  string  list is  evaluated  left-to-right,  in a
42127 short-circuit fashion.
42128
42129 Example:
42130 .code
42131 deny spf = fail
42132      message = $sender_host_address is not allowed to send mail from \
42133                ${if def:sender_address_domain \
42134                     {$sender_address_domain}{$sender_helo_name}}.  \
42135                Please see http://www.open-spf.org/Why;\
42136                identity=${if def:sender_address_domain \
42137                              {$sender_address}{$sender_helo_name}};\
42138                ip=$sender_host_address
42139 .endd
42140
42141 Note: The above mentioned URL may not be as helpful as expected. You are
42142 encouraged to replace the link with a link to a site with more
42143 explanations.
42144
42145 When the spf condition has run, it sets up several expansion
42146 variables:
42147
42148 .cindex SPF "verification variables"
42149 .vlist
42150 .vitem &$spf_header_comment$&
42151 .vindex &$spf_header_comment$&
42152   This contains a human-readable string describing the outcome
42153   of the SPF check. You can add it to a custom header or use
42154   it for logging purposes.
42155
42156 .vitem &$spf_received$&
42157 .vindex &$spf_received$&
42158   This contains a complete Received-SPF: header (name and
42159   content) that can be added to the message. Please note that
42160   according to the SPF draft, this header must be added at the
42161   top of the header list, i.e. with
42162 .code
42163 add_header = :at_start:$spf_received
42164 .endd
42165   See section &<<SECTaddheadacl>>& for further details.
42166
42167   Note: in case of "Best-guess" (see below), the convention is
42168   to put this string in a header called X-SPF-Guess: instead.
42169
42170 .vitem &$spf_result$&
42171 .vindex &$spf_result$&
42172   This contains the outcome of the SPF check in string form,
42173   currently one of pass, fail, softfail, none, neutral, permerror,
42174   temperror, or &"(invalid)"&.
42175
42176 .vitem &$spf_result_guessed$&
42177 .vindex &$spf_result_guessed$&
42178   This boolean is true only if a best-guess operation was used
42179   and required in order to obtain a result.
42180
42181 .vitem &$spf_smtp_comment$&
42182 .vindex &$spf_smtp_comment$&
42183 .vindex &%spf_smtp_comment_template%&
42184   This contains a string that can be used in a SMTP response
42185   to the calling party. Useful for "fail".
42186   The string is generated by the SPF library from the template configured in the main config
42187   option &%spf_smtp_comment_template%&.
42188 .endlist
42189
42190
42191 .cindex SPF "ACL condition"
42192 .cindex ACL "spf_guess condition"
42193 .cindex SPF "best guess"
42194 In addition to SPF, you can also perform checks for so-called
42195 "Best-guess".  Strictly speaking, "Best-guess" is not standard
42196 SPF, but it is supported by the same framework that enables SPF
42197 capability.
42198 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
42199 for a description of what it means.
42200 . --- 2019-10-28: still not https:
42201
42202 To access this feature, simply use the spf_guess condition in place
42203 of the spf one.  For example:
42204
42205 .code
42206 deny spf_guess = fail
42207      message = $sender_host_address doesn't look trustworthy to me
42208 .endd
42209
42210 In case you decide to reject messages based on this check, you
42211 should note that although it uses the same framework, "Best-guess"
42212 is not SPF, and therefore you should not mention SPF at all in your
42213 reject message.
42214
42215 When the spf_guess condition has run, it sets up the same expansion
42216 variables as when spf condition is run, described above.
42217
42218 Additionally, since Best-guess is not standardized, you may redefine
42219 what "Best-guess" means to you by redefining the main configuration
42220 &%spf_guess%& option.
42221 For example, the following:
42222
42223 .code
42224 spf_guess = v=spf1 a/16 mx/16 ptr ?all
42225 .endd
42226
42227 would relax host matching rules to a broader network range.
42228
42229
42230 .cindex SPF "lookup expansion"
42231 .cindex lookup spf
42232 A lookup expansion is also available. It takes an email
42233 address as the key and an IP address
42234 (v4 or v6)
42235 as the database:
42236
42237 .code
42238   ${lookup {username@domain} spf {ip.ip.ip.ip}}
42239 .endd
42240
42241 The lookup will return the same result strings as can appear in
42242 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
42243
42244
42245
42246
42247
42248 .subsection "SRS (Sender Rewriting Scheme)" SECTSRS
42249 .cindex SRS "sender rewriting scheme"
42250
42251 SRS can be used to modify sender addresses when forwarding so that
42252 SPF verification does not object to them.
42253 It operates by encoding the original envelope sender in a new
42254 sender local part and using a domain run by the forwarding site
42255 as the new domain for the sender.  Any DSN message should be returned
42256 to this new sender at the forwarding site, which can extract the
42257 original sender from the coded local part and forward the DSN to
42258 the originator.
42259
42260 This is a way of avoiding the breakage that SPF does to forwarding.
42261 The constructed local-part will be longer than the original,
42262 leading to possible problems with very long addresses.
42263 The changing of the sender address also hinders the tracing of mail
42264 problems.
42265
42266 Exim can be built to include native SRS support.  To do this
42267 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
42268 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
42269 will be defined.
42270 The support is limited to SRS0-encoding; SRS1 is not supported.
42271
42272 .cindex SRS excoding
42273 To encode an address use this expansion item:
42274 .vlist
42275 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
42276 .cindex "&%srs_encode%& expansion item"
42277 .cindex SRS "expansion item"
42278 The first argument should be a secret known and used by all systems
42279 handling the recipient domain for the original message.
42280 There is no need to periodically change this key; a timestamp is also
42281 encoded.
42282 The second argument should be given as the envelope sender address before this
42283 encoding operation.
42284 If this value is empty the the expansion result will be empty.
42285 The third argument should be the recipient domain of the message when
42286 it arrived at this system.
42287 All arguments are expanded before use.
42288
42289 The result of the expansion is the replacement envelope-from (return path)
42290 to be used.
42291 .endlist
42292
42293 .cindex SRS decoding
42294 To decode an address use this expansion condition:
42295 .vlist
42296 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
42297 The first argument should be the recipient local part as it was received.
42298 The second argument is the site secret.
42299 Both arguments are expanded before use.
42300
42301 If the messages is not for an SRS-encoded recipient the condition will
42302 return false.
42303 If it is, the condition will return true and the variable
42304 &$srs_recipient$& will be set to the decoded (original) value.
42305
42306 If the second argument is empty then the condition returns true if
42307 the first argument is in valid SRS formet, else false.
42308 The variable &$srs_recipient$& is not set for this case.
42309 .endlist
42310
42311 Example usage:
42312 .code
42313   #macro
42314   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
42315
42316   #routers
42317
42318   outbound:
42319     driver =    dnslookup
42320     # if outbound, and forwarding has been done, use an alternate transport
42321     domains =   ! +my_domains
42322     transport = ${if eq {$local_part@$domain} \
42323                         {$original_local_part@$original_domain} \
42324                      {remote_smtp} {remote_forwarded_smtp}}
42325
42326   inbound_srs:
42327     driver =    redirect
42328     senders =   :
42329     domains =   +my_domains
42330     # detect inbound bounces which are SRS'd, and decode them
42331     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
42332     data =      $srs_recipient
42333
42334   inbound_srs_failure:
42335     driver =    redirect
42336     senders =   :
42337     domains =   +my_domains
42338     # detect inbound bounces which look SRS'd but are invalid
42339     condition = ${if inbound_srs {$local_part} {}}
42340     allow_fail
42341     data =      :fail: Invalid SRS recipient address
42342
42343   #... further routers here
42344
42345
42346   # transport; should look like the non-forward outbound
42347   # one, plus the max_rcpt and return_path options
42348   remote_forwarded_smtp:
42349     driver =              smtp
42350     # single-recipient so that $original_domain is valid
42351     max_rcpt =            1
42352     # modify the envelope from, for mails that we forward
42353     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
42354 .endd
42355
42356
42357
42358
42359
42360 .section DMARC SECDMARC
42361 .cindex DMARC verification
42362
42363 DMARC combines feedback from SPF, DKIM, and header From: in order
42364 to attempt to provide better indicators of the authenticity of an
42365 email.  This document does not explain the fundamentals; you
42366 should read and understand how it works by visiting the website at
42367 &url(http://www.dmarc.org/).
42368
42369 If Exim is built with DMARC support,
42370 the libopendmarc library is used.
42371
42372 For building Exim yourself, obtain the library from
42373 &url(http://sourceforge.net/projects/opendmarc/)
42374 to obtain a copy, or find it in your favorite package
42375 repository.  You will need to attend to the local/Makefile feature
42376 SUPPORT_DMARC and the associated LDFLAGS addition.
42377 This description assumes
42378 that headers will be in /usr/local/include, and that the libraries
42379 are in /usr/local/lib.
42380
42381 .subsection Configuration SSECDMARCCONFIG
42382 .cindex DMARC configuration
42383
42384 There are three main-configuration options:
42385 .cindex DMARC "configuration options"
42386
42387 The &%dmarc_tld_file%& option
42388 .oindex &%dmarc_tld_file%&
42389 defines the location of a text file of valid
42390 top level domains the opendmarc library uses
42391 during domain parsing. Maintained by Mozilla,
42392 the most current version can be downloaded
42393 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
42394 See also the util/renew-opendmarc-tlds.sh script.
42395 The default for the option is unset.
42396 If not set, DMARC processing is disabled.
42397
42398
42399 The &%dmarc_history_file%& option, if set
42400 .oindex &%dmarc_history_file%&
42401 defines the location of a file to log results
42402 of dmarc verification on inbound emails. The
42403 contents are importable by the opendmarc tools
42404 which will manage the data, send out DMARC
42405 reports, and expire the data. Make sure the
42406 directory of this file is writable by the user
42407 exim runs as.
42408 The default is unset.
42409
42410 The &%dmarc_forensic_sender%& option
42411 .oindex &%dmarc_forensic_sender%&
42412 defines an alternate email address to use when sending a
42413 forensic report detailing alignment failures
42414 if a sender domain's dmarc record specifies it
42415 and you have configured Exim to send them.
42416 If set, this is expanded and used for the
42417 From: header line; the address is extracted
42418 from it and used for the envelope from.
42419 If not set (the default), the From: header is expanded from
42420 the dsn_from option, and <> is used for the
42421 envelope from.
42422
42423 .subsection Controls SSECDMARCCONTROLS
42424 .cindex DMARC controls
42425
42426 By default, the DMARC processing will run for any remote,
42427 non-authenticated user.  It makes sense to only verify DMARC
42428 status of messages coming from remote, untrusted sources.  You can
42429 use standard conditions such as hosts, senders, etc, to decide that
42430 DMARC verification should *not* be performed for them and disable
42431 DMARC with an ACL control modifier:
42432 .code
42433   control = dmarc_disable_verify
42434 .endd
42435 A DMARC record can also specify a "forensic address", which gives
42436 exim an email address to submit reports about failed alignment.
42437 Exim does not do this by default because in certain conditions it
42438 results in unintended information leakage (what lists a user might
42439 be subscribed to, etc).  You must configure exim to submit forensic
42440 reports to the owner of the domain.  If the DMARC record contains a
42441 forensic address and you specify the control statement below, then
42442 exim will send these forensic emails.  It is also advised that you
42443 configure a &%dmarc_forensic_sender%& because the default sender address
42444 construction might be inadequate.
42445 .code
42446   control = dmarc_enable_forensic
42447 .endd
42448 (AGAIN: You can choose not to send these forensic reports by simply
42449 not putting the dmarc_enable_forensic control line at any point in
42450 your exim config.  If you don't tell exim to send them, it will not
42451 send them.)
42452
42453 There are no options to either control.  Both must appear before
42454 the DATA acl.
42455
42456 .subsection ACL SSECDMARCACL
42457 .cindex DMARC "ACL condition"
42458
42459 DMARC checks can be run on incoming SMTP  messages by using the
42460 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42461 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42462 condition.  Putting this condition in the ACLs is required in order
42463 for a DMARC check to actually occur.  All of the variables are set
42464 up before the DATA ACL, but there is no actual DMARC check that
42465 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42466
42467 The &"dmarc_status"& condition takes a list of strings on its
42468 right-hand side.  These strings describe recommended action based
42469 on the DMARC check.  To understand what the policy recommendations
42470 mean, refer to the DMARC website above.  Valid strings are:
42471 .itable none 0 0 2 20* left 80* left
42472 .irow &'accept'&        "The DMARC check passed and the library recommends accepting the email"
42473 .irow &'reject'&        "The DMARC check failed and the library recommends rejecting the email"
42474 .irow &'quarantine'&    "The DMARC check failed and the library recommends keeping it for further inspection"
42475 .irow &'none'&          "The DMARC check passed and the library recommends no specific action, neutral"
42476 .irow &'norecord'&      "No policy section in the DMARC record for this RFC5322.From field"
42477 .irow &'nofrom'&        "Unable to determine the domain of the sender"
42478 .irow &'temperror'&     "Library error or dns error"
42479 .irow &'off'&           "The DMARC check was disabled for this email"
42480 .endtable
42481 You can prefix each string with an exclamation mark to invert its
42482 meaning, for example "!accept" will match all results but
42483 "accept".  The string list is evaluated left-to-right in a
42484 short-circuit fashion.  When a string matches the outcome of the
42485 DMARC check, the condition succeeds.  If none of the listed
42486 strings matches the outcome of the DMARC check, the condition
42487 fails.
42488
42489 Of course, you can also use any other lookup method that Exim
42490 supports, including LDAP, Postgres, MySQL, etc, as long as the
42491 result is a list of colon-separated strings.
42492
42493 Performing the check sets up information used by the
42494 &%authresults%& expansion item.
42495
42496 Several expansion variables are set before the DATA ACL is
42497 processed, and you can use them in this ACL.  The following
42498 expansion variables are available:
42499
42500 .vlist
42501 .vitem &$dmarc_status$&
42502 .vindex &$dmarc_status$&
42503 .cindex DMARC result
42504 A one word status indicating what the DMARC library
42505 thinks of the email.  It is a combination of the results of
42506 DMARC record lookup and the SPF/DKIM/DMARC processing results
42507 (if a DMARC record was found).  The actual policy declared
42508 in the DMARC record is in a separate expansion variable.
42509
42510 .vitem &$dmarc_status_text$&
42511 .vindex &$dmarc_status_text$&
42512 Slightly longer, human readable status.
42513
42514 .vitem &$dmarc_used_domain$&
42515 .vindex &$dmarc_used_domain$&
42516 The domain which DMARC used to look up the DMARC policy record.
42517
42518 .vitem &$dmarc_domain_policy$&
42519 .vindex &$dmarc_domain_policy$&
42520 The policy declared in the DMARC record.  Valid values
42521 are "none", "reject" and "quarantine".  It is blank when there
42522 is any error, including no DMARC record.
42523 .endlist
42524
42525 .subsection Logging SSECDMARCLOGGING
42526 .cindex DMARC logging
42527
42528 By default, Exim's DMARC configuration is intended to be
42529 non-intrusive and conservative.  To facilitate this, Exim will not
42530 create any type of logging files without explicit configuration by
42531 you, the admin.  Nor will Exim send out any emails/reports about
42532 DMARC issues without explicit configuration by you, the admin (other
42533 than typical bounce messages that may come about due to ACL
42534 processing or failure delivery issues).
42535
42536 In order to log statistics suitable to be imported by the opendmarc
42537 tools, you need to:
42538 .ilist
42539 Configure the global option &%dmarc_history_file%&
42540 .next
42541 Configure cron jobs to call the appropriate opendmarc history
42542 import scripts and truncating the dmarc_history_file
42543 .endlist
42544
42545 In order to send forensic reports, you need to:
42546 .ilist
42547 Configure the global option &%dmarc_forensic_sender%&
42548 .next
42549 Configure, somewhere before the DATA ACL, the control option to
42550 enable sending DMARC forensic reports
42551 .endlist
42552
42553 .subsection Example SSECDMARCEXAMPLE
42554 .cindex DMARC example
42555
42556 Example usage:
42557 .code
42558 (RCPT ACL)
42559   warn    domains        = +local_domains
42560           hosts          = +local_hosts
42561           control        = dmarc_disable_verify
42562
42563   warn    !domains       = +screwed_up_dmarc_records
42564           control        = dmarc_enable_forensic
42565
42566   warn    condition      = (lookup if destined to mailing list)
42567           set acl_m_mailing_list = 1
42568
42569 (DATA ACL)
42570   warn    dmarc_status   = accept : none : off
42571           !authenticated = *
42572           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42573
42574   warn    dmarc_status   = !accept
42575           !authenticated = *
42576           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42577
42578   warn    dmarc_status   = quarantine
42579           !authenticated = *
42580           set $acl_m_quarantine = 1
42581           # Do something in a transport with this flag variable
42582
42583   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42584           condition      = ${if eq{$acl_m_mailing_list}{1}}
42585           message        = Messages from $dmarc_used_domain break mailing lists
42586
42587   deny    dmarc_status   = reject
42588           !authenticated = *
42589           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42590
42591   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42592 .endd
42593
42594
42595
42596
42597
42598 . ////////////////////////////////////////////////////////////////////////////
42599 . ////////////////////////////////////////////////////////////////////////////
42600
42601 .chapter "Proxies" "CHAPproxies" &&&
42602          "Proxy support"
42603 .cindex "proxy support"
42604 .cindex "proxy" "access via"
42605
42606 A proxy is an intermediate system through which communication is passed.
42607 Proxies may provide a security, availability or load-distribution function.
42608
42609
42610 .section "Inbound proxies" SECTproxyInbound
42611 .cindex proxy inbound
42612 .cindex proxy "server side"
42613 .cindex proxy "Proxy protocol"
42614 .cindex "Proxy protocol" proxy
42615
42616 Exim has support for receiving inbound SMTP connections via a proxy
42617 that uses &"Proxy Protocol"& to speak to it.
42618 To include this support, include &"SUPPORT_PROXY=yes"&
42619 in Local/Makefile.
42620
42621 It was built on the HAProxy specification, found at
42622 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42623
42624 The purpose of this facility is so that an application load balancer,
42625 such as HAProxy, can sit in front of several Exim servers
42626 to distribute load.
42627 Exim uses the local protocol communication with the proxy to obtain
42628 the remote SMTP system IP address and port information.
42629 There is no logging if a host passes or
42630 fails Proxy Protocol negotiation, but it can easily be determined and
42631 recorded in an ACL (example is below).
42632
42633 Use of a proxy is enabled by setting the &%hosts_proxy%&
42634 main configuration option to a hostlist; connections from these
42635 hosts will use Proxy Protocol.
42636 Exim supports both version 1 and version 2 of the Proxy Protocol and
42637 automatically determines which version is in use.
42638
42639 The Proxy Protocol header is the first data received on a TCP connection
42640 and is inserted before any TLS-on-connect handshake from the client; Exim
42641 negotiates TLS between Exim-as-server and the remote client, not between
42642 Exim and the proxy server. The Proxy Protocol header must be received
42643 within &%proxy_protocol_timeout%&, which defaults to 3s.
42644
42645 The following expansion variables are usable
42646 (&"internal"& and &"external"& here refer to the interfaces
42647 of the proxy):
42648 .itable none 0 0 2 30* left 70* left
42649 .irow $proxy_external_address   "IP of host being proxied or IP of remote interface of proxy"
42650 .irow $proxy_external_port      "Port of host being proxied or Port on remote interface of proxy"
42651 .irow $proxy_local_address      "IP of proxy server inbound or IP of local interface of proxy"
42652 .irow $proxy_local_port         "Port of proxy server inbound or Port on local interface of proxy"
42653 .irow $proxy_session            "boolean: SMTP connection via proxy"
42654 .endtable
42655 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42656 there was a protocol error.
42657 The variables &$sender_host_address$& and &$sender_host_port$&
42658 will have values for the actual client system, not the proxy.
42659
42660 Since the real connections are all coming from the proxy, and the
42661 per host connection tracking is done before Proxy Protocol is
42662 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42663 handle all of the parallel volume you expect per inbound proxy.
42664 With the option set so high, you lose the ability
42665 to protect your server from many connections from one IP.
42666 In order to prevent your server from overload, you
42667 need to add a per connection ratelimit to your connect ACL.
42668 A possible solution is:
42669 .display
42670   # Set max number of connections per host
42671   LIMIT   = 5
42672   # Or do some kind of IP lookup in a flat file or database
42673   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42674
42675   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42676           message        = Too many connections from this IP right now
42677 .endd
42678
42679
42680
42681 .section "Outbound proxies" SECTproxySOCKS
42682 .cindex proxy outbound
42683 .cindex proxy "client side"
42684 .cindex proxy SOCKS
42685 .cindex SOCKS proxy
42686 Exim has support for sending outbound SMTP via a proxy
42687 using a protocol called SOCKS5 (defined by RFC1928).
42688 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42689 Local/Makefile.
42690
42691 Use of a proxy is enabled by setting the &%socks_proxy%& option
42692 on an smtp transport.
42693 The option value is expanded and should then be a list
42694 (colon-separated by default) of proxy specifiers.
42695 Each proxy specifier is a list
42696 (space-separated by default) where the initial element
42697 is an IP address and any subsequent elements are options.
42698
42699 Options are a string <name>=<value>.
42700 The list of options is in the following table:
42701 .itable none 0 0 2 10* left 90* left
42702 .irow &'auth'&  "authentication method"
42703 .irow &'name'&  "authentication username"
42704 .irow &'pass'&  "authentication password"
42705 .irow &'port'&  "tcp port"
42706 .irow &'tmo'&   "connection timeout"
42707 .irow &'pri'&   "priority"
42708 .irow &'weight'& "selection bias"
42709 .endtable
42710
42711 More details on each of these options follows:
42712
42713 .ilist
42714 .cindex authentication "to proxy"
42715 .cindex proxy authentication
42716 &%auth%&: Either &"none"& (default) or &"name"&.
42717 Using &"name"& selects username/password authentication per RFC 1929
42718 for access to the proxy.
42719 Default is &"none"&.
42720 .next
42721 &%name%&: sets the username for the &"name"& authentication method.
42722 Default is empty.
42723 .next
42724 &%pass%&: sets the password for the &"name"& authentication method.
42725 Default is empty.
42726 .next
42727 &%port%&: the TCP port number to use for the connection to the proxy.
42728 Default is 1080.
42729 .next
42730 &%tmo%&: sets a connection timeout in seconds for this proxy.
42731 Default is 5.
42732 .next
42733 &%pri%&: specifies a priority for the proxy within the list,
42734 higher values being tried first.
42735 The default priority is 1.
42736 .next
42737 &%weight%&: specifies a selection bias.
42738 Within a priority set servers are queried in a random fashion,
42739 weighted by this value.
42740 The default value for selection bias is 1.
42741 .endlist
42742
42743 Proxies from the list are tried according to their priority
42744 and weight settings until one responds.  The timeout for the
42745 overall connection applies to the set of proxied attempts.
42746
42747 .section Logging SECTproxyLog
42748 To log the (local) IP of a proxy in the incoming or delivery logline,
42749 add &"+proxy"& to the &%log_selector%& option.
42750 This will add a component tagged with &"PRX="& to the line.
42751
42752 . ////////////////////////////////////////////////////////////////////////////
42753 . ////////////////////////////////////////////////////////////////////////////
42754
42755 .chapter "Internationalisation" "CHAPi18n" &&&
42756          "Internationalisation""
42757 .cindex internationalisation "email address"
42758 .cindex EAI
42759 .cindex i18n
42760 .cindex utf8 "mail name handling"
42761
42762 Exim has support for Internationalised mail names.
42763 To include this it must be built with SUPPORT_I18N and the libidn library.
42764 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42765
42766 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42767 instead of it) then IDNA2008 is supported; this adds an extra library
42768 requirement, upon libidn2.
42769
42770 .section "MTA operations" SECTi18nMTA
42771 .cindex SMTPUTF8 "ESMTP option"
42772 .cindex "ESMTP extensions" SMTPUTF8
42773 The main configuration option &%smtputf8_advertise_hosts%& specifies
42774 a host list.  If this matches the sending host and
42775 accept_8bitmime is true (the default) then the ESMTP option
42776 SMTPUTF8 will be advertised.
42777
42778 If the sender specifies the SMTPUTF8 option on a MAIL command
42779 international handling for the message is enabled and
42780 the expansion variable &$message_smtputf8$& will have value TRUE.
42781
42782 The option &%allow_utf8_domains%& is set to true for this
42783 message. All DNS lookups are converted to a-label form
42784 whatever the setting of &%allow_utf8_domains%&
42785 when Exim is built with SUPPORT_I18N.
42786
42787 Both localparts and domain are maintained as the original
42788 UTF-8 form internally; any comparison or regular-expression use will
42789 require appropriate care.  Filenames created, eg. by
42790 the appendfile transport, will have UTF-8 names.
42791
42792 HELO names sent by the smtp transport will have any UTF-8
42793 components expanded to a-label form,
42794 and any certificate name checks will be done using the a-label
42795 form of the name.
42796
42797 .cindex log protocol
42798 .cindex SMTPUTF8 logging
42799 .cindex i18n logging
42800 Log lines and Received-by: header lines will acquire a "utf8"
42801 prefix on the protocol element, eg. utf8esmtp.
42802
42803 The following expansion operators can be used:
42804 .code
42805 ${utf8_domain_to_alabel:str}
42806 ${utf8_domain_from_alabel:str}
42807 ${utf8_localpart_to_alabel:str}
42808 ${utf8_localpart_from_alabel:str}
42809 .endd
42810
42811 .cindex utf8 "address downconversion"
42812 .cindex i18n "utf8 address downconversion"
42813 The RCPT ACL
42814 may use the following modifier:
42815 .display
42816 control = utf8_downconvert
42817 control = utf8_downconvert/<value>
42818 .endd
42819 This sets a flag requiring that envelope addresses are converted to
42820 a-label form before smtp delivery.
42821 This is usually for use in a Message Submission Agent context,
42822 but could be used for any message.
42823
42824 If a value is appended it may be:
42825 .itable none 0 0 2 5* right 95* left
42826 .irow &`1`&     "mandatory downconversion"
42827 .irow &`0`&     "no downconversion"
42828 .irow &`-1`&    "if SMTPUTF8 not supported by destination host"
42829 .endtable
42830 If no value is given, 1 is used.
42831
42832 If mua_wrapper is set, the utf8_downconvert control
42833 is initially set to -1.
42834
42835 The smtp transport has an option &%utf8_downconvert%&.
42836 If set it must expand to one of the three values described above,
42837 or an empty string.
42838 If non-empty it overrides value previously set
42839 (due to mua_wrapper or by an ACL control).
42840
42841
42842 There is no explicit support for VRFY and EXPN.
42843 Configurations supporting these should inspect
42844 &$smtp_command_argument$& for an SMTPUTF8 argument.
42845
42846 There is no support for LMTP on Unix sockets.
42847 Using the "lmtp" protocol option on an smtp transport,
42848 for LMTP over TCP, should work as expected.
42849
42850 There is no support for DSN unitext handling,
42851 and no provision for converting logging from or to UTF-8.
42852
42853
42854
42855 .section "MDA operations" SECTi18nMDA
42856 To aid in constructing names suitable for IMAP folders
42857 the following expansion operator can be used:
42858 .code
42859 ${imapfolder {<string>} {<sep>} {<specials>}}
42860 .endd
42861
42862 The string is converted from the charset specified by
42863 the "headers charset" command (in a filter file)
42864 or &%headers_charset%& main configuration option (otherwise),
42865 to the
42866 modified UTF-7 encoding specified by RFC 2060,
42867 with the following exception: All occurrences of <sep>
42868 (which has to be a single character)
42869 are replaced with periods ("."), and all periods and slashes that are not
42870 <sep> and are not in the <specials> string are BASE64 encoded.
42871
42872 The third argument can be omitted, defaulting to an empty string.
42873 The second argument can be omitted, defaulting to "/".
42874
42875 This is the encoding used by Courier for Maildir names on disk, and followed
42876 by many other IMAP servers.
42877
42878 Examples:
42879 .display
42880 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42881 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42882 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42883 .endd
42884
42885 Note that the source charset setting is vital, and also that characters
42886 must be representable in UTF-16.
42887
42888
42889 . ////////////////////////////////////////////////////////////////////////////
42890 . ////////////////////////////////////////////////////////////////////////////
42891
42892 .chapter "Events" "CHAPevents" &&&
42893          "Events"
42894 .cindex events
42895
42896 The events mechanism in Exim can be used to intercept processing at a number
42897 of points.  It was originally invented to give a way to do customised logging
42898 actions (for example, to a database) but can also be used to modify some
42899 processing actions.
42900
42901 Most installations will never need to use Events.
42902 The support can be left out of a build by defining DISABLE_EVENT=yes
42903 in &_Local/Makefile_&.
42904
42905 There are two major classes of events: main and transport.
42906 The main configuration option &%event_action%& controls reception events;
42907 a transport option &%event_action%& controls delivery events.
42908
42909 Both options are a string which is expanded when the event fires.
42910 An example might look like:
42911 .cindex logging custom
42912 .code
42913 event_action = ${if eq {msg:delivery}{$event_name} \
42914 {${lookup pgsql {SELECT * FROM record_Delivery( \
42915     '${quote_pgsql:$sender_address_domain}',\
42916     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42917     '${quote_pgsql:$domain}', \
42918     '${quote_pgsql:${lc:$local_part}}', \
42919     '${quote_pgsql:$host_address}', \
42920     '${quote_pgsql:${lc:$host}}', \
42921     '${quote_pgsql:$message_exim_id}')}} \
42922 } {}}
42923 .endd
42924
42925 Events have names which correspond to the point in process at which they fire.
42926 The name is placed in the variable &$event_name$& and the event action
42927 expansion must check this, as it will be called for every possible event type.
42928
42929 The current list of events is:
42930 .itable all 0 0 4 25* left 10* center 15* center 50* left
42931 .row auth:fail              after    both       "per driver per authentication attempt"
42932 .row dane:fail              after    transport  "per connection"
42933 .row msg:complete           after    main       "per message"
42934 .row msg:defer              after    transport  "per message per delivery try"
42935 .row msg:delivery           after    transport  "per recipient"
42936 .row msg:rcpt:host:defer    after    transport  "per recipient per host"
42937 .row msg:rcpt:defer         after    transport  "per recipient"
42938 .row msg:host:defer         after    transport  "per host per delivery try; host errors"
42939 .row msg:fail:delivery      after    transport  "per recipient"
42940 .row msg:fail:internal      after    main       "per recipient"
42941 .row tcp:connect            before   transport  "per connection"
42942 .row tcp:close              after    transport  "per connection"
42943 .row tls:cert               before   both       "per certificate in verification chain"
42944 .row tls:fail:connect       after    main       "per connection"
42945 .row smtp:connect           after    transport  "per connection"
42946 .row smtp:ehlo              after    transport  "per connection"
42947 .endtable
42948 New event types may be added in future.
42949
42950 The event name is a colon-separated list, defining the type of
42951 event in a tree of possibilities.  It may be used as a list
42952 or just matched on as a whole.  There will be no spaces in the name.
42953
42954 The second column in the table above describes whether the event fires
42955 before or after the action is associates with.  Those which fire before
42956 can be used to affect that action (more on this below).
42957
42958 The third column in the table above says what section of the configuration
42959 should define the event action.
42960
42961 An additional variable, &$event_data$&, is filled with information varying
42962 with the event type:
42963 .itable all 0 0 2 20* left 80* left
42964 .row auth:fail            "smtp response"
42965 .row dane:fail            "failure reason"
42966 .row msg:defer            "error string"
42967 .row msg:delivery         "smtp confirmation message"
42968 .row msg:fail:internal    "failure reason"
42969 .row msg:fail:delivery    "smtp error message"
42970 .row msg:host:defer       "error string"
42971 .row msg:rcpt:host:defer  "error string"
42972 .row msg:rcpt:defer       "error string"
42973 .row tls:cert             "verification chain depth"
42974 .row tls:fail:connect     "error string"
42975 .row smtp:connect         "smtp banner"
42976 .row smtp:ehlo            "smtp ehlo response"
42977 .endtable
42978
42979 The :defer events populate one extra variable: &$event_defer_errno$&.
42980
42981 For complex operations an ACL expansion can be used in &%event_action%&,
42982 however due to the multiple contexts that Exim operates in during
42983 the course of its processing:
42984 .ilist
42985 variables set in transport events will not be visible outside that
42986 transport call
42987 .next
42988 acl_m variables in a server context are lost on a new connection,
42989 and after smtp helo/ehlo/mail/starttls/rset commands
42990 .endlist
42991 Using an ACL expansion with the logwrite modifier can be
42992 a useful way of writing to the main log.
42993
42994 The expansion of the event_action option should normally
42995 return an empty string.  Should it return anything else the
42996 following will be forced:
42997 .itable all 0 0 2 20* left 80* left
42998 .row auth:fail        "log information to write"
42999 .row tcp:connect      "do not connect"
43000 .row tls:cert         "refuse verification"
43001 .row smtp:connect     "close connection"
43002 .endtable
43003 All other message types ignore the result string, and
43004 no other use is made of it.
43005
43006 For a tcp:connect event, if the connection is being made to a proxy
43007 then the &$host_address$& and &$host_port$& variables
43008 will be that of the proxy and not the target system.
43009
43010 For tls:cert events, if GnuTLS is in use this will trigger only per
43011 chain element received on the connection.
43012 For OpenSSL it will trigger for every chain element including those
43013 loaded locally.
43014
43015 . ////////////////////////////////////////////////////////////////////////////
43016 . ////////////////////////////////////////////////////////////////////////////
43017
43018 .chapter "Adding new drivers or lookup types" "CHID13" &&&
43019          "Adding drivers or lookups"
43020 .cindex "adding drivers"
43021 .cindex "new drivers, adding"
43022 .cindex "drivers" "adding new"
43023 The following actions have to be taken in order to add a new router, transport,
43024 authenticator, or lookup type to Exim:
43025
43026 .olist
43027 Choose a name for the driver or lookup type that does not conflict with any
43028 existing name; I will use &"newdriver"& in what follows.
43029 .next
43030 Add to &_src/EDITME_& the line:
43031 .display
43032 <&'type'&>&`_NEWDRIVER=yes`&
43033 .endd
43034 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
43035 code is not to be included in the binary by default, comment this line out. You
43036 should also add any relevant comments about the driver or lookup type.
43037 .next
43038 Add to &_src/config.h.defaults_& the line:
43039 .code
43040 #define <type>_NEWDRIVER
43041 .endd
43042 .next
43043 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
43044 and create a table entry as is done for all the other drivers and lookup types.
43045 .next
43046 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
43047 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
43048 Add your &`NEWDRIVER`& to that list.
43049 As long as the dynamic module would be named &_newdriver.so_&, you can use the
43050 simple form that most lookups have.
43051 .next
43052 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
43053 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
43054 driver or lookup type and add it to the definition of OBJ.
43055 .next
43056 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
43057 definition of OBJ_MACRO.  Add a set of line to do the compile also.
43058 .next
43059 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
43060 &_src_&.
43061 .next
43062 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
43063 as for other drivers and lookups.
43064 .endlist
43065
43066 Then all you need to do is write the code! A good way to start is to make a
43067 proforma by copying an existing module of the same type, globally changing all
43068 occurrences of the name, and cutting out most of the code. Note that any
43069 options you create must be listed in alphabetical order, because the tables are
43070 searched using a binary chop procedure.
43071
43072 There is a &_README_& file in each of the sub-directories of &_src_& describing
43073 the interface that is expected.
43074
43075
43076
43077
43078 . ////////////////////////////////////////////////////////////////////////////
43079 . ////////////////////////////////////////////////////////////////////////////
43080
43081 . /////////////////////////////////////////////////////////////////////////////
43082 . These lines are processing instructions for the Simple DocBook Processor that
43083 . Philip Hazel has developed as a less cumbersome way of making PostScript and
43084 . PDFs than using xmlto and fop. They will be ignored by all other XML
43085 . processors.
43086 . /////////////////////////////////////////////////////////////////////////////
43087
43088 .literal xml
43089 <?sdop
43090   format="newpage"
43091   foot_right_recto="&chaptertitle;"
43092   foot_right_verso="&chaptertitle;"
43093 ?>
43094 .literal off
43095
43096 .makeindex "Options index"   "option"
43097 .makeindex "Variables index" "variable"
43098 .makeindex "Concept index"   "concept"
43099
43100
43101 . /////////////////////////////////////////////////////////////////////////////
43102 . /////////////////////////////////////////////////////////////////////////////