19227beef0868a2e78465ba5981ca6abe3e5b76a
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.88"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2017
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .cindex "documentation"
375 This edition of the Exim specification applies to version &version() of Exim.
376 Substantive changes from the &previousversion; edition are marked in some
377 renditions of the document; this paragraph is so marked if the rendition is
378 capable of showing a change indicator.
379
380 This document is very much a reference manual; it is not a tutorial. The reader
381 is expected to have some familiarity with the SMTP mail transfer protocol and
382 with general Unix system administration. Although there are some discussions
383 and examples in places, the information is mostly organized in a way that makes
384 it easy to look up, rather than in a natural order for sequential reading.
385 Furthermore, the manual aims to cover every aspect of Exim in detail, including
386 a number of rarely-used, special-purpose features that are unlikely to be of
387 very wide interest.
388
389 .cindex "books about Exim"
390 An &"easier"& discussion of Exim which provides more in-depth explanatory,
391 introductory, and tutorial material can be found in a book entitled &'The Exim
392 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
393 (&url(http://www.uit.co.uk/exim-book/)).
394
395 This book also contains a chapter that gives a general introduction to SMTP and
396 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
397 with the latest release of Exim. (Note that the earlier book about Exim,
398 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
399
400 .cindex "Debian" "information sources"
401 If you are using a Debian distribution of Exim, you will find information about
402 Debian-specific features in the file
403 &_/usr/share/doc/exim4-base/README.Debian_&.
404 The command &(man update-exim.conf)& is another source of Debian-specific
405 information.
406
407 .cindex "&_doc/NewStuff_&"
408 .cindex "&_doc/ChangeLog_&"
409 .cindex "change log"
410 As the program develops, there may be features in newer versions that have not
411 yet made it into this document, which is updated only when the most significant
412 digit of the fractional part of the version number changes. Specifications of
413 new features that are not yet in this manual are placed in the file
414 &_doc/NewStuff_& in the Exim distribution.
415
416 Some features may be classified as &"experimental"&. These may change
417 incompatibly while they are developing, or even be withdrawn. For this reason,
418 they are not documented in this manual. Information about experimental features
419 can be found in the file &_doc/experimental.txt_&.
420
421 All changes to the program (whether new features, bug fixes, or other kinds of
422 change) are noted briefly in the file called &_doc/ChangeLog_&.
423
424 .cindex "&_doc/spec.txt_&"
425 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
426 that it can easily be searched with a text editor. Other files in the &_doc_&
427 directory are:
428
429 .table2 100pt
430 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
431 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
432 .row &_exim.8_&              "a man page of Exim's command line options"
433 .row &_experimental.txt_&    "documentation of experimental features"
434 .row &_filter.txt_&          "specification of the filter language"
435 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
436 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
437 .row &_openssl.txt_&         "installing a current OpenSSL release"
438 .endtable
439
440 The main specification and the specification of the filtering language are also
441 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
442 &<<SECTavail>>& below tells you how to get hold of these.
443
444
445
446 .section "FTP and web sites" "SECID2"
447 .cindex "web site"
448 .cindex "FTP site"
449 The primary site for Exim source distributions is currently the University of
450 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
451 distribution'& below. In addition, there is a web site and an FTP site at
452 &%exim.org%&. These are now also hosted at the University of Cambridge. The
453 &%exim.org%& site was previously hosted for a number of years by Energis
454 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
455
456 .cindex "wiki"
457 .cindex "FAQ"
458 As well as Exim distribution tar files, the Exim web site contains a number of
459 differently formatted versions of the documentation. A recent addition to the
460 online information is the Exim wiki (&url(http://wiki.exim.org)),
461 which contains what used to be a separate FAQ, as well as various other
462 examples, tips, and know-how that have been contributed by Exim users.
463
464 .cindex Bugzilla
465 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
466 this to report bugs, and also to add items to the wish list. Please search
467 first to check that you are not duplicating a previous entry.
468
469
470
471 .section "Mailing lists" "SECID3"
472 .cindex "mailing lists" "for Exim users"
473 The following Exim mailing lists exist:
474
475 .table2 140pt
476 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
477 .row &'exim-users@exim.org'&      "General discussion list"
478 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
479 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
480 .endtable
481
482 You can subscribe to these lists, change your existing subscriptions, and view
483 or search the archives via the mailing lists link on the Exim home page.
484 .cindex "Debian" "mailing list for"
485 If you are using a Debian distribution of Exim, you may wish to subscribe to
486 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
487 via this web page:
488 .display
489 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
490 .endd
491 Please ask Debian-specific questions on this list and not on the general Exim
492 lists.
493
494 .section "Exim training" "SECID4"
495 .cindex "training courses"
496 Training courses in Cambridge (UK) used to be run annually by the author of
497 Exim, before he retired. At the time of writing, there are no plans to run
498 further Exim courses in Cambridge. However, if that changes, relevant
499 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
500
501 .section "Bug reports" "SECID5"
502 .cindex "bug reports"
503 .cindex "reporting bugs"
504 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
505 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
506 whether some behaviour is a bug or not, the best thing to do is to post a
507 message to the &'exim-dev'& mailing list and have it discussed.
508
509
510
511 .section "Where to find the Exim distribution" "SECTavail"
512 .cindex "FTP site"
513 .cindex "distribution" "ftp site"
514 The master ftp site for the Exim distribution is
515 .display
516 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
517 .endd
518 This is mirrored by
519 .display
520 &*ftp://ftp.exim.org/pub/exim*&
521 .endd
522 The file references that follow are relative to the &_exim_& directories at
523 these sites. There are now quite a number of independent mirror sites around
524 the world. Those that I know about are listed in the file called &_Mirrors_&.
525
526 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
527 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
528 distributions), and &_Testing_& for testing versions. In the &_exim4_&
529 subdirectory, the current release can always be found in files called
530 .display
531 &_exim-n.nn.tar.gz_&
532 &_exim-n.nn.tar.bz2_&
533 .endd
534 where &'n.nn'& is the highest such version number in the directory. The two
535 files contain identical data; the only difference is the type of compression.
536 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
537
538 .cindex "distribution" "signing details"
539 .cindex "distribution" "public key"
540 .cindex "public key for signed distribution"
541 The distributions will be PGP signed by an individual key of the Release
542 Coordinator.  This key will have a uid containing an email address in the
543 &'exim.org'& domain and will have signatures from other people, including
544 other Exim maintainers.  We expect that the key will be in the "strong set" of
545 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
546 PGP key, a version of which can be found in the release directory in the file
547 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
548 such as &'pool.sks-keyservers.net'&.
549
550 At time of last update, releases were being made by Phil Pennock and signed with
551 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
552 A trust path from Nigel's key to Phil's can be observed at
553 &url(https://www.security.spodhuis.org/exim-trustpath).
554
555 Releases have also been authorized to be performed by Todd Lyons who signs with
556 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
557 Pennock and Todd Lyons through a common associate.
558
559 The signatures for the tar bundles are in:
560 .display
561 &_exim-n.nn.tar.gz.asc_&
562 &_exim-n.nn.tar.bz2.asc_&
563 .endd
564 For each released version, the log of changes is made separately available in a
565 separate file in the directory &_ChangeLogs_& so that it is possible to
566 find out what has changed without having to download the entire distribution.
567
568 .cindex "documentation" "available formats"
569 The main distribution contains ASCII versions of this specification and other
570 documentation; other formats of the documents are available in separate files
571 inside the &_exim4_& directory of the FTP site:
572 .display
573 &_exim-html-n.nn.tar.gz_&
574 &_exim-pdf-n.nn.tar.gz_&
575 &_exim-postscript-n.nn.tar.gz_&
576 &_exim-texinfo-n.nn.tar.gz_&
577 .endd
578 These tar files contain only the &_doc_& directory, not the complete
579 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
580
581
582 .section "Limitations" "SECID6"
583 .ilist
584 .cindex "limitations of Exim"
585 .cindex "bang paths" "not handled by Exim"
586 Exim is designed for use as an Internet MTA, and therefore handles addresses in
587 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
588 simple two-component bang paths can be converted by a straightforward rewriting
589 configuration. This restriction does not prevent Exim from being interfaced to
590 UUCP as a transport mechanism, provided that domain addresses are used.
591 .next
592 .cindex "domainless addresses"
593 .cindex "address" "without domain"
594 Exim insists that every address it handles has a domain attached. For incoming
595 local messages, domainless addresses are automatically qualified with a
596 configured domain value. Configuration options specify from which remote
597 systems unqualified addresses are acceptable. These are then qualified on
598 arrival.
599 .next
600 .cindex "transport" "external"
601 .cindex "external transports"
602 The only external transport mechanisms that are currently implemented are SMTP
603 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
604 transport is available, and there are facilities for writing messages to files
605 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
606 to send messages to other transport mechanisms such as UUCP, provided they can
607 handle domain-style addresses. Batched SMTP input is also catered for.
608 .next
609 Exim is not designed for storing mail for dial-in hosts. When the volumes of
610 such mail are large, it is better to get the messages &"delivered"& into files
611 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
612 other means.
613 .next
614 Although Exim does have basic facilities for scanning incoming messages, these
615 are not comprehensive enough to do full virus or spam scanning. Such operations
616 are best carried out using additional specialized software packages. If you
617 compile Exim with the content-scanning extension, straightforward interfaces to
618 a number of common scanners are provided.
619 .endlist
620
621
622 .section "Run time configuration" "SECID7"
623 Exim's run time configuration is held in a single text file that is divided
624 into a number of sections. The entries in this file consist of keywords and
625 values, in the style of Smail 3 configuration files. A default configuration
626 file which is suitable for simple online installations is provided in the
627 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
628
629
630 .section "Calling interface" "SECID8"
631 .cindex "Sendmail compatibility" "command line interface"
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for &_/usr/lib/sendmail_& or
634 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
640 documents all Exim's command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642
643 Control of messages on the queue can be done via certain privileged command
644 line options. There is also an optional monitor program called &'eximon'&,
645 which displays current information in an X window, and which contains a menu
646 interface to Exim's command line administration options.
647
648
649
650 .section "Terminology" "SECID9"
651 .cindex "terminology definitions"
652 .cindex "body of message" "definition of"
653 The &'body'& of a message is the actual data that the sender wants to transmit.
654 It is the last part of a message, and is separated from the &'header'& (see
655 below) by a blank line.
656
657 .cindex "bounce message" "definition of"
658 When a message cannot be delivered, it is normally returned to the sender in a
659 delivery failure message or a &"non-delivery report"& (NDR). The term
660 &'bounce'& is commonly used for this action, and the error reports are often
661 called &'bounce messages'&. This is a convenient shorthand for &"delivery
662 failure error report"&. Such messages have an empty sender address in the
663 message's &'envelope'& (see below) to ensure that they cannot themselves give
664 rise to further bounce messages.
665
666 The term &'default'& appears frequently in this manual. It is used to qualify a
667 value which is used in the absence of any setting in the configuration. It may
668 also qualify an action which is taken unless a configuration setting specifies
669 otherwise.
670
671 The term &'defer'& is used when the delivery of a message to a specific
672 destination cannot immediately take place for some reason (a remote host may be
673 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
674 until a later time.
675
676 The word &'domain'& is sometimes used to mean all but the first component of a
677 host's name. It is &'not'& used in that sense here, where it normally refers to
678 the part of an email address following the @ sign.
679
680 .cindex "envelope, definition of"
681 .cindex "sender" "definition of"
682 A message in transit has an associated &'envelope'&, as well as a header and a
683 body. The envelope contains a sender address (to which bounce messages should
684 be delivered), and any number of recipient addresses. References to the
685 sender or the recipients of a message usually mean the addresses in the
686 envelope. An MTA uses these addresses for delivery, and for returning bounce
687 messages, not the addresses that appear in the header lines.
688
689 .cindex "message" "header, definition of"
690 .cindex "header section" "definition of"
691 The &'header'& of a message is the first part of a message's text, consisting
692 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
693 &'Subject:'&, etc. Long header lines can be split over several text lines by
694 indenting the continuations. The header is separated from the body by a blank
695 line.
696
697 .cindex "local part" "definition of"
698 .cindex "domain" "definition of"
699 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
700 part of an email address that precedes the @ sign. The part that follows the
701 @ sign is called the &'domain'& or &'mail domain'&.
702
703 .cindex "local delivery" "definition of"
704 .cindex "remote delivery, definition of"
705 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
706 delivery to a file or a pipe on the local host from delivery by SMTP over
707 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
708 host it is running on are &'remote'&.
709
710 .cindex "return path" "definition of"
711 &'Return path'& is another name that is used for the sender address in a
712 message's envelope.
713
714 .cindex "queue" "definition of"
715 The term &'queue'& is used to refer to the set of messages awaiting delivery,
716 because this term is in widespread use in the context of MTAs. However, in
717 Exim's case the reality is more like a pool than a queue, because there is
718 normally no ordering of waiting messages.
719
720 .cindex "queue runner" "definition of"
721 The term &'queue runner'& is used to describe a process that scans the queue
722 and attempts to deliver those messages whose retry times have come. This term
723 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
724 the waiting messages are normally processed in an unpredictable order.
725
726 .cindex "spool directory" "definition of"
727 The term &'spool directory'& is used for a directory in which Exim keeps the
728 messages on its queue &-- that is, those that it is in the process of
729 delivering. This should not be confused with the directory in which local
730 mailboxes are stored, which is called a &"spool directory"& by some people. In
731 the Exim documentation, &"spool"& is always used in the first sense.
732
733
734
735
736
737
738 . ////////////////////////////////////////////////////////////////////////////
739 . ////////////////////////////////////////////////////////////////////////////
740
741 .chapter "Incorporated code" "CHID2"
742 .cindex "incorporated code"
743 .cindex "regular expressions" "library"
744 .cindex "PCRE"
745 .cindex "OpenDMARC"
746 A number of pieces of external code are included in the Exim distribution.
747
748 .ilist
749 Regular expressions are supported in the main Exim program and in the
750 Exim monitor using the freely-distributable PCRE library, copyright
751 &copy; University of Cambridge. The source to PCRE is no longer shipped with
752 Exim, so you will need to use the version of PCRE shipped with your system,
753 or obtain and install the full version of the library from
754 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
755 .next
756 .cindex "cdb" "acknowledgment"
757 Support for the cdb (Constant DataBase) lookup method is provided by code
758 contributed by Nigel Metheringham of (at the time he contributed it) Planet
759 Online Ltd. The implementation is completely contained within the code of Exim.
760 It does not link against an external cdb library. The code contains the
761 following statements:
762
763 .blockquote
764 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
765
766 This program is free software; you can redistribute it and/or modify it under
767 the terms of the GNU General Public License as published by the Free Software
768 Foundation; either version 2 of the License, or (at your option) any later
769 version.
770 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
771 the spec and sample code for cdb can be obtained from
772 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
773 some code from Dan Bernstein's implementation (which has no license
774 restrictions applied to it).
775 .endblockquote
776 .next
777 .cindex "SPA authentication"
778 .cindex "Samba project"
779 .cindex "Microsoft Secure Password Authentication"
780 Client support for Microsoft's &'Secure Password Authentication'& is provided
781 by code contributed by Marc Prud'hommeaux. Server support was contributed by
782 Tom Kistner. This includes code taken from the Samba project, which is released
783 under the Gnu GPL.
784 .next
785 .cindex "Cyrus"
786 .cindex "&'pwcheck'& daemon"
787 .cindex "&'pwauthd'& daemon"
788 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
789 by code taken from the Cyrus-SASL library and adapted by Alexander S.
790 Sabourenkov. The permission notice appears below, in accordance with the
791 conditions expressed therein.
792
793 .blockquote
794 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
795
796 Redistribution and use in source and binary forms, with or without
797 modification, are permitted provided that the following conditions
798 are met:
799
800 .olist
801 Redistributions of source code must retain the above copyright
802 notice, this list of conditions and the following disclaimer.
803 .next
804 Redistributions in binary form must reproduce the above copyright
805 notice, this list of conditions and the following disclaimer in
806 the documentation and/or other materials provided with the
807 distribution.
808 .next
809 The name &"Carnegie Mellon University"& must not be used to
810 endorse or promote products derived from this software without
811 prior written permission. For permission or any other legal
812 details, please contact
813 .display
814               Office of Technology Transfer
815               Carnegie Mellon University
816               5000 Forbes Avenue
817               Pittsburgh, PA  15213-3890
818               (412) 268-4387, fax: (412) 268-7395
819               tech-transfer@andrew.cmu.edu
820 .endd
821 .next
822 Redistributions of any form whatsoever must retain the following
823 acknowledgment:
824
825 &"This product includes software developed by Computing Services
826 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
827
828 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
829 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
830 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
831 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
832 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
833 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
834 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
835 .endlist
836 .endblockquote
837
838 .next
839 .cindex "Exim monitor" "acknowledgment"
840 .cindex "X-windows"
841 .cindex "Athena"
842 The Exim Monitor program, which is an X-Window application, includes
843 modified versions of the Athena StripChart and TextPop widgets.
844 This code is copyright by DEC and MIT, and their permission notice appears
845 below, in accordance with the conditions expressed therein.
846
847 .blockquote
848 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
849 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
850
851 All Rights Reserved
852
853 Permission to use, copy, modify, and distribute this software and its
854 documentation for any purpose and without fee is hereby granted,
855 provided that the above copyright notice appear in all copies and that
856 both that copyright notice and this permission notice appear in
857 supporting documentation, and that the names of Digital or MIT not be
858 used in advertising or publicity pertaining to distribution of the
859 software without specific, written prior permission.
860
861 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
862 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
863 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
864 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
865 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
866 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
867 SOFTWARE.
868 .endblockquote
869
870 .next
871 .cindex "opendmarc" "acknowledgment"
872 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
873 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
874 derived code are indicated in the respective source files. The full OpenDMARC
875 license is provided in the LICENSE.opendmarc file contained in the distributed
876 source code.
877
878 .next
879 Many people have contributed code fragments, some large, some small, that were
880 not covered by any specific licence requirements. It is assumed that the
881 contributors are happy to see their code incorporated into Exim under the GPL.
882 .endlist
883
884
885
886
887
888 . ////////////////////////////////////////////////////////////////////////////
889 . ////////////////////////////////////////////////////////////////////////////
890
891 .chapter "How Exim receives and delivers mail" "CHID11" &&&
892          "Receiving and delivering mail"
893
894
895 .section "Overall philosophy" "SECID10"
896 .cindex "design philosophy"
897 Exim is designed to work efficiently on systems that are permanently connected
898 to the Internet and are handling a general mix of mail. In such circumstances,
899 most messages can be delivered immediately. Consequently, Exim does not
900 maintain independent queues of messages for specific domains or hosts, though
901 it does try to send several messages in a single SMTP connection after a host
902 has been down, and it also maintains per-host retry information.
903
904
905 .section "Policy control" "SECID11"
906 .cindex "policy control" "overview"
907 Policy controls are now an important feature of MTAs that are connected to the
908 Internet. Perhaps their most important job is to stop MTAs being abused as
909 &"open relays"& by misguided individuals who send out vast amounts of
910 unsolicited junk, and want to disguise its source. Exim provides flexible
911 facilities for specifying policy controls on incoming mail:
912
913 .ilist
914 .cindex "&ACL;" "introduction"
915 Exim 4 (unlike previous versions of Exim) implements policy controls on
916 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
917 series of statements that may either grant or deny access. ACLs can be used at
918 several places in the SMTP dialogue while receiving a message from a remote
919 host. However, the most common places are after each RCPT command, and at the
920 very end of the message. The sysadmin can specify conditions for accepting or
921 rejecting individual recipients or the entire message, respectively, at these
922 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
923 error code.
924 .next
925 An ACL is also available for locally generated, non-SMTP messages. In this
926 case, the only available actions are to accept or deny the entire message.
927 .next
928 When Exim is compiled with the content-scanning extension, facilities are
929 provided in the ACL mechanism for passing the message to external virus and/or
930 spam scanning software. The result of such a scan is passed back to the ACL,
931 which can then use it to decide what to do with the message.
932 .next
933 When a message has been received, either from a remote host or from the local
934 host, but before the final acknowledgment has been sent, a locally supplied C
935 function called &[local_scan()]& can be run to inspect the message and decide
936 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
937 is accepted, the list of recipients can be modified by the function.
938 .next
939 Using the &[local_scan()]& mechanism is another way of calling external scanner
940 software. The &%SA-Exim%& add-on package works this way. It does not require
941 Exim to be compiled with the content-scanning extension.
942 .next
943 After a message has been accepted, a further checking mechanism is available in
944 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
945 runs at the start of every delivery process.
946 .endlist
947
948
949
950 .section "User filters" "SECID12"
951 .cindex "filter" "introduction"
952 .cindex "Sieve filter"
953 In a conventional Exim configuration, users are able to run private filters by
954 setting up appropriate &_.forward_& files in their home directories. See
955 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
956 configuration needed to support this, and the separate document entitled
957 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
958 of filtering are available:
959
960 .ilist
961 Sieve filters are written in the standard filtering language that is defined
962 by RFC 3028.
963 .next
964 Exim filters are written in a syntax that is unique to Exim, but which is more
965 powerful than Sieve, which it pre-dates.
966 .endlist
967
968 User filters are run as part of the routing process, described below.
969
970
971
972 .section "Message identification" "SECTmessiden"
973 .cindex "message ids" "details of format"
974 .cindex "format" "of message id"
975 .cindex "id of message"
976 .cindex "base62"
977 .cindex "base36"
978 .cindex "Darwin"
979 .cindex "Cygwin"
980 Every message handled by Exim is given a &'message id'& which is sixteen
981 characters long. It is divided into three parts, separated by hyphens, for
982 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
983 normally encoding numbers in base 62. However, in the Darwin operating
984 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
985 (avoiding the use of lower case letters) is used instead, because the message
986 id is used to construct file names, and the names of files in those systems are
987 not always case-sensitive.
988
989 .cindex "pid (process id)" "re-use of"
990 The detail of the contents of the message id have changed as Exim has evolved.
991 Earlier versions relied on the operating system not re-using a process id (pid)
992 within one second. On modern operating systems, this assumption can no longer
993 be made, so the algorithm had to be changed. To retain backward compatibility,
994 the format of the message id was retained, which is why the following rules are
995 somewhat eccentric:
996
997 .ilist
998 The first six characters of the message id are the time at which the message
999 started to be received, to a granularity of one second. That is, this field
1000 contains the number of seconds since the start of the epoch (the normal Unix
1001 way of representing the date and time of day).
1002 .next
1003 After the first hyphen, the next six characters are the id of the process that
1004 received the message.
1005 .next
1006 There are two different possibilities for the final two characters:
1007 .olist
1008 .oindex "&%localhost_number%&"
1009 If &%localhost_number%& is not set, this value is the fractional part of the
1010 time of reception, normally in units of 1/2000 of a second, but for systems
1011 that must use base 36 instead of base 62 (because of case-insensitive file
1012 systems), the units are 1/1000 of a second.
1013 .next
1014 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1015 the fractional part of the time, which in this case is in units of 1/200
1016 (1/100) of a second.
1017 .endlist
1018 .endlist
1019
1020 After a message has been received, Exim waits for the clock to tick at the
1021 appropriate resolution before proceeding, so that if another message is
1022 received by the same process, or by another process with the same (re-used)
1023 pid, it is guaranteed that the time will be different. In most cases, the clock
1024 will already have ticked while the message was being received.
1025
1026
1027 .section "Receiving mail" "SECID13"
1028 .cindex "receiving mail"
1029 .cindex "message" "reception"
1030 The only way Exim can receive mail from another host is using SMTP over
1031 TCP/IP, in which case the sender and recipient addresses are transferred using
1032 SMTP commands. However, from a locally running process (such as a user's MUA),
1033 there are several possibilities:
1034
1035 .ilist
1036 If the process runs Exim with the &%-bm%& option, the message is read
1037 non-interactively (usually via a pipe), with the recipients taken from the
1038 command line, or from the body of the message if &%-t%& is also used.
1039 .next
1040 If the process runs Exim with the &%-bS%& option, the message is also read
1041 non-interactively, but in this case the recipients are listed at the start of
1042 the message in a series of SMTP RCPT commands, terminated by a DATA
1043 command. This is so-called &"batch SMTP"& format,
1044 but it isn't really SMTP. The SMTP commands are just another way of passing
1045 envelope addresses in a non-interactive submission.
1046 .next
1047 If the process runs Exim with the &%-bs%& option, the message is read
1048 interactively, using the SMTP protocol. A two-way pipe is normally used for
1049 passing data between the local process and the Exim process.
1050 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1051 example, the ACLs for SMTP commands are used for this form of submission.
1052 .next
1053 A local process may also make a TCP/IP call to the host's loopback address
1054 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1055 does not treat the loopback address specially. It treats all such connections
1056 in the same way as connections from other hosts.
1057 .endlist
1058
1059
1060 .cindex "message sender, constructed by Exim"
1061 .cindex "sender" "constructed by Exim"
1062 In the three cases that do not involve TCP/IP, the sender address is
1063 constructed from the login name of the user that called Exim and a default
1064 qualification domain (which can be set by the &%qualify_domain%& configuration
1065 option). For local or batch SMTP, a sender address that is passed using the
1066 SMTP MAIL command is ignored. However, the system administrator may allow
1067 certain users (&"trusted users"&) to specify a different sender address
1068 unconditionally, or all users to specify certain forms of different sender
1069 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1070 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1071 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1072 users to change sender addresses.
1073
1074 Messages received by either of the non-interactive mechanisms are subject to
1075 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1076 (either over TCP/IP, or interacting with a local process) can be checked by a
1077 number of ACLs that operate at different times during the SMTP session. Either
1078 individual recipients, or the entire message, can be rejected if local policy
1079 requirements are not met. The &[local_scan()]& function (see chapter
1080 &<<CHAPlocalscan>>&) is run for all incoming messages.
1081
1082 Exim can be configured not to start a delivery process when a message is
1083 received; this can be unconditional, or depend on the number of incoming SMTP
1084 connections or the system load. In these situations, new messages wait on the
1085 queue until a queue runner process picks them up. However, in standard
1086 configurations under normal conditions, delivery is started as soon as a
1087 message is received.
1088
1089
1090
1091
1092
1093 .section "Handling an incoming message" "SECID14"
1094 .cindex "spool directory" "files that hold a message"
1095 .cindex "file" "how a message is held"
1096 When Exim accepts a message, it writes two files in its spool directory. The
1097 first contains the envelope information, the current status of the message, and
1098 the header lines, and the second contains the body of the message. The names of
1099 the two spool files consist of the message id, followed by &`-H`& for the
1100 file containing the envelope and header, and &`-D`& for the data file.
1101
1102 .cindex "spool directory" "&_input_& sub-directory"
1103 By default all these message files are held in a single directory called
1104 &_input_& inside the general Exim spool directory. Some operating systems do
1105 not perform very well if the number of files in a directory gets large; to
1106 improve performance in such cases, the &%split_spool_directory%& option can be
1107 used. This causes Exim to split up the input files into 62 sub-directories
1108 whose names are single letters or digits. When this is done, the queue is
1109 processed one sub-directory at a time instead of all at once, which can improve
1110 overall performance even when there are not enough files in each directory to
1111 affect file system performance.
1112
1113 The envelope information consists of the address of the message's sender and
1114 the addresses of the recipients. This information is entirely separate from
1115 any addresses contained in the header lines. The status of the message includes
1116 a list of recipients who have already received the message. The format of the
1117 first spool file is described in chapter &<<CHAPspool>>&.
1118
1119 .cindex "rewriting" "addresses"
1120 Address rewriting that is specified in the rewrite section of the configuration
1121 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1122 both in the header lines and the envelope, at the time the message is accepted.
1123 If during the course of delivery additional addresses are generated (for
1124 example, via aliasing), these new addresses are rewritten as soon as they are
1125 generated. At the time a message is actually delivered (transported) further
1126 rewriting can take place; because this is a transport option, it can be
1127 different for different forms of delivery. It is also possible to specify the
1128 addition or removal of certain header lines at the time the message is
1129 delivered (see chapters &<<CHAProutergeneric>>& and
1130 &<<CHAPtransportgeneric>>&).
1131
1132
1133
1134 .section "Life of a message" "SECID15"
1135 .cindex "message" "life of"
1136 .cindex "message" "frozen"
1137 A message remains in the spool directory until it is completely delivered to
1138 its recipients or to an error address, or until it is deleted by an
1139 administrator or by the user who originally created it. In cases when delivery
1140 cannot proceed &-- for example, when a message can neither be delivered to its
1141 recipients nor returned to its sender, the message is marked &"frozen"& on the
1142 spool, and no more deliveries are attempted.
1143
1144 .cindex "frozen messages" "thawing"
1145 .cindex "message" "thawing frozen"
1146 An administrator can &"thaw"& such messages when the problem has been
1147 corrected, and can also freeze individual messages by hand if necessary. In
1148 addition, an administrator can force a delivery error, causing a bounce message
1149 to be sent.
1150
1151 .oindex "&%timeout_frozen_after%&"
1152 .oindex "&%ignore_bounce_errors_after%&"
1153 There are options called &%ignore_bounce_errors_after%& and
1154 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1155 The first applies only to frozen bounces, the second to any frozen messages.
1156
1157 .cindex "message" "log file for"
1158 .cindex "log" "file for each message"
1159 While Exim is working on a message, it writes information about each delivery
1160 attempt to its main log file. This includes successful, unsuccessful, and
1161 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1162 lines are also written to a separate &'message log'& file for each message.
1163 These logs are solely for the benefit of the administrator, and are normally
1164 deleted along with the spool files when processing of a message is complete.
1165 The use of individual message logs can be disabled by setting
1166 &%no_message_logs%&; this might give an improvement in performance on very busy
1167 systems.
1168
1169 .cindex "journal file"
1170 .cindex "file" "journal"
1171 All the information Exim itself needs to set up a delivery is kept in the first
1172 spool file, along with the header lines. When a successful delivery occurs, the
1173 address is immediately written at the end of a journal file, whose name is the
1174 message id followed by &`-J`&. At the end of a delivery run, if there are some
1175 addresses left to be tried again later, the first spool file (the &`-H`& file)
1176 is updated to indicate which these are, and the journal file is then deleted.
1177 Updating the spool file is done by writing a new file and renaming it, to
1178 minimize the possibility of data loss.
1179
1180 Should the system or the program crash after a successful delivery but before
1181 the spool file has been updated, the journal is left lying around. The next
1182 time Exim attempts to deliver the message, it reads the journal file and
1183 updates the spool file before proceeding. This minimizes the chances of double
1184 deliveries caused by crashes.
1185
1186
1187
1188 .section "Processing an address for delivery" "SECTprocaddress"
1189 .cindex "drivers" "definition of"
1190 .cindex "router" "definition of"
1191 .cindex "transport" "definition of"
1192 The main delivery processing elements of Exim are called &'routers'& and
1193 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1194 number of them is provided in the source distribution, and compile-time options
1195 specify which ones are included in the binary. Run time options specify which
1196 ones are actually used for delivering messages.
1197
1198 .cindex "drivers" "instance definition"
1199 Each driver that is specified in the run time configuration is an &'instance'&
1200 of that particular driver type. Multiple instances are allowed; for example,
1201 you can set up several different &(smtp)& transports, each with different
1202 option values that might specify different ports or different timeouts. Each
1203 instance has its own identifying name. In what follows we will normally use the
1204 instance name when discussing one particular instance (that is, one specific
1205 configuration of the driver), and the generic driver name when discussing
1206 the driver's features in general.
1207
1208 A &'router'& is a driver that operates on an address, either determining how
1209 its delivery should happen, by assigning it to a specific transport, or
1210 converting the address into one or more new addresses (for example, via an
1211 alias file). A router may also explicitly choose to fail an address, causing it
1212 to be bounced.
1213
1214 A &'transport'& is a driver that transmits a copy of the message from Exim's
1215 spool to some destination. There are two kinds of transport: for a &'local'&
1216 transport, the destination is a file or a pipe on the local host, whereas for a
1217 &'remote'& transport the destination is some other host. A message is passed
1218 to a specific transport as a result of successful routing. If a message has
1219 several recipients, it may be passed to a number of different transports.
1220
1221 .cindex "preconditions" "definition of"
1222 An address is processed by passing it to each configured router instance in
1223 turn, subject to certain preconditions, until a router accepts the address or
1224 specifies that it should be bounced. We will describe this process in more
1225 detail shortly. First, as a simple example, we consider how each recipient
1226 address in a message is processed in a small configuration of three routers.
1227
1228 To make this a more concrete example, it is described in terms of some actual
1229 routers, but remember, this is only an example. You can configure Exim's
1230 routers in many different ways, and there may be any number of routers in a
1231 configuration.
1232
1233 The first router that is specified in a configuration is often one that handles
1234 addresses in domains that are not recognized specially by the local host. These
1235 are typically addresses for arbitrary domains on the Internet. A precondition
1236 is set up which looks for the special domains known to the host (for example,
1237 its own domain name), and the router is run for addresses that do &'not'&
1238 match. Typically, this is a router that looks up domains in the DNS in order to
1239 find the hosts to which this address routes. If it succeeds, the address is
1240 assigned to a suitable SMTP transport; if it does not succeed, the router is
1241 configured to fail the address.
1242
1243 The second router is reached only when the domain is recognized as one that
1244 &"belongs"& to the local host. This router does redirection &-- also known as
1245 aliasing and forwarding. When it generates one or more new addresses from the
1246 original, each of them is routed independently from the start. Otherwise, the
1247 router may cause an address to fail, or it may simply decline to handle the
1248 address, in which case the address is passed to the next router.
1249
1250 The final router in many configurations is one that checks to see if the
1251 address belongs to a local mailbox. The precondition may involve a check to
1252 see if the local part is the name of a login account, or it may look up the
1253 local part in a file or a database. If its preconditions are not met, or if
1254 the router declines, we have reached the end of the routers. When this happens,
1255 the address is bounced.
1256
1257
1258
1259 .section "Processing an address for verification" "SECID16"
1260 .cindex "router" "for verification"
1261 .cindex "verifying address" "overview"
1262 As well as being used to decide how to deliver to an address, Exim's routers
1263 are also used for &'address verification'&. Verification can be requested as
1264 one of the checks to be performed in an ACL for incoming messages, on both
1265 sender and recipient addresses, and it can be tested using the &%-bv%& and
1266 &%-bvs%& command line options.
1267
1268 When an address is being verified, the routers are run in &"verify mode"&. This
1269 does not affect the way the routers work, but it is a state that can be
1270 detected. By this means, a router can be skipped or made to behave differently
1271 when verifying. A common example is a configuration in which the first router
1272 sends all messages to a message-scanning program, unless they have been
1273 previously scanned. Thus, the first router accepts all addresses without any
1274 checking, making it useless for verifying. Normally, the &%no_verify%& option
1275 would be set for such a router, causing it to be skipped in verify mode.
1276
1277
1278
1279
1280 .section "Running an individual router" "SECTrunindrou"
1281 .cindex "router" "running details"
1282 .cindex "preconditions" "checking"
1283 .cindex "router" "result of running"
1284 As explained in the example above, a number of preconditions are checked before
1285 running a router. If any are not met, the router is skipped, and the address is
1286 passed to the next router. When all the preconditions on a router &'are'& met,
1287 the router is run. What happens next depends on the outcome, which is one of
1288 the following:
1289
1290 .ilist
1291 &'accept'&: The router accepts the address, and either assigns it to a
1292 transport, or generates one or more &"child"& addresses. Processing the
1293 original address ceases,
1294 .oindex "&%unseen%&"
1295 unless the &%unseen%& option is set on the router. This option
1296 can be used to set up multiple deliveries with different routing (for example,
1297 for keeping archive copies of messages). When &%unseen%& is set, the address is
1298 passed to the next router. Normally, however, an &'accept'& return marks the
1299 end of routing.
1300
1301 Any child addresses generated by the router are processed independently,
1302 starting with the first router by default. It is possible to change this by
1303 setting the &%redirect_router%& option to specify which router to start at for
1304 child addresses. Unlike &%pass_router%& (see below) the router specified by
1305 &%redirect_router%& may be anywhere in the router configuration.
1306 .next
1307 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1308 requests that the address be passed to another router. By default the address
1309 is passed to the next router, but this can be changed by setting the
1310 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1311 must be below the current router (to avoid loops).
1312 .next
1313 &'decline'&: The router declines to accept the address because it does not
1314 recognize it at all. By default, the address is passed to the next router, but
1315 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1316 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1317 &'decline'& into &'fail'&.
1318 .next
1319 &'fail'&: The router determines that the address should fail, and queues it for
1320 the generation of a bounce message. There is no further processing of the
1321 original address unless &%unseen%& is set on the router.
1322 .next
1323 &'defer'&: The router cannot handle the address at the present time. (A
1324 database may be offline, or a DNS lookup may have timed out.) No further
1325 processing of the address happens in this delivery attempt. It is tried again
1326 next time the message is considered for delivery.
1327 .next
1328 &'error'&: There is some error in the router (for example, a syntax error in
1329 its configuration). The action is as for defer.
1330 .endlist
1331
1332 If an address reaches the end of the routers without having been accepted by
1333 any of them, it is bounced as unrouteable. The default error message in this
1334 situation is &"unrouteable address"&, but you can set your own message by
1335 making use of the &%cannot_route_message%& option. This can be set for any
1336 router; the value from the last router that &"saw"& the address is used.
1337
1338 Sometimes while routing you want to fail a delivery when some conditions are
1339 met but others are not, instead of passing the address on for further routing.
1340 You can do this by having a second router that explicitly fails the delivery
1341 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1342 facility for this purpose.
1343
1344
1345 .section "Duplicate addresses" "SECID17"
1346 .cindex "case of local parts"
1347 .cindex "address duplicate, discarding"
1348 .cindex "duplicate addresses"
1349 Once routing is complete, Exim scans the addresses that are assigned to local
1350 and remote transports, and discards any duplicates that it finds. During this
1351 check, local parts are treated as case-sensitive. This happens only when
1352 actually delivering a message; when testing routers with &%-bt%&, all the
1353 routed addresses are shown.
1354
1355
1356
1357 .section "Router preconditions" "SECTrouprecon"
1358 .cindex "router" "preconditions, order of processing"
1359 .cindex "preconditions" "order of processing"
1360 The preconditions that are tested for each router are listed below, in the
1361 order in which they are tested. The individual configuration options are
1362 described in more detail in chapter &<<CHAProutergeneric>>&.
1363
1364 .ilist
1365 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1366 the local parts handled by the router may or must have certain prefixes and/or
1367 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1368 skipped. These conditions are tested first. When an affix is present, it is
1369 removed from the local part before further processing, including the evaluation
1370 of any other conditions.
1371 .next
1372 Routers can be designated for use only when not verifying an address, that is,
1373 only when routing it for delivery (or testing its delivery routing). If the
1374 &%verify%& option is set false, the router is skipped when Exim is verifying an
1375 address.
1376 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1377 &%verify_recipient%&, which independently control the use of the router for
1378 sender and recipient verification. You can set these options directly if
1379 you want a router to be used for only one type of verification.
1380 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1381 .next
1382 If the &%address_test%& option is set false, the router is skipped when Exim is
1383 run with the &%-bt%& option to test an address routing. This can be helpful
1384 when the first router sends all new messages to a scanner of some sort; it
1385 makes it possible to use &%-bt%& to test subsequent delivery routing without
1386 having to simulate the effect of the scanner.
1387 .next
1388 Routers can be designated for use only when verifying an address, as
1389 opposed to routing it for delivery. The &%verify_only%& option controls this.
1390 Again, cutthrough delivery counts as a verification.
1391 .next
1392 Individual routers can be explicitly skipped when running the routers to
1393 check an address given in the SMTP EXPN command (see the &%expn%& option).
1394 .next
1395 If the &%domains%& option is set, the domain of the address must be in the set
1396 of domains that it defines.
1397 .next
1398 .vindex "&$local_part_prefix$&"
1399 .vindex "&$local_part$&"
1400 .vindex "&$local_part_suffix$&"
1401 If the &%local_parts%& option is set, the local part of the address must be in
1402 the set of local parts that it defines. If &%local_part_prefix%& or
1403 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1404 part before this check. If you want to do precondition tests on local parts
1405 that include affixes, you can do so by using a &%condition%& option (see below)
1406 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1407 &$local_part_suffix$& as necessary.
1408 .next
1409 .vindex "&$local_user_uid$&"
1410 .vindex "&$local_user_gid$&"
1411 .vindex "&$home$&"
1412 If the &%check_local_user%& option is set, the local part must be the name of
1413 an account on the local host. If this check succeeds, the uid and gid of the
1414 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1415 user's home directory is placed in &$home$&; these values can be used in the
1416 remaining preconditions.
1417 .next
1418 If the &%router_home_directory%& option is set, it is expanded at this point,
1419 because it overrides the value of &$home$&. If this expansion were left till
1420 later, the value of &$home$& as set by &%check_local_user%& would be used in
1421 subsequent tests. Having two different values of &$home$& in the same router
1422 could lead to confusion.
1423 .next
1424 If the &%senders%& option is set, the envelope sender address must be in the
1425 set of addresses that it defines.
1426 .next
1427 If the &%require_files%& option is set, the existence or non-existence of
1428 specified files is tested.
1429 .next
1430 .cindex "customizing" "precondition"
1431 If the &%condition%& option is set, it is evaluated and tested. This option
1432 uses an expanded string to allow you to set up your own custom preconditions.
1433 Expanded strings are described in chapter &<<CHAPexpand>>&.
1434 .endlist
1435
1436
1437 Note that &%require_files%& comes near the end of the list, so you cannot use
1438 it to check for the existence of a file in which to lookup up a domain, local
1439 part, or sender. However, as these options are all expanded, you can use the
1440 &%exists%& expansion condition to make such tests within each condition. The
1441 &%require_files%& option is intended for checking files that the router may be
1442 going to use internally, or which are needed by a specific transport (for
1443 example, &_.procmailrc_&).
1444
1445
1446
1447 .section "Delivery in detail" "SECID18"
1448 .cindex "delivery" "in detail"
1449 When a message is to be delivered, the sequence of events is as follows:
1450
1451 .ilist
1452 If a system-wide filter file is specified, the message is passed to it. The
1453 filter may add recipients to the message, replace the recipients, discard the
1454 message, cause a new message to be generated, or cause the message delivery to
1455 fail. The format of the system filter file is the same as for Exim user filter
1456 files, described in the separate document entitled &'Exim's interfaces to mail
1457 filtering'&.
1458 .cindex "Sieve filter" "not available for system filter"
1459 (&*Note*&: Sieve cannot be used for system filter files.)
1460
1461 Some additional features are available in system filters &-- see chapter
1462 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1463 filter only once per delivery attempt, however many recipients it has. However,
1464 if there are several delivery attempts because one or more addresses could not
1465 be immediately delivered, the system filter is run each time. The filter
1466 condition &%first_delivery%& can be used to detect the first run of the system
1467 filter.
1468 .next
1469 Each recipient address is offered to each configured router in turn, subject to
1470 its preconditions, until one is able to handle it. If no router can handle the
1471 address, that is, if they all decline, the address is failed. Because routers
1472 can be targeted at particular domains, several locally handled domains can be
1473 processed entirely independently of each other.
1474 .next
1475 .cindex "routing" "loops in"
1476 .cindex "loop" "while routing"
1477 A router that accepts an address may assign it to a local or a remote
1478 transport. However, the transport is not run at this time. Instead, the address
1479 is placed on a list for the particular transport, which will be run later.
1480 Alternatively, the router may generate one or more new addresses (typically
1481 from alias, forward, or filter files). New addresses are fed back into this
1482 process from the top, but in order to avoid loops, a router ignores any address
1483 which has an identically-named ancestor that was processed by itself.
1484 .next
1485 When all the routing has been done, addresses that have been successfully
1486 handled are passed to their assigned transports. When local transports are
1487 doing real local deliveries, they handle only one address at a time, but if a
1488 local transport is being used as a pseudo-remote transport (for example, to
1489 collect batched SMTP messages for transmission by some other means) multiple
1490 addresses can be handled. Remote transports can always handle more than one
1491 address at a time, but can be configured not to do so, or to restrict multiple
1492 addresses to the same domain.
1493 .next
1494 Each local delivery to a file or a pipe runs in a separate process under a
1495 non-privileged uid, and these deliveries are run one at a time. Remote
1496 deliveries also run in separate processes, normally under a uid that is private
1497 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1498 run in parallel. The maximum number of simultaneous remote deliveries for any
1499 one message is set by the &%remote_max_parallel%& option.
1500 The order in which deliveries are done is not defined, except that all local
1501 deliveries happen before any remote deliveries.
1502 .next
1503 .cindex "queue runner"
1504 When it encounters a local delivery during a queue run, Exim checks its retry
1505 database to see if there has been a previous temporary delivery failure for the
1506 address before running the local transport. If there was a previous failure,
1507 Exim does not attempt a new delivery until the retry time for the address is
1508 reached. However, this happens only for delivery attempts that are part of a
1509 queue run. Local deliveries are always attempted when delivery immediately
1510 follows message reception, even if retry times are set for them. This makes for
1511 better behaviour if one particular message is causing problems (for example,
1512 causing quota overflow, or provoking an error in a filter file).
1513 .next
1514 .cindex "delivery" "retry in remote transports"
1515 Remote transports do their own retry handling, since an address may be
1516 deliverable to one of a number of hosts, each of which may have a different
1517 retry time. If there have been previous temporary failures and no host has
1518 reached its retry time, no delivery is attempted, whether in a queue run or
1519 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1520 .next
1521 If there were any permanent errors, a bounce message is returned to an
1522 appropriate address (the sender in the common case), with details of the error
1523 for each failing address. Exim can be configured to send copies of bounce
1524 messages to other addresses.
1525 .next
1526 .cindex "delivery" "deferral"
1527 If one or more addresses suffered a temporary failure, the message is left on
1528 the queue, to be tried again later. Delivery of these addresses is said to be
1529 &'deferred'&.
1530 .next
1531 When all the recipient addresses have either been delivered or bounced,
1532 handling of the message is complete. The spool files and message log are
1533 deleted, though the message log can optionally be preserved if required.
1534 .endlist
1535
1536
1537
1538
1539 .section "Retry mechanism" "SECID19"
1540 .cindex "delivery" "retry mechanism"
1541 .cindex "retry" "description of mechanism"
1542 .cindex "queue runner"
1543 Exim's mechanism for retrying messages that fail to get delivered at the first
1544 attempt is the queue runner process. You must either run an Exim daemon that
1545 uses the &%-q%& option with a time interval to start queue runners at regular
1546 intervals, or use some other means (such as &'cron'&) to start them. If you do
1547 not arrange for queue runners to be run, messages that fail temporarily at the
1548 first attempt will remain on your queue for ever. A queue runner process works
1549 its way through the queue, one message at a time, trying each delivery that has
1550 passed its retry time.
1551 You can run several queue runners at once.
1552
1553 Exim uses a set of configured rules to determine when next to retry the failing
1554 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1555 should give up trying to deliver to the address, at which point it generates a
1556 bounce message. If no retry rules are set for a particular host, address, and
1557 error combination, no retries are attempted, and temporary errors are treated
1558 as permanent.
1559
1560
1561
1562 .section "Temporary delivery failure" "SECID20"
1563 .cindex "delivery" "temporary failure"
1564 There are many reasons why a message may not be immediately deliverable to a
1565 particular address. Failure to connect to a remote machine (because it, or the
1566 connection to it, is down) is one of the most common. Temporary failures may be
1567 detected during routing as well as during the transport stage of delivery.
1568 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1569 is on a file system where the user is over quota. Exim can be configured to
1570 impose its own quotas on local mailboxes; where system quotas are set they will
1571 also apply.
1572
1573 If a host is unreachable for a period of time, a number of messages may be
1574 waiting for it by the time it recovers, and sending them in a single SMTP
1575 connection is clearly beneficial. Whenever a delivery to a remote host is
1576 deferred,
1577 .cindex "hints database" "deferred deliveries"
1578 Exim makes a note in its hints database, and whenever a successful
1579 SMTP delivery has happened, it looks to see if any other messages are waiting
1580 for the same host. If any are found, they are sent over the same SMTP
1581 connection, subject to a configuration limit as to the maximum number in any
1582 one connection.
1583
1584
1585
1586 .section "Permanent delivery failure" "SECID21"
1587 .cindex "delivery" "permanent failure"
1588 .cindex "bounce message" "when generated"
1589 When a message cannot be delivered to some or all of its intended recipients, a
1590 bounce message is generated. Temporary delivery failures turn into permanent
1591 errors when their timeout expires. All the addresses that fail in a given
1592 delivery attempt are listed in a single message. If the original message has
1593 many recipients, it is possible for some addresses to fail in one delivery
1594 attempt and others to fail subsequently, giving rise to more than one bounce
1595 message. The wording of bounce messages can be customized by the administrator.
1596 See chapter &<<CHAPemsgcust>>& for details.
1597
1598 .cindex "&'X-Failed-Recipients:'& header line"
1599 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1600 failed addresses, for the benefit of programs that try to analyse such messages
1601 automatically.
1602
1603 .cindex "bounce message" "recipient of"
1604 A bounce message is normally sent to the sender of the original message, as
1605 obtained from the message's envelope. For incoming SMTP messages, this is the
1606 address given in the MAIL command. However, when an address is expanded via a
1607 forward or alias file, an alternative address can be specified for delivery
1608 failures of the generated addresses. For a mailing list expansion (see section
1609 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1610 of the list.
1611
1612
1613
1614 .section "Failures to deliver bounce messages" "SECID22"
1615 .cindex "bounce message" "failure to deliver"
1616 If a bounce message (either locally generated or received from a remote host)
1617 itself suffers a permanent delivery failure, the message is left on the queue,
1618 but it is frozen, awaiting the attention of an administrator. There are options
1619 that can be used to make Exim discard such failed messages, or to keep them
1620 for only a short time (see &%timeout_frozen_after%& and
1621 &%ignore_bounce_errors_after%&).
1622
1623
1624
1625
1626
1627 . ////////////////////////////////////////////////////////////////////////////
1628 . ////////////////////////////////////////////////////////////////////////////
1629
1630 .chapter "Building and installing Exim" "CHID3"
1631 .scindex IIDbuex "building Exim"
1632
1633 .section "Unpacking" "SECID23"
1634 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1635 creates a directory with the name of the current release (for example,
1636 &_exim-&version()_&) into which the following files are placed:
1637
1638 .table2 140pt
1639 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1640 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1641   documented"
1642 .irow &_LICENCE_&         "the GNU General Public Licence"
1643 .irow &_Makefile_&        "top-level make file"
1644 .irow &_NOTICE_&          "conditions for the use of Exim"
1645 .irow &_README_&          "list of files, directories and simple build &&&
1646   instructions"
1647 .endtable
1648
1649 Other files whose names begin with &_README_& may also be present. The
1650 following subdirectories are created:
1651
1652 .table2 140pt
1653 .irow &_Local_&           "an empty directory for local configuration files"
1654 .irow &_OS_&              "OS-specific files"
1655 .irow &_doc_&             "documentation files"
1656 .irow &_exim_monitor_&    "source files for the Exim monitor"
1657 .irow &_scripts_&         "scripts used in the build process"
1658 .irow &_src_&             "remaining source files"
1659 .irow &_util_&            "independent utilities"
1660 .endtable
1661
1662 The main utility programs are contained in the &_src_& directory, and are built
1663 with the Exim binary. The &_util_& directory contains a few optional scripts
1664 that may be useful to some sites.
1665
1666
1667 .section "Multiple machine architectures and operating systems" "SECID24"
1668 .cindex "building Exim" "multiple OS/architectures"
1669 The building process for Exim is arranged to make it easy to build binaries for
1670 a number of different architectures and operating systems from the same set of
1671 source files. Compilation does not take place in the &_src_& directory.
1672 Instead, a &'build directory'& is created for each architecture and operating
1673 system.
1674 .cindex "symbolic link" "to build directory"
1675 Symbolic links to the sources are installed in this directory, which is where
1676 the actual building takes place. In most cases, Exim can discover the machine
1677 architecture and operating system for itself, but the defaults can be
1678 overridden if necessary.
1679
1680
1681 .section "PCRE library" "SECTpcre"
1682 .cindex "PCRE library"
1683 Exim no longer has an embedded PCRE library as the vast majority of
1684 modern systems include PCRE as a system library, although you may need
1685 to install the PCRE or PCRE development package for your operating
1686 system. If your system has a normal PCRE installation the Exim build
1687 process will need no further configuration. If the library or the
1688 headers are in an unusual location you will need to either set the PCRE_LIBS
1689 and INCLUDE directives appropriately,
1690 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1691 If your operating system has no
1692 PCRE support then you will need to obtain and build the current PCRE
1693 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1694 More information on PCRE is available at &url(http://www.pcre.org/).
1695
1696 .section "DBM libraries" "SECTdb"
1697 .cindex "DBM libraries" "discussion of"
1698 .cindex "hints database" "DBM files used for"
1699 Even if you do not use any DBM files in your configuration, Exim still needs a
1700 DBM library in order to operate, because it uses indexed files for its hints
1701 databases. Unfortunately, there are a number of DBM libraries in existence, and
1702 different operating systems often have different ones installed.
1703
1704 .cindex "Solaris" "DBM library for"
1705 .cindex "IRIX, DBM library for"
1706 .cindex "BSD, DBM library for"
1707 .cindex "Linux, DBM library for"
1708 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1709 Linux distribution, the DBM configuration should happen automatically, and you
1710 may be able to ignore this section. Otherwise, you may have to learn more than
1711 you would like about DBM libraries from what follows.
1712
1713 .cindex "&'ndbm'& DBM library"
1714 Licensed versions of Unix normally contain a library of DBM functions operating
1715 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1716 versions of Unix seem to vary in what they contain as standard. In particular,
1717 some early versions of Linux have no default DBM library, and different
1718 distributors have chosen to bundle different libraries with their packaged
1719 versions. However, the more recent releases seem to have standardized on the
1720 Berkeley DB library.
1721
1722 Different DBM libraries have different conventions for naming the files they
1723 use. When a program opens a file called &_dbmfile_&, there are several
1724 possibilities:
1725
1726 .olist
1727 A traditional &'ndbm'& implementation, such as that supplied as part of
1728 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1729 .next
1730 .cindex "&'gdbm'& DBM library"
1731 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1732 compatibility interface it makes two different hard links to it with names
1733 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1734 file name is used unmodified.
1735 .next
1736 .cindex "Berkeley DB library"
1737 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1738 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1739 programmer exactly the same as the traditional &'ndbm'& implementation.
1740 .next
1741 If the Berkeley package is used in its native mode, it operates on a single
1742 file called &_dbmfile_&; the programmer's interface is somewhat different to
1743 the traditional &'ndbm'& interface.
1744 .next
1745 To complicate things further, there are several very different versions of the
1746 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1747 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1748 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1749 versions of Berkeley DB can be obtained from
1750 &url(http://www.sleepycat.com/).
1751 .next
1752 .cindex "&'tdb'& DBM library"
1753 Yet another DBM library, called &'tdb'&, is available from
1754 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1755 operates on a single file.
1756 .endlist
1757
1758 .cindex "USE_DB"
1759 .cindex "DBM libraries" "configuration for building"
1760 Exim and its utilities can be compiled to use any of these interfaces. In order
1761 to use any version of the Berkeley DB package in native mode, you must set
1762 USE_DB in an appropriate configuration file (typically
1763 &_Local/Makefile_&). For example:
1764 .code
1765 USE_DB=yes
1766 .endd
1767 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1768 error is diagnosed if you set more than one of these.
1769
1770 At the lowest level, the build-time configuration sets none of these options,
1771 thereby assuming an interface of type (1). However, some operating system
1772 configuration files (for example, those for the BSD operating systems and
1773 Linux) assume type (4) by setting USE_DB as their default, and the
1774 configuration files for Cygwin set USE_GDBM. Anything you set in
1775 &_Local/Makefile_&, however, overrides these system defaults.
1776
1777 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1778 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1779 in one of these lines:
1780 .code
1781 DBMLIB = -ldb
1782 DBMLIB = -ltdb
1783 .endd
1784 Settings like that will work if the DBM library is installed in the standard
1785 place. Sometimes it is not, and the library's header file may also not be in
1786 the default path. You may need to set INCLUDE to specify where the header
1787 file is, and to specify the path to the library more fully in DBMLIB, as in
1788 this example:
1789 .code
1790 INCLUDE=-I/usr/local/include/db-4.1
1791 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1792 .endd
1793 There is further detailed discussion about the various DBM libraries in the
1794 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1795
1796
1797
1798 .section "Pre-building configuration" "SECID25"
1799 .cindex "building Exim" "pre-building configuration"
1800 .cindex "configuration for building Exim"
1801 .cindex "&_Local/Makefile_&"
1802 .cindex "&_src/EDITME_&"
1803 Before building Exim, a local configuration file that specifies options
1804 independent of any operating system has to be created with the name
1805 &_Local/Makefile_&. A template for this file is supplied as the file
1806 &_src/EDITME_&, and it contains full descriptions of all the option settings
1807 therein. These descriptions are therefore not repeated here. If you are
1808 building Exim for the first time, the simplest thing to do is to copy
1809 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1810
1811 There are three settings that you must supply, because Exim will not build
1812 without them. They are the location of the run time configuration file
1813 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1814 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1815 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1816 a colon-separated list of file names; Exim uses the first of them that exists.
1817
1818 There are a few other parameters that can be specified either at build time or
1819 at run time, to enable the same binary to be used on a number of different
1820 machines. However, if the locations of Exim's spool directory and log file
1821 directory (if not within the spool directory) are fixed, it is recommended that
1822 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1823 detected early in Exim's execution (such as a malformed configuration file) can
1824 be logged.
1825
1826 .cindex "content scanning" "specifying at build time"
1827 Exim's interfaces for calling virus and spam scanning software directly from
1828 access control lists are not compiled by default. If you want to include these
1829 facilities, you need to set
1830 .code
1831 WITH_CONTENT_SCAN=yes
1832 .endd
1833 in your &_Local/Makefile_&. For details of the facilities themselves, see
1834 chapter &<<CHAPexiscan>>&.
1835
1836
1837 .cindex "&_Local/eximon.conf_&"
1838 .cindex "&_exim_monitor/EDITME_&"
1839 If you are going to build the Exim monitor, a similar configuration process is
1840 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1841 your installation and saved under the name &_Local/eximon.conf_&. If you are
1842 happy with the default settings described in &_exim_monitor/EDITME_&,
1843 &_Local/eximon.conf_& can be empty, but it must exist.
1844
1845 This is all the configuration that is needed in straightforward cases for known
1846 operating systems. However, the building process is set up so that it is easy
1847 to override options that are set by default or by operating-system-specific
1848 configuration files, for example to change the name of the C compiler, which
1849 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1850 do this.
1851
1852
1853
1854 .section "Support for iconv()" "SECID26"
1855 .cindex "&[iconv()]& support"
1856 .cindex "RFC 2047"
1857 The contents of header lines in messages may be encoded according to the rules
1858 described RFC 2047. This makes it possible to transmit characters that are not
1859 in the ASCII character set, and to label them as being in a particular
1860 character set. When Exim is inspecting header lines by means of the &%$h_%&
1861 mechanism, it decodes them, and translates them into a specified character set
1862 (default is set at build time). The translation is possible only if the operating system
1863 supports the &[iconv()]& function.
1864
1865 However, some of the operating systems that supply &[iconv()]& do not support
1866 very many conversions. The GNU &%libiconv%& library (available from
1867 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1868 systems to remedy this deficiency, as well as on systems that do not supply
1869 &[iconv()]& at all. After installing &%libiconv%&, you should add
1870 .code
1871 HAVE_ICONV=yes
1872 .endd
1873 to your &_Local/Makefile_& and rebuild Exim.
1874
1875
1876
1877 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1878 .cindex "TLS" "including support for TLS"
1879 .cindex "encryption" "including support for"
1880 .cindex "SUPPORT_TLS"
1881 .cindex "OpenSSL" "building Exim with"
1882 .cindex "GnuTLS" "building Exim with"
1883 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1884 command as per RFC 2487. It can also support legacy clients that expect to
1885 start a TLS session immediately on connection to a non-standard port (see the
1886 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1887 line option).
1888
1889 If you want to build Exim with TLS support, you must first install either the
1890 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1891 implementing SSL.
1892
1893 If OpenSSL is installed, you should set
1894 .code
1895 SUPPORT_TLS=yes
1896 TLS_LIBS=-lssl -lcrypto
1897 .endd
1898 in &_Local/Makefile_&. You may also need to specify the locations of the
1899 OpenSSL library and include files. For example:
1900 .code
1901 SUPPORT_TLS=yes
1902 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1903 TLS_INCLUDE=-I/usr/local/openssl/include/
1904 .endd
1905 .cindex "pkg-config" "OpenSSL"
1906 If you have &'pkg-config'& available, then instead you can just use:
1907 .code
1908 SUPPORT_TLS=yes
1909 USE_OPENSSL_PC=openssl
1910 .endd
1911 .cindex "USE_GNUTLS"
1912 If GnuTLS is installed, you should set
1913 .code
1914 SUPPORT_TLS=yes
1915 USE_GNUTLS=yes
1916 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1917 .endd
1918 in &_Local/Makefile_&, and again you may need to specify the locations of the
1919 library and include files. For example:
1920 .code
1921 SUPPORT_TLS=yes
1922 USE_GNUTLS=yes
1923 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1924 TLS_INCLUDE=-I/usr/gnu/include
1925 .endd
1926 .cindex "pkg-config" "GnuTLS"
1927 If you have &'pkg-config'& available, then instead you can just use:
1928 .code
1929 SUPPORT_TLS=yes
1930 USE_GNUTLS=yes
1931 USE_GNUTLS_PC=gnutls
1932 .endd
1933
1934 You do not need to set TLS_INCLUDE if the relevant directory is already
1935 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1936 given in chapter &<<CHAPTLS>>&.
1937
1938
1939
1940
1941 .section "Use of tcpwrappers" "SECID27"
1942
1943 .cindex "tcpwrappers, building Exim to support"
1944 .cindex "USE_TCP_WRAPPERS"
1945 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1946 .cindex "tcp_wrappers_daemon_name"
1947 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1948 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1949 alternative to Exim's own checking facilities for installations that are
1950 already making use of &'tcpwrappers'& for other purposes. To do this, you
1951 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1952 &_tcpd.h_& to be available at compile time, and also ensure that the library
1953 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1954 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1955 you might have
1956 .code
1957 USE_TCP_WRAPPERS=yes
1958 CFLAGS=-O -I/usr/local/include
1959 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1960 .endd
1961 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1962 files is &"exim"&. For example, the line
1963 .code
1964 exim : LOCAL  192.168.1.  .friendly.domain.example
1965 .endd
1966 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1967 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1968 All other connections are denied. The daemon name used by &'tcpwrappers'&
1969 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1970 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1971 configure file. Consult the &'tcpwrappers'& documentation for
1972 further details.
1973
1974
1975 .section "Including support for IPv6" "SECID28"
1976 .cindex "IPv6" "including support for"
1977 Exim contains code for use on systems that have IPv6 support. Setting
1978 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1979 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1980 where the IPv6 support is not fully integrated into the normal include and
1981 library files.
1982
1983 Two different types of DNS record for handling IPv6 addresses have been
1984 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1985 currently seen as the mainstream. Another record type called A6 was proposed
1986 as better than AAAA because it had more flexibility. However, it was felt to be
1987 over-complex, and its status was reduced to &"experimental"&.
1988 Exim used to
1989 have a compile option for including A6 record support but this has now been
1990 withdrawn.
1991
1992
1993
1994 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1995 .cindex "lookup modules"
1996 .cindex "dynamic modules"
1997 .cindex ".so building"
1998 On some platforms, Exim supports not compiling all lookup types directly into
1999 the main binary, instead putting some into external modules which can be loaded
2000 on demand.
2001 This permits packagers to build Exim with support for lookups with extensive
2002 library dependencies without requiring all users to install all of those
2003 dependencies.
2004 Most, but not all, lookup types can be built this way.
2005
2006 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2007 installed; Exim will only load modules from that directory, as a security
2008 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2009 for your OS; see &_OS/Makefile-Linux_& for an example.
2010 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2011 see &_src/EDITME_& for details.
2012
2013 Then, for each module to be loaded dynamically, define the relevant
2014 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2015 For example, this will build in lsearch but load sqlite and mysql support
2016 on demand:
2017 .code
2018 LOOKUP_LSEARCH=yes
2019 LOOKUP_SQLITE=2
2020 LOOKUP_MYSQL=2
2021 .endd
2022
2023
2024 .section "The building process" "SECID29"
2025 .cindex "build directory"
2026 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2027 created, run &'make'& at the top level. It determines the architecture and
2028 operating system types, and creates a build directory if one does not exist.
2029 For example, on a Sun system running Solaris 8, the directory
2030 &_build-SunOS5-5.8-sparc_& is created.
2031 .cindex "symbolic link" "to source files"
2032 Symbolic links to relevant source files are installed in the build directory.
2033
2034 If this is the first time &'make'& has been run, it calls a script that builds
2035 a make file inside the build directory, using the configuration files from the
2036 &_Local_& directory. The new make file is then passed to another instance of
2037 &'make'&. This does the real work, building a number of utility scripts, and
2038 then compiling and linking the binaries for the Exim monitor (if configured), a
2039 number of utility programs, and finally Exim itself. The command &`make
2040 makefile`& can be used to force a rebuild of the make file in the build
2041 directory, should this ever be necessary.
2042
2043 If you have problems building Exim, check for any comments there may be in the
2044 &_README_& file concerning your operating system, and also take a look at the
2045 FAQ, where some common problems are covered.
2046
2047
2048
2049 .section 'Output from &"make"&' "SECID283"
2050 The output produced by the &'make'& process for compile lines is often very
2051 unreadable, because these lines can be very long. For this reason, the normal
2052 output is suppressed by default, and instead output similar to that which
2053 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2054 each module that is being compiled or linked. However, it is still possible to
2055 get the full output, by calling &'make'& like this:
2056 .code
2057 FULLECHO='' make -e
2058 .endd
2059 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2060 command reflection in &'make'&. When you ask for the full output, it is
2061 given in addition to the short output.
2062
2063
2064
2065 .section "Overriding build-time options for Exim" "SECToverride"
2066 .cindex "build-time options, overriding"
2067 The main make file that is created at the beginning of the building process
2068 consists of the concatenation of a number of files which set configuration
2069 values, followed by a fixed set of &'make'& instructions. If a value is set
2070 more than once, the last setting overrides any previous ones. This provides a
2071 convenient way of overriding defaults. The files that are concatenated are, in
2072 order:
2073 .display
2074 &_OS/Makefile-Default_&
2075 &_OS/Makefile-_&<&'ostype'&>
2076 &_Local/Makefile_&
2077 &_Local/Makefile-_&<&'ostype'&>
2078 &_Local/Makefile-_&<&'archtype'&>
2079 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2080 &_OS/Makefile-Base_&
2081 .endd
2082 .cindex "&_Local/Makefile_&"
2083 .cindex "building Exim" "operating system type"
2084 .cindex "building Exim" "architecture type"
2085 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2086 architecture type. &_Local/Makefile_& is required to exist, and the building
2087 process fails if it is absent. The other three &_Local_& files are optional,
2088 and are often not needed.
2089
2090 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2091 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2092 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2093 values are used, thereby providing a means of forcing particular settings.
2094 Otherwise, the scripts try to get values from the &%uname%& command. If this
2095 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2096 of &'ad hoc'& transformations are then applied, to produce the standard names
2097 that Exim expects. You can run these scripts directly from the shell in order
2098 to find out what values are being used on your system.
2099
2100
2101 &_OS/Makefile-Default_& contains comments about the variables that are set
2102 therein. Some (but not all) are mentioned below. If there is something that
2103 needs changing, review the contents of this file and the contents of the make
2104 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2105 default values are.
2106
2107
2108 .cindex "building Exim" "overriding default settings"
2109 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2110 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2111 need to change the original files. Instead, you should make the changes by
2112 putting the new values in an appropriate &_Local_& file. For example,
2113 .cindex "Tru64-Unix build-time settings"
2114 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2115 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2116 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2117 called with the option &%-std1%&, to make it recognize some of the features of
2118 Standard C that Exim uses. (Most other compilers recognize Standard C by
2119 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2120 containing the lines
2121 .code
2122 CC=cc
2123 CFLAGS=-std1
2124 .endd
2125 If you are compiling for just one operating system, it may be easier to put
2126 these lines directly into &_Local/Makefile_&.
2127
2128 Keeping all your local configuration settings separate from the distributed
2129 files makes it easy to transfer them to new versions of Exim simply by copying
2130 the contents of the &_Local_& directory.
2131
2132
2133 .cindex "NIS lookup type" "including support for"
2134 .cindex "NIS+ lookup type" "including support for"
2135 .cindex "LDAP" "including support for"
2136 .cindex "lookup" "inclusion in binary"
2137 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2138 lookup, but not all systems have these components installed, so the default is
2139 not to include the relevant code in the binary. All the different kinds of file
2140 and database lookup that Exim supports are implemented as separate code modules
2141 which are included only if the relevant compile-time options are set. In the
2142 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2143 .code
2144 LOOKUP_LDAP=yes
2145 LOOKUP_NIS=yes
2146 LOOKUP_NISPLUS=yes
2147 .endd
2148 and similar settings apply to the other lookup types. They are all listed in
2149 &_src/EDITME_&. In many cases the relevant include files and interface
2150 libraries need to be installed before compiling Exim.
2151 .cindex "cdb" "including support for"
2152 However, there are some optional lookup types (such as cdb) for which
2153 the code is entirely contained within Exim, and no external include
2154 files or libraries are required. When a lookup type is not included in the
2155 binary, attempts to configure Exim to use it cause run time configuration
2156 errors.
2157
2158 .cindex "pkg-config" "lookups"
2159 .cindex "pkg-config" "authenticators"
2160 Many systems now use a tool called &'pkg-config'& to encapsulate information
2161 about how to compile against a library; Exim has some initial support for
2162 being able to use pkg-config for lookups and authenticators.  For any given
2163 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2164 variable with the &`_PC`& suffix in the name and assign as the value the
2165 name of the package to be queried.  The results of querying via the
2166 &'pkg-config'& command will be added to the appropriate Makefile variables
2167 with &`+=`& directives, so your version of &'make'& will need to support that
2168 syntax.  For instance:
2169 .code
2170 LOOKUP_SQLITE=yes
2171 LOOKUP_SQLITE_PC=sqlite3
2172 AUTH_GSASL=yes
2173 AUTH_GSASL_PC=libgsasl
2174 AUTH_HEIMDAL_GSSAPI=yes
2175 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2176 .endd
2177
2178 .cindex "Perl" "including support for"
2179 Exim can be linked with an embedded Perl interpreter, allowing Perl
2180 subroutines to be called during string expansion. To enable this facility,
2181 .code
2182 EXIM_PERL=perl.o
2183 .endd
2184 must be defined in &_Local/Makefile_&. Details of this facility are given in
2185 chapter &<<CHAPperl>>&.
2186
2187 .cindex "X11 libraries, location of"
2188 The location of the X11 libraries is something that varies a lot between
2189 operating systems, and there may be different versions of X11 to cope
2190 with. Exim itself makes no use of X11, but if you are compiling the Exim
2191 monitor, the X11 libraries must be available.
2192 The following three variables are set in &_OS/Makefile-Default_&:
2193 .code
2194 X11=/usr/X11R6
2195 XINCLUDE=-I$(X11)/include
2196 XLFLAGS=-L$(X11)/lib
2197 .endd
2198 These are overridden in some of the operating-system configuration files. For
2199 example, in &_OS/Makefile-SunOS5_& there is
2200 .code
2201 X11=/usr/openwin
2202 XINCLUDE=-I$(X11)/include
2203 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2204 .endd
2205 If you need to override the default setting for your operating system, place a
2206 definition of all three of these variables into your
2207 &_Local/Makefile-<ostype>_& file.
2208
2209 .cindex "EXTRALIBS"
2210 If you need to add any extra libraries to the link steps, these can be put in a
2211 variable called EXTRALIBS, which appears in all the link commands, but by
2212 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2213 command for linking the main Exim binary, and not for any associated utilities.
2214
2215 .cindex "DBM libraries" "configuration for building"
2216 There is also DBMLIB, which appears in the link commands for binaries that
2217 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2218 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2219 binary, and which can be used, for example, to include additional X11
2220 libraries.
2221
2222 .cindex "configuration file" "editing"
2223 The make file copes with rebuilding Exim correctly if any of the configuration
2224 files are edited. However, if an optional configuration file is deleted, it is
2225 necessary to touch the associated non-optional file (that is,
2226 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2227
2228
2229 .section "OS-specific header files" "SECID30"
2230 .cindex "&_os.h_&"
2231 .cindex "building Exim" "OS-specific C header files"
2232 The &_OS_& directory contains a number of files with names of the form
2233 &_os.h-<ostype>_&. These are system-specific C header files that should not
2234 normally need to be changed. There is a list of macro settings that are
2235 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2236 are porting Exim to a new operating system.
2237
2238
2239
2240 .section "Overriding build-time options for the monitor" "SECID31"
2241 .cindex "building Eximon"
2242 A similar process is used for overriding things when building the Exim monitor,
2243 where the files that are involved are
2244 .display
2245 &_OS/eximon.conf-Default_&
2246 &_OS/eximon.conf-_&<&'ostype'&>
2247 &_Local/eximon.conf_&
2248 &_Local/eximon.conf-_&<&'ostype'&>
2249 &_Local/eximon.conf-_&<&'archtype'&>
2250 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2251 .endd
2252 .cindex "&_Local/eximon.conf_&"
2253 As with Exim itself, the final three files need not exist, and in this case the
2254 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2255 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2256 variables of the same name, preceded by EXIMON_. For example, setting
2257 EXIMON_LOG_DEPTH in the environment overrides the value of
2258 LOG_DEPTH at run time.
2259 .ecindex IIDbuex
2260
2261
2262 .section "Installing Exim binaries and scripts" "SECID32"
2263 .cindex "installing Exim"
2264 .cindex "BIN_DIRECTORY"
2265 The command &`make install`& runs the &(exim_install)& script with no
2266 arguments. The script copies binaries and utility scripts into the directory
2267 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2268 .cindex "setuid" "installing Exim with"
2269 The install script copies files only if they are newer than the files they are
2270 going to replace. The Exim binary is required to be owned by root and have the
2271 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2272 install`& as root so that it can set up the Exim binary in this way. However, in
2273 some special situations (for example, if a host is doing no local deliveries)
2274 it may be possible to run Exim without making the binary setuid root (see
2275 chapter &<<CHAPsecurity>>& for details).
2276
2277 .cindex "CONFIGURE_FILE"
2278 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2279 in &_Local/Makefile_&. If this names a single file, and the file does not
2280 exist, the default configuration file &_src/configure.default_& is copied there
2281 by the installation script. If a run time configuration file already exists, it
2282 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2283 alternative files, no default is installed.
2284
2285 .cindex "system aliases file"
2286 .cindex "&_/etc/aliases_&"
2287 One change is made to the default configuration file when it is installed: the
2288 default configuration contains a router that references a system aliases file.
2289 The path to this file is set to the value specified by
2290 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2291 If the system aliases file does not exist, the installation script creates it,
2292 and outputs a comment to the user.
2293
2294 The created file contains no aliases, but it does contain comments about the
2295 aliases a site should normally have. Mail aliases have traditionally been
2296 kept in &_/etc/aliases_&. However, some operating systems are now using
2297 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2298 Exim's configuration if necessary.
2299
2300 The default configuration uses the local host's name as the only local domain,
2301 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2302 running as the local user. System aliases and &_.forward_& files in users' home
2303 directories are supported, but no NIS or NIS+ support is configured. Domains
2304 other than the name of the local host are routed using the DNS, with delivery
2305 over SMTP.
2306
2307 It is possible to install Exim for special purposes (such as building a binary
2308 distribution) in a private part of the file system. You can do this by a
2309 command such as
2310 .code
2311 make DESTDIR=/some/directory/ install
2312 .endd
2313 This has the effect of pre-pending the specified directory to all the file
2314 paths, except the name of the system aliases file that appears in the default
2315 configuration. (If a default alias file is created, its name &'is'& modified.)
2316 For backwards compatibility, ROOT is used if DESTDIR is not set,
2317 but this usage is deprecated.
2318
2319 .cindex "installing Exim" "what is not installed"
2320 Running &'make install'& does not copy the Exim 4 conversion script
2321 &'convert4r4'&. You will probably run this only once if you are
2322 upgrading from Exim 3. None of the documentation files in the &_doc_&
2323 directory are copied, except for the info files when you have set
2324 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2325
2326 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2327 to their names. The Exim binary itself, however, is handled differently. It is
2328 installed under a name that includes the version number and the compile number,
2329 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2330 called &_exim_& to point to the binary. If you are updating a previous version
2331 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2332 from the directory (as seen by other processes).
2333
2334 .cindex "installing Exim" "testing the script"
2335 If you want to see what the &'make install'& will do before running it for
2336 real, you can pass the &%-n%& option to the installation script by this
2337 command:
2338 .code
2339 make INSTALL_ARG=-n install
2340 .endd
2341 The contents of the variable INSTALL_ARG are passed to the installation
2342 script. You do not need to be root to run this test. Alternatively, you can run
2343 the installation script directly, but this must be from within the build
2344 directory. For example, from the top-level Exim directory you could use this
2345 command:
2346 .code
2347 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2348 .endd
2349 .cindex "installing Exim" "install script options"
2350 There are two other options that can be supplied to the installation script.
2351
2352 .ilist
2353 &%-no_chown%& bypasses the call to change the owner of the installed binary
2354 to root, and the call to make it a setuid binary.
2355 .next
2356 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2357 installed binary.
2358 .endlist
2359
2360 INSTALL_ARG can be used to pass these options to the script. For example:
2361 .code
2362 make INSTALL_ARG=-no_symlink install
2363 .endd
2364 The installation script can also be given arguments specifying which files are
2365 to be copied. For example, to install just the Exim binary, and nothing else,
2366 without creating the symbolic link, you could use:
2367 .code
2368 make INSTALL_ARG='-no_symlink exim' install
2369 .endd
2370
2371
2372
2373 .section "Installing info documentation" "SECTinsinfdoc"
2374 .cindex "installing Exim" "&'info'& documentation"
2375 Not all systems use the GNU &'info'& system for documentation, and for this
2376 reason, the Texinfo source of Exim's documentation is not included in the main
2377 distribution. Instead it is available separately from the ftp site (see section
2378 &<<SECTavail>>&).
2379
2380 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2381 source of the documentation is found in the source tree, running &`make
2382 install`& automatically builds the info files and installs them.
2383
2384
2385
2386 .section "Setting up the spool directory" "SECID33"
2387 .cindex "spool directory" "creating"
2388 When it starts up, Exim tries to create its spool directory if it does not
2389 exist. The Exim uid and gid are used for the owner and group of the spool
2390 directory. Sub-directories are automatically created in the spool directory as
2391 necessary.
2392
2393
2394
2395
2396 .section "Testing" "SECID34"
2397 .cindex "testing" "installation"
2398 Having installed Exim, you can check that the run time configuration file is
2399 syntactically valid by running the following command, which assumes that the
2400 Exim binary directory is within your PATH environment variable:
2401 .code
2402 exim -bV
2403 .endd
2404 If there are any errors in the configuration file, Exim outputs error messages.
2405 Otherwise it outputs the version number and build date,
2406 the DBM library that is being used, and information about which drivers and
2407 other optional code modules are included in the binary.
2408 Some simple routing tests can be done by using the address testing option. For
2409 example,
2410 .display
2411 &`exim -bt`& <&'local username'&>
2412 .endd
2413 should verify that it recognizes a local mailbox, and
2414 .display
2415 &`exim -bt`& <&'remote address'&>
2416 .endd
2417 a remote one. Then try getting it to deliver mail, both locally and remotely.
2418 This can be done by passing messages directly to Exim, without going through a
2419 user agent. For example:
2420 .code
2421 exim -v postmaster@your.domain.example
2422 From: user@your.domain.example
2423 To: postmaster@your.domain.example
2424 Subject: Testing Exim
2425
2426 This is a test message.
2427 ^D
2428 .endd
2429 The &%-v%& option causes Exim to output some verification of what it is doing.
2430 In this case you should see copies of three log lines, one for the message's
2431 arrival, one for its delivery, and one containing &"Completed"&.
2432
2433 .cindex "delivery" "problems with"
2434 If you encounter problems, look at Exim's log files (&'mainlog'& and
2435 &'paniclog'&) to see if there is any relevant information there. Another source
2436 of information is running Exim with debugging turned on, by specifying the
2437 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2438 with debugging turned on by a command of the form
2439 .display
2440 &`exim -d -M`& <&'exim-message-id'&>
2441 .endd
2442 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2443 produces rather a lot of output, but you can cut this down to specific areas.
2444 For example, if you use &%-d-all+route%& only the debugging information
2445 relevant to routing is included. (See the &%-d%& option in chapter
2446 &<<CHAPcommandline>>& for more details.)
2447
2448 .cindex '&"sticky"& bit'
2449 .cindex "lock files"
2450 One specific problem that has shown up on some sites is the inability to do
2451 local deliveries into a shared mailbox directory, because it does not have the
2452 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2453 writing to a mailbox file, and if it cannot create the lock file, the delivery
2454 is deferred. You can get round this either by setting the &"sticky bit"& on the
2455 directory, or by setting a specific group for local deliveries and allowing
2456 that group to create files in the directory (see the comments above the
2457 &(local_delivery)& transport in the default configuration file). Another
2458 approach is to configure Exim not to use lock files, but just to rely on
2459 &[fcntl()]& locking instead. However, you should do this only if all user
2460 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2461 see chapter &<<CHAPappendfile>>&.
2462
2463 One thing that cannot be tested on a system that is already running an MTA is
2464 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2465 &%-oX%& option can be used to run an Exim daemon that listens on some other
2466 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2467 &'exim_checkaccess'& utility can be used to check out policy controls on
2468 incoming SMTP mail.
2469
2470 Testing a new version on a system that is already running Exim can most easily
2471 be done by building a binary with a different CONFIGURE_FILE setting. From
2472 within the run time configuration, all other file and directory names
2473 that Exim uses can be altered, in order to keep it entirely clear of the
2474 production version.
2475
2476
2477 .section "Replacing another MTA with Exim" "SECID35"
2478 .cindex "replacing another MTA"
2479 Building and installing Exim for the first time does not of itself put it in
2480 general use. The name by which the system's MTA is called by mail user agents
2481 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2482 operating system), and it is necessary to make this name point to the &'exim'&
2483 binary in order to get the user agents to pass messages to Exim. This is
2484 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2485 or &_/usr/lib/sendmail_&
2486 .cindex "symbolic link" "to &'exim'& binary"
2487 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2488 privilege and executable status from the old MTA. It is then necessary to stop
2489 and restart the mailer daemon, if one is running.
2490
2491 .cindex "FreeBSD, MTA indirection"
2492 .cindex "&_/etc/mail/mailer.conf_&"
2493 Some operating systems have introduced alternative ways of switching MTAs. For
2494 example, if you are running FreeBSD, you need to edit the file
2495 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2496 described. A typical example of the contents of this file for running Exim is
2497 as follows:
2498 .code
2499 sendmail            /usr/exim/bin/exim
2500 send-mail           /usr/exim/bin/exim
2501 mailq               /usr/exim/bin/exim -bp
2502 newaliases          /usr/bin/true
2503 .endd
2504 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2505 your Exim installation is &"live"&. Check it by sending a message from your
2506 favourite user agent.
2507
2508 You should consider what to tell your users about the change of MTA. Exim may
2509 have different capabilities to what was previously running, and there are
2510 various operational differences such as the text of messages produced by
2511 command line options and in bounce messages. If you allow your users to make
2512 use of Exim's filtering capabilities, you should make the document entitled
2513 &'Exim's interface to mail filtering'& available to them.
2514
2515
2516
2517 .section "Upgrading Exim" "SECID36"
2518 .cindex "upgrading Exim"
2519 If you are already running Exim on your host, building and installing a new
2520 version automatically makes it available to MUAs, or any other programs that
2521 call the MTA directly. However, if you are running an Exim daemon, you do need
2522 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2523 new binary. You do not need to stop processing mail in order to install a new
2524 version of Exim. The install script does not modify an existing runtime
2525 configuration file.
2526
2527
2528
2529
2530 .section "Stopping the Exim daemon on Solaris" "SECID37"
2531 .cindex "Solaris" "stopping Exim on"
2532 The standard command for stopping the mailer daemon on Solaris is
2533 .code
2534 /etc/init.d/sendmail stop
2535 .endd
2536 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2537 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2538 for the text &"sendmail"&; this is not present because the actual program name
2539 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2540 solution is to replace the line that finds the process id with something like
2541 .code
2542 pid=`cat /var/spool/exim/exim-daemon.pid`
2543 .endd
2544 to obtain the daemon's pid directly from the file that Exim saves it in.
2545
2546 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2547 still be received from local processes, and if automatic delivery is configured
2548 (the normal case), deliveries will still occur.
2549
2550
2551
2552
2553 . ////////////////////////////////////////////////////////////////////////////
2554 . ////////////////////////////////////////////////////////////////////////////
2555
2556 .chapter "The Exim command line" "CHAPcommandline"
2557 .scindex IIDclo1 "command line" "options"
2558 .scindex IIDclo2 "options" "command line"
2559 Exim's command line takes the standard Unix form of a sequence of options,
2560 each starting with a hyphen character, followed by a number of arguments. The
2561 options are compatible with the main options of Sendmail, and there are also
2562 some additional options, some of which are compatible with Smail 3. Certain
2563 combinations of options do not make sense, and provoke an error if used.
2564 The form of the arguments depends on which options are set.
2565
2566
2567 .section "Setting options by program name" "SECID38"
2568 .cindex "&'mailq'&"
2569 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2570 were present before any other options.
2571 The &%-bp%& option requests a listing of the contents of the mail queue on the
2572 standard output.
2573 This feature is for compatibility with some systems that contain a command of
2574 that name in one of the standard libraries, symbolically linked to
2575 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2576
2577 .cindex "&'rsmtp'&"
2578 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2579 were present before any other options, for compatibility with Smail. The
2580 &%-bS%& option is used for reading in a number of messages in batched SMTP
2581 format.
2582
2583 .cindex "&'rmail'&"
2584 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2585 &%-oee%& options were present before any other options, for compatibility with
2586 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2587
2588 .cindex "&'runq'&"
2589 .cindex "queue runner"
2590 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2591 were present before any other options, for compatibility with Smail. The &%-q%&
2592 option causes a single queue runner process to be started.
2593
2594 .cindex "&'newaliases'&"
2595 .cindex "alias file" "building"
2596 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2597 If Exim is called under the name &'newaliases'& it behaves as if the option
2598 &%-bi%& were present before any other options, for compatibility with Sendmail.
2599 This option is used for rebuilding Sendmail's alias file. Exim does not have
2600 the concept of a single alias file, but can be configured to run a given
2601 command if called with the &%-bi%& option.
2602
2603
2604 .section "Trusted and admin users" "SECTtrustedadmin"
2605 Some Exim options are available only to &'trusted users'& and others are
2606 available only to &'admin users'&. In the description below, the phrases &"Exim
2607 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2608 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2609 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2610
2611 .ilist
2612 .cindex "trusted users" "definition of"
2613 .cindex "user" "trusted definition of"
2614 The trusted users are root, the Exim user, any user listed in the
2615 &%trusted_users%& configuration option, and any user whose current group or any
2616 supplementary group is one of those listed in the &%trusted_groups%&
2617 configuration option. Note that the Exim group is not automatically trusted.
2618
2619 .cindex '&"From"& line'
2620 .cindex "envelope sender"
2621 Trusted users are always permitted to use the &%-f%& option or a leading
2622 &"From&~"& line to specify the envelope sender of a message that is passed to
2623 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2624 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2625 users to set envelope senders.
2626
2627 .cindex "&'From:'& header line"
2628 .cindex "&'Sender:'& header line"
2629 .cindex "header lines" "From:"
2630 .cindex "header lines" "Sender:"
2631 For a trusted user, there is never any check on the contents of the &'From:'&
2632 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2633 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2634
2635 Trusted users may also specify a host name, host address, interface address,
2636 protocol name, ident value, and authentication data when submitting a message
2637 locally. Thus, they are able to insert messages into Exim's queue locally that
2638 have the characteristics of messages received from a remote host. Untrusted
2639 users may in some circumstances use &%-f%&, but can never set the other values
2640 that are available to trusted users.
2641 .next
2642 .cindex "user" "admin definition of"
2643 .cindex "admin user" "definition of"
2644 The admin users are root, the Exim user, and any user that is a member of the
2645 Exim group or of any group listed in the &%admin_groups%& configuration option.
2646 The current group does not have to be one of these groups.
2647
2648 Admin users are permitted to list the queue, and to carry out certain
2649 operations on messages, for example, to force delivery failures. It is also
2650 necessary to be an admin user in order to see the full information provided by
2651 the Exim monitor, and full debugging output.
2652
2653 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2654 Exim to attempt delivery of messages on its queue is restricted to admin users.
2655 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2656 option false (that is, specifying &%no_prod_requires_admin%&).
2657
2658 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2659 is restricted to admin users unless &%queue_list_requires_admin%& is set
2660 false.
2661 .endlist
2662
2663
2664 &*Warning*&: If you configure your system so that admin users are able to
2665 edit Exim's configuration file, you are giving those users an easy way of
2666 getting root. There is further discussion of this issue at the start of chapter
2667 &<<CHAPconf>>&.
2668
2669
2670
2671
2672 .section "Command line options" "SECID39"
2673 Exim's command line options are described in alphabetical order below. If none
2674 of the options that specifies a specific action (such as starting the daemon or
2675 a queue runner, or testing an address, or receiving a message in a specific
2676 format, or listing the queue) are present, and there is at least one argument
2677 on the command line, &%-bm%& (accept a local message on the standard input,
2678 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2679 outputs a brief message about itself and exits.
2680
2681 . ////////////////////////////////////////////////////////////////////////////
2682 . Insert a stylized XML comment here, to identify the start of the command line
2683 . options. This is for the benefit of the Perl script that automatically
2684 . creates a man page for the options.
2685 . ////////////////////////////////////////////////////////////////////////////
2686
2687 .literal xml
2688 <!-- === Start of command line options === -->
2689 .literal off
2690
2691
2692 .vlist
2693 .vitem &%--%&
2694 .oindex "--"
2695 .cindex "options" "command line; terminating"
2696 This is a pseudo-option whose only purpose is to terminate the options and
2697 therefore to cause subsequent command line items to be treated as arguments
2698 rather than options, even if they begin with hyphens.
2699
2700 .vitem &%--help%&
2701 .oindex "&%--help%&"
2702 This option causes Exim to output a few sentences stating what it is.
2703 The same output is generated if the Exim binary is called with no options and
2704 no arguments.
2705
2706 .vitem &%--version%&
2707 .oindex "&%--version%&"
2708 This option is an alias for &%-bV%& and causes version information to be
2709 displayed.
2710
2711 .vitem &%-Ac%& &&&
2712        &%-Am%&
2713 .oindex "&%-Ac%&"
2714 .oindex "&%-Am%&"
2715 These options are used by Sendmail for selecting configuration files and are
2716 ignored by Exim.
2717
2718 .vitem &%-B%&<&'type'&>
2719 .oindex "&%-B%&"
2720 .cindex "8-bit characters"
2721 .cindex "Sendmail compatibility" "8-bit characters"
2722 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2723 clean; it ignores this option.
2724
2725 .vitem &%-bd%&
2726 .oindex "&%-bd%&"
2727 .cindex "daemon"
2728 .cindex "SMTP" "listener"
2729 .cindex "queue runner"
2730 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2731 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2732 that the daemon should also initiate periodic queue runs.
2733
2734 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2735 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2736 disconnect from the controlling terminal. When running this way, it can be
2737 stopped by pressing ctrl-C.
2738
2739 By default, Exim listens for incoming connections to the standard SMTP port on
2740 all the host's running interfaces. However, it is possible to listen on other
2741 ports, on multiple ports, and only on specific interfaces. Chapter
2742 &<<CHAPinterfaces>>& contains a description of the options that control this.
2743
2744 When a listening daemon
2745 .cindex "daemon" "process id (pid)"
2746 .cindex "pid (process id)" "of daemon"
2747 is started without the use of &%-oX%& (that is, without overriding the normal
2748 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2749 in Exim's spool directory. This location can be overridden by setting
2750 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2751 running as root.
2752
2753 When &%-oX%& is used on the command line to start a listening daemon, the
2754 process id is not written to the normal pid file path. However, &%-oP%& can be
2755 used to specify a path on the command line if a pid file is required.
2756
2757 The SIGHUP signal
2758 .cindex "SIGHUP"
2759 .cindex "daemon" "restarting"
2760 can be used to cause the daemon to re-execute itself. This should be done
2761 whenever Exim's configuration file, or any file that is incorporated into it by
2762 means of the &%.include%& facility, is changed, and also whenever a new version
2763 of Exim is installed. It is not necessary to do this when other files that are
2764 referenced from the configuration (for example, alias files) are changed,
2765 because these are reread each time they are used.
2766
2767 .vitem &%-bdf%&
2768 .oindex "&%-bdf%&"
2769 This option has the same effect as &%-bd%& except that it never disconnects
2770 from the controlling terminal, even when no debugging is specified.
2771
2772 .vitem &%-be%&
2773 .oindex "&%-be%&"
2774 .cindex "testing" "string expansion"
2775 .cindex "expansion" "testing"
2776 Run Exim in expansion testing mode. Exim discards its root privilege, to
2777 prevent ordinary users from using this mode to read otherwise inaccessible
2778 files. If no arguments are given, Exim runs interactively, prompting for lines
2779 of data. Otherwise, it processes each argument in turn.
2780
2781 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2782 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2783 used without command line arguments. If successful, it uses the &[readline()]&
2784 function, which provides extensive line-editing facilities, for reading the
2785 test data. A line history is supported.
2786
2787 Long expansion expressions can be split over several lines by using backslash
2788 continuations. As in Exim's run time configuration, white space at the start of
2789 continuation lines is ignored. Each argument or data line is passed through the
2790 string expansion mechanism, and the result is output. Variable values from the
2791 configuration file (for example, &$qualify_domain$&) are available, but no
2792 message-specific values (such as &$message_exim_id$&) are set, because no message
2793 is being processed (but see &%-bem%& and &%-Mset%&).
2794
2795 &*Note*&: If you use this mechanism to test lookups, and you change the data
2796 files or databases you are using, you must exit and restart Exim before trying
2797 the same lookup again. Otherwise, because each Exim process caches the results
2798 of lookups, you will just get the same result as before.
2799
2800 .vitem &%-bem%&&~<&'filename'&>
2801 .oindex "&%-bem%&"
2802 .cindex "testing" "string expansion"
2803 .cindex "expansion" "testing"
2804 This option operates like &%-be%& except that it must be followed by the name
2805 of a file. For example:
2806 .code
2807 exim -bem /tmp/testmessage
2808 .endd
2809 The file is read as a message (as if receiving a locally-submitted non-SMTP
2810 message) before any of the test expansions are done. Thus, message-specific
2811 variables such as &$message_size$& and &$header_from:$& are available. However,
2812 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2813 recipients are read from the headers in the normal way, and are shown in the
2814 &$recipients$& variable. Note that recipients cannot be given on the command
2815 line, because further arguments are taken as strings to expand (just like
2816 &%-be%&).
2817
2818 .vitem &%-bF%&&~<&'filename'&>
2819 .oindex "&%-bF%&"
2820 .cindex "system filter" "testing"
2821 .cindex "testing" "system filter"
2822 This option is the same as &%-bf%& except that it assumes that the filter being
2823 tested is a system filter. The additional commands that are available only in
2824 system filters are recognized.
2825
2826 .vitem &%-bf%&&~<&'filename'&>
2827 .oindex "&%-bf%&"
2828 .cindex "filter" "testing"
2829 .cindex "testing" "filter file"
2830 .cindex "forward file" "testing"
2831 .cindex "testing" "forward file"
2832 .cindex "Sieve filter" "testing"
2833 This option runs Exim in user filter testing mode; the file is the filter file
2834 to be tested, and a test message must be supplied on the standard input. If
2835 there are no message-dependent tests in the filter, an empty file can be
2836 supplied.
2837
2838 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2839 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2840 filter and a user filter in the same run. For example:
2841 .code
2842 exim -bF /system/filter -bf /user/filter </test/message
2843 .endd
2844 This is helpful when the system filter adds header lines or sets filter
2845 variables that are used by the user filter.
2846
2847 If the test filter file does not begin with one of the special lines
2848 .code
2849 # Exim filter
2850 # Sieve filter
2851 .endd
2852 it is taken to be a normal &_.forward_& file, and is tested for validity under
2853 that interpretation. See sections &<<SECTitenonfilred>>& to
2854 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2855 redirection lists.
2856
2857 The result of an Exim command that uses &%-bf%&, provided no errors are
2858 detected, is a list of the actions that Exim would try to take if presented
2859 with the message for real. More details of filter testing are given in the
2860 separate document entitled &'Exim's interfaces to mail filtering'&.
2861
2862 When testing a filter file,
2863 .cindex "&""From""& line"
2864 .cindex "envelope sender"
2865 .oindex "&%-f%&" "for filter testing"
2866 the envelope sender can be set by the &%-f%& option,
2867 or by a &"From&~"& line at the start of the test message. Various parameters
2868 that would normally be taken from the envelope recipient address of the message
2869 can be set by means of additional command line options (see the next four
2870 options).
2871
2872 .vitem &%-bfd%&&~<&'domain'&>
2873 .oindex "&%-bfd%&"
2874 .vindex "&$qualify_domain$&"
2875 This sets the domain of the recipient address when a filter file is being
2876 tested by means of the &%-bf%& option. The default is the value of
2877 &$qualify_domain$&.
2878
2879 .vitem &%-bfl%&&~<&'local&~part'&>
2880 .oindex "&%-bfl%&"
2881 This sets the local part of the recipient address when a filter file is being
2882 tested by means of the &%-bf%& option. The default is the username of the
2883 process that calls Exim. A local part should be specified with any prefix or
2884 suffix stripped, because that is how it appears to the filter when a message is
2885 actually being delivered.
2886
2887 .vitem &%-bfp%&&~<&'prefix'&>
2888 .oindex "&%-bfp%&"
2889 This sets the prefix of the local part of the recipient address when a filter
2890 file is being tested by means of the &%-bf%& option. The default is an empty
2891 prefix.
2892
2893 .vitem &%-bfs%&&~<&'suffix'&>
2894 .oindex "&%-bfs%&"
2895 This sets the suffix of the local part of the recipient address when a filter
2896 file is being tested by means of the &%-bf%& option. The default is an empty
2897 suffix.
2898
2899 .vitem &%-bh%&&~<&'IP&~address'&>
2900 .oindex "&%-bh%&"
2901 .cindex "testing" "incoming SMTP"
2902 .cindex "SMTP" "testing incoming"
2903 .cindex "testing" "relay control"
2904 .cindex "relaying" "testing configuration"
2905 .cindex "policy control" "testing"
2906 .cindex "debugging" "&%-bh%& option"
2907 This option runs a fake SMTP session as if from the given IP address, using the
2908 standard input and output. The IP address may include a port number at the end,
2909 after a full stop. For example:
2910 .code
2911 exim -bh 10.9.8.7.1234
2912 exim -bh fe80::a00:20ff:fe86:a061.5678
2913 .endd
2914 When an IPv6 address is given, it is converted into canonical form. In the case
2915 of the second example above, the value of &$sender_host_address$& after
2916 conversion to the canonical form is
2917 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2918
2919 Comments as to what is going on are written to the standard error file. These
2920 include lines beginning with &"LOG"& for anything that would have been logged.
2921 This facility is provided for testing configuration options for incoming
2922 messages, to make sure they implement the required policy. For example, you can
2923 test your relay controls using &%-bh%&.
2924
2925 &*Warning 1*&:
2926 .cindex "RFC 1413"
2927 You can test features of the configuration that rely on ident (RFC 1413)
2928 information by using the &%-oMt%& option. However, Exim cannot actually perform
2929 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2930 connection.
2931
2932 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2933 are also skipped when testing using &%-bh%&. If you want these callouts to
2934 occur, use &%-bhc%& instead.
2935
2936 Messages supplied during the testing session are discarded, and nothing is
2937 written to any of the real log files. There may be pauses when DNS (and other)
2938 lookups are taking place, and of course these may time out. The &%-oMi%& option
2939 can be used to specify a specific IP interface and port if this is important,
2940 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2941 session were authenticated.
2942
2943 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2944 output just states whether a given recipient address from a given host is
2945 acceptable or not. See section &<<SECTcheckaccess>>&.
2946
2947 Features such as authentication and encryption, where the client input is not
2948 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2949 specialized SMTP test program such as
2950 &url(http://jetmore.org/john/code/#swaks,swaks).
2951
2952 .vitem &%-bhc%&&~<&'IP&~address'&>
2953 .oindex "&%-bhc%&"
2954 This option operates in the same way as &%-bh%&, except that address
2955 verification callouts are performed if required. This includes consulting and
2956 updating the callout cache database.
2957
2958 .vitem &%-bi%&
2959 .oindex "&%-bi%&"
2960 .cindex "alias file" "building"
2961 .cindex "building alias file"
2962 .cindex "Sendmail compatibility" "&%-bi%& option"
2963 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2964 Exim does not have the concept of a single alias file, and so it cannot mimic
2965 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2966 tend to appear in various scripts such as NIS make files, so the option must be
2967 recognized.
2968
2969 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2970 configuration option is run, under the uid and gid of the caller of Exim. If
2971 the &%-oA%& option is used, its value is passed to the command as an argument.
2972 The command set by &%bi_command%& may not contain arguments. The command can
2973 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2974 if this is required. If the &%bi_command%& option is not set, calling Exim with
2975 &%-bi%& is a no-op.
2976
2977 . // Keep :help first, then the rest in alphabetical order
2978 .vitem &%-bI:help%&
2979 .oindex "&%-bI:help%&"
2980 .cindex "querying exim information"
2981 We shall provide various options starting &`-bI:`& for querying Exim for
2982 information.  The output of many of these will be intended for machine
2983 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2984 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2985 options shall cause Exim to exit after producing the requested output.
2986
2987 .vitem &%-bI:dscp%&
2988 .oindex "&%-bI:dscp%&"
2989 .cindex "DSCP" "values"
2990 This option causes Exim to emit an alphabetically sorted list of all
2991 recognised DSCP names.
2992
2993 .vitem &%-bI:sieve%&
2994 .oindex "&%-bI:sieve%&"
2995 .cindex "Sieve filter" "capabilities"
2996 This option causes Exim to emit an alphabetically sorted list of all supported
2997 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2998 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2999 &`SIEVE`& capability response line.  As the precise list may depend upon
3000 compile-time build options, which this option will adapt to, this is the only
3001 way to guarantee a correct response.
3002
3003 .vitem &%-bm%&
3004 .oindex "&%-bm%&"
3005 .cindex "local message reception"
3006 This option runs an Exim receiving process that accepts an incoming,
3007 locally-generated message on the standard input. The recipients are given as the
3008 command arguments (except when &%-t%& is also present &-- see below). Each
3009 argument can be a comma-separated list of RFC 2822 addresses. This is the
3010 default option for selecting the overall action of an Exim call; it is assumed
3011 if no other conflicting option is present.
3012
3013 If any addresses in the message are unqualified (have no domain), they are
3014 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3015 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3016 suppressing this for special cases.
3017
3018 Policy checks on the contents of local messages can be enforced by means of
3019 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3020
3021 .cindex "return code" "for &%-bm%&"
3022 The return code is zero if the message is successfully accepted. Otherwise, the
3023 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3024
3025 The format
3026 .cindex "message" "format"
3027 .cindex "format" "message"
3028 .cindex "&""From""& line"
3029 .cindex "UUCP" "&""From""& line"
3030 .cindex "Sendmail compatibility" "&""From""& line"
3031 of the message must be as defined in RFC 2822, except that, for
3032 compatibility with Sendmail and Smail, a line in one of the forms
3033 .code
3034 From sender Fri Jan  5 12:55 GMT 1997
3035 From sender Fri, 5 Jan 97 12:55:01
3036 .endd
3037 (with the weekday optional, and possibly with additional text after the date)
3038 is permitted to appear at the start of the message. There appears to be no
3039 authoritative specification of the format of this line. Exim recognizes it by
3040 matching against the regular expression defined by the &%uucp_from_pattern%&
3041 option, which can be changed if necessary.
3042
3043 .oindex "&%-f%&" "overriding &""From""& line"
3044 The specified sender is treated as if it were given as the argument to the
3045 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3046 preference to the address taken from the message. The caller of Exim must be a
3047 trusted user for the sender of a message to be set in this way.
3048
3049 .vitem &%-bmalware%&&~<&'filename'&>
3050 .oindex "&%-bmalware%&"
3051 .cindex "testing", "malware"
3052 .cindex "malware scan test"
3053 This debugging option causes Exim to scan the given file or directory
3054 (depending on the used scanner interface),
3055 using the malware scanning framework.  The option of &%av_scanner%& influences
3056 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3057 the expansion should have defaults which apply to this invocation.  ACLs are
3058 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3059 will never be populated and &%-bmalware%& will fail.
3060
3061 Exim will have changed working directory before resolving the filename, so
3062 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3063 user when it tries to open the file, rather than as the invoking user.
3064 This option requires admin privileges.
3065
3066 The &%-bmalware%& option will not be extended to be more generally useful,
3067 there are better tools for file-scanning.  This option exists to help
3068 administrators verify their Exim and AV scanner configuration.
3069
3070 .vitem &%-bnq%&
3071 .oindex "&%-bnq%&"
3072 .cindex "address qualification, suppressing"
3073 By default, Exim automatically qualifies unqualified addresses (those
3074 without domains) that appear in messages that are submitted locally (that
3075 is, not over TCP/IP). This qualification applies both to addresses in
3076 envelopes, and addresses in header lines. Sender addresses are qualified using
3077 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3078 defaults to the value of &%qualify_domain%&).
3079
3080 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3081 being used to re-submit messages that originally came from remote hosts after
3082 content scanning, you probably do not want to qualify unqualified addresses in
3083 header lines. (Such lines will be present only if you have not enabled a header
3084 syntax check in the appropriate ACL.)
3085
3086 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3087 messages that originate on the local host. When this is used, unqualified
3088 addresses in the envelope provoke errors (causing message rejection) and
3089 unqualified addresses in header lines are left alone.
3090
3091
3092 .vitem &%-bP%&
3093 .oindex "&%-bP%&"
3094 .cindex "configuration options" "extracting"
3095 .cindex "options" "configuration &-- extracting"
3096 If this option is given with no arguments, it causes the values of all Exim's
3097 main configuration options to be written to the standard output. The values
3098 of one or more specific options can be requested by giving their names as
3099 arguments, for example:
3100 .code
3101 exim -bP qualify_domain hold_domains
3102 .endd
3103 .cindex "hiding configuration option values"
3104 .cindex "configuration options" "hiding value of"
3105 .cindex "options" "hiding value of"
3106 However, any option setting that is preceded by the word &"hide"& in the
3107 configuration file is not shown in full, except to an admin user. For other
3108 users, the output is as in this example:
3109 .code
3110 mysql_servers = <value not displayable>
3111 .endd
3112 If &%config%& is given as an argument, the config is
3113 output, as it was parsed, any include file resolved, any comment removed.
3114
3115 If &%config_file%& is given as an argument, the name of the run time
3116 configuration file is output. (&%configure_file%& works too, for
3117 backward compatibility.)
3118 If a list of configuration files was supplied, the value that is output here
3119 is the name of the file that was actually used.
3120
3121 .cindex "options" "hiding name of"
3122 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3123 name will not be output.
3124
3125 .cindex "daemon" "process id (pid)"
3126 .cindex "pid (process id)" "of daemon"
3127 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3128 directories where log files and daemon pid files are written are output,
3129 respectively. If these values are unset, log files are written in a
3130 sub-directory of the spool directory called &%log%&, and the pid file is
3131 written directly into the spool directory.
3132
3133 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3134 .code
3135 exim -bP +local_domains
3136 .endd
3137 it searches for a matching named list of any type (domain, host, address, or
3138 local part) and outputs what it finds.
3139
3140 .cindex "options" "router &-- extracting"
3141 .cindex "options" "transport &-- extracting"
3142 .cindex "options" "authenticator &-- extracting"
3143 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3144 followed by the name of an appropriate driver instance, the option settings for
3145 that driver are output. For example:
3146 .code
3147 exim -bP transport local_delivery
3148 .endd
3149 The generic driver options are output first, followed by the driver's private
3150 options. A list of the names of drivers of a particular type can be obtained by
3151 using one of the words &%router_list%&, &%transport_list%&, or
3152 &%authenticator_list%&, and a complete list of all drivers with their option
3153 settings can be obtained by using &%routers%&, &%transports%&, or
3154 &%authenticators%&.
3155
3156 .cindex "environment"
3157 If &%environment%& is given as an argument, the set of environment
3158 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3159 variables.
3160
3161 .cindex "options" "macro &-- extracting"
3162 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3163 are available, similarly to the drivers.  Because macros are sometimes used
3164 for storing passwords, this option is restricted.
3165 The output format is one item per line.
3166
3167 .vitem &%-bp%&
3168 .oindex "&%-bp%&"
3169 .cindex "queue" "listing messages on"
3170 .cindex "listing" "messages on the queue"
3171 This option requests a listing of the contents of the mail queue on the
3172 standard output. If the &%-bp%& option is followed by a list of message ids,
3173 just those messages are listed. By default, this option can be used only by an
3174 admin user. However, the &%queue_list_requires_admin%& option can be set false
3175 to allow any user to see the queue.
3176
3177 Each message on the queue is displayed as in the following example:
3178 .code
3179 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3180           red.king@looking-glass.fict.example
3181           <other addresses>
3182 .endd
3183 .cindex "message" "size in queue listing"
3184 .cindex "size" "of message"
3185 The first line contains the length of time the message has been on the queue
3186 (in this case 25 minutes), the size of the message (2.9K), the unique local
3187 identifier for the message, and the message sender, as contained in the
3188 envelope. For bounce messages, the sender address is empty, and appears as
3189 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3190 the default sender address, the user's login name is shown in parentheses
3191 before the sender address.
3192
3193 .cindex "frozen messages" "in queue listing"
3194 If the message is frozen (attempts to deliver it are suspended) then the text
3195 &"*** frozen ***"& is displayed at the end of this line.
3196
3197 The recipients of the message (taken from the envelope, not the headers) are
3198 displayed on subsequent lines. Those addresses to which the message has already
3199 been delivered are marked with the letter D. If an original address gets
3200 expanded into several addresses via an alias or forward file, the original is
3201 displayed with a D only when deliveries for all of its child addresses are
3202 complete.
3203
3204
3205 .vitem &%-bpa%&
3206 .oindex "&%-bpa%&"
3207 This option operates like &%-bp%&, but in addition it shows delivered addresses
3208 that were generated from the original top level address(es) in each message by
3209 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3210 of just &"D"&.
3211
3212
3213 .vitem &%-bpc%&
3214 .oindex "&%-bpc%&"
3215 .cindex "queue" "count of messages on"
3216 This option counts the number of messages on the queue, and writes the total
3217 to the standard output. It is restricted to admin users, unless
3218 &%queue_list_requires_admin%& is set false.
3219
3220
3221 .vitem &%-bpr%&
3222 .oindex "&%-bpr%&"
3223 This option operates like &%-bp%&, but the output is not sorted into
3224 chronological order of message arrival. This can speed it up when there are
3225 lots of messages on the queue, and is particularly useful if the output is
3226 going to be post-processed in a way that doesn't need the sorting.
3227
3228 .vitem &%-bpra%&
3229 .oindex "&%-bpra%&"
3230 This option is a combination of &%-bpr%& and &%-bpa%&.
3231
3232 .vitem &%-bpru%&
3233 .oindex "&%-bpru%&"
3234 This option is a combination of &%-bpr%& and &%-bpu%&.
3235
3236
3237 .vitem &%-bpu%&
3238 .oindex "&%-bpu%&"
3239 This option operates like &%-bp%& but shows only undelivered top-level
3240 addresses for each message displayed. Addresses generated by aliasing or
3241 forwarding are not shown, unless the message was deferred after processing by a
3242 router with the &%one_time%& option set.
3243
3244
3245 .vitem &%-brt%&
3246 .oindex "&%-brt%&"
3247 .cindex "testing" "retry configuration"
3248 .cindex "retry" "configuration testing"
3249 This option is for testing retry rules, and it must be followed by up to three
3250 arguments. It causes Exim to look for a retry rule that matches the values
3251 and to write it to the standard output. For example:
3252 .code
3253 exim -brt bach.comp.mus.example
3254 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3255 .endd
3256 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3257 argument, which is required, can be a complete address in the form
3258 &'local_part@domain'&, or it can be just a domain name. If the second argument
3259 contains a dot, it is interpreted as an optional second domain name; if no
3260 retry rule is found for the first argument, the second is tried. This ties in
3261 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3262 rule is found that matches the host, one that matches the mail domain is
3263 sought. Finally, an argument that is the name of a specific delivery error, as
3264 used in setting up retry rules, can be given. For example:
3265 .code
3266 exim -brt haydn.comp.mus.example quota_3d
3267 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3268 .endd
3269
3270 .vitem &%-brw%&
3271 .oindex "&%-brw%&"
3272 .cindex "testing" "rewriting"
3273 .cindex "rewriting" "testing"
3274 This option is for testing address rewriting rules, and it must be followed by
3275 a single argument, consisting of either a local part without a domain, or a
3276 complete address with a fully qualified domain. Exim outputs how this address
3277 would be rewritten for each possible place it might appear. See chapter
3278 &<<CHAPrewrite>>& for further details.
3279
3280 .vitem &%-bS%&
3281 .oindex "&%-bS%&"
3282 .cindex "SMTP" "batched incoming"
3283 .cindex "batched SMTP input"
3284 This option is used for batched SMTP input, which is an alternative interface
3285 for non-interactive local message submission. A number of messages can be
3286 submitted in a single run. However, despite its name, this is not really SMTP
3287 input. Exim reads each message's envelope from SMTP commands on the standard
3288 input, but generates no responses. If the caller is trusted, or
3289 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3290 believed; otherwise the sender is always the caller of Exim.
3291
3292 The message itself is read from the standard input, in SMTP format (leading
3293 dots doubled), terminated by a line containing just a single dot. An error is
3294 provoked if the terminating dot is missing. A further message may then follow.
3295
3296 As for other local message submissions, the contents of incoming batch SMTP
3297 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3298 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3299 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3300
3301 Some other SMTP commands are recognized in the input. HELO and EHLO act
3302 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3303 QUIT quits, ignoring the rest of the standard input.
3304
3305 .cindex "return code" "for &%-bS%&"
3306 If any error is encountered, reports are written to the standard output and
3307 error streams, and Exim gives up immediately. The return code is 0 if no error
3308 was detected; it is 1 if one or more messages were accepted before the error
3309 was detected; otherwise it is 2.
3310
3311 More details of input using batched SMTP are given in section
3312 &<<SECTincomingbatchedSMTP>>&.
3313
3314 .vitem &%-bs%&
3315 .oindex "&%-bs%&"
3316 .cindex "SMTP" "local input"
3317 .cindex "local SMTP input"
3318 This option causes Exim to accept one or more messages by reading SMTP commands
3319 on the standard input, and producing SMTP replies on the standard output. SMTP
3320 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3321 Some user agents use this interface as a way of passing locally-generated
3322 messages to the MTA.
3323
3324 In
3325 .cindex "sender" "source of"
3326 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3327 set, the senders of messages are taken from the SMTP MAIL commands.
3328 Otherwise the content of these commands is ignored and the sender is set up as
3329 the calling user. Unqualified addresses are automatically qualified using
3330 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3331 &%-bnq%& option is used.
3332
3333 .cindex "inetd"
3334 The
3335 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3336 using a listening daemon. Exim can distinguish the two cases by checking
3337 whether the standard input is a TCP/IP socket. When Exim is called from
3338 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3339 above concerning senders and qualification do not apply. In this situation,
3340 Exim behaves in exactly the same way as it does when receiving a message via
3341 the listening daemon.
3342
3343 .vitem &%-bt%&
3344 .oindex "&%-bt%&"
3345 .cindex "testing" "addresses"
3346 .cindex "address" "testing"
3347 This option runs Exim in address testing mode, in which each argument is taken
3348 as a recipient address to be tested for deliverability. The results are
3349 written to the standard output. If a test fails, and the caller is not an admin
3350 user, no details of the failure are output, because these might contain
3351 sensitive information such as usernames and passwords for database lookups.
3352
3353 If no arguments are given, Exim runs in an interactive manner, prompting with a
3354 right angle bracket for addresses to be tested.
3355
3356 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3357 &[readline()]& function, because it is running as &'root'& and there are
3358 security issues.
3359
3360 Each address is handled as if it were the recipient address of a message
3361 (compare the &%-bv%& option). It is passed to the routers and the result is
3362 written to the standard output. However, any router that has
3363 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3364 genuine routing tests if your first router passes everything to a scanner
3365 program.
3366
3367 .cindex "return code" "for &%-bt%&"
3368 The return code is 2 if any address failed outright; it is 1 if no address
3369 failed outright but at least one could not be resolved for some reason. Return
3370 code 0 is given only when all addresses succeed.
3371
3372 .cindex "duplicate addresses"
3373 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3374 addresses after routing is complete, so that only one delivery takes place.
3375 This does not happen when testing with &%-bt%&; the full results of routing are
3376 always shown.
3377
3378 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3379 routers in the configuration makes any tests on the sender address of a
3380 message,
3381 .oindex "&%-f%&" "for address testing"
3382 you can use the &%-f%& option to set an appropriate sender when running
3383 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3384 default qualifying domain. However, if you have set up (for example) routers
3385 whose behaviour depends on the contents of an incoming message, you cannot test
3386 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3387 doing such tests.
3388
3389 .vitem &%-bV%&
3390 .oindex "&%-bV%&"
3391 .cindex "version number of Exim"
3392 This option causes Exim to write the current version number, compilation
3393 number, and compilation date of the &'exim'& binary to the standard output.
3394 It also lists the DBM library that is being used, the optional modules (such as
3395 specific lookup types), the drivers that are included in the binary, and the
3396 name of the run time configuration file that is in use.
3397
3398 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3399 configuration file. However, this is a static check only. It cannot check
3400 values that are to be expanded. For example, although a misspelt ACL verb is
3401 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3402 alone to discover (for example) all the typos in the configuration; some
3403 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3404 dynamic testing facilities.
3405
3406 .vitem &%-bv%&
3407 .oindex "&%-bv%&"
3408 .cindex "verifying address" "using &%-bv%&"
3409 .cindex "address" "verification"
3410 This option runs Exim in address verification mode, in which each argument is
3411 taken as a recipient address to be verified by the routers. (This does
3412 not involve any verification callouts). During normal operation, verification
3413 happens mostly as a consequence processing a &%verify%& condition in an ACL
3414 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3415 including callouts, see the &%-bh%& and &%-bhc%& options.
3416
3417 If verification fails, and the caller is not an admin user, no details of the
3418 failure are output, because these might contain sensitive information such as
3419 usernames and passwords for database lookups.
3420
3421 If no arguments are given, Exim runs in an interactive manner, prompting with a
3422 right angle bracket for addresses to be verified.
3423
3424 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3425 &[readline()]& function, because it is running as &'exim'& and there are
3426 security issues.
3427
3428 Verification differs from address testing (the &%-bt%& option) in that routers
3429 that have &%no_verify%& set are skipped, and if the address is accepted by a
3430 router that has &%fail_verify%& set, verification fails. The address is
3431 verified as a recipient if &%-bv%& is used; to test verification for a sender
3432 address, &%-bvs%& should be used.
3433
3434 If the &%-v%& option is not set, the output consists of a single line for each
3435 address, stating whether it was verified or not, and giving a reason in the
3436 latter case. Without &%-v%&, generating more than one address by redirection
3437 causes verification to end successfully, without considering the generated
3438 addresses. However, if just one address is generated, processing continues,
3439 and the generated address must verify successfully for the overall verification
3440 to succeed.
3441
3442 When &%-v%& is set, more details are given of how the address has been handled,
3443 and in the case of address redirection, all the generated addresses are also
3444 considered. Verification may succeed for some and fail for others.
3445
3446 The
3447 .cindex "return code" "for &%-bv%&"
3448 return code is 2 if any address failed outright; it is 1 if no address
3449 failed outright but at least one could not be resolved for some reason. Return
3450 code 0 is given only when all addresses succeed.
3451
3452 If any of the routers in the configuration makes any tests on the sender
3453 address of a message, you should use the &%-f%& option to set an appropriate
3454 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3455 calling user at the default qualifying domain.
3456
3457 .vitem &%-bvs%&
3458 .oindex "&%-bvs%&"
3459 This option acts like &%-bv%&, but verifies the address as a sender rather
3460 than a recipient address. This affects any rewriting and qualification that
3461 might happen.
3462
3463 .vitem &%-bw%&
3464 .oindex "&%-bw%&"
3465 .cindex "daemon"
3466 .cindex "inetd"
3467 .cindex "inetd" "wait mode"
3468 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3469 similarly to the &%-bd%& option.  All port specifications on the command-line
3470 and in the configuration file are ignored.  Queue-running may not be specified.
3471
3472 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3473 listening for connections.  This permits the system to start up and have
3474 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3475 each port only when the first connection is received.
3476
3477 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3478 which the daemon will exit, which should cause inetd to listen once more.
3479
3480 .vitem &%-C%&&~<&'filelist'&>
3481 .oindex "&%-C%&"
3482 .cindex "configuration file" "alternate"
3483 .cindex "CONFIGURE_FILE"
3484 .cindex "alternate configuration file"
3485 This option causes Exim to find the run time configuration file from the given
3486 list instead of from the list specified by the CONFIGURE_FILE
3487 compile-time setting. Usually, the list will consist of just a single file
3488 name, but it can be a colon-separated list of names. In this case, the first
3489 file that exists is used. Failure to open an existing file stops Exim from
3490 proceeding any further along the list, and an error is generated.
3491
3492 When this option is used by a caller other than root, and the list is different
3493 from the compiled-in list, Exim gives up its root privilege immediately, and
3494 runs with the real and effective uid and gid set to those of the caller.
3495 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3496 file contains a list of full pathnames, one per line, for configuration files
3497 which are trusted. Root privilege is retained for any configuration file so
3498 listed, as long as the caller is the Exim user (or the user specified in the
3499 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3500 not writeable by inappropriate users or groups.
3501
3502 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3503 configuration using &%-C%& right through message reception and delivery,
3504 even if the caller is root. The reception works, but by that time, Exim is
3505 running as the Exim user, so when it re-executes to regain privilege for the
3506 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3507 test reception and delivery using two separate commands (one to put a message
3508 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3509
3510 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3511 prefix string with which any file named in a &%-C%& command line option
3512 must start. In addition, the file name must not contain the sequence &`/../`&.
3513 However, if the value of the &%-C%& option is identical to the value of
3514 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3515 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3516 unset, any file name can be used with &%-C%&.
3517
3518 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3519 to a directory to which only root has access. This prevents someone who has
3520 broken into the Exim account from running a privileged Exim with an arbitrary
3521 configuration file.
3522
3523 The &%-C%& facility is useful for ensuring that configuration files are
3524 syntactically correct, but cannot be used for test deliveries, unless the
3525 caller is privileged, or unless it is an exotic configuration that does not
3526 require privilege. No check is made on the owner or group of the files
3527 specified by this option.
3528
3529
3530 .vitem &%-D%&<&'macro'&>=<&'value'&>
3531 .oindex "&%-D%&"
3532 .cindex "macro" "setting on command line"
3533 This option can be used to override macro definitions in the configuration file
3534 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3535 unprivileged caller, it causes Exim to give up its root privilege.
3536 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3537 completely disabled, and its use causes an immediate error exit.
3538
3539 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3540 colon-separated list of macros which are considered safe and, if &%-D%& only
3541 supplies macros from this list, and the values are acceptable, then Exim will
3542 not give up root privilege if the caller is root, the Exim run-time user, or
3543 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3544 to be removed in the future.  Acceptable values for the macros satisfy the
3545 regexp: &`^[A-Za-z0-9_/.-]*$`&
3546
3547 The entire option (including equals sign if present) must all be within one
3548 command line item. &%-D%& can be used to set the value of a macro to the empty
3549 string, in which case the equals sign is optional. These two commands are
3550 synonymous:
3551 .code
3552 exim -DABC  ...
3553 exim -DABC= ...
3554 .endd
3555 To include spaces in a macro definition item, quotes must be used. If you use
3556 quotes, spaces are permitted around the macro name and the equals sign. For
3557 example:
3558 .code
3559 exim '-D ABC = something' ...
3560 .endd
3561 &%-D%& may be repeated up to 10 times on a command line.
3562 Only macro names up to 22 letters long can be set.
3563
3564
3565 .vitem &%-d%&<&'debug&~options'&>
3566 .oindex "&%-d%&"
3567 .cindex "debugging" "list of selectors"
3568 .cindex "debugging" "&%-d%& option"
3569 This option causes debugging information to be written to the standard
3570 error stream. It is restricted to admin users because debugging output may show
3571 database queries that contain password information. Also, the details of users'
3572 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3573 writes an error message to the standard error stream and exits with a non-zero
3574 return code.
3575
3576 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3577 standard debugging data is output. This can be reduced, or increased to include
3578 some more rarely needed information, by directly following &%-d%& with a string
3579 made up of names preceded by plus or minus characters. These add or remove sets
3580 of debugging data, respectively. For example, &%-d+filter%& adds filter
3581 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3582 no spaces are allowed in the debug setting. The available debugging categories
3583 are:
3584 .display
3585 &`acl            `& ACL interpretation
3586 &`auth           `& authenticators
3587 &`deliver        `& general delivery logic
3588 &`dns            `& DNS lookups (see also resolver)
3589 &`dnsbl          `& DNS black list (aka RBL) code
3590 &`exec           `& arguments for &[execv()]& calls
3591 &`expand         `& detailed debugging for string expansions
3592 &`filter         `& filter handling
3593 &`hints_lookup   `& hints data lookups
3594 &`host_lookup    `& all types of name-to-IP address handling
3595 &`ident          `& ident lookup
3596 &`interface      `& lists of local interfaces
3597 &`lists          `& matching things in lists
3598 &`load           `& system load checks
3599 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3600                     &<<CHAPlocalscan>>&)
3601 &`lookup         `& general lookup code and all lookups
3602 &`memory         `& memory handling
3603 &`pid            `& add pid to debug output lines
3604 &`process_info   `& setting info for the process log
3605 &`queue_run      `& queue runs
3606 &`receive        `& general message reception logic
3607 &`resolver       `& turn on the DNS resolver's debugging output
3608 &`retry          `& retry handling
3609 &`rewrite        `& address rewriting
3610 &`route          `& address routing
3611 &`timestamp      `& add timestamp to debug output lines
3612 &`tls            `& TLS logic
3613 &`transport      `& transports
3614 &`uid            `& changes of uid/gid and looking up uid/gid
3615 &`verify         `& address verification logic
3616 &`all            `& almost all of the above (see below), and also &%-v%&
3617 .endd
3618 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3619 for &`-all`&. The reason for this is that &`+all`& is something that people
3620 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3621 is included, an awful lot of output that is very rarely of interest is
3622 generated, so it now has to be explicitly requested. However, &`-all`& does
3623 turn everything off.
3624
3625 .cindex "resolver, debugging output"
3626 .cindex "DNS resolver, debugging output"
3627 The &`resolver`& option produces output only if the DNS resolver was compiled
3628 with DEBUG enabled. This is not the case in some operating systems. Also,
3629 unfortunately, debugging output from the DNS resolver is written to stdout
3630 rather than stderr.
3631
3632 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3633 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3634 However, the &`pid`& selector is forced when debugging is turned on for a
3635 daemon, which then passes it on to any re-executed Exims. Exim also
3636 automatically adds the pid to debug lines when several remote deliveries are
3637 run in parallel.
3638
3639 The &`timestamp`& selector causes the current time to be inserted at the start
3640 of all debug output lines. This can be useful when trying to track down delays
3641 in processing.
3642
3643 If the &%debug_print%& option is set in any driver, it produces output whenever
3644 any debugging is selected, or if &%-v%& is used.
3645
3646 .vitem &%-dd%&<&'debug&~options'&>
3647 .oindex "&%-dd%&"
3648 This option behaves exactly like &%-d%& except when used on a command that
3649 starts a daemon process. In that case, debugging is turned off for the
3650 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3651 behaviour of the daemon without creating as much output as full debugging does.
3652
3653 .vitem &%-dropcr%&
3654 .oindex "&%-dropcr%&"
3655 This is an obsolete option that is now a no-op. It used to affect the way Exim
3656 handled CR and LF characters in incoming messages. What happens now is
3657 described in section &<<SECTlineendings>>&.
3658
3659 .vitem &%-E%&
3660 .oindex "&%-E%&"
3661 .cindex "bounce message" "generating"
3662 This option specifies that an incoming message is a locally-generated delivery
3663 failure report. It is used internally by Exim when handling delivery failures
3664 and is not intended for external use. Its only effect is to stop Exim
3665 generating certain messages to the postmaster, as otherwise message cascades
3666 could occur in some situations. As part of the same option, a message id may
3667 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3668 new message contains the id, following &"R="&, as a cross-reference.
3669
3670 .vitem &%-e%&&'x'&
3671 .oindex "&%-e%&&'x'&"
3672 There are a number of Sendmail options starting with &%-oe%& which seem to be
3673 called by various programs without the leading &%o%& in the option. For
3674 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3675 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3676
3677 .vitem &%-F%&&~<&'string'&>
3678 .oindex "&%-F%&"
3679 .cindex "sender" "name"
3680 .cindex "name" "of sender"
3681 This option sets the sender's full name for use when a locally-generated
3682 message is being accepted. In the absence of this option, the user's &'gecos'&
3683 entry from the password data is used. As users are generally permitted to alter
3684 their &'gecos'& entries, no security considerations are involved. White space
3685 between &%-F%& and the <&'string'&> is optional.
3686
3687 .vitem &%-f%&&~<&'address'&>
3688 .oindex "&%-f%&"
3689 .cindex "sender" "address"
3690 .cindex "address" "sender"
3691 .cindex "trusted users"
3692 .cindex "envelope sender"
3693 .cindex "user" "trusted"
3694 This option sets the address of the envelope sender of a locally-generated
3695 message (also known as the return path). The option can normally be used only
3696 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3697 users to use it.
3698
3699 Processes running as root or the Exim user are always trusted. Other
3700 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3701 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3702 of a local message is set to the caller's login name at the default qualify
3703 domain.
3704
3705 There is one exception to the restriction on the use of &%-f%&: an empty sender
3706 can be specified by any user, trusted or not, to create a message that can
3707 never provoke a bounce. An empty sender can be specified either as an empty
3708 string, or as a pair of angle brackets with nothing between them, as in these
3709 examples of shell commands:
3710 .code
3711 exim -f '<>' user@domain
3712 exim -f "" user@domain
3713 .endd
3714 In addition, the use of &%-f%& is not restricted when testing a filter file
3715 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3716 &%-bv%& options.
3717
3718 Allowing untrusted users to change the sender address does not of itself make
3719 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3720 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3721 though this can be overridden by setting &%no_local_from_check%&.
3722
3723 White
3724 .cindex "&""From""& line"
3725 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3726 given as two arguments or one combined argument). The sender of a
3727 locally-generated message can also be set (when permitted) by an initial
3728 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3729 if &%-f%& is also present, it overrides &"From&~"&.
3730
3731 .vitem &%-G%&
3732 .oindex "&%-G%&"
3733 .cindex "submission fixups, suppressing (command-line)"
3734 This option is equivalent to an ACL applying:
3735 .code
3736 control = suppress_local_fixups
3737 .endd
3738 for every message received.  Note that Sendmail will complain about such
3739 bad formatting, where Exim silently just does not fix it up.  This may change
3740 in future.
3741
3742 As this affects audit information, the caller must be a trusted user to use
3743 this option.
3744
3745 .vitem &%-h%&&~<&'number'&>
3746 .oindex "&%-h%&"
3747 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3748 This option is accepted for compatibility with Sendmail, but has no effect. (In
3749 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3750 headers.)
3751
3752 .vitem &%-i%&
3753 .oindex "&%-i%&"
3754 .cindex "Solaris" "&'mail'& command"
3755 .cindex "dot" "in incoming non-SMTP message"
3756 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3757 line by itself should not terminate an incoming, non-SMTP message. I can find
3758 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3759 command in Solaris 2.4 uses it. See also &%-ti%&.
3760
3761 .vitem &%-L%&&~<&'tag'&>
3762 .oindex "&%-L%&"
3763 .cindex "syslog" "process name; set with flag"
3764 This option is equivalent to setting &%syslog_processname%& in the config
3765 file and setting &%log_file_path%& to &`syslog`&.
3766 Its use is restricted to administrators.  The configuration file has to be
3767 read and parsed, to determine access rights, before this is set and takes
3768 effect, so early configuration file errors will not honour this flag.
3769
3770 The tag should not be longer than 32 characters.
3771
3772 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3773 .oindex "&%-M%&"
3774 .cindex "forcing delivery"
3775 .cindex "delivery" "forcing attempt"
3776 .cindex "frozen messages" "forcing delivery"
3777 This option requests Exim to run a delivery attempt on each message in turn. If
3778 any of the messages are frozen, they are automatically thawed before the
3779 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3780 and &%hold_domains%& are ignored.
3781
3782 Retry
3783 .cindex "hints database" "overriding retry hints"
3784 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3785 the normal retry time has not yet been reached. This option requires the caller
3786 to be an admin user. However, there is an option called &%prod_requires_admin%&
3787 which can be set false to relax this restriction (and also the same requirement
3788 for the &%-q%&, &%-R%&, and &%-S%& options).
3789
3790 The deliveries happen synchronously, that is, the original Exim process does
3791 not terminate until all the delivery attempts have finished. No output is
3792 produced unless there is a serious error. If you want to see what is happening,
3793 use the &%-v%& option as well, or inspect Exim's main log.
3794
3795 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3796 .oindex "&%-Mar%&"
3797 .cindex "message" "adding recipients"
3798 .cindex "recipient" "adding"
3799 This option requests Exim to add the addresses to the list of recipients of the
3800 message (&"ar"& for &"add recipients"&). The first argument must be a message
3801 id, and the remaining ones must be email addresses. However, if the message is
3802 active (in the middle of a delivery attempt), it is not altered. This option
3803 can be used only by an admin user.
3804
3805 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3806         &~<&'message&~id'&>"
3807 .oindex "&%-MC%&"
3808 .cindex "SMTP" "passed connection"
3809 .cindex "SMTP" "multiple deliveries"
3810 .cindex "multiple SMTP deliveries"
3811 This option is not intended for use by external callers. It is used internally
3812 by Exim to invoke another instance of itself to deliver a waiting message using
3813 an existing SMTP connection, which is passed as the standard input. Details are
3814 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3815 must be root or the Exim user in order to use it.
3816
3817 .vitem &%-MCA%&
3818 .oindex "&%-MCA%&"
3819 This option is not intended for use by external callers. It is used internally
3820 by Exim in conjunction with the &%-MC%& option. It signifies that the
3821 connection to the remote host has been authenticated.
3822
3823 .vitem &%-MCD%&
3824 .oindex "&%-MCD%&"
3825 This option is not intended for use by external callers. It is used internally
3826 by Exim in conjunction with the &%-MC%& option. It signifies that the
3827 remote host supports the ESMTP &_DSN_& extension.
3828
3829 .vitem &%-MCG%&
3830 .oindex "&%-MCG%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option. It signifies that an
3833 alternate queue is used, named by the following option.
3834
3835 .vitem &%-MCP%&
3836 .oindex "&%-MCP%&"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3839 which Exim is connected supports pipelining.
3840
3841 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3842 .oindex "&%-MCQ%&"
3843 This option is not intended for use by external callers. It is used internally
3844 by Exim in conjunction with the &%-MC%& option when the original delivery was
3845 started by a queue runner. It passes on the process id of the queue runner,
3846 together with the file descriptor number of an open pipe. Closure of the pipe
3847 signals the final completion of the sequence of processes that are passing
3848 messages through the same SMTP connection.
3849
3850 .vitem &%-MCS%&
3851 .oindex "&%-MCS%&"
3852 This option is not intended for use by external callers. It is used internally
3853 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3854 SMTP SIZE option should be used on messages delivered down the existing
3855 connection.
3856
3857 .vitem &%-MCT%&
3858 .oindex "&%-MCT%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3861 host to which Exim is connected supports TLS encryption.
3862
3863 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3864 .oindex "&%-Mc%&"
3865 .cindex "hints database" "not overridden by &%-Mc%&"
3866 .cindex "delivery" "manually started &-- not forced"
3867 This option requests Exim to run a delivery attempt on each message in turn,
3868 but unlike the &%-M%& option, it does check for retry hints, and respects any
3869 that are found. This option is not very useful to external callers. It is
3870 provided mainly for internal use by Exim when it needs to re-invoke itself in
3871 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3872 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3873 respects retry times and other options such as &%hold_domains%& that are
3874 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3875 If you want to run a specific delivery as if in a queue run, you should use
3876 &%-q%& with a message id argument. A distinction between queue run deliveries
3877 and other deliveries is made in one or two places.
3878
3879 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3880 .oindex "&%-Mes%&"
3881 .cindex "message" "changing sender"
3882 .cindex "sender" "changing"
3883 This option requests Exim to change the sender address in the message to the
3884 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3885 &"edit sender"&). There must be exactly two arguments. The first argument must
3886 be a message id, and the second one an email address. However, if the message
3887 is active (in the middle of a delivery attempt), its status is not altered.
3888 This option can be used only by an admin user.
3889
3890 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3891 .oindex "&%-Mf%&"
3892 .cindex "freezing messages"
3893 .cindex "message" "manually freezing"
3894 This option requests Exim to mark each listed message as &"frozen"&. This
3895 prevents any delivery attempts taking place until the message is &"thawed"&,
3896 either manually or as a result of the &%auto_thaw%& configuration option.
3897 However, if any of the messages are active (in the middle of a delivery
3898 attempt), their status is not altered. This option can be used only by an admin
3899 user.
3900
3901 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3902 .oindex "&%-Mg%&"
3903 .cindex "giving up on messages"
3904 .cindex "message" "abandoning delivery attempts"
3905 .cindex "delivery" "abandoning further attempts"
3906 This option requests Exim to give up trying to deliver the listed messages,
3907 including any that are frozen. However, if any of the messages are active,
3908 their status is not altered. For non-bounce messages, a delivery error message
3909 is sent to the sender, containing the text &"cancelled by administrator"&.
3910 Bounce messages are just discarded. This option can be used only by an admin
3911 user.
3912
3913 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3914 .oindex "&%-Mmad%&"
3915 .cindex "delivery" "cancelling all"
3916 This option requests Exim to mark all the recipient addresses in the messages
3917 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3918 message is active (in the middle of a delivery attempt), its status is not
3919 altered. This option can be used only by an admin user.
3920
3921 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3922 .oindex "&%-Mmd%&"
3923 .cindex "delivery" "cancelling by address"
3924 .cindex "recipient" "removing"
3925 .cindex "removing recipients"
3926 This option requests Exim to mark the given addresses as already delivered
3927 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3928 the remaining ones must be email addresses. These are matched to recipient
3929 addresses in the message in a case-sensitive manner. If the message is active
3930 (in the middle of a delivery attempt), its status is not altered. This option
3931 can be used only by an admin user.
3932
3933 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3934 .oindex "&%-Mrm%&"
3935 .cindex "removing messages"
3936 .cindex "abandoning mail"
3937 .cindex "message" "manually discarding"
3938 This option requests Exim to remove the given messages from the queue. No
3939 bounce messages are sent; each message is simply forgotten. However, if any of
3940 the messages are active, their status is not altered. This option can be used
3941 only by an admin user or by the user who originally caused the message to be
3942 placed on the queue.
3943
3944 .vitem &%-Mset%&&~<&'message&~id'&>
3945 .oindex "&%-Mset%&
3946 .cindex "testing" "string expansion"
3947 .cindex "expansion" "testing"
3948 This option is useful only in conjunction with &%-be%& (that is, when testing
3949 string expansions). Exim loads the given message from its spool before doing
3950 the test expansions, thus setting message-specific variables such as
3951 &$message_size$& and the header variables. The &$recipients$& variable is made
3952 available. This feature is provided to make it easier to test expansions that
3953 make use of these variables. However, this option can be used only by an admin
3954 user. See also &%-bem%&.
3955
3956 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3957 .oindex "&%-Mt%&"
3958 .cindex "thawing messages"
3959 .cindex "unfreezing messages"
3960 .cindex "frozen messages" "thawing"
3961 .cindex "message" "thawing frozen"
3962 This option requests Exim to &"thaw"& any of the listed messages that are
3963 &"frozen"&, so that delivery attempts can resume. However, if any of the
3964 messages are active, their status is not altered. This option can be used only
3965 by an admin user.
3966
3967 .vitem &%-Mvb%&&~<&'message&~id'&>
3968 .oindex "&%-Mvb%&"
3969 .cindex "listing" "message body"
3970 .cindex "message" "listing body of"
3971 This option causes the contents of the message body (-D) spool file to be
3972 written to the standard output. This option can be used only by an admin user.
3973
3974 .vitem &%-Mvc%&&~<&'message&~id'&>
3975 .oindex "&%-Mvc%&"
3976 .cindex "message" "listing in RFC 2822 format"
3977 .cindex "listing" "message in RFC 2822 format"
3978 This option causes a copy of the complete message (header lines plus body) to
3979 be written to the standard output in RFC 2822 format. This option can be used
3980 only by an admin user.
3981
3982 .vitem &%-Mvh%&&~<&'message&~id'&>
3983 .oindex "&%-Mvh%&"
3984 .cindex "listing" "message headers"
3985 .cindex "header lines" "listing"
3986 .cindex "message" "listing header lines"
3987 This option causes the contents of the message headers (-H) spool file to be
3988 written to the standard output. This option can be used only by an admin user.
3989
3990 .vitem &%-Mvl%&&~<&'message&~id'&>
3991 .oindex "&%-Mvl%&"
3992 .cindex "listing" "message log"
3993 .cindex "message" "listing message log"
3994 This option causes the contents of the message log spool file to be written to
3995 the standard output. This option can be used only by an admin user.
3996
3997 .vitem &%-m%&
3998 .oindex "&%-m%&"
3999 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4000 treats it that way too.
4001
4002 .vitem &%-N%&
4003 .oindex "&%-N%&"
4004 .cindex "debugging" "&%-N%& option"
4005 .cindex "debugging" "suppressing delivery"
4006 This is a debugging option that inhibits delivery of a message at the transport
4007 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4008 it just doesn't actually transport the message, but instead behaves as if it
4009 had successfully done so. However, it does not make any updates to the retry
4010 database, and the log entries for deliveries are flagged with &"*>"& rather
4011 than &"=>"&.
4012
4013 Because &%-N%& discards any message to which it applies, only root or the Exim
4014 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4015 words, an ordinary user can use it only when supplying an incoming message to
4016 which it will apply. Although transportation never fails when &%-N%& is set, an
4017 address may be deferred because of a configuration problem on a transport, or a
4018 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4019 the message, and applies to any subsequent delivery attempts that may happen
4020 for that message.
4021
4022 .vitem &%-n%&
4023 .oindex "&%-n%&"
4024 This option is interpreted by Sendmail to mean &"no aliasing"&.
4025 For normal modes of operation, it is ignored by Exim.
4026 When combined with &%-bP%& it makes the output more terse (suppresses
4027 option names, environment values and config pretty printing).
4028
4029 .vitem &%-O%&&~<&'data'&>
4030 .oindex "&%-O%&"
4031 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4032 Exim.
4033
4034 .vitem &%-oA%&&~<&'file&~name'&>
4035 .oindex "&%-oA%&"
4036 .cindex "Sendmail compatibility" "&%-oA%& option"
4037 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4038 alternative alias file name. Exim handles &%-bi%& differently; see the
4039 description above.
4040
4041 .vitem &%-oB%&&~<&'n'&>
4042 .oindex "&%-oB%&"
4043 .cindex "SMTP" "passed connection"
4044 .cindex "SMTP" "multiple deliveries"
4045 .cindex "multiple SMTP deliveries"
4046 This is a debugging option which limits the maximum number of messages that can
4047 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4048 transport. If <&'n'&> is omitted, the limit is set to 1.
4049
4050 .vitem &%-odb%&
4051 .oindex "&%-odb%&"
4052 .cindex "background delivery"
4053 .cindex "delivery" "in the background"
4054 This option applies to all modes in which Exim accepts incoming messages,
4055 including the listening daemon. It requests &"background"& delivery of such
4056 messages, which means that the accepting process automatically starts a
4057 delivery process for each message received, but does not wait for the delivery
4058 processes to finish.
4059
4060 When all the messages have been received, the reception process exits,
4061 leaving the delivery processes to finish in their own time. The standard output
4062 and error streams are closed at the start of each delivery process.
4063 This is the default action if none of the &%-od%& options are present.
4064
4065 If one of the queueing options in the configuration file
4066 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4067 overrides it if &%queue_only_override%& is set true, which is the default
4068 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4069
4070 .vitem &%-odf%&
4071 .oindex "&%-odf%&"
4072 .cindex "foreground delivery"
4073 .cindex "delivery" "in the foreground"
4074 This option requests &"foreground"& (synchronous) delivery when Exim has
4075 accepted a locally-generated message. (For the daemon it is exactly the same as
4076 &%-odb%&.) A delivery process is automatically started to deliver the message,
4077 and Exim waits for it to complete before proceeding.
4078
4079 The original Exim reception process does not finish until the delivery
4080 process for the final message has ended. The standard error stream is left open
4081 during deliveries.
4082
4083 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4084 false and one of the queueing options in the configuration file is in effect.
4085
4086 If there is a temporary delivery error during foreground delivery, the
4087 message is left on the queue for later delivery, and the original reception
4088 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4089 restricted configuration that never queues messages.
4090
4091
4092 .vitem &%-odi%&
4093 .oindex "&%-odi%&"
4094 This option is synonymous with &%-odf%&. It is provided for compatibility with
4095 Sendmail.
4096
4097 .vitem &%-odq%&
4098 .oindex "&%-odq%&"
4099 .cindex "non-immediate delivery"
4100 .cindex "delivery" "suppressing immediate"
4101 .cindex "queueing incoming messages"
4102 This option applies to all modes in which Exim accepts incoming messages,
4103 including the listening daemon. It specifies that the accepting process should
4104 not automatically start a delivery process for each message received. Messages
4105 are placed on the queue, and remain there until a subsequent queue runner
4106 process encounters them. There are several configuration options (such as
4107 &%queue_only%&) that can be used to queue incoming messages under certain
4108 conditions. This option overrides all of them and also &%-odqs%&. It always
4109 forces queueing.
4110
4111 .vitem &%-odqs%&
4112 .oindex "&%-odqs%&"
4113 .cindex "SMTP" "delaying delivery"
4114 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4115 However, like &%-odb%& and &%-odi%&, this option has no effect if
4116 &%queue_only_override%& is false and one of the queueing options in the
4117 configuration file is in effect.
4118
4119 When &%-odqs%& does operate, a delivery process is started for each incoming
4120 message, in the background by default, but in the foreground if &%-odi%& is
4121 also present. The recipient addresses are routed, and local deliveries are done
4122 in the normal way. However, if any SMTP deliveries are required, they are not
4123 done at this time, so the message remains on the queue until a subsequent queue
4124 runner process encounters it. Because routing was done, Exim knows which
4125 messages are waiting for which hosts, and so a number of messages for the same
4126 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4127 configuration option has the same effect for specific domains. See also the
4128 &%-qq%& option.
4129
4130 .vitem &%-oee%&
4131 .oindex "&%-oee%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received (for
4134 example, a malformed address), the error is reported to the sender in a mail
4135 message.
4136
4137 .cindex "return code" "for &%-oee%&"
4138 Provided
4139 this error message is successfully sent, the Exim receiving process
4140 exits with a return code of zero. If not, the return code is 2 if the problem
4141 is that the original message has no recipients, or 1 for any other error.
4142 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4143
4144 .vitem &%-oem%&
4145 .oindex "&%-oem%&"
4146 .cindex "error" "reporting"
4147 .cindex "return code" "for &%-oem%&"
4148 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4149 return code, whether or not the error message was successfully sent.
4150 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4151
4152 .vitem &%-oep%&
4153 .oindex "&%-oep%&"
4154 .cindex "error" "reporting"
4155 If an error is detected while a non-SMTP message is being received, the
4156 error is reported by writing a message to the standard error file (stderr).
4157 .cindex "return code" "for &%-oep%&"
4158 The return code is 1 for all errors.
4159
4160 .vitem &%-oeq%&
4161 .oindex "&%-oeq%&"
4162 .cindex "error" "reporting"
4163 This option is supported for compatibility with Sendmail, but has the same
4164 effect as &%-oep%&.
4165
4166 .vitem &%-oew%&
4167 .oindex "&%-oew%&"
4168 .cindex "error" "reporting"
4169 This option is supported for compatibility with Sendmail, but has the same
4170 effect as &%-oem%&.
4171
4172 .vitem &%-oi%&
4173 .oindex "&%-oi%&"
4174 .cindex "dot" "in incoming non-SMTP message"
4175 This option, which has the same effect as &%-i%&, specifies that a dot on a
4176 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4177 single dot does terminate, though Exim does no special processing for other
4178 lines that start with a dot. This option is set by default if Exim is called as
4179 &'rmail'&. See also &%-ti%&.
4180
4181 .vitem &%-oitrue%&
4182 .oindex "&%-oitrue%&"
4183 This option is treated as synonymous with &%-oi%&.
4184
4185 .vitem &%-oMa%&&~<&'host&~address'&>
4186 .oindex "&%-oMa%&"
4187 .cindex "sender" "host address, specifying for local message"
4188 A number of options starting with &%-oM%& can be used to set values associated
4189 with remote hosts on locally-submitted messages (that is, messages not received
4190 over TCP/IP). These options can be used by any caller in conjunction with the
4191 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4192 other circumstances, they are ignored unless the caller is trusted.
4193
4194 The &%-oMa%& option sets the sender host address. This may include a port
4195 number at the end, after a full stop (period). For example:
4196 .code
4197 exim -bs -oMa 10.9.8.7.1234
4198 .endd
4199 An alternative syntax is to enclose the IP address in square brackets,
4200 followed by a colon and the port number:
4201 .code
4202 exim -bs -oMa [10.9.8.7]:1234
4203 .endd
4204 The IP address is placed in the &$sender_host_address$& variable, and the
4205 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4206 are present on the command line, the sender host IP address is taken from
4207 whichever one is last.
4208
4209 .vitem &%-oMaa%&&~<&'name'&>
4210 .oindex "&%-oMaa%&"
4211 .cindex "authentication" "name, specifying for local message"
4212 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4213 option sets the value of &$sender_host_authenticated$& (the authenticator
4214 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4215 This option can be used with &%-bh%& and &%-bs%& to set up an
4216 authenticated SMTP session without actually using the SMTP AUTH command.
4217
4218 .vitem &%-oMai%&&~<&'string'&>
4219 .oindex "&%-oMai%&"
4220 .cindex "authentication" "id, specifying for local message"
4221 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4222 option sets the value of &$authenticated_id$& (the id that was authenticated).
4223 This overrides the default value (the caller's login id, except with &%-bh%&,
4224 where there is no default) for messages from local sources. See chapter
4225 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4226
4227 .vitem &%-oMas%&&~<&'address'&>
4228 .oindex "&%-oMas%&"
4229 .cindex "authentication" "sender, specifying for local message"
4230 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4231 option sets the authenticated sender value in &$authenticated_sender$&. It
4232 overrides the sender address that is created from the caller's login id for
4233 messages from local sources, except when &%-bh%& is used, when there is no
4234 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4235 specified on a MAIL command overrides this value. See chapter
4236 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4237
4238 .vitem &%-oMi%&&~<&'interface&~address'&>
4239 .oindex "&%-oMi%&"
4240 .cindex "interface" "address, specifying for local message"
4241 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4242 option sets the IP interface address value. A port number may be included,
4243 using the same syntax as for &%-oMa%&. The interface address is placed in
4244 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4245
4246 .vitem &%-oMm%&&~<&'message&~reference'&>
4247 .oindex "&%-oMm%&"
4248 .cindex "message reference" "message reference, specifying for local message"
4249 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4250 option sets the message reference, e.g. message-id, and is logged during
4251 delivery. This is useful when some kind of audit trail is required to tie
4252 messages together. The format of the message reference is checked and will
4253 abort if the format is invalid. The option will only be accepted if exim is
4254 running in trusted mode, not as any regular user.
4255
4256 The best example of a message reference is when Exim sends a bounce message.
4257 The message reference is the message-id of the original message for which Exim
4258 is sending the bounce.
4259
4260 .vitem &%-oMr%&&~<&'protocol&~name'&>
4261 .oindex "&%-oMr%&"
4262 .cindex "protocol, specifying for local message"
4263 .vindex "&$received_protocol$&"
4264 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4265 option sets the received protocol value that is stored in
4266 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4267 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4268 SMTP protocol names (see the description of &$received_protocol$& in section
4269 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4270 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4271 be set by &%-oMr%&.
4272
4273 .vitem &%-oMs%&&~<&'host&~name'&>
4274 .oindex "&%-oMs%&"
4275 .cindex "sender" "host name, specifying for local message"
4276 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4277 option sets the sender host name in &$sender_host_name$&. When this option is
4278 present, Exim does not attempt to look up a host name from an IP address; it
4279 uses the name it is given.
4280
4281 .vitem &%-oMt%&&~<&'ident&~string'&>
4282 .oindex "&%-oMt%&"
4283 .cindex "sender" "ident string, specifying for local message"
4284 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4285 option sets the sender ident value in &$sender_ident$&. The default setting for
4286 local callers is the login id of the calling process, except when &%-bh%& is
4287 used, when there is no default.
4288
4289 .vitem &%-om%&
4290 .oindex "&%-om%&"
4291 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4292 In Sendmail, this option means &"me too"&, indicating that the sender of a
4293 message should receive a copy of the message if the sender appears in an alias
4294 expansion. Exim always does this, so the option does nothing.
4295
4296 .vitem &%-oo%&
4297 .oindex "&%-oo%&"
4298 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4299 This option is ignored. In Sendmail it specifies &"old style headers"&,
4300 whatever that means.
4301
4302 .vitem &%-oP%&&~<&'path'&>
4303 .oindex "&%-oP%&"
4304 .cindex "pid (process id)" "of daemon"
4305 .cindex "daemon" "process id (pid)"
4306 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4307 value. The option specifies the file to which the process id of the daemon is
4308 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4309 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4310 because in those cases, the normal pid file is not used.
4311
4312 .vitem &%-or%&&~<&'time'&>
4313 .oindex "&%-or%&"
4314 .cindex "timeout" "for non-SMTP input"
4315 This option sets a timeout value for incoming non-SMTP messages. If it is not
4316 set, Exim will wait forever for the standard input. The value can also be set
4317 by the &%receive_timeout%& option. The format used for specifying times is
4318 described in section &<<SECTtimeformat>>&.
4319
4320 .vitem &%-os%&&~<&'time'&>
4321 .oindex "&%-os%&"
4322 .cindex "timeout" "for SMTP input"
4323 .cindex "SMTP" "input timeout"
4324 This option sets a timeout value for incoming SMTP messages. The timeout
4325 applies to each SMTP command and block of data. The value can also be set by
4326 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4327 for specifying times is described in section &<<SECTtimeformat>>&.
4328
4329 .vitem &%-ov%&
4330 .oindex "&%-ov%&"
4331 This option has exactly the same effect as &%-v%&.
4332
4333 .vitem &%-oX%&&~<&'number&~or&~string'&>
4334 .oindex "&%-oX%&"
4335 .cindex "TCP/IP" "setting listening ports"
4336 .cindex "TCP/IP" "setting listening interfaces"
4337 .cindex "port" "receiving TCP/IP"
4338 This option is relevant only when the &%-bd%& (start listening daemon) option
4339 is also given. It controls which ports and interfaces the daemon uses. Details
4340 of the syntax, and how it interacts with configuration file options, are given
4341 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4342 file is written unless &%-oP%& is also present to specify a pid file name.
4343
4344 .vitem &%-pd%&
4345 .oindex "&%-pd%&"
4346 .cindex "Perl" "starting the interpreter"
4347 This option applies when an embedded Perl interpreter is linked with Exim (see
4348 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4349 option, forcing the starting of the interpreter to be delayed until it is
4350 needed.
4351
4352 .vitem &%-ps%&
4353 .oindex "&%-ps%&"
4354 .cindex "Perl" "starting the interpreter"
4355 This option applies when an embedded Perl interpreter is linked with Exim (see
4356 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4357 option, forcing the starting of the interpreter to occur as soon as Exim is
4358 started.
4359
4360 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4361 .oindex "&%-p%&"
4362 For compatibility with Sendmail, this option is equivalent to
4363 .display
4364 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4365 .endd
4366 It sets the incoming protocol and host name (for trusted callers). The
4367 host name and its colon can be omitted when only the protocol is to be set.
4368 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4369 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4370 or &`s`& using this option (but that does not seem a real limitation).
4371
4372 .vitem &%-q%&
4373 .oindex "&%-q%&"
4374 .cindex "queue runner" "starting manually"
4375 This option is normally restricted to admin users. However, there is a
4376 configuration option called &%prod_requires_admin%& which can be set false to
4377 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4378 and &%-S%& options).
4379
4380 .cindex "queue runner" "description of operation"
4381 If other commandline options do not specify an action,
4382 the &%-q%& option starts one queue runner process. This scans the queue of
4383 waiting messages, and runs a delivery process for each one in turn. It waits
4384 for each delivery process to finish before starting the next one. A delivery
4385 process may not actually do any deliveries if the retry times for the addresses
4386 have not been reached. Use &%-qf%& (see below) if you want to override this.
4387
4388 If
4389 .cindex "SMTP" "passed connection"
4390 .cindex "SMTP" "multiple deliveries"
4391 .cindex "multiple SMTP deliveries"
4392 the delivery process spawns other processes to deliver other messages down
4393 passed SMTP connections, the queue runner waits for these to finish before
4394 proceeding.
4395
4396 When all the queued messages have been considered, the original queue runner
4397 process terminates. In other words, a single pass is made over the waiting
4398 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4399 this to be repeated periodically.
4400
4401 Exim processes the waiting messages in an unpredictable order. It isn't very
4402 random, but it is likely to be different each time, which is all that matters.
4403 If one particular message screws up a remote MTA, other messages to the same
4404 MTA have a chance of getting through if they get tried first.
4405
4406 It is possible to cause the messages to be processed in lexical message id
4407 order, which is essentially the order in which they arrived, by setting the
4408 &%queue_run_in_order%& option, but this is not recommended for normal use.
4409
4410 .vitem &%-q%&<&'qflags'&>
4411 The &%-q%& option may be followed by one or more flag letters that change its
4412 behaviour. They are all optional, but if more than one is present, they must
4413 appear in the correct order. Each flag is described in a separate item below.
4414
4415 .vitem &%-qq...%&
4416 .oindex "&%-qq%&"
4417 .cindex "queue" "double scanning"
4418 .cindex "queue" "routing"
4419 .cindex "routing" "whole queue before delivery"
4420 An option starting with &%-qq%& requests a two-stage queue run. In the first
4421 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4422 every domain. Addresses are routed, local deliveries happen, but no remote
4423 transports are run.
4424
4425 .cindex "hints database" "remembering routing"
4426 The hints database that remembers which messages are waiting for specific hosts
4427 is updated, as if delivery to those hosts had been deferred. After this is
4428 complete, a second, normal queue scan happens, with routing and delivery taking
4429 place as normal. Messages that are routed to the same host should mostly be
4430 delivered down a single SMTP
4431 .cindex "SMTP" "passed connection"
4432 .cindex "SMTP" "multiple deliveries"
4433 .cindex "multiple SMTP deliveries"
4434 connection because of the hints that were set up during the first queue scan.
4435 This option may be useful for hosts that are connected to the Internet
4436 intermittently.
4437
4438 .vitem &%-q[q]i...%&
4439 .oindex "&%-qi%&"
4440 .cindex "queue" "initial delivery"
4441 If the &'i'& flag is present, the queue runner runs delivery processes only for
4442 those messages that haven't previously been tried. (&'i'& stands for &"initial
4443 delivery"&.) This can be helpful if you are putting messages on the queue using
4444 &%-odq%& and want a queue runner just to process the new messages.
4445
4446 .vitem &%-q[q][i]f...%&
4447 .oindex "&%-qf%&"
4448 .cindex "queue" "forcing delivery"
4449 .cindex "delivery" "forcing in queue run"
4450 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4451 message, whereas without &'f'& only those non-frozen addresses that have passed
4452 their retry times are tried.
4453
4454 .vitem &%-q[q][i]ff...%&
4455 .oindex "&%-qff%&"
4456 .cindex "frozen messages" "forcing delivery"
4457 If &'ff'& is present, a delivery attempt is forced for every message, whether
4458 frozen or not.
4459
4460 .vitem &%-q[q][i][f[f]]l%&
4461 .oindex "&%-ql%&"
4462 .cindex "queue" "local deliveries only"
4463 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4464 be done. If a message requires any remote deliveries, it remains on the queue
4465 for later delivery.
4466
4467 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4468 .oindex "&%-qG%&"
4469 .cindex queue named
4470 .cindex "named queues"
4471 .cindex "queue" "delivering specific messages"
4472 If the &'G'& flag and a name is present, the queue runner operates on the
4473 queue with the given name rather than the default queue.
4474 The name should not contain a &'/'& character.
4475 For a periodic queue run (see below)
4476 append to the name a slash and a time value.
4477
4478 If other commandline options specify an action, a &'-qG<name>'& option
4479 will specify a queue to operate on.
4480 For example:
4481 .code
4482 exim -bp -qGquarantine
4483 mailq -qGquarantine
4484 exim -qGoffpeak -Rf @special.domain.example
4485 .endd
4486
4487 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4488 When scanning the queue, Exim can be made to skip over messages whose ids are
4489 lexically less than a given value by following the &%-q%& option with a
4490 starting message id. For example:
4491 .code
4492 exim -q 0t5C6f-0000c8-00
4493 .endd
4494 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4495 second message id is given, messages whose ids are lexically greater than it
4496 are also skipped. If the same id is given twice, for example,
4497 .code
4498 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4499 .endd
4500 just one delivery process is started, for that message. This differs from
4501 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4502 that it counts as a delivery from a queue run. Note that the selection
4503 mechanism does not affect the order in which the messages are scanned. There
4504 are also other ways of selecting specific sets of messages for delivery in a
4505 queue run &-- see &%-R%& and &%-S%&.
4506
4507 .vitem &%-q%&<&'qflags'&><&'time'&>
4508 .cindex "queue runner" "starting periodically"
4509 .cindex "periodic queue running"
4510 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4511 starting a queue runner process at intervals specified by the given time value
4512 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4513 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4514 single daemon process handles both functions. A common way of starting up a
4515 combined daemon at system boot time is to use a command such as
4516 .code
4517 /usr/exim/bin/exim -bd -q30m
4518 .endd
4519 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4520 process every 30 minutes.
4521
4522 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4523 pid file is written unless one is explicitly requested by the &%-oP%& option.
4524
4525 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4526 .oindex "&%-qR%&"
4527 This option is synonymous with &%-R%&. It is provided for Sendmail
4528 compatibility.
4529
4530 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4531 .oindex "&%-qS%&"
4532 This option is synonymous with &%-S%&.
4533
4534 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4535 .oindex "&%-R%&"
4536 .cindex "queue runner" "for specific recipients"
4537 .cindex "delivery" "to given domain"
4538 .cindex "domain" "delivery to"
4539 The <&'rsflags'&> may be empty, in which case the white space before the string
4540 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4541 which are the possible values for <&'rsflags'&>. White space is required if
4542 <&'rsflags'&> is not empty.
4543
4544 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4545 perform a single queue run, except that, when scanning the messages on the
4546 queue, Exim processes only those that have at least one undelivered recipient
4547 address containing the given string, which is checked in a case-independent
4548 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4549 regular expression; otherwise it is a literal string.
4550
4551 If you want to do periodic queue runs for messages with specific recipients,
4552 you can combine &%-R%& with &%-q%& and a time value. For example:
4553 .code
4554 exim -q25m -R @special.domain.example
4555 .endd
4556 This example does a queue run for messages with recipients in the given domain
4557 every 25 minutes. Any additional flags that are specified with &%-q%& are
4558 applied to each queue run.
4559
4560 Once a message is selected for delivery by this mechanism, all its addresses
4561 are processed. For the first selected message, Exim overrides any retry
4562 information and forces a delivery attempt for each undelivered address. This
4563 means that if delivery of any address in the first message is successful, any
4564 existing retry information is deleted, and so delivery attempts for that
4565 address in subsequently selected messages (which are processed without forcing)
4566 will run. However, if delivery of any address does not succeed, the retry
4567 information is updated, and in subsequently selected messages, the failing
4568 address will be skipped.
4569
4570 .cindex "frozen messages" "forcing delivery"
4571 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4572 all selected messages, not just the first; frozen messages are included when
4573 &'ff'& is present.
4574
4575 The &%-R%& option makes it straightforward to initiate delivery of all messages
4576 to a given domain after a host has been down for some time. When the SMTP
4577 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4578 effect is to run Exim with the &%-R%& option, but it can be configured to run
4579 an arbitrary command instead.
4580
4581 .vitem &%-r%&
4582 .oindex "&%-r%&"
4583 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4584
4585 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4586 .oindex "&%-S%&"
4587 .cindex "delivery" "from given sender"
4588 .cindex "queue runner" "for specific senders"
4589 This option acts like &%-R%& except that it checks the string against each
4590 message's sender instead of against the recipients. If &%-R%& is also set, both
4591 conditions must be met for a message to be selected. If either of the options
4592 has &'f'& or &'ff'& in its flags, the associated action is taken.
4593
4594 .vitem &%-Tqt%&&~<&'times'&>
4595 .oindex "&%-Tqt%&"
4596 This is an option that is exclusively for use by the Exim testing suite. It is not
4597 recognized when Exim is run normally. It allows for the setting up of explicit
4598 &"queue times"& so that various warning/retry features can be tested.
4599
4600 .vitem &%-t%&
4601 .oindex "&%-t%&"
4602 .cindex "recipient" "extracting from header lines"
4603 .cindex "&'Bcc:'& header line"
4604 .cindex "&'Cc:'& header line"
4605 .cindex "&'To:'& header line"
4606 When Exim is receiving a locally-generated, non-SMTP message on its standard
4607 input, the &%-t%& option causes the recipients of the message to be obtained
4608 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4609 from the command arguments. The addresses are extracted before any rewriting
4610 takes place and the &'Bcc:'& header line, if present, is then removed.
4611
4612 .cindex "Sendmail compatibility" "&%-t%& option"
4613 If the command has any arguments, they specify addresses to which the message
4614 is &'not'& to be delivered. That is, the argument addresses are removed from
4615 the recipients list obtained from the headers. This is compatible with Smail 3
4616 and in accordance with the documented behaviour of several versions of
4617 Sendmail, as described in man pages on a number of operating systems (e.g.
4618 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4619 argument addresses to those obtained from the headers, and the O'Reilly
4620 Sendmail book documents it that way. Exim can be made to add argument addresses
4621 instead of subtracting them by setting the option
4622 &%extract_addresses_remove_arguments%& false.
4623
4624 .cindex "&%Resent-%& header lines" "with &%-t%&"
4625 If there are any &%Resent-%& header lines in the message, Exim extracts
4626 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4627 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4628 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4629 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4630
4631 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4632 message is resent several times). The RFC also specifies that they should be
4633 added at the front of the message, and separated by &'Received:'& lines. It is
4634 not at all clear how &%-t%& should operate in the present of multiple sets,
4635 nor indeed exactly what constitutes a &"set"&.
4636 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4637 are often added at the end of the header, and if a message is resent more than
4638 once, it is common for the original set of &%Resent-%& headers to be renamed as
4639 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4640
4641 .vitem &%-ti%&
4642 .oindex "&%-ti%&"
4643 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4644 compatibility with Sendmail.
4645
4646 .vitem &%-tls-on-connect%&
4647 .oindex "&%-tls-on-connect%&"
4648 .cindex "TLS" "use without STARTTLS"
4649 .cindex "TLS" "automatic start"
4650 This option is available when Exim is compiled with TLS support. It forces all
4651 incoming SMTP connections to behave as if the incoming port is listed in the
4652 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4653 &<<CHAPTLS>>& for further details.
4654
4655
4656 .vitem &%-U%&
4657 .oindex "&%-U%&"
4658 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4659 Sendmail uses this option for &"initial message submission"&, and its
4660 documentation states that in future releases, it may complain about
4661 syntactically invalid messages rather than fixing them when this flag is not
4662 set. Exim ignores this option.
4663
4664 .vitem &%-v%&
4665 .oindex "&%-v%&"
4666 This option causes Exim to write information to the standard error stream,
4667 describing what it is doing. In particular, it shows the log lines for
4668 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4669 dialogue is shown. Some of the log lines shown may not actually be written to
4670 the log if the setting of &%log_selector%& discards them. Any relevant
4671 selectors are shown with each log line. If none are shown, the logging is
4672 unconditional.
4673
4674 .vitem &%-x%&
4675 .oindex "&%-x%&"
4676 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4677 National Language Support extended characters in the body of the mail item"&).
4678 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4679 this option.
4680
4681 .vitem &%-X%&&~<&'logfile'&>
4682 .oindex "&%-X%&"
4683 This option is interpreted by Sendmail to cause debug information to be sent
4684 to the named file.  It is ignored by Exim.
4685
4686 .vitem &%-z%&&~<&'log-line'&>
4687 .oindex "&%-z%&"
4688 This option writes its argument to Exim's logfile.
4689 Use is restricted to administrators; the intent is for operational notes.
4690 Quotes should be used to maintain a multi-word item as a single argument,
4691 under most shells.
4692 .endlist
4693
4694 .ecindex IIDclo1
4695 .ecindex IIDclo2
4696
4697
4698 . ////////////////////////////////////////////////////////////////////////////
4699 . Insert a stylized DocBook comment here, to identify the end of the command
4700 . line options. This is for the benefit of the Perl script that automatically
4701 . creates a man page for the options.
4702 . ////////////////////////////////////////////////////////////////////////////
4703
4704 .literal xml
4705 <!-- === End of command line options === -->
4706 .literal off
4707
4708
4709
4710
4711
4712 . ////////////////////////////////////////////////////////////////////////////
4713 . ////////////////////////////////////////////////////////////////////////////
4714
4715
4716 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4717          "The runtime configuration file"
4718
4719 .cindex "run time configuration"
4720 .cindex "configuration file" "general description"
4721 .cindex "CONFIGURE_FILE"
4722 .cindex "configuration file" "errors in"
4723 .cindex "error" "in configuration file"
4724 .cindex "return code" "for bad configuration"
4725 Exim uses a single run time configuration file that is read whenever an Exim
4726 binary is executed. Note that in normal operation, this happens frequently,
4727 because Exim is designed to operate in a distributed manner, without central
4728 control.
4729
4730 If a syntax error is detected while reading the configuration file, Exim
4731 writes a message on the standard error, and exits with a non-zero return code.
4732 The message is also written to the panic log. &*Note*&: Only simple syntax
4733 errors can be detected at this time. The values of any expanded options are
4734 not checked until the expansion happens, even when the expansion does not
4735 actually alter the string.
4736
4737 The name of the configuration file is compiled into the binary for security
4738 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4739 most configurations, this specifies a single file. However, it is permitted to
4740 give a colon-separated list of file names, in which case Exim uses the first
4741 existing file in the list.
4742
4743 .cindex "EXIM_USER"
4744 .cindex "EXIM_GROUP"
4745 .cindex "CONFIGURE_OWNER"
4746 .cindex "CONFIGURE_GROUP"
4747 .cindex "configuration file" "ownership"
4748 .cindex "ownership" "configuration file"
4749 The run time configuration file must be owned by root or by the user that is
4750 specified at compile time by the CONFIGURE_OWNER option (if set). The
4751 configuration file must not be world-writeable, or group-writeable unless its
4752 group is the root group or the one specified at compile time by the
4753 CONFIGURE_GROUP option.
4754
4755 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4756 to root, anybody who is able to edit the run time configuration file has an
4757 easy way to run commands as root. If you specify a user or group in the
4758 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4759 who are members of that group will trivially be able to obtain root privileges.
4760
4761 Up to Exim version 4.72, the run time configuration file was also permitted to
4762 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4763 since it offered a simple privilege escalation for any attacker who managed to
4764 compromise the Exim user account.
4765
4766 A default configuration file, which will work correctly in simple situations,
4767 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4768 defines just one file name, the installation process copies the default
4769 configuration to a new file of that name if it did not previously exist. If
4770 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4771 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4772 configuration.
4773
4774
4775
4776 .section "Using a different configuration file" "SECID40"
4777 .cindex "configuration file" "alternate"
4778 A one-off alternate configuration can be specified by the &%-C%& command line
4779 option, which may specify a single file or a list of files. However, when
4780 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4781 unless the argument for &%-C%& is identical to the built-in value from
4782 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4783 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4784 is useful mainly for checking the syntax of configuration files before
4785 installing them. No owner or group checks are done on a configuration file
4786 specified by &%-C%&, if root privilege has been dropped.
4787
4788 Even the Exim user is not trusted to specify an arbitrary configuration file
4789 with the &%-C%& option to be used with root privileges, unless that file is
4790 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4791 testing a configuration using &%-C%& right through message reception and
4792 delivery, even if the caller is root. The reception works, but by that time,
4793 Exim is running as the Exim user, so when it re-execs to regain privilege for
4794 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4795 can test reception and delivery using two separate commands (one to put a
4796 message on the queue, using &%-odq%&, and another to do the delivery, using
4797 &%-M%&).
4798
4799 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4800 prefix string with which any file named in a &%-C%& command line option must
4801 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4802 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4803 name can be used with &%-C%&.
4804
4805 One-off changes to a configuration can be specified by the &%-D%& command line
4806 option, which defines and overrides values for macros used inside the
4807 configuration file. However, like &%-C%&, the use of this option by a
4808 non-privileged user causes Exim to discard its root privilege.
4809 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4810 completely disabled, and its use causes an immediate error exit.
4811
4812 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4813 to declare certain macro names trusted, such that root privilege will not
4814 necessarily be discarded.
4815 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4816 considered safe and, if &%-D%& only supplies macros from this list, and the
4817 values are acceptable, then Exim will not give up root privilege if the caller
4818 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4819 transition mechanism and is expected to be removed in the future.  Acceptable
4820 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4821
4822 Some sites may wish to use the same Exim binary on different machines that
4823 share a file system, but to use different configuration files on each machine.
4824 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4825 looks for a file whose name is the configuration file name followed by a dot
4826 and the machine's node name, as obtained from the &[uname()]& function. If this
4827 file does not exist, the standard name is tried. This processing occurs for
4828 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4829
4830 In some esoteric situations different versions of Exim may be run under
4831 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4832 help with this. See the comments in &_src/EDITME_& for details.
4833
4834
4835
4836 .section "Configuration file format" "SECTconffilfor"
4837 .cindex "configuration file" "format of"
4838 .cindex "format" "configuration file"
4839 Exim's configuration file is divided into a number of different parts. General
4840 option settings must always appear at the start of the file. The other parts
4841 are all optional, and may appear in any order. Each part other than the first
4842 is introduced by the word &"begin"& followed by at least one literal
4843 space, and the name of the part. The optional parts are:
4844
4845 .ilist
4846 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4847 &<<CHAPACL>>&).
4848 .next
4849 .cindex "AUTH" "configuration"
4850 &'authenticators'&: Configuration settings for the authenticator drivers. These
4851 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4852 .next
4853 &'routers'&: Configuration settings for the router drivers. Routers process
4854 addresses and determine how the message is to be delivered (see chapters
4855 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4856 .next
4857 &'transports'&: Configuration settings for the transport drivers. Transports
4858 define mechanisms for copying messages to destinations (see chapters
4859 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4860 .next
4861 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4862 If there is no retry section, or if it is empty (that is, no retry rules are
4863 defined), Exim will not retry deliveries. In this situation, temporary errors
4864 are treated the same as permanent errors. Retry rules are discussed in chapter
4865 &<<CHAPretry>>&.
4866 .next
4867 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4868 when new addresses are generated during delivery. Rewriting is discussed in
4869 chapter &<<CHAPrewrite>>&.
4870 .next
4871 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4872 want to use this feature, you must set
4873 .code
4874 LOCAL_SCAN_HAS_OPTIONS=yes
4875 .endd
4876 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4877 facility are given in chapter &<<CHAPlocalscan>>&.
4878 .endlist
4879
4880 .cindex "configuration file" "leading white space in"
4881 .cindex "configuration file" "trailing white space in"
4882 .cindex "white space" "in configuration file"
4883 Leading and trailing white space in configuration lines is always ignored.
4884
4885 Blank lines in the file, and lines starting with a # character (ignoring
4886 leading white space) are treated as comments and are ignored. &*Note*&: A
4887 # character other than at the beginning of a line is not treated specially,
4888 and does not introduce a comment.
4889
4890 Any non-comment line can be continued by ending it with a backslash. Note that
4891 the general rule for white space means that trailing white space after the
4892 backslash and leading white space at the start of continuation
4893 lines is ignored. Comment lines beginning with # (but not empty lines) may
4894 appear in the middle of a sequence of continuation lines.
4895
4896 A convenient way to create a configuration file is to start from the
4897 default, which is supplied in &_src/configure.default_&, and add, delete, or
4898 change settings as required.
4899
4900 The ACLs, retry rules, and rewriting rules have their own syntax which is
4901 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4902 respectively. The other parts of the configuration file have some syntactic
4903 items in common, and these are described below, from section &<<SECTcos>>&
4904 onwards. Before that, the inclusion, macro, and conditional facilities are
4905 described.
4906
4907
4908
4909 .section "File inclusions in the configuration file" "SECID41"
4910 .cindex "inclusions in configuration file"
4911 .cindex "configuration file" "including other files"
4912 .cindex "&`.include`& in configuration file"
4913 .cindex "&`.include_if_exists`& in configuration file"
4914 You can include other files inside Exim's run time configuration file by
4915 using this syntax:
4916 .display
4917 &`.include`& <&'file name'&>
4918 &`.include_if_exists`& <&'file name'&>
4919 .endd
4920 on a line by itself. Double quotes round the file name are optional. If you use
4921 the first form, a configuration error occurs if the file does not exist; the
4922 second form does nothing for non-existent files.
4923 .new
4924 The first form allows a relative name. It is resolved relative to
4925 the directory of the including file. For the second form an absolute file
4926 name is required.
4927 .wen
4928
4929 Includes may be nested to any depth, but remember that Exim reads its
4930 configuration file often, so it is a good idea to keep them to a minimum.
4931 If you change the contents of an included file, you must HUP the daemon,
4932 because an included file is read only when the configuration itself is read.
4933
4934 The processing of inclusions happens early, at a physical line level, so, like
4935 comment lines, an inclusion can be used in the middle of an option setting,
4936 for example:
4937 .code
4938 hosts_lookup = a.b.c \
4939                .include /some/file
4940 .endd
4941 Include processing happens after macro processing (see below). Its effect is to
4942 process the lines of the included file as if they occurred inline where the
4943 inclusion appears.
4944
4945
4946
4947 .section "Macros in the configuration file" "SECTmacrodefs"
4948 .cindex "macro" "description of"
4949 .cindex "configuration file" "macros"
4950 If a line in the main part of the configuration (that is, before the first
4951 &"begin"& line) begins with an upper case letter, it is taken as a macro
4952 definition, and must be of the form
4953 .display
4954 <&'name'&> = <&'rest of line'&>
4955 .endd
4956 The name must consist of letters, digits, and underscores, and need not all be
4957 in upper case, though that is recommended. The rest of the line, including any
4958 continuations, is the replacement text, and has leading and trailing white
4959 space removed. Quotes are not removed. The replacement text can never end with
4960 a backslash character, but this doesn't seem to be a serious limitation.
4961
4962 Macros may also be defined between router, transport, authenticator, or ACL
4963 definitions. They may not, however, be defined within an individual driver or
4964 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4965
4966 .section "Macro substitution" "SECID42"
4967 Once a macro is defined, all subsequent lines in the file (and any included
4968 files) are scanned for the macro name; if there are several macros, the line is
4969 scanned for each in turn, in the order in which the macros are defined. The
4970 replacement text is not re-scanned for the current macro, though it is scanned
4971 for subsequently defined macros. For this reason, a macro name may not contain
4972 the name of a previously defined macro as a substring. You could, for example,
4973 define
4974 .display
4975 &`ABCD_XYZ = `&<&'something'&>
4976 &`ABCD = `&<&'something else'&>
4977 .endd
4978 but putting the definitions in the opposite order would provoke a configuration
4979 error. Macro expansion is applied to individual physical lines from the file,
4980 before checking for line continuation or file inclusion (see above). If a line
4981 consists solely of a macro name, and the expansion of the macro is empty, the
4982 line is ignored. A macro at the start of a line may turn the line into a
4983 comment line or a &`.include`& line.
4984
4985
4986 .section "Redefining macros" "SECID43"
4987 Once defined, the value of a macro can be redefined later in the configuration
4988 (or in an included file). Redefinition is specified by using &'=='& instead of
4989 &'='&. For example:
4990 .code
4991 MAC =  initial value
4992 ...
4993 MAC == updated value
4994 .endd
4995 Redefinition does not alter the order in which the macros are applied to the
4996 subsequent lines of the configuration file. It is still the same order in which
4997 the macros were originally defined. All that changes is the macro's value.
4998 Redefinition makes it possible to accumulate values. For example:
4999 .code
5000 MAC =  initial value
5001 ...
5002 MAC == MAC and something added
5003 .endd
5004 This can be helpful in situations where the configuration file is built
5005 from a number of other files.
5006
5007 .section "Overriding macro values" "SECID44"
5008 The values set for macros in the configuration file can be overridden by the
5009 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5010 used, unless called by root or the Exim user. A definition on the command line
5011 using the &%-D%& option causes all definitions and redefinitions within the
5012 file to be ignored.
5013
5014
5015
5016 .section "Example of macro usage" "SECID45"
5017 As an example of macro usage, consider a configuration where aliases are looked
5018 up in a MySQL database. It helps to keep the file less cluttered if long
5019 strings such as SQL statements are defined separately as macros, for example:
5020 .code
5021 ALIAS_QUERY = select mailbox from user where \
5022               login='${quote_mysql:$local_part}';
5023 .endd
5024 This can then be used in a &(redirect)& router setting like this:
5025 .code
5026 data = ${lookup mysql{ALIAS_QUERY}}
5027 .endd
5028 In earlier versions of Exim macros were sometimes used for domain, host, or
5029 address lists. In Exim 4 these are handled better by named lists &-- see
5030 section &<<SECTnamedlists>>&.
5031
5032
5033 .section "Builtin macros" "SECTbuiltinmacros"
5034 Exim defines some macros depending on facilities available, which may
5035 differ due to build-time definitions and from one release to another.
5036 All of these macros start with an underscore.
5037 They can be used to conditionally include parts of a configuration
5038 (see below).
5039
5040 The following classes of macros are defined:
5041 .display
5042 &` _HAVE_*                    `&  build-time defines
5043 &` _DRIVER_ROUTER_*           `&  router drivers
5044 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5045 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5046 &` _OPT_MAIN_*                `&  main config options
5047 &` _OPT_ROUTERS_*             `&  generic router options
5048 &` _OPT_TRANSPORTS_*          `&  generic transport options
5049 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5050 &` _OPT_ROUTER_*_*            `&  private router options
5051 &` _OPT_TRANSPORT_*_*         `&  private transport options
5052 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5053 .endd
5054
5055 Use an &"exim -bP macros"& command to get the list of macros.
5056
5057
5058 .section "Conditional skips in the configuration file" "SECID46"
5059 .cindex "configuration file" "conditional skips"
5060 .cindex "&`.ifdef`&"
5061 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5062 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5063 portions of the configuration file. The processing happens whenever the file is
5064 read (that is, when an Exim binary starts to run).
5065
5066 The implementation is very simple. Instances of the first four directives must
5067 be followed by text that includes the names of one or macros. The condition
5068 that is tested is whether or not any macro substitution has taken place in the
5069 line. Thus:
5070 .code
5071 .ifdef AAA
5072 message_size_limit = 50M
5073 .else
5074 message_size_limit = 100M
5075 .endif
5076 .endd
5077 sets a message size limit of 50M if the macro &`AAA`& is defined
5078 (or &`A`& or &`AA`&), and 100M
5079 otherwise. If there is more than one macro named on the line, the condition
5080 is true if any of them are defined. That is, it is an &"or"& condition. To
5081 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5082
5083 Although you can use a macro expansion to generate one of these directives,
5084 it is not very useful, because the condition &"there was a macro substitution
5085 in this line"& will always be true.
5086
5087 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5088 to clarify complicated nestings.
5089
5090
5091
5092 .section "Common option syntax" "SECTcos"
5093 .cindex "common option syntax"
5094 .cindex "syntax of common options"
5095 .cindex "configuration file" "common option syntax"
5096 For the main set of options, driver options, and &[local_scan()]& options,
5097 each setting is on a line by itself, and starts with a name consisting of
5098 lower-case letters and underscores. Many options require a data value, and in
5099 these cases the name must be followed by an equals sign (with optional white
5100 space) and then the value. For example:
5101 .code
5102 qualify_domain = mydomain.example.com
5103 .endd
5104 .cindex "hiding configuration option values"
5105 .cindex "configuration options" "hiding value of"
5106 .cindex "options" "hiding value of"
5107 Some option settings may contain sensitive data, for example, passwords for
5108 accessing databases. To stop non-admin users from using the &%-bP%& command
5109 line option to read these values, you can precede the option settings with the
5110 word &"hide"&. For example:
5111 .code
5112 hide mysql_servers = localhost/users/admin/secret-password
5113 .endd
5114 For non-admin users, such options are displayed like this:
5115 .code
5116 mysql_servers = <value not displayable>
5117 .endd
5118 If &"hide"& is used on a driver option, it hides the value of that option on
5119 all instances of the same driver.
5120
5121 The following sections describe the syntax used for the different data types
5122 that are found in option settings.
5123
5124
5125 .section "Boolean options" "SECID47"
5126 .cindex "format" "boolean"
5127 .cindex "boolean configuration values"
5128 .oindex "&%no_%&&'xxx'&"
5129 .oindex "&%not_%&&'xxx'&"
5130 Options whose type is given as boolean are on/off switches. There are two
5131 different ways of specifying such options: with and without a data value. If
5132 the option name is specified on its own without data, the switch is turned on;
5133 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5134 boolean options may be followed by an equals sign and one of the words
5135 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5136 the following two settings have exactly the same effect:
5137 .code
5138 queue_only
5139 queue_only = true
5140 .endd
5141 The following two lines also have the same (opposite) effect:
5142 .code
5143 no_queue_only
5144 queue_only = false
5145 .endd
5146 You can use whichever syntax you prefer.
5147
5148
5149
5150
5151 .section "Integer values" "SECID48"
5152 .cindex "integer configuration values"
5153 .cindex "format" "integer"
5154 If an option's type is given as &"integer"&, the value can be given in decimal,
5155 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5156 number is assumed. Otherwise, it is treated as an octal number unless it starts
5157 with the characters &"0x"&, in which case the remainder is interpreted as a
5158 hexadecimal number.
5159
5160 If an integer value is followed by the letter K, it is multiplied by 1024; if
5161 it is followed by the letter M, it is multiplied by 1024x1024;
5162 if by the letter G, 1024x1024x1024.
5163 When the values
5164 of integer option settings are output, values which are an exact multiple of
5165 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5166 and M. The printing style is independent of the actual input format that was
5167 used.
5168
5169
5170 .section "Octal integer values" "SECID49"
5171 .cindex "integer format"
5172 .cindex "format" "octal integer"
5173 If an option's type is given as &"octal integer"&, its value is always
5174 interpreted as an octal number, whether or not it starts with the digit zero.
5175 Such options are always output in octal.
5176
5177
5178 .section "Fixed point numbers" "SECID50"
5179 .cindex "fixed point configuration values"
5180 .cindex "format" "fixed point"
5181 If an option's type is given as &"fixed-point"&, its value must be a decimal
5182 integer, optionally followed by a decimal point and up to three further digits.
5183
5184
5185
5186 .section "Time intervals" "SECTtimeformat"
5187 .cindex "time interval" "specifying in configuration"
5188 .cindex "format" "time interval"
5189 A time interval is specified as a sequence of numbers, each followed by one of
5190 the following letters, with no intervening white space:
5191
5192 .table2 30pt
5193 .irow &%s%& seconds
5194 .irow &%m%& minutes
5195 .irow &%h%& hours
5196 .irow &%d%& days
5197 .irow &%w%& weeks
5198 .endtable
5199
5200 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5201 intervals are output in the same format. Exim does not restrict the values; it
5202 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5203
5204
5205
5206 .section "String values" "SECTstrings"
5207 .cindex "string" "format of configuration values"
5208 .cindex "format" "string"
5209 If an option's type is specified as &"string"&, the value can be specified with
5210 or without double-quotes. If it does not start with a double-quote, the value
5211 consists of the remainder of the line plus any continuation lines, starting at
5212 the first character after any leading white space, with trailing white space
5213 removed, and with no interpretation of the characters in the string. Because
5214 Exim removes comment lines (those beginning with #) at an early stage, they can
5215 appear in the middle of a multi-line string. The following two settings are
5216 therefore equivalent:
5217 .code
5218 trusted_users = uucp:mail
5219 trusted_users = uucp:\
5220                 # This comment line is ignored
5221                 mail
5222 .endd
5223 .cindex "string" "quoted"
5224 .cindex "escape characters in quoted strings"
5225 If a string does start with a double-quote, it must end with a closing
5226 double-quote, and any backslash characters other than those used for line
5227 continuation are interpreted as escape characters, as follows:
5228
5229 .table2 100pt
5230 .irow &`\\`&                     "single backslash"
5231 .irow &`\n`&                     "newline"
5232 .irow &`\r`&                     "carriage return"
5233 .irow &`\t`&                     "tab"
5234 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5235 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5236                                    character"
5237 .endtable
5238
5239 If a backslash is followed by some other character, including a double-quote
5240 character, that character replaces the pair.
5241
5242 Quoting is necessary only if you want to make use of the backslash escapes to
5243 insert special characters, or if you need to specify a value with leading or
5244 trailing spaces. These cases are rare, so quoting is almost never needed in
5245 current versions of Exim. In versions of Exim before 3.14, quoting was required
5246 in order to continue lines, so you may come across older configuration files
5247 and examples that apparently quote unnecessarily.
5248
5249
5250 .section "Expanded strings" "SECID51"
5251 .cindex "expansion" "definition of"
5252 Some strings in the configuration file are subjected to &'string expansion'&,
5253 by which means various parts of the string may be changed according to the
5254 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5255 is as just described; in particular, the handling of backslashes in quoted
5256 strings is done as part of the input process, before expansion takes place.
5257 However, backslash is also an escape character for the expander, so any
5258 backslashes that are required for that reason must be doubled if they are
5259 within a quoted configuration string.
5260
5261
5262 .section "User and group names" "SECID52"
5263 .cindex "user name" "format of"
5264 .cindex "format" "user name"
5265 .cindex "groups" "name format"
5266 .cindex "format" "group name"
5267 User and group names are specified as strings, using the syntax described
5268 above, but the strings are interpreted specially. A user or group name must
5269 either consist entirely of digits, or be a name that can be looked up using the
5270 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5271
5272
5273 .section "List construction" "SECTlistconstruct"
5274 .cindex "list" "syntax of in configuration"
5275 .cindex "format" "list item in configuration"
5276 .cindex "string" "list, definition of"
5277 The data for some configuration options is a list of items, with colon as the
5278 default separator. Many of these options are shown with type &"string list"& in
5279 the descriptions later in this document. Others are listed as &"domain list"&,
5280 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5281 are all the same; however, those other than &"string list"& are subject to
5282 particular kinds of interpretation, as described in chapter
5283 &<<CHAPdomhosaddlists>>&.
5284
5285 In all these cases, the entire list is treated as a single string as far as the
5286 input syntax is concerned. The &%trusted_users%& setting in section
5287 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5288 in a list, it must be entered as two colons. Leading and trailing white space
5289 on each item in a list is ignored. This makes it possible to include items that
5290 start with a colon, and in particular, certain forms of IPv6 address. For
5291 example, the list
5292 .code
5293 local_interfaces = 127.0.0.1 : ::::1
5294 .endd
5295 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5296
5297 &*Note*&: Although leading and trailing white space is ignored in individual
5298 list items, it is not ignored when parsing the list. The space after the first
5299 colon in the example above is necessary. If it were not there, the list would
5300 be interpreted as the two items 127.0.0.1:: and 1.
5301
5302 .section "Changing list separators" "SECTlistsepchange"
5303 .cindex "list separator" "changing"
5304 .cindex "IPv6" "addresses in lists"
5305 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5306 introduced to allow the separator character to be changed. If a list begins
5307 with a left angle bracket, followed by any punctuation character, that
5308 character is used instead of colon as the list separator. For example, the list
5309 above can be rewritten to use a semicolon separator like this:
5310 .code
5311 local_interfaces = <; 127.0.0.1 ; ::1
5312 .endd
5313 This facility applies to all lists, with the exception of the list in
5314 &%log_file_path%&. It is recommended that the use of non-colon separators be
5315 confined to circumstances where they really are needed.
5316
5317 .cindex "list separator" "newline as"
5318 .cindex "newline" "as list separator"
5319 It is also possible to use newline and other control characters (those with
5320 code values less than 32, plus DEL) as separators in lists. Such separators
5321 must be provided literally at the time the list is processed. For options that
5322 are string-expanded, you can write the separator using a normal escape
5323 sequence. This will be processed by the expander before the string is
5324 interpreted as a list. For example, if a newline-separated list of domains is
5325 generated by a lookup, you can process it directly by a line such as this:
5326 .code
5327 domains = <\n ${lookup mysql{.....}}
5328 .endd
5329 This avoids having to change the list separator in such data. You are unlikely
5330 to want to use a control character as a separator in an option that is not
5331 expanded, because the value is literal text. However, it can be done by giving
5332 the value in quotes. For example:
5333 .code
5334 local_interfaces = "<\n 127.0.0.1 \n ::1"
5335 .endd
5336 Unlike printing character separators, which can be included in list items by
5337 doubling, it is not possible to include a control character as data when it is
5338 set as the separator. Two such characters in succession are interpreted as
5339 enclosing an empty list item.
5340
5341
5342
5343 .section "Empty items in lists" "SECTempitelis"
5344 .cindex "list" "empty item in"
5345 An empty item at the end of a list is always ignored. In other words, trailing
5346 separator characters are ignored. Thus, the list in
5347 .code
5348 senders = user@domain :
5349 .endd
5350 contains only a single item. If you want to include an empty string as one item
5351 in a list, it must not be the last item. For example, this list contains three
5352 items, the second of which is empty:
5353 .code
5354 senders = user1@domain : : user2@domain
5355 .endd
5356 &*Note*&: There must be white space between the two colons, as otherwise they
5357 are interpreted as representing a single colon data character (and the list
5358 would then contain just one item). If you want to specify a list that contains
5359 just one, empty item, you can do it as in this example:
5360 .code
5361 senders = :
5362 .endd
5363 In this case, the first item is empty, and the second is discarded because it
5364 is at the end of the list.
5365
5366
5367
5368
5369 .section "Format of driver configurations" "SECTfordricon"
5370 .cindex "drivers" "configuration format"
5371 There are separate parts in the configuration for defining routers, transports,
5372 and authenticators. In each part, you are defining a number of driver
5373 instances, each with its own set of options. Each driver instance is defined by
5374 a sequence of lines like this:
5375 .display
5376 <&'instance name'&>:
5377   <&'option'&>
5378   ...
5379   <&'option'&>
5380 .endd
5381 In the following example, the instance name is &(localuser)&, and it is
5382 followed by three options settings:
5383 .code
5384 localuser:
5385   driver = accept
5386   check_local_user
5387   transport = local_delivery
5388 .endd
5389 For each driver instance, you specify which Exim code module it uses &-- by the
5390 setting of the &%driver%& option &-- and (optionally) some configuration
5391 settings. For example, in the case of transports, if you want a transport to
5392 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5393 a local file you would use the &(appendfile)& driver. Each of the drivers is
5394 described in detail in its own separate chapter later in this manual.
5395
5396 You can have several routers, transports, or authenticators that are based on
5397 the same underlying driver (each must have a different instance name).
5398
5399 The order in which routers are defined is important, because addresses are
5400 passed to individual routers one by one, in order. The order in which
5401 transports are defined does not matter at all. The order in which
5402 authenticators are defined is used only when Exim, as a client, is searching
5403 them to find one that matches an authentication mechanism offered by the
5404 server.
5405
5406 .cindex "generic options"
5407 .cindex "options" "generic &-- definition of"
5408 Within a driver instance definition, there are two kinds of option: &'generic'&
5409 and &'private'&. The generic options are those that apply to all drivers of the
5410 same type (that is, all routers, all transports or all authenticators). The
5411 &%driver%& option is a generic option that must appear in every definition.
5412 .cindex "private options"
5413 The private options are special for each driver, and none need appear, because
5414 they all have default values.
5415
5416 The options may appear in any order, except that the &%driver%& option must
5417 precede any private options, since these depend on the particular driver. For
5418 this reason, it is recommended that &%driver%& always be the first option.
5419
5420 Driver instance names, which are used for reference in log entries and
5421 elsewhere, can be any sequence of letters, digits, and underscores (starting
5422 with a letter) and must be unique among drivers of the same type. A router and
5423 a transport (for example) can each have the same name, but no two router
5424 instances can have the same name. The name of a driver instance should not be
5425 confused with the name of the underlying driver module. For example, the
5426 configuration lines:
5427 .code
5428 remote_smtp:
5429   driver = smtp
5430 .endd
5431 create an instance of the &(smtp)& transport driver whose name is
5432 &(remote_smtp)&. The same driver code can be used more than once, with
5433 different instance names and different option settings each time. A second
5434 instance of the &(smtp)& transport, with different options, might be defined
5435 thus:
5436 .code
5437 special_smtp:
5438   driver = smtp
5439   port = 1234
5440   command_timeout = 10s
5441 .endd
5442 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5443 these transport instances from routers, and these names would appear in log
5444 lines.
5445
5446 Comment lines may be present in the middle of driver specifications. The full
5447 list of option settings for any particular driver instance, including all the
5448 defaulted values, can be extracted by making use of the &%-bP%& command line
5449 option.
5450
5451
5452
5453
5454
5455
5456 . ////////////////////////////////////////////////////////////////////////////
5457 . ////////////////////////////////////////////////////////////////////////////
5458
5459 .chapter "The default configuration file" "CHAPdefconfil"
5460 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5461 .cindex "default" "configuration file &""walk through""&"
5462 The default configuration file supplied with Exim as &_src/configure.default_&
5463 is sufficient for a host with simple mail requirements. As an introduction to
5464 the way Exim is configured, this chapter &"walks through"& the default
5465 configuration, giving brief explanations of the settings. Detailed descriptions
5466 of the options are given in subsequent chapters. The default configuration file
5467 itself contains extensive comments about ways you might want to modify the
5468 initial settings. However, note that there are many options that are not
5469 mentioned at all in the default configuration.
5470
5471
5472
5473 .section "Main configuration settings" "SECTdefconfmain"
5474 The main (global) configuration option settings must always come first in the
5475 file. The first thing you'll see in the file, after some initial comments, is
5476 the line
5477 .code
5478 # primary_hostname =
5479 .endd
5480 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5481 to know the official, fully qualified name of your host, and this is where you
5482 can specify it. However, in most cases you do not need to set this option. When
5483 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5484
5485 The first three non-comment configuration lines are as follows:
5486 .code
5487 domainlist local_domains    = @
5488 domainlist relay_to_domains =
5489 hostlist   relay_from_hosts = 127.0.0.1
5490 .endd
5491 These are not, in fact, option settings. They are definitions of two named
5492 domain lists and one named host list. Exim allows you to give names to lists of
5493 domains, hosts, and email addresses, in order to make it easier to manage the
5494 configuration file (see section &<<SECTnamedlists>>&).
5495
5496 The first line defines a domain list called &'local_domains'&; this is used
5497 later in the configuration to identify domains that are to be delivered
5498 on the local host.
5499
5500 .cindex "@ in a domain list"
5501 There is just one item in this list, the string &"@"&. This is a special form
5502 of entry which means &"the name of the local host"&. Thus, if the local host is
5503 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5504 be delivered locally. Because the local host's name is referenced indirectly,
5505 the same configuration file can be used on different hosts.
5506
5507 The second line defines a domain list called &'relay_to_domains'&, but the
5508 list itself is empty. Later in the configuration we will come to the part that
5509 controls mail relaying through the local host; it allows relaying to any
5510 domains in this list. By default, therefore, no relaying on the basis of a mail
5511 domain is permitted.
5512
5513 The third line defines a host list called &'relay_from_hosts'&. This list is
5514 used later in the configuration to permit relaying from any host or IP address
5515 that matches the list. The default contains just the IP address of the IPv4
5516 loopback interface, which means that processes on the local host are able to
5517 submit mail for relaying by sending it over TCP/IP to that interface. No other
5518 hosts are permitted to submit messages for relaying.
5519
5520 Just to be sure there's no misunderstanding: at this point in the configuration
5521 we aren't actually setting up any controls. We are just defining some domains
5522 and hosts that will be used in the controls that are specified later.
5523
5524 The next two configuration lines are genuine option settings:
5525 .code
5526 acl_smtp_rcpt = acl_check_rcpt
5527 acl_smtp_data = acl_check_data
5528 .endd
5529 These options specify &'Access Control Lists'& (ACLs) that are to be used
5530 during an incoming SMTP session for every recipient of a message (every RCPT
5531 command), and after the contents of the message have been received,
5532 respectively. The names of the lists are &'acl_check_rcpt'& and
5533 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5534 section of the configuration. The RCPT ACL controls which recipients are
5535 accepted for an incoming message &-- if a configuration does not provide an ACL
5536 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5537 contents of a message to be checked.
5538
5539 Two commented-out option settings are next:
5540 .code
5541 # av_scanner = clamd:/tmp/clamd
5542 # spamd_address = 127.0.0.1 783
5543 .endd
5544 These are example settings that can be used when Exim is compiled with the
5545 content-scanning extension. The first specifies the interface to the virus
5546 scanner, and the second specifies the interface to SpamAssassin. Further
5547 details are given in chapter &<<CHAPexiscan>>&.
5548
5549 Three more commented-out option settings follow:
5550 .code
5551 # tls_advertise_hosts = *
5552 # tls_certificate = /etc/ssl/exim.crt
5553 # tls_privatekey = /etc/ssl/exim.pem
5554 .endd
5555 These are example settings that can be used when Exim is compiled with
5556 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5557 first one specifies the list of clients that are allowed to use TLS when
5558 connecting to this server; in this case the wildcard means all clients. The
5559 other options specify where Exim should find its TLS certificate and private
5560 key, which together prove the server's identity to any clients that connect.
5561 More details are given in chapter &<<CHAPTLS>>&.
5562
5563 Another two commented-out option settings follow:
5564 .code
5565 # daemon_smtp_ports = 25 : 465 : 587
5566 # tls_on_connect_ports = 465
5567 .endd
5568 .cindex "port" "465 and 587"
5569 .cindex "port" "for message submission"
5570 .cindex "message" "submission, ports for"
5571 .cindex "ssmtp protocol"
5572 .cindex "smtps protocol"
5573 .cindex "SMTP" "ssmtp protocol"
5574 .cindex "SMTP" "smtps protocol"
5575 These options provide better support for roaming users who wish to use this
5576 server for message submission. They are not much use unless you have turned on
5577 TLS (as described in the previous paragraph) and authentication (about which
5578 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5579 on end-user networks, so RFC 4409 specifies that message submission should use
5580 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5581 configured to use port 587 correctly, so these settings also enable the
5582 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5583 &<<SECTsupobssmt>>&).
5584
5585 Two more commented-out options settings follow:
5586 .code
5587 # qualify_domain =
5588 # qualify_recipient =
5589 .endd
5590 The first of these specifies a domain that Exim uses when it constructs a
5591 complete email address from a local login name. This is often needed when Exim
5592 receives a message from a local process. If you do not set &%qualify_domain%&,
5593 the value of &%primary_hostname%& is used. If you set both of these options,
5594 you can have different qualification domains for sender and recipient
5595 addresses. If you set only the first one, its value is used in both cases.
5596
5597 .cindex "domain literal" "recognizing format"
5598 The following line must be uncommented if you want Exim to recognize
5599 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5600 (an IP address within square brackets) instead of a named domain.
5601 .code
5602 # allow_domain_literals
5603 .endd
5604 The RFCs still require this form, but many people think that in the modern
5605 Internet it makes little sense to permit mail to be sent to specific hosts by
5606 quoting their IP addresses. This ancient format has been used by people who
5607 try to abuse hosts by using them for unwanted relaying. However, some
5608 people believe there are circumstances (for example, messages addressed to
5609 &'postmaster'&) where domain literals are still useful.
5610
5611 The next configuration line is a kind of trigger guard:
5612 .code
5613 never_users = root
5614 .endd
5615 It specifies that no delivery must ever be run as the root user. The normal
5616 convention is to set up &'root'& as an alias for the system administrator. This
5617 setting is a guard against slips in the configuration.
5618 The list of users specified by &%never_users%& is not, however, the complete
5619 list; the build-time configuration in &_Local/Makefile_& has an option called
5620 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5621 contents of &%never_users%& are added to this list. By default
5622 FIXED_NEVER_USERS also specifies root.
5623
5624 When a remote host connects to Exim in order to send mail, the only information
5625 Exim has about the host's identity is its IP address. The next configuration
5626 line,
5627 .code
5628 host_lookup = *
5629 .endd
5630 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5631 in order to get a host name. This improves the quality of the logging
5632 information, but if you feel it is too expensive, you can remove it entirely,
5633 or restrict the lookup to hosts on &"nearby"& networks.
5634 Note that it is not always possible to find a host name from an IP address,
5635 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5636 unreachable.
5637
5638 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5639 1413 (hence their names):
5640 .code
5641 rfc1413_hosts = *
5642 rfc1413_query_timeout = 0s
5643 .endd
5644 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5645 Few hosts offer RFC1413 service these days; calls have to be
5646 terminated by a timeout and this needlessly delays the startup
5647 of an incoming SMTP connection.
5648 If you have hosts for which you trust RFC1413 and need this
5649 information, you can change this.
5650
5651 This line enables an efficiency SMTP option.  It is negotiated by clients
5652 and not expected to cause problems but can be disabled if needed.
5653 .code
5654 prdr_enable = true
5655 .endd
5656
5657 When Exim receives messages over SMTP connections, it expects all addresses to
5658 be fully qualified with a domain, as required by the SMTP definition. However,
5659 if you are running a server to which simple clients submit messages, you may
5660 find that they send unqualified addresses. The two commented-out options:
5661 .code
5662 # sender_unqualified_hosts =
5663 # recipient_unqualified_hosts =
5664 .endd
5665 show how you can specify hosts that are permitted to send unqualified sender
5666 and recipient addresses, respectively.
5667
5668 The &%log_selector%& option is used to increase the detail of logging
5669 over the default:
5670 .code
5671 log_selector = +smtp_protocol_error +smtp_syntax_error \
5672                +tls_certificate_verified
5673 .endd
5674
5675 The &%percent_hack_domains%& option is also commented out:
5676 .code
5677 # percent_hack_domains =
5678 .endd
5679 It provides a list of domains for which the &"percent hack"& is to operate.
5680 This is an almost obsolete form of explicit email routing. If you do not know
5681 anything about it, you can safely ignore this topic.
5682
5683 The next two settings in the main part of the default configuration are
5684 concerned with messages that have been &"frozen"& on Exim's queue. When a
5685 message is frozen, Exim no longer continues to try to deliver it. Freezing
5686 occurs when a bounce message encounters a permanent failure because the sender
5687 address of the original message that caused the bounce is invalid, so the
5688 bounce cannot be delivered. This is probably the most common case, but there
5689 are also other conditions that cause freezing, and frozen messages are not
5690 always bounce messages.
5691 .code
5692 ignore_bounce_errors_after = 2d
5693 timeout_frozen_after = 7d
5694 .endd
5695 The first of these options specifies that failing bounce messages are to be
5696 discarded after 2 days on the queue. The second specifies that any frozen
5697 message (whether a bounce message or not) is to be timed out (and discarded)
5698 after a week. In this configuration, the first setting ensures that no failing
5699 bounce message ever lasts a week.
5700
5701 Exim queues it's messages in a spool directory. If you expect to have
5702 large queues, you may consider using this option. It splits the spool
5703 directory into subdirectories to avoid file system degradation from
5704 many files in a single directory, resulting in better performance.
5705 Manual manipulation of queued messages becomes more complex (though fortunately
5706 not often needed).
5707 .code
5708 # split_spool_directory = true
5709 .endd
5710
5711 In an ideal world everybody follows the standards. For non-ASCII
5712 messages RFC 2047 is a standard, allowing a maximum line length of 76
5713 characters. Exim adheres that standard and won't process messages which
5714 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5715 In particular, the Exim maintainers have had multiple reports of
5716 problems from Russian administrators of issues until they disable this
5717 check, because of some popular, yet buggy, mail composition software.
5718 .code
5719 # check_rfc2047_length = false
5720 .endd
5721
5722 If you need to be strictly RFC compliant you may wish to disable the
5723 8BITMIME advertisement. Use this, if you exchange mails with systems
5724 that are not 8-bit clean.
5725 .code
5726 # accept_8bitmime = false
5727 .endd
5728
5729 Libraries you use may depend on specific environment settings.  This
5730 imposes a security risk (e.g. PATH). There are two lists:
5731 &%keep_environment%& for the variables to import as they are, and
5732 &%add_environment%& for variables we want to set to a fixed value.
5733 Note that TZ is handled separately, by the $%timezone%$ runtime
5734 option and by the TIMEZONE_DEFAULT buildtime option.
5735 .code
5736 # keep_environment = ^LDAP
5737 # add_environment = PATH=/usr/bin::/bin
5738 .endd
5739
5740
5741 .section "ACL configuration" "SECID54"
5742 .cindex "default" "ACLs"
5743 .cindex "&ACL;" "default configuration"
5744 In the default configuration, the ACL section follows the main configuration.
5745 It starts with the line
5746 .code
5747 begin acl
5748 .endd
5749 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5750 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5751 and &%acl_smtp_data%& above.
5752
5753 .cindex "RCPT" "ACL for"
5754 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5755 RCPT command specifies one of the message's recipients. The ACL statements
5756 are considered in order, until the recipient address is either accepted or
5757 rejected. The RCPT command is then accepted or rejected, according to the
5758 result of the ACL processing.
5759 .code
5760 acl_check_rcpt:
5761 .endd
5762 This line, consisting of a name terminated by a colon, marks the start of the
5763 ACL, and names it.
5764 .code
5765 accept  hosts = :
5766 .endd
5767 This ACL statement accepts the recipient if the sending host matches the list.
5768 But what does that strange list mean? It doesn't actually contain any host
5769 names or IP addresses. The presence of the colon puts an empty item in the
5770 list; Exim matches this only if the incoming message did not come from a remote
5771 host, because in that case, the remote hostname is empty. The colon is
5772 important. Without it, the list itself is empty, and can never match anything.
5773
5774 What this statement is doing is to accept unconditionally all recipients in
5775 messages that are submitted by SMTP from local processes using the standard
5776 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5777 manner.
5778 .code
5779 deny    message       = Restricted characters in address
5780         domains       = +local_domains
5781         local_parts   = ^[.] : ^.*[@%!/|]
5782
5783 deny    message       = Restricted characters in address
5784         domains       = !+local_domains
5785         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5786 .endd
5787 These statements are concerned with local parts that contain any of the
5788 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5789 Although these characters are entirely legal in local parts (in the case of
5790 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5791 in Internet mail addresses.
5792
5793 The first three have in the past been associated with explicitly routed
5794 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5795 option). Addresses containing these characters are regularly tried by spammers
5796 in an attempt to bypass relaying restrictions, and also by open relay testing
5797 programs. Unless you really need them it is safest to reject these characters
5798 at this early stage. This configuration is heavy-handed in rejecting these
5799 characters for all messages it accepts from remote hosts. This is a deliberate
5800 policy of being as safe as possible.
5801
5802 The first rule above is stricter, and is applied to messages that are addressed
5803 to one of the local domains handled by this host. This is implemented by the
5804 first condition, which restricts it to domains that are listed in the
5805 &'local_domains'& domain list. The &"+"& character is used to indicate a
5806 reference to a named list. In this configuration, there is just one domain in
5807 &'local_domains'&, but in general there may be many.
5808
5809 The second condition on the first statement uses two regular expressions to
5810 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5811 or &"|"&. If you have local accounts that include these characters, you will
5812 have to modify this rule.
5813
5814 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5815 allows them because they have been encountered in practice. (Consider the
5816 common convention of local parts constructed as
5817 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5818 the author of Exim, who has no second initial.) However, a local part starting
5819 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5820 file name (for example, for a mailing list). This is also true for local parts
5821 that contain slashes. A pipe symbol can also be troublesome if the local part
5822 is incorporated unthinkingly into a shell command line.
5823
5824 The second rule above applies to all other domains, and is less strict. This
5825 allows your own users to send outgoing messages to sites that use slashes
5826 and vertical bars in their local parts. It blocks local parts that begin
5827 with a dot, slash, or vertical bar, but allows these characters within the
5828 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5829 and &"!"& is blocked, as before. The motivation here is to prevent your users
5830 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5831 .code
5832 accept  local_parts   = postmaster
5833         domains       = +local_domains
5834 .endd
5835 This statement, which has two conditions, accepts an incoming address if the
5836 local part is &'postmaster'& and the domain is one of those listed in the
5837 &'local_domains'& domain list. The &"+"& character is used to indicate a
5838 reference to a named list. In this configuration, there is just one domain in
5839 &'local_domains'&, but in general there may be many.
5840
5841 The presence of this statement means that mail to postmaster is never blocked
5842 by any of the subsequent tests. This can be helpful while sorting out problems
5843 in cases where the subsequent tests are incorrectly denying access.
5844 .code
5845 require verify        = sender
5846 .endd
5847 This statement requires the sender address to be verified before any subsequent
5848 ACL statement can be used. If verification fails, the incoming recipient
5849 address is refused. Verification consists of trying to route the address, to
5850 see if a bounce message could be delivered to it. In the case of remote
5851 addresses, basic verification checks only the domain, but &'callouts'& can be
5852 used for more verification if required. Section &<<SECTaddressverification>>&
5853 discusses the details of address verification.
5854 .code
5855 accept  hosts         = +relay_from_hosts
5856         control       = submission
5857 .endd
5858 This statement accepts the address if the message is coming from one of the
5859 hosts that are defined as being allowed to relay through this host. Recipient
5860 verification is omitted here, because in many cases the clients are dumb MUAs
5861 that do not cope well with SMTP error responses. For the same reason, the
5862 second line specifies &"submission mode"& for messages that are accepted. This
5863 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5864 messages that are deficient in some way, for example, because they lack a
5865 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5866 probably add recipient verification here, and disable submission mode.
5867 .code
5868 accept  authenticated = *
5869         control       = submission
5870 .endd
5871 This statement accepts the address if the client host has authenticated itself.
5872 Submission mode is again specified, on the grounds that such messages are most
5873 likely to come from MUAs. The default configuration does not define any
5874 authenticators, though it does include some nearly complete commented-out
5875 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5876 fact authenticate until you complete the authenticator definitions.
5877 .code
5878 require message = relay not permitted
5879         domains = +local_domains : +relay_to_domains
5880 .endd
5881 This statement rejects the address if its domain is neither a local domain nor
5882 one of the domains for which this host is a relay.
5883 .code
5884 require verify = recipient
5885 .endd
5886 This statement requires the recipient address to be verified; if verification
5887 fails, the address is rejected.
5888 .code
5889 # deny    message     = rejected because $sender_host_address \
5890 #                       is in a black list at $dnslist_domain\n\
5891 #                       $dnslist_text
5892 #         dnslists    = black.list.example
5893 #
5894 # warn    dnslists    = black.list.example
5895 #         add_header  = X-Warning: $sender_host_address is in \
5896 #                       a black list at $dnslist_domain
5897 #         log_message = found in $dnslist_domain
5898 .endd
5899 These commented-out lines are examples of how you could configure Exim to check
5900 sending hosts against a DNS black list. The first statement rejects messages
5901 from blacklisted hosts, whereas the second just inserts a warning header
5902 line.
5903 .code
5904 # require verify = csa
5905 .endd
5906 This commented-out line is an example of how you could turn on client SMTP
5907 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5908 records.
5909 .code
5910 accept
5911 .endd
5912 The final statement in the first ACL unconditionally accepts any recipient
5913 address that has successfully passed all the previous tests.
5914 .code
5915 acl_check_data:
5916 .endd
5917 This line marks the start of the second ACL, and names it. Most of the contents
5918 of this ACL are commented out:
5919 .code
5920 # deny    malware   = *
5921 #         message   = This message contains a virus \
5922 #                     ($malware_name).
5923 .endd
5924 These lines are examples of how to arrange for messages to be scanned for
5925 viruses when Exim has been compiled with the content-scanning extension, and a
5926 suitable virus scanner is installed. If the message is found to contain a
5927 virus, it is rejected with the given custom error message.
5928 .code
5929 # warn    spam      = nobody
5930 #         message   = X-Spam_score: $spam_score\n\
5931 #                     X-Spam_score_int: $spam_score_int\n\
5932 #                     X-Spam_bar: $spam_bar\n\
5933 #                     X-Spam_report: $spam_report
5934 .endd
5935 These lines are an example of how to arrange for messages to be scanned by
5936 SpamAssassin when Exim has been compiled with the content-scanning extension,
5937 and SpamAssassin has been installed. The SpamAssassin check is run with
5938 &`nobody`& as its user parameter, and the results are added to the message as a
5939 series of extra header line. In this case, the message is not rejected,
5940 whatever the spam score.
5941 .code
5942 accept
5943 .endd
5944 This final line in the DATA ACL accepts the message unconditionally.
5945
5946
5947 .section "Router configuration" "SECID55"
5948 .cindex "default" "routers"
5949 .cindex "routers" "default"
5950 The router configuration comes next in the default configuration, introduced
5951 by the line
5952 .code
5953 begin routers
5954 .endd
5955 Routers are the modules in Exim that make decisions about where to send
5956 messages. An address is passed to each router in turn, until it is either
5957 accepted, or failed. This means that the order in which you define the routers
5958 matters. Each router is fully described in its own chapter later in this
5959 manual. Here we give only brief overviews.
5960 .code
5961 # domain_literal:
5962 #   driver = ipliteral
5963 #   domains = !+local_domains
5964 #   transport = remote_smtp
5965 .endd
5966 .cindex "domain literal" "default router"
5967 This router is commented out because the majority of sites do not want to
5968 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5969 you uncomment this router, you also need to uncomment the setting of
5970 &%allow_domain_literals%& in the main part of the configuration.
5971 .code
5972 dnslookup:
5973   driver = dnslookup
5974   domains = ! +local_domains
5975   transport = remote_smtp
5976   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5977   no_more
5978 .endd
5979 The first uncommented router handles addresses that do not involve any local
5980 domains. This is specified by the line
5981 .code
5982 domains = ! +local_domains
5983 .endd
5984 The &%domains%& option lists the domains to which this router applies, but the
5985 exclamation mark is a negation sign, so the router is used only for domains
5986 that are not in the domain list called &'local_domains'& (which was defined at
5987 the start of the configuration). The plus sign before &'local_domains'&
5988 indicates that it is referring to a named list. Addresses in other domains are
5989 passed on to the following routers.
5990
5991 The name of the router driver is &(dnslookup)&,
5992 and is specified by the &%driver%& option. Do not be confused by the fact that
5993 the name of this router instance is the same as the name of the driver. The
5994 instance name is arbitrary, but the name set in the &%driver%& option must be
5995 one of the driver modules that is in the Exim binary.
5996
5997 The &(dnslookup)& router routes addresses by looking up their domains in the
5998 DNS in order to obtain a list of hosts to which the address is routed. If the
5999 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6000 specified by the &%transport%& option. If the router does not find the domain
6001 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6002 the address fails and is bounced.
6003
6004 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6005 be entirely ignored. This option is present because a number of cases have been
6006 encountered where MX records in the DNS point to host names
6007 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6008 Completely ignoring these IP addresses causes Exim to fail to route the
6009 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6010 continue to try to deliver the message periodically until the address timed
6011 out.
6012 .code
6013 system_aliases:
6014   driver = redirect
6015   allow_fail
6016   allow_defer
6017   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6018 # user = exim
6019   file_transport = address_file
6020   pipe_transport = address_pipe
6021 .endd
6022 Control reaches this and subsequent routers only for addresses in the local
6023 domains. This router checks to see whether the local part is defined as an
6024 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6025 data that it looks up from that file. If no data is found for the local part,
6026 the value of the &%data%& option is empty, causing the address to be passed to
6027 the next router.
6028
6029 &_/etc/aliases_& is a conventional name for the system aliases file that is
6030 often used. That is why it is referenced by from the default configuration
6031 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6032 &_Local/Makefile_& before building Exim.
6033 .code
6034 userforward:
6035   driver = redirect
6036   check_local_user
6037 # local_part_suffix = +* : -*
6038 # local_part_suffix_optional
6039   file = $home/.forward
6040 # allow_filter
6041   no_verify
6042   no_expn
6043   check_ancestor
6044   file_transport = address_file
6045   pipe_transport = address_pipe
6046   reply_transport = address_reply
6047 .endd
6048 This is the most complicated router in the default configuration. It is another
6049 redirection router, but this time it is looking for forwarding data set up by
6050 individual users. The &%check_local_user%& setting specifies a check that the
6051 local part of the address is the login name of a local user. If it is not, the
6052 router is skipped. The two commented options that follow &%check_local_user%&,
6053 namely:
6054 .code
6055 # local_part_suffix = +* : -*
6056 # local_part_suffix_optional
6057 .endd
6058 .vindex "&$local_part_suffix$&"
6059 show how you can specify the recognition of local part suffixes. If the first
6060 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6061 by any sequence of characters, is removed from the local part and placed in the
6062 variable &$local_part_suffix$&. The second suffix option specifies that the
6063 presence of a suffix in the local part is optional. When a suffix is present,
6064 the check for a local login uses the local part with the suffix removed.
6065
6066 When a local user account is found, the file called &_.forward_& in the user's
6067 home directory is consulted. If it does not exist, or is empty, the router
6068 declines. Otherwise, the contents of &_.forward_& are interpreted as
6069 redirection data (see chapter &<<CHAPredirect>>& for more details).
6070
6071 .cindex "Sieve filter" "enabling in default router"
6072 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6073 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6074 is commented out by default), the contents of the file are interpreted as a set
6075 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6076 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6077 separate document entitled &'Exim's interfaces to mail filtering'&.
6078
6079 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6080 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6081 There are two reasons for doing this:
6082
6083 .olist
6084 Whether or not a local user has a &_.forward_& file is not really relevant when
6085 checking an address for validity; it makes sense not to waste resources doing
6086 unnecessary work.
6087 .next
6088 More importantly, when Exim is verifying addresses or handling an EXPN
6089 command during an SMTP session, it is running as the Exim user, not as root.
6090 The group is the Exim group, and no additional groups are set up.
6091 It may therefore not be possible for Exim to read users' &_.forward_& files at
6092 this time.
6093 .endlist
6094
6095 The setting of &%check_ancestor%& prevents the router from generating a new
6096 address that is the same as any previous address that was redirected. (This
6097 works round a problem concerning a bad interaction between aliasing and
6098 forwarding &-- see section &<<SECTredlocmai>>&).
6099
6100 The final three option settings specify the transports that are to be used when
6101 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6102 auto-reply, respectively. For example, if a &_.forward_& file contains
6103 .code
6104 a.nother@elsewhere.example, /home/spqr/archive
6105 .endd
6106 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6107 transport.
6108 .code
6109 localuser:
6110   driver = accept
6111   check_local_user
6112 # local_part_suffix = +* : -*
6113 # local_part_suffix_optional
6114   transport = local_delivery
6115 .endd
6116 The final router sets up delivery into local mailboxes, provided that the local
6117 part is the name of a local login, by accepting the address and assigning it to
6118 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6119 routers, so the address is bounced. The commented suffix settings fulfil the
6120 same purpose as they do for the &(userforward)& router.
6121
6122
6123 .section "Transport configuration" "SECID56"
6124 .cindex "default" "transports"
6125 .cindex "transports" "default"
6126 Transports define mechanisms for actually delivering messages. They operate
6127 only when referenced from routers, so the order in which they are defined does
6128 not matter. The transports section of the configuration starts with
6129 .code
6130 begin transports
6131 .endd
6132 One remote transport and four local transports are defined.
6133 .code
6134 remote_smtp:
6135   driver = smtp
6136   hosts_try_prdr = *
6137 .endd
6138 This transport is used for delivering messages over SMTP connections.
6139 The list of remote hosts comes from the router.
6140 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6141 It is negotiated between client and server
6142 and not expected to cause problems but can be disabled if needed.
6143 All other options are defaulted.
6144 .code
6145 local_delivery:
6146   driver = appendfile
6147   file = /var/mail/$local_part
6148   delivery_date_add
6149   envelope_to_add
6150   return_path_add
6151 # group = mail
6152 # mode = 0660
6153 .endd
6154 This &(appendfile)& transport is used for local delivery to user mailboxes in
6155 traditional BSD mailbox format. By default it runs under the uid and gid of the
6156 local user, which requires the sticky bit to be set on the &_/var/mail_&
6157 directory. Some systems use the alternative approach of running mail deliveries
6158 under a particular group instead of using the sticky bit. The commented options
6159 show how this can be done.
6160
6161 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6162 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6163 similarly-named options above.
6164 .code
6165 address_pipe:
6166   driver = pipe
6167   return_output
6168 .endd
6169 This transport is used for handling deliveries to pipes that are generated by
6170 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6171 option specifies that any output on stdout or stderr generated by the pipe is to
6172 be returned to the sender.
6173 .code
6174 address_file:
6175   driver = appendfile
6176   delivery_date_add
6177   envelope_to_add
6178   return_path_add
6179 .endd
6180 This transport is used for handling deliveries to files that are generated by
6181 redirection. The name of the file is not specified in this instance of
6182 &(appendfile)&, because it comes from the &(redirect)& router.
6183 .code
6184 address_reply:
6185   driver = autoreply
6186 .endd
6187 This transport is used for handling automatic replies generated by users'
6188 filter files.
6189
6190
6191
6192 .section "Default retry rule" "SECID57"
6193 .cindex "retry" "default rule"
6194 .cindex "default" "retry rule"
6195 The retry section of the configuration file contains rules which affect the way
6196 Exim retries deliveries that cannot be completed at the first attempt. It is
6197 introduced by the line
6198 .code
6199 begin retry
6200 .endd
6201 In the default configuration, there is just one rule, which applies to all
6202 errors:
6203 .code
6204 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6205 .endd
6206 This causes any temporarily failing address to be retried every 15 minutes for
6207 2 hours, then at intervals starting at one hour and increasing by a factor of
6208 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6209 is not delivered after 4 days of temporary failure, it is bounced. The time is
6210 measured from first failure, not from the time the message was received.
6211
6212 If the retry section is removed from the configuration, or is empty (that is,
6213 if no retry rules are defined), Exim will not retry deliveries. This turns
6214 temporary errors into permanent errors.
6215
6216
6217 .section "Rewriting configuration" "SECID58"
6218 The rewriting section of the configuration, introduced by
6219 .code
6220 begin rewrite
6221 .endd
6222 contains rules for rewriting addresses in messages as they arrive. There are no
6223 rewriting rules in the default configuration file.
6224
6225
6226
6227 .section "Authenticators configuration" "SECTdefconfauth"
6228 .cindex "AUTH" "configuration"
6229 The authenticators section of the configuration, introduced by
6230 .code
6231 begin authenticators
6232 .endd
6233 defines mechanisms for the use of the SMTP AUTH command. The default
6234 configuration file contains two commented-out example authenticators
6235 which support plaintext username/password authentication using the
6236 standard PLAIN mechanism and the traditional but non-standard LOGIN
6237 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6238 to support most MUA software.
6239
6240 The example PLAIN authenticator looks like this:
6241 .code
6242 #PLAIN:
6243 #  driver                  = plaintext
6244 #  server_set_id           = $auth2
6245 #  server_prompts          = :
6246 #  server_condition        = Authentication is not yet configured
6247 #  server_advertise_condition = ${if def:tls_in_cipher }
6248 .endd
6249 And the example LOGIN authenticator looks like this:
6250 .code
6251 #LOGIN:
6252 #  driver                  = plaintext
6253 #  server_set_id           = $auth1
6254 #  server_prompts          = <| Username: | Password:
6255 #  server_condition        = Authentication is not yet configured
6256 #  server_advertise_condition = ${if def:tls_in_cipher }
6257 .endd
6258
6259 The &%server_set_id%& option makes Exim remember the authenticated username
6260 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6261 &%server_prompts%& option configures the &(plaintext)& authenticator so
6262 that it implements the details of the specific authentication mechanism,
6263 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6264 when Exim offers authentication to clients; in the examples, this is only
6265 when TLS or SSL has been started, so to enable the authenticators you also
6266 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6267
6268 The &%server_condition%& setting defines how to verify that the username and
6269 password are correct. In the examples it just produces an error message.
6270 To make the authenticators work, you can use a string expansion
6271 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6272
6273 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6274 usercode and password are in different positions.
6275 Chapter &<<CHAPplaintext>>& covers both.
6276
6277 .ecindex IIDconfiwal
6278
6279
6280
6281 . ////////////////////////////////////////////////////////////////////////////
6282 . ////////////////////////////////////////////////////////////////////////////
6283
6284 .chapter "Regular expressions" "CHAPregexp"
6285
6286 .cindex "regular expressions" "library"
6287 .cindex "PCRE"
6288 Exim supports the use of regular expressions in many of its options. It
6289 uses the PCRE regular expression library; this provides regular expression
6290 matching that is compatible with Perl 5. The syntax and semantics of
6291 regular expressions is discussed in
6292 online Perl manpages, in
6293 many Perl reference books, and also in
6294 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6295 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6296
6297 The documentation for the syntax and semantics of the regular expressions that
6298 are supported by PCRE is included in the PCRE distribution, and no further
6299 description is included here. The PCRE functions are called from Exim using
6300 the default option settings (that is, with no PCRE options set), except that
6301 the PCRE_CASELESS option is set when the matching is required to be
6302 case-insensitive.
6303
6304 In most cases, when a regular expression is required in an Exim configuration,
6305 it has to start with a circumflex, in order to distinguish it from plain text
6306 or an &"ends with"& wildcard. In this example of a configuration setting, the
6307 second item in the colon-separated list is a regular expression.
6308 .code
6309 domains = a.b.c : ^\\d{3} : *.y.z : ...
6310 .endd
6311 The doubling of the backslash is required because of string expansion that
6312 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6313 of this issue, and a way of avoiding the need for doubling backslashes. The
6314 regular expression that is eventually used in this example contains just one
6315 backslash. The circumflex is included in the regular expression, and has the
6316 normal effect of &"anchoring"& it to the start of the string that is being
6317 matched.
6318
6319 There are, however, two cases where a circumflex is not required for the
6320 recognition of a regular expression: these are the &%match%& condition in a
6321 string expansion, and the &%matches%& condition in an Exim filter file. In
6322 these cases, the relevant string is always treated as a regular expression; if
6323 it does not start with a circumflex, the expression is not anchored, and can
6324 match anywhere in the subject string.
6325
6326 In all cases, if you want a regular expression to match at the end of a string,
6327 you must code the $ metacharacter to indicate this. For example:
6328 .code
6329 domains = ^\\d{3}\\.example
6330 .endd
6331 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6332 You need to use:
6333 .code
6334 domains = ^\\d{3}\\.example\$
6335 .endd
6336 if you want &'example'& to be the top-level domain. The backslash before the
6337 $ is needed because string expansion also interprets dollar characters.
6338
6339
6340
6341 . ////////////////////////////////////////////////////////////////////////////
6342 . ////////////////////////////////////////////////////////////////////////////
6343
6344 .chapter "File and database lookups" "CHAPfdlookup"
6345 .scindex IIDfidalo1 "file" "lookups"
6346 .scindex IIDfidalo2 "database" "lookups"
6347 .cindex "lookup" "description of"
6348 Exim can be configured to look up data in files or databases as it processes
6349 messages. Two different kinds of syntax are used:
6350
6351 .olist
6352 A string that is to be expanded may contain explicit lookup requests. These
6353 cause parts of the string to be replaced by data that is obtained from the
6354 lookup. Lookups of this type are conditional expansion items. Different results
6355 can be defined for the cases of lookup success and failure. See chapter
6356 &<<CHAPexpand>>&, where string expansions are described in detail.
6357 The key for the lookup is specified as part of the string expansion.
6358 .next
6359 Lists of domains, hosts, and email addresses can contain lookup requests as a
6360 way of avoiding excessively long linear lists. In this case, the data that is
6361 returned by the lookup is often (but not always) discarded; whether the lookup
6362 succeeds or fails is what really counts. These kinds of list are described in
6363 chapter &<<CHAPdomhosaddlists>>&.
6364 The key for the lookup is given by the context in which the list is expanded.
6365 .endlist
6366
6367 String expansions, lists, and lookups interact with each other in such a way
6368 that there is no order in which to describe any one of them that does not
6369 involve references to the others. Each of these three chapters makes more sense
6370 if you have read the other two first. If you are reading this for the first
6371 time, be aware that some of it will make a lot more sense after you have read
6372 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6373
6374 .section "Examples of different lookup syntax" "SECID60"
6375 It is easy to confuse the two different kinds of lookup, especially as the
6376 lists that may contain the second kind are always expanded before being
6377 processed as lists. Therefore, they may also contain lookups of the first kind.
6378 Be careful to distinguish between the following two examples:
6379 .code
6380 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6381 domains = lsearch;/some/file
6382 .endd
6383 The first uses a string expansion, the result of which must be a domain list.
6384 No strings have been specified for a successful or a failing lookup; the
6385 defaults in this case are the looked-up data and an empty string, respectively.
6386 The expansion takes place before the string is processed as a list, and the
6387 file that is searched could contain lines like this:
6388 .code
6389 192.168.3.4: domain1:domain2:...
6390 192.168.1.9: domain3:domain4:...
6391 .endd
6392 When the lookup succeeds, the result of the expansion is a list of domains (and
6393 possibly other types of item that are allowed in domain lists).
6394
6395 In the second example, the lookup is a single item in a domain list. It causes
6396 Exim to use a lookup to see if the domain that is being processed can be found
6397 in the file. The file could contains lines like this:
6398 .code
6399 domain1:
6400 domain2:
6401 .endd
6402 Any data that follows the keys is not relevant when checking that the domain
6403 matches the list item.
6404
6405 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6406 Consider a file containing lines like this:
6407 .code
6408 192.168.5.6: lsearch;/another/file
6409 .endd
6410 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6411 first &%domains%& setting above generates the second setting, which therefore
6412 causes a second lookup to occur.
6413
6414 The rest of this chapter describes the different lookup types that are
6415 available. Any of them can be used in any part of the configuration where a
6416 lookup is permitted.
6417
6418
6419 .section "Lookup types" "SECID61"
6420 .cindex "lookup" "types of"
6421 .cindex "single-key lookup" "definition of"
6422 Two different types of data lookup are implemented:
6423
6424 .ilist
6425 The &'single-key'& type requires the specification of a file in which to look,
6426 and a single key to search for. The key must be a non-empty string for the
6427 lookup to succeed. The lookup type determines how the file is searched.
6428 .next
6429 .cindex "query-style lookup" "definition of"
6430 The &'query-style'& type accepts a generalized database query. No particular
6431 key value is assumed by Exim for query-style lookups. You can use whichever
6432 Exim variables you need to construct the database query.
6433 .endlist
6434
6435 The code for each lookup type is in a separate source file that is included in
6436 the binary of Exim only if the corresponding compile-time option is set. The
6437 default settings in &_src/EDITME_& are:
6438 .code
6439 LOOKUP_DBM=yes
6440 LOOKUP_LSEARCH=yes
6441 .endd
6442 which means that only linear searching and DBM lookups are included by default.
6443 For some types of lookup (e.g. SQL databases), you need to install appropriate
6444 libraries and header files before building Exim.
6445
6446
6447
6448
6449 .section "Single-key lookup types" "SECTsinglekeylookups"
6450 .cindex "lookup" "single-key types"
6451 .cindex "single-key lookup" "list of types"
6452 The following single-key lookup types are implemented:
6453
6454 .ilist
6455 .cindex "cdb" "description of"
6456 .cindex "lookup" "cdb"
6457 .cindex "binary zero" "in lookup key"
6458 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6459 string without a terminating binary zero. The cdb format is designed for
6460 indexed files that are read frequently and never updated, except by total
6461 re-creation. As such, it is particularly suitable for large files containing
6462 aliases or other indexed data referenced by an MTA. Information about cdb can
6463 be found in several places:
6464 .display
6465 &url(http://www.pobox.com/~djb/cdb.html)
6466 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6467 &url(http://packages.debian.org/stable/utils/freecdb.html)
6468 .endd
6469 A cdb distribution is not needed in order to build Exim with cdb support,
6470 because the code for reading cdb files is included directly in Exim itself.
6471 However, no means of building or testing cdb files is provided with Exim, so
6472 you need to obtain a cdb distribution in order to do this.
6473 .next
6474 .cindex "DBM" "lookup type"
6475 .cindex "lookup" "dbm"
6476 .cindex "binary zero" "in lookup key"
6477 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6478 DBM file by looking up the record with the given key. A terminating binary
6479 zero is included in the key that is passed to the DBM library. See section
6480 &<<SECTdb>>& for a discussion of DBM libraries.
6481
6482 .cindex "Berkeley DB library" "file format"
6483 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6484 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6485 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6486 the DB_UNKNOWN option. This enables it to handle any of the types of database
6487 that the library supports, and can be useful for accessing DBM files created by
6488 other applications. (For earlier DB versions, DB_HASH is always used.)
6489 .next
6490 .cindex "lookup" "dbmjz"
6491 .cindex "lookup" "dbm &-- embedded NULs"
6492 .cindex "sasldb2"
6493 .cindex "dbmjz lookup type"
6494 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6495 interpreted as an Exim list; the elements of the list are joined together with
6496 ASCII NUL characters to form the lookup key.  An example usage would be to
6497 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6498 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6499 &(cram_md5)& authenticator.
6500 .next
6501 .cindex "lookup" "dbmnz"
6502 .cindex "lookup" "dbm &-- terminating zero"
6503 .cindex "binary zero" "in lookup key"
6504 .cindex "Courier"
6505 .cindex "&_/etc/userdbshadow.dat_&"
6506 .cindex "dbmnz lookup type"
6507 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6508 is not included in the key that is passed to the DBM library. You may need this
6509 if you want to look up data in files that are created by or shared with some
6510 other application that does not use terminating zeros. For example, you need to
6511 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6512 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6513 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6514 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6515 .next
6516 .cindex "lookup" "dsearch"
6517 .cindex "dsearch lookup type"
6518 &(dsearch)&: The given file must be a directory; this is searched for an entry
6519 whose name is the key by calling the &[lstat()]& function. The key may not
6520 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6521 the lookup is the name of the entry, which may be a file, directory,
6522 symbolic link, or any other kind of directory entry. An example of how this
6523 lookup can be used to support virtual domains is given in section
6524 &<<SECTvirtualdomains>>&.
6525 .next
6526 .cindex "lookup" "iplsearch"
6527 .cindex "iplsearch lookup type"
6528 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6529 terminated by a colon or white space or the end of the line. The keys in the
6530 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6531 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6532 being interpreted as a key terminator. For example:
6533 .code
6534 1.2.3.4:           data for 1.2.3.4
6535 192.168.0.0/16:    data for 192.168.0.0/16
6536 "abcd::cdab":      data for abcd::cdab
6537 "abcd:abcd::/32"   data for abcd:abcd::/32
6538 .endd
6539 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6540 file is searched linearly, using the CIDR masks where present, until a matching
6541 key is found. The first key that matches is used; there is no attempt to find a
6542 &"best"& match. Apart from the way the keys are matched, the processing for
6543 &(iplsearch)& is the same as for &(lsearch)&.
6544
6545 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6546 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6547 lookup types support only literal keys.
6548
6549 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6550 the implicit key is the host's IP address rather than its name (see section
6551 &<<SECThoslispatsikey>>&).
6552 .next
6553 .cindex "linear search"
6554 .cindex "lookup" "lsearch"
6555 .cindex "lsearch lookup type"
6556 .cindex "case sensitivity" "in lsearch lookup"
6557 &(lsearch)&: The given file is a text file that is searched linearly for a
6558 line beginning with the search key, terminated by a colon or white space or the
6559 end of the line. The search is case-insensitive; that is, upper and lower case
6560 letters are treated as the same. The first occurrence of the key that is found
6561 in the file is used.
6562
6563 White space between the key and the colon is permitted. The remainder of the
6564 line, with leading and trailing white space removed, is the data. This can be
6565 continued onto subsequent lines by starting them with any amount of white
6566 space, but only a single space character is included in the data at such a
6567 junction. If the data begins with a colon, the key must be terminated by a
6568 colon, for example:
6569 .code
6570 baduser:  :fail:
6571 .endd
6572 Empty lines and lines beginning with # are ignored, even if they occur in the
6573 middle of an item. This is the traditional textual format of alias files. Note
6574 that the keys in an &(lsearch)& file are literal strings. There is no
6575 wildcarding of any kind.
6576
6577 .cindex "lookup" "lsearch &-- colons in keys"
6578 .cindex "white space" "in lsearch key"
6579 In most &(lsearch)& files, keys are not required to contain colons or #
6580 characters, or white space. However, if you need this feature, it is available.
6581 If a key begins with a doublequote character, it is terminated only by a
6582 matching quote (or end of line), and the normal escaping rules apply to its
6583 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6584 quoted keys (exactly as for unquoted keys). There is no special handling of
6585 quotes for the data part of an &(lsearch)& line.
6586
6587 .next
6588 .cindex "NIS lookup type"
6589 .cindex "lookup" "NIS"
6590 .cindex "binary zero" "in lookup key"
6591 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6592 the given key, without a terminating binary zero. There is a variant called
6593 &(nis0)& which does include the terminating binary zero in the key. This is
6594 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6595 aliases; the full map names must be used.
6596
6597 .next
6598 .cindex "wildlsearch lookup type"
6599 .cindex "lookup" "wildlsearch"
6600 .cindex "nwildlsearch lookup type"
6601 .cindex "lookup" "nwildlsearch"
6602 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6603 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6604 the file may be wildcarded. The difference between these two lookup types is
6605 that for &(wildlsearch)&, each key in the file is string-expanded before being
6606 used, whereas for &(nwildlsearch)&, no expansion takes place.
6607
6608 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6609 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6610 file that are regular expressions can be made case-sensitive by the use of
6611 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6612
6613 . ==== As this is a nested list, any displays it contains must be indented
6614 . ==== as otherwise they are too far to the left.
6615
6616 .olist
6617 The string may begin with an asterisk to mean &"ends with"&. For example:
6618 .code
6619     *.a.b.c       data for anything.a.b.c
6620     *fish         data for anythingfish
6621 .endd
6622 .next
6623 The string may begin with a circumflex to indicate a regular expression. For
6624 example, for &(wildlsearch)&:
6625 .code
6626     ^\N\d+\.a\.b\N    data for <digits>.a.b
6627 .endd
6628 Note the use of &`\N`& to disable expansion of the contents of the regular
6629 expression. If you are using &(nwildlsearch)&, where the keys are not
6630 string-expanded, the equivalent entry is:
6631 .code
6632     ^\d+\.a\.b        data for <digits>.a.b
6633 .endd
6634 The case-insensitive flag is set at the start of compiling the regular
6635 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6636 For example, to make the entire pattern case-sensitive:
6637 .code
6638     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6639 .endd
6640
6641 If the regular expression contains white space or colon characters, you must
6642 either quote it (see &(lsearch)& above), or represent these characters in other
6643 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6644 colon. This may be easier than quoting, because if you quote, you have to
6645 escape all the backslashes inside the quotes.
6646
6647 &*Note*&: It is not possible to capture substrings in a regular expression
6648 match for later use, because the results of all lookups are cached. If a lookup
6649 is repeated, the result is taken from the cache, and no actual pattern matching
6650 takes place. The values of all the numeric variables are unset after a
6651 &((n)wildlsearch)& match.
6652
6653 .next
6654 Although I cannot see it being of much use, the general matching function that
6655 is used to implement &((n)wildlsearch)& means that the string may begin with a
6656 lookup name terminated by a semicolon, and followed by lookup data. For
6657 example:
6658 .code
6659     cdb;/some/file  data for keys that match the file
6660 .endd
6661 The data that is obtained from the nested lookup is discarded.
6662 .endlist olist
6663
6664 Keys that do not match any of these patterns are interpreted literally. The
6665 continuation rules for the data are the same as for &(lsearch)&, and keys may
6666 be followed by optional colons.
6667
6668 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6669 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6670 lookup types support only literal keys.
6671 .endlist ilist
6672
6673
6674 .section "Query-style lookup types" "SECTquerystylelookups"
6675 .cindex "lookup" "query-style types"
6676 .cindex "query-style lookup" "list of types"
6677 The supported query-style lookup types are listed below. Further details about
6678 many of them are given in later sections.
6679
6680 .ilist
6681 .cindex "DNS" "as a lookup type"
6682 .cindex "lookup" "DNS"
6683 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6684 are given in the supplied query. The resulting data is the contents of the
6685 records. See section &<<SECTdnsdb>>&.
6686 .next
6687 .cindex "InterBase lookup type"
6688 .cindex "lookup" "InterBase"
6689 &(ibase)&: This does a lookup in an InterBase database.
6690 .next
6691 .cindex "LDAP" "lookup type"
6692 .cindex "lookup" "LDAP"
6693 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6694 returns attributes from a single entry. There is a variant called &(ldapm)&
6695 that permits values from multiple entries to be returned. A third variant
6696 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6697 any attribute values. See section &<<SECTldap>>&.
6698 .next
6699 .cindex "MySQL" "lookup type"
6700 .cindex "lookup" "MySQL"
6701 &(mysql)&: The format of the query is an SQL statement that is passed to a
6702 MySQL database. See section &<<SECTsql>>&.
6703 .next
6704 .cindex "NIS+ lookup type"
6705 .cindex "lookup" "NIS+"
6706 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6707 the field to be returned. See section &<<SECTnisplus>>&.
6708 .next
6709 .cindex "Oracle" "lookup type"
6710 .cindex "lookup" "Oracle"
6711 &(oracle)&: The format of the query is an SQL statement that is passed to an
6712 Oracle database. See section &<<SECTsql>>&.
6713 .next
6714 .cindex "lookup" "passwd"
6715 .cindex "passwd lookup type"
6716 .cindex "&_/etc/passwd_&"
6717 &(passwd)& is a query-style lookup with queries that are just user names. The
6718 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6719 success, the result string is the same as you would get from an &(lsearch)&
6720 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6721 password value. For example:
6722 .code
6723 *:42:42:King Rat:/home/kr:/bin/bash
6724 .endd
6725 .next
6726 .cindex "PostgreSQL lookup type"
6727 .cindex "lookup" "PostgreSQL"
6728 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6729 PostgreSQL database. See section &<<SECTsql>>&.
6730
6731 .next
6732 .cindex "Redis lookup type"
6733 .cindex lookup Redis
6734 &(redis)&: The format of the query is an SQL statement that is passed to a
6735 Redis database. See section &<<SECTsql>>&.
6736
6737 .next
6738 .cindex "sqlite lookup type"
6739 .cindex "lookup" "sqlite"
6740 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6741 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6742
6743 .next
6744 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6745 not likely to be useful in normal operation.
6746 .next
6747 .cindex "whoson lookup type"
6748 .cindex "lookup" "whoson"
6749 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6750 allows a server to check whether a particular (dynamically allocated) IP
6751 address is currently allocated to a known (trusted) user and, optionally, to
6752 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6753 at one time for &"POP before SMTP"& authentication, but that approach has been
6754 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6755 &"POP before SMTP"& checking using ACL statements such as
6756 .code
6757 require condition = \
6758   ${lookup whoson {$sender_host_address}{yes}{no}}
6759 .endd
6760 The query consists of a single IP address. The value returned is the name of
6761 the authenticated user, which is stored in the variable &$value$&. However, in
6762 this example, the data in &$value$& is not used; the result of the lookup is
6763 one of the fixed strings &"yes"& or &"no"&.
6764 .endlist
6765
6766
6767
6768 .section "Temporary errors in lookups" "SECID63"
6769 .cindex "lookup" "temporary error in"
6770 Lookup functions can return temporary error codes if the lookup cannot be
6771 completed. For example, an SQL or LDAP database might be unavailable. For this
6772 reason, it is not advisable to use a lookup that might do this for critical
6773 options such as a list of local domains.
6774
6775 When a lookup cannot be completed in a router or transport, delivery
6776 of the message (to the relevant address) is deferred, as for any other
6777 temporary error. In other circumstances Exim may assume the lookup has failed,
6778 or may give up altogether.
6779
6780
6781
6782 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6783 .cindex "wildcard lookups"
6784 .cindex "lookup" "default values"
6785 .cindex "lookup" "wildcard"
6786 .cindex "lookup" "* added to type"
6787 .cindex "default" "in single-key lookups"
6788 In this context, a &"default value"& is a value specified by the administrator
6789 that is to be used if a lookup fails.
6790
6791 &*Note:*& This section applies only to single-key lookups. For query-style
6792 lookups, the facilities of the query language must be used. An attempt to
6793 specify a default for a query-style lookup provokes an error.
6794
6795 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6796 and the initial lookup fails, the key &"*"& is looked up in the file to
6797 provide a default value. See also the section on partial matching below.
6798
6799 .cindex "*@ with single-key lookup"
6800 .cindex "lookup" "*@ added to type"
6801 .cindex "alias file" "per-domain default"
6802 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6803 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6804 character, a second lookup is done with everything before the last @ replaced
6805 by *. This makes it possible to provide per-domain defaults in alias files
6806 that include the domains in the keys. If the second lookup fails (or doesn't
6807 take place because there is no @ in the key), &"*"& is looked up.
6808 For example, a &(redirect)& router might contain:
6809 .code
6810 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6811 .endd
6812 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6813 looks up these keys, in this order:
6814 .code
6815 jane@eyre.example
6816 *@eyre.example
6817 *
6818 .endd
6819 The data is taken from whichever key it finds first. &*Note*&: In an
6820 &(lsearch)& file, this does not mean the first of these keys in the file. A
6821 complete scan is done for each key, and only if it is not found at all does
6822 Exim move on to try the next key.
6823
6824
6825
6826 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6827 .cindex "partial matching"
6828 .cindex "wildcard lookups"
6829 .cindex "lookup" "partial matching"
6830 .cindex "lookup" "wildcard"
6831 .cindex "asterisk" "in search type"
6832 The normal operation of a single-key lookup is to search the file for an exact
6833 match with the given key. However, in a number of situations where domains are
6834 being looked up, it is useful to be able to do partial matching. In this case,
6835 information in the file that has a key starting with &"*."& is matched by any
6836 domain that ends with the components that follow the full stop. For example, if
6837 a key in a DBM file is
6838 .code
6839 *.dates.fict.example
6840 .endd
6841 then when partial matching is enabled this is matched by (amongst others)
6842 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6843 by &'dates.fict.example'&, if that does not appear as a separate key in the
6844 file.
6845
6846 &*Note*&: Partial matching is not available for query-style lookups. It is
6847 also not available for any lookup items in address lists (see section
6848 &<<SECTaddresslist>>&).
6849
6850 Partial matching is implemented by doing a series of separate lookups using
6851 keys constructed by modifying the original subject key. This means that it can
6852 be used with any of the single-key lookup types, provided that
6853 partial matching keys
6854 beginning with a special prefix (default &"*."&) are included in the data file.
6855 Keys in the file that do not begin with the prefix are matched only by
6856 unmodified subject keys when partial matching is in use.
6857
6858 Partial matching is requested by adding the string &"partial-"& to the front of
6859 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6860 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6861 is added at the start of the subject key, and it is looked up again. If that
6862 fails, further lookups are tried with dot-separated components removed from the
6863 start of the subject key, one-by-one, and &"*."& added on the front of what
6864 remains.
6865
6866 A minimum number of two non-* components are required. This can be adjusted
6867 by including a number before the hyphen in the search type. For example,
6868 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6869 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6870 subject key is &'2250.dates.fict.example'& then the following keys are looked
6871 up when the minimum number of non-* components is two:
6872 .code
6873 2250.dates.fict.example
6874 *.2250.dates.fict.example
6875 *.dates.fict.example
6876 *.fict.example
6877 .endd
6878 As soon as one key in the sequence is successfully looked up, the lookup
6879 finishes.
6880
6881 .cindex "lookup" "partial matching &-- changing prefix"
6882 .cindex "prefix" "for partial matching"
6883 The use of &"*."& as the partial matching prefix is a default that can be
6884 changed. The motivation for this feature is to allow Exim to operate with file
6885 formats that are used by other MTAs. A different prefix can be supplied in
6886 parentheses instead of the hyphen after &"partial"&. For example:
6887 .code
6888 domains = partial(.)lsearch;/some/file
6889 .endd
6890 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6891 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6892 components is unchanged). The prefix may consist of any punctuation characters
6893 other than a closing parenthesis. It may be empty, for example:
6894 .code
6895 domains = partial1()cdb;/some/file
6896 .endd
6897 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6898 &`a.b.c`&, &`b.c`&, and &`c`&.
6899
6900 If &"partial0"& is specified, what happens at the end (when the lookup with
6901 just one non-wild component has failed, and the original key is shortened right
6902 down to the null string) depends on the prefix:
6903
6904 .ilist
6905 If the prefix has zero length, the whole lookup fails.
6906 .next
6907 If the prefix has length 1, a lookup for just the prefix is done. For
6908 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6909 .next
6910 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6911 remainder is looked up. With the default prefix, therefore, the final lookup is
6912 for &"*"& on its own.
6913 .next
6914 Otherwise, the whole prefix is looked up.
6915 .endlist
6916
6917
6918 If the search type ends in &"*"& or &"*@"& (see section
6919 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6920 this implies happens after all partial lookups have failed. If &"partial0"& is
6921 specified, adding &"*"& to the search type has no effect with the default
6922 prefix, because the &"*"& key is already included in the sequence of partial
6923 lookups. However, there might be a use for lookup types such as
6924 &"partial0(.)lsearch*"&.
6925
6926 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6927 in domain lists and the like. Partial matching works only in terms of
6928 dot-separated components; a key such as &`*fict.example`&
6929 in a database file is useless, because the asterisk in a partial matching
6930 subject key is always followed by a dot.
6931
6932
6933
6934
6935 .section "Lookup caching" "SECID64"
6936 .cindex "lookup" "caching"
6937 .cindex "caching" "lookup data"
6938 Exim caches all lookup results in order to avoid needless repetition of
6939 lookups. However, because (apart from the daemon) Exim operates as a collection
6940 of independent, short-lived processes, this caching applies only within a
6941 single Exim process. There is no inter-process lookup caching facility.
6942
6943 For single-key lookups, Exim keeps the relevant files open in case there is
6944 another lookup that needs them. In some types of configuration this can lead to
6945 many files being kept open for messages with many recipients. To avoid hitting
6946 the operating system limit on the number of simultaneously open files, Exim
6947 closes the least recently used file when it needs to open more files than its
6948 own internal limit, which can be changed via the &%lookup_open_max%& option.
6949
6950 The single-key lookup files are closed and the lookup caches are flushed at
6951 strategic points during delivery &-- for example, after all routing is
6952 complete.
6953
6954
6955
6956
6957 .section "Quoting lookup data" "SECID65"
6958 .cindex "lookup" "quoting"
6959 .cindex "quoting" "in lookups"
6960 When data from an incoming message is included in a query-style lookup, there
6961 is the possibility of special characters in the data messing up the syntax of
6962 the query. For example, a NIS+ query that contains
6963 .code
6964 [name=$local_part]
6965 .endd
6966 will be broken if the local part happens to contain a closing square bracket.
6967 For NIS+, data can be enclosed in double quotes like this:
6968 .code
6969 [name="$local_part"]
6970 .endd
6971 but this still leaves the problem of a double quote in the data. The rule for
6972 NIS+ is that double quotes must be doubled. Other lookup types have different
6973 rules, and to cope with the differing requirements, an expansion operator
6974 of the following form is provided:
6975 .code
6976 ${quote_<lookup-type>:<string>}
6977 .endd
6978 For example, the safest way to write the NIS+ query is
6979 .code
6980 [name="${quote_nisplus:$local_part}"]
6981 .endd
6982 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6983 operator can be used for all lookup types, but has no effect for single-key
6984 lookups, since no quoting is ever needed in their key strings.
6985
6986
6987
6988
6989 .section "More about dnsdb" "SECTdnsdb"
6990 .cindex "dnsdb lookup"
6991 .cindex "lookup" "dnsdb"
6992 .cindex "DNS" "as a lookup type"
6993 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6994 of a record type and a domain name, separated by an equals sign. For example,
6995 an expansion string could contain:
6996 .code
6997 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6998 .endd
6999 If the lookup succeeds, the result is placed in &$value$&, which in this case
7000 is used on its own as the result. If the lookup does not succeed, the
7001 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7002 &<<SECTforexpfai>>& for an explanation of what this means.
7003
7004 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7005 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7006 If no type is given, TXT is assumed.
7007
7008 For any record type, if multiple records are found, the data is returned as a
7009 concatenation, with newline as the default separator. The order, of course,
7010 depends on the DNS resolver. You can specify a different separator character
7011 between multiple records by putting a right angle-bracket followed immediately
7012 by the new separator at the start of the query. For example:
7013 .code
7014 ${lookup dnsdb{>: a=host1.example}}
7015 .endd
7016 It is permitted to specify a space as the separator character. Further
7017 white space is ignored.
7018 For lookup types that return multiple fields per record,
7019 an alternate field separator can be specified using a comma after the main
7020 separator character, followed immediately by the field separator.
7021
7022 .cindex "PTR record" "in &(dnsdb)& lookup"
7023 When the type is PTR,
7024 the data can be an IP address, written as normal; inversion and the addition of
7025 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7026 .code
7027 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7028 .endd
7029 If the data for a PTR record is not a syntactically valid IP address, it is not
7030 altered and nothing is added.
7031
7032 .cindex "MX record" "in &(dnsdb)& lookup"
7033 .cindex "SRV record" "in &(dnsdb)& lookup"
7034 For an MX lookup, both the preference value and the host name are returned for
7035 each record, separated by a space. For an SRV lookup, the priority, weight,
7036 port, and host name are returned for each record, separated by spaces.
7037 The field separator can be modified as above.
7038
7039 .cindex "TXT record" "in &(dnsdb)& lookup"
7040 .cindex "SPF record" "in &(dnsdb)& lookup"
7041 For TXT records with multiple items of data, only the first item is returned,
7042 unless a field separator is specified.
7043 To concatenate items without a separator, use a semicolon instead.
7044 For SPF records the
7045 default behaviour is to concatenate multiple items without using a separator.
7046 .code
7047 ${lookup dnsdb{>\n,: txt=a.b.example}}
7048 ${lookup dnsdb{>\n; txt=a.b.example}}
7049 ${lookup dnsdb{spf=example.org}}
7050 .endd
7051 It is permitted to specify a space as the separator character. Further
7052 white space is ignored.
7053
7054 .cindex "SOA record" "in &(dnsdb)& lookup"
7055 For an SOA lookup, while no result is obtained the lookup is redone with
7056 successively more leading components dropped from the given domain.
7057 Only the primary-nameserver field is returned unless a field separator is
7058 specified.
7059 .code
7060 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7061 .endd
7062
7063 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7064 .cindex "dnsdb modifiers"
7065 .cindex "modifiers" "dnsdb"
7066 .cindex "options" "dnsdb"
7067 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7068 each followed by a comma,
7069 that may appear before the record type.
7070
7071 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7072 temporary DNS error for any of them, the behaviour is controlled by
7073 a defer-option modifier.
7074 The possible keywords are
7075 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7076 With &"strict"& behaviour, any temporary DNS error causes the
7077 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7078 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7079 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7080 error causes the whole lookup to defer only if none of the other lookups
7081 succeed. The default is &"lax"&, so the following lookups are equivalent:
7082 .code
7083 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7084 ${lookup dnsdb{a=one.host.com:two.host.com}}
7085 .endd
7086 Thus, in the default case, as long as at least one of the DNS lookups
7087 yields some data, the lookup succeeds.
7088
7089 .cindex "DNSSEC" "dns lookup"
7090 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7091 The possible keywords are
7092 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7093 With &"strict"& or &"lax"& DNSSEC information is requested
7094 with the lookup.
7095 With &"strict"& a response from the DNS resolver that
7096 is not labelled as authenticated data
7097 is treated as equivalent to a temporary DNS error.
7098 The default is &"never"&.
7099
7100 See also the &$lookup_dnssec_authenticated$& variable.
7101
7102 .cindex timeout "dns lookup"
7103 .cindex "DNS" timeout
7104 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7105 The form is &"retrans_VAL"& where VAL is an Exim time specification
7106 (e.g. &"5s"&).
7107 The default value is set by the main configuration option &%dns_retrans%&.
7108
7109 Retries for the dnsdb lookup can be controlled by a retry modifier.
7110 The form if &"retry_VAL"& where VAL is an integer.
7111 The default count is set by the main configuration option &%dns_retry%&.
7112
7113 .cindex caching "of dns lookup"
7114 .cindex TTL "of dns lookup"
7115 .cindex DNS TTL
7116 Dnsdb lookup results are cached within a single process (and its children).
7117 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7118 value of the set of returned DNS records.
7119
7120
7121 .section "Pseudo dnsdb record types" "SECID66"
7122 .cindex "MX record" "in &(dnsdb)& lookup"
7123 By default, both the preference value and the host name are returned for
7124 each MX record, separated by a space. If you want only host names, you can use
7125 the pseudo-type MXH:
7126 .code
7127 ${lookup dnsdb{mxh=a.b.example}}
7128 .endd
7129 In this case, the preference values are omitted, and just the host names are
7130 returned.
7131
7132 .cindex "name server for enclosing domain"
7133 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7134 records on the given domain, but if none are found, it removes the first
7135 component of the domain name, and tries again. This process continues until NS
7136 records are found or there are no more components left (or there is a DNS
7137 error). In other words, it may return the name servers for a top-level domain,
7138 but it never returns the root name servers. If there are no NS records for the
7139 top-level domain, the lookup fails. Consider these examples:
7140 .code
7141 ${lookup dnsdb{zns=xxx.quercite.com}}
7142 ${lookup dnsdb{zns=xxx.edu}}
7143 .endd
7144 Assuming that in each case there are no NS records for the full domain name,
7145 the first returns the name servers for &%quercite.com%&, and the second returns
7146 the name servers for &%edu%&.
7147
7148 You should be careful about how you use this lookup because, unless the
7149 top-level domain does not exist, the lookup always returns some host names. The
7150 sort of use to which this might be put is for seeing if the name servers for a
7151 given domain are on a blacklist. You can probably assume that the name servers
7152 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7153 such a list.
7154
7155 .cindex "CSA" "in &(dnsdb)& lookup"
7156 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7157 records according to the CSA rules, which are described in section
7158 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7159 not sufficient because of the extra parent domain search behaviour of CSA. The
7160 result of a successful lookup such as:
7161 .code
7162 ${lookup dnsdb {csa=$sender_helo_name}}
7163 .endd
7164 has two space-separated fields: an authorization code and a target host name.
7165 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7166 authorization required but absent, or &"?"& for unknown.
7167
7168 .cindex "A+" "in &(dnsdb)& lookup"
7169 The pseudo-type A+ performs an AAAA
7170 and then an A lookup.  All results are returned; defer processing
7171 (see below) is handled separately for each lookup.  Example:
7172 .code
7173 ${lookup dnsdb {>; a+=$sender_helo_name}}
7174 .endd
7175
7176
7177 .section "Multiple dnsdb lookups" "SECID67"
7178 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7179 However, you can specify a list of domains or IP addresses in a single
7180 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7181 the default separator, but with the ability to change this. For example:
7182 .code
7183 ${lookup dnsdb{one.domain.com:two.domain.com}}
7184 ${lookup dnsdb{a=one.host.com:two.host.com}}
7185 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7186 .endd
7187 In order to retain backwards compatibility, there is one special case: if
7188 the lookup type is PTR and no change of separator is specified, Exim looks
7189 to see if the rest of the string is precisely one IPv6 address. In this
7190 case, it does not treat it as a list.
7191
7192 The data from each lookup is concatenated, with newline separators by default,
7193 in the same way that multiple DNS records for a single item are handled. A
7194 different separator can be specified, as described above.
7195
7196
7197
7198
7199 .section "More about LDAP" "SECTldap"
7200 .cindex "LDAP" "lookup, more about"
7201 .cindex "lookup" "LDAP"
7202 .cindex "Solaris" "LDAP"
7203 The original LDAP implementation came from the University of Michigan; this has
7204 become &"Open LDAP"&, and there are now two different releases. Another
7205 implementation comes from Netscape, and Solaris 7 and subsequent releases
7206 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7207 the lookup function level, their error handling is different. For this reason
7208 it is necessary to set a compile-time variable when building Exim with LDAP, to
7209 indicate which LDAP library is in use. One of the following should appear in
7210 your &_Local/Makefile_&:
7211 .code
7212 LDAP_LIB_TYPE=UMICHIGAN
7213 LDAP_LIB_TYPE=OPENLDAP1
7214 LDAP_LIB_TYPE=OPENLDAP2
7215 LDAP_LIB_TYPE=NETSCAPE
7216 LDAP_LIB_TYPE=SOLARIS
7217 .endd
7218 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7219 same interface as the University of Michigan version.
7220
7221 There are three LDAP lookup types in Exim. These behave slightly differently in
7222 the way they handle the results of a query:
7223
7224 .ilist
7225 &(ldap)& requires the result to contain just one entry; if there are more, it
7226 gives an error.
7227 .next
7228 &(ldapdn)& also requires the result to contain just one entry, but it is the
7229 Distinguished Name that is returned rather than any attribute values.
7230 .next
7231 &(ldapm)& permits the result to contain more than one entry; the attributes
7232 from all of them are returned.
7233 .endlist
7234
7235
7236 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7237 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7238 the data returned by a successful lookup is described in the next section.
7239 First we explain how LDAP queries are coded.
7240
7241
7242 .section "Format of LDAP queries" "SECTforldaque"
7243 .cindex "LDAP" "query format"
7244 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7245 the configuration of a &(redirect)& router one might have this setting:
7246 .code
7247 data = ${lookup ldap \
7248   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7249   c=UK?mailbox?base?}}
7250 .endd
7251 .cindex "LDAP" "with TLS"
7252 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7253 secure (encrypted) LDAP connections. The second of these ensures that an
7254 encrypted TLS connection is used.
7255
7256 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7257 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7258 See the &%ldap_start_tls%& option.
7259
7260 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7261 controlled. Every part of the TLS configuration can be configured by settings in
7262 &_exim.conf_&. Depending on the version of the client libraries installed on
7263 your system, some of the initialization may have required setting options in
7264 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7265 certificates. This revealed a nuance where the current UID that exim was
7266 running as could affect which config files it read. With Exim 4.83, these
7267 methods become optional, only taking effect if not specifically set in
7268 &_exim.conf_&.
7269
7270
7271 .section "LDAP quoting" "SECID68"
7272 .cindex "LDAP" "quoting"
7273 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7274 and the second because the LDAP query is represented as a URL. Furthermore,
7275 within an LDAP query, two different kinds of quoting are required. For this
7276 reason, there are two different LDAP-specific quoting operators.
7277
7278 The &%quote_ldap%& operator is designed for use on strings that are part of
7279 filter specifications. Conceptually, it first does the following conversions on
7280 the string:
7281 .code
7282 *   =>   \2A
7283 (   =>   \28
7284 )   =>   \29
7285 \   =>   \5C
7286 .endd
7287 in accordance with RFC 2254. The resulting string is then quoted according
7288 to the rules for URLs, that is, all non-alphanumeric characters except
7289 .code
7290 ! $ ' - . _ ( ) * +
7291 .endd
7292 are converted to their hex values, preceded by a percent sign. For example:
7293 .code
7294 ${quote_ldap: a(bc)*, a<yz>; }
7295 .endd
7296 yields
7297 .code
7298 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7299 .endd
7300 Removing the URL quoting, this is (with a leading and a trailing space):
7301 .code
7302 a\28bc\29\2A, a<yz>;
7303 .endd
7304 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7305 base DN specifications in queries. Conceptually, it first converts the string
7306 by inserting a backslash in front of any of the following characters:
7307 .code
7308 , + " \ < > ;
7309 .endd
7310 It also inserts a backslash before any leading spaces or # characters, and
7311 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7312 is then quoted according to the rules for URLs. For example:
7313 .code
7314 ${quote_ldap_dn: a(bc)*, a<yz>; }
7315 .endd
7316 yields
7317 .code
7318 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7319 .endd
7320 Removing the URL quoting, this is (with a trailing space):
7321 .code
7322 \ a(bc)*\, a\<yz\>\;\
7323 .endd
7324 There are some further comments about quoting in the section on LDAP
7325 authentication below.
7326
7327
7328 .section "LDAP connections" "SECID69"
7329 .cindex "LDAP" "connections"
7330 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7331 is in use, via a Unix domain socket. The example given above does not specify
7332 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7333 by starting it with
7334 .code
7335 ldap://<hostname>:<port>/...
7336 .endd
7337 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7338 used. When no server is specified in a query, a list of default servers is
7339 taken from the &%ldap_default_servers%& configuration option. This supplies a
7340 colon-separated list of servers which are tried in turn until one successfully
7341 handles a query, or there is a serious error. Successful handling either
7342 returns the requested data, or indicates that it does not exist. Serious errors
7343 are syntactical, or multiple values when only a single value is expected.
7344 Errors which cause the next server to be tried are connection failures, bind
7345 failures, and timeouts.
7346
7347 For each server name in the list, a port number can be given. The standard way
7348 of specifying a host and port is to use a colon separator (RFC 1738). Because
7349 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7350 doubled. For example
7351 .code
7352 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7353 .endd
7354 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7355 to the LDAP library with no server name, and the library's default (normally
7356 the local host) is used.
7357
7358 If you are using the OpenLDAP library, you can connect to an LDAP server using
7359 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7360 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7361 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7362 not available.
7363
7364 For this type of connection, instead of a host name for the server, a pathname
7365 for the socket is required, and the port number is not relevant. The pathname
7366 can be specified either as an item in &%ldap_default_servers%&, or inline in
7367 the query. In the former case, you can have settings such as
7368 .code
7369 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7370 .endd
7371 When the pathname is given in the query, you have to escape the slashes as
7372 &`%2F`& to fit in with the LDAP URL syntax. For example:
7373 .code
7374 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7375 .endd
7376 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7377 a pathname, it uses the Unix domain socket code, even if the query actually
7378 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7379 socket connection. This behaviour means that you can use a setting of
7380 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7381 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7382 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7383 backup host.
7384
7385 If an explicit &`ldapi`& type is given in a query when a host name is
7386 specified, an error is diagnosed. However, if there are more items in
7387 &%ldap_default_servers%&, they are tried. In other words:
7388
7389 .ilist
7390 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7391 interface.
7392 .next
7393 Using &`ldapi`& with a host name causes an error.
7394 .endlist
7395
7396
7397 Using &`ldapi`& with no host or path in the query, and no setting of
7398 &%ldap_default_servers%&, does whatever the library does by default.
7399
7400
7401
7402 .section "LDAP authentication and control information" "SECID70"
7403 .cindex "LDAP" "authentication"
7404 The LDAP URL syntax provides no way of passing authentication and other control
7405 information to the server. To make this possible, the URL in an LDAP query may
7406 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7407 spaces. If a value contains spaces it must be enclosed in double quotes, and
7408 when double quotes are used, backslash is interpreted in the usual way inside
7409 them. The following names are recognized:
7410 .display
7411 &`DEREFERENCE`&  set the dereferencing parameter
7412 &`NETTIME    `&  set a timeout for a network operation
7413 &`USER       `&  set the DN, for authenticating the LDAP bind
7414 &`PASS       `&  set the password, likewise
7415 &`REFERRALS  `&  set the referrals parameter
7416 &`SERVERS    `&  set alternate server list for this query only
7417 &`SIZE       `&  set the limit for the number of entries returned
7418 &`TIME       `&  set the maximum waiting time for a query
7419 .endd
7420 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7421 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7422 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7423 library from trying to follow referrals issued by the LDAP server.
7424
7425 .cindex LDAP timeout
7426 .cindex timeout "LDAP lookup"
7427 The name CONNECT is an obsolete name for NETTIME, retained for
7428 backwards compatibility. This timeout (specified as a number of seconds) is
7429 enforced from the client end for operations that can be carried out over a
7430 network. Specifically, it applies to network connections and calls to the
7431 &'ldap_result()'& function. If the value is greater than zero, it is used if
7432 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7433 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7434 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7435 Netscape SDK; for OpenLDAP no action is taken.
7436
7437 The TIME parameter (also a number of seconds) is passed to the server to
7438 set a server-side limit on the time taken to complete a search.
7439
7440 The SERVERS parameter allows you to specify an alternate list of ldap servers
7441 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7442 default list of ldap servers, and a single lookup can specify a single ldap
7443 server to use.  But when you need to do a lookup with a list of servers that is
7444 different than the default list (maybe different order, maybe a completely
7445 different set of servers), the SERVERS parameter allows you to specify this
7446 alternate list (colon-separated).
7447
7448 Here is an example of an LDAP query in an Exim lookup that uses some of these
7449 values. This is a single line, folded to fit on the page:
7450 .code
7451 ${lookup ldap
7452   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7453   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7454   {$value}fail}
7455 .endd
7456 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7457 any of the auxiliary data. Exim configuration settings that include lookups
7458 which contain password information should be preceded by &"hide"& to prevent
7459 non-admin users from using the &%-bP%& option to see their values.
7460
7461 The auxiliary data items may be given in any order. The default is no
7462 connection timeout (the system timeout is used), no user or password, no limit
7463 on the number of entries returned, and no time limit on queries.
7464
7465 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7466 removes any URL quoting that it may contain before passing it LDAP. Apparently
7467 some libraries do this for themselves, but some do not. Removing the URL
7468 quoting has two advantages:
7469
7470 .ilist
7471 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7472 DNs as with DNs inside actual queries.
7473 .next
7474 It permits spaces inside USER= DNs.
7475 .endlist
7476
7477 For example, a setting such as
7478 .code
7479 USER=cn=${quote_ldap_dn:$1}
7480 .endd
7481 should work even if &$1$& contains spaces.
7482
7483 Expanded data for the PASS= value should be quoted using the &%quote%&
7484 expansion operator, rather than the LDAP quote operators. The only reason this
7485 field needs quoting is to ensure that it conforms to the Exim syntax, which
7486 does not allow unquoted spaces. For example:
7487 .code
7488 PASS=${quote:$3}
7489 .endd
7490 The LDAP authentication mechanism can be used to check passwords as part of
7491 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7492 &<<CHAPexpand>>&.
7493
7494
7495
7496 .section "Format of data returned by LDAP" "SECID71"
7497 .cindex "LDAP" "returned data formats"
7498 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7499 as a sequence of values, for example
7500 .code
7501 cn=manager,o=University of Cambridge,c=UK
7502 .endd
7503 The &(ldap)& lookup type generates an error if more than one entry matches the
7504 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7505 the result between the data from different entries. It is possible for multiple
7506 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7507 you know that whatever values are returned all came from a single entry in the
7508 directory.
7509
7510 In the common case where you specify a single attribute in your LDAP query, the
7511 result is not quoted, and does not contain the attribute name. If the attribute
7512 has multiple values, they are separated by commas. Any comma that is
7513 part of an attribute's value is doubled.
7514
7515 If you specify multiple attributes, the result contains space-separated, quoted
7516 strings, each preceded by the attribute name and an equals sign. Within the
7517 quotes, the quote character, backslash, and newline are escaped with
7518 backslashes, and commas are used to separate multiple values for the attribute.
7519 Any commas in attribute values are doubled
7520 (permitting treatment of the values as a comma-separated list).
7521 Apart from the escaping, the string within quotes takes the same form as the
7522 output when a single attribute is requested. Specifying no attributes is the
7523 same as specifying all of an entry's attributes.
7524
7525 Here are some examples of the output format. The first line of each pair is an
7526 LDAP query, and the second is the data that is returned. The attribute called
7527 &%attr1%& has two values, one of them with an embedded comma, whereas
7528 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7529 (they have SUP &%attr%& in their schema definitions).
7530
7531 .code
7532 ldap:///o=base?attr1?sub?(uid=fred)
7533 value1.1,value1,,2
7534
7535 ldap:///o=base?attr2?sub?(uid=fred)
7536 value two
7537
7538 ldap:///o=base?attr?sub?(uid=fred)
7539 value1.1,value1,,2,value two
7540
7541 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7542 attr1="value1.1,value1,,2" attr2="value two"
7543
7544 ldap:///o=base??sub?(uid=fred)
7545 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7546 .endd
7547 You can
7548 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7549 results of LDAP lookups.
7550 The &%extract%& operator in string expansions can be used to pick out
7551 individual fields from data that consists of &'key'&=&'value'& pairs.
7552 The &%listextract%& operator should be used to pick out individual values
7553 of attributes, even when only a single value is expected.
7554 The doubling of embedded commas allows you to use the returned data as a
7555 comma separated list (using the "<," syntax for changing the input list separator).
7556
7557
7558
7559
7560 .section "More about NIS+" "SECTnisplus"
7561 .cindex "NIS+ lookup type"
7562 .cindex "lookup" "NIS+"
7563 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7564 and field name. If this is given, the result of a successful query is the
7565 contents of the named field; otherwise the result consists of a concatenation
7566 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7567 values containing spaces are quoted. For example, the query
7568 .code
7569 [name=mg1456],passwd.org_dir
7570 .endd
7571 might return the string
7572 .code
7573 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7574 home=/home/mg1456 shell=/bin/bash shadow=""
7575 .endd
7576 (split over two lines here to fit on the page), whereas
7577 .code
7578 [name=mg1456],passwd.org_dir:gcos
7579 .endd
7580 would just return
7581 .code
7582 Martin Guerre
7583 .endd
7584 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7585 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7586 operator is to double any quote characters within the text.
7587
7588
7589
7590 .section "SQL lookups" "SECTsql"
7591 .cindex "SQL lookup types"
7592 .cindex "MySQL" "lookup type"
7593 .cindex "PostgreSQL lookup type"
7594 .cindex "lookup" "MySQL"
7595 .cindex "lookup" "PostgreSQL"
7596 .cindex "Oracle" "lookup type"
7597 .cindex "lookup" "Oracle"
7598 .cindex "InterBase lookup type"
7599 .cindex "lookup" "InterBase"
7600 .cindex "Redis lookup type"
7601 .cindex lookup Redis
7602 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7603 and SQLite
7604 databases. Queries for these databases contain SQL statements, so an example
7605 might be
7606 .code
7607 ${lookup mysql{select mailbox from users where id='userx'}\
7608   {$value}fail}
7609 .endd
7610 If the result of the query contains more than one field, the data for each
7611 field in the row is returned, preceded by its name, so the result of
7612 .code
7613 ${lookup pgsql{select home,name from users where id='userx'}\
7614   {$value}}
7615 .endd
7616 might be
7617 .code
7618 home=/home/userx name="Mister X"
7619 .endd
7620 Empty values and values containing spaces are double quoted, with embedded
7621 quotes escaped by a backslash. If the result of the query contains just one
7622 field, the value is passed back verbatim, without a field name, for example:
7623 .code
7624 Mister X
7625 .endd
7626 If the result of the query yields more than one row, it is all concatenated,
7627 with a newline between the data for each row.
7628
7629
7630 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7631 .cindex "MySQL" "lookup type"
7632 .cindex "PostgreSQL lookup type"
7633 .cindex "lookup" "MySQL"
7634 .cindex "lookup" "PostgreSQL"
7635 .cindex "Oracle" "lookup type"
7636 .cindex "lookup" "Oracle"
7637 .cindex "InterBase lookup type"
7638 .cindex "lookup" "InterBase"
7639 .cindex "Redis lookup type"
7640 .cindex lookup Redis
7641 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7642 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7643 or &%redis_servers%&
7644 option (as appropriate) must be set to a colon-separated list of server
7645 information.
7646 (For MySQL and PostgreSQL, the global option need not be set if all
7647 queries contain their own server information &-- see section
7648 &<<SECTspeserque>>&.)
7649 For all but Redis
7650 each item in the list is a slash-separated list of four
7651 items: host name, database name, user name, and password. In the case of
7652 Oracle, the host name field is used for the &"service name"&, and the database
7653 name field is not used and should be empty. For example:
7654 .code
7655 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7656 .endd
7657 Because password data is sensitive, you should always precede the setting with
7658 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7659 option. Here is an example where two MySQL servers are listed:
7660 .code
7661 hide mysql_servers = localhost/users/root/secret:\
7662                      otherhost/users/root/othersecret
7663 .endd
7664 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7665 because this is a colon-separated list, the colon has to be doubled. For each
7666 query, these parameter groups are tried in order until a connection is made and
7667 a query is successfully processed. The result of a query may be that no data is
7668 found, but that is still a successful query. In other words, the list of
7669 servers provides a backup facility, not a list of different places to look.
7670
7671 For Redis the global option need not be specified if all queries contain their
7672 own server information &-- see section &<<SECTspeserque>>&.
7673 If specified, the option must be set to a colon-separated list of server
7674 information.
7675 Each item in the list is a slash-separated list of three items:
7676 host, database number, and password.
7677 .olist
7678 The host is required and may be either an IPv4 address and optional
7679 port number (separated by a colon, which needs doubling due to the
7680 higher-level list), or a Unix socket pathname enclosed in parentheses
7681 .next
7682 The database number is optional; if present that number is selected in the backend
7683 .next
7684 The password is optional; if present it is used to authenticate to the backend
7685 .endlist
7686
7687 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7688 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7689 respectively, and the characters single-quote, double-quote, and backslash
7690 itself are escaped with backslashes.
7691
7692 The &%quote_redis%& expansion operator
7693 escapes whitespace and backslash characters with a backslash.
7694
7695 .section "Specifying the server in the query" "SECTspeserque"
7696 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7697 it is possible to specify a list of servers with an individual query. This is
7698 done by starting the query with
7699 .display
7700 &`servers=`&&'server1:server2:server3:...'&&`;`&
7701 .endd
7702 Each item in the list may take one of two forms:
7703 .olist
7704 If it contains no slashes it is assumed to be just a host name. The appropriate
7705 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7706 of the same name, and the remaining parameters (database, user, password) are
7707 taken from there.
7708 .next
7709 If it contains any slashes, it is taken as a complete parameter set.
7710 .endlist
7711 The list of servers is used in exactly the same way as the global list.
7712 Once a connection to a server has happened and a query has been
7713 successfully executed, processing of the lookup ceases.
7714
7715 This feature is intended for use in master/slave situations where updates
7716 are occurring and you want to update the master rather than a slave. If the
7717 master is in the list as a backup for reading, you might have a global setting
7718 like this:
7719 .code
7720 mysql_servers = slave1/db/name/pw:\
7721                 slave2/db/name/pw:\
7722                 master/db/name/pw
7723 .endd
7724 In an updating lookup, you could then write:
7725 .code
7726 ${lookup mysql{servers=master; UPDATE ...} }
7727 .endd
7728 That query would then be sent only to the master server. If, on the other hand,
7729 the master is not to be used for reading, and so is not present in the global
7730 option, you can still update it by a query of this form:
7731 .code
7732 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7733 .endd
7734
7735
7736 .section "Special MySQL features" "SECID73"
7737 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7738 causes a connection to the server on the local host by means of a Unix domain
7739 socket. An alternate socket can be specified in parentheses.
7740 An option group name for MySQL option files can be specified in square brackets;
7741 the default value is &"exim"&.
7742 The full syntax of each item in &%mysql_servers%& is:
7743 .display
7744 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7745   <&'database'&>/<&'user'&>/<&'password'&>
7746 .endd
7747 Any of the four sub-parts of the first field can be omitted. For normal use on
7748 the local host it can be left blank or set to just &"localhost"&.
7749
7750 No database need be supplied &-- but if it is absent here, it must be given in
7751 the queries.
7752
7753 If a MySQL query is issued that does not request any data (an insert, update,
7754 or delete command), the result of the lookup is the number of rows affected.
7755
7756 &*Warning*&: This can be misleading. If an update does not actually change
7757 anything (for example, setting a field to the value it already has), the result
7758 is zero because no rows are affected.
7759
7760
7761 .section "Special PostgreSQL features" "SECID74"
7762 PostgreSQL lookups can also use Unix domain socket connections to the database.
7763 This is usually faster and costs less CPU time than a TCP/IP connection.
7764 However it can be used only if the mail server runs on the same machine as the
7765 database server. A configuration line for PostgreSQL via Unix domain sockets
7766 looks like this:
7767 .code
7768 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7769 .endd
7770 In other words, instead of supplying a host name, a path to the socket is
7771 given. The path name is enclosed in parentheses so that its slashes aren't
7772 visually confused with the delimiters for the other server parameters.
7773
7774 If a PostgreSQL query is issued that does not request any data (an insert,
7775 update, or delete command), the result of the lookup is the number of rows
7776 affected.
7777
7778 .section "More about SQLite" "SECTsqlite"
7779 .cindex "lookup" "SQLite"
7780 .cindex "sqlite lookup type"
7781 SQLite is different to the other SQL lookups because a file name is required in
7782 addition to the SQL query. An SQLite database is a single file, and there is no
7783 daemon as in the other SQL databases. The interface to Exim requires the name
7784 of the file, as an absolute path, to be given at the start of the query. It is
7785 separated from the query by white space. This means that the path name cannot
7786 contain white space. Here is a lookup expansion example:
7787 .code
7788 ${lookup sqlite {/some/thing/sqlitedb \
7789   select name from aliases where id='userx';}}
7790 .endd
7791 In a list, the syntax is similar. For example:
7792 .code
7793 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7794    select * from relays where ip='$sender_host_address';
7795 .endd
7796 The only character affected by the &%quote_sqlite%& operator is a single
7797 quote, which it doubles.
7798
7799 .cindex timeout SQLite
7800 .cindex sqlite "lookup timeout"
7801 The SQLite library handles multiple simultaneous accesses to the database
7802 internally. Multiple readers are permitted, but only one process can
7803 update at once. Attempts to access the database while it is being updated
7804 are rejected after a timeout period, during which the SQLite library
7805 waits for the lock to be released. In Exim, the default timeout is set
7806 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7807 option.
7808 .ecindex IIDfidalo1
7809 .ecindex IIDfidalo2
7810
7811
7812 . ////////////////////////////////////////////////////////////////////////////
7813 . ////////////////////////////////////////////////////////////////////////////
7814
7815 .chapter "Domain, host, address, and local part lists" &&&
7816          "CHAPdomhosaddlists" &&&
7817          "Domain, host, and address lists"
7818 .scindex IIDdohoadli "lists of domains; hosts; etc."
7819 A number of Exim configuration options contain lists of domains, hosts,
7820 email addresses, or local parts. For example, the &%hold_domains%& option
7821 contains a list of domains whose delivery is currently suspended. These lists
7822 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7823 arguments to expansion conditions such as &%match_domain%&.
7824
7825 Each item in one of these lists is a pattern to be matched against a domain,
7826 host, email address, or local part, respectively. In the sections below, the
7827 different types of pattern for each case are described, but first we cover some
7828 general facilities that apply to all four kinds of list.
7829
7830 Note that other parts of Exim use a &'string list'& which does not
7831 support all the complexity available in
7832 domain, host, address and local part lists.
7833
7834
7835
7836 .section "Expansion of lists" "SECTlistexpand"
7837 .cindex "expansion" "of lists"
7838 Each list is expanded as a single string before it is used.
7839
7840 &'Exception: the router headers_remove option, where list-item
7841 splitting is done before string-expansion.'&
7842
7843 The result of
7844 expansion must be a list, possibly containing empty items, which is split up
7845 into separate items for matching. By default, colon is the separator character,
7846 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7847 &<<SECTempitelis>>& for details of the list syntax; the second of these
7848 discusses the way to specify empty list items.
7849
7850
7851 If the string expansion is forced to fail, Exim behaves as if the item it is
7852 testing (domain, host, address, or local part) is not in the list. Other
7853 expansion failures cause temporary errors.
7854
7855 If an item in a list is a regular expression, backslashes, dollars and possibly
7856 other special characters in the expression must be protected against
7857 misinterpretation by the string expander. The easiest way to do this is to use
7858 the &`\N`& expansion feature to indicate that the contents of the regular
7859 expression should not be expanded. For example, in an ACL you might have:
7860 .code
7861 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7862                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7863 .endd
7864 The first item is a regular expression that is protected from expansion by
7865 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7866 senders based on the receiving domain.
7867
7868
7869
7870
7871 .section "Negated items in lists" "SECID76"
7872 .cindex "list" "negation"
7873 .cindex "negation" "in lists"
7874 Items in a list may be positive or negative. Negative items are indicated by a
7875 leading exclamation mark, which may be followed by optional white space. A list
7876 defines a set of items (domains, etc). When Exim processes one of these lists,
7877 it is trying to find out whether a domain, host, address, or local part
7878 (respectively) is in the set that is defined by the list. It works like this:
7879
7880 The list is scanned from left to right. If a positive item is matched, the
7881 subject that is being checked is in the set; if a negative item is matched, the
7882 subject is not in the set. If the end of the list is reached without the
7883 subject having matched any of the patterns, it is in the set if the last item
7884 was a negative one, but not if it was a positive one. For example, the list in
7885 .code
7886 domainlist relay_to_domains = !a.b.c : *.b.c
7887 .endd
7888 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7889 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7890 list is positive. However, if the setting were
7891 .code
7892 domainlist relay_to_domains = !a.b.c
7893 .endd
7894 then all domains other than &'a.b.c'& would match because the last item in the
7895 list is negative. In other words, a list that ends with a negative item behaves
7896 as if it had an extra item &`:*`& on the end.
7897
7898 Another way of thinking about positive and negative items in lists is to read
7899 the connector as &"or"& after a positive item and as &"and"& after a negative
7900 item.
7901
7902
7903
7904 .section "File names in lists" "SECTfilnamlis"
7905 .cindex "list" "file name in"
7906 If an item in a domain, host, address, or local part list is an absolute file
7907 name (beginning with a slash character), each line of the file is read and
7908 processed as if it were an independent item in the list, except that further
7909 file names are not allowed,
7910 and no expansion of the data from the file takes place.
7911 Empty lines in the file are ignored, and the file may also contain comment
7912 lines:
7913
7914 .ilist
7915 For domain and host lists, if a # character appears anywhere in a line of the
7916 file, it and all following characters are ignored.
7917 .next
7918 Because local parts may legitimately contain # characters, a comment in an
7919 address list or local part list file is recognized only if # is preceded by
7920 white space or the start of the line. For example:
7921 .code
7922 not#comment@x.y.z   # but this is a comment
7923 .endd
7924 .endlist
7925
7926 Putting a file name in a list has the same effect as inserting each line of the
7927 file as an item in the list (blank lines and comments excepted). However, there
7928 is one important difference: the file is read each time the list is processed,
7929 so if its contents vary over time, Exim's behaviour changes.
7930
7931 If a file name is preceded by an exclamation mark, the sense of any match
7932 within the file is inverted. For example, if
7933 .code
7934 hold_domains = !/etc/nohold-domains
7935 .endd
7936 and the file contains the lines
7937 .code
7938 !a.b.c
7939 *.b.c
7940 .endd
7941 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7942 any domain matching &`*.b.c`& is not.
7943
7944
7945
7946 .section "An lsearch file is not an out-of-line list" "SECID77"
7947 As will be described in the sections that follow, lookups can be used in lists
7948 to provide indexed methods of checking list membership. There has been some
7949 confusion about the way &(lsearch)& lookups work in lists. Because
7950 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7951 sometimes thought that it is allowed to contain wild cards and other kinds of
7952 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7953 always fixed strings, just as for any other single-key lookup type.
7954
7955 If you want to use a file to contain wild-card patterns that form part of a
7956 list, just give the file name on its own, without a search type, as described
7957 in the previous section. You could also use the &(wildlsearch)& or
7958 &(nwildlsearch)&, but there is no advantage in doing this.
7959
7960
7961
7962
7963 .section "Named lists" "SECTnamedlists"
7964 .cindex "named lists"
7965 .cindex "list" "named"
7966 A list of domains, hosts, email addresses, or local parts can be given a name
7967 which is then used to refer to the list elsewhere in the configuration. This is
7968 particularly convenient if the same list is required in several different
7969 places. It also allows lists to be given meaningful names, which can improve
7970 the readability of the configuration. For example, it is conventional to define
7971 a domain list called &'local_domains'& for all the domains that are handled
7972 locally on a host, using a configuration line such as
7973 .code
7974 domainlist local_domains = localhost:my.dom.example
7975 .endd
7976 Named lists are referenced by giving their name preceded by a plus sign, so,
7977 for example, a router that is intended to handle local domains would be
7978 configured with the line
7979 .code
7980 domains = +local_domains
7981 .endd
7982 The first router in a configuration is often one that handles all domains
7983 except the local ones, using a configuration with a negated item like this:
7984 .code
7985 dnslookup:
7986   driver = dnslookup
7987   domains = ! +local_domains
7988   transport = remote_smtp
7989   no_more
7990 .endd
7991 The four kinds of named list are created by configuration lines starting with
7992 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7993 respectively. Then there follows the name that you are defining, followed by an
7994 equals sign and the list itself. For example:
7995 .code
7996 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7997 addresslist bad_senders = cdb;/etc/badsenders
7998 .endd
7999 A named list may refer to other named lists:
8000 .code
8001 domainlist  dom1 = first.example : second.example
8002 domainlist  dom2 = +dom1 : third.example
8003 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8004 .endd
8005 &*Warning*&: If the last item in a referenced list is a negative one, the
8006 effect may not be what you intended, because the negation does not propagate
8007 out to the higher level. For example, consider:
8008 .code
8009 domainlist  dom1 = !a.b
8010 domainlist  dom2 = +dom1 : *.b
8011 .endd
8012 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8013 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8014 means it matches the second list as well. The effect is not the same as
8015 .code
8016 domainlist  dom2 = !a.b : *.b
8017 .endd
8018 where &'x.y'& does not match. It's best to avoid negation altogether in
8019 referenced lists if you can.
8020
8021 Named lists may have a performance advantage. When Exim is routing an
8022 address or checking an incoming message, it caches the result of tests on named
8023 lists. So, if you have a setting such as
8024 .code
8025 domains = +local_domains
8026 .endd
8027 on several of your routers
8028 or in several ACL statements,
8029 the actual test is done only for the first one. However, the caching works only
8030 if there are no expansions within the list itself or any sublists that it
8031 references. In other words, caching happens only for lists that are known to be
8032 the same each time they are referenced.
8033
8034 By default, there may be up to 16 named lists of each type. This limit can be
8035 extended by changing a compile-time variable. The use of domain and host lists
8036 is recommended for concepts such as local domains, relay domains, and relay
8037 hosts. The default configuration is set up like this.
8038
8039
8040
8041 .section "Named lists compared with macros" "SECID78"
8042 .cindex "list" "named compared with macro"
8043 .cindex "macro" "compared with named list"
8044 At first sight, named lists might seem to be no different from macros in the
8045 configuration file. However, macros are just textual substitutions. If you
8046 write
8047 .code
8048 ALIST = host1 : host2
8049 auth_advertise_hosts = !ALIST
8050 .endd
8051 it probably won't do what you want, because that is exactly the same as
8052 .code
8053 auth_advertise_hosts = !host1 : host2
8054 .endd
8055 Notice that the second host name is not negated. However, if you use a host
8056 list, and write
8057 .code
8058 hostlist alist = host1 : host2
8059 auth_advertise_hosts = ! +alist
8060 .endd
8061 the negation applies to the whole list, and so that is equivalent to
8062 .code
8063 auth_advertise_hosts = !host1 : !host2
8064 .endd
8065
8066
8067 .section "Named list caching" "SECID79"
8068 .cindex "list" "caching of named"
8069 .cindex "caching" "named lists"
8070 While processing a message, Exim caches the result of checking a named list if
8071 it is sure that the list is the same each time. In practice, this means that
8072 the cache operates only if the list contains no $ characters, which guarantees
8073 that it will not change when it is expanded. Sometimes, however, you may have
8074 an expanded list that you know will be the same each time within a given
8075 message. For example:
8076 .code
8077 domainlist special_domains = \
8078            ${lookup{$sender_host_address}cdb{/some/file}}
8079 .endd
8080 This provides a list of domains that depends only on the sending host's IP
8081 address. If this domain list is referenced a number of times (for example,
8082 in several ACL lines, or in several routers) the result of the check is not
8083 cached by default, because Exim does not know that it is going to be the
8084 same list each time.
8085
8086 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8087 cache the result anyway. For example:
8088 .code
8089 domainlist_cache special_domains = ${lookup{...
8090 .endd
8091 If you do this, you should be absolutely sure that caching is going to do
8092 the right thing in all cases. When in doubt, leave it out.
8093
8094
8095
8096 .section "Domain lists" "SECTdomainlist"
8097 .cindex "domain list" "patterns for"
8098 .cindex "list" "domain list"
8099 Domain lists contain patterns that are to be matched against a mail domain.
8100 The following types of item may appear in domain lists:
8101
8102 .ilist
8103 .cindex "primary host name"
8104 .cindex "host name" "matched in domain list"
8105 .oindex "&%primary_hostname%&"
8106 .cindex "domain list" "matching primary host name"
8107 .cindex "@ in a domain list"
8108 If a pattern consists of a single @ character, it matches the local host name,
8109 as set by the &%primary_hostname%& option (or defaulted). This makes it
8110 possible to use the same configuration file on several different hosts that
8111 differ only in their names.
8112 .next
8113 .cindex "@[] in a domain list"
8114 .cindex "domain list" "matching local IP interfaces"
8115 .cindex "domain literal"
8116 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8117 in square brackets (as in an email address that contains a domain literal), but
8118 only if that IP address is recognized as local for email routing purposes. The
8119 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8120 control which of a host's several IP addresses are treated as local.
8121 In today's Internet, the use of domain literals is controversial.
8122 .next
8123 .cindex "@mx_any"
8124 .cindex "@mx_primary"
8125 .cindex "@mx_secondary"
8126 .cindex "domain list" "matching MX pointers to local host"
8127 If a pattern consists of the string &`@mx_any`& it matches any domain that
8128 has an MX record pointing to the local host or to any host that is listed in
8129 .oindex "&%hosts_treat_as_local%&"
8130 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8131 are similar, except that the first matches only when a primary MX target is the
8132 local host, and the second only when no primary MX target is the local host,
8133 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8134 preference value &-- there may of course be more than one of them.
8135
8136 The MX lookup that takes place when matching a pattern of this type is
8137 performed with the resolver options for widening names turned off. Thus, for
8138 example, a single-component domain will &'not'& be expanded by adding the
8139 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8140 options of the &(dnslookup)& router for a discussion of domain widening.
8141
8142 Sometimes you may want to ignore certain IP addresses when using one of these
8143 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8144 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8145 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8146 on a router). For example:
8147 .code
8148 domains = @mx_any/ignore=127.0.0.1
8149 .endd
8150 This example matches any domain that has an MX record pointing to one of
8151 the local host's IP addresses other than 127.0.0.1.
8152
8153 The list of IP addresses is in fact processed by the same code that processes
8154 host lists, so it may contain CIDR-coded network specifications and it may also
8155 contain negative items.
8156
8157 Because the list of IP addresses is a sublist within a domain list, you have to
8158 be careful about delimiters if there is more than one address. Like any other
8159 list, the default delimiter can be changed. Thus, you might have:
8160 .code
8161 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8162           an.other.domain : ...
8163 .endd
8164 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8165 involved, it is easiest to change the delimiter for the main list as well:
8166 .code
8167 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8168           an.other.domain ? ...
8169 .endd
8170 .next
8171 .cindex "asterisk" "in domain list"
8172 .cindex "domain list" "asterisk in"
8173 .cindex "domain list" "matching &""ends with""&"
8174 If a pattern starts with an asterisk, the remaining characters of the pattern
8175 are compared with the terminating characters of the domain. The use of &"*"& in
8176 domain lists differs from its use in partial matching lookups. In a domain
8177 list, the character following the asterisk need not be a dot, whereas partial
8178 matching works only in terms of dot-separated components. For example, a domain
8179 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8180 &'cipher.key.ex'&.
8181
8182 .next
8183 .cindex "regular expressions" "in domain list"
8184 .cindex "domain list" "matching regular expression"
8185 If a pattern starts with a circumflex character, it is treated as a regular
8186 expression, and matched against the domain using a regular expression matching
8187 function. The circumflex is treated as part of the regular expression.
8188 Email domains are case-independent, so this regular expression match is by
8189 default case-independent, but you can make it case-dependent by starting it
8190 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8191 are given in chapter &<<CHAPregexp>>&.
8192
8193 &*Warning*&: Because domain lists are expanded before being processed, you
8194 must escape any backslash and dollar characters in the regular expression, or
8195 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8196 it is not to be expanded (unless you really do want to build a regular
8197 expression by expansion, of course).
8198 .next
8199 .cindex "lookup" "in domain list"
8200 .cindex "domain list" "matching by lookup"
8201 If a pattern starts with the name of a single-key lookup type followed by a
8202 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8203 must be a file name in a suitable format for the lookup type. For example, for
8204 &"cdb;"& it must be an absolute path:
8205 .code
8206 domains = cdb;/etc/mail/local_domains.cdb
8207 .endd
8208 The appropriate type of lookup is done on the file using the domain name as the
8209 key. In most cases, the data that is looked up is not used; Exim is interested
8210 only in whether or not the key is present in the file. However, when a lookup
8211 is used for the &%domains%& option on a router
8212 or a &%domains%& condition in an ACL statement, the data is preserved in the
8213 &$domain_data$& variable and can be referred to in other router options or
8214 other statements in the same ACL.
8215
8216 .next
8217 Any of the single-key lookup type names may be preceded by
8218 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8219 .code
8220 domains = partial-dbm;/partial/domains
8221 .endd
8222 This causes partial matching logic to be invoked; a description of how this
8223 works is given in section &<<SECTpartiallookup>>&.
8224
8225 .next
8226 .cindex "asterisk" "in lookup type"
8227 Any of the single-key lookup types may be followed by an asterisk. This causes
8228 a default lookup for a key consisting of a single asterisk to be done if the
8229 original lookup fails. This is not a useful feature when using a domain list to
8230 select particular domains (because any domain would match), but it might have
8231 value if the result of the lookup is being used via the &$domain_data$&
8232 expansion variable.
8233 .next
8234 If the pattern starts with the name of a query-style lookup type followed by a
8235 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8236 pattern must be an appropriate query for the lookup type, as described in
8237 chapter &<<CHAPfdlookup>>&. For example:
8238 .code
8239 hold_domains = mysql;select domain from holdlist \
8240   where domain = '${quote_mysql:$domain}';
8241 .endd
8242 In most cases, the data that is looked up is not used (so for an SQL query, for
8243 example, it doesn't matter what field you select). Exim is interested only in
8244 whether or not the query succeeds. However, when a lookup is used for the
8245 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8246 variable and can be referred to in other options.
8247 .next
8248 .cindex "domain list" "matching literal domain name"
8249 If none of the above cases apply, a caseless textual comparison is made
8250 between the pattern and the domain.
8251 .endlist
8252
8253 Here is an example that uses several different kinds of pattern:
8254 .code
8255 domainlist funny_domains = \
8256   @ : \
8257   lib.unseen.edu : \
8258   *.foundation.fict.example : \
8259   \N^[1-2]\d{3}\.fict\.example$\N : \
8260   partial-dbm;/opt/data/penguin/book : \
8261   nis;domains.byname : \
8262   nisplus;[name=$domain,status=local],domains.org_dir
8263 .endd
8264 There are obvious processing trade-offs among the various matching modes. Using
8265 an asterisk is faster than a regular expression, and listing a few names
8266 explicitly probably is too. The use of a file or database lookup is expensive,
8267 but may be the only option if hundreds of names are required. Because the
8268 patterns are tested in order, it makes sense to put the most commonly matched
8269 patterns earlier.
8270
8271
8272
8273 .section "Host lists" "SECThostlist"
8274 .cindex "host list" "patterns in"
8275 .cindex "list" "host list"
8276 Host lists are used to control what remote hosts are allowed to do. For
8277 example, some hosts may be allowed to use the local host as a relay, and some
8278 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8279 two different ways, by name or by IP address. In a host list, some types of
8280 pattern are matched to a host name, and some are matched to an IP address.
8281 You need to be particularly careful with this when single-key lookups are
8282 involved, to ensure that the right value is being used as the key.
8283
8284
8285 .section "Special host list patterns" "SECID80"
8286 .cindex "empty item in hosts list"
8287 .cindex "host list" "empty string in"
8288 If a host list item is the empty string, it matches only when no remote host is
8289 involved. This is the case when a message is being received from a local
8290 process using SMTP on the standard input, that is, when a TCP/IP connection is
8291 not used.
8292
8293 .cindex "asterisk" "in host list"
8294 The special pattern &"*"& in a host list matches any host or no host. Neither
8295 the IP address nor the name is actually inspected.
8296
8297
8298
8299 .section "Host list patterns that match by IP address" "SECThoslispatip"
8300 .cindex "host list" "matching IP addresses"
8301 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8302 the incoming address actually appears in the IPv6 host as
8303 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8304 list, it is converted into a traditional IPv4 address first. (Not all operating
8305 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8306 concerns.)
8307
8308 The following types of pattern in a host list check the remote host by
8309 inspecting its IP address:
8310
8311 .ilist
8312 If the pattern is a plain domain name (not a regular expression, not starting
8313 with *, not a lookup of any kind), Exim calls the operating system function
8314 to find the associated IP address(es). Exim uses the newer
8315 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8316 This typically causes a forward DNS lookup of the name. The result is compared
8317 with the IP address of the subject host.
8318
8319 If there is a temporary problem (such as a DNS timeout) with the host name
8320 lookup, a temporary error occurs. For example, if the list is being used in an
8321 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8322 temporary SMTP error code. If no IP address can be found for the host name,
8323 what happens is described in section &<<SECTbehipnot>>& below.
8324
8325 .next
8326 .cindex "@ in a host list"
8327 If the pattern is &"@"&, the primary host name is substituted and used as a
8328 domain name, as just described.
8329
8330 .next
8331 If the pattern is an IP address, it is matched against the IP address of the
8332 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8333 IPv6 addresses can be given in colon-separated format, but the colons have to
8334 be doubled so as not to be taken as item separators when the default list
8335 separator is used. IPv6 addresses are recognized even when Exim is compiled
8336 without IPv6 support. This means that if they appear in a host list on an
8337 IPv4-only host, Exim will not treat them as host names. They are just addresses
8338 that can never match a client host.
8339
8340 .next
8341 .cindex "@[] in a host list"
8342 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8343 the local host. For example, if the local host is an IPv4 host with one
8344 interface address 10.45.23.56, these two ACL statements have the same effect:
8345 .code
8346 accept hosts = 127.0.0.1 : 10.45.23.56
8347 accept hosts = @[]
8348 .endd
8349 .next
8350 .cindex "CIDR notation"
8351 If the pattern is an IP address followed by a slash and a mask length (for
8352 example 10.11.42.0/24), it is matched against the IP address of the subject
8353 host under the given mask. This allows, an entire network of hosts to be
8354 included (or excluded) by a single item. The mask uses CIDR notation; it
8355 specifies the number of address bits that must match, starting from the most
8356 significant end of the address.
8357
8358 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8359 of a range of addresses. It is the number of bits in the network portion of the
8360 address. The above example specifies a 24-bit netmask, so it matches all 256
8361 addresses in the 10.11.42.0 network. An item such as
8362 .code
8363 192.168.23.236/31
8364 .endd
8365 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8366 32 for an IPv4 address is the same as no mask at all; just a single address
8367 matches.
8368
8369 Here is another example which shows an IPv4 and an IPv6 network:
8370 .code
8371 recipient_unqualified_hosts = 192.168.0.0/16: \
8372                               3ffe::ffff::836f::::/48
8373 .endd
8374 The doubling of list separator characters applies only when these items
8375 appear inline in a host list. It is not required when indirecting via a file.
8376 For example:
8377 .code
8378 recipient_unqualified_hosts = /opt/exim/unqualnets
8379 .endd
8380 could make use of a file containing
8381 .code
8382 172.16.0.0/12
8383 3ffe:ffff:836f::/48
8384 .endd
8385 to have exactly the same effect as the previous example. When listing IPv6
8386 addresses inline, it is usually more convenient to use the facility for
8387 changing separator characters. This list contains the same two networks:
8388 .code
8389 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8390                                  3ffe:ffff:836f::/48
8391 .endd
8392 The separator is changed to semicolon by the leading &"<;"& at the start of the
8393 list.
8394 .endlist
8395
8396
8397
8398 .section "Host list patterns for single-key lookups by host address" &&&
8399          "SECThoslispatsikey"
8400 .cindex "host list" "lookup of IP address"
8401 When a host is to be identified by a single-key lookup of its complete IP
8402 address, the pattern takes this form:
8403 .display
8404 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8405 .endd
8406 For example:
8407 .code
8408 hosts_lookup = net-cdb;/hosts-by-ip.db
8409 .endd
8410 The text form of the IP address of the subject host is used as the lookup key.
8411 IPv6 addresses are converted to an unabbreviated form, using lower case
8412 letters, with dots as separators because colon is the key terminator in
8413 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8414 quoting the keys, but this is a facility that was added later.] The data
8415 returned by the lookup is not used.
8416
8417 .cindex "IP address" "masking"
8418 .cindex "host list" "masked IP address"
8419 Single-key lookups can also be performed using masked IP addresses, using
8420 patterns of this form:
8421 .display
8422 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8423 .endd
8424 For example:
8425 .code
8426 net24-dbm;/networks.db
8427 .endd
8428 The IP address of the subject host is masked using <&'number'&> as the mask
8429 length. A textual string is constructed from the masked value, followed by the
8430 mask, and this is used as the lookup key. For example, if the host's IP address
8431 is 192.168.34.6, the key that is looked up for the above example is
8432 &"192.168.34.0/24"&.
8433
8434 When an IPv6 address is converted to a string, dots are normally used instead
8435 of colons, so that keys in &(lsearch)& files need not contain colons (which
8436 terminate &(lsearch)& keys). This was implemented some time before the ability
8437 to quote keys was made available in &(lsearch)& files. However, the more
8438 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8439 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8440 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8441 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8442 addresses are always used.
8443
8444 Ideally, it would be nice to tidy up this anomalous situation by changing to
8445 colons in all cases, given that quoting is now available for &(lsearch)&.
8446 However, this would be an incompatible change that might break some existing
8447 configurations.
8448
8449 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8450 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8451 the former case the key strings include the mask value, whereas in the latter
8452 case the IP address is used on its own.
8453
8454
8455
8456 .section "Host list patterns that match by host name" "SECThoslispatnam"
8457 .cindex "host" "lookup failures"
8458 .cindex "unknown host name"
8459 .cindex "host list" "matching host name"
8460 There are several types of pattern that require Exim to know the name of the
8461 remote host. These are either wildcard patterns or lookups by name. (If a
8462 complete hostname is given without any wildcarding, it is used to find an IP
8463 address to match against, as described in section &<<SECThoslispatip>>&
8464 above.)
8465
8466 If the remote host name is not already known when Exim encounters one of these
8467 patterns, it has to be found from the IP address.
8468 Although many sites on the Internet are conscientious about maintaining reverse
8469 DNS data for their hosts, there are also many that do not do this.
8470 Consequently, a name cannot always be found, and this may lead to unwanted
8471 effects. Take care when configuring host lists with wildcarded name patterns.
8472 Consider what will happen if a name cannot be found.
8473
8474 Because of the problems of determining host names from IP addresses, matching
8475 against host names is not as common as matching against IP addresses.
8476
8477 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8478 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8479 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8480 are done can be changed by setting the &%host_lookup_order%& option. For
8481 security, once Exim has found one or more names, it looks up the IP addresses
8482 for these names and compares them with the IP address that it started with.
8483 Only those names whose IP addresses match are accepted. Any other names are
8484 discarded. If no names are left, Exim behaves as if the host name cannot be
8485 found. In the most common case there is only one name and one IP address.
8486
8487 There are some options that control what happens if a host name cannot be
8488 found. These are described in section &<<SECTbehipnot>>& below.
8489
8490 .cindex "host" "alias for"
8491 .cindex "alias for host"
8492 As a result of aliasing, hosts may have more than one name. When processing any
8493 of the following types of pattern, all the host's names are checked:
8494
8495 .ilist
8496 .cindex "asterisk" "in host list"
8497 If a pattern starts with &"*"& the remainder of the item must match the end of
8498 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8499 &'.b.c'&. This special simple form is provided because this is a very common
8500 requirement. Other kinds of wildcarding require the use of a regular
8501 expression.
8502 .next
8503 .cindex "regular expressions" "in host list"
8504 .cindex "host list" "regular expression in"
8505 If the item starts with &"^"& it is taken to be a regular expression which is
8506 matched against the host name. Host names are case-independent, so this regular
8507 expression match is by default case-independent, but you can make it
8508 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8509 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8510 example,
8511 .code
8512 ^(a|b)\.c\.d$
8513 .endd
8514 is a regular expression that matches either of the two hosts &'a.c.d'& or
8515 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8516 that backslash and dollar characters are not misinterpreted as part of the
8517 string expansion. The simplest way to do this is to use &`\N`& to mark that
8518 part of the string as non-expandable. For example:
8519 .code
8520 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8521 .endd
8522 &*Warning*&: If you want to match a complete host name, you must include the
8523 &`$`& terminating metacharacter in the regular expression, as in the above
8524 example. Without it, a match at the start of the host name is all that is
8525 required.
8526 .endlist
8527
8528
8529
8530
8531 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8532 .cindex "host" "lookup failures, permanent"
8533 While processing a host list, Exim may need to look up an IP address from a
8534 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8535 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8536 behaviour when it fails to find the information it is seeking is the same.
8537
8538 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8539 apply to temporary DNS errors, whose handling is described in the next section.
8540
8541 .cindex "&`+include_unknown`&"
8542 .cindex "&`+ignore_unknown`&"
8543 Exim parses a host list from left to right. If it encounters a permanent
8544 lookup failure in any item in the host list before it has found a match,
8545 Exim treats it as a failure and the default behavior is as if the host
8546 does not match the list. This may not always be what you want to happen.
8547 To change Exim's behaviour, the special items &`+include_unknown`& or
8548 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8549 not recognized in an indirected file).
8550
8551 .ilist
8552 If any item that follows &`+include_unknown`& requires information that
8553 cannot found, Exim behaves as if the host does match the list. For example,
8554 .code
8555 host_reject_connection = +include_unknown:*.enemy.ex
8556 .endd
8557 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8558 any hosts whose name it cannot find.
8559
8560 .next
8561 If any item that follows &`+ignore_unknown`& requires information that cannot
8562 be found, Exim ignores that item and proceeds to the rest of the list. For
8563 example:
8564 .code
8565 accept hosts = +ignore_unknown : friend.example : \
8566                192.168.4.5
8567 .endd
8568 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8569 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8570 name can be found for 192.168.4.5, it is rejected.
8571 .endlist
8572
8573 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8574 list. The effect of each one lasts until the next, or until the end of the
8575 list.
8576
8577 .section "Mixing wildcarded host names and addresses in host lists" &&&
8578          "SECTmixwilhos"
8579 .cindex "host list" "mixing names and addresses in"
8580
8581 This section explains the host/ip processing logic with the same concepts
8582 as the previous section, but specifically addresses what happens when a
8583 wildcarded hostname is one of the items in the hostlist.
8584
8585 .ilist
8586 If you have name lookups or wildcarded host names and
8587 IP addresses in the same host list, you should normally put the IP
8588 addresses first. For example, in an ACL you could have:
8589 .code
8590 accept hosts = 10.9.8.7 : *.friend.example
8591 .endd
8592 The reason you normally would order it this way lies in the
8593 left-to-right way that Exim processes lists.  It can test IP addresses
8594 without doing any DNS lookups, but when it reaches an item that requires
8595 a host name, it fails if it cannot find a host name to compare with the
8596 pattern. If the above list is given in the opposite order, the
8597 &%accept%& statement fails for a host whose name cannot be found, even
8598 if its IP address is 10.9.8.7.
8599
8600 .next
8601 If you really do want to do the name check first, and still recognize the IP
8602 address, you can rewrite the ACL like this:
8603 .code
8604 accept hosts = *.friend.example
8605 accept hosts = 10.9.8.7
8606 .endd
8607 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8608 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8609 &`+ignore_unknown`&, which was discussed in depth in the first example in
8610 this section.
8611 .endlist
8612
8613
8614 .section "Temporary DNS errors when looking up host information" &&&
8615          "SECTtemdnserr"
8616 .cindex "host" "lookup failures, temporary"
8617 .cindex "&`+include_defer`&"
8618 .cindex "&`+ignore_defer`&"
8619 A temporary DNS lookup failure normally causes a defer action (except when
8620 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8621 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8622 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8623 section. These options should be used with care, probably only in non-critical
8624 host lists such as whitelists.
8625
8626
8627
8628 .section "Host list patterns for single-key lookups by host name" &&&
8629          "SECThoslispatnamsk"
8630 .cindex "unknown host name"
8631 .cindex "host list" "matching host name"
8632 If a pattern is of the form
8633 .display
8634 <&'single-key-search-type'&>;<&'search-data'&>
8635 .endd
8636 for example
8637 .code
8638 dbm;/host/accept/list
8639 .endd
8640 a single-key lookup is performed, using the host name as its key. If the
8641 lookup succeeds, the host matches the item. The actual data that is looked up
8642 is not used.
8643
8644 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8645 keys in the file, not IP addresses. If you want to do lookups based on IP
8646 addresses, you must precede the search type with &"net-"& (see section
8647 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8648 two items in the same list, one doing an address lookup and one doing a name
8649 lookup, both using the same file.
8650
8651
8652
8653 .section "Host list patterns for query-style lookups" "SECID81"
8654 If a pattern is of the form
8655 .display
8656 <&'query-style-search-type'&>;<&'query'&>
8657 .endd
8658 the query is obeyed, and if it succeeds, the host matches the item. The actual
8659 data that is looked up is not used. The variables &$sender_host_address$& and
8660 &$sender_host_name$& can be used in the query. For example:
8661 .code
8662 hosts_lookup = pgsql;\
8663   select ip from hostlist where ip='$sender_host_address'
8664 .endd
8665 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8666 can use the &%sg%& expansion item to change this if you need to. If you want to
8667 use masked IP addresses in database queries, you can use the &%mask%& expansion
8668 operator.
8669
8670 If the query contains a reference to &$sender_host_name$&, Exim automatically
8671 looks up the host name if it has not already done so. (See section
8672 &<<SECThoslispatnam>>& for comments on finding host names.)
8673
8674 Historical note: prior to release 4.30, Exim would always attempt to find a
8675 host name before running the query, unless the search type was preceded by
8676 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8677 still recognized for query-style lookups, but its presence or absence has no
8678 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8679 See section &<<SECThoslispatsikey>>&.)
8680
8681
8682
8683
8684
8685 .section "Address lists" "SECTaddresslist"
8686 .cindex "list" "address list"
8687 .cindex "address list" "empty item"
8688 .cindex "address list" "patterns"
8689 Address lists contain patterns that are matched against mail addresses. There
8690 is one special case to be considered: the sender address of a bounce message is
8691 always empty. You can test for this by providing an empty item in an address
8692 list. For example, you can set up a router to process bounce messages by
8693 using this option setting:
8694 .code
8695 senders = :
8696 .endd
8697 The presence of the colon creates an empty item. If you do not provide any
8698 data, the list is empty and matches nothing. The empty sender can also be
8699 detected by a regular expression that matches an empty string,
8700 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8701
8702 Non-empty items in an address list can be straightforward email addresses. For
8703 example:
8704 .code
8705 senders = jbc@askone.example : hs@anacreon.example
8706 .endd
8707 A certain amount of wildcarding is permitted. If a pattern contains an @
8708 character, but is not a regular expression and does not begin with a
8709 semicolon-terminated lookup type (described below), the local part of the
8710 subject address is compared with the local part of the pattern, which may start
8711 with an asterisk. If the local parts match, the domain is checked in exactly
8712 the same way as for a pattern in a domain list. For example, the domain can be
8713 wildcarded, refer to a named list, or be a lookup:
8714 .code
8715 deny senders = *@*.spamming.site:\
8716                *@+hostile_domains:\
8717                bozo@partial-lsearch;/list/of/dodgy/sites:\
8718                *@dbm;/bad/domains.db
8719 .endd
8720 .cindex "local part" "starting with !"
8721 .cindex "address list" "local part starting with !"
8722 If a local part that begins with an exclamation mark is required, it has to be
8723 specified using a regular expression, because otherwise the exclamation mark is
8724 treated as a sign of negation, as is standard in lists.
8725
8726 If a non-empty pattern that is not a regular expression or a lookup does not
8727 contain an @ character, it is matched against the domain part of the subject
8728 address. The only two formats that are recognized this way are a literal
8729 domain, or a domain pattern that starts with *. In both these cases, the effect
8730 is the same as if &`*@`& preceded the pattern. For example:
8731 .code
8732 deny senders = enemy.domain : *.enemy.domain
8733 .endd
8734
8735 The following kinds of more complicated address list pattern can match any
8736 address, including the empty address that is characteristic of bounce message
8737 senders:
8738
8739 .ilist
8740 .cindex "regular expressions" "in address list"
8741 .cindex "address list" "regular expression in"
8742 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8743 done against the complete address, with the pattern as the regular expression.
8744 You must take care that backslash and dollar characters are not misinterpreted
8745 as part of the string expansion. The simplest way to do this is to use &`\N`&
8746 to mark that part of the string as non-expandable. For example:
8747 .code
8748 deny senders = \N^.*this.*@example\.com$\N : \
8749                \N^\d{8}.+@spamhaus.example$\N : ...
8750 .endd
8751 The &`\N`& sequences are removed by the expansion, so these items do indeed
8752 start with &"^"& by the time they are being interpreted as address patterns.
8753
8754 .next
8755 .cindex "address list" "lookup for complete address"
8756 Complete addresses can be looked up by using a pattern that starts with a
8757 lookup type terminated by a semicolon, followed by the data for the lookup. For
8758 example:
8759 .code
8760 deny senders = cdb;/etc/blocked.senders : \
8761   mysql;select address from blocked where \
8762   address='${quote_mysql:$sender_address}'
8763 .endd
8764 Both query-style and single-key lookup types can be used. For a single-key
8765 lookup type, Exim uses the complete address as the key. However, empty keys are
8766 not supported for single-key lookups, so a match against the empty address
8767 always fails. This restriction does not apply to query-style lookups.
8768
8769 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8770 cannot be used, and is ignored if specified, with an entry being written to the
8771 panic log.
8772 .cindex "*@ with single-key lookup"
8773 However, you can configure lookup defaults, as described in section
8774 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8775 default. For example, with this lookup:
8776 .code
8777 accept senders = lsearch*@;/some/file
8778 .endd
8779 the file could contains lines like this:
8780 .code
8781 user1@domain1.example
8782 *@domain2.example
8783 .endd
8784 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8785 that are tried is:
8786 .code
8787 nimrod@jaeger.example
8788 *@jaeger.example
8789 *
8790 .endd
8791 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8792 would mean that every address matches, thus rendering the test useless.
8793
8794 &*Warning 2*&: Do not confuse these two kinds of item:
8795 .code
8796 deny recipients = dbm*@;/some/file
8797 deny recipients = *@dbm;/some/file
8798 .endd
8799 The first does a whole address lookup, with defaulting, as just described,
8800 because it starts with a lookup type. The second matches the local part and
8801 domain independently, as described in a bullet point below.
8802 .endlist
8803
8804
8805 The following kinds of address list pattern can match only non-empty addresses.
8806 If the subject address is empty, a match against any of these pattern types
8807 always fails.
8808
8809
8810 .ilist
8811 .cindex "@@ with single-key lookup"
8812 .cindex "address list" "@@ lookup type"
8813 .cindex "address list" "split local part and domain"
8814 If a pattern starts with &"@@"& followed by a single-key lookup item
8815 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8816 split into a local part and a domain. The domain is looked up in the file. If
8817 it is not found, there is no match. If it is found, the data that is looked up
8818 from the file is treated as a colon-separated list of local part patterns, each
8819 of which is matched against the subject local part in turn.
8820
8821 .cindex "asterisk" "in address list"
8822 The lookup may be a partial one, and/or one involving a search for a default
8823 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8824 patterns that are looked up can be regular expressions or begin with &"*"&, or
8825 even be further lookups. They may also be independently negated. For example,
8826 with
8827 .code
8828 deny senders = @@dbm;/etc/reject-by-domain
8829 .endd
8830 the data from which the DBM file is built could contain lines like
8831 .code
8832 baddomain.com:  !postmaster : *
8833 .endd
8834 to reject all senders except &%postmaster%& from that domain.
8835
8836 .cindex "local part" "starting with !"
8837 If a local part that actually begins with an exclamation mark is required, it
8838 has to be specified using a regular expression. In &(lsearch)& files, an entry
8839 may be split over several lines by indenting the second and subsequent lines,
8840 but the separating colon must still be included at line breaks. White space
8841 surrounding the colons is ignored. For example:
8842 .code
8843 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8844   spammer3 : spammer4
8845 .endd
8846 As in all colon-separated lists in Exim, a colon can be included in an item by
8847 doubling.
8848
8849 If the last item in the list starts with a right angle-bracket, the remainder
8850 of the item is taken as a new key to look up in order to obtain a continuation
8851 list of local parts. The new key can be any sequence of characters. Thus one
8852 might have entries like
8853 .code
8854 aol.com: spammer1 : spammer 2 : >*
8855 xyz.com: spammer3 : >*
8856 *:       ^\d{8}$
8857 .endd
8858 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8859 local parts for all domains, in addition to the specific local parts listed for
8860 each domain. Of course, using this feature costs another lookup each time a
8861 chain is followed, but the effort needed to maintain the data is reduced.
8862
8863 .cindex "loop" "in lookups"
8864 It is possible to construct loops using this facility, and in order to catch
8865 them, the chains may be no more than fifty items long.
8866
8867 .next
8868 The @@<&'lookup'&> style of item can also be used with a query-style
8869 lookup, but in this case, the chaining facility is not available. The lookup
8870 can only return a single list of local parts.
8871 .endlist
8872
8873 &*Warning*&: There is an important difference between the address list items
8874 in these two examples:
8875 .code
8876 senders = +my_list
8877 senders = *@+my_list
8878 .endd
8879 In the first one, &`my_list`& is a named address list, whereas in the second
8880 example it is a named domain list.
8881
8882
8883
8884
8885 .section "Case of letters in address lists" "SECTcasletadd"
8886 .cindex "case of local parts"
8887 .cindex "address list" "case forcing"
8888 .cindex "case forcing in address lists"
8889 Domains in email addresses are always handled caselessly, but for local parts
8890 case may be significant on some systems (see &%caseful_local_part%& for how
8891 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8892 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8893 blocking lists should be done in a case-independent manner. Since most address
8894 lists in Exim are used for this kind of control, Exim attempts to do this by
8895 default.
8896
8897 The domain portion of an address is always lowercased before matching it to an
8898 address list. The local part is lowercased by default, and any string
8899 comparisons that take place are done caselessly. This means that the data in
8900 the address list itself, in files included as plain file names, and in any file
8901 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8902 keys in files that are looked up by a search type other than &(lsearch)& (which
8903 works caselessly) must be in lower case, because these lookups are not
8904 case-independent.
8905
8906 .cindex "&`+caseful`&"
8907 To allow for the possibility of caseful address list matching, if an item in
8908 an address list is the string &"+caseful"&, the original case of the local
8909 part is restored for any comparisons that follow, and string comparisons are no
8910 longer case-independent. This does not affect the domain, which remains in
8911 lower case. However, although independent matches on the domain alone are still
8912 performed caselessly, regular expressions that match against an entire address
8913 become case-sensitive after &"+caseful"& has been seen.
8914
8915
8916
8917 .section "Local part lists" "SECTlocparlis"
8918 .cindex "list" "local part list"
8919 .cindex "local part" "list"
8920 Case-sensitivity in local part lists is handled in the same way as for address
8921 lists, as just described. The &"+caseful"& item can be used if required. In a
8922 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8923 set false, the subject is lowercased and the matching is initially
8924 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8925 matching in the local part list, but not elsewhere in the router. If
8926 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8927 option is case-sensitive from the start.
8928
8929 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8930 comments are handled in the same way as address lists &-- they are recognized
8931 only if the # is preceded by white space or the start of the line.
8932 Otherwise, local part lists are matched in the same way as domain lists, except
8933 that the special items that refer to the local host (&`@`&, &`@[]`&,
8934 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8935 Refer to section &<<SECTdomainlist>>& for details of the other available item
8936 types.
8937 .ecindex IIDdohoadli
8938
8939
8940
8941
8942 . ////////////////////////////////////////////////////////////////////////////
8943 . ////////////////////////////////////////////////////////////////////////////
8944
8945 .chapter "String expansions" "CHAPexpand"
8946 .scindex IIDstrexp "expansion" "of strings"
8947 Many strings in Exim's run time configuration are expanded before use. Some of
8948 them are expanded every time they are used; others are expanded only once.
8949
8950 When a string is being expanded it is copied verbatim from left to right except
8951 when a dollar or backslash character is encountered. A dollar specifies the
8952 start of a portion of the string that is interpreted and replaced as described
8953 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8954 escape character, as described in the following section.
8955
8956 Whether a string is expanded depends upon the context.  Usually this is solely
8957 dependent upon the option for which a value is sought; in this documentation,
8958 options for which string expansion is performed are marked with &dagger; after
8959 the data type.  ACL rules always expand strings.  A couple of expansion
8960 conditions do not expand some of the brace-delimited branches, for security
8961 reasons.
8962
8963
8964
8965 .section "Literal text in expanded strings" "SECTlittext"
8966 .cindex "expansion" "including literal text"
8967 An uninterpreted dollar can be included in an expanded string by putting a
8968 backslash in front of it. A backslash can be used to prevent any special
8969 character being treated specially in an expansion, including backslash itself.
8970 If the string appears in quotes in the configuration file, two backslashes are
8971 required because the quotes themselves cause interpretation of backslashes when
8972 the string is read in (see section &<<SECTstrings>>&).
8973
8974 .cindex "expansion" "non-expandable substrings"
8975 A portion of the string can specified as non-expandable by placing it between
8976 two occurrences of &`\N`&. This is particularly useful for protecting regular
8977 expressions, which often contain backslashes and dollar signs. For example:
8978 .code
8979 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8980 .endd
8981 On encountering the first &`\N`&, the expander copies subsequent characters
8982 without interpretation until it reaches the next &`\N`& or the end of the
8983 string.
8984
8985
8986
8987 .section "Character escape sequences in expanded strings" "SECID82"
8988 .cindex "expansion" "escape sequences"
8989 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8990 expanded string is recognized as an escape sequence for the character newline,
8991 carriage return, or tab, respectively. A backslash followed by up to three
8992 octal digits is recognized as an octal encoding for a single character, and a
8993 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8994 encoding.
8995
8996 These escape sequences are also recognized in quoted strings when they are read
8997 in. Their interpretation in expansions as well is useful for unquoted strings,
8998 and for other cases such as looked-up strings that are then expanded.
8999
9000
9001 .section "Testing string expansions" "SECID83"
9002 .cindex "expansion" "testing"
9003 .cindex "testing" "string expansion"
9004 .oindex "&%-be%&"
9005 Many expansions can be tested by calling Exim with the &%-be%& option. This
9006 takes the command arguments, or lines from the standard input if there are no
9007 arguments, runs them through the string expansion code, and writes the results
9008 to the standard output. Variables based on configuration values are set up, but
9009 since no message is being processed, variables such as &$local_part$& have no
9010 value. Nevertheless the &%-be%& option can be useful for checking out file and
9011 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9012 and &%nhash%&.
9013
9014 Exim gives up its root privilege when it is called with the &%-be%& option, and
9015 instead runs under the uid and gid it was called with, to prevent users from
9016 using &%-be%& for reading files to which they do not have access.
9017
9018 .oindex "&%-bem%&"
9019 If you want to test expansions that include variables whose values are taken
9020 from a message, there are two other options that can be used. The &%-bem%&
9021 option is like &%-be%& except that it is followed by a file name. The file is
9022 read as a message before doing the test expansions. For example:
9023 .code
9024 exim -bem /tmp/test.message '$h_subject:'
9025 .endd
9026 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9027 Exim message identifier. For example:
9028 .code
9029 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9030 .endd
9031 This loads the message from Exim's spool before doing the test expansions, and
9032 is therefore restricted to admin users.
9033
9034
9035 .section "Forced expansion failure" "SECTforexpfai"
9036 .cindex "expansion" "forced failure"
9037 A number of expansions that are described in the following section have
9038 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9039 (which are sometimes called &"curly brackets"&). Which of the two strings is
9040 used depends on some condition that is evaluated as part of the expansion. If,
9041 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9042 the entire string expansion fails in a way that can be detected by the code
9043 that requested the expansion. This is called &"forced expansion failure"&, and
9044 its consequences depend on the circumstances. In some cases it is no different
9045 from any other expansion failure, but in others a different action may be
9046 taken. Such variations are mentioned in the documentation of the option that is
9047 being expanded.
9048
9049
9050
9051
9052 .section "Expansion items" "SECTexpansionitems"
9053 The following items are recognized in expanded strings. White space may be used
9054 between sub-items that are keywords or substrings enclosed in braces inside an
9055 outer set of braces, to improve readability. &*Warning*&: Within braces,
9056 white space is significant.
9057
9058 .vlist
9059 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9060 .cindex "expansion" "variables"
9061 Substitute the contents of the named variable, for example:
9062 .code
9063 $local_part
9064 ${domain}
9065 .endd
9066 The second form can be used to separate the name from subsequent alphanumeric
9067 characters. This form (using braces) is available only for variables; it does
9068 &'not'& apply to message headers. The names of the variables are given in
9069 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9070 given, the expansion fails.
9071
9072 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9073 .cindex "expansion" "operators"
9074 The string is first itself expanded, and then the operation specified by
9075 <&'op'&> is applied to it. For example:
9076 .code
9077 ${lc:$local_part}
9078 .endd
9079 The string starts with the first character after the colon, which may be
9080 leading white space. A list of operators is given in section &<<SECTexpop>>&
9081 below. The operator notation is used for simple expansion items that have just
9082 one argument, because it reduces the number of braces and therefore makes the
9083 string easier to understand.
9084
9085 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9086 This item inserts &"basic"& header lines. It is described with the &%header%&
9087 expansion item below.
9088
9089
9090 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9091 .cindex "expansion" "calling an acl"
9092 .cindex "&%acl%&" "call from expansion"
9093 The name and zero to nine argument strings are first expanded separately.  The expanded
9094 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9095 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9096 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9097 and may use the variables; if another acl expansion is used the values
9098 are restored after it returns.  If the ACL sets
9099 a value using a "message =" modifier and returns accept or deny, the value becomes
9100 the result of the expansion.
9101 If no message is set and the ACL returns accept or deny
9102 the expansion result is an empty string.
9103 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9104
9105
9106 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9107        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9108 .cindex "expansion" "extracting certificate fields"
9109 .cindex "&%certextract%&" "certificate fields"
9110 .cindex "certificate" "extracting fields"
9111 The <&'certificate'&> must be a variable of type certificate.
9112 The field name is expanded and used to retrieve the relevant field from
9113 the certificate.  Supported fields are:
9114 .display
9115 &`version        `&
9116 &`serial_number  `&
9117 &`subject        `& RFC4514 DN
9118 &`issuer         `& RFC4514 DN
9119 &`notbefore      `& time
9120 &`notafter       `& time
9121 &`sig_algorithm  `&
9122 &`signature      `&
9123 &`subj_altname   `& tagged list
9124 &`ocsp_uri       `& list
9125 &`crl_uri        `& list
9126 .endd
9127 If the field is found,
9128 <&'string2'&> is expanded, and replaces the whole item;
9129 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9130 variable &$value$& contains the value that has been extracted. Afterwards, it
9131 is restored to any previous value it might have had.
9132
9133 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9134 key is not found. If {<&'string2'&>} is also omitted, the value that was
9135 extracted is used.
9136
9137 Some field names take optional modifiers, appended and separated by commas.
9138
9139 The field selectors marked as "RFC4514" above
9140 output a Distinguished Name string which is
9141 not quite
9142 parseable by Exim as a comma-separated tagged list
9143 (the exceptions being elements containing commas).
9144 RDN elements of a single type may be selected by
9145 a modifier of the type label; if so the expansion
9146 result is a list (newline-separated by default).
9147 The separator may be changed by another modifier of
9148 a right angle-bracket followed immediately by the new separator.
9149 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9150
9151 The field selectors marked as "time" above
9152 take an optional modifier of "int"
9153 for which the result is the number of seconds since epoch.
9154 Otherwise the result is a human-readable string
9155 in the timezone selected by the main "timezone" option.
9156
9157 The field selectors marked as "list" above return a list,
9158 newline-separated by default,
9159 (embedded separator characters in elements are doubled).
9160 The separator may be changed by a modifier of
9161 a right angle-bracket followed immediately by the new separator.
9162
9163 The field selectors marked as "tagged" above
9164 prefix each list element with a type string and an equals sign.
9165 Elements of only one type may be selected by a modifier
9166 which is one of "dns", "uri" or "mail";
9167 if so the element tags are omitted.
9168
9169 If not otherwise noted field values are presented in human-readable form.
9170
9171 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9172        {*&<&'arg'&>&*}...}*&"
9173 .cindex &%dlfunc%&
9174 This expansion dynamically loads and then calls a locally-written C function.
9175 This functionality is available only if Exim is compiled with
9176 .code
9177 EXPAND_DLFUNC=yes
9178 .endd
9179 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9180 object so that it doesn't reload the same object file in the same Exim process
9181 (but of course Exim does start new processes frequently).
9182
9183 There may be from zero to eight arguments to the function. When compiling
9184 a local function that is to be called in this way, &_local_scan.h_& should be
9185 included. The Exim variables and functions that are defined by that API
9186 are also available for dynamically loaded functions. The function itself
9187 must have the following type:
9188 .code
9189 int dlfunction(uschar **yield, int argc, uschar *argv[])
9190 .endd
9191 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9192 function should return one of the following values:
9193
9194 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9195 into the expanded string that is being built.
9196
9197 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9198 from &'yield'&, if it is set.
9199
9200 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9201 taken from &'yield'& if it is set.
9202
9203 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9204
9205 When compiling a function that is to be used in this way with gcc,
9206 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9207 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9208
9209
9210 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9211 .cindex "expansion" "extracting value from environment"
9212 .cindex "environment" "values from"
9213 The key is first expanded separately, and leading and trailing white space
9214 removed.
9215 This is then searched for as a name in the environment.
9216 If a variable is found then its value is placed in &$value$&
9217 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9218
9219 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9220 appear, for example:
9221 .code
9222 ${env{USER}{$value} fail }
9223 .endd
9224 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9225 {<&'string1'&>} must be present for &"fail"& to be recognized.
9226
9227 If {<&'string2'&>} is omitted an empty string is substituted on
9228 search failure.
9229 If {<&'string1'&>} is omitted the search result is substituted on
9230 search success.
9231
9232 The environment is adjusted by the &%keep_environment%& and
9233 &%add_environment%& main section options.
9234
9235
9236 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9237        {*&<&'string3'&>&*}}*&"
9238 .cindex "expansion" "extracting substrings by key"
9239 .cindex "&%extract%&" "substrings by key"
9240 The key and <&'string1'&> are first expanded separately. Leading and trailing
9241 white space is removed from the key (but not from any of the strings). The key
9242 must not be empty and must not consist entirely of digits.
9243 The expanded <&'string1'&> must be of the form:
9244 .display
9245 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9246 .endd
9247 .vindex "&$value$&"
9248 where the equals signs and spaces (but not both) are optional. If any of the
9249 values contain white space, they must be enclosed in double quotes, and any
9250 values that are enclosed in double quotes are subject to escape processing as
9251 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9252 for the value that corresponds to the key. The search is case-insensitive. If
9253 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9254 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9255 variable &$value$& contains the value that has been extracted. Afterwards, it
9256 is restored to any previous value it might have had.
9257
9258 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9259 key is not found. If {<&'string2'&>} is also omitted, the value that was
9260 extracted is used. Thus, for example, these two expansions are identical, and
9261 yield &"2001"&:
9262 .code
9263 ${extract{gid}{uid=1984 gid=2001}}
9264 ${extract{gid}{uid=1984 gid=2001}{$value}}
9265 .endd
9266 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9267 appear, for example:
9268 .code
9269 ${extract{Z}{A=... B=...}{$value} fail }
9270 .endd
9271 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9272 {<&'string2'&>} must be present for &"fail"& to be recognized.
9273
9274
9275 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9276         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9277 .cindex "expansion" "extracting substrings by number"
9278 .cindex "&%extract%&" "substrings by number"
9279 The <&'number'&> argument must consist entirely of decimal digits,
9280 apart from leading and trailing white space, which is ignored.
9281 This is what distinguishes this form of &%extract%& from the previous kind. It
9282 behaves in the same way, except that, instead of extracting a named field, it
9283 extracts from <&'string1'&> the field whose number is given as the first
9284 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9285 <&'string3'&> as before.
9286
9287 The fields in the string are separated by any one of the characters in the
9288 separator string. These may include space or tab characters.
9289 The first field is numbered one. If the number is negative, the fields are
9290 counted from the end of the string, with the rightmost one numbered -1. If the
9291 number given is zero, the entire string is returned. If the modulus of the
9292 number is greater than the number of fields in the string, the result is the
9293 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9294 provided. For example:
9295 .code
9296 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9297 .endd
9298 yields &"42"&, and
9299 .code
9300 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9301 .endd
9302 yields &"99"&. Two successive separators mean that the field between them is
9303 empty (for example, the fifth field above).
9304
9305
9306 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9307 .cindex "list" "selecting by condition"
9308 .cindex "expansion" "selecting from list by condition"
9309 .vindex "&$item$&"
9310 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9311 default, but the separator can be changed in the usual way. For each item
9312 in this list, its value is place in &$item$&, and then the condition is
9313 evaluated. If the condition is true, &$item$& is added to the output as an
9314 item in a new list; if the condition is false, the item is discarded. The
9315 separator used for the output list is the same as the one used for the
9316 input, but a separator setting is not included in the output. For example:
9317 .code
9318 ${filter{a:b:c}{!eq{$item}{b}}
9319 .endd
9320 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9321 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9322
9323
9324 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9325 .cindex "hash function" "textual"
9326 .cindex "expansion" "textual hash"
9327 This is a textual hashing function, and was the first to be implemented in
9328 early versions of Exim. In current releases, there are other hashing functions
9329 (numeric, MD5, and SHA-1), which are described below.
9330
9331 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9332 <&'n'&>. If you are using fixed values for these numbers, that is, if
9333 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9334 use the simpler operator notation that avoids some of the braces:
9335 .code
9336 ${hash_<n>_<m>:<string>}
9337 .endd
9338 The second number is optional (in both notations). If <&'n'&> is greater than
9339 or equal to the length of the string, the expansion item returns the string.
9340 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9341 function to the string. The new string consists of characters taken from the
9342 first <&'m'&> characters of the string
9343 .code
9344 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9345 .endd
9346 If <&'m'&> is not present the value 26 is used, so that only lower case
9347 letters appear. For example:
9348 .display
9349 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9350 &`$hash{5}{monty}}           `&   yields  &`monty`&
9351 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9352 .endd
9353
9354 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9355         &*$h_*&<&'header&~name'&>&*:*&" &&&
9356        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9357         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9358        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9359         &*$rh_*&<&'header&~name'&>&*:*&"
9360 .cindex "expansion" "header insertion"
9361 .vindex "&$header_$&"
9362 .vindex "&$bheader_$&"
9363 .vindex "&$rheader_$&"
9364 .cindex "header lines" "in expansion strings"
9365 .cindex "header lines" "character sets"
9366 .cindex "header lines" "decoding"
9367 Substitute the contents of the named message header line, for example
9368 .code
9369 $header_reply-to:
9370 .endd
9371 The newline that terminates a header line is not included in the expansion, but
9372 internal newlines (caused by splitting the header line over several physical
9373 lines) may be present.
9374
9375 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9376 the data in the header line is interpreted.
9377
9378 .ilist
9379 .cindex "white space" "in header lines"
9380 &%rheader%& gives the original &"raw"& content of the header line, with no
9381 processing at all, and without the removal of leading and trailing white space.
9382
9383 .next
9384 .cindex "base64 encoding" "in header lines"
9385 &%bheader%& removes leading and trailing white space, and then decodes base64
9386 or quoted-printable MIME &"words"& within the header text, but does no
9387 character set translation. If decoding of what looks superficially like a MIME
9388 &"word"& fails, the raw string is returned. If decoding
9389 .cindex "binary zero" "in header line"
9390 produces a binary zero character, it is replaced by a question mark &-- this is
9391 what Exim does for binary zeros that are actually received in header lines.
9392
9393 .next
9394 &%header%& tries to translate the string as decoded by &%bheader%& to a
9395 standard character set. This is an attempt to produce the same string as would
9396 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9397 returned. Translation is attempted only on operating systems that support the
9398 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9399 a system Makefile or in &_Local/Makefile_&.
9400 .endlist ilist
9401
9402 In a filter file, the target character set for &%header%& can be specified by a
9403 command of the following form:
9404 .code
9405 headers charset "UTF-8"
9406 .endd
9407 This command affects all references to &$h_$& (or &$header_$&) expansions in
9408 subsequently obeyed filter commands. In the absence of this command, the target
9409 character set in a filter is taken from the setting of the &%headers_charset%&
9410 option in the runtime configuration. The value of this option defaults to the
9411 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9412 ISO-8859-1.
9413
9414 Header names follow the syntax of RFC 2822, which states that they may contain
9415 any printing characters except space and colon. Consequently, curly brackets
9416 &'do not'& terminate header names, and should not be used to enclose them as
9417 if they were variables. Attempting to do so causes a syntax error.
9418
9419 Only header lines that are common to all copies of a message are visible to
9420 this mechanism. These are the original header lines that are received with the
9421 message, and any that are added by an ACL statement or by a system
9422 filter. Header lines that are added to a particular copy of a message by a
9423 router or transport are not accessible.
9424
9425 For incoming SMTP messages, no header lines are visible in
9426 .new
9427 ACLs that are obeyed before the data phase completes,
9428 .wen
9429 because the header structure is not set up until the message is received.
9430 They are visible in DKIM, PRDR and DATA ACLs.
9431 Header lines that are added in a RCPT ACL (for example)
9432 are saved until the message's incoming header lines are available, at which
9433 point they are added.
9434 .new
9435 When any of the above ACLs ar
9436 .wen
9437 running, however, header lines added by earlier ACLs are visible.
9438
9439 Upper case and lower case letters are synonymous in header names. If the
9440 following character is white space, the terminating colon may be omitted, but
9441 this is not recommended, because you may then forget it when it is needed. When
9442 white space terminates the header name, this white space is included in the
9443 expanded string.  If the message does not contain the given header, the
9444 expansion item is replaced by an empty string. (See the &%def%& condition in
9445 section &<<SECTexpcond>>& for a means of testing for the existence of a
9446 header.)
9447
9448 If there is more than one header with the same name, they are all concatenated
9449 to form the substitution string, up to a maximum length of 64K. Unless
9450 &%rheader%& is being used, leading and trailing white space is removed from
9451 each header before concatenation, and a completely empty header is ignored. A
9452 newline character is then inserted between non-empty headers, but there is no
9453 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9454 those headers that contain lists of addresses, a comma is also inserted at the
9455 junctions between headers. This does not happen for the &%rheader%& expansion.
9456
9457
9458 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9459 .cindex "expansion" "hmac hashing"
9460 .cindex &%hmac%&
9461 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9462 shared secret and some text into a message authentication code, as specified in
9463 RFC 2104. This differs from &`${md5:secret_text...}`& or
9464 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9465 cryptographic hash, allowing for authentication that is not possible with MD5
9466 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9467 present. For example:
9468 .code
9469 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9470 .endd
9471 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9472 produces:
9473 .code
9474 dd97e3ba5d1a61b5006108f8c8252953
9475 .endd
9476 As an example of how this might be used, you might put in the main part of
9477 an Exim configuration:
9478 .code
9479 SPAMSCAN_SECRET=cohgheeLei2thahw
9480 .endd
9481 In a router or a transport you could then have:
9482 .code
9483 headers_add = \
9484   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9485   ${hmac{md5}{SPAMSCAN_SECRET}\
9486   {${primary_hostname},${message_exim_id},$h_message-id:}}
9487 .endd
9488 Then given a message, you can check where it was scanned by looking at the
9489 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9490 this header line is authentic by recomputing the authentication code from the
9491 host name, message ID and the &'Message-id:'& header line. This can be done
9492 using Exim's &%-be%& option, or by other means, for example by using the
9493 &'hmac_md5_hex()'& function in Perl.
9494
9495
9496 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9497 .cindex "expansion" "conditional"
9498 .cindex "&%if%&, expansion item"
9499 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9500 item; otherwise <&'string2'&> is used. The available conditions are described
9501 in section &<<SECTexpcond>>& below. For example:
9502 .code
9503 ${if eq {$local_part}{postmaster} {yes}{no} }
9504 .endd
9505 The second string need not be present; if it is not and the condition is not
9506 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9507 be present instead of the second string (without any curly brackets). In this
9508 case, the expansion is forced to fail if the condition is not true (see section
9509 &<<SECTforexpfai>>&).
9510
9511 If both strings are omitted, the result is the string &`true`& if the condition
9512 is true, and the empty string if the condition is false. This makes it less
9513 cumbersome to write custom ACL and router conditions. For example, instead of
9514 .code
9515 condition = ${if >{$acl_m4}{3}{true}{false}}
9516 .endd
9517 you can use
9518 .code
9519 condition = ${if >{$acl_m4}{3}}
9520 .endd
9521
9522
9523
9524 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9525 .cindex expansion "imap folder"
9526 .cindex "&%imapfolder%& expansion item"
9527 This item converts a (possibly multilevel, or with non-ASCII characters)
9528 folder specification to a Maildir name for filesystem use.
9529 For information on internationalisation support see &<<SECTi18nMDA>>&.
9530
9531
9532
9533 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9534 .cindex "expansion" "string truncation"
9535 .cindex "&%length%& expansion item"
9536 The &%length%& item is used to extract the initial portion of a string. Both
9537 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9538 you are using a fixed value for the number, that is, if <&'string1'&> does not
9539 change when expanded, you can use the simpler operator notation that avoids
9540 some of the braces:
9541 .code
9542 ${length_<n>:<string>}
9543 .endd
9544 The result of this item is either the first <&'n'&> characters or the whole
9545 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9546 &%strlen%&, which gives the length of a string.
9547
9548
9549 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9550         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9551 .cindex "expansion" "extracting list elements by number"
9552 .cindex "&%listextract%&" "extract list elements by number"
9553 .cindex "list" "extracting elements by number"
9554 The <&'number'&> argument must consist entirely of decimal digits,
9555 apart from an optional leading minus,
9556 and leading and trailing white space (which is ignored).
9557
9558 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9559 default, but the separator can be changed in the usual way.
9560
9561 The first field of the list is numbered one.
9562 If the number is negative, the fields are
9563 counted from the end of the list, with the rightmost one numbered -1.
9564 The numbered element of the list is extracted and placed in &$value$&,
9565 then <&'string2'&> is expanded as the result.
9566
9567 If the modulus of the
9568 number is zero or greater than the number of fields in the string,
9569 the result is the expansion of <&'string3'&>.
9570
9571 For example:
9572 .code
9573 ${listextract{2}{x:42:99}}
9574 .endd
9575 yields &"42"&, and
9576 .code
9577 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9578 .endd
9579 yields &"result: 42"&.
9580
9581 If {<&'string3'&>} is omitted, an empty string is used for string3.
9582 If {<&'string2'&>} is also omitted, the value that was
9583 extracted is used.
9584 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9585
9586
9587 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9588         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9589 This is the first of one of two different types of lookup item, which are both
9590 described in the next item.
9591
9592 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9593         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9594 .cindex "expansion" "lookup in"
9595 .cindex "file" "lookups"
9596 .cindex "lookup" "in expanded string"
9597 The two forms of lookup item specify data lookups in files and databases, as
9598 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9599 lookups, and the second is used for query-style lookups. The <&'key'&>,
9600 <&'file'&>, and <&'query'&> strings are expanded before use.
9601
9602 If there is any white space in a lookup item which is part of a filter command,
9603 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9604 other place where white space is significant, the lookup item must be enclosed
9605 in double quotes. The use of data lookups in users' filter files may be locked
9606 out by the system administrator.
9607
9608 .vindex "&$value$&"
9609 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9610 During its expansion, the variable &$value$& contains the data returned by the
9611 lookup. Afterwards it reverts to the value it had previously (at the outer
9612 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9613 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9614 string on failure. If <&'string2'&> is provided, it can itself be a nested
9615 lookup, thus providing a mechanism for looking up a default value when the
9616 original lookup fails.
9617
9618 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9619 data for the outer lookup while the parameters of the second lookup are
9620 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9621 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9622 appear, and in this case, if the lookup fails, the entire expansion is forced
9623 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9624 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9625 successful lookup, and nothing in the case of failure.
9626
9627 For single-key lookups, the string &"partial"& is permitted to precede the
9628 search type in order to do partial matching, and * or *@ may follow a search
9629 type to request default lookups if the key does not match (see sections
9630 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9631
9632 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9633 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9634 and non-wild parts of the key during the expansion of the replacement text.
9635 They return to their previous values at the end of the lookup item.
9636
9637 This example looks up the postmaster alias in the conventional alias file:
9638 .code
9639 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9640 .endd
9641 This example uses NIS+ to look up the full name of the user corresponding to
9642 the local part of an address, forcing the expansion to fail if it is not found:
9643 .code
9644 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9645   {$value}fail}
9646 .endd
9647
9648
9649 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9650 .cindex "expansion" "list creation"
9651 .vindex "&$item$&"
9652 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9653 default, but the separator can be changed in the usual way. For each item
9654 in this list, its value is place in &$item$&, and then <&'string2'&> is
9655 expanded and added to the output as an item in a new list. The separator used
9656 for the output list is the same as the one used for the input, but a separator
9657 setting is not included in the output. For example:
9658 .code
9659 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9660 .endd
9661 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9662 value of &$item$& is restored to what it was before. See also the &*filter*&
9663 and &*reduce*& expansion items.
9664
9665 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9666 .cindex "expansion" "numeric hash"
9667 .cindex "hash function" "numeric"
9668 The three strings are expanded; the first two must yield numbers. Call them
9669 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9670 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9671 can use the simpler operator notation that avoids some of the braces:
9672 .code
9673 ${nhash_<n>_<m>:<string>}
9674 .endd
9675 The second number is optional (in both notations). If there is only one number,
9676 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9677 processed by a div/mod hash function that returns two numbers, separated by a
9678 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9679 example,
9680 .code
9681 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9682 .endd
9683 returns the string &"6/33"&.
9684
9685
9686
9687 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9688 .cindex "Perl" "use in expanded string"
9689 .cindex "expansion" "calling Perl from"
9690 This item is available only if Exim has been built to include an embedded Perl
9691 interpreter. The subroutine name and the arguments are first separately
9692 expanded, and then the Perl subroutine is called with those arguments. No
9693 additional arguments need be given; the maximum number permitted, including the
9694 name of the subroutine, is nine.
9695
9696 The return value of the subroutine is inserted into the expanded string, unless
9697 the return value is &%undef%&. In that case, the expansion fails in the same
9698 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9699 Whatever you return is evaluated in a scalar context. For example, if you
9700 return the name of a Perl vector, the return value is the size of the vector,
9701 not its contents.
9702
9703 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9704 with the error message that was passed to &%die%&. More details of the embedded
9705 Perl facility are given in chapter &<<CHAPperl>>&.
9706
9707 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9708 out the use of this expansion item in filter files.
9709
9710
9711 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9712 .cindex "&%prvs%& expansion item"
9713 The first argument is a complete email address and the second is secret
9714 keystring. The third argument, specifying a key number, is optional. If absent,
9715 it defaults to 0. The result of the expansion is a prvs-signed email address,
9716 to be typically used with the &%return_path%& option on an &(smtp)& transport
9717 as part of a bounce address tag validation (BATV) scheme. For more discussion
9718 and an example, see section &<<SECTverifyPRVS>>&.
9719
9720 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9721         {*&<&'string'&>&*}}*&"
9722 .cindex "&%prvscheck%& expansion item"
9723 This expansion item is the complement of the &%prvs%& item. It is used for
9724 checking prvs-signed addresses. If the expansion of the first argument does not
9725 yield a syntactically valid prvs-signed address, the whole item expands to the
9726 empty string. When the first argument does expand to a syntactically valid
9727 prvs-signed address, the second argument is expanded, with the prvs-decoded
9728 version of the address and the key number extracted from the address in the
9729 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9730
9731 These two variables can be used in the expansion of the second argument to
9732 retrieve the secret. The validity of the prvs-signed address is then checked
9733 against the secret. The result is stored in the variable &$prvscheck_result$&,
9734 which is empty for failure or &"1"& for success.
9735
9736 The third argument is optional; if it is missing, it defaults to an empty
9737 string. This argument is now expanded. If the result is an empty string, the
9738 result of the expansion is the decoded version of the address. This is the case
9739 whether or not the signature was valid. Otherwise, the result of the expansion
9740 is the expansion of the third argument.
9741
9742 All three variables can be used in the expansion of the third argument.
9743 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9744 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9745
9746 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9747 .cindex "expansion" "inserting an entire file"
9748 .cindex "file" "inserting into expansion"
9749 .cindex "&%readfile%& expansion item"
9750 The file name and end-of-line string are first expanded separately. The file is
9751 then read, and its contents replace the entire item. All newline characters in
9752 the file are replaced by the end-of-line string if it is present. Otherwise,
9753 newlines are left in the string.
9754 String expansion is not applied to the contents of the file. If you want this,
9755 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9756 the string expansion fails.
9757
9758 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9759 locks out the use of this expansion item in filter files.
9760
9761
9762
9763 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9764         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9765 .cindex "expansion" "inserting from a socket"
9766 .cindex "socket, use of in expansion"
9767 .cindex "&%readsocket%& expansion item"
9768 This item inserts data from a Unix domain or TCP socket into the expanded
9769 string. The minimal way of using it uses just two arguments, as in these
9770 examples:
9771 .code
9772 ${readsocket{/socket/name}{request string}}
9773 ${readsocket{inet:some.host:1234}{request string}}
9774 .endd
9775 For a Unix domain socket, the first substring must be the path to the socket.
9776 For an Internet socket, the first substring must contain &`inet:`& followed by
9777 a host name or IP address, followed by a colon and a port, which can be a
9778 number or the name of a TCP port in &_/etc/services_&. An IP address may
9779 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9780 example:
9781 .code
9782 ${readsocket{inet:[::1]:1234}{request string}}
9783 .endd
9784 Only a single host name may be given, but if looking it up yields more than
9785 one IP address, they are each tried in turn until a connection is made. For
9786 both kinds of socket, Exim makes a connection, writes the request string
9787 unless it is an empty string; and no terminating NUL is ever sent)
9788 and reads from the socket until an end-of-file
9789 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9790 extend what can be done. Firstly, you can vary the timeout. For example:
9791 .code
9792 ${readsocket{/socket/name}{request string}{3s}}
9793 .endd
9794 A fourth argument allows you to change any newlines that are in the data
9795 that is read, in the same way as for &%readfile%& (see above). This example
9796 turns them into spaces:
9797 .code
9798 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9799 .endd
9800 As with all expansions, the substrings are expanded before the processing
9801 happens. Errors in these sub-expansions cause the expansion to fail. In
9802 addition, the following errors can occur:
9803
9804 .ilist
9805 Failure to create a socket file descriptor;
9806 .next
9807 Failure to connect the socket;
9808 .next
9809 Failure to write the request string;
9810 .next
9811 Timeout on reading from the socket.
9812 .endlist
9813
9814 By default, any of these errors causes the expansion to fail. However, if
9815 you supply a fifth substring, it is expanded and used when any of the above
9816 errors occurs. For example:
9817 .code
9818 ${readsocket{/socket/name}{request string}{3s}{\n}\
9819   {socket failure}}
9820 .endd
9821 You can test for the existence of a Unix domain socket by wrapping this
9822 expansion in &`${if exists`&, but there is a race condition between that test
9823 and the actual opening of the socket, so it is safer to use the fifth argument
9824 if you want to be absolutely sure of avoiding an expansion error for a
9825 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9826
9827 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9828 locks out the use of this expansion item in filter files.
9829
9830
9831 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9832 .cindex "expansion" "reducing a list to a scalar"
9833 .cindex "list" "reducing to a scalar"
9834 .vindex "&$value$&"
9835 .vindex "&$item$&"
9836 This operation reduces a list to a single, scalar string. After expansion,
9837 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9838 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9839 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9840 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9841 them. The result of that expansion is assigned to &$value$& before the next
9842 iteration. When the end of the list is reached, the final value of &$value$& is
9843 added to the expansion output. The &*reduce*& expansion item can be used in a
9844 number of ways. For example, to add up a list of numbers:
9845 .code
9846 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9847 .endd
9848 The result of that expansion would be &`6`&. The maximum of a list of numbers
9849 can be found:
9850 .code
9851 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9852 .endd
9853 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9854 restored to what they were before. See also the &*filter*& and &*map*&
9855 expansion items.
9856
9857 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9858 This item inserts &"raw"& header lines. It is described with the &%header%&
9859 expansion item above.
9860
9861 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9862         {*&<&'string2'&>&*}}*&"
9863 .cindex "expansion" "running a command"
9864 .cindex "&%run%& expansion item"
9865 The command and its arguments are first expanded as one string. The string is
9866 split apart into individual arguments by spaces, and then the command is run
9867 in a separate process, but under the same uid and gid.  As in other command
9868 executions from Exim, a shell is not used by default. If the command requires
9869 a shell, you must explicitly code it.
9870
9871 Since the arguments are split by spaces, when there is a variable expansion
9872 which has an empty result, it will cause the situation that the argument will
9873 simply be omitted when the program is actually executed by Exim. If the
9874 script/program requires a specific number of arguments and the expanded
9875 variable could possibly result in this empty expansion, the variable must be
9876 quoted. This is more difficult if the expanded variable itself could result
9877 in a string containing quotes, because it would interfere with the quotes
9878 around the command arguments. A possible guard against this is to wrap the
9879 variable in the &%sg%& operator to change any quote marks to some other
9880 character.
9881
9882 The standard input for the command exists, but is empty. The standard output
9883 and standard error are set to the same file descriptor.
9884 .cindex "return code" "from &%run%& expansion"
9885 .vindex "&$value$&"
9886 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9887 and replaces the entire item; during this expansion, the standard output/error
9888 from the command is in the variable &$value$&. If the command fails,
9889 <&'string2'&>, if present, is expanded and used. Once again, during the
9890 expansion, the standard output/error from the command is in the variable
9891 &$value$&.
9892
9893 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9894 can be the word &"fail"& (not in braces) to force expansion failure if the
9895 command does not succeed. If both strings are omitted, the result is contents
9896 of the standard output/error on success, and nothing on failure.
9897
9898 .vindex "&$run_in_acl$&"
9899 The standard output/error of the command is put in the variable &$value$&.
9900 In this ACL example, the output of a command is logged for the admin to
9901 troubleshoot:
9902 .code
9903 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9904       log_message  = Output of id: $value
9905 .endd
9906 If the command requires shell idioms, such as the > redirect operator, the
9907 shell must be invoked directly, such as with:
9908 .code
9909 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9910 .endd
9911
9912 .vindex "&$runrc$&"
9913 The return code from the command is put in the variable &$runrc$&, and this
9914 remains set afterwards, so in a filter file you can do things like this:
9915 .code
9916 if "${run{x y z}{}}$runrc" is 1 then ...
9917   elif $runrc is 2 then ...
9918   ...
9919 endif
9920 .endd
9921 If execution of the command fails (for example, the command does not exist),
9922 the return code is 127 &-- the same code that shells use for non-existent
9923 commands.
9924
9925 &*Warning*&: In a router or transport, you cannot assume the order in which
9926 option values are expanded, except for those preconditions whose order of
9927 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9928 by the expansion of one option, and use it in another.
9929
9930 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9931 out the use of this expansion item in filter files.
9932
9933
9934 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9935 .cindex "expansion" "string substitution"
9936 .cindex "&%sg%& expansion item"
9937 This item works like Perl's substitution operator (s) with the global (/g)
9938 option; hence its name. However, unlike the Perl equivalent, Exim does not
9939 modify the subject string; instead it returns the modified string for insertion
9940 into the overall expansion. The item takes three arguments: the subject string,
9941 a regular expression, and a substitution string. For example:
9942 .code
9943 ${sg{abcdefabcdef}{abc}{xyz}}
9944 .endd
9945 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9946 if any $ or \ characters are required in the regular expression or in the
9947 substitution string, they have to be escaped. For example:
9948 .code
9949 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9950 .endd
9951 yields &"defabc"&, and
9952 .code
9953 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9954 .endd
9955 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9956 the regular expression from string expansion.
9957
9958
9959
9960 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9961 .cindex sorting "a list"
9962 .cindex list sorting
9963 .cindex expansion "list sorting"
9964 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9965 default, but the separator can be changed in the usual way.
9966 The <&'comparator'&> argument is interpreted as the operator
9967 of a two-argument expansion condition.
9968 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9969 The comparison should return true when applied to two values
9970 if the first value should sort before the second value.
9971 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9972 the element being placed in &$item$&,
9973 to give values for comparison.
9974
9975 The item result is a sorted list,
9976 with the original list separator,
9977 of the list elements (in full) of the original.
9978
9979 Examples:
9980 .code
9981 ${sort{3:2:1:4}{<}{$item}}
9982 .endd
9983 sorts a list of numbers, and
9984 .code
9985 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9986 .endd
9987 will sort an MX lookup into priority order.
9988
9989
9990 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9991 .cindex "&%substr%& expansion item"
9992 .cindex "substring extraction"
9993 .cindex "expansion" "substring extraction"
9994 The three strings are expanded; the first two must yield numbers. Call them
9995 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9996 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9997 can use the simpler operator notation that avoids some of the braces:
9998 .code
9999 ${substr_<n>_<m>:<string>}
10000 .endd
10001 The second number is optional (in both notations).
10002 If it is absent in the simpler format, the preceding underscore must also be
10003 omitted.
10004
10005 The &%substr%& item can be used to extract more general substrings than
10006 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10007 length required. For example
10008 .code
10009 ${substr{3}{2}{$local_part}}
10010 .endd
10011 If the starting offset is greater than the string length the result is the
10012 null string; if the length plus starting offset is greater than the string
10013 length, the result is the right-hand part of the string, starting from the
10014 given offset. The first character in the string has offset zero.
10015
10016 The &%substr%& expansion item can take negative offset values to count
10017 from the right-hand end of its operand. The last character is offset -1, the
10018 second-last is offset -2, and so on. Thus, for example,
10019 .code
10020 ${substr{-5}{2}{1234567}}
10021 .endd
10022 yields &"34"&. If the absolute value of a negative offset is greater than the
10023 length of the string, the substring starts at the beginning of the string, and
10024 the length is reduced by the amount of overshoot. Thus, for example,
10025 .code
10026 ${substr{-5}{2}{12}}
10027 .endd
10028 yields an empty string, but
10029 .code
10030 ${substr{-3}{2}{12}}
10031 .endd
10032 yields &"1"&.
10033
10034 When the second number is omitted from &%substr%&, the remainder of the string
10035 is taken if the offset is positive. If it is negative, all characters in the
10036 string preceding the offset point are taken. For example, an offset of -1 and
10037 no length, as in these semantically identical examples:
10038 .code
10039 ${substr_-1:abcde}
10040 ${substr{-1}{abcde}}
10041 .endd
10042 yields all but the last character of the string, that is, &"abcd"&.
10043
10044
10045
10046 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10047         {*&<&'replacements'&>&*}}*&"
10048 .cindex "expansion" "character translation"
10049 .cindex "&%tr%& expansion item"
10050 This item does single-character translation on its subject string. The second
10051 argument is a list of characters to be translated in the subject string. Each
10052 matching character is replaced by the corresponding character from the
10053 replacement list. For example
10054 .code
10055 ${tr{abcdea}{ac}{13}}
10056 .endd
10057 yields &`1b3de1`&. If there are duplicates in the second character string, the
10058 last occurrence is used. If the third string is shorter than the second, its
10059 last character is replicated. However, if it is empty, no translation takes
10060 place.
10061 .endlist
10062
10063
10064
10065 .section "Expansion operators" "SECTexpop"
10066 .cindex "expansion" "operators"
10067 For expansion items that perform transformations on a single argument string,
10068 the &"operator"& notation is used because it is simpler and uses fewer braces.
10069 The substring is first expanded before the operation is applied to it. The
10070 following operations can be performed:
10071
10072 .vlist
10073 .vitem &*${address:*&<&'string'&>&*}*&
10074 .cindex "expansion" "RFC 2822 address handling"
10075 .cindex "&%address%& expansion item"
10076 The string is interpreted as an RFC 2822 address, as it might appear in a
10077 header line, and the effective address is extracted from it. If the string does
10078 not parse successfully, the result is empty.
10079
10080
10081 .vitem &*${addresses:*&<&'string'&>&*}*&
10082 .cindex "expansion" "RFC 2822 address handling"
10083 .cindex "&%addresses%& expansion item"
10084 The string (after expansion) is interpreted as a list of addresses in RFC
10085 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10086 operative address (&'local-part@domain'&) is extracted from each item, and the
10087 result of the expansion is a colon-separated list, with appropriate
10088 doubling of colons should any happen to be present in the email addresses.
10089 Syntactically invalid RFC2822 address items are omitted from the output.
10090
10091 It is possible to specify a character other than colon for the output
10092 separator by starting the string with > followed by the new separator
10093 character. For example:
10094 .code
10095 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10096 .endd
10097 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10098 expansion item, which extracts the working address from a single RFC2822
10099 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10100 processing lists.
10101
10102 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10103 a strict interpretation of header line formatting.  Exim parses the bare,
10104 unquoted portion of an email address and if it finds a comma, treats it as an
10105 email address separator. For the example header line:
10106 .code
10107 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10108 .endd
10109 The first example below demonstrates that Q-encoded email addresses are parsed
10110 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10111 It does not see the comma because it's still encoded as "=2C".  The second
10112 example below is passed the contents of &`$header_from:`&, meaning it gets
10113 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10114 The third example shows that the presence of a comma is skipped when it is
10115 quoted.
10116 .code
10117 # exim -be '${addresses:From: \
10118 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10119 user@example.com
10120 # exim -be '${addresses:From: Last, First <user@example.com>}'
10121 Last:user@example.com
10122 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10123 user@example.com
10124 .endd
10125
10126 .vitem &*${base32:*&<&'digits'&>&*}*&
10127 .cindex "&%base32%& expansion item"
10128 .cindex "expansion" "conversion to base 32"
10129 The string must consist entirely of decimal digits. The number is converted to
10130 base 32 and output as a (empty, for zero) string of characters.
10131 Only lowercase letters are used.
10132
10133 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10134 .cindex "&%base32d%& expansion item"
10135 .cindex "expansion" "conversion to base 32"
10136 The string must consist entirely of base-32 digits.
10137 The number is converted to decimal and output as a string.
10138
10139 .vitem &*${base62:*&<&'digits'&>&*}*&
10140 .cindex "&%base62%& expansion item"
10141 .cindex "expansion" "conversion to base 62"
10142 The string must consist entirely of decimal digits. The number is converted to
10143 base 62 and output as a string of six characters, including leading zeros. In
10144 the few operating environments where Exim uses base 36 instead of base 62 for
10145 its message identifiers (because those systems do not have case-sensitive file
10146 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10147 be absolutely clear: this is &'not'& base64 encoding.
10148
10149 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10150 .cindex "&%base62d%& expansion item"
10151 .cindex "expansion" "conversion to base 62"
10152 The string must consist entirely of base-62 digits, or, in operating
10153 environments where Exim uses base 36 instead of base 62 for its message
10154 identifiers, base-36 digits. The number is converted to decimal and output as a
10155 string.
10156
10157 .vitem &*${base64:*&<&'string'&>&*}*&
10158 .cindex "expansion" "base64 encoding"
10159 .cindex "base64 encoding" "in string expansion"
10160 .cindex "&%base64%& expansion item"
10161 .cindex certificate "base64 of DER"
10162 This operator converts a string into one that is base64 encoded.
10163
10164 If the string is a single variable of type certificate,
10165 returns the base64 encoding of the DER form of the certificate.
10166
10167
10168 .vitem &*${base64d:*&<&'string'&>&*}*&
10169 .cindex "expansion" "base64 decoding"
10170 .cindex "base64 decoding" "in string expansion"
10171 .cindex "&%base64d%& expansion item"
10172 This operator converts a base64-encoded string into the un-coded form.
10173
10174
10175 .vitem &*${domain:*&<&'string'&>&*}*&
10176 .cindex "domain" "extraction"
10177 .cindex "expansion" "domain extraction"
10178 The string is interpreted as an RFC 2822 address and the domain is extracted
10179 from it. If the string does not parse successfully, the result is empty.
10180
10181
10182 .vitem &*${escape:*&<&'string'&>&*}*&
10183 .cindex "expansion" "escaping non-printing characters"
10184 .cindex "&%escape%& expansion item"
10185 If the string contains any non-printing characters, they are converted to
10186 escape sequences starting with a backslash. Whether characters with the most
10187 significant bit set (so-called &"8-bit characters"&) count as printing or not
10188 is controlled by the &%print_topbitchars%& option.
10189
10190 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10191 .cindex "expansion" "escaping 8-bit characters"
10192 .cindex "&%escape8bit%& expansion item"
10193 If the string contains and characters with the most significant bit set,
10194 they are converted to escape sequences starting with a backslash.
10195 Backslashes and DEL characters are also converted.
10196
10197
10198 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10199 .cindex "expansion" "expression evaluation"
10200 .cindex "expansion" "arithmetic expression"
10201 .cindex "&%eval%& expansion item"
10202 These items supports simple arithmetic and bitwise logical operations in
10203 expansion strings. The string (after expansion) must be a conventional
10204 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10205 logical operators, and parentheses. All operations are carried out using
10206 integer arithmetic. The operator priorities are as follows (the same as in the
10207 C programming language):
10208 .table2 70pt 300pt
10209 .irow &'highest:'& "not (~), negate (-)"
10210 .irow ""   "multiply (*), divide (/), remainder (%)"
10211 .irow ""   "plus (+), minus (-)"
10212 .irow ""   "shift-left (<<), shift-right (>>)"
10213 .irow ""   "and (&&)"
10214 .irow ""   "xor (^)"
10215 .irow &'lowest:'&  "or (|)"
10216 .endtable
10217 Binary operators with the same priority are evaluated from left to right. White
10218 space is permitted before or after operators.
10219
10220 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10221 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10222 decimal, even if they start with a leading zero; hexadecimal numbers are not
10223 permitted. This can be useful when processing numbers extracted from dates or
10224 times, which often do have leading zeros.
10225
10226 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10227 or 1024*1024*1024,
10228 respectively. Negative numbers are supported. The result of the computation is
10229 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10230
10231 .display
10232 &`${eval:1+1}            `&  yields 2
10233 &`${eval:1+2*3}          `&  yields 7
10234 &`${eval:(1+2)*3}        `&  yields 9
10235 &`${eval:2+42%5}         `&  yields 4
10236 &`${eval:0xc&amp;5}          `&  yields 4
10237 &`${eval:0xc|5}          `&  yields 13
10238 &`${eval:0xc^5}          `&  yields 9
10239 &`${eval:0xc>>1}         `&  yields 6
10240 &`${eval:0xc<<1}         `&  yields 24
10241 &`${eval:~255&amp;0x1234}    `&  yields 4608
10242 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10243 .endd
10244
10245 As a more realistic example, in an ACL you might have
10246 .code
10247 deny   message = Too many bad recipients
10248        condition =                    \
10249          ${if and {                   \
10250            {>{$rcpt_count}{10}}       \
10251            {                          \
10252            <                          \
10253              {$recipients_count}      \
10254              {${eval:$rcpt_count/2}}  \
10255            }                          \
10256          }{yes}{no}}
10257 .endd
10258 The condition is true if there have been more than 10 RCPT commands and
10259 fewer than half of them have resulted in a valid recipient.
10260
10261
10262 .vitem &*${expand:*&<&'string'&>&*}*&
10263 .cindex "expansion" "re-expansion of substring"
10264 The &%expand%& operator causes a string to be expanded for a second time. For
10265 example,
10266 .code
10267 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10268 .endd
10269 first looks up a string in a file while expanding the operand for &%expand%&,
10270 and then re-expands what it has found.
10271
10272
10273 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10274 .cindex "Unicode"
10275 .cindex "UTF-8" "conversion from"
10276 .cindex "expansion" "UTF-8 conversion"
10277 .cindex "&%from_utf8%& expansion item"
10278 The world is slowly moving towards Unicode, although there are no standards for
10279 email yet. However, other applications (including some databases) are starting
10280 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10281 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10282 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10283 the result is an undefined sequence of bytes.
10284
10285 Unicode code points with values less than 256 are compatible with ASCII and
10286 ISO-8859-1 (also known as Latin-1).
10287 For example, character 169 is the copyright symbol in both cases, though the
10288 way it is encoded is different. In UTF-8, more than one byte is needed for
10289 characters with code values greater than 127, whereas ISO-8859-1 is a
10290 single-byte encoding (but thereby limited to 256 characters). This makes
10291 translation from UTF-8 to ISO-8859-1 straightforward.
10292
10293
10294 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10295 .cindex "hash function" "textual"
10296 .cindex "expansion" "textual hash"
10297 The &%hash%& operator is a simpler interface to the hashing function that can
10298 be used when the two parameters are fixed numbers (as opposed to strings that
10299 change when expanded). The effect is the same as
10300 .code
10301 ${hash{<n>}{<m>}{<string>}}
10302 .endd
10303 See the description of the general &%hash%& item above for details. The
10304 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10305
10306
10307
10308 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10309 .cindex "base64 encoding" "conversion from hex"
10310 .cindex "expansion" "hex to base64"
10311 .cindex "&%hex2b64%& expansion item"
10312 This operator converts a hex string into one that is base64 encoded. This can
10313 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10314
10315
10316
10317 .vitem &*${hexquote:*&<&'string'&>&*}*&
10318 .cindex "quoting" "hex-encoded unprintable characters"
10319 .cindex "&%hexquote%& expansion item"
10320 This operator converts non-printable characters in a string into a hex
10321 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10322 as is, and other byte values are converted to &`\xNN`&, for example a
10323 byte value 127 is converted to &`\x7f`&.
10324
10325
10326 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10327 .cindex "&%ipv6denorm%& expansion item"
10328 .cindex "IP address" normalisation
10329 This expands an IPv6 address to a full eight-element colon-separated set
10330 of hex digits including leading zeroes.
10331 A trailing ipv4-style dotted-decimal set is converted to hex.
10332 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10333
10334 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10335 .cindex "&%ipv6norm%& expansion item"
10336 .cindex "IP address" normalisation
10337 .cindex "IP address" "canonical form"
10338 This converts an IPv6 address to canonical form.
10339 Leading zeroes of groups are omitted, and the longest
10340 set of zero-valued groups is replaced with a double colon.
10341 A trailing ipv4-style dotted-decimal set is converted to hex.
10342 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10343
10344
10345 .vitem &*${lc:*&<&'string'&>&*}*&
10346 .cindex "case forcing in strings"
10347 .cindex "string" "case forcing"
10348 .cindex "lower casing"
10349 .cindex "expansion" "case forcing"
10350 .cindex "&%lc%& expansion item"
10351 This forces the letters in the string into lower-case, for example:
10352 .code
10353 ${lc:$local_part}
10354 .endd
10355
10356 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10357 .cindex "expansion" "string truncation"
10358 .cindex "&%length%& expansion item"
10359 The &%length%& operator is a simpler interface to the &%length%& function that
10360 can be used when the parameter is a fixed number (as opposed to a string that
10361 changes when expanded). The effect is the same as
10362 .code
10363 ${length{<number>}{<string>}}
10364 .endd
10365 See the description of the general &%length%& item above for details. Note that
10366 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10367 when &%length%& is used as an operator.
10368
10369
10370 .vitem &*${listcount:*&<&'string'&>&*}*&
10371 .cindex "expansion" "list item count"
10372 .cindex "list" "item count"
10373 .cindex "list" "count of items"
10374 .cindex "&%listcount%& expansion item"
10375 The string is interpreted as a list and the number of items is returned.
10376
10377
10378 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10379 .cindex "expansion" "named list"
10380 .cindex "&%listnamed%& expansion item"
10381 The name is interpreted as a named list and the content of the list is returned,
10382 expanding any referenced lists, re-quoting as needed for colon-separation.
10383 If the optional type is given it must be one of "a", "d", "h" or "l"
10384 and selects address-, domain-, host- or localpart- lists to search among respectively.
10385 Otherwise all types are searched in an undefined order and the first
10386 matching list is returned.
10387
10388
10389 .vitem &*${local_part:*&<&'string'&>&*}*&
10390 .cindex "expansion" "local part extraction"
10391 .cindex "&%local_part%& expansion item"
10392 The string is interpreted as an RFC 2822 address and the local part is
10393 extracted from it. If the string does not parse successfully, the result is
10394 empty.
10395
10396
10397 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10398 .cindex "masked IP address"
10399 .cindex "IP address" "masking"
10400 .cindex "CIDR notation"
10401 .cindex "expansion" "IP address masking"
10402 .cindex "&%mask%& expansion item"
10403 If the form of the string to be operated on is not an IP address followed by a
10404 slash and an integer (that is, a network address in CIDR notation), the
10405 expansion fails. Otherwise, this operator converts the IP address to binary,
10406 masks off the least significant bits according to the bit count, and converts
10407 the result back to text, with mask appended. For example,
10408 .code
10409 ${mask:10.111.131.206/28}
10410 .endd
10411 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10412 be mostly used for looking up masked addresses in files, the result for an IPv6
10413 address uses dots to separate components instead of colons, because colon
10414 terminates a key string in lsearch files. So, for example,
10415 .code
10416 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10417 .endd
10418 returns the string
10419 .code
10420 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10421 .endd
10422 Letters in IPv6 addresses are always output in lower case.
10423
10424
10425 .vitem &*${md5:*&<&'string'&>&*}*&
10426 .cindex "MD5 hash"
10427 .cindex "expansion" "MD5 hash"
10428 .cindex certificate fingerprint
10429 .cindex "&%md5%& expansion item"
10430 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10431 as a 32-digit hexadecimal number, in which any letters are in lower case.
10432
10433 If the string is a single variable of type certificate,
10434 returns the MD5 hash fingerprint of the certificate.
10435
10436
10437 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10438 .cindex "expansion" "numeric hash"
10439 .cindex "hash function" "numeric"
10440 The &%nhash%& operator is a simpler interface to the numeric hashing function
10441 that can be used when the two parameters are fixed numbers (as opposed to
10442 strings that change when expanded). The effect is the same as
10443 .code
10444 ${nhash{<n>}{<m>}{<string>}}
10445 .endd
10446 See the description of the general &%nhash%& item above for details.
10447
10448
10449 .vitem &*${quote:*&<&'string'&>&*}*&
10450 .cindex "quoting" "in string expansions"
10451 .cindex "expansion" "quoting"
10452 .cindex "&%quote%& expansion item"
10453 The &%quote%& operator puts its argument into double quotes if it
10454 is an empty string or
10455 contains anything other than letters, digits, underscores, dots, and hyphens.
10456 Any occurrences of double quotes and backslashes are escaped with a backslash.
10457 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10458 respectively For example,
10459 .code
10460 ${quote:ab"*"cd}
10461 .endd
10462 becomes
10463 .code
10464 "ab\"*\"cd"
10465 .endd
10466 The place where this is useful is when the argument is a substitution from a
10467 variable or a message header.
10468
10469 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10470 .cindex "&%quote_local_part%& expansion item"
10471 This operator is like &%quote%&, except that it quotes the string only if
10472 required to do so by the rules of RFC 2822 for quoting local parts. For
10473 example, a plus sign would not cause quoting (but it would for &%quote%&).
10474 If you are creating a new email address from the contents of &$local_part$&
10475 (or any other unknown data), you should always use this operator.
10476
10477
10478 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10479 .cindex "quoting" "lookup-specific"
10480 This operator applies lookup-specific quoting rules to the string. Each
10481 query-style lookup type has its own quoting rules which are described with
10482 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10483 .code
10484 ${quote_ldap:two * two}
10485 .endd
10486 returns
10487 .code
10488 two%20%5C2A%20two
10489 .endd
10490 For single-key lookup types, no quoting is ever necessary and this operator
10491 yields an unchanged string.
10492
10493
10494 .vitem &*${randint:*&<&'n'&>&*}*&
10495 .cindex "random number"
10496 This operator returns a somewhat random number which is less than the
10497 supplied number and is at least 0.  The quality of this randomness depends
10498 on how Exim was built; the values are not suitable for keying material.
10499 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10500 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10501 for versions of GnuTLS with that function.
10502 Otherwise, the implementation may be arc4random(), random() seeded by
10503 srandomdev() or srandom(), or a custom implementation even weaker than
10504 random().
10505
10506
10507 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10508 .cindex "expansion" "IP address"
10509 This operator reverses an IP address; for IPv4 addresses, the result is in
10510 dotted-quad decimal form, while for IPv6 addresses the result is in
10511 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10512 for DNS.  For example,
10513 .code
10514 ${reverse_ip:192.0.2.4}
10515 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10516 .endd
10517 returns
10518 .code
10519 4.2.0.192
10520 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
10521 .endd
10522
10523
10524 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10525 .cindex "expansion" "RFC 2047"
10526 .cindex "RFC 2047" "expansion operator"
10527 .cindex "&%rfc2047%& expansion item"
10528 This operator encodes text according to the rules of RFC 2047. This is an
10529 encoding that is used in header lines to encode non-ASCII characters. It is
10530 assumed that the input string is in the encoding specified by the
10531 &%headers_charset%& option, which gets its default at build time. If the string
10532 contains only characters in the range 33&--126, and no instances of the
10533 characters
10534 .code
10535 ? = ( ) < > @ , ; : \ " . [ ] _
10536 .endd
10537 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10538 string, using as many &"encoded words"& as necessary to encode all the
10539 characters.
10540
10541
10542 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10543 .cindex "expansion" "RFC 2047"
10544 .cindex "RFC 2047" "decoding"
10545 .cindex "&%rfc2047d%& expansion item"
10546 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10547 bytes are replaced by question marks. Characters are converted into the
10548 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10549 not recognized unless &%check_rfc2047_length%& is set false.
10550
10551 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10552 access a header line, RFC 2047 decoding is done automatically. You do not need
10553 to use this operator as well.
10554
10555
10556
10557 .vitem &*${rxquote:*&<&'string'&>&*}*&
10558 .cindex "quoting" "in regular expressions"
10559 .cindex "regular expressions" "quoting"
10560 .cindex "&%rxquote%& expansion item"
10561 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10562 characters in its argument. This is useful when substituting the values of
10563 variables or headers inside regular expressions.
10564
10565
10566 .vitem &*${sha1:*&<&'string'&>&*}*&
10567 .cindex "SHA-1 hash"
10568 .cindex "expansion" "SHA-1 hashing"
10569 .cindex certificate fingerprint
10570 .cindex "&%sha1%& expansion item"
10571 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10572 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10573
10574 If the string is a single variable of type certificate,
10575 returns the SHA-1 hash fingerprint of the certificate.
10576
10577
10578 .vitem &*${sha256:*&<&'string'&>&*}*&
10579 .cindex "SHA-256 hash"
10580 .cindex certificate fingerprint
10581 .cindex "expansion" "SHA-256 hashing"
10582 .cindex "&%sha256%& expansion item"
10583 The &%sha256%& operator computes the SHA-256 hash value of the string
10584 and returns
10585 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10586
10587 If the string is a single variable of type certificate,
10588 returns the SHA-256 hash fingerprint of the certificate.
10589
10590
10591 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10592        &*${sha3_<n>:*&<&'string'&>&*}*&
10593 .cindex "SHA3 hash"
10594 .cindex "expansion" "SHA3 hashing"
10595 .cindex "&%sha3%& expansion item"
10596 The &%sha3%& operator computes the SHA3-256 hash value of the string
10597 and returns
10598 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10599
10600 If a number is appended, separated by an underbar, it specifies
10601 the output length.  Values of 224, 256, 384 and 512 are accepted;
10602 with 256 being the default.
10603
10604 The &%sha3%& expansion item is only supported if Exim has been
10605 compiled with GnuTLS 3.5.0 or later.
10606
10607
10608 .vitem &*${stat:*&<&'string'&>&*}*&
10609 .cindex "expansion" "statting a file"
10610 .cindex "file" "extracting characteristics"
10611 .cindex "&%stat%& expansion item"
10612 The string, after expansion, must be a file path. A call to the &[stat()]&
10613 function is made for this path. If &[stat()]& fails, an error occurs and the
10614 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10615 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10616 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10617 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10618 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10619 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10620 can extract individual fields using the &%extract%& expansion item.
10621
10622 The use of the &%stat%& expansion in users' filter files can be locked out by
10623 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10624 systems for files larger than 2GB.
10625
10626 .vitem &*${str2b64:*&<&'string'&>&*}*&
10627 .cindex "&%str2b64%& expansion item"
10628 Now deprecated, a synonym for the &%base64%& expansion operator.
10629
10630
10631
10632 .vitem &*${strlen:*&<&'string'&>&*}*&
10633 .cindex "expansion" "string length"
10634 .cindex "string" "length in expansion"
10635 .cindex "&%strlen%& expansion item"
10636 The item is replace by the length of the expanded string, expressed as a
10637 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10638
10639
10640 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10641 .cindex "&%substr%& expansion item"
10642 .cindex "substring extraction"
10643 .cindex "expansion" "substring expansion"
10644 The &%substr%& operator is a simpler interface to the &%substr%& function that
10645 can be used when the two parameters are fixed numbers (as opposed to strings
10646 that change when expanded). The effect is the same as
10647 .code
10648 ${substr{<start>}{<length>}{<string>}}
10649 .endd
10650 See the description of the general &%substr%& item above for details. The
10651 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10652
10653 .vitem &*${time_eval:*&<&'string'&>&*}*&
10654 .cindex "&%time_eval%& expansion item"
10655 .cindex "time interval" "decoding"
10656 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10657 seconds.
10658
10659 .vitem &*${time_interval:*&<&'string'&>&*}*&
10660 .cindex "&%time_interval%& expansion item"
10661 .cindex "time interval" "formatting"
10662 The argument (after sub-expansion) must be a sequence of decimal digits that
10663 represents an interval of time as a number of seconds. It is converted into a
10664 number of larger units and output in Exim's normal time format, for example,
10665 &`1w3d4h2m6s`&.
10666
10667 .vitem &*${uc:*&<&'string'&>&*}*&
10668 .cindex "case forcing in strings"
10669 .cindex "string" "case forcing"
10670 .cindex "upper casing"
10671 .cindex "expansion" "case forcing"
10672 .cindex "&%uc%& expansion item"
10673 This forces the letters in the string into upper-case.
10674
10675 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10676 .cindex "correction of invalid utf-8 sequences in strings"
10677 .cindex "utf-8" "utf-8 sequences"
10678 .cindex "incorrect utf-8"
10679 .cindex "expansion" "utf-8 forcing"
10680 .cindex "&%utf8clean%& expansion item"
10681 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10682
10683 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10684        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10685        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10686        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10687 .cindex expansion UTF-8
10688 .cindex UTF-8 expansion
10689 .cindex EAI
10690 .cindex internationalisation
10691 .cindex "&%utf8_domain_to_alabel%& expansion item"
10692 .cindex "&%utf8_domain_from_alabel%& expansion item"
10693 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10694 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10695 These convert EAI mail name components between UTF-8 and a-label forms.
10696 For information on internationalisation support see &<<SECTi18nMTA>>&.
10697 .endlist
10698
10699
10700
10701
10702
10703
10704 .section "Expansion conditions" "SECTexpcond"
10705 .scindex IIDexpcond "expansion" "conditions"
10706 The following conditions are available for testing by the &%${if%& construct
10707 while expanding strings:
10708
10709 .vlist
10710 .vitem &*!*&<&'condition'&>
10711 .cindex "expansion" "negating a condition"
10712 .cindex "negation" "in expansion condition"
10713 Preceding any condition with an exclamation mark negates the result of the
10714 condition.
10715
10716 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10717 .cindex "numeric comparison"
10718 .cindex "expansion" "numeric comparison"
10719 There are a number of symbolic operators for doing numeric comparisons. They
10720 are:
10721 .display
10722 &`=   `&   equal
10723 &`==  `&   equal
10724 &`>   `&   greater
10725 &`>=  `&   greater or equal
10726 &`<   `&   less
10727 &`<=  `&   less or equal
10728 .endd
10729 For example:
10730 .code
10731 ${if >{$message_size}{10M} ...
10732 .endd
10733 Note that the general negation operator provides for inequality testing. The
10734 two strings must take the form of optionally signed decimal integers,
10735 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10736 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10737 As a special case, the numerical value of an empty string is taken as
10738 zero.
10739
10740 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10741 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10742 10M, not if 10M is larger than &$message_size$&.
10743
10744
10745 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10746         {*&<&'arg2'&>&*}...}*&
10747 .cindex "expansion" "calling an acl"
10748 .cindex "&%acl%&" "expansion condition"
10749 The name and zero to nine argument strings are first expanded separately.  The expanded
10750 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10751 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10752 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10753 and may use the variables; if another acl expansion is used the values
10754 are restored after it returns.  If the ACL sets
10755 a value using a "message =" modifier the variable $value becomes
10756 the result of the expansion, otherwise it is empty.
10757 If the ACL returns accept the condition is true; if deny, false.
10758 If the ACL returns defer the result is a forced-fail.
10759
10760 .vitem &*bool&~{*&<&'string'&>&*}*&
10761 .cindex "expansion" "boolean parsing"
10762 .cindex "&%bool%& expansion condition"
10763 This condition turns a string holding a true or false representation into
10764 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10765 (case-insensitively); also integer numbers map to true if non-zero,
10766 false if zero.
10767 An empty string is treated as false.
10768 Leading and trailing whitespace is ignored;
10769 thus a string consisting only of whitespace is false.
10770 All other string values will result in expansion failure.
10771
10772 When combined with ACL variables, this expansion condition will let you
10773 make decisions in one place and act on those decisions in another place.
10774 For example:
10775 .code
10776 ${if bool{$acl_m_privileged_sender} ...
10777 .endd
10778
10779
10780 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10781 .cindex "expansion" "boolean parsing"
10782 .cindex "&%bool_lax%& expansion condition"
10783 Like &%bool%&, this condition turns a string into a boolean state.  But
10784 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10785 loose definition that the Router &%condition%& option uses.  The empty string
10786 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10787 true.  Leading and trailing whitespace is ignored.
10788
10789 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10790
10791 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10792 .cindex "expansion" "encrypted comparison"
10793 .cindex "encrypted strings, comparing"
10794 .cindex "&%crypteq%& expansion condition"
10795 This condition is included in the Exim binary if it is built to support any
10796 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10797 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10798 included in the binary.
10799
10800 The &%crypteq%& condition has two arguments. The first is encrypted and
10801 compared against the second, which is already encrypted. The second string may
10802 be in the LDAP form for storing encrypted strings, which starts with the
10803 encryption type in curly brackets, followed by the data. If the second string
10804 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10805 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10806 Typically this will be a field from a password file. An example of an encrypted
10807 string in LDAP form is:
10808 .code
10809 {md5}CY9rzUYh03PK3k6DJie09g==
10810 .endd
10811 If such a string appears directly in an expansion, the curly brackets have to
10812 be quoted, because they are part of the expansion syntax. For example:
10813 .code
10814 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10815 .endd
10816 The following encryption types (whose names are matched case-independently) are
10817 supported:
10818
10819 .ilist
10820 .cindex "MD5 hash"
10821 .cindex "base64 encoding" "in encrypted password"
10822 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10823 printable characters to compare with the remainder of the second string. If the
10824 length of the comparison string is 24, Exim assumes that it is base64 encoded
10825 (as in the above example). If the length is 32, Exim assumes that it is a
10826 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10827 comparison fails.
10828
10829 .next
10830 .cindex "SHA-1 hash"
10831 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10832 printable characters to compare with the remainder of the second string. If the
10833 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10834 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10835 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10836
10837 .next
10838 .cindex "&[crypt()]&"
10839 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10840 only the first eight characters of the password. However, in modern operating
10841 systems this is no longer true, and in many cases the entire password is used,
10842 whatever its length.
10843
10844 .next
10845 .cindex "&[crypt16()]&"
10846 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10847 use up to 16 characters of the password in some operating systems. Again, in
10848 modern operating systems, more characters may be used.
10849 .endlist
10850 Exim has its own version of &[crypt16()]&, which is just a double call to
10851 &[crypt()]&. For operating systems that have their own version, setting
10852 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10853 operating system version instead of its own. This option is set by default in
10854 the OS-dependent &_Makefile_& for those operating systems that are known to
10855 support &[crypt16()]&.
10856
10857 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10858 it was not using the same algorithm as some operating systems' versions. It
10859 turns out that as well as &[crypt16()]& there is a function called
10860 &[bigcrypt()]& in some operating systems. This may or may not use the same
10861 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10862
10863 However, since there is now a move away from the traditional &[crypt()]&
10864 functions towards using SHA1 and other algorithms, tidying up this area of
10865 Exim is seen as very low priority.
10866
10867 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10868 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10869 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10870 default is &`{crypt}`&. Whatever the default, you can always use either
10871 function by specifying it explicitly in curly brackets.
10872
10873 .vitem &*def:*&<&'variable&~name'&>
10874 .cindex "expansion" "checking for empty variable"
10875 .cindex "&%def%& expansion condition"
10876 The &%def%& condition must be followed by the name of one of the expansion
10877 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10878 variable does not contain the empty string. For example:
10879 .code
10880 ${if def:sender_ident {from $sender_ident}}
10881 .endd
10882 Note that the variable name is given without a leading &%$%& character. If the
10883 variable does not exist, the expansion fails.
10884
10885 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10886         &~&*def:h_*&<&'header&~name'&>&*:*&"
10887 .cindex "expansion" "checking header line existence"
10888 This condition is true if a message is being processed and the named header
10889 exists in the message. For example,
10890 .code
10891 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10892 .endd
10893 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10894 the header name must be terminated by a colon if white space does not follow.
10895
10896 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10897        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10898 .cindex "string" "comparison"
10899 .cindex "expansion" "string comparison"
10900 .cindex "&%eq%& expansion condition"
10901 .cindex "&%eqi%& expansion condition"
10902 The two substrings are first expanded. The condition is true if the two
10903 resulting strings are identical. For &%eq%& the comparison includes the case of
10904 letters, whereas for &%eqi%& the comparison is case-independent.
10905
10906 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10907 .cindex "expansion" "file existence test"
10908 .cindex "file" "existence test"
10909 .cindex "&%exists%&, expansion condition"
10910 The substring is first expanded and then interpreted as an absolute path. The
10911 condition is true if the named file (or directory) exists. The existence test
10912 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10913 users' filter files may be locked out by the system administrator.
10914
10915 .vitem &*first_delivery*&
10916 .cindex "delivery" "first"
10917 .cindex "first delivery"
10918 .cindex "expansion" "first delivery test"
10919 .cindex "&%first_delivery%& expansion condition"
10920 This condition, which has no data, is true during a message's first delivery
10921 attempt. It is false during any subsequent delivery attempts.
10922
10923
10924 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10925        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10926 .cindex "list" "iterative conditions"
10927 .cindex "expansion" "&*forall*& condition"
10928 .cindex "expansion" "&*forany*& condition"
10929 .vindex "&$item$&"
10930 These conditions iterate over a list. The first argument is expanded to form
10931 the list. By default, the list separator is a colon, but it can be changed by
10932 the normal method. The second argument is interpreted as a condition that is to
10933 be applied to each item in the list in turn. During the interpretation of the
10934 condition, the current list item is placed in a variable called &$item$&.
10935 .ilist
10936 For &*forany*&, interpretation stops if the condition is true for any item, and
10937 the result of the whole condition is true. If the condition is false for all
10938 items in the list, the overall condition is false.
10939 .next
10940 For &*forall*&, interpretation stops if the condition is false for any item,
10941 and the result of the whole condition is false. If the condition is true for
10942 all items in the list, the overall condition is true.
10943 .endlist
10944 Note that negation of &*forany*& means that the condition must be false for all
10945 items for the overall condition to succeed, and negation of &*forall*& means
10946 that the condition must be false for at least one item. In this example, the
10947 list separator is changed to a comma:
10948 .code
10949 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10950 .endd
10951 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10952 being processed, to enable these expansion items to be nested.
10953
10954 To scan a named list, expand it with the &*listnamed*& operator.
10955
10956
10957 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10958        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10959 .cindex "string" "comparison"
10960 .cindex "expansion" "string comparison"
10961 .cindex "&%ge%& expansion condition"
10962 .cindex "&%gei%& expansion condition"
10963 The two substrings are first expanded. The condition is true if the first
10964 string is lexically greater than or equal to the second string. For &%ge%& the
10965 comparison includes the case of letters, whereas for &%gei%& the comparison is
10966 case-independent.
10967
10968 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10969        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10970 .cindex "string" "comparison"
10971 .cindex "expansion" "string comparison"
10972 .cindex "&%gt%& expansion condition"
10973 .cindex "&%gti%& expansion condition"
10974 The two substrings are first expanded. The condition is true if the first
10975 string is lexically greater than the second string. For &%gt%& the comparison
10976 includes the case of letters, whereas for &%gti%& the comparison is
10977 case-independent.
10978
10979 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10980        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10981 .cindex "string" "comparison"
10982 .cindex "list" "iterative conditions"
10983 Both strings are expanded; the second string is treated as a list of simple
10984 strings; if the first string is a member of the second, then the condition
10985 is true.
10986
10987 These are simpler to use versions of the more powerful &*forany*& condition.
10988 Examples, and the &*forany*& equivalents:
10989 .code
10990 ${if inlist{needle}{foo:needle:bar}}
10991   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10992 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10993   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10994 .endd
10995
10996 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10997        &*isip4&~{*&<&'string'&>&*}*& &&&
10998        &*isip6&~{*&<&'string'&>&*}*&
10999 .cindex "IP address" "testing string format"
11000 .cindex "string" "testing for IP address"
11001 .cindex "&%isip%& expansion condition"
11002 .cindex "&%isip4%& expansion condition"
11003 .cindex "&%isip6%& expansion condition"
11004 The substring is first expanded, and then tested to see if it has the form of
11005 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11006 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11007
11008 For an IPv4 address, the test is for four dot-separated components, each of
11009 which consists of from one to three digits. For an IPv6 address, up to eight
11010 colon-separated components are permitted, each containing from one to four
11011 hexadecimal digits. There may be fewer than eight components if an empty
11012 component (adjacent colons) is present. Only one empty component is permitted.
11013
11014 &*Note*&: The checks are just on the form of the address; actual numerical
11015 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
11016 check. The main use of these tests is to distinguish between IP addresses and
11017 host names, or between IPv4 and IPv6 addresses. For example, you could use
11018 .code
11019 ${if isip4{$sender_host_address}...
11020 .endd
11021 to test which IP version an incoming SMTP connection is using.
11022
11023 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11024 .cindex "LDAP" "use for authentication"
11025 .cindex "expansion" "LDAP authentication test"
11026 .cindex "&%ldapauth%& expansion condition"
11027 This condition supports user authentication using LDAP. See section
11028 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11029 queries. For this use, the query must contain a user name and password. The
11030 query itself is not used, and can be empty. The condition is true if the
11031 password is not empty, and the user name and password are accepted by the LDAP
11032 server. An empty password is rejected without calling LDAP because LDAP binds
11033 with an empty password are considered anonymous regardless of the username, and
11034 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11035 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11036 this can be used.
11037
11038
11039 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11040        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11041 .cindex "string" "comparison"
11042 .cindex "expansion" "string comparison"
11043 .cindex "&%le%& expansion condition"
11044 .cindex "&%lei%& expansion condition"
11045 The two substrings are first expanded. The condition is true if the first
11046 string is lexically less than or equal to the second string. For &%le%& the
11047 comparison includes the case of letters, whereas for &%lei%& the comparison is
11048 case-independent.
11049
11050 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11051        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11052 .cindex "string" "comparison"
11053 .cindex "expansion" "string comparison"
11054 .cindex "&%lt%& expansion condition"
11055 .cindex "&%lti%& expansion condition"
11056 The two substrings are first expanded. The condition is true if the first
11057 string is lexically less than the second string. For &%lt%& the comparison
11058 includes the case of letters, whereas for &%lti%& the comparison is
11059 case-independent.
11060
11061
11062 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11063 .cindex "expansion" "regular expression comparison"
11064 .cindex "regular expressions" "match in expanded string"
11065 .cindex "&%match%& expansion condition"
11066 The two substrings are first expanded. The second is then treated as a regular
11067 expression and applied to the first. Because of the pre-expansion, if the
11068 regular expression contains dollar, or backslash characters, they must be
11069 escaped. Care must also be taken if the regular expression contains braces
11070 (curly brackets). A closing brace must be escaped so that it is not taken as a
11071 premature termination of <&'string2'&>. The easiest approach is to use the
11072 &`\N`& feature to disable expansion of the regular expression.
11073 For example,
11074 .code
11075 ${if match {$local_part}{\N^\d{3}\N} ...
11076 .endd
11077 If the whole expansion string is in double quotes, further escaping of
11078 backslashes is also required.
11079
11080 The condition is true if the regular expression match succeeds.
11081 The regular expression is not required to begin with a circumflex
11082 metacharacter, but if there is no circumflex, the expression is not anchored,
11083 and it may match anywhere in the subject, not just at the start. If you want
11084 the pattern to match at the end of the subject, you must include the &`$`&
11085 metacharacter at an appropriate point.
11086
11087 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11088 At the start of an &%if%& expansion the values of the numeric variable
11089 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11090 succeeds causes them to be reset to the substrings of that condition and they
11091 will have these values during the expansion of the success string. At the end
11092 of the &%if%& expansion, the previous values are restored. After testing a
11093 combination of conditions using &%or%&, the subsequent values of the numeric
11094 variables are those of the condition that succeeded.
11095
11096 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11097 .cindex "&%match_address%& expansion condition"
11098 See &*match_local_part*&.
11099
11100 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11101 .cindex "&%match_domain%& expansion condition"
11102 See &*match_local_part*&.
11103
11104 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11105 .cindex "&%match_ip%& expansion condition"
11106 This condition matches an IP address to a list of IP address patterns. It must
11107 be followed by two argument strings. The first (after expansion) must be an IP
11108 address or an empty string. The second (not expanded) is a restricted host
11109 list that can match only an IP address, not a host name. For example:
11110 .code
11111 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11112 .endd
11113 The specific types of host list item that are permitted in the list are:
11114
11115 .ilist
11116 An IP address, optionally with a CIDR mask.
11117 .next
11118 A single asterisk, which matches any IP address.
11119 .next
11120 An empty item, which matches only if the IP address is empty. This could be
11121 useful for testing for a locally submitted message or one from specific hosts
11122 in a single test such as
11123 . ==== As this is a nested list, any displays it contains must be indented
11124 . ==== as otherwise they are too far to the left. This comment applies to
11125 . ==== the use of xmlto plus fop. There's no problem when formatting with
11126 . ==== sdop, with or without the extra indent.
11127 .code
11128   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11129 .endd
11130 where the first item in the list is the empty string.
11131 .next
11132 The item @[] matches any of the local host's interface addresses.
11133 .next
11134 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11135 even if &`net-`& is not specified. There is never any attempt to turn the IP
11136 address into a host name. The most common type of linear search for
11137 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11138 masks. For example:
11139 .code
11140   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11141 .endd
11142 It is of course possible to use other kinds of lookup, and in such a case, you
11143 do need to specify the &`net-`& prefix if you want to specify a specific
11144 address mask, for example:
11145 .code
11146   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11147 .endd
11148 However, unless you are combining a &%match_ip%& condition with others, it is
11149 just as easy to use the fact that a lookup is itself a condition, and write:
11150 .code
11151   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11152 .endd
11153 .endlist ilist
11154
11155 Note that <&'string2'&> is not itself subject to string expansion, unless
11156 Exim was built with the EXPAND_LISTMATCH_RHS option.
11157
11158 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11159
11160 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11161 .cindex "domain list" "in expansion condition"
11162 .cindex "address list" "in expansion condition"
11163 .cindex "local part" "list, in expansion condition"
11164 .cindex "&%match_local_part%& expansion condition"
11165 This condition, together with &%match_address%& and &%match_domain%&, make it
11166 possible to test domain, address, and local part lists within expansions. Each
11167 condition requires two arguments: an item and a list to match. A trivial
11168 example is:
11169 .code
11170 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11171 .endd
11172 In each case, the second argument may contain any of the allowable items for a
11173 list of the appropriate type. Also, because the second argument (after
11174 expansion) is a standard form of list, it is possible to refer to a named list.
11175 Thus, you can use conditions like this:
11176 .code
11177 ${if match_domain{$domain}{+local_domains}{...
11178 .endd
11179 .cindex "&`+caseful`&"
11180 For address lists, the matching starts off caselessly, but the &`+caseful`&
11181 item can be used, as in all address lists, to cause subsequent items to
11182 have their local parts matched casefully. Domains are always matched
11183 caselessly.
11184
11185 Note that <&'string2'&> is not itself subject to string expansion, unless
11186 Exim was built with the EXPAND_LISTMATCH_RHS option.
11187
11188 &*Note*&: Host lists are &'not'& supported in this way. This is because
11189 hosts have two identities: a name and an IP address, and it is not clear
11190 how to specify cleanly how such a test would work. However, IP addresses can be
11191 matched using &%match_ip%&.
11192
11193 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11194 .cindex "PAM authentication"
11195 .cindex "AUTH" "with PAM"
11196 .cindex "Solaris" "PAM support"
11197 .cindex "expansion" "PAM authentication test"
11198 .cindex "&%pam%& expansion condition"
11199 &'Pluggable Authentication Modules'&
11200 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11201 available in the latest releases of Solaris and in some GNU/Linux
11202 distributions. The Exim support, which is intended for use in conjunction with
11203 the SMTP AUTH command, is available only if Exim is compiled with
11204 .code
11205 SUPPORT_PAM=yes
11206 .endd
11207 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11208 in some releases of GNU/Linux &%-ldl%& is also needed.
11209
11210 The argument string is first expanded, and the result must be a
11211 colon-separated list of strings. Leading and trailing white space is ignored.
11212 The PAM module is initialized with the service name &"exim"& and the user name
11213 taken from the first item in the colon-separated data string (<&'string1'&>).
11214 The remaining items in the data string are passed over in response to requests
11215 from the authentication function. In the simple case there will only be one
11216 request, for a password, so the data consists of just two strings.
11217
11218 There can be problems if any of the strings are permitted to contain colon
11219 characters. In the usual way, these have to be doubled to avoid being taken as
11220 separators. If the data is being inserted from a variable, the &%sg%& expansion
11221 item can be used to double any existing colons. For example, the configuration
11222 of a LOGIN authenticator might contain this setting:
11223 .code
11224 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11225 .endd
11226 For a PLAIN authenticator you could use:
11227 .code
11228 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11229 .endd
11230 In some operating systems, PAM authentication can be done only from a process
11231 running as root. Since Exim is running as the Exim user when receiving
11232 messages, this means that PAM cannot be used directly in those systems.
11233 A patched version of the &'pam_unix'& module that comes with the
11234 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11235 The patched module allows one special uid/gid combination, in addition to root,
11236 to authenticate. If you build the patched module to allow the Exim user and
11237 group, PAM can then be used from an Exim authenticator.
11238
11239
11240 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11241 .cindex "&'pwcheck'& daemon"
11242 .cindex "Cyrus"
11243 .cindex "expansion" "&'pwcheck'& authentication test"
11244 .cindex "&%pwcheck%& expansion condition"
11245 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11246 This is one way of making it possible for passwords to be checked by a process
11247 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11248 deprecated. Its replacement is &'saslauthd'& (see below).
11249
11250 The pwcheck support is not included in Exim by default. You need to specify
11251 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11252 building Exim. For example:
11253 .code
11254 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11255 .endd
11256 You do not need to install the full Cyrus software suite in order to use
11257 the pwcheck daemon. You can compile and install just the daemon alone
11258 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11259 access to the &_/var/pwcheck_& directory.
11260
11261 The &%pwcheck%& condition takes one argument, which must be the user name and
11262 password, separated by a colon. For example, in a LOGIN authenticator
11263 configuration, you might have this:
11264 .code
11265 server_condition = ${if pwcheck{$auth1:$auth2}}
11266 .endd
11267 Again, for a PLAIN authenticator configuration, this would be:
11268 .code
11269 server_condition = ${if pwcheck{$auth2:$auth3}}
11270 .endd
11271 .vitem &*queue_running*&
11272 .cindex "queue runner" "detecting when delivering from"
11273 .cindex "expansion" "queue runner test"
11274 .cindex "&%queue_running%& expansion condition"
11275 This condition, which has no data, is true during delivery attempts that are
11276 initiated by queue runner processes, and false otherwise.
11277
11278
11279 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11280 .cindex "Radius"
11281 .cindex "expansion" "Radius authentication"
11282 .cindex "&%radius%& expansion condition"
11283 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11284 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11285 the Radius client configuration file in order to build Exim with Radius
11286 support.
11287
11288 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11289 library, using the original API. If you are using release 0.4.0 or later of
11290 this library, you need to set
11291 .code
11292 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11293 .endd
11294 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11295 &%libradius%& library that comes with FreeBSD. To do this, set
11296 .code
11297 RADIUS_LIB_TYPE=RADLIB
11298 .endd
11299 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11300 You may also have to supply a suitable setting in EXTRALIBS so that the
11301 Radius library can be found when Exim is linked.
11302
11303 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11304 Radius client library, which calls the Radius server. The condition is true if
11305 the authentication is successful. For example:
11306 .code
11307 server_condition = ${if radius{<arguments>}}
11308 .endd
11309
11310
11311 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11312         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11313 .cindex "&'saslauthd'& daemon"
11314 .cindex "Cyrus"
11315 .cindex "expansion" "&'saslauthd'& authentication test"
11316 .cindex "&%saslauthd%& expansion condition"
11317 This condition supports user authentication using the Cyrus &'saslauthd'&
11318 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11319 Using this daemon is one way of making it possible for passwords to be checked
11320 by a process that is not running as root.
11321
11322 The saslauthd support is not included in Exim by default. You need to specify
11323 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11324 building Exim. For example:
11325 .code
11326 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11327 .endd
11328 You do not need to install the full Cyrus software suite in order to use
11329 the saslauthd daemon. You can compile and install just the daemon alone
11330 from the Cyrus SASL library.
11331
11332 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11333 two are mandatory. For example:
11334 .code
11335 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11336 .endd
11337 The service and the realm are optional (which is why the arguments are enclosed
11338 in their own set of braces). For details of the meaning of the service and
11339 realm, and how to run the daemon, consult the Cyrus documentation.
11340 .endlist vlist
11341
11342
11343
11344 .section "Combining expansion conditions" "SECID84"
11345 .cindex "expansion" "combining conditions"
11346 Several conditions can be tested at once by combining them using the &%and%&
11347 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11348 conditions on their own, and precede their lists of sub-conditions. Each
11349 sub-condition must be enclosed in braces within the overall braces that contain
11350 the list. No repetition of &%if%& is used.
11351
11352
11353 .vlist
11354 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11355 .cindex "&""or""& expansion condition"
11356 .cindex "expansion" "&""or""& of conditions"
11357 The sub-conditions are evaluated from left to right. The condition is true if
11358 any one of the sub-conditions is true.
11359 For example,
11360 .code
11361 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11362 .endd
11363 When a true sub-condition is found, the following ones are parsed but not
11364 evaluated. If there are several &"match"& sub-conditions the values of the
11365 numeric variables afterwards are taken from the first one that succeeds.
11366
11367 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11368 .cindex "&""and""& expansion condition"
11369 .cindex "expansion" "&""and""& of conditions"
11370 The sub-conditions are evaluated from left to right. The condition is true if
11371 all of the sub-conditions are true. If there are several &"match"&
11372 sub-conditions, the values of the numeric variables afterwards are taken from
11373 the last one. When a false sub-condition is found, the following ones are
11374 parsed but not evaluated.
11375 .endlist
11376 .ecindex IIDexpcond
11377
11378
11379
11380
11381 .section "Expansion variables" "SECTexpvar"
11382 .cindex "expansion" "variables, list of"
11383 This section contains an alphabetical list of all the expansion variables. Some
11384 of them are available only when Exim is compiled with specific options such as
11385 support for TLS or the content scanning extension.
11386
11387 .vlist
11388 .vitem "&$0$&, &$1$&, etc"
11389 .cindex "numerical variables (&$1$& &$2$& etc)"
11390 When a &%match%& expansion condition succeeds, these variables contain the
11391 captured substrings identified by the regular expression during subsequent
11392 processing of the success string of the containing &%if%& expansion item.
11393 In the expansion condition case
11394 they do not retain their values afterwards; in fact, their previous
11395 values are restored at the end of processing an &%if%& item. The numerical
11396 variables may also be set externally by some other matching process which
11397 precedes the expansion of the string. For example, the commands available in
11398 Exim filter files include an &%if%& command with its own regular expression
11399 matching condition.
11400
11401 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11402 Within an acl condition, expansion condition or expansion item
11403 any arguments are copied to these variables,
11404 any unused variables being made empty.
11405
11406 .vitem "&$acl_c...$&"
11407 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11408 can be given any name that starts with &$acl_c$& and is at least six characters
11409 long, but the sixth character must be either a digit or an underscore. For
11410 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11411 variables persist throughout the lifetime of an SMTP connection. They can be
11412 used to pass information between ACLs and between different invocations of the
11413 same ACL. When a message is received, the values of these variables are saved
11414 with the message, and can be accessed by filters, routers, and transports
11415 during subsequent delivery.
11416
11417 .vitem "&$acl_m...$&"
11418 These variables are like the &$acl_c...$& variables, except that their values
11419 are reset after a message has been received. Thus, if several messages are
11420 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11421 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11422 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11423 message is received, the values of these variables are saved with the message,
11424 and can be accessed by filters, routers, and transports during subsequent
11425 delivery.
11426
11427 .vitem &$acl_narg$&
11428 Within an acl condition, expansion condition or expansion item
11429 this variable has the number of arguments.
11430
11431 .vitem &$acl_verify_message$&
11432 .vindex "&$acl_verify_message$&"
11433 After an address verification has failed, this variable contains the failure
11434 message. It retains its value for use in subsequent modifiers. The message can
11435 be preserved by coding like this:
11436 .code
11437 warn !verify = sender
11438      set acl_m0 = $acl_verify_message
11439 .endd
11440 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11441 &%log_message%& modifiers, to include information about the verification
11442 failure.
11443
11444 .vitem &$address_data$&
11445 .vindex "&$address_data$&"
11446 This variable is set by means of the &%address_data%& option in routers. The
11447 value then remains with the address while it is processed by subsequent routers
11448 and eventually a transport. If the transport is handling multiple addresses,
11449 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11450 for more details. &*Note*&: The contents of &$address_data$& are visible in
11451 user filter files.
11452
11453 If &$address_data$& is set when the routers are called from an ACL to verify
11454 a recipient address, the final value is still in the variable for subsequent
11455 conditions and modifiers of the ACL statement. If routing the address caused it
11456 to be redirected to just one address, the child address is also routed as part
11457 of the verification, and in this case the final value of &$address_data$& is
11458 from the child's routing.
11459
11460 If &$address_data$& is set when the routers are called from an ACL to verify a
11461 sender address, the final value is also preserved, but this time in
11462 &$sender_address_data$&, to distinguish it from data from a recipient
11463 address.
11464
11465 In both cases (recipient and sender verification), the value does not persist
11466 after the end of the current ACL statement. If you want to preserve
11467 these values for longer, you can save them in ACL variables.
11468
11469 .vitem &$address_file$&
11470 .vindex "&$address_file$&"
11471 When, as a result of aliasing, forwarding, or filtering, a message is directed
11472 to a specific file, this variable holds the name of the file when the transport
11473 is running. At other times, the variable is empty. For example, using the
11474 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11475 .code
11476 /home/r2d2/savemail
11477 .endd
11478 then when the &(address_file)& transport is running, &$address_file$&
11479 contains the text string &`/home/r2d2/savemail`&.
11480 .cindex "Sieve filter" "value of &$address_file$&"
11481 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11482 then up to the transport configuration to generate an appropriate absolute path
11483 to the relevant file.
11484
11485 .vitem &$address_pipe$&
11486 .vindex "&$address_pipe$&"
11487 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11488 this variable holds the pipe command when the transport is running.
11489
11490 .vitem "&$auth1$& &-- &$auth3$&"
11491 .vindex "&$auth1$&, &$auth2$&, etc"
11492 These variables are used in SMTP authenticators (see chapters
11493 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11494
11495 .vitem &$authenticated_id$&
11496 .cindex "authentication" "id"
11497 .vindex "&$authenticated_id$&"
11498 When a server successfully authenticates a client it may be configured to
11499 preserve some of the authentication information in the variable
11500 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11501 user/password authenticator configuration might preserve the user name for use
11502 in the routers. Note that this is not the same information that is saved in
11503 &$sender_host_authenticated$&.
11504 When a message is submitted locally (that is, not over a TCP connection)
11505 the value of &$authenticated_id$& is normally the login name of the calling
11506 process. However, a trusted user can override this by means of the &%-oMai%&
11507 command line option.
11508
11509 .vitem &$authenticated_fail_id$&
11510 .cindex "authentication" "fail" "id"
11511 .vindex "&$authenticated_fail_id$&"
11512 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11513 will contain the failed authentication id. If more than one authentication
11514 id is attempted, it will contain only the last one. The variable is
11515 available for processing in the ACL's, generally the quit or notquit ACL.
11516 A message to a local recipient could still be accepted without requiring
11517 authentication, which means this variable could also be visible in all of
11518 the ACL's as well.
11519
11520
11521 .vitem &$authenticated_sender$&
11522 .cindex "sender" "authenticated"
11523 .cindex "authentication" "sender"
11524 .cindex "AUTH" "on MAIL command"
11525 .vindex "&$authenticated_sender$&"
11526 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11527 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11528 described in section &<<SECTauthparamail>>&. Unless the data is the string
11529 &"<>"&, it is set as the authenticated sender of the message, and the value is
11530 available during delivery in the &$authenticated_sender$& variable. If the
11531 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11532
11533 .vindex "&$qualify_domain$&"
11534 When a message is submitted locally (that is, not over a TCP connection), the
11535 value of &$authenticated_sender$& is an address constructed from the login
11536 name of the calling process and &$qualify_domain$&, except that a trusted user
11537 can override this by means of the &%-oMas%& command line option.
11538
11539
11540 .vitem &$authentication_failed$&
11541 .cindex "authentication" "failure"
11542 .vindex "&$authentication_failed$&"
11543 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11544 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11545 possible to distinguish between &"did not try to authenticate"&
11546 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11547 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11548 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11549 negative response to an AUTH command, including (for example) an attempt to use
11550 an undefined mechanism.
11551
11552 .vitem &$av_failed$&
11553 .cindex "content scanning" "AV scanner failure"
11554 This variable is available when Exim is compiled with the content-scanning
11555 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11556 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11557 the ACL malware condition.
11558
11559 .vitem &$body_linecount$&
11560 .cindex "message body" "line count"
11561 .cindex "body of message" "line count"
11562 .vindex "&$body_linecount$&"
11563 When a message is being received or delivered, this variable contains the
11564 number of lines in the message's body. See also &$message_linecount$&.
11565
11566 .vitem &$body_zerocount$&
11567 .cindex "message body" "binary zero count"
11568 .cindex "body of message" "binary zero count"
11569 .cindex "binary zero" "in message body"
11570 .vindex "&$body_zerocount$&"
11571 When a message is being received or delivered, this variable contains the
11572 number of binary zero bytes (ASCII NULs) in the message's body.
11573
11574 .vitem &$bounce_recipient$&
11575 .vindex "&$bounce_recipient$&"
11576 This is set to the recipient address of a bounce message while Exim is creating
11577 it. It is useful if a customized bounce message text file is in use (see
11578 chapter &<<CHAPemsgcust>>&).
11579
11580 .vitem &$bounce_return_size_limit$&
11581 .vindex "&$bounce_return_size_limit$&"
11582 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11583 up to a multiple of 1000. It is useful when a customized error message text
11584 file is in use (see chapter &<<CHAPemsgcust>>&).
11585
11586 .vitem &$caller_gid$&
11587 .cindex "gid (group id)" "caller"
11588 .vindex "&$caller_gid$&"
11589 The real group id under which the process that called Exim was running. This is
11590 not the same as the group id of the originator of a message (see
11591 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11592 incarnation normally contains the Exim gid.
11593
11594 .vitem &$caller_uid$&
11595 .cindex "uid (user id)" "caller"
11596 .vindex "&$caller_uid$&"
11597 The real user id under which the process that called Exim was running. This is
11598 not the same as the user id of the originator of a message (see
11599 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11600 incarnation normally contains the Exim uid.
11601
11602 .vitem &$callout_address$&
11603 .vindex "&$callout_address$&"
11604 After a callout for verification, spamd or malware daemon service, the
11605 address that was connected to.
11606
11607 .vitem &$compile_number$&
11608 .vindex "&$compile_number$&"
11609 The building process for Exim keeps a count of the number
11610 of times it has been compiled. This serves to distinguish different
11611 compilations of the same version of the program.
11612
11613 .vitem &$config_dir$&
11614 .vindex "&$config_dir$&"
11615 The directory name of the main configuration file. That is, the content of
11616 &$config_file$& with the last component stripped. The value does not
11617 contain the trailing slash. If &$config_file$& does not contain a slash,
11618 &$config_dir$& is ".".
11619
11620 .vitem &$config_file$&
11621 .vindex "&$config_file$&"
11622 The name of the main configuration file Exim is using.
11623
11624 .vitem &$dkim_cur_signer$& &&&
11625        &$dkim_verify_status$& &&&
11626        &$dkim_verify_reason$& &&&
11627        &$dkim_domain$& &&&
11628        &$dkim_identity$& &&&
11629        &$dkim_selector$& &&&
11630        &$dkim_algo$& &&&
11631        &$dkim_canon_body$& &&&
11632        &$dkim_canon_headers$& &&&
11633        &$dkim_copiedheaders$& &&&
11634        &$dkim_bodylength$& &&&
11635        &$dkim_created$& &&&
11636        &$dkim_expires$& &&&
11637        &$dkim_headernames$& &&&
11638        &$dkim_key_testing$& &&&
11639        &$dkim_key_nosubdomains$& &&&
11640        &$dkim_key_srvtype$& &&&
11641        &$dkim_key_granularity$& &&&
11642        &$dkim_key_notes$& &&&
11643        &$dkim_key_length$&
11644 These variables are only available within the DKIM ACL.
11645 For details see chapter &<<CHAPdkim>>&.
11646
11647 .vitem &$dkim_signers$&
11648 .vindex &$dkim_signers$&
11649 When a message has been received this variable contains
11650 a colon-separated list of signer domains and identities for the message.
11651 For details see chapter &<<CHAPdkim>>&.
11652
11653 .vitem &$dnslist_domain$& &&&
11654        &$dnslist_matched$& &&&
11655        &$dnslist_text$& &&&
11656        &$dnslist_value$&
11657 .vindex "&$dnslist_domain$&"
11658 .vindex "&$dnslist_matched$&"
11659 .vindex "&$dnslist_text$&"
11660 .vindex "&$dnslist_value$&"
11661 .cindex "black list (DNS)"
11662 When a DNS (black) list lookup succeeds, these variables are set to contain
11663 the following data from the lookup: the list's domain name, the key that was
11664 looked up, the contents of any associated TXT record, and the value from the
11665 main A record. See section &<<SECID204>>& for more details.
11666
11667 .vitem &$domain$&
11668 .vindex "&$domain$&"
11669 When an address is being routed, or delivered on its own, this variable
11670 contains the domain. Uppercase letters in the domain are converted into lower
11671 case for &$domain$&.
11672
11673 Global address rewriting happens when a message is received, so the value of
11674 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11675 is set during user filtering, but not during system filtering, because a
11676 message may have many recipients and the system filter is called just once.
11677
11678 When more than one address is being delivered at once (for example, several
11679 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11680 have the same domain. Transports can be restricted to handling only one domain
11681 at a time if the value of &$domain$& is required at transport time &-- this is
11682 the default for local transports. For further details of the environment in
11683 which local transports are run, see chapter &<<CHAPenvironment>>&.
11684
11685 .oindex "&%delay_warning_condition%&"
11686 At the end of a delivery, if all deferred addresses have the same domain, it is
11687 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11688
11689 The &$domain$& variable is also used in some other circumstances:
11690
11691 .ilist
11692 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11693 the recipient address. The domain of the &'sender'& address is in
11694 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11695 normally set during the running of the MAIL ACL. However, if the sender address
11696 is verified with a callout during the MAIL ACL, the sender domain is placed in
11697 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11698 the &(smtp)& transport.
11699
11700 .next
11701 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11702 &$domain$& contains the domain portion of the address that is being rewritten;
11703 it can be used in the expansion of the replacement address, for example, to
11704 rewrite domains by file lookup.
11705
11706 .next
11707 With one important exception, whenever a domain list is being scanned,
11708 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11709 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11710 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11711 that, in a RCPT ACL, the sender domain list can be dependent on the
11712 recipient domain (which is what is in &$domain$& at this time).
11713
11714 .next
11715 .cindex "ETRN" "value of &$domain$&"
11716 .oindex "&%smtp_etrn_command%&"
11717 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11718 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11719 .endlist
11720
11721
11722 .vitem &$domain_data$&
11723 .vindex "&$domain_data$&"
11724 When the &%domains%& option on a router matches a domain by
11725 means of a lookup, the data read by the lookup is available during the running
11726 of the router as &$domain_data$&. In addition, if the driver routes the
11727 address to a transport, the value is available in that transport. If the
11728 transport is handling multiple addresses, the value from the first address is
11729 used.
11730
11731 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11732 domain by means of a lookup. The data read by the lookup is available during
11733 the rest of the ACL statement. In all other situations, this variable expands
11734 to nothing.
11735
11736 .vitem &$exim_gid$&
11737 .vindex "&$exim_gid$&"
11738 This variable contains the numerical value of the Exim group id.
11739
11740 .vitem &$exim_path$&
11741 .vindex "&$exim_path$&"
11742 This variable contains the path to the Exim binary.
11743
11744 .vitem &$exim_uid$&
11745 .vindex "&$exim_uid$&"
11746 This variable contains the numerical value of the Exim user id.
11747
11748 .vitem &$exim_version$&
11749 .vindex "&$exim_version$&"
11750 This variable contains the version string of the Exim build.
11751 The first character is a major version number, currently 4.
11752 Then after a dot, the next group of digits is a minor version number.
11753 There may be other characters following the minor version.
11754
11755 .vitem &$header_$&<&'name'&>
11756 This is not strictly an expansion variable. It is expansion syntax for
11757 inserting the message header line with the given name. Note that the name must
11758 be terminated by colon or white space, because it may contain a wide variety of
11759 characters. Note also that braces must &'not'& be used.
11760
11761 .vitem &$headers_added$&
11762 .vindex "&$headers_added$&"
11763 Within an ACL this variable contains the headers added so far by
11764 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11765 The headers are a newline-separated list.
11766
11767 .vitem &$home$&
11768 .vindex "&$home$&"
11769 When the &%check_local_user%& option is set for a router, the user's home
11770 directory is placed in &$home$& when the check succeeds. In particular, this
11771 means it is set during the running of users' filter files. A router may also
11772 explicitly set a home directory for use by a transport; this can be overridden
11773 by a setting on the transport itself.
11774
11775 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11776 of the environment variable HOME, which is subject to the
11777 &%keep_environment%& and &%add_environment%& main config options.
11778
11779 .vitem &$host$&
11780 .vindex "&$host$&"
11781 If a router assigns an address to a transport (any transport), and passes a
11782 list of hosts with the address, the value of &$host$& when the transport starts
11783 to run is the name of the first host on the list. Note that this applies both
11784 to local and remote transports.
11785
11786 .cindex "transport" "filter"
11787 .cindex "filter" "transport filter"
11788 For the &(smtp)& transport, if there is more than one host, the value of
11789 &$host$& changes as the transport works its way through the list. In
11790 particular, when the &(smtp)& transport is expanding its options for encryption
11791 using TLS, or for specifying a transport filter (see chapter
11792 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11793 is connected.
11794
11795 When used in the client part of an authenticator configuration (see chapter
11796 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11797 client is connected.
11798
11799
11800 .vitem &$host_address$&
11801 .vindex "&$host_address$&"
11802 This variable is set to the remote host's IP address whenever &$host$& is set
11803 for a remote connection. It is also set to the IP address that is being checked
11804 when the &%ignore_target_hosts%& option is being processed.
11805
11806 .vitem &$host_data$&
11807 .vindex "&$host_data$&"
11808 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11809 result of the lookup is made available in the &$host_data$& variable. This
11810 allows you, for example, to do things like this:
11811 .code
11812 deny  hosts = net-lsearch;/some/file
11813 message = $host_data
11814 .endd
11815 .vitem &$host_lookup_deferred$&
11816 .cindex "host name" "lookup, failure of"
11817 .vindex "&$host_lookup_deferred$&"
11818 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11819 message comes from a remote host and there is an attempt to look up the host's
11820 name from its IP address, and the attempt is not successful, one of these
11821 variables is set to &"1"&.
11822
11823 .ilist
11824 If the lookup receives a definite negative response (for example, a DNS lookup
11825 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11826
11827 .next
11828 If there is any kind of problem during the lookup, such that Exim cannot
11829 tell whether or not the host name is defined (for example, a timeout for a DNS
11830 lookup), &$host_lookup_deferred$& is set to &"1"&.
11831 .endlist ilist
11832
11833 Looking up a host's name from its IP address consists of more than just a
11834 single reverse lookup. Exim checks that a forward lookup of at least one of the
11835 names it receives from a reverse lookup yields the original IP address. If this
11836 is not the case, Exim does not accept the looked up name(s), and
11837 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11838 IP address (for example, the existence of a PTR record in the DNS) is not
11839 sufficient on its own for the success of a host name lookup. If the reverse
11840 lookup succeeds, but there is a lookup problem such as a timeout when checking
11841 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11842 &"1"&. See also &$sender_host_name$&.
11843
11844 .vitem &$host_lookup_failed$&
11845 .vindex "&$host_lookup_failed$&"
11846 See &$host_lookup_deferred$&.
11847
11848 .vitem &$host_port$&
11849 .vindex "&$host_port$&"
11850 This variable is set to the remote host's TCP port whenever &$host$& is set
11851 for an outbound connection.
11852
11853 .vitem &$initial_cwd$&
11854 .vindex "&$initial_cwd$&
11855 This variable contains the full path name of the initial working
11856 directory of the current Exim process. This may differ from the current
11857 working directory, as Exim changes this to "/" during early startup, and
11858 to &$spool_directory$& later.
11859
11860 .vitem &$inode$&
11861 .vindex "&$inode$&"
11862 The only time this variable is set is while expanding the &%directory_file%&
11863 option in the &(appendfile)& transport. The variable contains the inode number
11864 of the temporary file which is about to be renamed. It can be used to construct
11865 a unique name for the file.
11866
11867 .vitem &$interface_address$&
11868 .vindex "&$interface_address$&"
11869 This is an obsolete name for &$received_ip_address$&.
11870
11871 .vitem &$interface_port$&
11872 .vindex "&$interface_port$&"
11873 This is an obsolete name for &$received_port$&.
11874
11875 .vitem &$item$&
11876 .vindex "&$item$&"
11877 This variable is used during the expansion of &*forall*& and &*forany*&
11878 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11879 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11880 empty.
11881
11882 .vitem &$ldap_dn$&
11883 .vindex "&$ldap_dn$&"
11884 This variable, which is available only when Exim is compiled with LDAP support,
11885 contains the DN from the last entry in the most recently successful LDAP
11886 lookup.
11887
11888 .vitem &$load_average$&
11889 .vindex "&$load_average$&"
11890 This variable contains the system load average, multiplied by 1000 so that it
11891 is an integer. For example, if the load average is 0.21, the value of the
11892 variable is 210. The value is recomputed every time the variable is referenced.
11893
11894 .vitem &$local_part$&
11895 .vindex "&$local_part$&"
11896 When an address is being routed, or delivered on its own, this
11897 variable contains the local part. When a number of addresses are being
11898 delivered together (for example, multiple RCPT commands in an SMTP
11899 session), &$local_part$& is not set.
11900
11901 Global address rewriting happens when a message is received, so the value of
11902 &$local_part$& during routing and delivery is the value after rewriting.
11903 &$local_part$& is set during user filtering, but not during system filtering,
11904 because a message may have many recipients and the system filter is called just
11905 once.
11906
11907 .vindex "&$local_part_prefix$&"
11908 .vindex "&$local_part_suffix$&"
11909 If a local part prefix or suffix has been recognized, it is not included in the
11910 value of &$local_part$& during routing and subsequent delivery. The values of
11911 any prefix or suffix are in &$local_part_prefix$& and
11912 &$local_part_suffix$&, respectively.
11913
11914 When a message is being delivered to a file, pipe, or autoreply transport as a
11915 result of aliasing or forwarding, &$local_part$& is set to the local part of
11916 the parent address, not to the file name or command (see &$address_file$& and
11917 &$address_pipe$&).
11918
11919 When an ACL is running for a RCPT command, &$local_part$& contains the
11920 local part of the recipient address.
11921
11922 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11923 &$local_part$& contains the local part of the address that is being rewritten;
11924 it can be used in the expansion of the replacement address, for example.
11925
11926 In all cases, all quoting is removed from the local part. For example, for both
11927 the addresses
11928 .code
11929 "abc:xyz"@test.example
11930 abc\:xyz@test.example
11931 .endd
11932 the value of &$local_part$& is
11933 .code
11934 abc:xyz
11935 .endd
11936 If you use &$local_part$& to create another address, you should always wrap it
11937 inside a quoting operator. For example, in a &(redirect)& router you could
11938 have:
11939 .code
11940 data = ${quote_local_part:$local_part}@new.domain.example
11941 .endd
11942 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11943 to process local parts in a case-dependent manner in a router, you can set the
11944 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11945
11946 .vitem &$local_part_data$&
11947 .vindex "&$local_part_data$&"
11948 When the &%local_parts%& option on a router matches a local part by means of a
11949 lookup, the data read by the lookup is available during the running of the
11950 router as &$local_part_data$&. In addition, if the driver routes the address
11951 to a transport, the value is available in that transport. If the transport is
11952 handling multiple addresses, the value from the first address is used.
11953
11954 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11955 matches a local part by means of a lookup. The data read by the lookup is
11956 available during the rest of the ACL statement. In all other situations, this
11957 variable expands to nothing.
11958
11959 .vitem &$local_part_prefix$&
11960 .vindex "&$local_part_prefix$&"
11961 When an address is being routed or delivered, and a
11962 specific prefix for the local part was recognized, it is available in this
11963 variable, having been removed from &$local_part$&.
11964
11965 .vitem &$local_part_suffix$&
11966 .vindex "&$local_part_suffix$&"
11967 When an address is being routed or delivered, and a
11968 specific suffix for the local part was recognized, it is available in this
11969 variable, having been removed from &$local_part$&.
11970
11971 .vitem &$local_scan_data$&
11972 .vindex "&$local_scan_data$&"
11973 This variable contains the text returned by the &[local_scan()]& function when
11974 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11975
11976 .vitem &$local_user_gid$&
11977 .vindex "&$local_user_gid$&"
11978 See &$local_user_uid$&.
11979
11980 .vitem &$local_user_uid$&
11981 .vindex "&$local_user_uid$&"
11982 This variable and &$local_user_gid$& are set to the uid and gid after the
11983 &%check_local_user%& router precondition succeeds. This means that their values
11984 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11985 and &%condition%&), for the &%address_data%& expansion, and for any
11986 router-specific expansions. At all other times, the values in these variables
11987 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11988
11989 .vitem &$localhost_number$&
11990 .vindex "&$localhost_number$&"
11991 This contains the expanded value of the
11992 &%localhost_number%& option. The expansion happens after the main options have
11993 been read.
11994
11995 .vitem &$log_inodes$&
11996 .vindex "&$log_inodes$&"
11997 The number of free inodes in the disk partition where Exim's
11998 log files are being written. The value is recalculated whenever the variable is
11999 referenced. If the relevant file system does not have the concept of inodes,
12000 the value of is -1. See also the &%check_log_inodes%& option.
12001
12002 .vitem &$log_space$&
12003 .vindex "&$log_space$&"
12004 The amount of free space (as a number of kilobytes) in the disk
12005 partition where Exim's log files are being written. The value is recalculated
12006 whenever the variable is referenced. If the operating system does not have the
12007 ability to find the amount of free space (only true for experimental systems),
12008 the space value is -1. See also the &%check_log_space%& option.
12009
12010
12011 .vitem &$lookup_dnssec_authenticated$&
12012 .vindex "&$lookup_dnssec_authenticated$&"
12013 This variable is set after a DNS lookup done by
12014 a dnsdb lookup expansion, dnslookup router or smtp transport.
12015 .cindex "DNS" "DNSSEC"
12016 It will be empty if &(DNSSEC)& was not requested,
12017 &"no"& if the result was not labelled as authenticated data
12018 and &"yes"& if it was.
12019 Results that are labelled as authoritative answer that match
12020 the &%dns_trust_aa%& configuration variable count also
12021 as authenticated data.
12022
12023 .vitem &$mailstore_basename$&
12024 .vindex "&$mailstore_basename$&"
12025 This variable is set only when doing deliveries in &"mailstore"& format in the
12026 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12027 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12028 contains the basename of the files that are being written, that is, the name
12029 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12030 variable is empty.
12031
12032 .vitem &$malware_name$&
12033 .vindex "&$malware_name$&"
12034 This variable is available when Exim is compiled with the
12035 content-scanning extension. It is set to the name of the virus that was found
12036 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12037
12038 .vitem &$max_received_linelength$&
12039 .vindex "&$max_received_linelength$&"
12040 .cindex "maximum" "line length"
12041 .cindex "line length" "maximum"
12042 This variable contains the number of bytes in the longest line that was
12043 received as part of the message, not counting the line termination
12044 character(s).
12045
12046 .vitem &$message_age$&
12047 .cindex "message" "age of"
12048 .vindex "&$message_age$&"
12049 This variable is set at the start of a delivery attempt to contain the number
12050 of seconds since the message was received. It does not change during a single
12051 delivery attempt.
12052
12053 .vitem &$message_body$&
12054 .cindex "body of message" "expansion variable"
12055 .cindex "message body" "in expansion"
12056 .cindex "binary zero" "in message body"
12057 .vindex "&$message_body$&"
12058 .oindex "&%message_body_visible%&"
12059 This variable contains the initial portion of a message's body while it is
12060 being delivered, and is intended mainly for use in filter files. The maximum
12061 number of characters of the body that are put into the variable is set by the
12062 &%message_body_visible%& configuration option; the default is 500.
12063
12064 .oindex "&%message_body_newlines%&"
12065 By default, newlines are converted into spaces in &$message_body$&, to make it
12066 easier to search for phrases that might be split over a line break. However,
12067 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12068 zeros are always converted into spaces.
12069
12070 .vitem &$message_body_end$&
12071 .cindex "body of message" "expansion variable"
12072 .cindex "message body" "in expansion"
12073 .vindex "&$message_body_end$&"
12074 This variable contains the final portion of a message's
12075 body while it is being delivered. The format and maximum size are as for
12076 &$message_body$&.
12077
12078 .vitem &$message_body_size$&
12079 .cindex "body of message" "size"
12080 .cindex "message body" "size"
12081 .vindex "&$message_body_size$&"
12082 When a message is being delivered, this variable contains the size of the body
12083 in bytes. The count starts from the character after the blank line that
12084 separates the body from the header. Newlines are included in the count. See
12085 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12086
12087 .vitem &$message_exim_id$&
12088 .vindex "&$message_exim_id$&"
12089 When a message is being received or delivered, this variable contains the
12090 unique message id that is generated and used by Exim to identify the message.
12091 An id is not created for a message until after its header has been successfully
12092 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12093 line; it is the local id that Exim assigns to the message, for example:
12094 &`1BXTIK-0001yO-VA`&.
12095
12096 .vitem &$message_headers$&
12097 .vindex &$message_headers$&
12098 This variable contains a concatenation of all the header lines when a message
12099 is being processed, except for lines added by routers or transports. The header
12100 lines are separated by newline characters. Their contents are decoded in the
12101 same way as a header line that is inserted by &%bheader%&.
12102
12103 .vitem &$message_headers_raw$&
12104 .vindex &$message_headers_raw$&
12105 This variable is like &$message_headers$& except that no processing of the
12106 contents of header lines is done.
12107
12108 .vitem &$message_id$&
12109 This is an old name for &$message_exim_id$&. It is now deprecated.
12110
12111 .vitem &$message_linecount$&
12112 .vindex "&$message_linecount$&"
12113 This variable contains the total number of lines in the header and body of the
12114 message. Compare &$body_linecount$&, which is the count for the body only.
12115 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12116 number of lines received. Before delivery happens (that is, before filters,
12117 routers, and transports run) the count is increased to include the
12118 &'Received:'& header line that Exim standardly adds, and also any other header
12119 lines that are added by ACLs. The blank line that separates the message header
12120 from the body is not counted.
12121
12122 As with the special case of &$message_size$&, during the expansion of the
12123 appendfile transport's maildir_tag option in maildir format, the value of
12124 &$message_linecount$& is the precise size of the number of newlines in the
12125 file that has been written (minus one for the blank line between the
12126 header and the body).
12127
12128 Here is an example of the use of this variable in a DATA ACL:
12129 .code
12130 deny message   = Too many lines in message header
12131      condition = \
12132       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12133 .endd
12134 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12135 message has not yet been received.
12136
12137 .vitem &$message_size$&
12138 .cindex "size" "of message"
12139 .cindex "message" "size"
12140 .vindex "&$message_size$&"
12141 When a message is being processed, this variable contains its size in bytes. In
12142 most cases, the size includes those headers that were received with the
12143 message, but not those (such as &'Envelope-to:'&) that are added to individual
12144 deliveries as they are written. However, there is one special case: during the
12145 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12146 doing a delivery in maildir format, the value of &$message_size$& is the
12147 precise size of the file that has been written. See also
12148 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12149
12150 .cindex "RCPT" "value of &$message_size$&"
12151 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12152 contains the size supplied on the MAIL command, or -1 if no size was given. The
12153 value may not, of course, be truthful.
12154
12155 .vitem &$mime_$&&'xxx'&
12156 A number of variables whose names start with &$mime$& are
12157 available when Exim is compiled with the content-scanning extension. For
12158 details, see section &<<SECTscanmimepart>>&.
12159
12160 .vitem "&$n0$& &-- &$n9$&"
12161 These variables are counters that can be incremented by means
12162 of the &%add%& command in filter files.
12163
12164 .vitem &$original_domain$&
12165 .vindex "&$domain$&"
12166 .vindex "&$original_domain$&"
12167 When a top-level address is being processed for delivery, this contains the
12168 same value as &$domain$&. However, if a &"child"& address (for example,
12169 generated by an alias, forward, or filter file) is being processed, this
12170 variable contains the domain of the original address (lower cased). This
12171 differs from &$parent_domain$& only when there is more than one level of
12172 aliasing or forwarding. When more than one address is being delivered in a
12173 single transport run, &$original_domain$& is not set.
12174
12175 If a new address is created by means of a &%deliver%& command in a system
12176 filter, it is set up with an artificial &"parent"& address. This has the local
12177 part &'system-filter'& and the default qualify domain.
12178
12179 .vitem &$original_local_part$&
12180 .vindex "&$local_part$&"
12181 .vindex "&$original_local_part$&"
12182 When a top-level address is being processed for delivery, this contains the
12183 same value as &$local_part$&, unless a prefix or suffix was removed from the
12184 local part, because &$original_local_part$& always contains the full local
12185 part. When a &"child"& address (for example, generated by an alias, forward, or
12186 filter file) is being processed, this variable contains the full local part of
12187 the original address.
12188
12189 If the router that did the redirection processed the local part
12190 case-insensitively, the value in &$original_local_part$& is in lower case.
12191 This variable differs from &$parent_local_part$& only when there is more than
12192 one level of aliasing or forwarding. When more than one address is being
12193 delivered in a single transport run, &$original_local_part$& is not set.
12194
12195 If a new address is created by means of a &%deliver%& command in a system
12196 filter, it is set up with an artificial &"parent"& address. This has the local
12197 part &'system-filter'& and the default qualify domain.
12198
12199 .vitem &$originator_gid$&
12200 .cindex "gid (group id)" "of originating user"
12201 .cindex "sender" "gid"
12202 .vindex "&$caller_gid$&"
12203 .vindex "&$originator_gid$&"
12204 This variable contains the value of &$caller_gid$& that was set when the
12205 message was received. For messages received via the command line, this is the
12206 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12207 normally the gid of the Exim user.
12208
12209 .vitem &$originator_uid$&
12210 .cindex "uid (user id)" "of originating user"
12211 .cindex "sender" "uid"
12212 .vindex "&$caller_uid$&"
12213 .vindex "&$originator_uid$&"
12214 The value of &$caller_uid$& that was set when the message was received. For
12215 messages received via the command line, this is the uid of the sending user.
12216 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12217 user.
12218
12219 .vitem &$parent_domain$&
12220 .vindex "&$parent_domain$&"
12221 This variable is similar to &$original_domain$& (see
12222 above), except that it refers to the immediately preceding parent address.
12223
12224 .vitem &$parent_local_part$&
12225 .vindex "&$parent_local_part$&"
12226 This variable is similar to &$original_local_part$&
12227 (see above), except that it refers to the immediately preceding parent address.
12228
12229 .vitem &$pid$&
12230 .cindex "pid (process id)" "of current process"
12231 .vindex "&$pid$&"
12232 This variable contains the current process id.
12233
12234 .vitem &$pipe_addresses$&
12235 .cindex "filter" "transport filter"
12236 .cindex "transport" "filter"
12237 .vindex "&$pipe_addresses$&"
12238 This is not an expansion variable, but is mentioned here because the string
12239 &`$pipe_addresses`& is handled specially in the command specification for the
12240 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12241 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12242 It cannot be used in general expansion strings, and provokes an &"unknown
12243 variable"& error if encountered.
12244
12245 .vitem &$primary_hostname$&
12246 .vindex "&$primary_hostname$&"
12247 This variable contains the value set by &%primary_hostname%& in the
12248 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12249 a single-component name, Exim calls &[gethostbyname()]& (or
12250 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12251 qualified host name. See also &$smtp_active_hostname$&.
12252
12253
12254 .vitem &$proxy_external_address$& &&&
12255        &$proxy_external_port$& &&&
12256        &$proxy_local_address$& &&&
12257        &$proxy_local_port$& &&&
12258        &$proxy_session$&
12259 These variables are only available when built with Proxy Protocol
12260 or SOCKS5 support.
12261 For details see chapter &<<SECTproxyInbound>>&.
12262
12263 .vitem &$prdr_requested$&
12264 .cindex "PRDR" "variable for"
12265 This variable is set to &"yes"& if PRDR was requested by the client for the
12266 current message, otherwise &"no"&.
12267
12268 .vitem &$prvscheck_address$&
12269 This variable is used in conjunction with the &%prvscheck%& expansion item,
12270 which is described in sections &<<SECTexpansionitems>>& and
12271 &<<SECTverifyPRVS>>&.
12272
12273 .vitem &$prvscheck_keynum$&
12274 This variable is used in conjunction with the &%prvscheck%& expansion item,
12275 which is described in sections &<<SECTexpansionitems>>& and
12276 &<<SECTverifyPRVS>>&.
12277
12278 .vitem &$prvscheck_result$&
12279 This variable is used in conjunction with the &%prvscheck%& expansion item,
12280 which is described in sections &<<SECTexpansionitems>>& and
12281 &<<SECTverifyPRVS>>&.
12282
12283 .vitem &$qualify_domain$&
12284 .vindex "&$qualify_domain$&"
12285 The value set for the &%qualify_domain%& option in the configuration file.
12286
12287 .vitem &$qualify_recipient$&
12288 .vindex "&$qualify_recipient$&"
12289 The value set for the &%qualify_recipient%& option in the configuration file,
12290 or if not set, the value of &$qualify_domain$&.
12291
12292 .vitem &$queue_name$&
12293 .vindex &$queue_name$&
12294 .cindex "named queues"
12295 .cindex queues named
12296 The name of the spool queue in use; empty for the default queue.
12297
12298 .vitem &$rcpt_count$&
12299 .vindex "&$rcpt_count$&"
12300 When a message is being received by SMTP, this variable contains the number of
12301 RCPT commands received for the current message. If this variable is used in a
12302 RCPT ACL, its value includes the current command.
12303
12304 .vitem &$rcpt_defer_count$&
12305 .vindex "&$rcpt_defer_count$&"
12306 .cindex "4&'xx'& responses" "count of"
12307 When a message is being received by SMTP, this variable contains the number of
12308 RCPT commands in the current message that have previously been rejected with a
12309 temporary (4&'xx'&) response.
12310
12311 .vitem &$rcpt_fail_count$&
12312 .vindex "&$rcpt_fail_count$&"
12313 When a message is being received by SMTP, this variable contains the number of
12314 RCPT commands in the current message that have previously been rejected with a
12315 permanent (5&'xx'&) response.
12316
12317 .vitem &$received_count$&
12318 .vindex "&$received_count$&"
12319 This variable contains the number of &'Received:'& header lines in the message,
12320 including the one added by Exim (so its value is always greater than zero). It
12321 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12322 delivering.
12323
12324 .vitem &$received_for$&
12325 .vindex "&$received_for$&"
12326 If there is only a single recipient address in an incoming message, this
12327 variable contains that address when the &'Received:'& header line is being
12328 built. The value is copied after recipient rewriting has happened, but before
12329 the &[local_scan()]& function is run.
12330
12331 .vitem &$received_ip_address$&
12332 .vindex "&$received_ip_address$&"
12333 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12334 variable is set to the address of the local IP interface, and &$received_port$&
12335 is set to the local port number. (The remote IP address and port are in
12336 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12337 the port value is -1 unless it has been set using the &%-oMi%& command line
12338 option.
12339
12340 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12341 could be used, for example, to make the file name for a TLS certificate depend
12342 on which interface and/or port is being used for the incoming connection. The
12343 values of &$received_ip_address$& and &$received_port$& are saved with any
12344 messages that are received, thus making these variables available at delivery
12345 time.
12346 For outbound connections see &$sending_ip_address$&.
12347
12348 .vitem &$received_port$&
12349 .vindex "&$received_port$&"
12350 See &$received_ip_address$&.
12351
12352 .vitem &$received_protocol$&
12353 .vindex "&$received_protocol$&"
12354 When a message is being processed, this variable contains the name of the
12355 protocol by which it was received. Most of the names used by Exim are defined
12356 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12357 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12358 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12359 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12360 connection and the client was successfully authenticated.
12361
12362 Exim uses the protocol name &"smtps"& for the case when encryption is
12363 automatically set up on connection without the use of STARTTLS (see
12364 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12365 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12366 where the client initially uses EHLO, sets up an encrypted connection using
12367 STARTTLS, and then uses HELO afterwards.
12368
12369 The &%-oMr%& option provides a way of specifying a custom protocol name for
12370 messages that are injected locally by trusted callers. This is commonly used to
12371 identify messages that are being re-injected after some kind of scanning.
12372
12373 .vitem &$received_time$&
12374 .vindex "&$received_time$&"
12375 This variable contains the date and time when the current message was received,
12376 as a number of seconds since the start of the Unix epoch.
12377
12378 .vitem &$recipient_data$&
12379 .vindex "&$recipient_data$&"
12380 This variable is set after an indexing lookup success in an ACL &%recipients%&
12381 condition. It contains the data from the lookup, and the value remains set
12382 until the next &%recipients%& test. Thus, you can do things like this:
12383 .display
12384 &`require recipients  = cdb*@;/some/file`&
12385 &`deny    `&&'some further test involving'& &`$recipient_data`&
12386 .endd
12387 &*Warning*&: This variable is set only when a lookup is used as an indexing
12388 method in the address list, using the semicolon syntax as in the example above.
12389 The variable is not set for a lookup that is used as part of the string
12390 expansion that all such lists undergo before being interpreted.
12391
12392 .vitem &$recipient_verify_failure$&
12393 .vindex "&$recipient_verify_failure$&"
12394 In an ACL, when a recipient verification fails, this variable contains
12395 information about the failure. It is set to one of the following words:
12396
12397 .ilist
12398 &"qualify"&: The address was unqualified (no domain), and the message
12399 was neither local nor came from an exempted host.
12400
12401 .next
12402 &"route"&: Routing failed.
12403
12404 .next
12405 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12406 or before the MAIL command (that is, on initial connection, HELO, or
12407 MAIL).
12408
12409 .next
12410 &"recipient"&: The RCPT command in a callout was rejected.
12411 .next
12412
12413 &"postmaster"&: The postmaster check in a callout was rejected.
12414 .endlist
12415
12416 The main use of this variable is expected to be to distinguish between
12417 rejections of MAIL and rejections of RCPT.
12418
12419 .vitem &$recipients$&
12420 .vindex "&$recipients$&"
12421 This variable contains a list of envelope recipients for a message. A comma and
12422 a space separate the addresses in the replacement text. However, the variable
12423 is not generally available, to prevent exposure of Bcc recipients in
12424 unprivileged users' filter files. You can use &$recipients$& only in these
12425 cases:
12426
12427 .olist
12428 In a system filter file.
12429 .next
12430 In the ACLs associated with the DATA command and with non-SMTP messages, that
12431 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12432 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12433 &%acl_not_smtp_mime%&.
12434 .next
12435 From within a &[local_scan()]& function.
12436 .endlist
12437
12438
12439 .vitem &$recipients_count$&
12440 .vindex "&$recipients_count$&"
12441 When a message is being processed, this variable contains the number of
12442 envelope recipients that came with the message. Duplicates are not excluded
12443 from the count. While a message is being received over SMTP, the number
12444 increases for each accepted recipient. It can be referenced in an ACL.
12445
12446
12447 .vitem &$regex_match_string$&
12448 .vindex "&$regex_match_string$&"
12449 This variable is set to contain the matching regular expression after a
12450 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12451
12452 .vitem "&$regex1$&, &$regex2$&, etc"
12453 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12454 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12455 these variables contain the
12456 captured substrings identified by the regular expression.
12457
12458
12459 .vitem &$reply_address$&
12460 .vindex "&$reply_address$&"
12461 When a message is being processed, this variable contains the contents of the
12462 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12463 contents of the &'From:'& header line. Apart from the removal of leading
12464 white space, the value is not processed in any way. In particular, no RFC 2047
12465 decoding or character code translation takes place.
12466
12467 .vitem &$return_path$&
12468 .vindex "&$return_path$&"
12469 When a message is being delivered, this variable contains the return path &--
12470 the sender field that will be sent as part of the envelope. It is not enclosed
12471 in <> characters. At the start of routing an address, &$return_path$& has the
12472 same value as &$sender_address$&, but if, for example, an incoming message to a
12473 mailing list has been expanded by a router which specifies a different address
12474 for bounce messages, &$return_path$& subsequently contains the new bounce
12475 address, whereas &$sender_address$& always contains the original sender address
12476 that was received with the message. In other words, &$sender_address$& contains
12477 the incoming envelope sender, and &$return_path$& contains the outgoing
12478 envelope sender.
12479
12480 .vitem &$return_size_limit$&
12481 .vindex "&$return_size_limit$&"
12482 This is an obsolete name for &$bounce_return_size_limit$&.
12483
12484 .vitem &$router_name$&
12485 .cindex "router" "name"
12486 .cindex "name" "of router"
12487 .vindex "&$router_name$&"
12488 During the running of a router this variable contains its name.
12489
12490 .vitem &$runrc$&
12491 .cindex "return code" "from &%run%& expansion"
12492 .vindex "&$runrc$&"
12493 This variable contains the return code from a command that is run by the
12494 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12495 assume the order in which option values are expanded, except for those
12496 preconditions whose order of testing is documented. Therefore, you cannot
12497 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12498 another.
12499
12500 .vitem &$self_hostname$&
12501 .oindex "&%self%&" "value of host name"
12502 .vindex "&$self_hostname$&"
12503 When an address is routed to a supposedly remote host that turns out to be the
12504 local host, what happens is controlled by the &%self%& generic router option.
12505 One of its values causes the address to be passed to another router. When this
12506 happens, &$self_hostname$& is set to the name of the local host that the
12507 original router encountered. In other circumstances its contents are null.
12508
12509 .vitem &$sender_address$&
12510 .vindex "&$sender_address$&"
12511 When a message is being processed, this variable contains the sender's address
12512 that was received in the message's envelope. The case of letters in the address
12513 is retained, in both the local part and the domain. For bounce messages, the
12514 value of this variable is the empty string. See also &$return_path$&.
12515
12516 .vitem &$sender_address_data$&
12517 .vindex "&$address_data$&"
12518 .vindex "&$sender_address_data$&"
12519 If &$address_data$& is set when the routers are called from an ACL to verify a
12520 sender address, the final value is preserved in &$sender_address_data$&, to
12521 distinguish it from data from a recipient address. The value does not persist
12522 after the end of the current ACL statement. If you want to preserve it for
12523 longer, you can save it in an ACL variable.
12524
12525 .vitem &$sender_address_domain$&
12526 .vindex "&$sender_address_domain$&"
12527 The domain portion of &$sender_address$&.
12528
12529 .vitem &$sender_address_local_part$&
12530 .vindex "&$sender_address_local_part$&"
12531 The local part portion of &$sender_address$&.
12532
12533 .vitem &$sender_data$&
12534 .vindex "&$sender_data$&"
12535 This variable is set after a lookup success in an ACL &%senders%& condition or
12536 in a router &%senders%& option. It contains the data from the lookup, and the
12537 value remains set until the next &%senders%& test. Thus, you can do things like
12538 this:
12539 .display
12540 &`require senders      = cdb*@;/some/file`&
12541 &`deny    `&&'some further test involving'& &`$sender_data`&
12542 .endd
12543 &*Warning*&: This variable is set only when a lookup is used as an indexing
12544 method in the address list, using the semicolon syntax as in the example above.
12545 The variable is not set for a lookup that is used as part of the string
12546 expansion that all such lists undergo before being interpreted.
12547
12548 .vitem &$sender_fullhost$&
12549 .vindex "&$sender_fullhost$&"
12550 When a message is received from a remote host, this variable contains the host
12551 name and IP address in a single string. It ends with the IP address in square
12552 brackets, followed by a colon and a port number if the logging of ports is
12553 enabled. The format of the rest of the string depends on whether the host
12554 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12555 looking up its IP address. (Looking up the IP address can be forced by the
12556 &%host_lookup%& option, independent of verification.) A plain host name at the
12557 start of the string is a verified host name; if this is not present,
12558 verification either failed or was not requested. A host name in parentheses is
12559 the argument of a HELO or EHLO command. This is omitted if it is identical to
12560 the verified host name or to the host's IP address in square brackets.
12561
12562 .vitem &$sender_helo_dnssec$&
12563 .vindex "&$sender_helo_dnssec$&"
12564 This boolean variable is true if a successful HELO verification was
12565 .cindex "DNS" "DNSSEC"
12566 done using DNS information the resolver library stated was authenticated data.
12567
12568 .vitem &$sender_helo_name$&
12569 .vindex "&$sender_helo_name$&"
12570 When a message is received from a remote host that has issued a HELO or EHLO
12571 command, the argument of that command is placed in this variable. It is also
12572 set if HELO or EHLO is used when a message is received using SMTP locally via
12573 the &%-bs%& or &%-bS%& options.
12574
12575 .vitem &$sender_host_address$&
12576 .vindex "&$sender_host_address$&"
12577 When a message is received from a remote host using SMTP,
12578 this variable contains that
12579 host's IP address. For locally non-SMTP submitted messages, it is empty.
12580
12581 .vitem &$sender_host_authenticated$&
12582 .vindex "&$sender_host_authenticated$&"
12583 This variable contains the name (not the public name) of the authenticator
12584 driver that successfully authenticated the client from which the message was
12585 received. It is empty if there was no successful authentication. See also
12586 &$authenticated_id$&.
12587
12588 .vitem &$sender_host_dnssec$&
12589 .vindex "&$sender_host_dnssec$&"
12590 If an attempt to populate &$sender_host_name$& has been made
12591 (by reference, &%hosts_lookup%& or
12592 otherwise) then this boolean will have been set true if, and only if, the
12593 resolver library states that both
12594 the reverse and forward DNS were authenticated data.  At all
12595 other times, this variable is false.
12596
12597 .cindex "DNS" "DNSSEC"
12598 It is likely that you will need to coerce DNSSEC support on in the resolver
12599 library, by setting:
12600 .code
12601 dns_dnssec_ok = 1
12602 .endd
12603
12604 Exim does not perform DNSSEC validation itself, instead leaving that to a
12605 validating resolver (e.g. unbound, or bind with suitable configuration).
12606
12607 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12608 mechanism in the list, then this variable will be false.
12609
12610 .new
12611 This requires that your system resolver library support EDNS0 (and that
12612 DNSSEC flags exist in the system headers).  If the resolver silently drops
12613 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12614 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12615 .wen
12616
12617
12618 .vitem &$sender_host_name$&
12619 .vindex "&$sender_host_name$&"
12620 When a message is received from a remote host, this variable contains the
12621 host's name as obtained by looking up its IP address. For messages received by
12622 other means, this variable is empty.
12623
12624 .vindex "&$host_lookup_failed$&"
12625 If the host name has not previously been looked up, a reference to
12626 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12627 A looked up name is accepted only if it leads back to the original IP address
12628 via a forward lookup. If either the reverse or the forward lookup fails to find
12629 any data, or if the forward lookup does not yield the original IP address,
12630 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12631
12632 .vindex "&$host_lookup_deferred$&"
12633 However, if either of the lookups cannot be completed (for example, there is a
12634 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12635 &$host_lookup_failed$& remains set to &"0"&.
12636
12637 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12638 host name again if there is a subsequent reference to &$sender_host_name$&
12639 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12640 is set to &"1"&.
12641
12642 Exim does not automatically look up every calling host's name. If you want
12643 maximum efficiency, you should arrange your configuration so that it avoids
12644 these lookups altogether. The lookup happens only if one or more of the
12645 following are true:
12646
12647 .ilist
12648 A string containing &$sender_host_name$& is expanded.
12649 .next
12650 The calling host matches the list in &%host_lookup%&. In the default
12651 configuration, this option is set to *, so it must be changed if lookups are
12652 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12653 .next
12654 Exim needs the host name in order to test an item in a host list. The items
12655 that require this are described in sections &<<SECThoslispatnam>>& and
12656 &<<SECThoslispatnamsk>>&.
12657 .next
12658 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12659 In this case, the host name is required to compare with the name quoted in any
12660 EHLO or HELO commands that the client issues.
12661 .next
12662 The remote host issues a EHLO or HELO command that quotes one of the
12663 domains in &%helo_lookup_domains%&. The default value of this option is
12664 . ==== As this is a nested list, any displays it contains must be indented
12665 . ==== as otherwise they are too far to the left.
12666 .code
12667   helo_lookup_domains = @ : @[]
12668 .endd
12669 which causes a lookup if a remote host (incorrectly) gives the server's name or
12670 IP address in an EHLO or HELO command.
12671 .endlist
12672
12673
12674 .vitem &$sender_host_port$&
12675 .vindex "&$sender_host_port$&"
12676 When a message is received from a remote host, this variable contains the port
12677 number that was used on the remote host.
12678
12679 .vitem &$sender_ident$&
12680 .vindex "&$sender_ident$&"
12681 When a message is received from a remote host, this variable contains the
12682 identification received in response to an RFC 1413 request. When a message has
12683 been received locally, this variable contains the login name of the user that
12684 called Exim.
12685
12686 .vitem &$sender_rate_$&&'xxx'&
12687 A number of variables whose names begin &$sender_rate_$& are set as part of the
12688 &%ratelimit%& ACL condition. Details are given in section
12689 &<<SECTratelimiting>>&.
12690
12691 .vitem &$sender_rcvhost$&
12692 .cindex "DNS" "reverse lookup"
12693 .cindex "reverse DNS lookup"
12694 .vindex "&$sender_rcvhost$&"
12695 This is provided specifically for use in &'Received:'& headers. It starts with
12696 either the verified host name (as obtained from a reverse DNS lookup) or, if
12697 there is no verified host name, the IP address in square brackets. After that
12698 there may be text in parentheses. When the first item is a verified host name,
12699 the first thing in the parentheses is the IP address in square brackets,
12700 followed by a colon and a port number if port logging is enabled. When the
12701 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12702 the parentheses.
12703
12704 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12705 was used and its argument was not identical to the real host name or IP
12706 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12707 all three items are present in the parentheses, a newline and tab are inserted
12708 into the string, to improve the formatting of the &'Received:'& header.
12709
12710 .vitem &$sender_verify_failure$&
12711 .vindex "&$sender_verify_failure$&"
12712 In an ACL, when a sender verification fails, this variable contains information
12713 about the failure. The details are the same as for
12714 &$recipient_verify_failure$&.
12715
12716 .vitem &$sending_ip_address$&
12717 .vindex "&$sending_ip_address$&"
12718 This variable is set whenever an outgoing SMTP connection to another host has
12719 been set up. It contains the IP address of the local interface that is being
12720 used. This is useful if a host that has more than one IP address wants to take
12721 on different personalities depending on which one is being used. For incoming
12722 connections, see &$received_ip_address$&.
12723
12724 .vitem &$sending_port$&
12725 .vindex "&$sending_port$&"
12726 This variable is set whenever an outgoing SMTP connection to another host has
12727 been set up. It contains the local port that is being used. For incoming
12728 connections, see &$received_port$&.
12729
12730 .vitem &$smtp_active_hostname$&
12731 .vindex "&$smtp_active_hostname$&"
12732 During an incoming SMTP session, this variable contains the value of the active
12733 host name, as specified by the &%smtp_active_hostname%& option. The value of
12734 &$smtp_active_hostname$& is saved with any message that is received, so its
12735 value can be consulted during routing and delivery.
12736
12737 .vitem &$smtp_command$&
12738 .vindex "&$smtp_command$&"
12739 During the processing of an incoming SMTP command, this variable contains the
12740 entire command. This makes it possible to distinguish between HELO and EHLO in
12741 the HELO ACL, and also to distinguish between commands such as these:
12742 .code
12743 MAIL FROM:<>
12744 MAIL FROM: <>
12745 .endd
12746 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12747 command, the address in &$smtp_command$& is the original address before any
12748 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12749 the address after SMTP-time rewriting.
12750
12751 .vitem &$smtp_command_argument$&
12752 .cindex "SMTP" "command, argument for"
12753 .vindex "&$smtp_command_argument$&"
12754 While an ACL is running to check an SMTP command, this variable contains the
12755 argument, that is, the text that follows the command name, with leading white
12756 space removed. Following the introduction of &$smtp_command$&, this variable is
12757 somewhat redundant, but is retained for backwards compatibility.
12758
12759 .vitem &$smtp_count_at_connection_start$&
12760 .vindex "&$smtp_count_at_connection_start$&"
12761 This variable is set greater than zero only in processes spawned by the Exim
12762 daemon for handling incoming SMTP connections. The name is deliberately long,
12763 in order to emphasize what the contents are. When the daemon accepts a new
12764 connection, it increments this variable. A copy of the variable is passed to
12765 the child process that handles the connection, but its value is fixed, and
12766 never changes. It is only an approximation of how many incoming connections
12767 there actually are, because many other connections may come and go while a
12768 single connection is being processed. When a child process terminates, the
12769 daemon decrements its copy of the variable.
12770
12771 .vitem "&$sn0$& &-- &$sn9$&"
12772 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12773 that were current at the end of the system filter file. This allows a system
12774 filter file to set values that can be tested in users' filter files. For
12775 example, a system filter could set a value indicating how likely it is that a
12776 message is junk mail.
12777
12778 .vitem &$spam_$&&'xxx'&
12779 A number of variables whose names start with &$spam$& are available when Exim
12780 is compiled with the content-scanning extension. For details, see section
12781 &<<SECTscanspamass>>&.
12782
12783
12784 .vitem &$spool_directory$&
12785 .vindex "&$spool_directory$&"
12786 The name of Exim's spool directory.
12787
12788 .vitem &$spool_inodes$&
12789 .vindex "&$spool_inodes$&"
12790 The number of free inodes in the disk partition where Exim's spool files are
12791 being written. The value is recalculated whenever the variable is referenced.
12792 If the relevant file system does not have the concept of inodes, the value of
12793 is -1. See also the &%check_spool_inodes%& option.
12794
12795 .vitem &$spool_space$&
12796 .vindex "&$spool_space$&"
12797 The amount of free space (as a number of kilobytes) in the disk partition where
12798 Exim's spool files are being written. The value is recalculated whenever the
12799 variable is referenced. If the operating system does not have the ability to
12800 find the amount of free space (only true for experimental systems), the space
12801 value is -1. For example, to check in an ACL that there is at least 50
12802 megabytes free on the spool, you could write:
12803 .code
12804 condition = ${if > {$spool_space}{50000}}
12805 .endd
12806 See also the &%check_spool_space%& option.
12807
12808
12809 .vitem &$thisaddress$&
12810 .vindex "&$thisaddress$&"
12811 This variable is set only during the processing of the &%foranyaddress%&
12812 command in a filter file. Its use is explained in the description of that
12813 command, which can be found in the separate document entitled &'Exim's
12814 interfaces to mail filtering'&.
12815
12816 .vitem &$tls_in_bits$&
12817 .vindex "&$tls_in_bits$&"
12818 Contains an approximation of the TLS cipher's bit-strength
12819 on the inbound connection; the meaning of
12820 this depends upon the TLS implementation used.
12821 If TLS has not been negotiated, the value will be 0.
12822 The value of this is automatically fed into the Cyrus SASL authenticator
12823 when acting as a server, to specify the "external SSF" (a SASL term).
12824
12825 The deprecated &$tls_bits$& variable refers to the inbound side
12826 except when used in the context of an outbound SMTP delivery, when it refers to
12827 the outbound.
12828
12829 .vitem &$tls_out_bits$&
12830 .vindex "&$tls_out_bits$&"
12831 Contains an approximation of the TLS cipher's bit-strength
12832 on an outbound SMTP connection; the meaning of
12833 this depends upon the TLS implementation used.
12834 If TLS has not been negotiated, the value will be 0.
12835
12836 .vitem &$tls_in_ourcert$&
12837 .vindex "&$tls_in_ourcert$&"
12838 .cindex certificate variables
12839 This variable refers to the certificate presented to the peer of an
12840 inbound connection when the message was received.
12841 It is only useful as the argument of a
12842 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12843 or a &%def%& condition.
12844
12845 .vitem &$tls_in_peercert$&
12846 .vindex "&$tls_in_peercert$&"
12847 This variable refers to the certificate presented by the peer of an
12848 inbound connection when the message was received.
12849 It is only useful as the argument of a
12850 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12851 or a &%def%& condition.
12852 If certificate verification fails it may refer to a failing chain element
12853 which is not the leaf.
12854
12855 .vitem &$tls_out_ourcert$&
12856 .vindex "&$tls_out_ourcert$&"
12857 This variable refers to the certificate presented to the peer of an
12858 outbound connection.  It is only useful as the argument of a
12859 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12860 or a &%def%& condition.
12861
12862 .vitem &$tls_out_peercert$&
12863 .vindex "&$tls_out_peercert$&"
12864 This variable refers to the certificate presented by the peer of an
12865 outbound connection.  It is only useful as the argument of a
12866 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12867 or a &%def%& condition.
12868 If certificate verification fails it may refer to a failing chain element
12869 which is not the leaf.
12870
12871 .vitem &$tls_in_certificate_verified$&
12872 .vindex "&$tls_in_certificate_verified$&"
12873 This variable is set to &"1"& if a TLS certificate was verified when the
12874 message was received, and &"0"& otherwise.
12875
12876 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12877 except when used in the context of an outbound SMTP delivery, when it refers to
12878 the outbound.
12879
12880 .vitem &$tls_out_certificate_verified$&
12881 .vindex "&$tls_out_certificate_verified$&"
12882 This variable is set to &"1"& if a TLS certificate was verified when an
12883 outbound SMTP connection was made,
12884 and &"0"& otherwise.
12885
12886 .vitem &$tls_in_cipher$&
12887 .vindex "&$tls_in_cipher$&"
12888 .vindex "&$tls_cipher$&"
12889 When a message is received from a remote host over an encrypted SMTP
12890 connection, this variable is set to the cipher suite that was negotiated, for
12891 example DES-CBC3-SHA. In other circumstances, in particular, for message
12892 received over unencrypted connections, the variable is empty. Testing
12893 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12894 non-encrypted connections during ACL processing.
12895
12896 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12897 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12898 becomes the same as &$tls_out_cipher$&.
12899
12900 .vitem &$tls_out_cipher$&
12901 .vindex "&$tls_out_cipher$&"
12902 This variable is
12903 cleared before any outgoing SMTP connection is made,
12904 and then set to the outgoing cipher suite if one is negotiated. See chapter
12905 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12906 details of the &(smtp)& transport.
12907
12908 .vitem &$tls_in_ocsp$&
12909 .vindex "&$tls_in_ocsp$&"
12910 When a message is received from a remote client connection
12911 the result of any OCSP request from the client is encoded in this variable:
12912 .code
12913 0 OCSP proof was not requested (default value)
12914 1 No response to request
12915 2 Response not verified
12916 3 Verification failed
12917 4 Verification succeeded
12918 .endd
12919
12920 .vitem &$tls_out_ocsp$&
12921 .vindex "&$tls_out_ocsp$&"
12922 When a message is sent to a remote host connection
12923 the result of any OCSP request made is encoded in this variable.
12924 See &$tls_in_ocsp$& for values.
12925
12926 .vitem &$tls_in_peerdn$&
12927 .vindex "&$tls_in_peerdn$&"
12928 .vindex "&$tls_peerdn$&"
12929 .cindex certificate "extracting fields"
12930 When a message is received from a remote host over an encrypted SMTP
12931 connection, and Exim is configured to request a certificate from the client,
12932 the value of the Distinguished Name of the certificate is made available in the
12933 &$tls_in_peerdn$& during subsequent processing.
12934 If certificate verification fails it may refer to a failing chain element
12935 which is not the leaf.
12936
12937 The deprecated &$tls_peerdn$& variable refers to the inbound side
12938 except when used in the context of an outbound SMTP delivery, when it refers to
12939 the outbound.
12940
12941 .vitem &$tls_out_peerdn$&
12942 .vindex "&$tls_out_peerdn$&"
12943 When a message is being delivered to a remote host over an encrypted SMTP
12944 connection, and Exim is configured to request a certificate from the server,
12945 the value of the Distinguished Name of the certificate is made available in the
12946 &$tls_out_peerdn$& during subsequent processing.
12947 If certificate verification fails it may refer to a failing chain element
12948 which is not the leaf.
12949
12950 .vitem &$tls_in_sni$&
12951 .vindex "&$tls_in_sni$&"
12952 .vindex "&$tls_sni$&"
12953 .cindex "TLS" "Server Name Indication"
12954 When a TLS session is being established, if the client sends the Server
12955 Name Indication extension, the value will be placed in this variable.
12956 If the variable appears in &%tls_certificate%& then this option and
12957 some others, described in &<<SECTtlssni>>&,
12958 will be re-expanded early in the TLS session, to permit
12959 a different certificate to be presented (and optionally a different key to be
12960 used) to the client, based upon the value of the SNI extension.
12961
12962 The deprecated &$tls_sni$& variable refers to the inbound side
12963 except when used in the context of an outbound SMTP delivery, when it refers to
12964 the outbound.
12965
12966 .vitem &$tls_out_sni$&
12967 .vindex "&$tls_out_sni$&"
12968 .cindex "TLS" "Server Name Indication"
12969 During outbound
12970 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12971 the transport.
12972
12973 .vitem &$tod_bsdinbox$&
12974 .vindex "&$tod_bsdinbox$&"
12975 The time of day and the date, in the format required for BSD-style mailbox
12976 files, for example: Thu Oct 17 17:14:09 1995.
12977
12978 .vitem &$tod_epoch$&
12979 .vindex "&$tod_epoch$&"
12980 The time and date as a number of seconds since the start of the Unix epoch.
12981
12982 .vitem &$tod_epoch_l$&
12983 .vindex "&$tod_epoch_l$&"
12984 The time and date as a number of microseconds since the start of the Unix epoch.
12985
12986 .vitem &$tod_full$&
12987 .vindex "&$tod_full$&"
12988 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12989 +0100. The timezone is always given as a numerical offset from UTC, with
12990 positive values used for timezones that are ahead (east) of UTC, and negative
12991 values for those that are behind (west).
12992
12993 .vitem &$tod_log$&
12994 .vindex "&$tod_log$&"
12995 The time and date in the format used for writing Exim's log files, for example:
12996 1995-10-12 15:32:29, but without a timezone.
12997
12998 .vitem &$tod_logfile$&
12999 .vindex "&$tod_logfile$&"
13000 This variable contains the date in the format yyyymmdd. This is the format that
13001 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13002 flag.
13003
13004 .vitem &$tod_zone$&
13005 .vindex "&$tod_zone$&"
13006 This variable contains the numerical value of the local timezone, for example:
13007 -0500.
13008
13009 .vitem &$tod_zulu$&
13010 .vindex "&$tod_zulu$&"
13011 This variable contains the UTC date and time in &"Zulu"& format, as specified
13012 by ISO 8601, for example: 20030221154023Z.
13013
13014 .vitem &$transport_name$&
13015 .cindex "transport" "name"
13016 .cindex "name" "of transport"
13017 .vindex "&$transport_name$&"
13018 During the running of a transport, this variable contains its name.
13019
13020 .vitem &$value$&
13021 .vindex "&$value$&"
13022 This variable contains the result of an expansion lookup, extraction operation,
13023 or external command, as described above. It is also used during a
13024 &*reduce*& expansion.
13025
13026 .vitem &$verify_mode$&
13027 .vindex "&$verify_mode$&"
13028 While a router or transport is being run in verify mode or for cutthrough delivery,
13029 contains "S" for sender-verification or "R" for recipient-verification.
13030 Otherwise, empty.
13031
13032 .vitem &$version_number$&
13033 .vindex "&$version_number$&"
13034 The version number of Exim.
13035
13036 .vitem &$warn_message_delay$&
13037 .vindex "&$warn_message_delay$&"
13038 This variable is set only during the creation of a message warning about a
13039 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13040
13041 .vitem &$warn_message_recipients$&
13042 .vindex "&$warn_message_recipients$&"
13043 This variable is set only during the creation of a message warning about a
13044 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13045 .endlist
13046 .ecindex IIDstrexp
13047
13048
13049
13050 . ////////////////////////////////////////////////////////////////////////////
13051 . ////////////////////////////////////////////////////////////////////////////
13052
13053 .chapter "Embedded Perl" "CHAPperl"
13054 .scindex IIDperl "Perl" "calling from Exim"
13055 Exim can be built to include an embedded Perl interpreter. When this is done,
13056 Perl subroutines can be called as part of the string expansion process. To make
13057 use of the Perl support, you need version 5.004 or later of Perl installed on
13058 your system. To include the embedded interpreter in the Exim binary, include
13059 the line
13060 .code
13061 EXIM_PERL = perl.o
13062 .endd
13063 in your &_Local/Makefile_& and then build Exim in the normal way.
13064
13065
13066 .section "Setting up so Perl can be used" "SECID85"
13067 .oindex "&%perl_startup%&"
13068 Access to Perl subroutines is via a global configuration option called
13069 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13070 no &%perl_startup%& option in the Exim configuration file then no Perl
13071 interpreter is started and there is almost no overhead for Exim (since none of
13072 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13073 option then the associated value is taken to be Perl code which is executed in
13074 a newly created Perl interpreter.
13075
13076 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13077 need backslashes before any characters to escape special meanings. The option
13078 should usually be something like
13079 .code
13080 perl_startup = do '/etc/exim.pl'
13081 .endd
13082 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13083 use from Exim. Exim can be configured either to start up a Perl interpreter as
13084 soon as it is entered, or to wait until the first time it is needed. Starting
13085 the interpreter at the beginning ensures that it is done while Exim still has
13086 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13087 fact used in a particular run. Also, note that this does not mean that Exim is
13088 necessarily running as root when Perl is called at a later time. By default,
13089 the interpreter is started only when it is needed, but this can be changed in
13090 two ways:
13091
13092 .ilist
13093 .oindex "&%perl_at_start%&"
13094 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13095 a startup when Exim is entered.
13096 .next
13097 The command line option &%-ps%& also requests a startup when Exim is entered,
13098 overriding the setting of &%perl_at_start%&.
13099 .endlist
13100
13101 There is also a command line option &%-pd%& (for delay) which suppresses the
13102 initial startup, even if &%perl_at_start%& is set.
13103
13104 .ilist
13105 .oindex "&%perl_taintmode%&"
13106 .cindex "Perl" "taintmode"
13107 To provide more security executing Perl code via the embedded Perl
13108 interpreter, the &%perl_taintmode%& option can be set. This enables the
13109 taint mode of the Perl interpreter. You are encouraged to set this
13110 option to a true value. To avoid breaking existing installations, it
13111 defaults to false.
13112
13113
13114 .section "Calling Perl subroutines" "SECID86"
13115 When the configuration file includes a &%perl_startup%& option you can make use
13116 of the string expansion item to call the Perl subroutines that are defined
13117 by the &%perl_startup%& code. The operator is used in any of the following
13118 forms:
13119 .code
13120 ${perl{foo}}
13121 ${perl{foo}{argument}}
13122 ${perl{foo}{argument1}{argument2} ... }
13123 .endd
13124 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13125 arguments may be passed. Passing more than this results in an expansion failure
13126 with an error message of the form
13127 .code
13128 Too many arguments passed to Perl subroutine "foo" (max is 8)
13129 .endd
13130 The return value of the Perl subroutine is evaluated in a scalar context before
13131 it is passed back to Exim to be inserted into the expanded string. If the
13132 return value is &'undef'&, the expansion is forced to fail in the same way as
13133 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13134 by obeying Perl's &%die%& function, the expansion fails with the error message
13135 that was passed to &%die%&.
13136
13137
13138 .section "Calling Exim functions from Perl" "SECID87"
13139 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13140 is available to call back into Exim's string expansion function. For example,
13141 the Perl code
13142 .code
13143 my $lp = Exim::expand_string('$local_part');
13144 .endd
13145 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13146 Note those are single quotes and not double quotes to protect against
13147 &$local_part$& being interpolated as a Perl variable.
13148
13149 If the string expansion is forced to fail by a &"fail"& item, the result of
13150 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13151 expansion string, the Perl call from the original expansion string fails with
13152 an appropriate error message, in the same way as if &%die%& were used.
13153
13154 .cindex "debugging" "from embedded Perl"
13155 .cindex "log" "writing from embedded Perl"
13156 Two other Exim functions are available for use from within Perl code.
13157 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13158 debugging is enabled. If you want a newline at the end, you must supply it.
13159 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13160 timestamp. In this case, you should not supply a terminating newline.
13161
13162
13163 .section "Use of standard output and error by Perl" "SECID88"
13164 .cindex "Perl" "standard output and error"
13165 You should not write to the standard error or output streams from within your
13166 Perl code, as it is not defined how these are set up. In versions of Exim
13167 before 4.50, it is possible for the standard output or error to refer to the
13168 SMTP connection during message reception via the daemon. Writing to this stream
13169 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13170 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13171 avoided, but the output is lost.
13172
13173 .cindex "Perl" "use of &%warn%&"
13174 The Perl &%warn%& statement writes to the standard error stream by default.
13175 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13176 you have no control. When Exim starts up the Perl interpreter, it arranges for
13177 output from the &%warn%& statement to be written to the Exim main log. You can
13178 change this by including appropriate Perl magic somewhere in your Perl code.
13179 For example, to discard &%warn%& output completely, you need this:
13180 .code
13181 $SIG{__WARN__} = sub { };
13182 .endd
13183 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13184 example, the code for the subroutine is empty, so it does nothing, but you can
13185 include any Perl code that you like. The text of the &%warn%& message is passed
13186 as the first subroutine argument.
13187 .ecindex IIDperl
13188
13189
13190 . ////////////////////////////////////////////////////////////////////////////
13191 . ////////////////////////////////////////////////////////////////////////////
13192
13193 .chapter "Starting the daemon and the use of network interfaces" &&&
13194          "CHAPinterfaces" &&&
13195          "Starting the daemon"
13196 .cindex "daemon" "starting"
13197 .cindex "interface" "listening"
13198 .cindex "network interface"
13199 .cindex "interface" "network"
13200 .cindex "IP address" "for listening"
13201 .cindex "daemon" "listening IP addresses"
13202 .cindex "TCP/IP" "setting listening interfaces"
13203 .cindex "TCP/IP" "setting listening ports"
13204 A host that is connected to a TCP/IP network may have one or more physical
13205 hardware network interfaces. Each of these interfaces may be configured as one
13206 or more &"logical"& interfaces, which are the entities that a program actually
13207 works with. Each of these logical interfaces is associated with an IP address.
13208 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13209 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13210 knowledge about the host's interfaces for use in three different circumstances:
13211
13212 .olist
13213 When a listening daemon is started, Exim needs to know which interfaces
13214 and ports to listen on.
13215 .next
13216 When Exim is routing an address, it needs to know which IP addresses
13217 are associated with local interfaces. This is required for the correct
13218 processing of MX lists by removing the local host and others with the
13219 same or higher priority values. Also, Exim needs to detect cases
13220 when an address is routed to an IP address that in fact belongs to the
13221 local host. Unless the &%self%& router option or the &%allow_localhost%&
13222 option of the smtp transport is set (as appropriate), this is treated
13223 as an error situation.
13224 .next
13225 When Exim connects to a remote host, it may need to know which interface to use
13226 for the outgoing connection.
13227 .endlist
13228
13229
13230 Exim's default behaviour is likely to be appropriate in the vast majority
13231 of cases. If your host has only one interface, and you want all its IP
13232 addresses to be treated in the same way, and you are using only the
13233 standard SMTP port, you should not need to take any special action. The
13234 rest of this chapter does not apply to you.
13235
13236 In a more complicated situation you may want to listen only on certain
13237 interfaces, or on different ports, and for this reason there are a number of
13238 options that can be used to influence Exim's behaviour. The rest of this
13239 chapter describes how they operate.
13240
13241 When a message is received over TCP/IP, the interface and port that were
13242 actually used are set in &$received_ip_address$& and &$received_port$&.
13243
13244
13245
13246 .section "Starting a listening daemon" "SECID89"
13247 When a listening daemon is started (by means of the &%-bd%& command line
13248 option), the interfaces and ports on which it listens are controlled by the
13249 following options:
13250
13251 .ilist
13252 &%daemon_smtp_ports%& contains a list of default ports
13253 or service names.
13254 (For backward compatibility, this option can also be specified in the singular.)
13255 .next
13256 &%local_interfaces%& contains list of interface IP addresses on which to
13257 listen. Each item may optionally also specify a port.
13258 .endlist
13259
13260 The default list separator in both cases is a colon, but this can be changed as
13261 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13262 it is usually best to change the separator to avoid having to double all the
13263 colons. For example:
13264 .code
13265 local_interfaces = <; 127.0.0.1 ; \
13266                       192.168.23.65 ; \
13267                       ::1 ; \
13268                       3ffe:ffff:836f::fe86:a061
13269 .endd
13270 There are two different formats for specifying a port along with an IP address
13271 in &%local_interfaces%&:
13272
13273 .olist
13274 The port is added onto the address with a dot separator. For example, to listen
13275 on port 1234 on two different IP addresses:
13276 .code
13277 local_interfaces = <; 192.168.23.65.1234 ; \
13278                       3ffe:ffff:836f::fe86:a061.1234
13279 .endd
13280 .next
13281 The IP address is enclosed in square brackets, and the port is added
13282 with a colon separator, for example:
13283 .code
13284 local_interfaces = <; [192.168.23.65]:1234 ; \
13285                       [3ffe:ffff:836f::fe86:a061]:1234
13286 .endd
13287 .endlist
13288
13289 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13290 default setting contains just one port:
13291 .code
13292 daemon_smtp_ports = smtp
13293 .endd
13294 If more than one port is listed, each interface that does not have its own port
13295 specified listens on all of them. Ports that are listed in
13296 &%daemon_smtp_ports%& can be identified either by name (defined in
13297 &_/etc/services_&) or by number. However, when ports are given with individual
13298 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13299
13300
13301
13302 .section "Special IP listening addresses" "SECID90"
13303 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13304 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13305 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13306 instead of setting up separate listening sockets for each interface. The
13307 default value of &%local_interfaces%& is
13308 .code
13309 local_interfaces = 0.0.0.0
13310 .endd
13311 when Exim is built without IPv6 support; otherwise it is:
13312 .code
13313 local_interfaces = <; ::0 ; 0.0.0.0
13314 .endd
13315 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13316
13317
13318
13319 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13320 The &%-oX%& command line option can be used to override the values of
13321 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13322 instance. Another way of doing this would be to use macros and the &%-D%&
13323 option. However, &%-oX%& can be used by any admin user, whereas modification of
13324 the runtime configuration by &%-D%& is allowed only when the caller is root or
13325 exim.
13326
13327 The value of &%-oX%& is a list of items. The default colon separator can be
13328 changed in the usual way if required. If there are any items that do not
13329 contain dots or colons (that is, are not IP addresses), the value of
13330 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13331 items that do contain dots or colons, the value of &%local_interfaces%& is
13332 replaced by those items. Thus, for example,
13333 .code
13334 -oX 1225
13335 .endd
13336 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13337 whereas
13338 .code
13339 -oX 192.168.34.5.1125
13340 .endd
13341 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13342 (However, since &%local_interfaces%& now contains no items without ports, the
13343 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13344
13345
13346
13347 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13348 .cindex "ssmtp protocol"
13349 .cindex "smtps protocol"
13350 .cindex "SMTP" "ssmtp protocol"
13351 .cindex "SMTP" "smtps protocol"
13352 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13353 before the STARTTLS command was standardized for SMTP. Some legacy clients
13354 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13355 list of port numbers or service names,
13356 connections to those ports must use SSMTP. The most
13357 common use of this option is expected to be
13358 .code
13359 tls_on_connect_ports = 465
13360 .endd
13361 because 465 is the usual port number used by the legacy clients. There is also
13362 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13363 this way when a daemon is started.
13364
13365 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13366 daemon to listen on those ports. You must still specify them in
13367 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13368 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13369 connections via the daemon.)
13370
13371
13372
13373
13374 .section "IPv6 address scopes" "SECID92"
13375 .cindex "IPv6" "address scopes"
13376 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13377 can, in principle, have the same link-local IPv6 address on different
13378 interfaces. Thus, additional information is needed, over and above the IP
13379 address, to distinguish individual interfaces. A convention of using a
13380 percent sign followed by something (often the interface name) has been
13381 adopted in some cases, leading to addresses like this:
13382 .code
13383 fe80::202:b3ff:fe03:45c1%eth0
13384 .endd
13385 To accommodate this usage, a percent sign followed by an arbitrary string is
13386 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13387 to convert a textual IPv6 address for actual use. This function recognizes the
13388 percent convention in operating systems that support it, and it processes the
13389 address appropriately. Unfortunately, some older libraries have problems with
13390 &[getaddrinfo()]&. If
13391 .code
13392 IPV6_USE_INET_PTON=yes
13393 .endd
13394 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13395 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13396 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13397 function.) Of course, this means that the additional functionality of
13398 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13399
13400 .section "Disabling IPv6" "SECID93"
13401 .cindex "IPv6" "disabling"
13402 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13403 run on a host whose kernel does not support IPv6. The binary will fall back to
13404 using IPv4, but it may waste resources looking up AAAA records, and trying to
13405 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13406 .oindex "&%disable_ipv6%&"
13407 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13408 activities take place. AAAA records are never looked up, and any IPv6 addresses
13409 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13410 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13411 to handle IPv6 literal addresses.
13412
13413 On the other hand, when IPv6 is in use, there may be times when you want to
13414 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13415 option to globally suppress the lookup of AAAA records for specified domains,
13416 and you can use the &%ignore_target_hosts%& generic router option to ignore
13417 IPv6 addresses in an individual router.
13418
13419
13420
13421 .section "Examples of starting a listening daemon" "SECID94"
13422 The default case in an IPv6 environment is
13423 .code
13424 daemon_smtp_ports = smtp
13425 local_interfaces = <; ::0 ; 0.0.0.0
13426 .endd
13427 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13428 Either one or two sockets may be used, depending on the characteristics of
13429 the TCP/IP stack. (This is complicated and messy; for more information,
13430 read the comments in the &_daemon.c_& source file.)
13431
13432 To specify listening on ports 25 and 26 on all interfaces:
13433 .code
13434 daemon_smtp_ports = 25 : 26
13435 .endd
13436 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13437 .code
13438 local_interfaces = <; ::0.25     ; ::0.26 \
13439                       0.0.0.0.25 ; 0.0.0.0.26
13440 .endd
13441 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13442 IPv4 loopback address only:
13443 .code
13444 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13445 .endd
13446 To specify listening on the default port on specific interfaces only:
13447 .code
13448 local_interfaces = 10.0.0.67 : 192.168.34.67
13449 .endd
13450 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13451
13452
13453
13454 .section "Recognizing the local host" "SECTreclocipadd"
13455 The &%local_interfaces%& option is also used when Exim needs to determine
13456 whether or not an IP address refers to the local host. That is, the IP
13457 addresses of all the interfaces on which a daemon is listening are always
13458 treated as local.
13459
13460 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13461 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13462 available interfaces from the operating system, and extracts the relevant
13463 (that is, IPv4 or IPv6) addresses to use for checking.
13464
13465 Some systems set up large numbers of virtual interfaces in order to provide
13466 many virtual web servers. In this situation, you may want to listen for
13467 email on only a few of the available interfaces, but nevertheless treat all
13468 interfaces as local when routing. You can do this by setting
13469 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13470 &"all"& wildcard values. These addresses are recognized as local, but are not
13471 used for listening. Consider this example:
13472 .code
13473 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13474                       192.168.53.235 ; \
13475                       3ffe:2101:12:1:a00:20ff:fe86:a061
13476
13477 extra_local_interfaces = <; ::0 ; 0.0.0.0
13478 .endd
13479 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13480 address, but all available interface addresses are treated as local when
13481 Exim is routing.
13482
13483 In some environments the local host name may be in an MX list, but with an IP
13484 address that is not assigned to any local interface. In other cases it may be
13485 desirable to treat other host names as if they referred to the local host. Both
13486 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13487 This contains host names rather than IP addresses. When a host is referenced
13488 during routing, either via an MX record or directly, it is treated as the local
13489 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13490 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13491
13492
13493
13494 .section "Delivering to a remote host" "SECID95"
13495 Delivery to a remote host is handled by the smtp transport. By default, it
13496 allows the system's TCP/IP functions to choose which interface to use (if
13497 there is more than one) when connecting to a remote host. However, the
13498 &%interface%& option can be set to specify which interface is used. See the
13499 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13500 details.
13501
13502
13503
13504
13505 . ////////////////////////////////////////////////////////////////////////////
13506 . ////////////////////////////////////////////////////////////////////////////
13507
13508 .chapter "Main configuration" "CHAPmainconfig"
13509 .scindex IIDconfima "configuration file" "main section"
13510 .scindex IIDmaiconf "main configuration"
13511 The first part of the run time configuration file contains three types of item:
13512
13513 .ilist
13514 Macro definitions: These lines start with an upper case letter. See section
13515 &<<SECTmacrodefs>>& for details of macro processing.
13516 .next
13517 Named list definitions: These lines start with one of the words &"domainlist"&,
13518 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13519 section &<<SECTnamedlists>>&.
13520 .next
13521 Main configuration settings: Each setting occupies one line of the file
13522 (with possible continuations). If any setting is preceded by the word
13523 &"hide"&, the &%-bP%& command line option displays its value to admin users
13524 only. See section &<<SECTcos>>& for a description of the syntax of these option
13525 settings.
13526 .endlist
13527
13528 This chapter specifies all the main configuration options, along with their
13529 types and default values. For ease of finding a particular option, they appear
13530 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13531 are now so many options, they are first listed briefly in functional groups, as
13532 an aid to finding the name of the option you are looking for. Some options are
13533 listed in more than one group.
13534
13535 .section "Miscellaneous" "SECID96"
13536 .table2
13537 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13538 .row &%debug_store%&                 "do extra internal checks"
13539 .row &%disable_ipv6%&                "do no IPv6 processing"
13540 .row &%keep_malformed%&              "for broken files &-- should not happen"
13541 .row &%localhost_number%&            "for unique message ids in clusters"
13542 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13543 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13544 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13545 .row &%print_topbitchars%&           "top-bit characters are printing"
13546 .row &%timezone%&                    "force time zone"
13547 .endtable
13548
13549
13550 .section "Exim parameters" "SECID97"
13551 .table2
13552 .row &%exim_group%&                  "override compiled-in value"
13553 .row &%exim_path%&                   "override compiled-in value"
13554 .row &%exim_user%&                   "override compiled-in value"
13555 .row &%primary_hostname%&            "default from &[uname()]&"
13556 .row &%split_spool_directory%&       "use multiple directories"
13557 .row &%spool_directory%&             "override compiled-in value"
13558 .endtable
13559
13560
13561
13562 .section "Privilege controls" "SECID98"
13563 .table2
13564 .row &%admin_groups%&                "groups that are Exim admin users"
13565 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13566 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13567 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13568 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13569 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13570 .row &%never_users%&                 "do not run deliveries as these"
13571 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13572 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13573 .row &%trusted_groups%&              "groups that are trusted"
13574 .row &%trusted_users%&               "users that are trusted"
13575 .endtable
13576
13577
13578
13579 .section "Logging" "SECID99"
13580 .table2
13581 .row &%event_action%&                "custom logging"
13582 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13583 .row &%log_file_path%&               "override compiled-in value"
13584 .row &%log_selector%&                "set/unset optional logging"
13585 .row &%log_timezone%&                "add timezone to log lines"
13586 .row &%message_logs%&                "create per-message logs"
13587 .row &%preserve_message_logs%&       "after message completion"
13588 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13589 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13590 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13591 .row &%syslog_facility%&             "set syslog &""facility""& field"
13592 .row &%syslog_pid%&                  "pid in syslog lines"
13593 .row &%syslog_processname%&          "set syslog &""ident""& field"
13594 .row &%syslog_timestamp%&            "timestamp syslog lines"
13595 .row &%write_rejectlog%&             "control use of message log"
13596 .endtable
13597
13598
13599
13600 .section "Frozen messages" "SECID100"
13601 .table2
13602 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13603 .row &%freeze_tell%&                 "send message when freezing"
13604 .row &%move_frozen_messages%&        "to another directory"
13605 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13606 .endtable
13607
13608
13609
13610 .section "Data lookups" "SECID101"
13611 .table2
13612 .row &%ibase_servers%&               "InterBase servers"
13613 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13614 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13615 .row &%ldap_cert_file%&              "client cert file for LDAP"
13616 .row &%ldap_cert_key%&               "client key file for LDAP"
13617 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13618 .row &%ldap_default_servers%&        "used if no server in query"
13619 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13620 .row &%ldap_start_tls%&              "require TLS within LDAP"
13621 .row &%ldap_version%&                "set protocol version"
13622 .row &%lookup_open_max%&             "lookup files held open"
13623 .row &%mysql_servers%&               "default MySQL servers"
13624 .row &%oracle_servers%&              "Oracle servers"
13625 .row &%pgsql_servers%&               "default PostgreSQL servers"
13626 .row &%sqlite_lock_timeout%&         "as it says"
13627 .endtable
13628
13629
13630
13631 .section "Message ids" "SECID102"
13632 .table2
13633 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13634 .row &%message_id_header_text%&      "ditto"
13635 .endtable
13636
13637
13638
13639 .section "Embedded Perl Startup" "SECID103"
13640 .table2
13641 .row &%perl_at_start%&               "always start the interpreter"
13642 .row &%perl_startup%&                "code to obey when starting Perl"
13643 .row &%perl_taintmode%&              "enable taint mode in Perl"
13644 .endtable
13645
13646
13647
13648 .section "Daemon" "SECID104"
13649 .table2
13650 .row &%daemon_smtp_ports%&           "default ports"
13651 .row &%daemon_startup_retries%&      "number of times to retry"
13652 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13653 .row &%extra_local_interfaces%&      "not necessarily listened on"
13654 .row &%local_interfaces%&            "on which to listen, with optional ports"
13655 .row &%pid_file_path%&               "override compiled-in value"
13656 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13657 .endtable
13658
13659
13660
13661 .section "Resource control" "SECID105"
13662 .table2
13663 .row &%check_log_inodes%&            "before accepting a message"
13664 .row &%check_log_space%&             "before accepting a message"
13665 .row &%check_spool_inodes%&          "before accepting a message"
13666 .row &%check_spool_space%&           "before accepting a message"
13667 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13668 .row &%queue_only_load%&             "queue incoming if load high"
13669 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13670 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13671 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13672 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13673 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13674 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13675 .row &%smtp_accept_max_per_connection%& "messages per connection"
13676 .row &%smtp_accept_max_per_host%&    "connections from one host"
13677 .row &%smtp_accept_queue%&           "queue mail if more connections"
13678 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13679                                            connection"
13680 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13681 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13682 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13683 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13684 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13685 .endtable
13686
13687
13688
13689 .section "Policy controls" "SECID106"
13690 .table2
13691 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13692 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13693 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13694 .row &%acl_smtp_auth%&               "ACL for AUTH"
13695 .row &%acl_smtp_connect%&            "ACL for connection"
13696 .row &%acl_smtp_data%&               "ACL for DATA"
13697 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13698 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13699 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13700 .row &%acl_smtp_expn%&               "ACL for EXPN"
13701 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13702 .row &%acl_smtp_mail%&               "ACL for MAIL"
13703 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13704 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13705 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13706 .row &%acl_smtp_predata%&            "ACL for start of data"
13707 .row &%acl_smtp_quit%&               "ACL for QUIT"
13708 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13709 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13710 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13711 .row &%av_scanner%&                  "specify virus scanner"
13712 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13713                                       words""&"
13714 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13715 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13716 .row &%header_maxsize%&              "total size of message header"
13717 .row &%header_line_maxsize%&         "individual header line limit"
13718 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13719 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13720 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13721 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13722 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13723 .row &%host_lookup%&                 "host name looked up for these hosts"
13724 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13725 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13726 .row &%host_reject_connection%&      "reject connection from these hosts"
13727 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13728 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13729 .row &%message_size_limit%&          "for all messages"
13730 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13731 .row &%spamd_address%&               "set interface to SpamAssassin"
13732 .row &%strict_acl_vars%&             "object to unset ACL variables"
13733 .endtable
13734
13735
13736
13737 .section "Callout cache" "SECID107"
13738 .table2
13739 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13740                                          item"
13741 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13742                                          item"
13743 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13744 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13745 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13746 .endtable
13747
13748
13749
13750 .section "TLS" "SECID108"
13751 .table2
13752 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13753 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13754 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13755 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13756 .row &%tls_certificate%&             "location of server certificate"
13757 .row &%tls_crl%&                     "certificate revocation list"
13758 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13759 .row &%tls_dhparam%&                 "DH parameters for server"
13760 .row &%tls_eccurve%&                 "EC curve selection for server"
13761 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13762 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13763 .row &%tls_privatekey%&              "location of server private key"
13764 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13765 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13766 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13767 .row &%tls_verify_certificates%&     "expected client certificates"
13768 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13769 .endtable
13770
13771
13772
13773 .section "Local user handling" "SECID109"
13774 .table2
13775 .row &%finduser_retries%&            "useful in NIS environments"
13776 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13777 .row &%gecos_pattern%&               "ditto"
13778 .row &%max_username_length%&         "for systems that truncate"
13779 .row &%unknown_login%&               "used when no login name found"
13780 .row &%unknown_username%&            "ditto"
13781 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13782 .row &%uucp_from_sender%&            "ditto"
13783 .endtable
13784
13785
13786
13787 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13788 .table2
13789 .row &%header_maxsize%&              "total size of message header"
13790 .row &%header_line_maxsize%&         "individual header line limit"
13791 .row &%message_size_limit%&          "applies to all messages"
13792 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13793 .row &%received_header_text%&        "expanded to make &'Received:'&"
13794 .row &%received_headers_max%&        "for mail loop detection"
13795 .row &%recipients_max%&              "limit per message"
13796 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13797 .endtable
13798
13799
13800
13801
13802 .section "Non-SMTP incoming messages" "SECID111"
13803 .table2
13804 .row &%receive_timeout%&             "for non-SMTP messages"
13805 .endtable
13806
13807
13808
13809
13810
13811 .section "Incoming SMTP messages" "SECID112"
13812 See also the &'Policy controls'& section above.
13813
13814 .table2
13815 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13816 .row &%host_lookup%&                 "host name looked up for these hosts"
13817 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13818 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13819 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13820 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13821 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13822 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13823 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13824 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13825 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13826 .row &%smtp_accept_max_per_connection%& "messages per connection"
13827 .row &%smtp_accept_max_per_host%&    "connections from one host"
13828 .row &%smtp_accept_queue%&           "queue mail if more connections"
13829 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13830                                            connection"
13831 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13832 .row &%smtp_active_hostname%&        "host name to use in messages"
13833 .row &%smtp_banner%&                 "text for welcome banner"
13834 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13835 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13836 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13837 .row &%smtp_etrn_command%&           "what to run for ETRN"
13838 .row &%smtp_etrn_serialize%&         "only one at once"
13839 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13840 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13841 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13842 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13843 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13844 .row &%smtp_receive_timeout%&        "per command or data line"
13845 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13846 .row &%smtp_return_error_details%&   "give detail on rejections"
13847 .endtable
13848
13849
13850
13851 .section "SMTP extensions" "SECID113"
13852 .table2
13853 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13854 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13855 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13856 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13857 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13858 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13859 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13860 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13861 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13862 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13863 .endtable
13864
13865
13866
13867 .section "Processing messages" "SECID114"
13868 .table2
13869 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13870 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13871 .row &%allow_utf8_domains%&          "in addresses"
13872 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13873                                       words""&"
13874 .row &%delivery_date_remove%&        "from incoming messages"
13875 .row &%envelope_to_remove%&          "from incoming messages"
13876 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13877 .row &%headers_charset%&             "default for translations"
13878 .row &%qualify_domain%&              "default for senders"
13879 .row &%qualify_recipient%&           "default for recipients"
13880 .row &%return_path_remove%&          "from incoming messages"
13881 .row &%strip_excess_angle_brackets%& "in addresses"
13882 .row &%strip_trailing_dot%&          "at end of addresses"
13883 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13884 .endtable
13885
13886
13887
13888 .section "System filter" "SECID115"
13889 .table2
13890 .row &%system_filter%&               "locate system filter"
13891 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13892                                             directory"
13893 .row &%system_filter_file_transport%& "transport for delivery to a file"
13894 .row &%system_filter_group%&         "group for filter running"
13895 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13896 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13897 .row &%system_filter_user%&          "user for filter running"
13898 .endtable
13899
13900
13901
13902 .section "Routing and delivery" "SECID116"
13903 .table2
13904 .row &%disable_ipv6%&                "do no IPv6 processing"
13905 .row &%dns_again_means_nonexist%&    "for broken domains"
13906 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13907 .row &%dns_dnssec_ok%&               "parameter for resolver"
13908 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13909 .row &%dns_retrans%&                 "parameter for resolver"
13910 .row &%dns_retry%&                   "parameter for resolver"
13911 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13912 .row &%dns_use_edns0%&               "parameter for resolver"
13913 .row &%hold_domains%&                "hold delivery for these domains"
13914 .row &%local_interfaces%&            "for routing checks"
13915 .row &%queue_domains%&               "no immediate delivery for these"
13916 .row &%queue_only%&                  "no immediate delivery at all"
13917 .row &%queue_only_file%&             "no immediate delivery if file exists"
13918 .row &%queue_only_load%&             "no immediate delivery if load is high"
13919 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13920 .row &%queue_only_override%&         "allow command line to override"
13921 .row &%queue_run_in_order%&          "order of arrival"
13922 .row &%queue_run_max%&               "of simultaneous queue runners"
13923 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13924 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13925 .row &%remote_sort_domains%&         "order of remote deliveries"
13926 .row &%retry_data_expire%&           "timeout for retry data"
13927 .row &%retry_interval_max%&          "safety net for retry rules"
13928 .endtable
13929
13930
13931
13932 .section "Bounce and warning messages" "SECID117"
13933 .table2
13934 .row &%bounce_message_file%&         "content of bounce"
13935 .row &%bounce_message_text%&         "content of bounce"
13936 .row &%bounce_return_body%&          "include body if returning message"
13937 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13938 .row &%bounce_return_message%&       "include original message in bounce"
13939 .row &%bounce_return_size_limit%&    "limit on returned message"
13940 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13941 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13942 .row &%errors_copy%&                 "copy bounce messages"
13943 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13944 .row &%delay_warning%&               "time schedule"
13945 .row &%delay_warning_condition%&     "condition for warning messages"
13946 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13947 .row &%smtp_return_error_details%&   "give detail on rejections"
13948 .row &%warn_message_file%&           "content of warning message"
13949 .endtable
13950
13951
13952
13953 .section "Alphabetical list of main options" "SECTalomo"
13954 Those options that undergo string expansion before use are marked with
13955 &dagger;.
13956
13957 .option accept_8bitmime main boolean true
13958 .cindex "8BITMIME"
13959 .cindex "8-bit characters"
13960 .cindex "log" "selectors"
13961 .cindex "log" "8BITMIME"
13962 This option causes Exim to send 8BITMIME in its response to an SMTP
13963 EHLO command, and to accept the BODY= parameter on MAIL commands.
13964 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13965 takes no steps to do anything special with messages received by this route.
13966
13967 Historically Exim kept this option off by default, but the maintainers
13968 feel that in today's Internet, this causes more problems than it solves.
13969 It now defaults to true.
13970 A more detailed analysis of the issues is provided by Dan Bernstein:
13971 .display
13972 &url(http://cr.yp.to/smtp/8bitmime.html)
13973 .endd
13974
13975 To log received 8BITMIME status use
13976 .code
13977 log_selector = +8bitmime
13978 .endd
13979
13980 .option acl_not_smtp main string&!! unset
13981 .cindex "&ACL;" "for non-SMTP messages"
13982 .cindex "non-SMTP messages" "ACLs for"
13983 This option defines the ACL that is run when a non-SMTP message has been
13984 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13985 further details.
13986
13987 .option acl_not_smtp_mime main string&!! unset
13988 This option defines the ACL that is run for individual MIME parts of non-SMTP
13989 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13990 SMTP messages.
13991
13992 .option acl_not_smtp_start main string&!! unset
13993 .cindex "&ACL;" "at start of non-SMTP message"
13994 .cindex "non-SMTP messages" "ACLs for"
13995 This option defines the ACL that is run before Exim starts reading a
13996 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13997
13998 .option acl_smtp_auth main string&!! unset
13999 .cindex "&ACL;" "setting up for SMTP commands"
14000 .cindex "AUTH" "ACL for"
14001 This option defines the ACL that is run when an SMTP AUTH command is
14002 received. See chapter &<<CHAPACL>>& for further details.
14003
14004 .option acl_smtp_connect main string&!! unset
14005 .cindex "&ACL;" "on SMTP connection"
14006 This option defines the ACL that is run when an SMTP connection is received.
14007 See chapter &<<CHAPACL>>& for further details.
14008
14009 .option acl_smtp_data main string&!! unset
14010 .cindex "DATA" "ACL for"
14011 This option defines the ACL that is run after an SMTP DATA command has been
14012 processed and the message itself has been received, but before the final
14013 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14014
14015 .option acl_smtp_data_prdr main string&!! accept
14016 .cindex "PRDR" "ACL for"
14017 .cindex "DATA" "PRDR ACL for"
14018 .cindex "&ACL;" "PRDR-related"
14019 .cindex "&ACL;" "per-user data processing"
14020 This option defines the ACL that,
14021 if the PRDR feature has been negotiated,
14022 is run for each recipient after an SMTP DATA command has been
14023 processed and the message itself has been received, but before the
14024 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14025
14026 .option acl_smtp_dkim main string&!! unset
14027 .cindex DKIM "ACL for"
14028 This option defines the ACL that is run for each DKIM signature
14029 (by default, or as specified in the dkim_verify_signers option)
14030 of a received message.
14031 See chapter &<<CHAPdkim>>& for further details.
14032
14033 .option acl_smtp_etrn main string&!! unset
14034 .cindex "ETRN" "ACL for"
14035 This option defines the ACL that is run when an SMTP ETRN command is
14036 received. See chapter &<<CHAPACL>>& for further details.
14037
14038 .option acl_smtp_expn main string&!! unset
14039 .cindex "EXPN" "ACL for"
14040 This option defines the ACL that is run when an SMTP EXPN command is
14041 received. See chapter &<<CHAPACL>>& for further details.
14042
14043 .option acl_smtp_helo main string&!! unset
14044 .cindex "EHLO" "ACL for"
14045 .cindex "HELO" "ACL for"
14046 This option defines the ACL that is run when an SMTP EHLO or HELO
14047 command is received. See chapter &<<CHAPACL>>& for further details.
14048
14049
14050 .option acl_smtp_mail main string&!! unset
14051 .cindex "MAIL" "ACL for"
14052 This option defines the ACL that is run when an SMTP MAIL command is
14053 received. See chapter &<<CHAPACL>>& for further details.
14054
14055 .option acl_smtp_mailauth main string&!! unset
14056 .cindex "AUTH" "on MAIL command"
14057 This option defines the ACL that is run when there is an AUTH parameter on
14058 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14059 &<<CHAPSMTPAUTH>>& for details of authentication.
14060
14061 .option acl_smtp_mime main string&!! unset
14062 .cindex "MIME content scanning" "ACL for"
14063 This option is available when Exim is built with the content-scanning
14064 extension. It defines the ACL that is run for each MIME part in a message. See
14065 section &<<SECTscanmimepart>>& for details.
14066
14067 .option acl_smtp_notquit main string&!! unset
14068 .cindex "not-QUIT, ACL for"
14069 This option defines the ACL that is run when an SMTP session
14070 ends without a QUIT command being received.
14071 See chapter &<<CHAPACL>>& for further details.
14072
14073 .option acl_smtp_predata main string&!! unset
14074 This option defines the ACL that is run when an SMTP DATA command is
14075 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14076 further details.
14077
14078 .option acl_smtp_quit main string&!! unset
14079 .cindex "QUIT, ACL for"
14080 This option defines the ACL that is run when an SMTP QUIT command is
14081 received. See chapter &<<CHAPACL>>& for further details.
14082
14083 .option acl_smtp_rcpt main string&!! unset
14084 .cindex "RCPT" "ACL for"
14085 This option defines the ACL that is run when an SMTP RCPT command is
14086 received. See chapter &<<CHAPACL>>& for further details.
14087
14088 .option acl_smtp_starttls main string&!! unset
14089 .cindex "STARTTLS, ACL for"
14090 This option defines the ACL that is run when an SMTP STARTTLS command is
14091 received. See chapter &<<CHAPACL>>& for further details.
14092
14093 .option acl_smtp_vrfy main string&!! unset
14094 .cindex "VRFY" "ACL for"
14095 This option defines the ACL that is run when an SMTP VRFY command is
14096 received. See chapter &<<CHAPACL>>& for further details.
14097
14098 .option add_environment main "string list" empty
14099 .cindex "environment" "set values"
14100 This option allows to set individual environment variables that the
14101 currently linked libraries and programs in child processes use.
14102 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14103
14104 .option admin_groups main "string list&!!" unset
14105 .cindex "admin user"
14106 This option is expanded just once, at the start of Exim's processing. If the
14107 current group or any of the supplementary groups of an Exim caller is in this
14108 colon-separated list, the caller has admin privileges. If all your system
14109 programmers are in a specific group, for example, you can give them all Exim
14110 admin privileges by putting that group in &%admin_groups%&. However, this does
14111 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14112 To permit this, you have to add individuals to the Exim group.
14113
14114 .option allow_domain_literals main boolean false
14115 .cindex "domain literal"
14116 If this option is set, the RFC 2822 domain literal format is permitted in
14117 email addresses. The option is not set by default, because the domain literal
14118 format is not normally required these days, and few people know about it. It
14119 has, however, been exploited by mail abusers.
14120
14121 Unfortunately, it seems that some DNS black list maintainers are using this
14122 format to report black listing to postmasters. If you want to accept messages
14123 addressed to your hosts by IP address, you need to set
14124 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14125 domains (defined in the named domain list &%local_domains%& in the default
14126 configuration). This &"magic string"& matches the domain literal form of all
14127 the local host's IP addresses.
14128
14129
14130 .option allow_mx_to_ip main boolean false
14131 .cindex "MX record" "pointing to IP address"
14132 It appears that more and more DNS zone administrators are breaking the rules
14133 and putting domain names that look like IP addresses on the right hand side of
14134 MX records. Exim follows the rules and rejects this, giving an error message
14135 that explains the misconfiguration. However, some other MTAs support this
14136 practice, so to avoid &"Why can't Exim do this?"& complaints,
14137 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14138 recommended, except when you have no other choice.
14139
14140 .option allow_utf8_domains main boolean false
14141 .cindex "domain" "UTF-8 characters in"
14142 .cindex "UTF-8" "in domain name"
14143 Lots of discussion is going on about internationalized domain names. One
14144 camp is strongly in favour of just using UTF-8 characters, and it seems
14145 that at least two other MTAs permit this. This option allows Exim users to
14146 experiment if they wish.
14147
14148 If it is set true, Exim's domain parsing function allows valid
14149 UTF-8 multicharacters to appear in domain name components, in addition to
14150 letters, digits, and hyphens. However, just setting this option is not
14151 enough; if you want to look up these domain names in the DNS, you must also
14152 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14153 suitable setting is:
14154 .code
14155 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14156   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14157 .endd
14158 Alternatively, you can just disable this feature by setting
14159 .code
14160 dns_check_names_pattern =
14161 .endd
14162 That is, set the option to an empty string so that no check is done.
14163
14164
14165 .option auth_advertise_hosts main "host list&!!" *
14166 .cindex "authentication" "advertising"
14167 .cindex "AUTH" "advertising"
14168 If any server authentication mechanisms are configured, Exim advertises them in
14169 response to an EHLO command only if the calling host matches this list.
14170 Otherwise, Exim does not advertise AUTH.
14171 Exim does not accept AUTH commands from clients to which it has not
14172 advertised the availability of AUTH. The advertising of individual
14173 authentication mechanisms can be controlled by the use of the
14174 &%server_advertise_condition%& generic authenticator option on the individual
14175 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14176
14177 Certain mail clients (for example, Netscape) require the user to provide a name
14178 and password for authentication if AUTH is advertised, even though it may
14179 not be needed (the host may accept messages from hosts on its local LAN without
14180 authentication, for example). The &%auth_advertise_hosts%& option can be used
14181 to make these clients more friendly by excluding them from the set of hosts to
14182 which Exim advertises AUTH.
14183
14184 .cindex "AUTH" "advertising when encrypted"
14185 If you want to advertise the availability of AUTH only when the connection
14186 is encrypted using TLS, you can make use of the fact that the value of this
14187 option is expanded, with a setting like this:
14188 .code
14189 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14190 .endd
14191 .vindex "&$tls_in_cipher$&"
14192 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14193 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14194 expansion is *, which matches all hosts.
14195
14196
14197 .option auto_thaw main time 0s
14198 .cindex "thawing messages"
14199 .cindex "unfreezing messages"
14200 If this option is set to a time greater than zero, a queue runner will try a
14201 new delivery attempt on any frozen message, other than a bounce message, if
14202 this much time has passed since it was frozen. This may result in the message
14203 being re-frozen if nothing has changed since the last attempt. It is a way of
14204 saying &"keep on trying, even though there are big problems"&.
14205
14206 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14207 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14208 thought to be very useful any more, and its use should probably be avoided.
14209
14210
14211 .option av_scanner main string "see below"
14212 This option is available if Exim is built with the content-scanning extension.
14213 It specifies which anti-virus scanner to use. The default value is:
14214 .code
14215 sophie:/var/run/sophie
14216 .endd
14217 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14218 before use. See section &<<SECTscanvirus>>& for further details.
14219
14220
14221 .option bi_command main string unset
14222 .oindex "&%-bi%&"
14223 This option supplies the name of a command that is run when Exim is called with
14224 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14225 just the command name, it is not a complete command line. If an argument is
14226 required, it must come from the &%-oA%& command line option.
14227
14228
14229 .option bounce_message_file main string unset
14230 .cindex "bounce message" "customizing"
14231 .cindex "customizing" "bounce message"
14232 This option defines a template file containing paragraphs of text to be used
14233 for constructing bounce messages.  Details of the file's contents are given in
14234 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14235
14236
14237 .option bounce_message_text main string unset
14238 When this option is set, its contents are included in the default bounce
14239 message immediately after &"This message was created automatically by mail
14240 delivery software."& It is not used if &%bounce_message_file%& is set.
14241
14242 .option bounce_return_body main boolean true
14243 .cindex "bounce message" "including body"
14244 This option controls whether the body of an incoming message is included in a
14245 bounce message when &%bounce_return_message%& is true. The default setting
14246 causes the entire message, both header and body, to be returned (subject to the
14247 value of &%bounce_return_size_limit%&). If this option is false, only the
14248 message header is included. In the case of a non-SMTP message containing an
14249 error that is detected during reception, only those header lines preceding the
14250 point at which the error was detected are returned.
14251 .cindex "bounce message" "including original"
14252
14253 .option bounce_return_linesize_limit main integer 998
14254 .cindex "size" "of bounce lines, limit"
14255 .cindex "bounce message" "line length limit"
14256 .cindex "limit" "bounce message line length"
14257 This option sets a limit in bytes on the line length of messages
14258 that are returned to senders due to delivery problems,
14259 when &%bounce_return_message%& is true.
14260 The default value corresponds to RFC limits.
14261 If the message being returned has lines longer than this value it is
14262 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14263
14264 The option also applies to bounces returned when an error is detected
14265 during reception of a message.
14266 In this case lines from the original are truncated.
14267
14268 The option does not apply to messages generated by an &(autoreply)& transport.
14269
14270
14271 .option bounce_return_message main boolean true
14272 If this option is set false, none of the original message is included in
14273 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14274 &%bounce_return_body%&.
14275
14276
14277 .option bounce_return_size_limit main integer 100K
14278 .cindex "size" "of bounce, limit"
14279 .cindex "bounce message" "size limit"
14280 .cindex "limit" "bounce message size"
14281 This option sets a limit in bytes on the size of messages that are returned to
14282 senders as part of bounce messages when &%bounce_return_message%& is true. The
14283 limit should be less than the value of the global &%message_size_limit%& and of
14284 any &%message_size_limit%& settings on transports, to allow for the bounce text
14285 that Exim generates. If this option is set to zero there is no limit.
14286
14287 When the body of any message that is to be included in a bounce message is
14288 greater than the limit, it is truncated, and a comment pointing this out is
14289 added at the top. The actual cutoff may be greater than the value given, owing
14290 to the use of buffering for transferring the message in chunks (typically 8K in
14291 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14292 messages.
14293
14294 .option bounce_sender_authentication main string unset
14295 .cindex "bounce message" "sender authentication"
14296 .cindex "authentication" "bounce message"
14297 .cindex "AUTH" "on bounce message"
14298 This option provides an authenticated sender address that is sent with any
14299 bounce messages generated by Exim that are sent over an authenticated SMTP
14300 connection. A typical setting might be:
14301 .code
14302 bounce_sender_authentication = mailer-daemon@my.domain.example
14303 .endd
14304 which would cause bounce messages to be sent using the SMTP command:
14305 .code
14306 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14307 .endd
14308 The value of &%bounce_sender_authentication%& must always be a complete email
14309 address.
14310
14311 .option callout_domain_negative_expire main time 3h
14312 .cindex "caching" "callout timeouts"
14313 .cindex "callout" "caching timeouts"
14314 This option specifies the expiry time for negative callout cache data for a
14315 domain. See section &<<SECTcallver>>& for details of callout verification, and
14316 section &<<SECTcallvercache>>& for details of the caching.
14317
14318
14319 .option callout_domain_positive_expire main time 7d
14320 This option specifies the expiry time for positive callout cache data for a
14321 domain. See section &<<SECTcallver>>& for details of callout verification, and
14322 section &<<SECTcallvercache>>& for details of the caching.
14323
14324
14325 .option callout_negative_expire main time 2h
14326 This option specifies the expiry time for negative callout cache data for an
14327 address. See section &<<SECTcallver>>& for details of callout verification, and
14328 section &<<SECTcallvercache>>& for details of the caching.
14329
14330
14331 .option callout_positive_expire main time 24h
14332 This option specifies the expiry time for positive callout cache data for an
14333 address. See section &<<SECTcallver>>& for details of callout verification, and
14334 section &<<SECTcallvercache>>& for details of the caching.
14335
14336
14337 .option callout_random_local_part main string&!! "see below"
14338 This option defines the &"random"& local part that can be used as part of
14339 callout verification. The default value is
14340 .code
14341 $primary_hostname-$tod_epoch-testing
14342 .endd
14343 See section &<<CALLaddparcall>>& for details of how this value is used.
14344
14345
14346 .option check_log_inodes main integer 100
14347 See &%check_spool_space%& below.
14348
14349
14350 .option check_log_space main integer 10M
14351 See &%check_spool_space%& below.
14352
14353 .oindex "&%check_rfc2047_length%&"
14354 .cindex "RFC 2047" "disabling length check"
14355 .option check_rfc2047_length main boolean true
14356 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14357 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14358 word; strings to be encoded that exceed this length are supposed to use
14359 multiple encoded words. By default, Exim does not recognize encoded words that
14360 exceed the maximum length. However, it seems that some software, in violation
14361 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14362 set false, Exim recognizes encoded words of any length.
14363
14364
14365 .option check_spool_inodes main integer 100
14366 See &%check_spool_space%& below.
14367
14368
14369 .option check_spool_space main integer 10M
14370 .cindex "checking disk space"
14371 .cindex "disk space, checking"
14372 .cindex "spool directory" "checking space"
14373 The four &%check_...%& options allow for checking of disk resources before a
14374 message is accepted.
14375
14376 .vindex "&$log_inodes$&"
14377 .vindex "&$log_space$&"
14378 .vindex "&$spool_inodes$&"
14379 .vindex "&$spool_space$&"
14380 When any of these options are nonzero, they apply to all incoming messages. If you
14381 want to apply different checks to different kinds of message, you can do so by
14382 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14383 &$spool_space$& in an ACL with appropriate additional conditions.
14384
14385
14386 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14387 either value is greater than zero, for example:
14388 .code
14389 check_spool_space = 100M
14390 check_spool_inodes = 100
14391 .endd
14392 The spool partition is the one that contains the directory defined by
14393 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14394 transit.
14395
14396 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14397 files are written if either is greater than zero. These should be set only if
14398 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14399
14400 If there is less space or fewer inodes than requested, Exim refuses to accept
14401 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14402 error response to the MAIL command. If ESMTP is in use and there was a
14403 SIZE parameter on the MAIL command, its value is added to the
14404 &%check_spool_space%& value, and the check is performed even if
14405 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14406
14407 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14408 number of kilobytes (though specified in bytes).
14409 If a non-multiple of 1024 is specified, it is rounded up.
14410
14411 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14412 failure a message is written to stderr and Exim exits with a non-zero code, as
14413 it obviously cannot send an error message of any kind.
14414
14415 There is a slight performance penalty for these checks.
14416 Versions of Exim preceding 4.88 had these disabled by default;
14417 high-rate installations confident they will never run out of resources
14418 may wish to deliberately disable them.
14419
14420 .option chunking_advertise_hosts main "host list&!!" *
14421 .cindex CHUNKING advertisement
14422 .cindex "RFC 3030" "CHUNKING"
14423 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14424 these hosts.
14425 Hosts may use the BDAT command as an alternate to DATA.
14426
14427 .new
14428 .option debug_store main boolean &`false`&
14429 .cindex debugging "memory corruption"
14430 .cindex memory debugging
14431 This option, when true, enables extra checking in Exim's internal memory
14432 management.  For use when a memory corruption issue is being investigated,
14433 it should normally be left as default.
14434 .wen
14435
14436 .option daemon_smtp_ports main string &`smtp`&
14437 .cindex "port" "for daemon"
14438 .cindex "TCP/IP" "setting listening ports"
14439 This option specifies one or more default SMTP ports on which the Exim daemon
14440 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14441 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14442
14443 .option daemon_startup_retries main integer 9
14444 .cindex "daemon startup, retrying"
14445 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14446 the daemon at startup when it cannot immediately bind a listening socket
14447 (typically because the socket is already in use): &%daemon_startup_retries%&
14448 defines the number of retries after the first failure, and
14449 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14450
14451 .option daemon_startup_sleep main time 30s
14452 See &%daemon_startup_retries%&.
14453
14454 .option delay_warning main "time list" 24h
14455 .cindex "warning of delay"
14456 .cindex "delay warning, specifying"
14457 .cindex "queue" "delay warning"
14458 When a message is delayed, Exim sends a warning message to the sender at
14459 intervals specified by this option. The data is a colon-separated list of times
14460 after which to send warning messages. If the value of the option is an empty
14461 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14462 message has been on the queue for longer than the last time, the last interval
14463 between the times is used to compute subsequent warning times. For example,
14464 with
14465 .code
14466 delay_warning = 4h:8h:24h
14467 .endd
14468 the first message is sent after 4 hours, the second after 8 hours, and
14469 the third one after 24 hours. After that, messages are sent every 16 hours,
14470 because that is the interval between the last two times on the list. If you set
14471 just one time, it specifies the repeat interval. For example, with:
14472 .code
14473 delay_warning = 6h
14474 .endd
14475 messages are repeated every six hours. To stop warnings after a given time, set
14476 a very large time at the end of the list. For example:
14477 .code
14478 delay_warning = 2h:12h:99d
14479 .endd
14480 Note that the option is only evaluated at the time a delivery attempt fails,
14481 which depends on retry and queue-runner configuration.
14482 Typically retries will be configured more frequently than warning messages.
14483
14484 .option delay_warning_condition main string&!! "see below"
14485 .vindex "&$domain$&"
14486 The string is expanded at the time a warning message might be sent. If all the
14487 deferred addresses have the same domain, it is set in &$domain$& during the
14488 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14489 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14490 &"false"& (the comparison being done caselessly) then the warning message is
14491 not sent. The default is:
14492 .code
14493 delay_warning_condition = ${if or {\
14494   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14495   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14496   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14497   } {no}{yes}}
14498 .endd
14499 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14500 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14501 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14502 &"auto-replied"& in an &'Auto-Submitted:'& header.
14503
14504 .option deliver_drop_privilege main boolean false
14505 .cindex "unprivileged delivery"
14506 .cindex "delivery" "unprivileged"
14507 If this option is set true, Exim drops its root privilege at the start of a
14508 delivery process, and runs as the Exim user throughout. This severely restricts
14509 the kinds of local delivery that are possible, but is viable in certain types
14510 of configuration. There is a discussion about the use of root privilege in
14511 chapter &<<CHAPsecurity>>&.
14512
14513 .option deliver_queue_load_max main fixed-point unset
14514 .cindex "load average"
14515 .cindex "queue runner" "abandoning"
14516 When this option is set, a queue run is abandoned if the system load average
14517 becomes greater than the value of the option. The option has no effect on
14518 ancient operating systems on which Exim cannot determine the load average.
14519 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14520
14521
14522 .option delivery_date_remove main boolean true
14523 .cindex "&'Delivery-date:'& header line"
14524 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14525 message when it is delivered, in exactly the same way as &'Return-path:'& is
14526 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14527 should not be present in incoming messages, and this option causes them to be
14528 removed at the time the message is received, to avoid any problems that might
14529 occur when a delivered message is subsequently sent on to some other recipient.
14530
14531 .option disable_fsync main boolean false
14532 .cindex "&[fsync()]&, disabling"
14533 This option is available only if Exim was built with the compile-time option
14534 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14535 a runtime configuration generates an &"unknown option"& error. You should not
14536 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14537 really, really, really understand what you are doing. &'No pre-compiled
14538 distributions of Exim should ever make this option available.'&
14539
14540 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14541 updated files' data to be written to disc before continuing. Unexpected events
14542 such as crashes and power outages may cause data to be lost or scrambled.
14543 Here be Dragons. &*Beware.*&
14544
14545
14546 .option disable_ipv6 main boolean false
14547 .cindex "IPv6" "disabling"
14548 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14549 activities take place. AAAA records are never looked up, and any IPv6 addresses
14550 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14551 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14552 to handle IPv6 literal addresses.
14553
14554
14555 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14556 .cindex DKIM "controlling calls to the ACL"
14557 This option gives a list of DKIM domains for which the DKIM ACL is run.
14558 It is expanded after the message is received; by default it runs
14559 the ACL once for each signature in the message.
14560 See chapter &<<CHAPdkim>>&.
14561
14562
14563 .option dns_again_means_nonexist main "domain list&!!" unset
14564 .cindex "DNS" "&""try again""& response; overriding"
14565 DNS lookups give a &"try again"& response for the DNS errors
14566 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14567 keep trying to deliver a message, or to give repeated temporary errors to
14568 incoming mail. Sometimes the effect is caused by a badly set up name server and
14569 may persist for a long time. If a domain which exhibits this problem matches
14570 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14571 This option should be used with care. You can make it apply to reverse lookups
14572 by a setting such as this:
14573 .code
14574 dns_again_means_nonexist = *.in-addr.arpa
14575 .endd
14576 This option applies to all DNS lookups that Exim does. It also applies when the
14577 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14578 since these are most likely to be caused by DNS lookup problems. The
14579 &(dnslookup)& router has some options of its own for controlling what happens
14580 when lookups for MX or SRV records give temporary errors. These more specific
14581 options are applied after this global option.
14582
14583 .option dns_check_names_pattern main string "see below"
14584 .cindex "DNS" "pre-check of name syntax"
14585 When this option is set to a non-empty string, it causes Exim to check domain
14586 names for characters that are not allowed in host names before handing them to
14587 the DNS resolver, because some resolvers give temporary errors for names that
14588 contain unusual characters. If a domain name contains any unwanted characters,
14589 a &"not found"& result is forced, and the resolver is not called. The check is
14590 done by matching the domain name against a regular expression, which is the
14591 value of this option. The default pattern is
14592 .code
14593 dns_check_names_pattern = \
14594   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14595 .endd
14596 which permits only letters, digits, slashes, and hyphens in components, but
14597 they must start and end with a letter or digit. Slashes are not, in fact,
14598 permitted in host names, but they are found in certain NS records (which can be
14599 accessed in Exim by using a &%dnsdb%& lookup). If you set
14600 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14601 empty string.
14602
14603 .option dns_csa_search_limit main integer 5
14604 This option controls the depth of parental searching for CSA SRV records in the
14605 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14606
14607 .option dns_csa_use_reverse main boolean true
14608 This option controls whether or not an IP address, given as a CSA domain, is
14609 reversed and looked up in the reverse DNS, as described in more detail in
14610 section &<<SECTverifyCSA>>&.
14611
14612
14613 .option dns_dnssec_ok main integer -1
14614 .cindex "DNS" "resolver options"
14615 .cindex "DNS" "DNSSEC"
14616 If this option is set to a non-negative number then Exim will initialise the
14617 DNS resolver library to either use or not use DNSSEC, overriding the system
14618 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14619
14620 If the resolver library does not support DNSSEC then this option has no effect.
14621
14622
14623 .option dns_ipv4_lookup main "domain list&!!" unset
14624 .cindex "IPv6" "DNS lookup for AAAA records"
14625 .cindex "DNS" "IPv6 lookup for AAAA records"
14626 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14627 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14628 (A records) when trying to find IP addresses for hosts, unless the host's
14629 domain matches this list.
14630
14631 This is a fudge to help with name servers that give big delays or otherwise do
14632 not work for the AAAA record type. In due course, when the world's name
14633 servers have all been upgraded, there should be no need for this option.
14634
14635
14636 .option dns_retrans main time 0s
14637 .cindex "DNS" "resolver options"
14638 .cindex timeout "dns lookup"
14639 .cindex "DNS" timeout
14640 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14641 retransmission and retry parameters for DNS lookups. Values of zero (the
14642 defaults) leave the system default settings unchanged. The first value is the
14643 time between retries, and the second is the number of retries. It isn't
14644 totally clear exactly how these settings affect the total time a DNS lookup may
14645 take. I haven't found any documentation about timeouts on DNS lookups; these
14646 parameter values are available in the external resolver interface structure,
14647 but nowhere does it seem to describe how they are used or what you might want
14648 to set in them.
14649 See also the &%slow_lookup_log%& option.
14650
14651
14652 .option dns_retry main integer 0
14653 See &%dns_retrans%& above.
14654
14655
14656 .option dns_trust_aa main "domain list&!!" unset
14657 .cindex "DNS" "resolver options"
14658 .cindex "DNS" "DNSSEC"
14659 If this option is set then lookup results marked with the AA bit
14660 (Authoritative Answer) are trusted the same way as if they were
14661 DNSSEC-verified. The authority section's name of the answer must
14662 match with this expanded domain list.
14663
14664 Use this option only if you talk directly to a resolver that is
14665 authoritative for some zones and does not set the AD (Authentic Data)
14666 bit in the answer. Some DNS servers may have an configuration option to
14667 mark the answers from their own zones as verified (they set the AD bit).
14668 Others do not have this option. It is considered as poor practice using
14669 a resolver that is an authoritative server for some zones.
14670
14671 Use this option only if you really have to (e.g. if you want
14672 to use DANE for remote delivery to a server that is listed in the DNS
14673 zones that your resolver is authoritative for).
14674
14675 If the DNS answer packet has the AA bit set and contains resource record
14676 in the answer section, the name of the first NS record appearing in the
14677 authority section is compared against the list. If the answer packet is
14678 authoritative but the answer section is empty, the name of the first SOA
14679 record in the authoritative section is used instead.
14680
14681 .cindex "DNS" "resolver options"
14682 .option dns_use_edns0 main integer -1
14683 .cindex "DNS" "resolver options"
14684 .cindex "DNS" "EDNS0"
14685 .cindex "DNS" "OpenBSD
14686 If this option is set to a non-negative number then Exim will initialise the
14687 DNS resolver library to either use or not use EDNS0 extensions, overriding
14688 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14689 on.
14690
14691 If the resolver library does not support EDNS0 then this option has no effect.
14692
14693 .new
14694 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14695 means that DNSSEC will not work with Exim on that platform either, unless Exim
14696 is linked against an alternative DNS client library.
14697 .wen
14698
14699
14700 .option drop_cr main boolean false
14701 This is an obsolete option that is now a no-op. It used to affect the way Exim
14702 handled CR and LF characters in incoming messages. What happens now is
14703 described in section &<<SECTlineendings>>&.
14704
14705 .option dsn_advertise_hosts main "host list&!!" unset
14706 .cindex "bounce messages" "success"
14707 .cindex "DSN" "success"
14708 .cindex "Delivery Status Notification" "success"
14709 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14710 and accepted from, these hosts.
14711 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14712 and RET and ORCPT options on MAIL FROM commands.
14713 A NOTIFY=SUCCESS option requests success-DSN messages.
14714 A NOTIFY= option with no argument requests that no delay or failure DSNs
14715 are sent.
14716
14717 .option dsn_from main "string&!!" "see below"
14718 .cindex "&'From:'& header line" "in bounces"
14719 .cindex "bounce messages" "&'From:'& line, specifying"
14720 This option can be used to vary the contents of &'From:'& header lines in
14721 bounces and other automatically generated messages (&"Delivery Status
14722 Notifications"& &-- hence the name of the option). The default setting is:
14723 .code
14724 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14725 .endd
14726 The value is expanded every time it is needed. If the expansion fails, a
14727 panic is logged, and the default value is used.
14728
14729 .option envelope_to_remove main boolean true
14730 .cindex "&'Envelope-to:'& header line"
14731 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14732 message when it is delivered, in exactly the same way as &'Return-path:'& is
14733 handled. &'Envelope-to:'& records the original recipient address from the
14734 message's envelope that caused the delivery to happen. Such headers should not
14735 be present in incoming messages, and this option causes them to be removed at
14736 the time the message is received, to avoid any problems that might occur when a
14737 delivered message is subsequently sent on to some other recipient.
14738
14739
14740 .option errors_copy main "string list&!!" unset
14741 .cindex "bounce message" "copy to other address"
14742 .cindex "copy of bounce message"
14743 Setting this option causes Exim to send bcc copies of bounce messages that it
14744 generates to other addresses. &*Note*&: This does not apply to bounce messages
14745 coming from elsewhere. The value of the option is a colon-separated list of
14746 items. Each item consists of a pattern, terminated by white space, followed by
14747 a comma-separated list of email addresses. If a pattern contains spaces, it
14748 must be enclosed in double quotes.
14749
14750 Each pattern is processed in the same way as a single item in an address list
14751 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14752 the bounce message, the message is copied to the addresses on the list. The
14753 items are scanned in order, and once a matching one is found, no further items
14754 are examined. For example:
14755 .code
14756 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14757               rqps@mydomain   hostmaster@mydomain.example,\
14758                               postmaster@mydomain.example
14759 .endd
14760 .vindex "&$domain$&"
14761 .vindex "&$local_part$&"
14762 The address list is expanded before use. The expansion variables &$local_part$&
14763 and &$domain$& are set from the original recipient of the error message, and if
14764 there was any wildcard matching in the pattern, the expansion
14765 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14766 variables &$0$&, &$1$&, etc. are set in the normal way.
14767
14768
14769 .option errors_reply_to main string unset
14770 .cindex "bounce message" "&'Reply-to:'& in"
14771 By default, Exim's bounce and delivery warning messages contain the header line
14772 .display
14773 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14774 .endd
14775 .oindex &%quota_warn_message%&
14776 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14777 A warning message that is generated by the &%quota_warn_message%& option in an
14778 &(appendfile)& transport may contain its own &'From:'& header line that
14779 overrides the default.
14780
14781 Experience shows that people reply to bounce messages. If the
14782 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14783 and warning messages. For example:
14784 .code
14785 errors_reply_to = postmaster@my.domain.example
14786 .endd
14787 The value of the option is not expanded. It must specify a valid RFC 2822
14788 address. However, if a warning message that is generated by the
14789 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14790 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14791 not used.
14792
14793
14794 .option event_action main string&!! unset
14795 .cindex events
14796 This option declares a string to be expanded for Exim's events mechanism.
14797 For details see chapter &<<CHAPevents>>&.
14798
14799
14800 .option exim_group main string "compile-time configured"
14801 .cindex "gid (group id)" "Exim's own"
14802 .cindex "Exim group"
14803 This option changes the gid under which Exim runs when it gives up root
14804 privilege. The default value is compiled into the binary. The value of this
14805 option is used only when &%exim_user%& is also set. Unless it consists entirely
14806 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14807 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14808 security issues.
14809
14810
14811 .option exim_path main string "see below"
14812 .cindex "Exim binary, path name"
14813 This option specifies the path name of the Exim binary, which is used when Exim
14814 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14815 the directory configured at compile time by the BIN_DIRECTORY setting. It
14816 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14817 other place.
14818 &*Warning*&: Do not use a macro to define the value of this option, because
14819 you will break those Exim utilities that scan the configuration file to find
14820 where the binary is. (They then use the &%-bP%& option to extract option
14821 settings such as the value of &%spool_directory%&.)
14822
14823
14824 .option exim_user main string "compile-time configured"
14825 .cindex "uid (user id)" "Exim's own"
14826 .cindex "Exim user"
14827 This option changes the uid under which Exim runs when it gives up root
14828 privilege. The default value is compiled into the binary. Ownership of the run
14829 time configuration file and the use of the &%-C%& and &%-D%& command line
14830 options is checked against the values in the binary, not what is set here.
14831
14832 Unless it consists entirely of digits, the string is looked up using
14833 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14834 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14835 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14836
14837
14838 .option extra_local_interfaces main "string list" unset
14839 This option defines network interfaces that are to be considered local when
14840 routing, but which are not used for listening by the daemon. See section
14841 &<<SECTreclocipadd>>& for details.
14842
14843
14844 . Allow this long option name to split; give it unsplit as a fifth argument
14845 . for the automatic .oindex that is generated by .option.
14846
14847 .option "extract_addresses_remove_arguments" main boolean true &&&
14848          extract_addresses_remove_arguments
14849 .oindex "&%-t%&"
14850 .cindex "command line" "addresses with &%-t%&"
14851 .cindex "Sendmail compatibility" "&%-t%& option"
14852 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14853 are present on the command line when the &%-t%& option is used to build an
14854 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14855 line addresses are removed from the recipients list. This is also how Smail
14856 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14857 command line addresses are added to those obtained from the header lines. When
14858 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14859 argument headers. If it is set false, Exim adds rather than removes argument
14860 addresses.
14861
14862
14863 .option finduser_retries main integer 0
14864 .cindex "NIS, retrying user lookups"
14865 On systems running NIS or other schemes in which user and group information is
14866 distributed from a remote system, there can be times when &[getpwnam()]& and
14867 related functions fail, even when given valid data, because things time out.
14868 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14869 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14870 many extra times to find a user or a group, waiting for one second between
14871 retries.
14872
14873 .cindex "&_/etc/passwd_&" "multiple reading of"
14874 You should not set this option greater than zero if your user information is in
14875 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14876 search the file multiple times for non-existent users, and also cause delay.
14877
14878
14879
14880 .option freeze_tell main "string list, comma separated" unset
14881 .cindex "freezing messages" "sending a message when freezing"
14882 On encountering certain errors, or when configured to do so in a system filter,
14883 ACL, or special router, Exim freezes a message. This means that no further
14884 delivery attempts take place until an administrator thaws the message, or the
14885 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14886 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14887 warning message whenever it freezes something, unless the message it is
14888 freezing is a locally-generated bounce message. (Without this exception there
14889 is the possibility of looping.) The warning message is sent to the addresses
14890 supplied as the comma-separated value of this option. If several of the
14891 message's addresses cause freezing, only a single message is sent. If the
14892 freezing was automatic, the reason(s) for freezing can be found in the message
14893 log. If you configure freezing in a filter or ACL, you must arrange for any
14894 logging that you require.
14895
14896
14897 .option gecos_name main string&!! unset
14898 .cindex "HP-UX"
14899 .cindex "&""gecos""& field, parsing"
14900 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14901 password file to hold other information in addition to users' real names. Exim
14902 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14903 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14904 of the field are used unchanged, except that, if an ampersand is encountered,
14905 it is replaced by the user's login name with the first character forced to
14906 upper case, since this is a convention that is observed on many systems.
14907
14908 When these options are set, &%gecos_pattern%& is treated as a regular
14909 expression that is to be applied to the field (again with && replaced by the
14910 login name), and if it matches, &%gecos_name%& is expanded and used as the
14911 user's name.
14912
14913 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14914 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14915 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14916 name terminates at the first comma, the following can be used:
14917 .code
14918 gecos_pattern = ([^,]*)
14919 gecos_name = $1
14920 .endd
14921
14922 .option gecos_pattern main string unset
14923 See &%gecos_name%& above.
14924
14925
14926 .option gnutls_compat_mode main boolean unset
14927 This option controls whether GnuTLS is used in compatibility mode in an Exim
14928 server. This reduces security slightly, but improves interworking with older
14929 implementations of TLS.
14930
14931
14932 option gnutls_allow_auto_pkcs11 main boolean unset
14933 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14934 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14935
14936 See
14937 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14938 for documentation.
14939
14940
14941
14942 .option headers_charset main string "see below"
14943 This option sets a default character set for translating from encoded MIME
14944 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14945 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14946 ultimate default is ISO-8859-1. For more details see the description of header
14947 insertions in section &<<SECTexpansionitems>>&.
14948
14949
14950
14951 .option header_maxsize main integer "see below"
14952 .cindex "header section" "maximum size of"
14953 .cindex "limit" "size of message header section"
14954 This option controls the overall maximum size of a message's header
14955 section. The default is the value of HEADER_MAXSIZE in
14956 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14957 sections are rejected.
14958
14959
14960 .option header_line_maxsize main integer 0
14961 .cindex "header lines" "maximum size of"
14962 .cindex "limit" "size of one header line"
14963 This option limits the length of any individual header line in a message, after
14964 all the continuations have been joined together. Messages with individual
14965 header lines that are longer than the limit are rejected. The default value of
14966 zero means &"no limit"&.
14967
14968
14969
14970
14971 .option helo_accept_junk_hosts main "host list&!!" unset
14972 .cindex "HELO" "accepting junk data"
14973 .cindex "EHLO" "accepting junk data"
14974 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14975 mail, and gives an error response for invalid data. Unfortunately, there are
14976 some SMTP clients that send syntactic junk. They can be accommodated by setting
14977 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14978 if you want to do semantic checking.
14979 See also &%helo_allow_chars%& for a way of extending the permitted character
14980 set.
14981
14982
14983 .option helo_allow_chars main string unset
14984 .cindex "HELO" "underscores in"
14985 .cindex "EHLO" "underscores in"
14986 .cindex "underscore in EHLO/HELO"
14987 This option can be set to a string of rogue characters that are permitted in
14988 all EHLO and HELO names in addition to the standard letters, digits,
14989 hyphens, and dots. If you really must allow underscores, you can set
14990 .code
14991 helo_allow_chars = _
14992 .endd
14993 Note that the value is one string, not a list.
14994
14995
14996 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14997 .cindex "HELO" "forcing reverse lookup"
14998 .cindex "EHLO" "forcing reverse lookup"
14999 If the domain given by a client in a HELO or EHLO command matches this
15000 list, a reverse lookup is done in order to establish the host's true name. The
15001 default forces a lookup if the client host gives the server's name or any of
15002 its IP addresses (in brackets), something that broken clients have been seen to
15003 do.
15004
15005
15006 .option helo_try_verify_hosts main "host list&!!" unset
15007 .cindex "HELO verifying" "optional"
15008 .cindex "EHLO" "verifying, optional"
15009 By default, Exim just checks the syntax of HELO and EHLO commands (see
15010 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15011 to do more extensive checking of the data supplied by these commands. The ACL
15012 condition &`verify = helo`& is provided to make this possible.
15013 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15014 to force the check to occur. From release 4.53 onwards, this is no longer
15015 necessary. If the check has not been done before &`verify = helo`& is
15016 encountered, it is done at that time. Consequently, this option is obsolete.
15017 Its specification is retained here for backwards compatibility.
15018
15019 When an EHLO or HELO command is received, if the calling host matches
15020 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15021 EHLO command either:
15022
15023 .ilist
15024 is an IP literal matching the calling address of the host, or
15025 .next
15026 .cindex "DNS" "reverse lookup"
15027 .cindex "reverse DNS lookup"
15028 matches the host name that Exim obtains by doing a reverse lookup of the
15029 calling host address, or
15030 .next
15031 when looked up in DNS yields the calling host address.
15032 .endlist
15033
15034 However, the EHLO or HELO command is not rejected if any of the checks
15035 fail. Processing continues, but the result of the check is remembered, and can
15036 be detected later in an ACL by the &`verify = helo`& condition.
15037
15038 If DNS was used for successful verification, the variable
15039 .cindex "DNS" "DNSSEC"
15040 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15041
15042 .option helo_verify_hosts main "host list&!!" unset
15043 .cindex "HELO verifying" "mandatory"
15044 .cindex "EHLO" "verifying, mandatory"
15045 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15046 backwards compatibility. For hosts that match this option, Exim checks the host
15047 name given in the HELO or EHLO in the same way as for
15048 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15049 rejected with a 550 error, and entries are written to the main and reject logs.
15050 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15051 error.
15052
15053 .option hold_domains main "domain list&!!" unset
15054 .cindex "domain" "delaying delivery"
15055 .cindex "delivery" "delaying certain domains"
15056 This option allows mail for particular domains to be held on the queue
15057 manually. The option is overridden if a message delivery is forced with the
15058 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15059 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15060 item in &%hold_domains%&, no routing or delivery for that address is done, and
15061 it is deferred every time the message is looked at.
15062
15063 This option is intended as a temporary operational measure for delaying the
15064 delivery of mail while some problem is being sorted out, or some new
15065 configuration tested. If you just want to delay the processing of some
15066 domains until a queue run occurs, you should use &%queue_domains%& or
15067 &%queue_smtp_domains%&, not &%hold_domains%&.
15068
15069 A setting of &%hold_domains%& does not override Exim's code for removing
15070 messages from the queue if they have been there longer than the longest retry
15071 time in any retry rule. If you want to hold messages for longer than the normal
15072 retry times, insert a dummy retry rule with a long retry time.
15073
15074
15075 .option host_lookup main "host list&!!" unset
15076 .cindex "host name" "lookup, forcing"
15077 Exim does not look up the name of a calling host from its IP address unless it
15078 is required to compare against some host list, or the host matches
15079 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15080 option (which normally contains IP addresses rather than host names). The
15081 default configuration file contains
15082 .code
15083 host_lookup = *
15084 .endd
15085 which causes a lookup to happen for all hosts. If the expense of these lookups
15086 is felt to be too great, the setting can be changed or removed.
15087
15088 After a successful reverse lookup, Exim does a forward lookup on the name it
15089 has obtained, to verify that it yields the IP address that it started with. If
15090 this check fails, Exim behaves as if the name lookup failed.
15091
15092 .vindex "&$host_lookup_failed$&"
15093 .vindex "&$sender_host_name$&"
15094 After any kind of failure, the host name (in &$sender_host_name$&) remains
15095 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15096 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15097 &`verify = reverse_host_lookup`& in ACLs.
15098
15099
15100 .option host_lookup_order main "string list" &`bydns:byaddr`&
15101 This option specifies the order of different lookup methods when Exim is trying
15102 to find a host name from an IP address. The default is to do a DNS lookup
15103 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15104 if that fails. You can change the order of these lookups, or omit one entirely,
15105 if you want.
15106
15107 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15108 multiple PTR records in the DNS and the IP address is not listed in
15109 &_/etc/hosts_&. Different operating systems give different results in this
15110 case. That is why the default tries a DNS lookup first.
15111
15112
15113
15114 .option host_reject_connection main "host list&!!" unset
15115 .cindex "host" "rejecting connections from"
15116 If this option is set, incoming SMTP calls from the hosts listed are rejected
15117 as soon as the connection is made.
15118 This option is obsolete, and retained only for backward compatibility, because
15119 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15120 connections immediately.
15121
15122 The ability to give an immediate rejection (either by this option or using an
15123 ACL) is provided for use in unusual cases. Many hosts will just try again,
15124 sometimes without much delay. Normally, it is better to use an ACL to reject
15125 incoming messages at a later stage, such as after RCPT commands. See
15126 chapter &<<CHAPACL>>&.
15127
15128
15129 .option hosts_connection_nolog main "host list&!!" unset
15130 .cindex "host" "not logging connections from"
15131 This option defines a list of hosts for which connection logging does not
15132 happen, even though the &%smtp_connection%& log selector is set. For example,
15133 you might want not to log SMTP connections from local processes, or from
15134 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15135 the daemon; you should therefore strive to restrict its value to a short inline
15136 list of IP addresses and networks. To disable logging SMTP connections from
15137 local processes, you must create a host list with an empty item. For example:
15138 .code
15139 hosts_connection_nolog = :
15140 .endd
15141 If the &%smtp_connection%& log selector is not set, this option has no effect.
15142
15143
15144
15145 .option hosts_proxy main "host list&!!" unset
15146 .cindex proxy "proxy protocol"
15147 This option enables use of Proxy Protocol proxies for incoming
15148 connections.  For details see section &<<SECTproxyInbound>>&.
15149
15150
15151 .option hosts_treat_as_local main "domain list&!!" unset
15152 .cindex "local host" "domains treated as"
15153 .cindex "host" "treated as local"
15154 If this option is set, any host names that match the domain list are treated as
15155 if they were the local host when Exim is scanning host lists obtained from MX
15156 records
15157 or other sources. Note that the value of this option is a domain list, not a
15158 host list, because it is always used to check host names, not IP addresses.
15159
15160 This option also applies when Exim is matching the special items
15161 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15162 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15163 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15164 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15165 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15166 interfaces and recognizing the local host.
15167
15168
15169 .option ibase_servers main "string list" unset
15170 .cindex "InterBase" "server list"
15171 This option provides a list of InterBase servers and associated connection data,
15172 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15173 The option is available only if Exim has been built with InterBase support.
15174
15175
15176
15177 .option ignore_bounce_errors_after main time 10w
15178 .cindex "bounce message" "discarding"
15179 .cindex "discarding bounce message"
15180 This option affects the processing of bounce messages that cannot be delivered,
15181 that is, those that suffer a permanent delivery failure. (Bounce messages that
15182 suffer temporary delivery failures are of course retried in the usual way.)
15183
15184 After a permanent delivery failure, bounce messages are frozen,
15185 because there is no sender to whom they can be returned. When a frozen bounce
15186 message has been on the queue for more than the given time, it is unfrozen at
15187 the next queue run, and a further delivery is attempted. If delivery fails
15188 again, the bounce message is discarded. This makes it possible to keep failed
15189 bounce messages around for a shorter time than the normal maximum retry time
15190 for frozen messages. For example,
15191 .code
15192 ignore_bounce_errors_after = 12h
15193 .endd
15194 retries failed bounce message deliveries after 12 hours, discarding any further
15195 failures. If the value of this option is set to a zero time period, bounce
15196 failures are discarded immediately. Setting a very long time (as in the default
15197 value) has the effect of disabling this option. For ways of automatically
15198 dealing with other kinds of frozen message, see &%auto_thaw%& and
15199 &%timeout_frozen_after%&.
15200
15201
15202 .option ignore_fromline_hosts main "host list&!!" unset
15203 .cindex "&""From""& line"
15204 .cindex "UUCP" "&""From""& line"
15205 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15206 the headers of a message. By default this is treated as the start of the
15207 message's body, which means that any following headers are not recognized as
15208 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15209 match those hosts that insist on sending it. If the sender is actually a local
15210 process rather than a remote host, and is using &%-bs%& to inject the messages,
15211 &%ignore_fromline_local%& must be set to achieve this effect.
15212
15213
15214 .option ignore_fromline_local main boolean false
15215 See &%ignore_fromline_hosts%& above.
15216
15217 .option keep_environment main "string list" unset
15218 .cindex "environment" "values from"
15219 This option contains a string list of environment variables to keep.
15220 You have to trust these variables or you have to be sure that
15221 these variables do not impose any security risk. Keep in mind that
15222 during the startup phase Exim is running with an effective UID 0 in most
15223 installations. As the default value is an empty list, the default
15224 environment for using libraries, running embedded Perl code, or running
15225 external binaries is empty, and does not not even contain PATH or HOME.
15226
15227 Actually the list is interpreted as a list of patterns
15228 (&<<SECTlistexpand>>&), except that it is not expanded first.
15229
15230 WARNING: Macro substitution is still done first, so having a macro
15231 FOO and having FOO_HOME in your &%keep_environment%& option may have
15232 unexpected results. You may work around this using a regular expression
15233 that does not match the macro name: ^[F]OO_HOME$.
15234
15235 Current versions of Exim issue a warning during startup if you do not mention
15236 &%keep_environment%& in your runtime configuration file and if your
15237 current environment is not empty. Future versions may not issue that warning
15238 anymore.
15239
15240 See the &%add_environment%& main config option for a way to set
15241 environment variables to a fixed value.  The environment for &(pipe)&
15242 transports is handled separately, see section &<<SECTpipeenv>>& for
15243 details.
15244
15245
15246 .option keep_malformed main time 4d
15247 This option specifies the length of time to keep messages whose spool files
15248 have been corrupted in some way. This should, of course, never happen. At the
15249 next attempt to deliver such a message, it gets removed. The incident is
15250 logged.
15251
15252
15253 .option ldap_ca_cert_dir main string unset
15254 .cindex "LDAP", "TLS CA certificate directory"
15255 .cindex certificate "directory for LDAP"
15256 This option indicates which directory contains CA certificates for verifying
15257 a TLS certificate presented by an LDAP server.
15258 While Exim does not provide a default value, your SSL library may.
15259 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15260 and constrained to be a directory.
15261
15262
15263 .option ldap_ca_cert_file main string unset
15264 .cindex "LDAP", "TLS CA certificate file"
15265 .cindex certificate "file for LDAP"
15266 This option indicates which file contains CA certificates for verifying
15267 a TLS certificate presented by an LDAP server.
15268 While Exim does not provide a default value, your SSL library may.
15269 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15270 and constrained to be a file.
15271
15272
15273 .option ldap_cert_file main string unset
15274 .cindex "LDAP" "TLS client certificate file"
15275 .cindex certificate "file for LDAP"
15276 This option indicates which file contains an TLS client certificate which
15277 Exim should present to the LDAP server during TLS negotiation.
15278 Should be used together with &%ldap_cert_key%&.
15279
15280
15281 .option ldap_cert_key main string unset
15282 .cindex "LDAP" "TLS client key file"
15283 .cindex certificate "key for LDAP"
15284 This option indicates which file contains the secret/private key to use
15285 to prove identity to the LDAP server during TLS negotiation.
15286 Should be used together with &%ldap_cert_file%&, which contains the
15287 identity to be proven.
15288
15289
15290 .option ldap_cipher_suite main string unset
15291 .cindex "LDAP" "TLS cipher suite"
15292 This controls the TLS cipher-suite negotiation during TLS negotiation with
15293 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15294 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15295
15296
15297 .option ldap_default_servers main "string list" unset
15298 .cindex "LDAP" "default servers"
15299 This option provides a list of LDAP servers which are tried in turn when an
15300 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15301 details of LDAP queries. This option is available only when Exim has been built
15302 with LDAP support.
15303
15304
15305 .option ldap_require_cert main string unset.
15306 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15307 This should be one of the values "hard", "demand", "allow", "try" or "never".
15308 A value other than one of these is interpreted as "never".
15309 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15310 Although Exim does not set a default, the LDAP library probably defaults
15311 to hard/demand.
15312
15313
15314 .option ldap_start_tls main boolean false
15315 .cindex "LDAP" "whether or not to negotiate TLS"
15316 If set, Exim will attempt to negotiate TLS with the LDAP server when
15317 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15318 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15319 of SSL-on-connect.
15320 In the event of failure to negotiate TLS, the action taken is controlled
15321 by &%ldap_require_cert%&.
15322 .new
15323 This option is ignored for &`ldapi`& connections.
15324 .wen
15325
15326
15327 .option ldap_version main integer unset
15328 .cindex "LDAP" "protocol version, forcing"
15329 This option can be used to force Exim to set a specific protocol version for
15330 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15331 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15332 the LDAP headers; otherwise it is 2. This option is available only when Exim
15333 has been built with LDAP support.
15334
15335
15336
15337 .option local_from_check main boolean true
15338 .cindex "&'Sender:'& header line" "disabling addition of"
15339 .cindex "&'From:'& header line" "disabling checking of"
15340 When a message is submitted locally (that is, not over a TCP/IP connection) by
15341 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15342 checks that the &'From:'& header line matches the login of the calling user and
15343 the domain specified by &%qualify_domain%&.
15344
15345 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15346 locally submitted message is automatically qualified by Exim, unless the
15347 &%-bnq%& command line option is used.
15348
15349 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15350 on the local part. If the &'From:'& header line does not match, Exim adds a
15351 &'Sender:'& header with an address constructed from the calling user's login
15352 and the default qualify domain.
15353
15354 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15355 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15356 &'Sender:'& header lines supplied by untrusted users, you must also set
15357 &%local_sender_retain%& to be true.
15358
15359 .cindex "envelope sender"
15360 These options affect only the header lines in the message. The envelope sender
15361 is still forced to be the login id at the qualify domain unless
15362 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15363
15364 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15365 request similar header line checking. See section &<<SECTthesenhea>>&, which
15366 has more details about &'Sender:'& processing.
15367
15368
15369
15370
15371 .option local_from_prefix main string unset
15372 When Exim checks the &'From:'& header line of locally submitted messages for
15373 matching the login id (see &%local_from_check%& above), it can be configured to
15374 ignore certain prefixes and suffixes in the local part of the address. This is
15375 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15376 appropriate lists, in the same form as the &%local_part_prefix%& and
15377 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15378 example, if
15379 .code
15380 local_from_prefix = *-
15381 .endd
15382 is set, a &'From:'& line containing
15383 .code
15384 From: anything-user@your.domain.example
15385 .endd
15386 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15387 matches the actual sender address that is constructed from the login name and
15388 qualify domain.
15389
15390
15391 .option local_from_suffix main string unset
15392 See &%local_from_prefix%& above.
15393
15394
15395 .option local_interfaces main "string list" "see below"
15396 This option controls which network interfaces are used by the daemon for
15397 listening; they are also used to identify the local host when routing. Chapter
15398 &<<CHAPinterfaces>>& contains a full description of this option and the related
15399 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15400 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15401 &%local_interfaces%& is
15402 .code
15403 local_interfaces = 0.0.0.0
15404 .endd
15405 when Exim is built without IPv6 support; otherwise it is
15406 .code
15407 local_interfaces = <; ::0 ; 0.0.0.0
15408 .endd
15409
15410 .option local_scan_timeout main time 5m
15411 .cindex "timeout" "for &[local_scan()]& function"
15412 .cindex "&[local_scan()]& function" "timeout"
15413 This timeout applies to the &[local_scan()]& function (see chapter
15414 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15415 the incoming message is rejected with a temporary error if it is an SMTP
15416 message. For a non-SMTP message, the message is dropped and Exim ends with a
15417 non-zero code. The incident is logged on the main and reject logs.
15418
15419
15420
15421 .option local_sender_retain main boolean false
15422 .cindex "&'Sender:'& header line" "retaining from local submission"
15423 When a message is submitted locally (that is, not over a TCP/IP connection) by
15424 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15425 do not want this to happen, you must set &%local_sender_retain%&, and you must
15426 also set &%local_from_check%& to be false (Exim will complain if you do not).
15427 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15428 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15429
15430
15431
15432
15433 .option localhost_number main string&!! unset
15434 .cindex "host" "locally unique number for"
15435 .cindex "message ids" "with multiple hosts"
15436 .vindex "&$localhost_number$&"
15437 Exim's message ids are normally unique only within the local host. If
15438 uniqueness among a set of hosts is required, each host must set a different
15439 value for the &%localhost_number%& option. The string is expanded immediately
15440 after reading the configuration file (so that a number can be computed from the
15441 host name, for example) and the result of the expansion must be a number in the
15442 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15443 systems). This is available in subsequent string expansions via the variable
15444 &$localhost_number$&. When &%localhost_number is set%&, the final two
15445 characters of the message id, instead of just being a fractional part of the
15446 time, are computed from the time and the local host number as described in
15447 section &<<SECTmessiden>>&.
15448
15449
15450
15451 .option log_file_path main "string list&!!" "set at compile time"
15452 .cindex "log" "file path for"
15453 This option sets the path which is used to determine the names of Exim's log
15454 files, or indicates that logging is to be to syslog, or both. It is expanded
15455 when Exim is entered, so it can, for example, contain a reference to the host
15456 name. If no specific path is set for the log files at compile or run time,
15457 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15458 they are written in a sub-directory called &_log_& in Exim's spool directory.
15459 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15460 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15461 used. If this string is fixed at your installation (contains no expansion
15462 variables) it is recommended that you do not set this option in the
15463 configuration file, but instead supply the path using LOG_FILE_PATH in
15464 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15465 early on &-- in particular, failure to read the configuration file.
15466
15467
15468 .option log_selector main string unset
15469 .cindex "log" "selectors"
15470 This option can be used to reduce or increase the number of things that Exim
15471 writes to its log files. Its argument is made up of names preceded by plus or
15472 minus characters. For example:
15473 .code
15474 log_selector = +arguments -retry_defer
15475 .endd
15476 A list of possible names and what they control is given in the chapter on
15477 logging, in section &<<SECTlogselector>>&.
15478
15479
15480 .option log_timezone main boolean false
15481 .cindex "log" "timezone for entries"
15482 .vindex "&$tod_log$&"
15483 .vindex "&$tod_zone$&"
15484 By default, the timestamps on log lines are in local time without the
15485 timezone. This means that if your timezone changes twice a year, the timestamps
15486 in log lines are ambiguous for an hour when the clocks go back. One way of
15487 avoiding this problem is to set the timezone to UTC. An alternative is to set
15488 &%log_timezone%& true. This turns on the addition of the timezone offset to
15489 timestamps in log lines. Turning on this option can add quite a lot to the size
15490 of log files because each line is extended by 6 characters. Note that the
15491 &$tod_log$& variable contains the log timestamp without the zone, but there is
15492 another variable called &$tod_zone$& that contains just the timezone offset.
15493
15494
15495 .option lookup_open_max main integer 25
15496 .cindex "too many open files"
15497 .cindex "open files, too many"
15498 .cindex "file" "too many open"
15499 .cindex "lookup" "maximum open files"
15500 .cindex "limit" "open files for lookups"
15501 This option limits the number of simultaneously open files for single-key
15502 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15503 Exim normally keeps these files open during routing, because often the same
15504 file is required several times. If the limit is reached, Exim closes the least
15505 recently used file. Note that if you are using the &'ndbm'& library, it
15506 actually opens two files for each logical DBM database, though it still counts
15507 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15508 open files"& errors with NDBM, you need to reduce the value of
15509 &%lookup_open_max%&.
15510
15511
15512 .option max_username_length main integer 0
15513 .cindex "length of login name"
15514 .cindex "user name" "maximum length"
15515 .cindex "limit" "user name length"
15516 Some operating systems are broken in that they truncate long arguments to
15517 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15518 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15519 an argument that is longer behaves as if &[getpwnam()]& failed.
15520
15521
15522 .option message_body_newlines main bool false
15523 .cindex "message body" "newlines in variables"
15524 .cindex "newline" "in message body variables"
15525 .vindex "&$message_body$&"
15526 .vindex "&$message_body_end$&"
15527 By default, newlines in the message body are replaced by spaces when setting
15528 the &$message_body$& and &$message_body_end$& expansion variables. If this
15529 option is set true, this no longer happens.
15530
15531
15532 .option message_body_visible main integer 500
15533 .cindex "body of message" "visible size"
15534 .cindex "message body" "visible size"
15535 .vindex "&$message_body$&"
15536 .vindex "&$message_body_end$&"
15537 This option specifies how much of a message's body is to be included in the
15538 &$message_body$& and &$message_body_end$& expansion variables.
15539
15540
15541 .option message_id_header_domain main string&!! unset
15542 .cindex "&'Message-ID:'& header line"
15543 If this option is set, the string is expanded and used as the right hand side
15544 (domain) of the &'Message-ID:'& header that Exim creates if a
15545 locally-originated incoming message does not have one. &"Locally-originated"&
15546 means &"not received over TCP/IP."&
15547 Otherwise, the primary host name is used.
15548 Only letters, digits, dot and hyphen are accepted; any other characters are
15549 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15550 empty string, the option is ignored.
15551
15552
15553 .option message_id_header_text main string&!! unset
15554 If this variable is set, the string is expanded and used to augment the text of
15555 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15556 message does not have one. The text of this header is required by RFC 2822 to
15557 take the form of an address. By default, Exim uses its internal message id as
15558 the local part, and the primary host name as the domain. If this option is set,
15559 it is expanded, and provided the expansion is not forced to fail, and does not
15560 yield an empty string, the result is inserted into the header immediately
15561 before the @, separated from the internal message id by a dot. Any characters
15562 that are illegal in an address are automatically converted into hyphens. This
15563 means that variables such as &$tod_log$& can be used, because the spaces and
15564 colons will become hyphens.
15565
15566
15567 .option message_logs main boolean true
15568 .cindex "message logs" "disabling"
15569 .cindex "log" "message log; disabling"
15570 If this option is turned off, per-message log files are not created in the
15571 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15572 Exim, by reducing the number of files involved in handling a message from a
15573 minimum of four (header spool file, body spool file, delivery journal, and
15574 per-message log) to three. The other major I/O activity is Exim's main log,
15575 which is not affected by this option.
15576
15577
15578 .option message_size_limit main string&!! 50M
15579 .cindex "message" "size limit"
15580 .cindex "limit" "message size"
15581 .cindex "size" "of message, limit"
15582 This option limits the maximum size of message that Exim will process. The
15583 value is expanded for each incoming connection so, for example, it can be made
15584 to depend on the IP address of the remote host for messages arriving via
15585 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15586 optionally followed by K or M.
15587
15588 &*Note*&: This limit cannot be made to depend on a message's sender or any
15589 other properties of an individual message, because it has to be advertised in
15590 the server's response to EHLO. String expansion failure causes a temporary
15591 error. A value of zero means no limit, but its use is not recommended. See also
15592 &%bounce_return_size_limit%&.
15593
15594 Incoming SMTP messages are failed with a 552 error if the limit is
15595 exceeded; locally-generated messages either get a stderr message or a delivery
15596 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15597 an oversized message is logged in both the main and the reject logs. See also
15598 the generic transport option &%message_size_limit%&, which limits the size of
15599 message that an individual transport can process.
15600
15601 If you use a virus-scanner and set this option to to a value larger than the
15602 maximum size that your virus-scanner is configured to support, you may get
15603 failures triggered by large mails.  The right size to configure for the
15604 virus-scanner depends upon what data is passed and the options in use but it's
15605 probably safest to just set it to a little larger than this value.  E.g., with a
15606 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15607 some problems may result.
15608
15609 A value of 0 will disable size limit checking; Exim will still advertise the
15610 SIZE extension in an EHLO response, but without a limit, so as to permit
15611 SMTP clients to still indicate the message size along with the MAIL verb.
15612
15613
15614 .option move_frozen_messages main boolean false
15615 .cindex "frozen messages" "moving"
15616 This option, which is available only if Exim has been built with the setting
15617 .code
15618 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15619 .endd
15620 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15621 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15622 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15623 standard utilities for handling such moved messages, and they do not show up in
15624 lists generated by &%-bp%& or by the Exim monitor.
15625
15626
15627 .option mua_wrapper main boolean false
15628 Setting this option true causes Exim to run in a very restrictive mode in which
15629 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15630 contains a full description of this facility.
15631
15632
15633
15634 .option mysql_servers main "string list" unset
15635 .cindex "MySQL" "server list"
15636 This option provides a list of MySQL servers and associated connection data, to
15637 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15638 option is available only if Exim has been built with MySQL support.
15639
15640
15641 .option never_users main "string list&!!" unset
15642 This option is expanded just once, at the start of Exim's processing. Local
15643 message deliveries are normally run in processes that are setuid to the
15644 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15645 It is usually desirable to prevent any deliveries from running as root, as a
15646 safety precaution.
15647
15648 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15649 list of users that must not be used for local deliveries. This list is fixed in
15650 the binary and cannot be overridden by the configuration file. By default, it
15651 contains just the single user name &"root"&. The &%never_users%& runtime option
15652 can be used to add more users to the fixed list.
15653
15654 If a message is to be delivered as one of the users on the fixed list or the
15655 &%never_users%& list, an error occurs, and delivery is deferred. A common
15656 example is
15657 .code
15658 never_users = root:daemon:bin
15659 .endd
15660 Including root is redundant if it is also on the fixed list, but it does no
15661 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15662 transport driver.
15663
15664
15665 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15666 .cindex "OpenSSL "compatibility options"
15667 This option allows an administrator to adjust the SSL options applied
15668 by OpenSSL to connections.  It is given as a space-separated list of items,
15669 each one to be +added or -subtracted from the current value.
15670
15671 This option is only available if Exim is built against OpenSSL.  The values
15672 available for this option vary according to the age of your OpenSSL install.
15673 The &"all"& value controls a subset of flags which are available, typically
15674 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15675 list the values known on your system and Exim should support all the
15676 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15677 names lose the leading &"SSL_OP_"& and are lower-cased.
15678
15679 Note that adjusting the options can have severe impact upon the security of
15680 SSL as used by Exim.  It is possible to disable safety checks and shoot
15681 yourself in the foot in various unpleasant ways.  This option should not be
15682 adjusted lightly.  An unrecognised item will be detected at startup, by
15683 invoking Exim with the &%-bV%& flag.
15684
15685 The option affects Exim operating both as a server and as a client.
15686
15687 Historical note: prior to release 4.80, Exim defaulted this value to
15688 "+dont_insert_empty_fragments", which may still be needed for compatibility
15689 with some clients, but which lowers security by increasing exposure to
15690 some now infamous attacks.
15691
15692 Examples:
15693 .code
15694 # Make both old MS and old Eudora happy:
15695 openssl_options = -all +microsoft_big_sslv3_buffer \
15696                        +dont_insert_empty_fragments
15697
15698 # Disable older protocol versions:
15699 openssl_options = +no_sslv2 +no_sslv3
15700 .endd
15701
15702 Possible options may include:
15703 .ilist
15704 &`all`&
15705 .next
15706 &`allow_unsafe_legacy_renegotiation`&
15707 .next
15708 &`cipher_server_preference`&
15709 .next
15710 &`dont_insert_empty_fragments`&
15711 .next
15712 &`ephemeral_rsa`&
15713 .next
15714 &`legacy_server_connect`&
15715 .next
15716 &`microsoft_big_sslv3_buffer`&
15717 .next
15718 &`microsoft_sess_id_bug`&
15719 .next
15720 &`msie_sslv2_rsa_padding`&
15721 .next
15722 &`netscape_challenge_bug`&
15723 .next
15724 &`netscape_reuse_cipher_change_bug`&
15725 .next
15726 &`no_compression`&
15727 .next
15728 &`no_session_resumption_on_renegotiation`&
15729 .next
15730 &`no_sslv2`&
15731 .next
15732 &`no_sslv3`&
15733 .next
15734 &`no_ticket`&
15735 .next
15736 &`no_tlsv1`&
15737 .next
15738 &`no_tlsv1_1`&
15739 .next
15740 &`no_tlsv1_2`&
15741 .next
15742 &`safari_ecdhe_ecdsa_bug`&
15743 .next
15744 &`single_dh_use`&
15745 .next
15746 &`single_ecdh_use`&
15747 .next
15748 &`ssleay_080_client_dh_bug`&
15749 .next
15750 &`sslref2_reuse_cert_type_bug`&
15751 .next
15752 &`tls_block_padding_bug`&
15753 .next
15754 &`tls_d5_bug`&
15755 .next
15756 &`tls_rollback_bug`&
15757 .endlist
15758
15759 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15760 all clients connecting using the MacOS SecureTransport TLS facility prior
15761 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15762 to negotiate TLS then this option value might help, provided that your OpenSSL
15763 release is new enough to contain this work-around.  This may be a situation
15764 where you have to upgrade OpenSSL to get buggy clients working.
15765
15766
15767 .option oracle_servers main "string list" unset
15768 .cindex "Oracle" "server list"
15769 This option provides a list of Oracle servers and associated connection data,
15770 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15771 The option is available only if Exim has been built with Oracle support.
15772
15773
15774 .option percent_hack_domains main "domain list&!!" unset
15775 .cindex "&""percent hack""&"
15776 .cindex "source routing" "in email address"
15777 .cindex "address" "source-routed"
15778 The &"percent hack"& is the convention whereby a local part containing a
15779 percent sign is re-interpreted as a new email address, with the percent
15780 replaced by @. This is sometimes called &"source routing"&, though that term is
15781 also applied to RFC 2822 addresses that begin with an @ character. If this
15782 option is set, Exim implements the percent facility for those domains listed,
15783 but no others. This happens before an incoming SMTP address is tested against
15784 an ACL.
15785
15786 &*Warning*&: The &"percent hack"& has often been abused by people who are
15787 trying to get round relaying restrictions. For this reason, it is best avoided
15788 if at all possible. Unfortunately, a number of less security-conscious MTAs
15789 implement it unconditionally. If you are running Exim on a gateway host, and
15790 routing mail through to internal MTAs without processing the local parts, it is
15791 a good idea to reject recipient addresses with percent characters in their
15792 local parts. Exim's default configuration does this.
15793
15794
15795 .option perl_at_start main boolean false
15796 .cindex "Perl"
15797 This option is available only when Exim is built with an embedded Perl
15798 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15799
15800
15801 .option perl_startup main string unset
15802 .cindex "Perl"
15803 This option is available only when Exim is built with an embedded Perl
15804 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15805
15806 .option perl_startup main boolean false
15807 .cindex "Perl"
15808 This Option enables the taint mode of the embedded Perl interpreter.
15809
15810
15811 .option pgsql_servers main "string list" unset
15812 .cindex "PostgreSQL lookup type" "server list"
15813 This option provides a list of PostgreSQL servers and associated connection
15814 data, to be used in conjunction with &(pgsql)& lookups (see section
15815 &<<SECID72>>&). The option is available only if Exim has been built with
15816 PostgreSQL support.
15817
15818
15819 .option pid_file_path main string&!! "set at compile time"
15820 .cindex "daemon" "pid file path"
15821 .cindex "pid file, path for"
15822 This option sets the name of the file to which the Exim daemon writes its
15823 process id. The string is expanded, so it can contain, for example, references
15824 to the host name:
15825 .code
15826 pid_file_path = /var/log/$primary_hostname/exim.pid
15827 .endd
15828 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15829 spool directory.
15830 The value set by the option can be overridden by the &%-oP%& command line
15831 option. A pid file is not written if a &"non-standard"& daemon is run by means
15832 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15833
15834
15835 .option pipelining_advertise_hosts main "host list&!!" *
15836 .cindex "PIPELINING" "suppressing advertising"
15837 This option can be used to suppress the advertisement of the SMTP
15838 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15839 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15840 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15841 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15842 that clients will use it; &"out of order"& commands that are &"expected"& do
15843 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15844
15845
15846 .option prdr_enable main boolean false
15847 .cindex "PRDR" "enabling on server"
15848 This option can be used to enable the Per-Recipient Data Response extension
15849 to SMTP, defined by Eric Hall.
15850 If the option is set, PRDR is advertised by Exim when operating as a server.
15851 If the client requests PRDR, and more than one recipient, for a message
15852 an additional ACL is called for each recipient after the message content
15853 is received.  See section &<<SECTPRDRACL>>&.
15854
15855 .option preserve_message_logs main boolean false
15856 .cindex "message logs" "preserving"
15857 If this option is set, message log files are not deleted when messages are
15858 completed. Instead, they are moved to a sub-directory of the spool directory
15859 called &_msglog.OLD_&, where they remain available for statistical or debugging
15860 purposes. This is a dangerous option to set on systems with any appreciable
15861 volume of mail. Use with care!
15862
15863
15864 .option primary_hostname main string "see below"
15865 .cindex "name" "of local host"
15866 .cindex "host" "name of local"
15867 .cindex "local host" "name of"
15868 .vindex "&$primary_hostname$&"
15869 This specifies the name of the current host. It is used in the default EHLO or
15870 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15871 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15872 The value is also used by default in some SMTP response messages from an Exim
15873 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15874
15875 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15876 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15877 contains only one component, Exim passes it to &[gethostbyname()]& (or
15878 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15879 version. The variable &$primary_hostname$& contains the host name, whether set
15880 explicitly by this option, or defaulted.
15881
15882
15883 .option print_topbitchars main boolean false
15884 .cindex "printing characters"
15885 .cindex "8-bit characters"
15886 By default, Exim considers only those characters whose codes lie in the range
15887 32&--126 to be printing characters. In a number of circumstances (for example,
15888 when writing log entries) non-printing characters are converted into escape
15889 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15890 is set, code values of 128 and above are also considered to be printing
15891 characters.
15892
15893 This option also affects the header syntax checks performed by the
15894 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15895 the user's full name when constructing From: and Sender: addresses (as
15896 described in section &<<SECTconstr>>&). Setting this option can cause
15897 Exim to generate eight bit message headers that do not conform to the
15898 standards.
15899
15900
15901 .option process_log_path main string unset
15902 .cindex "process log path"
15903 .cindex "log" "process log"
15904 .cindex "&'exiwhat'&"
15905 This option sets the name of the file to which an Exim process writes its
15906 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15907 utility script. If this option is unset, the file called &_exim-process.info_&
15908 in Exim's spool directory is used. The ability to specify the name explicitly
15909 can be useful in environments where two different Exims are running, using
15910 different spool directories.
15911
15912
15913 .option prod_requires_admin main boolean true
15914 .oindex "&%-M%&"
15915 .oindex "&%-R%&"
15916 .oindex "&%-q%&"
15917 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15918 admin user unless &%prod_requires_admin%& is set false. See also
15919 &%queue_list_requires_admin%&.
15920
15921
15922 .option qualify_domain main string "see below"
15923 .cindex "domain" "for qualifying addresses"
15924 .cindex "address" "qualification"
15925 This option specifies the domain name that is added to any envelope sender
15926 addresses that do not have a domain qualification. It also applies to
15927 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15928 are accepted by default only for locally-generated messages. Qualification is
15929 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15930 locally-generated messages, unless the &%-bnq%& command line option is used.
15931
15932 Messages from external sources must always contain fully qualified addresses,
15933 unless the sending host matches &%sender_unqualified_hosts%& or
15934 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15935 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15936 necessary. Internally, Exim always works with fully qualified envelope
15937 addresses. If &%qualify_domain%& is not set, it defaults to the
15938 &%primary_hostname%& value.
15939
15940
15941 .option qualify_recipient main string "see below"
15942 This option allows you to specify a different domain for qualifying recipient
15943 addresses to the one that is used for senders. See &%qualify_domain%& above.
15944
15945
15946
15947 .option queue_domains main "domain list&!!" unset
15948 .cindex "domain" "specifying non-immediate delivery"
15949 .cindex "queueing incoming messages"
15950 .cindex "message" "queueing certain domains"
15951 This option lists domains for which immediate delivery is not required.
15952 A delivery process is started whenever a message is received, but only those
15953 domains that do not match are processed. All other deliveries wait until the
15954 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15955
15956
15957 .option queue_list_requires_admin main boolean true
15958 .oindex "&%-bp%&"
15959 The &%-bp%& command-line option, which lists the messages that are on the
15960 queue, requires the caller to be an admin user unless
15961 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15962
15963
15964 .option queue_only main boolean false
15965 .cindex "queueing incoming messages"
15966 .cindex "message" "queueing unconditionally"
15967 If &%queue_only%& is set, a delivery process is not automatically started
15968 whenever a message is received. Instead, the message waits on the queue for the
15969 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15970 delivered immediately when certain conditions (such as heavy load) occur.
15971
15972 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15973 and &%-odi%& command line options override &%queue_only%& unless
15974 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15975 &%queue_only_load%&, and &%smtp_accept_queue%&.
15976
15977
15978 .option queue_only_file main string unset
15979 .cindex "queueing incoming messages"
15980 .cindex "message" "queueing by file existence"
15981 This option can be set to a colon-separated list of absolute path names, each
15982 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15983 it tests for the existence of each listed path using a call to &[stat()]&. For
15984 each path that exists, the corresponding queueing option is set.
15985 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15986 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15987 .code
15988 queue_only_file = smtp/some/file
15989 .endd
15990 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15991 &_/some/file_& exists.
15992
15993
15994 .option queue_only_load main fixed-point unset
15995 .cindex "load average"
15996 .cindex "queueing incoming messages"
15997 .cindex "message" "queueing by load"
15998 If the system load average is higher than this value, incoming messages from
15999 all sources are queued, and no automatic deliveries are started. If this
16000 happens during local or remote SMTP input, all subsequent messages received on
16001 the same SMTP connection are queued by default, whatever happens to the load in
16002 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16003 false.
16004
16005 Deliveries will subsequently be performed by queue runner processes. This
16006 option has no effect on ancient operating systems on which Exim cannot
16007 determine the load average. See also &%deliver_queue_load_max%& and
16008 &%smtp_load_reserve%&.
16009
16010
16011 .option queue_only_load_latch main boolean true
16012 .cindex "load average" "re-evaluating per message"
16013 When this option is true (the default), once one message has been queued
16014 because the load average is higher than the value set by &%queue_only_load%&,
16015 all subsequent messages received on the same SMTP connection are also queued.
16016 This is a deliberate choice; even though the load average may fall below the
16017 threshold, it doesn't seem right to deliver later messages on the same
16018 connection when not delivering earlier ones. However, there are special
16019 circumstances such as very long-lived connections from scanning appliances
16020 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16021 should be set false. This causes the value of the load average to be
16022 re-evaluated for each message.
16023
16024
16025 .option queue_only_override main boolean true
16026 .cindex "queueing incoming messages"
16027 When this option is true, the &%-od%&&'x'& command line options override the
16028 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16029 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16030 to override; they are accepted, but ignored.
16031
16032
16033 .option queue_run_in_order main boolean false
16034 .cindex "queue runner" "processing messages in order"
16035 If this option is set, queue runs happen in order of message arrival instead of
16036 in an arbitrary order. For this to happen, a complete list of the entire queue
16037 must be set up before the deliveries start. When the queue is all held in a
16038 single directory (the default), a single list is created for both the ordered
16039 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16040 single list is not created when &%queue_run_in_order%& is false. In this case,
16041 the sub-directories are processed one at a time (in a random order), and this
16042 avoids setting up one huge list for the whole queue. Thus, setting
16043 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16044 when the queue is large, because of the extra work in setting up the single,
16045 large list. In most situations, &%queue_run_in_order%& should not be set.
16046
16047
16048
16049 .option queue_run_max main integer&!! 5
16050 .cindex "queue runner" "maximum number of"
16051 This controls the maximum number of queue runner processes that an Exim daemon
16052 can run simultaneously. This does not mean that it starts them all at once,
16053 but rather that if the maximum number are still running when the time comes to
16054 start another one, it refrains from starting another one. This can happen with
16055 very large queues and/or very sluggish deliveries. This option does not,
16056 however, interlock with other processes, so additional queue runners can be
16057 started by other means, or by killing and restarting the daemon.
16058
16059 Setting this option to zero does not suppress queue runs; rather, it disables
16060 the limit, allowing any number of simultaneous queue runner processes to be
16061 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16062 the daemon's command line.
16063
16064 .cindex queues named
16065 .cindex "named queues"
16066 To set limits for different named queues use
16067 an expansion depending on the &$queue_name$& variable.
16068
16069 .option queue_smtp_domains main "domain list&!!" unset
16070 .cindex "queueing incoming messages"
16071 .cindex "message" "queueing remote deliveries"
16072 When this option is set, a delivery process is started whenever a message is
16073 received, routing is performed, and local deliveries take place.
16074 However, if any SMTP deliveries are required for domains that match
16075 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16076 message waits on the queue for the next queue run. Since routing of the message
16077 has taken place, Exim knows to which remote hosts it must be delivered, and so
16078 when the queue run happens, multiple messages for the same host are delivered
16079 over a single SMTP connection. The &%-odqs%& command line option causes all
16080 SMTP deliveries to be queued in this way, and is equivalent to setting
16081 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16082 &%queue_domains%&.
16083
16084
16085 .option receive_timeout main time 0s
16086 .cindex "timeout" "for non-SMTP input"
16087 This option sets the timeout for accepting a non-SMTP message, that is, the
16088 maximum time that Exim waits when reading a message on the standard input. If
16089 the value is zero, it will wait for ever. This setting is overridden by the
16090 &%-or%& command line option. The timeout for incoming SMTP messages is
16091 controlled by &%smtp_receive_timeout%&.
16092
16093 .option received_header_text main string&!! "see below"
16094 .cindex "customizing" "&'Received:'& header"
16095 .cindex "&'Received:'& header line" "customizing"
16096 This string defines the contents of the &'Received:'& message header that is
16097 added to each message, except for the timestamp, which is automatically added
16098 on at the end (preceded by a semicolon). The string is expanded each time it is
16099 used. If the expansion yields an empty string, no &'Received:'& header line is
16100 added to the message. Otherwise, the string should start with the text
16101 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16102 header lines. The default setting is:
16103
16104 .code
16105 received_header_text = Received: \
16106   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16107   {${if def:sender_ident \
16108   {from ${quote_local_part:$sender_ident} }}\
16109   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16110   by $primary_hostname \
16111   ${if def:received_protocol {with $received_protocol}} \
16112   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16113   (Exim $version_number)\n\t\
16114   ${if def:sender_address \
16115   {(envelope-from <$sender_address>)\n\t}}\
16116   id $message_exim_id\
16117   ${if def:received_for {\n\tfor $received_for}}
16118 .endd
16119
16120 The reference to the TLS cipher is omitted when Exim is built without TLS
16121 support. The use of conditional expansions ensures that this works for both
16122 locally generated messages and messages received from remote hosts, giving
16123 header lines such as the following:
16124 .code
16125 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16126 by marley.carol.example with esmtp (Exim 4.00)
16127 (envelope-from <bob@carol.example>)
16128 id 16IOWa-00019l-00
16129 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16130 Received: by scrooge.carol.example with local (Exim 4.00)
16131 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16132 .endd
16133 Until the body of the message has been received, the timestamp is the time when
16134 the message started to be received. Once the body has arrived, and all policy
16135 checks have taken place, the timestamp is updated to the time at which the
16136 message was accepted.
16137
16138
16139 .option received_headers_max main integer 30
16140 .cindex "loop" "prevention"
16141 .cindex "mail loop prevention"
16142 .cindex "&'Received:'& header line" "counting"
16143 When a message is to be delivered, the number of &'Received:'& headers is
16144 counted, and if it is greater than this parameter, a mail loop is assumed to
16145 have occurred, the delivery is abandoned, and an error message is generated.
16146 This applies to both local and remote deliveries.
16147
16148
16149 .option recipient_unqualified_hosts main "host list&!!" unset
16150 .cindex "unqualified addresses"
16151 .cindex "host" "unqualified addresses from"
16152 This option lists those hosts from which Exim is prepared to accept unqualified
16153 recipient addresses in message envelopes. The addresses are made fully
16154 qualified by the addition of the &%qualify_recipient%& value. This option also
16155 affects message header lines. Exim does not reject unqualified recipient
16156 addresses in headers, but it qualifies them only if the message came from a
16157 host that matches &%recipient_unqualified_hosts%&,
16158 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16159 option was not set.
16160
16161
16162 .option recipients_max main integer 0
16163 .cindex "limit" "number of recipients"
16164 .cindex "recipient" "maximum number"
16165 If this option is set greater than zero, it specifies the maximum number of
16166 original recipients for any message. Additional recipients that are generated
16167 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16168 all recipients over the limit; earlier recipients are delivered as normal.
16169 Non-SMTP messages with too many recipients are failed, and no deliveries are
16170 done.
16171
16172 .cindex "RCPT" "maximum number of incoming"
16173 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16174 RCPT commands in a single message.
16175
16176
16177 .option recipients_max_reject main boolean false
16178 If this option is set true, Exim rejects SMTP messages containing too many
16179 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16180 error to the eventual DATA command. Otherwise (the default) it gives a 452
16181 error to the surplus RCPT commands and accepts the message on behalf of the
16182 initial set of recipients. The remote server should then re-send the message
16183 for the remaining recipients at a later time.
16184
16185
16186 .option remote_max_parallel main integer 2
16187 .cindex "delivery" "parallelism for remote"
16188 This option controls parallel delivery of one message to a number of remote
16189 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16190 does all the remote deliveries for a message one by one. Otherwise, if a single
16191 message has to be delivered to more than one remote host, or if several copies
16192 have to be sent to the same remote host, up to &%remote_max_parallel%&
16193 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16194 deliveries are required, the maximum number of processes are started, and as
16195 each one finishes, another is begun. The order of starting processes is the
16196 same as if sequential delivery were being done, and can be controlled by the
16197 &%remote_sort_domains%& option. If parallel delivery takes place while running
16198 with debugging turned on, the debugging output from each delivery process is
16199 tagged with its process id.
16200
16201 This option controls only the maximum number of parallel deliveries for one
16202 message in one Exim delivery process. Because Exim has no central queue
16203 manager, there is no way of controlling the total number of simultaneous
16204 deliveries if the configuration allows a delivery attempt as soon as a message
16205 is received.
16206
16207 .cindex "number of deliveries"
16208 .cindex "delivery" "maximum number of"
16209 If you want to control the total number of deliveries on the system, you
16210 need to set the &%queue_only%& option. This ensures that all incoming messages
16211 are added to the queue without starting a delivery process. Then set up an Exim
16212 daemon to start queue runner processes at appropriate intervals (probably
16213 fairly often, for example, every minute), and limit the total number of queue
16214 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16215 delivers only one message at a time, the maximum number of deliveries that can
16216 then take place at once is &%queue_run_max%& multiplied by
16217 &%remote_max_parallel%&.
16218
16219 If it is purely remote deliveries you want to control, use
16220 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16221 doing the SMTP routing before queueing, so that several messages for the same
16222 host will eventually get delivered down the same connection.
16223
16224
16225 .option remote_sort_domains main "domain list&!!" unset
16226 .cindex "sorting remote deliveries"
16227 .cindex "delivery" "sorting remote"
16228 When there are a number of remote deliveries for a message, they are sorted by
16229 domain into the order given by this list. For example,
16230 .code
16231 remote_sort_domains = *.cam.ac.uk:*.uk
16232 .endd
16233 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16234 then to those in the &%uk%& domain, then to any others.
16235
16236
16237 .option retry_data_expire main time 7d
16238 .cindex "hints database" "data expiry"
16239 This option sets a &"use before"& time on retry information in Exim's hints
16240 database. Any older retry data is ignored. This means that, for example, once a
16241 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16242 past failures.
16243
16244
16245 .option retry_interval_max main time 24h
16246 .cindex "retry" "limit on interval"
16247 .cindex "limit" "on retry interval"
16248 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16249 intervals between delivery attempts for messages that cannot be delivered
16250 straight away. This option sets an overall limit to the length of time between
16251 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16252 the default value.
16253
16254
16255 .option return_path_remove main boolean true
16256 .cindex "&'Return-path:'& header line" "removing"
16257 RFC 2821, section 4.4, states that an SMTP server must insert a
16258 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16259 The &'Return-path:'& header preserves the sender address as received in the
16260 MAIL command. This description implies that this header should not be present
16261 in an incoming message. If &%return_path_remove%& is true, any existing
16262 &'Return-path:'& headers are removed from messages at the time they are
16263 received. Exim's transports have options for adding &'Return-path:'& headers at
16264 the time of delivery. They are normally used only for final local deliveries.
16265
16266
16267 .option return_size_limit main integer 100K
16268 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16269
16270
16271 .option rfc1413_hosts main "host list&!!" @[]
16272 .cindex "RFC 1413"
16273 .cindex "host" "for RFC 1413 calls"
16274 RFC 1413 identification calls are made to any client host which matches
16275 an item in the list.
16276 The default value specifies just this host, being any local interface
16277 for the system.
16278
16279 .option rfc1413_query_timeout main time 0s
16280 .cindex "RFC 1413" "query timeout"
16281 .cindex "timeout" "for RFC 1413 call"
16282 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16283 no RFC 1413 calls are ever made.
16284
16285
16286 .option sender_unqualified_hosts main "host list&!!" unset
16287 .cindex "unqualified addresses"
16288 .cindex "host" "unqualified addresses from"
16289 This option lists those hosts from which Exim is prepared to accept unqualified
16290 sender addresses. The addresses are made fully qualified by the addition of
16291 &%qualify_domain%&. This option also affects message header lines. Exim does
16292 not reject unqualified addresses in headers that contain sender addresses, but
16293 it qualifies them only if the message came from a host that matches
16294 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16295 using TCP/IP), and the &%-bnq%& option was not set.
16296
16297 .option set_environment main "string list" empty
16298 .cindex "environment"
16299 This option allows to set individual environment variables that the
16300 currently linked libraries and programs in child processes use. The
16301 default list is empty,
16302
16303
16304 .option slow_lookup_log main integer 0
16305 .cindex "logging" "slow lookups"
16306 .cindex "dns" "logging slow lookups"
16307 This option controls logging of slow lookups.
16308 If the value is nonzero it is taken as a number of milliseconds
16309 and lookups taking longer than this are logged.
16310 Currently this applies only to DNS lookups.
16311
16312
16313
16314 .option smtp_accept_keepalive main boolean true
16315 .cindex "keepalive" "on incoming connection"
16316 This option controls the setting of the SO_KEEPALIVE option on incoming
16317 TCP/IP socket connections. When set, it causes the kernel to probe idle
16318 connections periodically, by sending packets with &"old"& sequence numbers. The
16319 other end of the connection should send an acknowledgment if the connection is
16320 still okay or a reset if the connection has been aborted. The reason for doing
16321 this is that it has the beneficial effect of freeing up certain types of
16322 connection that can get stuck when the remote host is disconnected without
16323 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16324 hours to detect unreachable hosts.
16325
16326
16327
16328 .option smtp_accept_max main integer 20
16329 .cindex "limit" "incoming SMTP connections"
16330 .cindex "SMTP" "incoming connection count"
16331 .cindex "inetd"
16332 This option specifies the maximum number of simultaneous incoming SMTP calls
16333 that Exim will accept. It applies only to the listening daemon; there is no
16334 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16335 value is set to zero, no limit is applied. However, it is required to be
16336 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16337 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16338
16339 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16340 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16341 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16342 and &%smtp_load_reserve%& are then checked before accepting the connection.
16343
16344
16345 .option smtp_accept_max_nonmail main integer 10
16346 .cindex "limit" "non-mail SMTP commands"
16347 .cindex "SMTP" "limiting non-mail commands"
16348 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16349 the connection if there are too many. This option defines &"too many"&. The
16350 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16351 client looping sending EHLO, for example. The check is applied only if the
16352 client host matches &%smtp_accept_max_nonmail_hosts%&.
16353
16354 When a new message is expected, one occurrence of RSET is not counted. This
16355 allows a client to send one RSET between messages (this is not necessary,
16356 but some clients do it). Exim also allows one uncounted occurrence of HELO
16357 or EHLO, and one occurrence of STARTTLS between messages. After
16358 starting up a TLS session, another EHLO is expected, and so it too is not
16359 counted. The first occurrence of AUTH in a connection, or immediately
16360 following STARTTLS is not counted. Otherwise, all commands other than
16361 MAIL, RCPT, DATA, and QUIT are counted.
16362
16363
16364 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16365 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16366 check by setting this option. The default value makes it apply to all hosts. By
16367 changing the value, you can exclude any badly-behaved hosts that you have to
16368 live with.
16369
16370
16371 . Allow this long option name to split; give it unsplit as a fifth argument
16372 . for the automatic .oindex that is generated by .option.
16373 . We insert " &~&~" which is both pretty nasty visually and results in
16374 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16375 . zero-width-space, which would be nicer visually and results in (at least)
16376 . html that Firefox will split on when it's forced to reflow (rather than
16377 . inserting a horizontal scrollbar).  However, the text is still not
16378 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16379 . the option name to split.
16380
16381 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16382          smtp_accept_max_per_connection
16383 .cindex "SMTP" "limiting incoming message count"
16384 .cindex "limit" "messages per SMTP connection"
16385 The value of this option limits the number of MAIL commands that Exim is
16386 prepared to accept over a single SMTP connection, whether or not each command
16387 results in the transfer of a message. After the limit is reached, a 421
16388 response is given to subsequent MAIL commands. This limit is a safety
16389 precaution against a client that goes mad (incidents of this type have been
16390 seen).
16391
16392
16393 .option smtp_accept_max_per_host main string&!! unset
16394 .cindex "limit" "SMTP connections from one host"
16395 .cindex "host" "limiting SMTP connections from"
16396 This option restricts the number of simultaneous IP connections from a single
16397 host (strictly, from a single IP address) to the Exim daemon. The option is
16398 expanded, to enable different limits to be applied to different hosts by
16399 reference to &$sender_host_address$&. Once the limit is reached, additional
16400 connection attempts from the same host are rejected with error code 421. This
16401 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16402 of zero imposes no limit. If this option is set greater than zero, it is
16403 required that &%smtp_accept_max%& be non-zero.
16404
16405 &*Warning*&: When setting this option you should not use any expansion
16406 constructions that take an appreciable amount of time. The expansion and test
16407 happen in the main daemon loop, in order to reject additional connections
16408 without forking additional processes (otherwise a denial-of-service attack
16409 could cause a vast number or processes to be created). While the daemon is
16410 doing this processing, it cannot accept any other incoming connections.
16411
16412
16413
16414 .option smtp_accept_queue main integer 0
16415 .cindex "SMTP" "incoming connection count"
16416 .cindex "queueing incoming messages"
16417 .cindex "message" "queueing by SMTP connection count"
16418 If the number of simultaneous incoming SMTP connections being handled via the
16419 listening daemon exceeds this value, messages received by SMTP are just placed
16420 on the queue; no delivery processes are started automatically. The count is
16421 fixed at the start of an SMTP connection. It cannot be updated in the
16422 subprocess that receives messages, and so the queueing or not queueing applies
16423 to all messages received in the same connection.
16424
16425 A value of zero implies no limit, and clearly any non-zero value is useful only
16426 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16427 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16428 various &%-od%&&'x'& command line options.
16429
16430
16431 . See the comment on smtp_accept_max_per_connection
16432
16433 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16434          smtp_accept_queue_per_connection
16435 .cindex "queueing incoming messages"
16436 .cindex "message" "queueing by message count"
16437 This option limits the number of delivery processes that Exim starts
16438 automatically when receiving messages via SMTP, whether via the daemon or by
16439 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16440 and the number of messages received in a single SMTP session exceeds this
16441 number, subsequent messages are placed on the queue, but no delivery processes
16442 are started. This helps to limit the number of Exim processes when a server
16443 restarts after downtime and there is a lot of mail waiting for it on other
16444 systems. On large systems, the default should probably be increased, and on
16445 dial-in client systems it should probably be set to zero (that is, disabled).
16446
16447
16448 .option smtp_accept_reserve main integer 0
16449 .cindex "SMTP" "incoming call count"
16450 .cindex "host" "reserved"
16451 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16452 number of SMTP connections that are reserved for connections from the hosts
16453 that are specified in &%smtp_reserve_hosts%&. The value set in
16454 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16455 restricted to this number of connections; the option specifies a minimum number
16456 of connection slots for them, not a maximum. It is a guarantee that this group
16457 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16458 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16459 individual host.
16460
16461 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16462 set to 5, once there are 45 active connections (from any hosts), new
16463 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16464 provided the other criteria for acceptance are met.
16465
16466
16467 .option smtp_active_hostname main string&!! unset
16468 .cindex "host" "name in SMTP responses"
16469 .cindex "SMTP" "host name in responses"
16470 .vindex "&$primary_hostname$&"
16471 This option is provided for multi-homed servers that want to masquerade as
16472 several different hosts. At the start of an incoming SMTP connection, its value
16473 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16474 responses. For example, it is used as domain name in the response to an
16475 incoming HELO or EHLO command.
16476
16477 .vindex "&$smtp_active_hostname$&"
16478 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16479 is saved with any messages that are received. It is therefore available for use
16480 in routers and transports when the message is later delivered.
16481
16482 If this option is unset, or if its expansion is forced to fail, or if the
16483 expansion results in an empty string, the value of &$primary_hostname$& is
16484 used. Other expansion failures cause a message to be written to the main and
16485 panic logs, and the SMTP command receives a temporary error. Typically, the
16486 value of &%smtp_active_hostname%& depends on the incoming interface address.
16487 For example:
16488 .code
16489 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16490   {cox.mydomain}{box.mydomain}}
16491 .endd
16492
16493 Although &$smtp_active_hostname$& is primarily concerned with incoming
16494 messages, it is also used as the default for HELO commands in callout
16495 verification if there is no remote transport from which to obtain a
16496 &%helo_data%& value.
16497
16498 .option smtp_banner main string&!! "see below"
16499 .cindex "SMTP" "welcome banner"
16500 .cindex "banner for SMTP"
16501 .cindex "welcome banner for SMTP"
16502 .cindex "customizing" "SMTP banner"
16503 This string, which is expanded every time it is used, is output as the initial
16504 positive response to an SMTP connection. The default setting is:
16505 .code
16506 smtp_banner = $smtp_active_hostname ESMTP Exim \
16507   $version_number $tod_full
16508 .endd
16509 Failure to expand the string causes a panic error. If you want to create a
16510 multiline response to the initial SMTP connection, use &"\n"& in the string at
16511 appropriate points, but not at the end. Note that the 220 code is not included
16512 in this string. Exim adds it automatically (several times in the case of a
16513 multiline response).
16514
16515
16516 .option smtp_check_spool_space main boolean true
16517 .cindex "checking disk space"
16518 .cindex "disk space, checking"
16519 .cindex "spool directory" "checking space"
16520 When this option is set, if an incoming SMTP session encounters the SIZE
16521 option on a MAIL command, it checks that there is enough space in the
16522 spool directory's partition to accept a message of that size, while still
16523 leaving free the amount specified by &%check_spool_space%& (even if that value
16524 is zero). If there isn't enough space, a temporary error code is returned.
16525
16526
16527 .option smtp_connect_backlog main integer 20
16528 .cindex "connection backlog"
16529 .cindex "SMTP" "connection backlog"
16530 .cindex "backlog of connections"
16531 This option specifies a maximum number of waiting SMTP connections. Exim passes
16532 this value to the TCP/IP system when it sets up its listener. Once this number
16533 of connections are waiting for the daemon's attention, subsequent connection
16534 attempts are refused at the TCP/IP level. At least, that is what the manuals
16535 say; in some circumstances such connection attempts have been observed to time
16536 out instead. For large systems it is probably a good idea to increase the
16537 value (to 50, say). It also gives some protection against denial-of-service
16538 attacks by SYN flooding.
16539
16540
16541 .option smtp_enforce_sync main boolean true
16542 .cindex "SMTP" "synchronization checking"
16543 .cindex "synchronization checking in SMTP"
16544 The SMTP protocol specification requires the client to wait for a response from
16545 the server at certain points in the dialogue. Without PIPELINING these
16546 synchronization points are after every command; with PIPELINING they are
16547 fewer, but they still exist.
16548
16549 Some spamming sites send out a complete set of SMTP commands without waiting
16550 for any response. Exim protects against this by rejecting a message if the
16551 client has sent further input when it should not have. The error response &"554
16552 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16553 for this error cannot be perfect because of transmission delays (unexpected
16554 input may be on its way but not yet received when Exim checks). However, it
16555 does detect many instances.
16556
16557 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16558 If you want to disable the check selectively (for example, only for certain
16559 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16560 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16561
16562
16563
16564 .option smtp_etrn_command main string&!! unset
16565 .cindex "ETRN" "command to be run"
16566 .vindex "&$domain$&"
16567 If this option is set, the given command is run whenever an SMTP ETRN
16568 command is received from a host that is permitted to issue such commands (see
16569 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16570 are independently expanded. The expansion variable &$domain$& is set to the
16571 argument of the ETRN command, and no syntax checking is done on it. For
16572 example:
16573 .code
16574 smtp_etrn_command = /etc/etrn_command $domain \
16575                     $sender_host_address
16576 .endd
16577 A new process is created to run the command, but Exim does not wait for it to
16578 complete. Consequently, its status cannot be checked. If the command cannot be
16579 run, a line is written to the panic log, but the ETRN caller still receives
16580 a 250 success response. Exim is normally running under its own uid when
16581 receiving SMTP, so it is not possible for it to change the uid before running
16582 the command.
16583
16584
16585 .option smtp_etrn_serialize main boolean true
16586 .cindex "ETRN" "serializing"
16587 When this option is set, it prevents the simultaneous execution of more than
16588 one identical command as a result of ETRN in an SMTP connection. See
16589 section &<<SECTETRN>>& for details.
16590
16591
16592 .option smtp_load_reserve main fixed-point unset
16593 .cindex "load average"
16594 If the system load average ever gets higher than this, incoming SMTP calls are
16595 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16596 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16597 the load is over the limit. The option has no effect on ancient operating
16598 systems on which Exim cannot determine the load average. See also
16599 &%deliver_queue_load_max%& and &%queue_only_load%&.
16600
16601
16602
16603 .option smtp_max_synprot_errors main integer 3
16604 .cindex "SMTP" "limiting syntax and protocol errors"
16605 .cindex "limit" "SMTP syntax and protocol errors"
16606 Exim rejects SMTP commands that contain syntax or protocol errors. In
16607 particular, a syntactically invalid email address, as in this command:
16608 .code
16609 RCPT TO:<abc xyz@a.b.c>
16610 .endd
16611 causes immediate rejection of the command, before any other tests are done.
16612 (The ACL cannot be run if there is no valid address to set up for it.) An
16613 example of a protocol error is receiving RCPT before MAIL. If there are
16614 too many syntax or protocol errors in one SMTP session, the connection is
16615 dropped. The limit is set by this option.
16616
16617 .cindex "PIPELINING" "expected errors"
16618 When the PIPELINING extension to SMTP is in use, some protocol errors are
16619 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16620 Exim assumes that PIPELINING will be used if it advertises it (see
16621 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16622 not count towards the limit.
16623
16624
16625
16626 .option smtp_max_unknown_commands main integer 3
16627 .cindex "SMTP" "limiting unknown commands"
16628 .cindex "limit" "unknown SMTP commands"
16629 If there are too many unrecognized commands in an incoming SMTP session, an
16630 Exim server drops the connection. This is a defence against some kinds of abuse
16631 that subvert web
16632 clients
16633 into making connections to SMTP ports; in these circumstances, a number of
16634 non-SMTP command lines are sent first.
16635
16636
16637
16638 .option smtp_ratelimit_hosts main "host list&!!" unset
16639 .cindex "SMTP" "rate limiting"
16640 .cindex "limit" "rate of message arrival"
16641 .cindex "RCPT" "rate limiting"
16642 Some sites find it helpful to be able to limit the rate at which certain hosts
16643 can send them messages, and the rate at which an individual message can specify
16644 recipients.
16645
16646 Exim has two rate-limiting facilities. This section describes the older
16647 facility, which can limit rates within a single connection. The newer
16648 &%ratelimit%& ACL condition can limit rates across all connections. See section
16649 &<<SECTratelimiting>>& for details of the newer facility.
16650
16651 When a host matches &%smtp_ratelimit_hosts%&, the values of
16652 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16653 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16654 respectively. Each option, if set, must contain a set of four comma-separated
16655 values:
16656
16657 .ilist
16658 A threshold, before which there is no rate limiting.
16659 .next
16660 An initial time delay. Unlike other times in Exim, numbers with decimal
16661 fractional parts are allowed here.
16662 .next
16663 A factor by which to increase the delay each time.
16664 .next
16665 A maximum value for the delay. This should normally be less than 5 minutes,
16666 because after that time, the client is liable to timeout the SMTP command.
16667 .endlist
16668
16669 For example, these settings have been used successfully at the site which
16670 first suggested this feature, for controlling mail from their customers:
16671 .code
16672 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16673 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16674 .endd
16675 The first setting specifies delays that are applied to MAIL commands after
16676 two have been received over a single connection. The initial delay is 0.5
16677 seconds, increasing by a factor of 1.05 each time. The second setting applies
16678 delays to RCPT commands when more than four occur in a single message.
16679
16680
16681 .option smtp_ratelimit_mail main string unset
16682 See &%smtp_ratelimit_hosts%& above.
16683
16684
16685 .option smtp_ratelimit_rcpt main string unset
16686 See &%smtp_ratelimit_hosts%& above.
16687
16688
16689 .option smtp_receive_timeout main time&!! 5m
16690 .cindex "timeout" "for SMTP input"
16691 .cindex "SMTP" "input timeout"
16692 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16693 input, including batch SMTP. If a line of input (either an SMTP command or a
16694 data line) is not received within this time, the SMTP connection is dropped and
16695 the message is abandoned.
16696 A line is written to the log containing one of the following messages:
16697 .code
16698 SMTP command timeout on connection from...
16699 SMTP data timeout on connection from...
16700 .endd
16701 The former means that Exim was expecting to read an SMTP command; the latter
16702 means that it was in the DATA phase, reading the contents of a message.
16703
16704 If the first character of the option is a &"$"& the option is
16705 expanded before use and may depend on
16706 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16707
16708
16709 .oindex "&%-os%&"
16710 The value set by this option can be overridden by the
16711 &%-os%& command-line option. A setting of zero time disables the timeout, but
16712 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16713 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16714 timeout is controlled by &%receive_timeout%& and &%-or%&.
16715
16716
16717 .option smtp_reserve_hosts main "host list&!!" unset
16718 This option defines hosts for which SMTP connections are reserved; see
16719 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16720
16721
16722 .option smtp_return_error_details main boolean false
16723 .cindex "SMTP" "details policy failures"
16724 .cindex "policy control" "rejection, returning details"
16725 In the default state, Exim uses bland messages such as
16726 &"Administrative prohibition"& when it rejects SMTP commands for policy
16727 reasons. Many sysadmins like this because it gives away little information
16728 to spammers. However, some other sysadmins who are applying strict checking
16729 policies want to give out much fuller information about failures. Setting
16730 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16731 example, instead of &"Administrative prohibition"&, it might give:
16732 .code
16733 550-Rejected after DATA: '>' missing at end of address:
16734 550 failing address in "From" header is: <user@dom.ain
16735 .endd
16736
16737
16738 .option smtputf8_advertise_hosts main "host list&!!" *
16739 .cindex "SMTPUTF8" "advertising"
16740 When Exim is built with support for internationalised mail names,
16741 the availability thereof is advertised in
16742 response to EHLO only to those client hosts that match this option. See
16743 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16744
16745
16746 .option spamd_address main string "see below"
16747 This option is available when Exim is compiled with the content-scanning
16748 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16749 The default value is
16750 .code
16751 127.0.0.1 783
16752 .endd
16753 See section &<<SECTscanspamass>>& for more details.
16754
16755
16756
16757 .option split_spool_directory main boolean false
16758 .cindex "multiple spool directories"
16759 .cindex "spool directory" "split"
16760 .cindex "directories, multiple"
16761 If this option is set, it causes Exim to split its input directory into 62
16762 subdirectories, each with a single alphanumeric character as its name. The
16763 sixth character of the message id is used to allocate messages to
16764 subdirectories; this is the least significant base-62 digit of the time of
16765 arrival of the message.
16766
16767 Splitting up the spool in this way may provide better performance on systems
16768 where there are long mail queues, by reducing the number of files in any one
16769 directory. The msglog directory is also split up in a similar way to the input
16770 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16771 are still placed in the single directory &_msglog.OLD_&.
16772
16773 It is not necessary to take any special action for existing messages when
16774 changing &%split_spool_directory%&. Exim notices messages that are in the
16775 &"wrong"& place, and continues to process them. If the option is turned off
16776 after a period of being on, the subdirectories will eventually empty and be
16777 automatically deleted.
16778
16779 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16780 changes. Instead of creating a list of all messages in the queue, and then
16781 trying to deliver each one in turn, it constructs a list of those in one
16782 sub-directory and tries to deliver them, before moving on to the next
16783 sub-directory. The sub-directories are processed in a random order. This
16784 spreads out the scanning of the input directories, and uses less memory. It is
16785 particularly beneficial when there are lots of messages on the queue. However,
16786 if &%queue_run_in_order%& is set, none of this new processing happens. The
16787 entire queue has to be scanned and sorted before any deliveries can start.
16788
16789
16790 .option spool_directory main string&!! "set at compile time"
16791 .cindex "spool directory" "path to"
16792 This defines the directory in which Exim keeps its spool, that is, the messages
16793 it is waiting to deliver. The default value is taken from the compile-time
16794 configuration setting, if there is one. If not, this option must be set. The
16795 string is expanded, so it can contain, for example, a reference to
16796 &$primary_hostname$&.
16797
16798 If the spool directory name is fixed on your installation, it is recommended
16799 that you set it at build time rather than from this option, particularly if the
16800 log files are being written to the spool directory (see &%log_file_path%&).
16801 Otherwise log files cannot be used for errors that are detected early on, such
16802 as failures in the configuration file.
16803
16804 By using this option to override the compiled-in path, it is possible to run
16805 tests of Exim without using the standard spool.
16806
16807 .option sqlite_lock_timeout main time 5s
16808 .cindex "sqlite lookup type" "lock timeout"
16809 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16810 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16811
16812 .option strict_acl_vars main boolean false
16813 .cindex "&ACL;" "variables, handling unset"
16814 This option controls what happens if a syntactically valid but undefined ACL
16815 variable is referenced. If it is false (the default), an empty string
16816 is substituted; if it is true, an error is generated. See section
16817 &<<SECTaclvariables>>& for details of ACL variables.
16818
16819 .option strip_excess_angle_brackets main boolean false
16820 .cindex "angle brackets, excess"
16821 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16822 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16823 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16824 passed on to another MTA, the excess angle brackets are not passed on. If this
16825 option is not set, multiple pairs of angle brackets cause a syntax error.
16826
16827
16828 .option strip_trailing_dot main boolean false
16829 .cindex "trailing dot on domain"
16830 .cindex "dot" "trailing on domain"
16831 If this option is set, a trailing dot at the end of a domain in an address is
16832 ignored. If this is in the envelope and the message is passed on to another
16833 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16834 domain causes a syntax error.
16835 However, addresses in header lines are checked only when an ACL requests header
16836 syntax checking.
16837
16838
16839 .option syslog_duplication main boolean true
16840 .cindex "syslog" "duplicate log lines; suppressing"
16841 When Exim is logging to syslog, it writes the log lines for its three
16842 separate logs at different syslog priorities so that they can in principle
16843 be separated on the logging hosts. Some installations do not require this
16844 separation, and in those cases, the duplication of certain log lines is a
16845 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16846 particular log line is written to syslog. For lines that normally go to
16847 both the main log and the reject log, the reject log version (possibly
16848 containing message header lines) is written, at LOG_NOTICE priority.
16849 Lines that normally go to both the main and the panic log are written at
16850 the LOG_ALERT priority.
16851
16852
16853 .option syslog_facility main string unset
16854 .cindex "syslog" "facility; setting"
16855 This option sets the syslog &"facility"& name, used when Exim is logging to
16856 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16857 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16858 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16859 details of Exim's logging.
16860
16861
16862 .option syslog_pid main boolean true
16863 .cindex "syslog" "pid"
16864 If &%syslog_pid%& is set false, the PID on Exim's log lines are
16865 omitted when these lines are sent to syslog. (Syslog normally prefixes
16866 the log lines with the PID of the logging process automatically.) You need
16867 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
16868 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
16869
16870
16871
16872 .option syslog_processname main string &`exim`&
16873 .cindex "syslog" "process name; setting"
16874 This option sets the syslog &"ident"& name, used when Exim is logging to
16875 syslog. The value must be no longer than 32 characters. See chapter
16876 &<<CHAPlog>>& for details of Exim's logging.
16877
16878
16879
16880 .option syslog_timestamp main boolean true
16881 .cindex "syslog" "timestamps"
16882 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16883 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16884 details of Exim's logging.
16885
16886
16887 .option system_filter main string&!! unset
16888 .cindex "filter" "system filter"
16889 .cindex "system filter" "specifying"
16890 .cindex "Sieve filter" "not available for system filter"
16891 This option specifies an Exim filter file that is applied to all messages at
16892 the start of each delivery attempt, before any routing is done. System filters
16893 must be Exim filters; they cannot be Sieve filters. If the system filter
16894 generates any deliveries to files or pipes, or any new mail messages, the
16895 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16896 which transports are to be used. Details of this facility are given in chapter
16897 &<<CHAPsystemfilter>>&.
16898 .new
16899 A forced expansion failure results in no filter operation.
16900 .wen
16901
16902
16903 .option system_filter_directory_transport main string&!! unset
16904 .vindex "&$address_file$&"
16905 This sets the name of the transport driver that is to be used when the
16906 &%save%& command in a system message filter specifies a path ending in &"/"&,
16907 implying delivery of each message into a separate file in some directory.
16908 During the delivery, the variable &$address_file$& contains the path name.
16909
16910
16911 .option system_filter_file_transport main string&!! unset
16912 .cindex "file" "transport for system filter"
16913 This sets the name of the transport driver that is to be used when the &%save%&
16914 command in a system message filter specifies a path not ending in &"/"&. During
16915 the delivery, the variable &$address_file$& contains the path name.
16916
16917 .option system_filter_group main string unset
16918 .cindex "gid (group id)" "system filter"
16919 This option is used only when &%system_filter_user%& is also set. It sets the
16920 gid under which the system filter is run, overriding any gid that is associated
16921 with the user. The value may be numerical or symbolic.
16922
16923 .option system_filter_pipe_transport main string&!! unset
16924 .cindex "&(pipe)& transport" "for system filter"
16925 .vindex "&$address_pipe$&"
16926 This specifies the transport driver that is to be used when a &%pipe%& command
16927 is used in a system filter. During the delivery, the variable &$address_pipe$&
16928 contains the pipe command.
16929
16930
16931 .option system_filter_reply_transport main string&!! unset
16932 .cindex "&(autoreply)& transport" "for system filter"
16933 This specifies the transport driver that is to be used when a &%mail%& command
16934 is used in a system filter.
16935
16936
16937 .option system_filter_user main string unset
16938 .cindex "uid (user id)" "system filter"
16939 If this option is set to root, the system filter is run in the main Exim
16940 delivery process, as root.  Otherwise, the system filter runs in a separate
16941 process, as the given user, defaulting to the Exim run-time user.
16942 Unless the string consists entirely of digits, it
16943 is looked up in the password data. Failure to find the named user causes a
16944 configuration error. The gid is either taken from the password data, or
16945 specified by &%system_filter_group%&. When the uid is specified numerically,
16946 &%system_filter_group%& is required to be set.
16947
16948 If the system filter generates any pipe, file, or reply deliveries, the uid
16949 under which the filter is run is used when transporting them, unless a
16950 transport option overrides.
16951
16952
16953 .option tcp_nodelay main boolean true
16954 .cindex "daemon" "TCP_NODELAY on sockets"
16955 .cindex "Nagle algorithm"
16956 .cindex "TCP_NODELAY on listening sockets"
16957 If this option is set false, it stops the Exim daemon setting the
16958 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16959 turns off the &"Nagle algorithm"&, which is a way of improving network
16960 performance in interactive (character-by-character) situations. Turning it off
16961 should improve Exim's performance a bit, so that is what happens by default.
16962 However, it appears that some broken clients cannot cope, and time out. Hence
16963 this option. It affects only those sockets that are set up for listening by the
16964 daemon. Sockets created by the smtp transport for delivering mail always set
16965 TCP_NODELAY.
16966
16967
16968 .option timeout_frozen_after main time 0s
16969 .cindex "frozen messages" "timing out"
16970 .cindex "timeout" "frozen messages"
16971 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16972 message of any kind that has been on the queue for longer than the given time
16973 is automatically cancelled at the next queue run. If the frozen message is a
16974 bounce message, it is just discarded; otherwise, a bounce is sent to the
16975 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16976 If you want to timeout frozen bounce messages earlier than other kinds of
16977 frozen message, see &%ignore_bounce_errors_after%&.
16978
16979 &*Note:*& the default value of zero means no timeouts; with this setting,
16980 frozen messages remain on the queue forever (except for any frozen bounce
16981 messages that are released by &%ignore_bounce_errors_after%&).
16982
16983
16984 .option timezone main string unset
16985 .cindex "timezone, setting"
16986 .cindex "environment" "values from"
16987 The value of &%timezone%& is used to set the environment variable TZ while
16988 running Exim (if it is different on entry). This ensures that all timestamps
16989 created by Exim are in the required timezone. If you want all your timestamps
16990 to be in UTC (aka GMT) you should set
16991 .code
16992 timezone = UTC
16993 .endd
16994 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16995 or, if that is not set, from the value of the TZ environment variable when Exim
16996 is built. If &%timezone%& is set to the empty string, either at build or run
16997 time, any existing TZ variable is removed from the environment when Exim
16998 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16999 unfortunately not all, operating systems.
17000
17001
17002 .option tls_advertise_hosts main "host list&!!" *
17003 .cindex "TLS" "advertising"
17004 .cindex "encryption" "on SMTP connection"
17005 .cindex "SMTP" "encrypted connection"
17006 When Exim is built with support for TLS encrypted connections, the availability
17007 of the STARTTLS command to set up an encrypted session is advertised in
17008 response to EHLO only to those client hosts that match this option. See
17009 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17010 Note that the default value requires that a certificate be supplied
17011 using the &%tls_certificate%& option.  If TLS support for incoming connections
17012 is not required the &%tls_advertise_hosts%& option should be set empty.
17013
17014
17015 .option tls_certificate main string&!! unset
17016 .cindex "TLS" "server certificate; location of"
17017 .cindex "certificate" "server, location of"
17018 The value of this option is expanded, and must then be the absolute path to a
17019 file which contains the server's certificates. The server's private key is also
17020 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17021 &<<CHAPTLS>>& for further details.
17022
17023 &*Note*&: The certificates defined by this option are used only when Exim is
17024 receiving incoming messages as a server. If you want to supply certificates for
17025 use when sending messages as a client, you must set the &%tls_certificate%&
17026 option in the relevant &(smtp)& transport.
17027
17028 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17029 if the OpenSSL build supports TLS extensions and the TLS client sends the
17030 Server Name Indication extension, then this option and others documented in
17031 &<<SECTtlssni>>& will be re-expanded.
17032
17033 If this option is unset or empty a fresh self-signed certificate will be
17034 generated for every connection.
17035
17036 .option tls_crl main string&!! unset
17037 .cindex "TLS" "server certificate revocation list"
17038 .cindex "certificate" "revocation list for server"
17039 This option specifies a certificate revocation list. The expanded value must
17040 be the name of a file that contains a CRL in PEM format.
17041
17042 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17043
17044
17045 .option tls_dh_max_bits main integer 2236
17046 .cindex "TLS" "D-H bit count"
17047 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17048 the chosen TLS library.  That value might prove to be too high for
17049 interoperability.  This option provides a maximum clamp on the value
17050 suggested, trading off security for interoperability.
17051
17052 The value must be at least 1024.
17053
17054 The value 2236 was chosen because, at time of adding the option, it was the
17055 hard-coded maximum value supported by the NSS cryptographic library, as used
17056 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17057
17058 If you prefer more security and are willing to break some clients, raise this
17059 number.
17060
17061 Note that the value passed to GnuTLS for *generating* a new prime may be a
17062 little less than this figure, because GnuTLS is inexact and may produce a
17063 larger prime than requested.
17064
17065
17066 .option tls_dhparam main string&!! unset
17067 .cindex "TLS" "D-H parameters for server"
17068 The value of this option is expanded and indicates the source of DH parameters
17069 to be used by Exim.
17070
17071 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17072 local DH parameters*&, which has been supported across all versions of Exim.  The
17073 other specific constants available are a fallback so that even when
17074 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17075
17076 If &%tls_dhparam%& is a filename starting with a &`/`&,
17077 then it names a file from which DH
17078 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17079 PKCS#3 representation of the DH prime.  If the file does not exist, for
17080 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17081 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17082 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17083 and treated as though the &%tls_dhparam%& were set to "none".
17084
17085 If this option expands to the string "none", then no DH parameters will be
17086 loaded by Exim.
17087
17088 If this option expands to the string "historic" and Exim is using GnuTLS, then
17089 Exim will attempt to load a file from inside the spool directory.  If the file
17090 does not exist, Exim will attempt to create it.
17091 See section &<<SECTgnutlsparam>>& for further details.
17092
17093 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17094 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17095
17096 In older versions of Exim the default was the 2048 bit prime described in section
17097 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17098 in IKE is assigned number 23.
17099
17100 Otherwise, the option must expand to the name used by Exim for any of a number
17101 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17102 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17103 the number used by IKE, or "default" which corresponds to
17104 &`exim.dev.20160529.3`&.
17105
17106 The available standard primes are:
17107 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17108 &`ike1`&, &`ike2`&, &`ike5`&,
17109 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17110 &`ike22`&, &`ike23`& and &`ike24`&.
17111
17112 The available additional primes are:
17113 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17114
17115 Some of these will be too small to be accepted by clients.
17116 Some may be too large to be accepted by clients.
17117 The open cryptographic community has suspicions about the integrity of some
17118 of the later IKE values, which led into RFC7919 providing new fixed constants
17119 (the "ffdhe" identifiers).
17120
17121 At this point, all of the "ike" values should be considered obsolete;
17122 they're still in Exim to avoid breaking unusual configurations, but are
17123 candidates for removal the next time we have backwards-incompatible changes.
17124
17125 The TLS protocol does not negotiate an acceptable size for this; clients tend
17126 to hard-drop connections if what is offered by the server is unacceptable,
17127 whether too large or too small, and there's no provision for the client to
17128 tell the server what these constraints are.  Thus, as a server operator, you
17129 need to make an educated guess as to what is most likely to work for your
17130 userbase.
17131
17132 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17133 is most likely to maximise interoperability.  The upper bound comes from
17134 applications using the Mozilla Network Security Services (NSS) library, which
17135 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17136 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17137 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17138 acceptable bound from 1024 to 2048.
17139
17140
17141 .option tls_eccurve main string&!! &`auto`&
17142 .cindex TLS "EC cryptography"
17143 This option selects a EC curve for use by Exim.
17144
17145 After expansion it must contain a valid EC curve parameter, such as
17146 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17147 for valid selections.
17148
17149 For OpenSSL versions before (and not including) 1.0.2, the string
17150 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17151 &`auto`& tells the library to choose.
17152
17153 If the option expands to an empty string, no EC curves will be enabled.
17154
17155
17156 .option tls_ocsp_file main string&!! unset
17157 .cindex TLS "certificate status"
17158 .cindex TLS "OCSP proof file"
17159 This option
17160 must if set expand to the absolute path to a file which contains a current
17161 status proof for the server's certificate, as obtained from the
17162 Certificate Authority.
17163
17164 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17165
17166
17167 .option tls_on_connect_ports main "string list" unset
17168 .cindex SSMTP
17169 .cindex SMTPS
17170 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17171 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17172 set up without waiting for the client to issue a STARTTLS command. For
17173 further details, see section &<<SECTsupobssmt>>&.
17174
17175
17176
17177 .option tls_privatekey main string&!! unset
17178 .cindex "TLS" "server private key; location of"
17179 The value of this option is expanded, and must then be the absolute path to a
17180 file which contains the server's private key. If this option is unset, or if
17181 the expansion is forced to fail, or the result is an empty string, the private
17182 key is assumed to be in the same file as the server's certificates. See chapter
17183 &<<CHAPTLS>>& for further details.
17184
17185 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17186
17187
17188 .option tls_remember_esmtp main boolean false
17189 .cindex "TLS" "esmtp state; remembering"
17190 .cindex "TLS" "broken clients"
17191 If this option is set true, Exim violates the RFCs by remembering that it is in
17192 &"esmtp"& state after successfully negotiating a TLS session. This provides
17193 support for broken clients that fail to send a new EHLO after starting a
17194 TLS session.
17195
17196
17197 .option tls_require_ciphers main string&!! unset
17198 .cindex "TLS" "requiring specific ciphers"
17199 .cindex "cipher" "requiring specific"
17200 This option controls which ciphers can be used for incoming TLS connections.
17201 The &(smtp)& transport has an option of the same name for controlling outgoing
17202 connections. This option is expanded for each connection, so can be varied for
17203 different clients if required. The value of this option must be a list of
17204 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17205 in somewhat different ways. If GnuTLS is being used, the client controls the
17206 preference order of the available ciphers. Details are given in sections
17207 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17208
17209
17210 .option tls_try_verify_hosts main "host list&!!" unset
17211 .cindex "TLS" "client certificate verification"
17212 .cindex "certificate" "verification of client"
17213 See &%tls_verify_hosts%& below.
17214
17215
17216 .option tls_verify_certificates main string&!! system
17217 .cindex "TLS" "client certificate verification"
17218 .cindex "certificate" "verification of client"
17219 The value of this option is expanded, and must then be either the
17220 word "system"
17221 or the absolute path to
17222 a file or directory containing permitted certificates for clients that
17223 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17224
17225 The "system" value for the option will use a
17226 system default location compiled into the SSL library.
17227 This is not available for GnuTLS versions preceding 3.0.20,
17228 and will be taken as empty; an explicit location
17229 must be specified.
17230
17231 The use of a directory for the option value is not available for GnuTLS versions
17232 preceding 3.3.6 and a single file must be used.
17233
17234 With OpenSSL the certificates specified
17235 explicitly
17236 either by file or directory
17237 are added to those given by the system default location.
17238
17239 These certificates should be for the certificate authorities trusted, rather
17240 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17241 the value is a file then the certificates are sent by Exim as a server to
17242 connecting clients, defining the list of accepted certificate authorities.
17243 Thus the values defined should be considered public data.  To avoid this,
17244 use the explicit directory version.
17245
17246 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17247
17248 A forced expansion failure or setting to an empty string is equivalent to
17249 being unset.
17250
17251
17252 .option tls_verify_hosts main "host list&!!" unset
17253 .cindex "TLS" "client certificate verification"
17254 .cindex "certificate" "verification of client"
17255 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17256 certificates from clients. The expected certificates are defined by
17257 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17258 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17259 &%tls_verify_certificates%& is not set.
17260
17261 Any client that matches &%tls_verify_hosts%& is constrained by
17262 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17263 present one of the listed certificates. If it does not, the connection is
17264 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17265 the host to use TLS. It can still send SMTP commands through unencrypted
17266 connections. Forcing a client to use TLS has to be done separately using an
17267 ACL to reject inappropriate commands when the connection is not encrypted.
17268
17269 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17270 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17271 certificate and checks it against &%tls_verify_certificates%&, but does not
17272 abort the connection if there is no certificate or if it does not match. This
17273 state can be detected in an ACL, which makes it possible to implement policies
17274 such as &"accept for relay only if a verified certificate has been received,
17275 but accept for local delivery if encrypted, even without a verified
17276 certificate"&.
17277
17278 Client hosts that match neither of these lists are not asked to present
17279 certificates.
17280
17281
17282 .option trusted_groups main "string list&!!" unset
17283 .cindex "trusted groups"
17284 .cindex "groups" "trusted"
17285 This option is expanded just once, at the start of Exim's processing. If this
17286 option is set, any process that is running in one of the listed groups, or
17287 which has one of them as a supplementary group, is trusted. The groups can be
17288 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17289 details of what trusted callers are permitted to do. If neither
17290 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17291 are trusted.
17292
17293 .option trusted_users main "string list&!!" unset
17294 .cindex "trusted users"
17295 .cindex "user" "trusted"
17296 This option is expanded just once, at the start of Exim's processing. If this
17297 option is set, any process that is running as one of the listed users is
17298 trusted. The users can be specified numerically or by name. See section
17299 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17300 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17301 Exim user are trusted.
17302
17303 .option unknown_login main string&!! unset
17304 .cindex "uid (user id)" "unknown caller"
17305 .vindex "&$caller_uid$&"
17306 This is a specialized feature for use in unusual configurations. By default, if
17307 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17308 gives up. The &%unknown_login%& option can be used to set a login name to be
17309 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17310 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17311 is used for the user's real name (gecos field), unless this has been set by the
17312 &%-F%& option.
17313
17314 .option unknown_username main string unset
17315 See &%unknown_login%&.
17316
17317 .option untrusted_set_sender main "address list&!!" unset
17318 .cindex "trusted users"
17319 .cindex "sender" "setting by untrusted user"
17320 .cindex "untrusted user setting sender"
17321 .cindex "user" "untrusted setting sender"
17322 .cindex "envelope sender"
17323 When an untrusted user submits a message to Exim using the standard input, Exim
17324 normally creates an envelope sender address from the user's login and the
17325 default qualification domain. Data from the &%-f%& option (for setting envelope
17326 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17327 is used) is ignored.
17328
17329 However, untrusted users are permitted to set an empty envelope sender address,
17330 to declare that a message should never generate any bounces. For example:
17331 .code
17332 exim -f '<>' user@domain.example
17333 .endd
17334 .vindex "&$sender_ident$&"
17335 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17336 other envelope sender addresses in a controlled way. When it is set, untrusted
17337 users are allowed to set envelope sender addresses that match any of the
17338 patterns in the list. Like all address lists, the string is expanded. The
17339 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17340 users to setting senders that start with their login ids
17341 followed by a hyphen
17342 by a setting like this:
17343 .code
17344 untrusted_set_sender = ^$sender_ident-
17345 .endd
17346 If you want to allow untrusted users to set envelope sender addresses without
17347 restriction, you can use
17348 .code
17349 untrusted_set_sender = *
17350 .endd
17351 The &%untrusted_set_sender%& option applies to all forms of local input, but
17352 only to the setting of the envelope sender. It does not permit untrusted users
17353 to use the other options which trusted user can use to override message
17354 parameters. Furthermore, it does not stop Exim from removing an existing
17355 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17356 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17357 overriding these actions. The handling of the &'Sender:'& header is also
17358 described in section &<<SECTthesenhea>>&.
17359
17360 The log line for a message's arrival shows the envelope sender following
17361 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17362 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17363 envelope sender address, the user's login is shown in parentheses after the
17364 sender address.
17365
17366
17367 .option uucp_from_pattern main string "see below"
17368 .cindex "&""From""& line"
17369 .cindex "UUCP" "&""From""& line"
17370 Some applications that pass messages to an MTA via a command line interface use
17371 an initial line starting with &"From&~"& to pass the envelope sender. In
17372 particular, this is used by UUCP software. Exim recognizes such a line by means
17373 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17374 matches, the sender address is constructed by expanding the contents of
17375 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17376 default pattern recognizes lines in the following two forms:
17377 .code
17378 From ph10 Fri Jan  5 12:35 GMT 1996
17379 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17380 .endd
17381 The pattern can be seen by running
17382 .code
17383 exim -bP uucp_from_pattern
17384 .endd
17385 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17386 year in the second case. The first word after &"From&~"& is matched in the
17387 regular expression by a parenthesized subpattern. The default value for
17388 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17389 (&"ph10"& in the example above) as the message's sender. See also
17390 &%ignore_fromline_hosts%&.
17391
17392
17393 .option uucp_from_sender main string&!! &`$1`&
17394 See &%uucp_from_pattern%& above.
17395
17396
17397 .option warn_message_file main string unset
17398 .cindex "warning of delay" "customizing the message"
17399 .cindex "customizing" "warning message"
17400 This option defines a template file containing paragraphs of text to be used
17401 for constructing the warning message which is sent by Exim when a message has
17402 been on the queue for a specified amount of time, as specified by
17403 &%delay_warning%&. Details of the file's contents are given in chapter
17404 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17405
17406
17407 .option write_rejectlog main boolean true
17408 .cindex "reject log" "disabling"
17409 If this option is set false, Exim no longer writes anything to the reject log.
17410 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17411 .ecindex IIDconfima
17412 .ecindex IIDmaiconf
17413
17414
17415
17416
17417 . ////////////////////////////////////////////////////////////////////////////
17418 . ////////////////////////////////////////////////////////////////////////////
17419
17420 .chapter "Generic options for routers" "CHAProutergeneric"
17421 .scindex IIDgenoprou1 "options" "generic; for routers"
17422 .scindex IIDgenoprou2 "generic options" "router"
17423 This chapter describes the generic options that apply to all routers.
17424 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17425
17426 For a general description of how a router operates, see sections
17427 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17428 which the preconditions are tested. The order of expansion of the options that
17429 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17430 &%headers_remove%&, &%transport%&.
17431
17432
17433
17434 .option address_data routers string&!! unset
17435 .cindex "router" "data attached to address"
17436 The string is expanded just before the router is run, that is, after all the
17437 precondition tests have succeeded. If the expansion is forced to fail, the
17438 router declines, the value of &%address_data%& remains unchanged, and the
17439 &%more%& option controls what happens next. Other expansion failures cause
17440 delivery of the address to be deferred.
17441
17442 .vindex "&$address_data$&"
17443 When the expansion succeeds, the value is retained with the address, and can be
17444 accessed using the variable &$address_data$& in the current router, subsequent
17445 routers, and the eventual transport.
17446
17447 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17448 that runs a user's filter file, the contents of &$address_data$& are accessible
17449 in the filter. This is not normally a problem, because such data is usually
17450 either not confidential or it &"belongs"& to the current user, but if you do
17451 put confidential data into &$address_data$& you need to remember this point.
17452
17453 Even if the router declines or passes, the value of &$address_data$& remains
17454 with the address, though it can be changed by another &%address_data%& setting
17455 on a subsequent router. If a router generates child addresses, the value of
17456 &$address_data$& propagates to them. This also applies to the special kind of
17457 &"child"& that is generated by a router with the &%unseen%& option.
17458
17459 The idea of &%address_data%& is that you can use it to look up a lot of data
17460 for the address once, and then pick out parts of the data later. For example,
17461 you could use a single LDAP lookup to return a string of the form
17462 .code
17463 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17464 .endd
17465 In the transport you could pick out the mailbox by a setting such as
17466 .code
17467 file = ${extract{mailbox}{$address_data}}
17468 .endd
17469 This makes the configuration file less messy, and also reduces the number of
17470 lookups (though Exim does cache lookups).
17471
17472 .vindex "&$sender_address_data$&"
17473 .vindex "&$address_data$&"
17474 The &%address_data%& facility is also useful as a means of passing information
17475 from one router to another, and from a router to a transport. In addition, if
17476 &$address_data$& is set by a router when verifying a recipient address from an
17477 ACL, it remains available for use in the rest of the ACL statement. After
17478 verifying a sender, the value is transferred to &$sender_address_data$&.
17479
17480
17481
17482 .option address_test routers&!? boolean true
17483 .oindex "&%-bt%&"
17484 .cindex "router" "skipping when address testing"
17485 If this option is set false, the router is skipped when routing is being tested
17486 by means of the &%-bt%& command line option. This can be a convenience when
17487 your first router sends messages to an external scanner, because it saves you
17488 having to set the &"already scanned"& indicator when testing real address
17489 routing.
17490
17491
17492
17493 .option cannot_route_message routers string&!! unset
17494 .cindex "router" "customizing &""cannot route""& message"
17495 .cindex "customizing" "&""cannot route""& message"
17496 This option specifies a text message that is used when an address cannot be
17497 routed because Exim has run out of routers. The default message is
17498 &"Unrouteable address"&. This option is useful only on routers that have
17499 &%more%& set false, or on the very last router in a configuration, because the
17500 value that is used is taken from the last router that is considered. This
17501 includes a router that is skipped because its preconditions are not met, as
17502 well as a router that declines. For example, using the default configuration,
17503 you could put:
17504 .code
17505 cannot_route_message = Remote domain not found in DNS
17506 .endd
17507 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17508 and
17509 .code
17510 cannot_route_message = Unknown local user
17511 .endd
17512 on the final router that checks for local users. If string expansion fails for
17513 this option, the default message is used. Unless the expansion failure was
17514 explicitly forced, a message about the failure is written to the main and panic
17515 logs, in addition to the normal message about the routing failure.
17516
17517
17518 .option caseful_local_part routers boolean false
17519 .cindex "case of local parts"
17520 .cindex "router" "case of local parts"
17521 By default, routers handle the local parts of addresses in a case-insensitive
17522 manner, though the actual case is preserved for transmission with the message.
17523 If you want the case of letters to be significant in a router, you must set
17524 this option true. For individual router options that contain address or local
17525 part lists (for example, &%local_parts%&), case-sensitive matching can be
17526 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17527 more details.
17528
17529 .vindex "&$local_part$&"
17530 .vindex "&$original_local_part$&"
17531 .vindex "&$parent_local_part$&"
17532 The value of the &$local_part$& variable is forced to lower case while a
17533 router is running unless &%caseful_local_part%& is set. When a router assigns
17534 an address to a transport, the value of &$local_part$& when the transport runs
17535 is the same as it was in the router. Similarly, when a router generates child
17536 addresses by aliasing or forwarding, the values of &$original_local_part$&
17537 and &$parent_local_part$& are those that were used by the redirecting router.
17538
17539 This option applies to the processing of an address by a router. When a
17540 recipient address is being processed in an ACL, there is a separate &%control%&
17541 modifier that can be used to specify case-sensitive processing within the ACL
17542 (see section &<<SECTcontrols>>&).
17543
17544
17545
17546 .option check_local_user routers&!? boolean false
17547 .cindex "local user, checking in router"
17548 .cindex "router" "checking for local user"
17549 .cindex "&_/etc/passwd_&"
17550 .vindex "&$home$&"
17551 When this option is true, Exim checks that the local part of the recipient
17552 address (with affixes removed if relevant) is the name of an account on the
17553 local system. The check is done by calling the &[getpwnam()]& function rather
17554 than trying to read &_/etc/passwd_& directly. This means that other methods of
17555 holding password data (such as NIS) are supported. If the local part is a local
17556 user, &$home$& is set from the password data, and can be tested in other
17557 preconditions that are evaluated after this one (the order of evaluation is
17558 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17559 overridden by &%router_home_directory%&. If the local part is not a local user,
17560 the router is skipped.
17561
17562 If you want to check that the local part is either the name of a local user
17563 or matches something else, you cannot combine &%check_local_user%& with a
17564 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17565 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17566 setting to achieve this. For example:
17567 .code
17568 local_parts = passwd;$local_part : lsearch;/etc/other/users
17569 .endd
17570 Note, however, that the side effects of &%check_local_user%& (such as setting
17571 up a home directory) do not occur when a &(passwd)& lookup is used in a
17572 &%local_parts%& (or any other) precondition.
17573
17574
17575
17576 .option condition routers&!? string&!! unset
17577 .cindex "router" "customized precondition"
17578 This option specifies a general precondition test that has to succeed for the
17579 router to be called. The &%condition%& option is the last precondition to be
17580 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17581 result is a forced failure, or an empty string, or one of the strings &"0"& or
17582 &"no"& or &"false"& (checked without regard to the case of the letters), the
17583 router is skipped, and the address is offered to the next one.
17584
17585 If the result is any other value, the router is run (as this is the last
17586 precondition to be evaluated, all the other preconditions must be true).
17587
17588 This option is unusual in that multiple &%condition%& options may be present.
17589 All &%condition%& options must succeed.
17590
17591 The &%condition%& option provides a means of applying custom conditions to the
17592 running of routers. Note that in the case of a simple conditional expansion,
17593 the default expansion values are exactly what is wanted. For example:
17594 .code
17595 condition = ${if >{$message_age}{600}}
17596 .endd
17597 Because of the default behaviour of the string expansion, this is equivalent to
17598 .code
17599 condition = ${if >{$message_age}{600}{true}{}}
17600 .endd
17601
17602 A multiple condition example, which succeeds:
17603 .code
17604 condition = ${if >{$message_age}{600}}
17605 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17606 condition = foobar
17607 .endd
17608
17609 If the expansion fails (other than forced failure) delivery is deferred. Some
17610 of the other precondition options are common special cases that could in fact
17611 be specified using &%condition%&.
17612
17613 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17614 are far older, and use one set of semantics.  ACLs are newer and when
17615 they were created, the ACL &%condition%& process was given far stricter
17616 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17617 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17618 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17619 Router rules processing behavior.
17620
17621 This is best illustrated in an example:
17622 .code
17623 # If used in an ACL condition will fail with a syntax error, but
17624 # in a router condition any extra characters are treated as a string
17625
17626 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17627 true {yes} {no}}
17628
17629 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17630  {yes} {no}}
17631 .endd
17632 In each example above, the &%if%& statement actually ends after
17633 &"{google.com}}"&.  Since no true or false braces were defined, the
17634 default &%if%& behavior is to return a boolean true or a null answer
17635 (which evaluates to false). The rest of the line is then treated as a
17636 string. So the first example resulted in the boolean answer &"true"&
17637 with the string &" {yes} {no}}"& appended to it. The second example
17638 resulted in the null output (indicating false) with the string
17639 &" {yes} {no}}"& appended to it.
17640
17641 In fact you can put excess forward braces in too.  In the router
17642 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17643 mean something, like after a &"$"& or when required as part of a
17644 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17645 string characters.
17646
17647 Thus, in a Router, the above expansion strings will both always evaluate
17648 true, as the result of expansion is a non-empty string which doesn't
17649 match an explicit false value.  This can be tricky to debug.  By
17650 contrast, in an ACL either of those strings will always result in an
17651 expansion error because the result doesn't look sufficiently boolean.
17652
17653
17654 .option debug_print routers string&!! unset
17655 .cindex "testing" "variables in drivers"
17656 If this option is set and debugging is enabled (see the &%-d%& command line
17657 option) or in address-testing mode (see the &%-bt%& command line option),
17658 the string is expanded and included in the debugging output.
17659 If expansion of the string fails, the error message is written to the debugging
17660 output, and Exim carries on processing.
17661 This option is provided to help with checking out the values of variables and
17662 so on when debugging router configurations. For example, if a &%condition%&
17663 option appears not to be working, &%debug_print%& can be used to output the
17664 variables it references. The output happens after checks for &%domains%&,
17665 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17666 are tested. A newline is added to the text if it does not end with one.
17667 The variable &$router_name$& contains the name of the router.
17668
17669
17670
17671 .option disable_logging routers boolean false
17672 If this option is set true, nothing is logged for any routing errors
17673 or for any deliveries caused by this router. You should not set this option
17674 unless you really, really know what you are doing. See also the generic
17675 transport option of the same name.
17676
17677 .option dnssec_request_domains routers "domain list&!!" unset
17678 .cindex "MX record" "security"
17679 .cindex "DNSSEC" "MX lookup"
17680 .cindex "security" "MX lookup"
17681 .cindex "DNS" "DNSSEC"
17682 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17683 the dnssec request bit set.
17684 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17685
17686 .option dnssec_require_domains routers "domain list&!!" unset
17687 .cindex "MX record" "security"
17688 .cindex "DNSSEC" "MX lookup"
17689 .cindex "security" "MX lookup"
17690 .cindex "DNS" "DNSSEC"
17691 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17692 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17693 (AD bit) set will be ignored and logged as a host-lookup failure.
17694 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17695
17696
17697 .option domains routers&!? "domain list&!!" unset
17698 .cindex "router" "restricting to specific domains"
17699 .vindex "&$domain_data$&"
17700 If this option is set, the router is skipped unless the current domain matches
17701 the list. If the match is achieved by means of a file lookup, the data that the
17702 lookup returned for the domain is placed in &$domain_data$& for use in string
17703 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17704 a list of the order in which preconditions are evaluated.
17705
17706
17707
17708 .option driver routers string unset
17709 This option must always be set. It specifies which of the available routers is
17710 to be used.
17711
17712
17713 .option dsn_lasthop routers boolean false
17714 .cindex "DSN" "success"
17715 .cindex "Delivery Status Notification" "success"
17716 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17717 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17718 instead send a success DSN as if the next hop does not support DSN.
17719 Not effective on redirect routers.
17720
17721
17722
17723 .option errors_to routers string&!! unset
17724 .cindex "envelope sender"
17725 .cindex "router" "changing address for errors"
17726 If a router successfully handles an address, it may assign the address to a
17727 transport for delivery or it may generate child addresses. In both cases, if
17728 there is a delivery problem during later processing, the resulting bounce
17729 message is sent to the address that results from expanding this string,
17730 provided that the address verifies successfully. The &%errors_to%& option is
17731 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17732
17733 The &%errors_to%& setting associated with an address can be overridden if it
17734 subsequently passes through other routers that have their own &%errors_to%&
17735 settings, or if the message is delivered by a transport with a &%return_path%&
17736 setting.
17737
17738 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17739 the expansion fails to verify, the errors address associated with the incoming
17740 address is used. At top level, this is the envelope sender. A non-forced
17741 expansion failure causes delivery to be deferred.
17742
17743 If an address for which &%errors_to%& has been set ends up being delivered over
17744 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17745 any bounces that are generated by other MTAs on the delivery route are also
17746 sent there. You can set &%errors_to%& to the empty string by either of these
17747 settings:
17748 .code
17749 errors_to =
17750 errors_to = ""
17751 .endd
17752 An expansion item that yields an empty string has the same effect. If you do
17753 this, a locally detected delivery error for addresses processed by this router
17754 no longer gives rise to a bounce message; the error is discarded. If the
17755 address is delivered to a remote host, the return path is set to &`<>`&, unless
17756 overridden by the &%return_path%& option on the transport.
17757
17758 .vindex "&$address_data$&"
17759 If for some reason you want to discard local errors, but use a non-empty
17760 MAIL command for remote delivery, you can preserve the original return
17761 path in &$address_data$& in the router, and reinstate it in the transport by
17762 setting &%return_path%&.
17763
17764 The most common use of &%errors_to%& is to direct mailing list bounces to the
17765 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17766 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17767
17768
17769
17770 .option expn routers&!? boolean true
17771 .cindex "address" "testing"
17772 .cindex "testing" "addresses"
17773 .cindex "EXPN" "router skipping"
17774 .cindex "router" "skipping for EXPN"
17775 If this option is turned off, the router is skipped when testing an address
17776 as a result of processing an SMTP EXPN command. You might, for example,
17777 want to turn it off on a router for users' &_.forward_& files, while leaving it
17778 on for the system alias file.
17779 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17780 are evaluated.
17781
17782 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17783 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17784 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17785
17786
17787
17788 .option fail_verify routers boolean false
17789 .cindex "router" "forcing verification failure"
17790 Setting this option has the effect of setting both &%fail_verify_sender%& and
17791 &%fail_verify_recipient%& to the same value.
17792
17793
17794
17795 .option fail_verify_recipient routers boolean false
17796 If this option is true and an address is accepted by this router when
17797 verifying a recipient, verification fails.
17798
17799
17800
17801 .option fail_verify_sender routers boolean false
17802 If this option is true and an address is accepted by this router when
17803 verifying a sender, verification fails.
17804
17805
17806
17807 .option fallback_hosts routers "string list" unset
17808 .cindex "router" "fallback hosts"
17809 .cindex "fallback" "hosts specified on router"
17810 String expansion is not applied to this option. The argument must be a
17811 colon-separated list of host names or IP addresses. The list separator can be
17812 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17813 each name or address. In fact, the format of each item is exactly the same as
17814 defined for the list of hosts in a &(manualroute)& router (see section
17815 &<<SECTformatonehostitem>>&).
17816
17817 If a router queues an address for a remote transport, this host list is
17818 associated with the address, and used instead of the transport's fallback host
17819 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17820 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17821 transport for further details.
17822
17823
17824 .option group routers string&!! "see below"
17825 .cindex "gid (group id)" "local delivery"
17826 .cindex "local transports" "uid and gid"
17827 .cindex "transport" "local"
17828 .cindex "router" "setting group"
17829 When a router queues an address for a transport, and the transport does not
17830 specify a group, the group given here is used when running the delivery
17831 process.
17832 The group may be specified numerically or by name. If expansion fails, the
17833 error is logged and delivery is deferred.
17834 The default is unset, unless &%check_local_user%& is set, when the default
17835 is taken from the password information. See also &%initgroups%& and &%user%&
17836 and the discussion in chapter &<<CHAPenvironment>>&.
17837
17838
17839
17840 .option headers_add routers list&!! unset
17841 .cindex "header lines" "adding"
17842 .cindex "router" "adding header lines"
17843 This option specifies a list of text headers,
17844 newline-separated (by default, changeable in the usual way),
17845 that is associated with any addresses that are accepted by the router.
17846 Each item is separately expanded, at routing time.  However, this
17847 option has no effect when an address is just being verified. The way in which
17848 the text is used to add header lines at transport time is described in section
17849 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17850 message is in the process of being transported. This means that references to
17851 header lines in string expansions in the transport's configuration do not
17852 &"see"& the added header lines.
17853
17854 The &%headers_add%& option is expanded after &%errors_to%&, but before
17855 &%headers_remove%& and &%transport%&. If an item is empty, or if
17856 an item expansion is forced to fail, the item has no effect. Other expansion
17857 failures are treated as configuration errors.
17858
17859 Unlike most options, &%headers_add%& can be specified multiple times
17860 for a router; all listed headers are added.
17861
17862 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17863 router that has the &%one_time%& option set.
17864
17865 .cindex "duplicate addresses"
17866 .oindex "&%unseen%&"
17867 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17868 additions are deleted when the address is passed on to subsequent routers.
17869 For a &%redirect%& router, if a generated address is the same as the incoming
17870 address, this can lead to duplicate addresses with different header
17871 modifications. Exim does not do duplicate deliveries (except, in certain
17872 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17873 which of the duplicates is discarded, so this ambiguous situation should be
17874 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17875
17876
17877
17878 .option headers_remove routers list&!! unset
17879 .cindex "header lines" "removing"
17880 .cindex "router" "removing header lines"
17881 This option specifies a list of text headers,
17882 colon-separated (by default, changeable in the usual way),
17883 that is associated with any addresses that are accepted by the router.
17884 Each item is separately expanded, at routing time.  However, this
17885 option has no effect when an address is just being verified. The way in which
17886 the text is used to remove header lines at transport time is described in
17887 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17888 the message is in the process of being transported. This means that references
17889 to header lines in string expansions in the transport's configuration still
17890 &"see"& the original header lines.
17891
17892 The &%headers_remove%& option is expanded after &%errors_to%& and
17893 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17894 the item has no effect. Other expansion failures are treated as configuration
17895 errors.
17896
17897 Unlike most options, &%headers_remove%& can be specified multiple times
17898 for a router; all listed headers are removed.
17899
17900 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17901 router that has the &%one_time%& option set.
17902
17903 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17904 removal requests are deleted when the address is passed on to subsequent
17905 routers, and this can lead to problems with duplicates -- see the similar
17906 warning for &%headers_add%& above.
17907
17908 &*Warning 3*&: Because of the separate expansion of the list items,
17909 items that contain a list separator must have it doubled.
17910 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17911
17912
17913
17914 .option ignore_target_hosts routers "host list&!!" unset
17915 .cindex "IP address" "discarding"
17916 .cindex "router" "discarding IP addresses"
17917 Although this option is a host list, it should normally contain IP address
17918 entries rather than names. If any host that is looked up by the router has an
17919 IP address that matches an item in this list, Exim behaves as if that IP
17920 address did not exist. This option allows you to cope with rogue DNS entries
17921 like
17922 .code
17923 remote.domain.example.  A  127.0.0.1
17924 .endd
17925 by setting
17926 .code
17927 ignore_target_hosts = 127.0.0.1
17928 .endd
17929 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17930 discarded in this way, the router declines. In a conventional configuration, an
17931 attempt to mail to such a domain would normally provoke the &"unrouteable
17932 domain"& error, and an attempt to verify an address in the domain would fail.
17933 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17934 router declines if presented with one of the listed addresses.
17935
17936 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17937 means of the first or the second of the following settings, respectively:
17938 .code
17939 ignore_target_hosts = 0.0.0.0/0
17940 ignore_target_hosts = <; 0::0/0
17941 .endd
17942 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17943 in the second line matches all IPv6 addresses.
17944
17945 This option may also be useful for ignoring link-local and site-local IPv6
17946 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17947 is expanded before use as a list, it is possible to make it dependent on the
17948 domain that is being routed.
17949
17950 .vindex "&$host_address$&"
17951 During its expansion, &$host_address$& is set to the IP address that is being
17952 checked.
17953
17954 .option initgroups routers boolean false
17955 .cindex "additional groups"
17956 .cindex "groups" "additional"
17957 .cindex "local transports" "uid and gid"
17958 .cindex "transport" "local"
17959 If the router queues an address for a transport, and this option is true, and
17960 the uid supplied by the router is not overridden by the transport, the
17961 &[initgroups()]& function is called when running the transport to ensure that
17962 any additional groups associated with the uid are set up. See also &%group%&
17963 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17964
17965
17966
17967 .option local_part_prefix routers&!? "string list" unset
17968 .cindex "router" "prefix for local part"
17969 .cindex "prefix" "for local part, used in router"
17970 If this option is set, the router is skipped unless the local part starts with
17971 one of the given strings, or &%local_part_prefix_optional%& is true. See
17972 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17973 evaluated.
17974
17975 The list is scanned from left to right, and the first prefix that matches is
17976 used. A limited form of wildcard is available; if the prefix begins with an
17977 asterisk, it matches the longest possible sequence of arbitrary characters at
17978 the start of the local part. An asterisk should therefore always be followed by
17979 some character that does not occur in normal local parts.
17980 .cindex "multiple mailboxes"
17981 .cindex "mailbox" "multiple"
17982 Wildcarding can be used to set up multiple user mailboxes, as described in
17983 section &<<SECTmulbox>>&.
17984
17985 .vindex "&$local_part$&"
17986 .vindex "&$local_part_prefix$&"
17987 During the testing of the &%local_parts%& option, and while the router is
17988 running, the prefix is removed from the local part, and is available in the
17989 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17990 the router accepts the address, this remains true during subsequent delivery by
17991 a transport. In particular, the local part that is transmitted in the RCPT
17992 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17993 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17994 the relevant transport.
17995
17996 When an address is being verified, &%local_part_prefix%& affects only the
17997 behaviour of the router. If the callout feature of verification is in use, this
17998 means that the full address, including the prefix, will be used during the
17999 callout.
18000
18001 The prefix facility is commonly used to handle local parts of the form
18002 &%owner-something%&. Another common use is to support local parts of the form
18003 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18004 to tell a user their forwarding is broken &-- by placing a router like this one
18005 immediately before the router that handles &_.forward_& files:
18006 .code
18007 real_localuser:
18008   driver = accept
18009   local_part_prefix = real-
18010   check_local_user
18011   transport = local_delivery
18012 .endd
18013 For security, it would probably be a good idea to restrict the use of this
18014 router to locally-generated messages, using a condition such as this:
18015 .code
18016   condition = ${if match {$sender_host_address}\
18017                          {\N^(|127\.0\.0\.1)$\N}}
18018 .endd
18019
18020 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18021 both conditions must be met if not optional. Care must be taken if wildcards
18022 are used in both a prefix and a suffix on the same router. Different
18023 separator characters must be used to avoid ambiguity.
18024
18025
18026 .option local_part_prefix_optional routers boolean false
18027 See &%local_part_prefix%& above.
18028
18029
18030
18031 .option local_part_suffix routers&!? "string list" unset
18032 .cindex "router" "suffix for local part"
18033 .cindex "suffix for local part" "used in router"
18034 This option operates in the same way as &%local_part_prefix%&, except that the
18035 local part must end (rather than start) with the given string, the
18036 &%local_part_suffix_optional%& option determines whether the suffix is
18037 mandatory, and the wildcard * character, if present, must be the last
18038 character of the suffix. This option facility is commonly used to handle local
18039 parts of the form &%something-request%& and multiple user mailboxes of the form
18040 &%username-foo%&.
18041
18042
18043 .option local_part_suffix_optional routers boolean false
18044 See &%local_part_suffix%& above.
18045
18046
18047
18048 .option local_parts routers&!? "local part list&!!" unset
18049 .cindex "router" "restricting to specific local parts"
18050 .cindex "local part" "checking in router"
18051 The router is run only if the local part of the address matches the list.
18052 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18053 are evaluated, and
18054 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18055 string is expanded, it is possible to make it depend on the domain, for
18056 example:
18057 .code
18058 local_parts = dbm;/usr/local/specials/$domain
18059 .endd
18060 .vindex "&$local_part_data$&"
18061 If the match is achieved by a lookup, the data that the lookup returned
18062 for the local part is placed in the variable &$local_part_data$& for use in
18063 expansions of the router's private options. You might use this option, for
18064 example, if you have a large number of local virtual domains, and you want to
18065 send all postmaster mail to the same place without having to set up an alias in
18066 each virtual domain:
18067 .code
18068 postmaster:
18069   driver = redirect
18070   local_parts = postmaster
18071   data = postmaster@real.domain.example
18072 .endd
18073
18074
18075 .option log_as_local routers boolean "see below"
18076 .cindex "log" "delivery line"
18077 .cindex "delivery" "log line format"
18078 Exim has two logging styles for delivery, the idea being to make local
18079 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18080 recipient address is given just as the local part, without a domain. The use of
18081 this style is controlled by this option. It defaults to true for the &(accept)&
18082 router, and false for all the others. This option applies only when a
18083 router assigns an address to a transport. It has no effect on routers that
18084 redirect addresses.
18085
18086
18087
18088 .option more routers boolean&!! true
18089 The result of string expansion for this option must be a valid boolean value,
18090 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18091 result causes an error, and delivery is deferred. If the expansion is forced to
18092 fail, the default value for the option (true) is used. Other failures cause
18093 delivery to be deferred.
18094
18095 If this option is set false, and the router declines to handle the address, no
18096 further routers are tried, routing fails, and the address is bounced.
18097 .oindex "&%self%&"
18098 However, if the router explicitly passes an address to the following router by
18099 means of the setting
18100 .code
18101 self = pass
18102 .endd
18103 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18104 does not affect the behaviour if one of the precondition tests fails. In that
18105 case, the address is always passed to the next router.
18106
18107 Note that &%address_data%& is not considered to be a precondition. If its
18108 expansion is forced to fail, the router declines, and the value of &%more%&
18109 controls what happens next.
18110
18111
18112 .option pass_on_timeout routers boolean false
18113 .cindex "timeout" "of router"
18114 .cindex "router" "timeout"
18115 If a router times out during a host lookup, it normally causes deferral of the
18116 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18117 router, overriding &%no_more%&. This may be helpful for systems that are
18118 intermittently connected to the Internet, or those that want to pass to a smart
18119 host any messages that cannot immediately be delivered.
18120
18121 There are occasional other temporary errors that can occur while doing DNS
18122 lookups. They are treated in the same way as a timeout, and this option
18123 applies to all of them.
18124
18125
18126
18127 .option pass_router routers string unset
18128 .cindex "router" "go to after &""pass""&"
18129 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18130 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18131 routing to continue, and overriding a false setting of &%more%&. When one of
18132 these routers returns &"pass"&, the address is normally handed on to the next
18133 router in sequence. This can be changed by setting &%pass_router%& to the name
18134 of another router. However (unlike &%redirect_router%&) the named router must
18135 be below the current router, to avoid loops. Note that this option applies only
18136 to the special case of &"pass"&. It does not apply when a router returns
18137 &"decline"& because it cannot handle an address.
18138
18139
18140
18141 .option redirect_router routers string unset
18142 .cindex "router" "start at after redirection"
18143 Sometimes an administrator knows that it is pointless to reprocess addresses
18144 generated from alias or forward files with the same router again. For
18145 example, if an alias file translates real names into login ids there is no
18146 point searching the alias file a second time, especially if it is a large file.
18147
18148 The &%redirect_router%& option can be set to the name of any router instance.
18149 It causes the routing of any generated addresses to start at the named router
18150 instead of at the first router. This option has no effect if the router in
18151 which it is set does not generate new addresses.
18152
18153
18154
18155 .option require_files routers&!? "string list&!!" unset
18156 .cindex "file" "requiring for router"
18157 .cindex "router" "requiring file existence"
18158 This option provides a general mechanism for predicating the running of a
18159 router on the existence or non-existence of certain files or directories.
18160 Before running a router, as one of its precondition tests, Exim works its way
18161 through the &%require_files%& list, expanding each item separately.
18162
18163 Because the list is split before expansion, any colons in expansion items must
18164 be doubled, or the facility for using a different list separator must be used.
18165 If any expansion is forced to fail, the item is ignored. Other expansion
18166 failures cause routing of the address to be deferred.
18167
18168 If any expanded string is empty, it is ignored. Otherwise, except as described
18169 below, each string must be a fully qualified file path, optionally preceded by
18170 &"!"&. The paths are passed to the &[stat()]& function to test for the
18171 existence of the files or directories. The router is skipped if any paths not
18172 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18173
18174 .cindex "NFS"
18175 If &[stat()]& cannot determine whether a file exists or not, delivery of
18176 the message is deferred. This can happen when NFS-mounted filesystems are
18177 unavailable.
18178
18179 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18180 options, so you cannot use it to check for the existence of a file in which to
18181 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18182 full list of the order in which preconditions are evaluated.) However, as
18183 these options are all expanded, you can use the &%exists%& expansion condition
18184 to make such tests. The &%require_files%& option is intended for checking files
18185 that the router may be going to use internally, or which are needed by a
18186 transport (for example &_.procmailrc_&).
18187
18188 During delivery, the &[stat()]& function is run as root, but there is a
18189 facility for some checking of the accessibility of a file by another user.
18190 This is not a proper permissions check, but just a &"rough"& check that
18191 operates as follows:
18192
18193 If an item in a &%require_files%& list does not contain any forward slash
18194 characters, it is taken to be the user (and optional group, separated by a
18195 comma) to be checked for subsequent files in the list. If no group is specified
18196 but the user is specified symbolically, the gid associated with the uid is
18197 used. For example:
18198 .code
18199 require_files = mail:/some/file
18200 require_files = $local_part:$home/.procmailrc
18201 .endd
18202 If a user or group name in a &%require_files%& list does not exist, the
18203 &%require_files%& condition fails.
18204
18205 Exim performs the check by scanning along the components of the file path, and
18206 checking the access for the given uid and gid. It checks for &"x"& access on
18207 directories, and &"r"& access on the final file. Note that this means that file
18208 access control lists, if the operating system has them, are ignored.
18209
18210 &*Warning 1*&: When the router is being run to verify addresses for an
18211 incoming SMTP message, Exim is not running as root, but under its own uid. This
18212 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18213 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18214 user is not permitted to read one of the directories on the file's path.
18215
18216 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18217 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18218 without root access. In this case, if a check for access by a particular user
18219 is requested, Exim creates a subprocess that runs as that user, and tries the
18220 check again in that process.
18221
18222 The default action for handling an unresolved EACCES is to consider it to
18223 be caused by a configuration error, and routing is deferred because the
18224 existence or non-existence of the file cannot be determined. However, in some
18225 circumstances it may be desirable to treat this condition as if the file did
18226 not exist. If the file name (or the exclamation mark that precedes the file
18227 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18228 as if the file did not exist. For example:
18229 .code
18230 require_files = +/some/file
18231 .endd
18232 If the router is not an essential part of verification (for example, it
18233 handles users' &_.forward_& files), another solution is to set the &%verify%&
18234 option false so that the router is skipped when verifying.
18235
18236
18237
18238 .option retry_use_local_part routers boolean "see below"
18239 .cindex "hints database" "retry keys"
18240 .cindex "local part" "in retry keys"
18241 When a delivery suffers a temporary routing failure, a retry record is created
18242 in Exim's hints database. For addresses whose routing depends only on the
18243 domain, the key for the retry record should not involve the local part, but for
18244 other addresses, both the domain and the local part should be included.
18245 Usually, remote routing is of the former kind, and local routing is of the
18246 latter kind.
18247
18248 This option controls whether the local part is used to form the key for retry
18249 hints for addresses that suffer temporary errors while being handled by this
18250 router. The default value is true for any router that has &%check_local_user%&
18251 set, and false otherwise. Note that this option does not apply to hints keys
18252 for transport delays; they are controlled by a generic transport option of the
18253 same name.
18254
18255 The setting of &%retry_use_local_part%& applies only to the router on which it
18256 appears. If the router generates child addresses, they are routed
18257 independently; this setting does not become attached to them.
18258
18259
18260
18261 .option router_home_directory routers string&!! unset
18262 .cindex "router" "home directory for"
18263 .cindex "home directory" "for router"
18264 .vindex "&$home$&"
18265 This option sets a home directory for use while the router is running. (Compare
18266 &%transport_home_directory%&, which sets a home directory for later
18267 transporting.) In particular, if used on a &(redirect)& router, this option
18268 sets a value for &$home$& while a filter is running. The value is expanded;
18269 forced expansion failure causes the option to be ignored &-- other failures
18270 cause the router to defer.
18271
18272 Expansion of &%router_home_directory%& happens immediately after the
18273 &%check_local_user%& test (if configured), before any further expansions take
18274 place.
18275 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18276 are evaluated.)
18277 While the router is running, &%router_home_directory%& overrides the value of
18278 &$home$& that came from &%check_local_user%&.
18279
18280 When a router accepts an address and assigns it to a local transport (including
18281 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18282 delivery), the home directory setting for the transport is taken from the first
18283 of these values that is set:
18284
18285 .ilist
18286 The &%home_directory%& option on the transport;
18287 .next
18288 The &%transport_home_directory%& option on the router;
18289 .next
18290 The password data if &%check_local_user%& is set on the router;
18291 .next
18292 The &%router_home_directory%& option on the router.
18293 .endlist
18294
18295 In other words, &%router_home_directory%& overrides the password data for the
18296 router, but not for the transport.
18297
18298
18299
18300 .option self routers string freeze
18301 .cindex "MX record" "pointing to local host"
18302 .cindex "local host" "MX pointing to"
18303 This option applies to those routers that use a recipient address to find a
18304 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18305 and &(manualroute)& routers.
18306 Certain configurations of the &(queryprogram)& router can also specify a list
18307 of remote hosts.
18308 Usually such routers are configured to send the message to a remote host via an
18309 &(smtp)& transport. The &%self%& option specifies what happens when the first
18310 host on the list turns out to be the local host.
18311 The way in which Exim checks for the local host is described in section
18312 &<<SECTreclocipadd>>&.
18313
18314 Normally this situation indicates either an error in Exim's configuration (for
18315 example, the router should be configured not to process this domain), or an
18316 error in the DNS (for example, the MX should not point to this host). For this
18317 reason, the default action is to log the incident, defer the address, and
18318 freeze the message. The following alternatives are provided for use in special
18319 cases:
18320
18321 .vlist
18322 .vitem &%defer%&
18323 Delivery of the message is tried again later, but the message is not frozen.
18324
18325 .vitem "&%reroute%&: <&'domain'&>"
18326 The domain is changed to the given domain, and the address is passed back to
18327 be reprocessed by the routers. No rewriting of headers takes place. This
18328 behaviour is essentially a redirection.
18329
18330 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18331 The domain is changed to the given domain, and the address is passed back to be
18332 reprocessed by the routers. Any headers that contain the original domain are
18333 rewritten.
18334
18335 .vitem &%pass%&
18336 .oindex "&%more%&"
18337 .vindex "&$self_hostname$&"
18338 The router passes the address to the next router, or to the router named in the
18339 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18340 subsequent routing and delivery, the variable &$self_hostname$& contains the
18341 name of the local host that the router encountered. This can be used to
18342 distinguish between different cases for hosts with multiple names. The
18343 combination
18344 .code
18345 self = pass
18346 no_more
18347 .endd
18348 ensures that only those addresses that routed to the local host are passed on.
18349 Without &%no_more%&, addresses that were declined for other reasons would also
18350 be passed to the next router.
18351
18352 .vitem &%fail%&
18353 Delivery fails and an error report is generated.
18354
18355 .vitem &%send%&
18356 .cindex "local host" "sending to"
18357 The anomaly is ignored and the address is queued for the transport. This
18358 setting should be used with extreme caution. For an &(smtp)& transport, it
18359 makes sense only in cases where the program that is listening on the SMTP port
18360 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18361 different configuration file that handles the domain in another way.
18362 .endlist
18363
18364
18365
18366 .option senders routers&!? "address list&!!" unset
18367 .cindex "router" "checking senders"
18368 If this option is set, the router is skipped unless the message's sender
18369 address matches something on the list.
18370 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18371 are evaluated.
18372
18373 There are issues concerning verification when the running of routers is
18374 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18375 setting, it sets the sender to the null string. When using the &%-bt%& option
18376 to check a configuration file, it is necessary also to use the &%-f%& option to
18377 set an appropriate sender. For incoming mail, the sender is unset when
18378 verifying the sender, but is available when verifying any recipients. If the
18379 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18380 matters.
18381
18382
18383 .option translate_ip_address routers string&!! unset
18384 .cindex "IP address" "translating"
18385 .cindex "packet radio"
18386 .cindex "router" "IP address translation"
18387 There exist some rare networking situations (for example, packet radio) where
18388 it is helpful to be able to translate IP addresses generated by normal routing
18389 mechanisms into other IP addresses, thus performing a kind of manual IP
18390 routing. This should be done only if the normal IP routing of the TCP/IP stack
18391 is inadequate or broken. Because this is an extremely uncommon requirement, the
18392 code to support this option is not included in the Exim binary unless
18393 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18394
18395 .vindex "&$host_address$&"
18396 The &%translate_ip_address%& string is expanded for every IP address generated
18397 by the router, with the generated address set in &$host_address$&. If the
18398 expansion is forced to fail, no action is taken.
18399 For any other expansion error, delivery of the message is deferred.
18400 If the result of the expansion is an IP address, that replaces the original
18401 address; otherwise the result is assumed to be a host name &-- this is looked
18402 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18403 produce one or more replacement IP addresses. For example, to subvert all IP
18404 addresses in some specific networks, this could be added to a router:
18405 .code
18406 translate_ip_address = \
18407   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18408     {$value}fail}}
18409 .endd
18410 The file would contain lines like
18411 .code
18412 10.2.3.128/26    some.host
18413 10.8.4.34/26     10.44.8.15
18414 .endd
18415 You should not make use of this facility unless you really understand what you
18416 are doing.
18417
18418
18419
18420 .option transport routers string&!! unset
18421 This option specifies the transport to be used when a router accepts an address
18422 and sets it up for delivery. A transport is never needed if a router is used
18423 only for verification. The value of the option is expanded at routing time,
18424 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18425 and result must be the name of one of the configured transports. If it is not,
18426 delivery is deferred.
18427
18428 The &%transport%& option is not used by the &(redirect)& router, but it does
18429 have some private options that set up transports for pipe and file deliveries
18430 (see chapter &<<CHAPredirect>>&).
18431
18432
18433
18434 .option transport_current_directory routers string&!! unset
18435 .cindex "current directory for local transport"
18436 This option associates a current directory with any address that is routed
18437 to a local transport. This can happen either because a transport is
18438 explicitly configured for the router, or because it generates a delivery to a
18439 file or a pipe. During the delivery process (that is, at transport time), this
18440 option string is expanded and is set as the current directory, unless
18441 overridden by a setting on the transport.
18442 If the expansion fails for any reason, including forced failure, an error is
18443 logged, and delivery is deferred.
18444 See chapter &<<CHAPenvironment>>& for details of the local delivery
18445 environment.
18446
18447
18448
18449
18450 .option transport_home_directory routers string&!! "see below"
18451 .cindex "home directory" "for local transport"
18452 This option associates a home directory with any address that is routed to a
18453 local transport. This can happen either because a transport is explicitly
18454 configured for the router, or because it generates a delivery to a file or a
18455 pipe. During the delivery process (that is, at transport time), the option
18456 string is expanded and is set as the home directory, unless overridden by a
18457 setting of &%home_directory%& on the transport.
18458 If the expansion fails for any reason, including forced failure, an error is
18459 logged, and delivery is deferred.
18460
18461 If the transport does not specify a home directory, and
18462 &%transport_home_directory%& is not set for the router, the home directory for
18463 the transport is taken from the password data if &%check_local_user%& is set for
18464 the router. Otherwise it is taken from &%router_home_directory%& if that option
18465 is set; if not, no home directory is set for the transport.
18466
18467 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18468 environment.
18469
18470
18471
18472
18473 .option unseen routers boolean&!! false
18474 .cindex "router" "carrying on after success"
18475 The result of string expansion for this option must be a valid boolean value,
18476 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18477 result causes an error, and delivery is deferred. If the expansion is forced to
18478 fail, the default value for the option (false) is used. Other failures cause
18479 delivery to be deferred.
18480
18481 When this option is set true, routing does not cease if the router accepts the
18482 address. Instead, a copy of the incoming address is passed to the next router,
18483 overriding a false setting of &%more%&. There is little point in setting
18484 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18485 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18486 sometimes true and sometimes false).
18487
18488 .cindex "copy of message (&%unseen%& option)"
18489 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18490 qualifier in filter files. It can be used to cause copies of messages to be
18491 delivered to some other destination, while also carrying out a normal delivery.
18492 In effect, the current address is made into a &"parent"& that has two children
18493 &-- one that is delivered as specified by this router, and a clone that goes on
18494 to be routed further. For this reason, &%unseen%& may not be combined with the
18495 &%one_time%& option in a &(redirect)& router.
18496
18497 &*Warning*&: Header lines added to the address (or specified for removal) by
18498 this router or by previous routers affect the &"unseen"& copy of the message
18499 only. The clone that continues to be processed by further routers starts with
18500 no added headers and none specified for removal. For a &%redirect%& router, if
18501 a generated address is the same as the incoming address, this can lead to
18502 duplicate addresses with different header modifications. Exim does not do
18503 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18504 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18505 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18506 &%redirect%& router may be of help.
18507
18508 Unlike the handling of header modifications, any data that was set by the
18509 &%address_data%& option in the current or previous routers &'is'& passed on to
18510 subsequent routers.
18511
18512
18513 .option user routers string&!! "see below"
18514 .cindex "uid (user id)" "local delivery"
18515 .cindex "local transports" "uid and gid"
18516 .cindex "transport" "local"
18517 .cindex "router" "user for filter processing"
18518 .cindex "filter" "user for processing"
18519 When a router queues an address for a transport, and the transport does not
18520 specify a user, the user given here is used when running the delivery process.
18521 The user may be specified numerically or by name. If expansion fails, the
18522 error is logged and delivery is deferred.
18523 This user is also used by the &(redirect)& router when running a filter file.
18524 The default is unset, except when &%check_local_user%& is set. In this case,
18525 the default is taken from the password information. If the user is specified as
18526 a name, and &%group%& is not set, the group associated with the user is used.
18527 See also &%initgroups%& and &%group%& and the discussion in chapter
18528 &<<CHAPenvironment>>&.
18529
18530
18531
18532 .option verify routers&!? boolean true
18533 Setting this option has the effect of setting &%verify_sender%& and
18534 &%verify_recipient%& to the same value.
18535
18536
18537 .option verify_only routers&!? boolean false
18538 .cindex "EXPN" "with &%verify_only%&"
18539 .oindex "&%-bv%&"
18540 .cindex "router" "used only when verifying"
18541 If this option is set, the router is used only when verifying an address,
18542 delivering in cutthrough mode or
18543 testing with the &%-bv%& option, not when actually doing a delivery, testing
18544 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18545 restricted to verifying only senders or recipients by means of
18546 &%verify_sender%& and &%verify_recipient%&.
18547
18548 &*Warning*&: When the router is being run to verify addresses for an incoming
18549 SMTP message, Exim is not running as root, but under its own uid. If the router
18550 accesses any files, you need to make sure that they are accessible to the Exim
18551 user or group.
18552
18553
18554 .option verify_recipient routers&!? boolean true
18555 If this option is false, the router is skipped when verifying recipient
18556 addresses,
18557 delivering in cutthrough mode
18558 or testing recipient verification using &%-bv%&.
18559 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18560 are evaluated.
18561 See also the &$verify_mode$& variable.
18562
18563
18564 .option verify_sender routers&!? boolean true
18565 If this option is false, the router is skipped when verifying sender addresses
18566 or testing sender verification using &%-bvs%&.
18567 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18568 are evaluated.
18569 See also the &$verify_mode$& variable.
18570 .ecindex IIDgenoprou1
18571 .ecindex IIDgenoprou2
18572
18573
18574
18575
18576
18577
18578 . ////////////////////////////////////////////////////////////////////////////
18579 . ////////////////////////////////////////////////////////////////////////////
18580
18581 .chapter "The accept router" "CHID4"
18582 .cindex "&(accept)& router"
18583 .cindex "routers" "&(accept)&"
18584 The &(accept)& router has no private options of its own. Unless it is being
18585 used purely for verification (see &%verify_only%&) a transport is required to
18586 be defined by the generic &%transport%& option. If the preconditions that are
18587 specified by generic options are met, the router accepts the address and queues
18588 it for the given transport. The most common use of this router is for setting
18589 up deliveries to local mailboxes. For example:
18590 .code
18591 localusers:
18592   driver = accept
18593   domains = mydomain.example
18594   check_local_user
18595   transport = local_delivery
18596 .endd
18597 The &%domains%& condition in this example checks the domain of the address, and
18598 &%check_local_user%& checks that the local part is the login of a local user.
18599 When both preconditions are met, the &(accept)& router runs, and queues the
18600 address for the &(local_delivery)& transport.
18601
18602
18603
18604
18605
18606
18607 . ////////////////////////////////////////////////////////////////////////////
18608 . ////////////////////////////////////////////////////////////////////////////
18609
18610 .chapter "The dnslookup router" "CHAPdnslookup"
18611 .scindex IIDdnsrou1 "&(dnslookup)& router"
18612 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18613 The &(dnslookup)& router looks up the hosts that handle mail for the
18614 recipient's domain in the DNS. A transport must always be set for this router,
18615 unless &%verify_only%& is set.
18616
18617 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18618 SRV records. If none are found, or if SRV support is not configured,
18619 MX records are looked up. If no MX records exist, address records are sought.
18620 However, &%mx_domains%& can be set to disable the direct use of address
18621 records.
18622
18623 MX records of equal priority are sorted by Exim into a random order. Exim then
18624 looks for address records for the host names obtained from MX or SRV records.
18625 When a host has more than one IP address, they are sorted into a random order,
18626 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18627 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18628 generic option, the router declines.
18629
18630 Unless they have the highest priority (lowest MX value), MX records that point
18631 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18632 are discarded, together with any other MX records of equal or lower priority.
18633
18634 .cindex "MX record" "pointing to local host"
18635 .cindex "local host" "MX pointing to"
18636 .oindex "&%self%&" "in &(dnslookup)& router"
18637 If the host pointed to by the highest priority MX record, or looked up as an
18638 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18639 happens is controlled by the generic &%self%& option.
18640
18641
18642 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18643 There have been problems with DNS servers when SRV records are looked up.
18644 Some misbehaving servers return a DNS error or timeout when a non-existent
18645 SRV record is sought. Similar problems have in the past been reported for
18646 MX records. The global &%dns_again_means_nonexist%& option can help with this
18647 problem, but it is heavy-handed because it is a global option.
18648
18649 For this reason, there are two options, &%srv_fail_domains%& and
18650 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18651 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18652 an attempt to look up an SRV or MX record causes one of these results, and the
18653 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18654 such record"&. In the case of an SRV lookup, this means that the router
18655 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18656 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18657 case routing fails.
18658
18659
18660 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18661 .cindex "&(dnslookup)& router" "declines"
18662 There are a few cases where a &(dnslookup)& router will decline to accept
18663 an address; if such a router is expected to handle "all remaining non-local
18664 domains", then it is important to set &%no_more%&.
18665
18666 The router will defer rather than decline if the domain
18667 is found in the &%fail_defer_domains%& router option.
18668
18669 Reasons for a &(dnslookup)& router to decline currently include:
18670 .ilist
18671 The domain does not exist in DNS
18672 .next
18673 The domain exists but the MX record's host part is just "."; this is a common
18674 convention (borrowed from SRV) used to indicate that there is no such service
18675 for this domain and to not fall back to trying A/AAAA records.
18676 .next
18677 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18678 .next
18679 MX record points to a non-existent host.
18680 .next
18681 MX record points to an IP address and the main section option
18682 &%allow_mx_to_ip%& is not set.
18683 .next
18684 MX records exist and point to valid hosts, but all hosts resolve only to
18685 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18686 .next
18687 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18688 &%dns_check_names_pattern%& for handling one variant of this)
18689 .next
18690 &%check_secondary_mx%& is set on this router but the local host can
18691 not be found in the MX records (see below)
18692 .endlist
18693
18694
18695
18696
18697 .section "Private options for dnslookup" "SECID118"
18698 .cindex "options" "&(dnslookup)& router"
18699 The private options for the &(dnslookup)& router are as follows:
18700
18701 .option check_secondary_mx dnslookup boolean false
18702 .cindex "MX record" "checking for secondary"
18703 If this option is set, the router declines unless the local host is found in
18704 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18705 process domains for which the local host is a secondary mail exchanger
18706 differently to other domains. The way in which Exim decides whether a host is
18707 the local host is described in section &<<SECTreclocipadd>>&.
18708
18709
18710 .option check_srv dnslookup string&!! unset
18711 .cindex "SRV record" "enabling use of"
18712 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18713 addition to MX and address records. The support is disabled by default. To
18714 enable SRV support, set the &%check_srv%& option to the name of the service
18715 required. For example,
18716 .code
18717 check_srv = smtp
18718 .endd
18719 looks for SRV records that refer to the normal smtp service. The option is
18720 expanded, so the service name can vary from message to message or address
18721 to address. This might be helpful if SRV records are being used for a
18722 submission service. If the expansion is forced to fail, the &%check_srv%&
18723 option is ignored, and the router proceeds to look for MX records in the
18724 normal way.
18725
18726 When the expansion succeeds, the router searches first for SRV records for
18727 the given service (it assumes TCP protocol). A single SRV record with a
18728 host name that consists of just a single dot indicates &"no such service for
18729 this domain"&; if this is encountered, the router declines. If other kinds of
18730 SRV record are found, they are used to construct a host list for delivery
18731 according to the rules of RFC 2782. MX records are not sought in this case.
18732
18733 When no SRV records are found, MX records (and address records) are sought in
18734 the traditional way. In other words, SRV records take precedence over MX
18735 records, just as MX records take precedence over address records. Note that
18736 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18737 defined it. It is apparently believed that MX records are sufficient for email
18738 and that SRV records should not be used for this purpose. However, SRV records
18739 have an additional &"weight"& feature which some people might find useful when
18740 trying to split an SMTP load between hosts of different power.
18741
18742 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18743 when there is a DNS lookup error.
18744
18745
18746
18747
18748 .option fail_defer_domains dnslookup "domain list&!!" unset
18749 .cindex "MX record" "not found"
18750 DNS lookups for domains matching &%fail_defer_domains%&
18751 which find no matching record will cause the router to defer
18752 rather than the default behaviour of decline.
18753 This maybe be useful for queueing messages for a newly created
18754 domain while the DNS configuration is not ready.
18755 However, it will result in any message with mistyped domains
18756 also being queued.
18757
18758
18759 .option mx_domains dnslookup "domain list&!!" unset
18760 .cindex "MX record" "required to exist"
18761 .cindex "SRV record" "required to exist"
18762 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18763 record in order to be recognized. (The name of this option could be improved.)
18764 For example, if all the mail hosts in &'fict.example'& are known to have MX
18765 records, except for those in &'discworld.fict.example'&, you could use this
18766 setting:
18767 .code
18768 mx_domains = ! *.discworld.fict.example : *.fict.example
18769 .endd
18770 This specifies that messages addressed to a domain that matches the list but
18771 has no MX record should be bounced immediately instead of being routed using
18772 the address record.
18773
18774
18775 .option mx_fail_domains dnslookup "domain list&!!" unset
18776 If the DNS lookup for MX records for one of the domains in this list causes a
18777 DNS lookup error, Exim behaves as if no MX records were found. See section
18778 &<<SECTprowitdnsloo>>& for more discussion.
18779
18780
18781
18782
18783 .option qualify_single dnslookup boolean true
18784 .cindex "DNS" "resolver options"
18785 .cindex "DNS" "qualifying single-component names"
18786 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18787 lookups. Typically, but not standardly, this causes the resolver to qualify
18788 single-component names with the default domain. For example, on a machine
18789 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18790 &'thesaurus.ref.example'& inside the resolver. For details of what your
18791 resolver actually does, consult your man pages for &'resolver'& and
18792 &'resolv.conf'&.
18793
18794
18795
18796 .option rewrite_headers dnslookup boolean true
18797 .cindex "rewriting" "header lines"
18798 .cindex "header lines" "rewriting"
18799 If the domain name in the address that is being processed is not fully
18800 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18801 an address is specified as &'dormouse@teaparty'&, the domain might be
18802 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18803 occur as a result of setting the &%widen_domains%& option. If
18804 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18805 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18806 header lines of the message are rewritten with the full domain name.
18807
18808 This option should be turned off only when it is known that no message is
18809 ever going to be sent outside an environment where the abbreviation makes
18810 sense.
18811
18812 When an MX record is looked up in the DNS and matches a wildcard record, name
18813 servers normally return a record containing the name that has been looked up,
18814 making it impossible to detect whether a wildcard was present or not. However,
18815 some name servers have recently been seen to return the wildcard entry. If the
18816 name returned by a DNS lookup begins with an asterisk, it is not used for
18817 header rewriting.
18818
18819
18820 .option same_domain_copy_routing dnslookup boolean false
18821 .cindex "address" "copying routing"
18822 Addresses with the same domain are normally routed by the &(dnslookup)& router
18823 to the same list of hosts. However, this cannot be presumed, because the router
18824 options and preconditions may refer to the local part of the address. By
18825 default, therefore, Exim routes each address in a message independently. DNS
18826 servers run caches, so repeated DNS lookups are not normally expensive, and in
18827 any case, personal messages rarely have more than a few recipients.
18828
18829 If you are running mailing lists with large numbers of subscribers at the same
18830 domain, and you are using a &(dnslookup)& router which is independent of the
18831 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18832 lookups for identical domains in one message. In this case, when &(dnslookup)&
18833 routes an address to a remote transport, any other unrouted addresses in the
18834 message that have the same domain are automatically given the same routing
18835 without processing them independently,
18836 provided the following conditions are met:
18837
18838 .ilist
18839 No router that processed the address specified &%headers_add%& or
18840 &%headers_remove%&.
18841 .next
18842 The router did not change the address in any way, for example, by &"widening"&
18843 the domain.
18844 .endlist
18845
18846
18847
18848
18849 .option search_parents dnslookup boolean false
18850 .cindex "DNS" "resolver options"
18851 When this option is true, the resolver option RES_DNSRCH is set for DNS
18852 lookups. This is different from the &%qualify_single%& option in that it
18853 applies to domains containing dots. Typically, but not standardly, it causes
18854 the resolver to search for the name in the current domain and in parent
18855 domains. For example, on a machine in the &'fict.example'& domain, if looking
18856 up &'teaparty.wonderland'& failed, the resolver would try
18857 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18858 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18859
18860 Setting this option true can cause problems in domains that have a wildcard MX
18861 record, because any domain that does not have its own MX record matches the
18862 local wildcard.
18863
18864
18865
18866 .option srv_fail_domains dnslookup "domain list&!!" unset
18867 If the DNS lookup for SRV records for one of the domains in this list causes a
18868 DNS lookup error, Exim behaves as if no SRV records were found. See section
18869 &<<SECTprowitdnsloo>>& for more discussion.
18870
18871
18872
18873
18874 .option widen_domains dnslookup "string list" unset
18875 .cindex "domain" "partial; widening"
18876 If a DNS lookup fails and this option is set, each of its strings in turn is
18877 added onto the end of the domain, and the lookup is tried again. For example,
18878 if
18879 .code
18880 widen_domains = fict.example:ref.example
18881 .endd
18882 is set and a lookup of &'klingon.dictionary'& fails,
18883 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18884 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18885 and &%search_parents%& options can cause some widening to be undertaken inside
18886 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18887 when verifying, unless &%rewrite_headers%& is false (not the default).
18888
18889
18890 .section "Effect of qualify_single and search_parents" "SECID119"
18891 When a domain from an envelope recipient is changed by the resolver as a result
18892 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18893 corresponding address in the message's header lines unless &%rewrite_headers%&
18894 is set false. Exim then re-routes the address, using the full domain.
18895
18896 These two options affect only the DNS lookup that takes place inside the router
18897 for the domain of the address that is being routed. They do not affect lookups
18898 such as that implied by
18899 .code
18900 domains = @mx_any
18901 .endd
18902 that may happen while processing a router precondition before the router is
18903 entered. No widening ever takes place for these lookups.
18904 .ecindex IIDdnsrou1
18905 .ecindex IIDdnsrou2
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915 . ////////////////////////////////////////////////////////////////////////////
18916 . ////////////////////////////////////////////////////////////////////////////
18917
18918 .chapter "The ipliteral router" "CHID5"
18919 .cindex "&(ipliteral)& router"
18920 .cindex "domain literal" "routing"
18921 .cindex "routers" "&(ipliteral)&"
18922 This router has no private options. Unless it is being used purely for
18923 verification (see &%verify_only%&) a transport is required to be defined by the
18924 generic &%transport%& option. The router accepts the address if its domain part
18925 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18926 router handles the address
18927 .code
18928 root@[192.168.1.1]
18929 .endd
18930 by setting up delivery to the host with that IP address. IPv4 domain literals
18931 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18932 are similar, but the address is preceded by &`ipv6:`&. For example:
18933 .code
18934 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18935 .endd
18936 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18937 grounds that sooner or later somebody will try it.
18938
18939 .oindex "&%self%&" "in &(ipliteral)& router"
18940 If the IP address matches something in &%ignore_target_hosts%&, the router
18941 declines. If an IP literal turns out to refer to the local host, the generic
18942 &%self%& option determines what happens.
18943
18944 The RFCs require support for domain literals; however, their use is
18945 controversial in today's Internet. If you want to use this router, you must
18946 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18947 Exim will not recognize the domain literal syntax in addresses.
18948
18949
18950
18951 . ////////////////////////////////////////////////////////////////////////////
18952 . ////////////////////////////////////////////////////////////////////////////
18953
18954 .chapter "The iplookup router" "CHID6"
18955 .cindex "&(iplookup)& router"
18956 .cindex "routers" "&(iplookup)&"
18957 The &(iplookup)& router was written to fulfil a specific requirement in
18958 Cambridge University (which in fact no longer exists). For this reason, it is
18959 not included in the binary of Exim by default. If you want to include it, you
18960 must set
18961 .code
18962 ROUTER_IPLOOKUP=yes
18963 .endd
18964 in your &_Local/Makefile_& configuration file.
18965
18966 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18967 connection to one or more specific hosts. The host can then return the same or
18968 a different address &-- in effect rewriting the recipient address in the
18969 message's envelope. The new address is then passed on to subsequent routers. If
18970 this process fails, the address can be passed on to other routers, or delivery
18971 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18972 must not be specified for it.
18973
18974 .cindex "options" "&(iplookup)& router"
18975 .option hosts iplookup string unset
18976 This option must be supplied. Its value is a colon-separated list of host
18977 names. The hosts are looked up using &[gethostbyname()]&
18978 (or &[getipnodebyname()]& when available)
18979 and are tried in order until one responds to the query. If none respond, what
18980 happens is controlled by &%optional%&.
18981
18982
18983 .option optional iplookup boolean false
18984 If &%optional%& is true, if no response is obtained from any host, the address
18985 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18986 delivery to the address is deferred.
18987
18988
18989 .option port iplookup integer 0
18990 .cindex "port" "&(iplookup)& router"
18991 This option must be supplied. It specifies the port number for the TCP or UDP
18992 call.
18993
18994
18995 .option protocol iplookup string udp
18996 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18997 protocols is to be used.
18998
18999
19000 .option query iplookup string&!! "see below"
19001 This defines the content of the query that is sent to the remote hosts. The
19002 default value is:
19003 .code
19004 $local_part@$domain $local_part@$domain
19005 .endd
19006 The repetition serves as a way of checking that a response is to the correct
19007 query in the default case (see &%response_pattern%& below).
19008
19009
19010 .option reroute iplookup string&!! unset
19011 If this option is not set, the rerouted address is precisely the byte string
19012 returned by the remote host, up to the first white space, if any. If set, the
19013 string is expanded to form the rerouted address. It can include parts matched
19014 in the response by &%response_pattern%& by means of numeric variables such as
19015 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19016 whether or not a pattern is in use. In all cases, the rerouted address must end
19017 up in the form &'local_part@domain'&.
19018
19019
19020 .option response_pattern iplookup string unset
19021 This option can be set to a regular expression that is applied to the string
19022 returned from the remote host. If the pattern does not match the response, the
19023 router declines. If &%response_pattern%& is not set, no checking of the
19024 response is done, unless the query was defaulted, in which case there is a
19025 check that the text returned after the first white space is the original
19026 address. This checks that the answer that has been received is in response to
19027 the correct question. For example, if the response is just a new domain, the
19028 following could be used:
19029 .code
19030 response_pattern = ^([^@]+)$
19031 reroute = $local_part@$1
19032 .endd
19033
19034 .option timeout iplookup time 5s
19035 This specifies the amount of time to wait for a response from the remote
19036 machine. The same timeout is used for the &[connect()]& function for a TCP
19037 call. It does not apply to UDP.
19038
19039
19040
19041
19042 . ////////////////////////////////////////////////////////////////////////////
19043 . ////////////////////////////////////////////////////////////////////////////
19044
19045 .chapter "The manualroute router" "CHID7"
19046 .scindex IIDmanrou1 "&(manualroute)& router"
19047 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19048 .cindex "domain" "manually routing"
19049 The &(manualroute)& router is so-called because it provides a way of manually
19050 routing an address according to its domain. It is mainly used when you want to
19051 route addresses to remote hosts according to your own rules, bypassing the
19052 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19053 route to local transports, a facility that may be useful if you want to save
19054 messages for dial-in hosts in local files.
19055
19056 The &(manualroute)& router compares a list of domain patterns with the domain
19057 it is trying to route. If there is no match, the router declines. Each pattern
19058 has associated with it a list of hosts and some other optional data, which may
19059 include a transport. The combination of a pattern and its data is called a
19060 &"routing rule"&. For patterns that do not have an associated transport, the
19061 generic &%transport%& option must specify a transport, unless the router is
19062 being used purely for verification (see &%verify_only%&).
19063
19064 .vindex "&$host$&"
19065 In the case of verification, matching the domain pattern is sufficient for the
19066 router to accept the address. When actually routing an address for delivery,
19067 an address that matches a domain pattern is queued for the associated
19068 transport. If the transport is not a local one, a host list must be associated
19069 with the pattern; IP addresses are looked up for the hosts, and these are
19070 passed to the transport along with the mail address. For local transports, a
19071 host list is optional. If it is present, it is passed in &$host$& as a single
19072 text string.
19073
19074 The list of routing rules can be provided as an inline string in
19075 &%route_list%&, or the data can be obtained by looking up the domain in a file
19076 or database by setting &%route_data%&. Only one of these settings may appear in
19077 any one instance of &(manualroute)&. The format of routing rules is described
19078 below, following the list of private options.
19079
19080
19081 .section "Private options for manualroute" "SECTprioptman"
19082
19083 .cindex "options" "&(manualroute)& router"
19084 The private options for the &(manualroute)& router are as follows:
19085
19086 .option host_all_ignored manualroute string defer
19087 See &%host_find_failed%&.
19088
19089 .option host_find_failed manualroute string freeze
19090 This option controls what happens when &(manualroute)& tries to find an IP
19091 address for a host, and the host does not exist. The option can be set to one
19092 of the following values:
19093 .code
19094 decline
19095 defer
19096 fail
19097 freeze
19098 ignore
19099 pass
19100 .endd
19101 The default (&"freeze"&) assumes that this state is a serious configuration
19102 error. The difference between &"pass"& and &"decline"& is that the former
19103 forces the address to be passed to the next router (or the router defined by
19104 &%pass_router%&),
19105 .oindex "&%more%&"
19106 overriding &%no_more%&, whereas the latter passes the address to the next
19107 router only if &%more%& is true.
19108
19109 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19110 cannot be found. If all the hosts in the list are ignored, the behaviour is
19111 controlled by the &%host_all_ignored%& option. This takes the same values
19112 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19113
19114 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19115 state; if a host lookup gets a temporary error, delivery is deferred unless the
19116 generic &%pass_on_timeout%& option is set.
19117
19118
19119 .option hosts_randomize manualroute boolean false
19120 .cindex "randomized host list"
19121 .cindex "host" "list of; randomized"
19122 If this option is set, the order of the items in a host list in a routing rule
19123 is randomized each time the list is used, unless an option in the routing rule
19124 overrides (see below). Randomizing the order of a host list can be used to do
19125 crude load sharing. However, if more than one mail address is routed by the
19126 same router to the same host list, the host lists are considered to be the same
19127 (even though they may be randomized into different orders) for the purpose of
19128 deciding whether to batch the deliveries into a single SMTP transaction.
19129
19130 When &%hosts_randomize%& is true, a host list may be split
19131 into groups whose order is separately randomized. This makes it possible to
19132 set up MX-like behaviour. The boundaries between groups are indicated by an
19133 item that is just &`+`& in the host list. For example:
19134 .code
19135 route_list = * host1:host2:host3:+:host4:host5
19136 .endd
19137 The order of the first three hosts and the order of the last two hosts is
19138 randomized for each use, but the first three always end up before the last two.
19139 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19140 randomized host list is passed to an &(smtp)& transport that also has
19141 &%hosts_randomize set%&, the list is not re-randomized.
19142
19143
19144 .option route_data manualroute string&!! unset
19145 If this option is set, it must expand to yield the data part of a routing rule.
19146 Typically, the expansion string includes a lookup based on the domain. For
19147 example:
19148 .code
19149 route_data = ${lookup{$domain}dbm{/etc/routes}}
19150 .endd
19151 If the expansion is forced to fail, or the result is an empty string, the
19152 router declines. Other kinds of expansion failure cause delivery to be
19153 deferred.
19154
19155
19156 .option route_list manualroute "string list" unset
19157 This string is a list of routing rules, in the form defined below. Note that,
19158 unlike most string lists, the items are separated by semicolons. This is so
19159 that they may contain colon-separated host lists.
19160
19161
19162 .option same_domain_copy_routing manualroute boolean false
19163 .cindex "address" "copying routing"
19164 Addresses with the same domain are normally routed by the &(manualroute)&
19165 router to the same list of hosts. However, this cannot be presumed, because the
19166 router options and preconditions may refer to the local part of the address. By
19167 default, therefore, Exim routes each address in a message independently. DNS
19168 servers run caches, so repeated DNS lookups are not normally expensive, and in
19169 any case, personal messages rarely have more than a few recipients.
19170
19171 If you are running mailing lists with large numbers of subscribers at the same
19172 domain, and you are using a &(manualroute)& router which is independent of the
19173 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19174 lookups for identical domains in one message. In this case, when
19175 &(manualroute)& routes an address to a remote transport, any other unrouted
19176 addresses in the message that have the same domain are automatically given the
19177 same routing without processing them independently. However, this is only done
19178 if &%headers_add%& and &%headers_remove%& are unset.
19179
19180
19181
19182
19183 .section "Routing rules in route_list" "SECID120"
19184 The value of &%route_list%& is a string consisting of a sequence of routing
19185 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19186 entered as two semicolons. Alternatively, the list separator can be changed as
19187 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19188 Empty rules are ignored. The format of each rule is
19189 .display
19190 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19191 .endd
19192 The following example contains two rules, each with a simple domain pattern and
19193 no options:
19194 .code
19195 route_list = \
19196   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19197   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19198 .endd
19199 The three parts of a rule are separated by white space. The pattern and the
19200 list of hosts can be enclosed in quotes if necessary, and if they are, the
19201 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19202 single domain pattern, which is the only mandatory item in the rule. The
19203 pattern is in the same format as one item in a domain list (see section
19204 &<<SECTdomainlist>>&),
19205 except that it may not be the name of an interpolated file.
19206 That is, it may be wildcarded, or a regular expression, or a file or database
19207 lookup (with semicolons doubled, because of the use of semicolon as a separator
19208 in a &%route_list%&).
19209
19210 The rules in &%route_list%& are searched in order until one of the patterns
19211 matches the domain that is being routed. The list of hosts and then options are
19212 then used as described below. If there is no match, the router declines. When
19213 &%route_list%& is set, &%route_data%& must not be set.
19214
19215
19216
19217 .section "Routing rules in route_data" "SECID121"
19218 The use of &%route_list%& is convenient when there are only a small number of
19219 routing rules. For larger numbers, it is easier to use a file or database to
19220 hold the routing information, and use the &%route_data%& option instead.
19221 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19222 Most commonly, &%route_data%& is set as a string that contains an
19223 expansion lookup. For example, suppose we place two routing rules in a file
19224 like this:
19225 .code
19226 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19227 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19228 .endd
19229 This data can be accessed by setting
19230 .code
19231 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19232 .endd
19233 Failure of the lookup results in an empty string, causing the router to
19234 decline. However, you do not have to use a lookup in &%route_data%&. The only
19235 requirement is that the result of expanding the string is a list of hosts,
19236 possibly followed by options, separated by white space. The list of hosts must
19237 be enclosed in quotes if it contains white space.
19238
19239
19240
19241
19242 .section "Format of the list of hosts" "SECID122"
19243 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19244 always separately expanded before use. If the expansion fails, the router
19245 declines. The result of the expansion must be a colon-separated list of names
19246 and/or IP addresses, optionally also including ports. The format of each item
19247 in the list is described in the next section. The list separator can be changed
19248 as described in section &<<SECTlistconstruct>>&.
19249
19250 If the list of hosts was obtained from a &%route_list%& item, the following
19251 variables are set during its expansion:
19252
19253 .ilist
19254 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19255 If the domain was matched against a regular expression, the numeric variables
19256 &$1$&, &$2$&, etc. may be set. For example:
19257 .code
19258 route_list = ^domain(\d+)   host-$1.text.example
19259 .endd
19260 .next
19261 &$0$& is always set to the entire domain.
19262 .next
19263 &$1$& is also set when partial matching is done in a file lookup.
19264
19265 .next
19266 .vindex "&$value$&"
19267 If the pattern that matched the domain was a lookup item, the data that was
19268 looked up is available in the expansion variable &$value$&. For example:
19269 .code
19270 route_list = lsearch;;/some/file.routes  $value
19271 .endd
19272 .endlist
19273
19274 Note the doubling of the semicolon in the pattern that is necessary because
19275 semicolon is the default route list separator.
19276
19277
19278
19279 .section "Format of one host item" "SECTformatonehostitem"
19280 Each item in the list of hosts is either a host name or an IP address,
19281 optionally with an attached port number. When no port is given, an IP address
19282 is not enclosed in brackets. When a port is specified, it overrides the port
19283 specification on the transport. The port is separated from the name or address
19284 by a colon. This leads to some complications:
19285
19286 .ilist
19287 Because colon is the default separator for the list of hosts, either
19288 the colon that specifies a port must be doubled, or the list separator must
19289 be changed. The following two examples have the same effect:
19290 .code
19291 route_list = * "host1.tld::1225 : host2.tld::1226"
19292 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19293 .endd
19294 .next
19295 When IPv6 addresses are involved, it gets worse, because they contain
19296 colons of their own. To make this case easier, it is permitted to
19297 enclose an IP address (either v4 or v6) in square brackets if a port
19298 number follows. For example:
19299 .code
19300 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19301 .endd
19302 .endlist
19303
19304 .section "How the list of hosts is used" "SECThostshowused"
19305 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19306 the hosts is tried, in the order specified, when carrying out the SMTP
19307 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19308 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19309 transport.
19310
19311 Hosts may be listed by name or by IP address. An unadorned name in the list of
19312 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19313 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19314 records in the DNS. For example:
19315 .code
19316 route_list = *  x.y.z:p.q.r/MX:e.f.g
19317 .endd
19318 If this feature is used with a port specifier, the port must come last. For
19319 example:
19320 .code
19321 route_list = *  dom1.tld/mx::1225
19322 .endd
19323 If the &%hosts_randomize%& option is set, the order of the items in the list is
19324 randomized before any lookups are done. Exim then scans the list; for any name
19325 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19326 be an interface on the local host and the item is not the first in the list,
19327 Exim discards it and any subsequent items. If it is the first item, what
19328 happens is controlled by the
19329 .oindex "&%self%&" "in &(manualroute)& router"
19330 &%self%& option of the router.
19331
19332 A name on the list that is followed by &`/MX`& is replaced with the list of
19333 hosts obtained by looking up MX records for the name. This is always a DNS
19334 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19335 below) are not relevant here. The order of these hosts is determined by the
19336 preference values in the MX records, according to the usual rules. Because
19337 randomizing happens before the MX lookup, it does not affect the order that is
19338 defined by MX preferences.
19339
19340 If the local host is present in the sublist obtained from MX records, but is
19341 not the most preferred host in that list, it and any equally or less
19342 preferred hosts are removed before the sublist is inserted into the main list.
19343
19344 If the local host is the most preferred host in the MX list, what happens
19345 depends on where in the original list of hosts the &`/MX`& item appears. If it
19346 is not the first item (that is, there are previous hosts in the main list),
19347 Exim discards this name and any subsequent items in the main list.
19348
19349 If the MX item is first in the list of hosts, and the local host is the
19350 most preferred host, what happens is controlled by the &%self%& option of the
19351 router.
19352
19353 DNS failures when lookup up the MX records are treated in the same way as DNS
19354 failures when looking up IP addresses: &%pass_on_timeout%& and
19355 &%host_find_failed%& are used when relevant.
19356
19357 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19358 whether obtained from an MX lookup or not.
19359
19360
19361
19362 .section "How the options are used" "SECThowoptused"
19363 The options are a sequence of words; in practice no more than three are ever
19364 present. One of the words can be the name of a transport; this overrides the
19365 &%transport%& option on the router for this particular routing rule only. The
19366 other words (if present) control randomization of the list of hosts on a
19367 per-rule basis, and how the IP addresses of the hosts are to be found when
19368 routing to a remote transport. These options are as follows:
19369
19370 .ilist
19371 &%randomize%&: randomize the order of the hosts in this list, overriding the
19372 setting of &%hosts_randomize%& for this routing rule only.
19373 .next
19374 &%no_randomize%&: do not randomize the order of the hosts in this list,
19375 overriding the setting of &%hosts_randomize%& for this routing rule only.
19376 .next
19377 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19378 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19379 also look in &_/etc/hosts_& or other sources of information.
19380 .next
19381 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19382 no address records are found. If there is a temporary DNS error (such as a
19383 timeout), delivery is deferred.
19384 .endlist
19385
19386 For example:
19387 .code
19388 route_list = domain1  host1:host2:host3  randomize bydns;\
19389              domain2  host4:host5
19390 .endd
19391 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19392 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19393 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19394 or &[gethostbyname()]&, and the result of the lookup is the result of that
19395 call.
19396
19397 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19398 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19399 instead of TRY_AGAIN. That is why the default action is to try a DNS
19400 lookup first. Only if that gives a definite &"no such host"& is the local
19401 function called.
19402
19403
19404
19405 If no IP address for a host can be found, what happens is controlled by the
19406 &%host_find_failed%& option.
19407
19408 .vindex "&$host$&"
19409 When an address is routed to a local transport, IP addresses are not looked up.
19410 The host list is passed to the transport in the &$host$& variable.
19411
19412
19413
19414 .section "Manualroute examples" "SECID123"
19415 In some of the examples that follow, the presence of the &%remote_smtp%&
19416 transport, as defined in the default configuration file, is assumed:
19417
19418 .ilist
19419 .cindex "smart host" "example router"
19420 The &(manualroute)& router can be used to forward all external mail to a
19421 &'smart host'&. If you have set up, in the main part of the configuration, a
19422 named domain list that contains your local domains, for example:
19423 .code
19424 domainlist local_domains = my.domain.example
19425 .endd
19426 You can arrange for all other domains to be routed to a smart host by making
19427 your first router something like this:
19428 .code
19429 smart_route:
19430   driver = manualroute
19431   domains = !+local_domains
19432   transport = remote_smtp
19433   route_list = * smarthost.ref.example
19434 .endd
19435 This causes all non-local addresses to be sent to the single host
19436 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19437 they are tried in order
19438 (but you can use &%hosts_randomize%& to vary the order each time).
19439 Another way of configuring the same thing is this:
19440 .code
19441 smart_route:
19442   driver = manualroute
19443   transport = remote_smtp
19444   route_list = !+local_domains  smarthost.ref.example
19445 .endd
19446 There is no difference in behaviour between these two routers as they stand.
19447 However, they behave differently if &%no_more%& is added to them. In the first
19448 example, the router is skipped if the domain does not match the &%domains%&
19449 precondition; the following router is always tried. If the router runs, it
19450 always matches the domain and so can never decline. Therefore, &%no_more%&
19451 would have no effect. In the second case, the router is never skipped; it
19452 always runs. However, if it doesn't match the domain, it declines. In this case
19453 &%no_more%& would prevent subsequent routers from running.
19454
19455 .next
19456 .cindex "mail hub example"
19457 A &'mail hub'& is a host which receives mail for a number of domains via MX
19458 records in the DNS and delivers it via its own private routing mechanism. Often
19459 the final destinations are behind a firewall, with the mail hub being the one
19460 machine that can connect to machines both inside and outside the firewall. The
19461 &(manualroute)& router is usually used on a mail hub to route incoming messages
19462 to the correct hosts. For a small number of domains, the routing can be inline,
19463 using the &%route_list%& option, but for a larger number a file or database
19464 lookup is easier to manage.
19465
19466 If the domain names are in fact the names of the machines to which the mail is
19467 to be sent by the mail hub, the configuration can be quite simple. For
19468 example:
19469 .code
19470 hub_route:
19471   driver = manualroute
19472   transport = remote_smtp
19473   route_list = *.rhodes.tvs.example  $domain
19474 .endd
19475 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19476 whose names are the same as the mail domains. A similar approach can be taken
19477 if the host name can be obtained from the domain name by a string manipulation
19478 that the expansion facilities can handle. Otherwise, a lookup based on the
19479 domain can be used to find the host:
19480 .code
19481 through_firewall:
19482   driver = manualroute
19483   transport = remote_smtp
19484   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19485 .endd
19486 The result of the lookup must be the name or IP address of the host (or
19487 hosts) to which the address is to be routed. If the lookup fails, the route
19488 data is empty, causing the router to decline. The address then passes to the
19489 next router.
19490
19491 .next
19492 .cindex "batched SMTP output example"
19493 .cindex "SMTP" "batched outgoing; example"
19494 You can use &(manualroute)& to deliver messages to pipes or files in batched
19495 SMTP format for onward transportation by some other means. This is one way of
19496 storing mail for a dial-up host when it is not connected. The route list entry
19497 can be as simple as a single domain name in a configuration like this:
19498 .code
19499 save_in_file:
19500   driver = manualroute
19501   transport = batchsmtp_appendfile
19502   route_list = saved.domain.example
19503 .endd
19504 though often a pattern is used to pick up more than one domain. If there are
19505 several domains or groups of domains with different transport requirements,
19506 different transports can be listed in the routing information:
19507 .code
19508 save_in_file:
19509   driver = manualroute
19510   route_list = \
19511     *.saved.domain1.example  $domain  batch_appendfile; \
19512     *.saved.domain2.example  \
19513       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19514       batch_pipe
19515 .endd
19516 .vindex "&$domain$&"
19517 .vindex "&$host$&"
19518 The first of these just passes the domain in the &$host$& variable, which
19519 doesn't achieve much (since it is also in &$domain$&), but the second does a
19520 file lookup to find a value to pass, causing the router to decline to handle
19521 the address if the lookup fails.
19522
19523 .next
19524 .cindex "UUCP" "example of router for"
19525 Routing mail directly to UUCP software is a specific case of the use of
19526 &(manualroute)& in a gateway to another mail environment. This is an example of
19527 one way it can be done:
19528 .code
19529 # Transport
19530 uucp:
19531   driver = pipe
19532   user = nobody
19533   command = /usr/local/bin/uux -r - \
19534     ${substr_-5:$host}!rmail ${local_part}
19535   return_fail_output = true
19536
19537 # Router
19538 uucphost:
19539   transport = uucp
19540   driver = manualroute
19541   route_data = \
19542     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19543 .endd
19544 The file &_/usr/local/exim/uucphosts_& contains entries like
19545 .code
19546 darksite.ethereal.example:           darksite.UUCP
19547 .endd
19548 It can be set up more simply without adding and removing &".UUCP"& but this way
19549 makes clear the distinction between the domain name
19550 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19551 .endlist
19552 .ecindex IIDmanrou1
19553 .ecindex IIDmanrou2
19554
19555
19556
19557
19558
19559
19560
19561
19562 . ////////////////////////////////////////////////////////////////////////////
19563 . ////////////////////////////////////////////////////////////////////////////
19564
19565 .chapter "The queryprogram router" "CHAPdriverlast"
19566 .scindex IIDquerou1 "&(queryprogram)& router"
19567 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19568 .cindex "routing" "by external program"
19569 The &(queryprogram)& router routes an address by running an external command
19570 and acting on its output. This is an expensive way to route, and is intended
19571 mainly for use in lightly-loaded systems, or for performing experiments.
19572 However, if it is possible to use the precondition options (&%domains%&,
19573 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19574 be used in special cases, even on a busy host. There are the following private
19575 options:
19576 .cindex "options" "&(queryprogram)& router"
19577
19578 .option command queryprogram string&!! unset
19579 This option must be set. It specifies the command that is to be run. The
19580 command is split up into a command name and arguments, and then each is
19581 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19582 &<<CHAPpipetransport>>&).
19583
19584
19585 .option command_group queryprogram string unset
19586 .cindex "gid (group id)" "in &(queryprogram)& router"
19587 This option specifies a gid to be set when running the command while routing an
19588 address for deliver. It must be set if &%command_user%& specifies a numerical
19589 uid. If it begins with a digit, it is interpreted as the numerical value of the
19590 gid. Otherwise it is looked up using &[getgrnam()]&.
19591
19592
19593 .option command_user queryprogram string unset
19594 .cindex "uid (user id)" "for &(queryprogram)&"
19595 This option must be set. It specifies the uid which is set when running the
19596 command while routing an address for delivery. If the value begins with a digit,
19597 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19598 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19599 not set, a value for the gid also.
19600
19601 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19602 root, which it does during a normal delivery in a conventional configuration.
19603 However, when an address is being verified during message reception, Exim is
19604 usually running as the Exim user, not as root. If the &(queryprogram)& router
19605 is called from a non-root process, Exim cannot change uid or gid before running
19606 the command. In this circumstance the command runs under the current uid and
19607 gid.
19608
19609
19610 .option current_directory queryprogram string /
19611 This option specifies an absolute path which is made the current directory
19612 before running the command.
19613
19614
19615 .option timeout queryprogram time 1h
19616 If the command does not complete within the timeout period, its process group
19617 is killed and the message is frozen. A value of zero time specifies no
19618 timeout.
19619
19620
19621 The standard output of the command is connected to a pipe, which is read when
19622 the command terminates. It should consist of a single line of output,
19623 containing up to five fields, separated by white space. The maximum length of
19624 the line is 1023 characters. Longer lines are silently truncated. The first
19625 field is one of the following words (case-insensitive):
19626
19627 .ilist
19628 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19629 below).
19630 .next
19631 &'Decline'&: the router declines; pass the address to the next router, unless
19632 &%no_more%& is set.
19633 .next
19634 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19635 subsequent text on the line is an error message. If the router is run as part
19636 of address verification during an incoming SMTP message, the message is
19637 included in the SMTP response.
19638 .next
19639 &'Defer'&: routing could not be completed at this time; try again later. Any
19640 subsequent text on the line is an error message which is logged. It is not
19641 included in any SMTP response.
19642 .next
19643 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19644 .next
19645 &'Pass'&: pass the address to the next router (or the router specified by
19646 &%pass_router%&), overriding &%no_more%&.
19647 .next
19648 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19649 new addresses, which are routed independently, starting with the first router,
19650 or the router specified by &%redirect_router%&, if set.
19651 .endlist
19652
19653 When the first word is &'accept'&, the remainder of the line consists of a
19654 number of keyed data values, as follows (split into two lines here, to fit on
19655 the page):
19656 .code
19657 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19658 LOOKUP=byname|bydns DATA=<text>
19659 .endd
19660 The data items can be given in any order, and all are optional. If no transport
19661 is included, the transport specified by the generic &%transport%& option is
19662 used. The list of hosts and the lookup type are needed only if the transport is
19663 an &(smtp)& transport that does not itself supply a list of hosts.
19664
19665 The format of the list of hosts is the same as for the &(manualroute)& router.
19666 As well as host names and IP addresses with optional port numbers, as described
19667 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19668 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19669 (see section &<<SECThostshowused>>&).
19670
19671 If the lookup type is not specified, Exim behaves as follows when trying to
19672 find an IP address for each host: First, a DNS lookup is done. If this yields
19673 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19674 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19675 result of the lookup is the result of that call.
19676
19677 .vindex "&$address_data$&"
19678 If the DATA field is set, its value is placed in the &$address_data$&
19679 variable. For example, this return line
19680 .code
19681 accept hosts=x1.y.example:x2.y.example data="rule1"
19682 .endd
19683 routes the address to the default transport, passing a list of two hosts. When
19684 the transport runs, the string &"rule1"& is in &$address_data$&.
19685 .ecindex IIDquerou1
19686 .ecindex IIDquerou2
19687
19688
19689
19690
19691 . ////////////////////////////////////////////////////////////////////////////
19692 . ////////////////////////////////////////////////////////////////////////////
19693
19694 .chapter "The redirect router" "CHAPredirect"
19695 .scindex IIDredrou1 "&(redirect)& router"
19696 .scindex IIDredrou2 "routers" "&(redirect)&"
19697 .cindex "alias file" "in a &(redirect)& router"
19698 .cindex "address redirection" "&(redirect)& router"
19699 The &(redirect)& router handles several kinds of address redirection. Its most
19700 common uses are for resolving local part aliases from a central alias file
19701 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19702 files, but it has many other potential uses. The incoming address can be
19703 redirected in several different ways:
19704
19705 .ilist
19706 It can be replaced by one or more new addresses which are themselves routed
19707 independently.
19708 .next
19709 It can be routed to be delivered to a given file or directory.
19710 .next
19711 It can be routed to be delivered to a specified pipe command.
19712 .next
19713 It can cause an automatic reply to be generated.
19714 .next
19715 It can be forced to fail, optionally with a custom error message.
19716 .next
19717 It can be temporarily deferred, optionally with a custom message.
19718 .next
19719 It can be discarded.
19720 .endlist
19721
19722 The generic &%transport%& option must not be set for &(redirect)& routers.
19723 However, there are some private options which define transports for delivery to
19724 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19725 &%pipe_transport%& and &%reply_transport%& descriptions below.
19726
19727 If success DSNs have been requested
19728 .cindex "DSN" "success"
19729 .cindex "Delivery Status Notification" "success"
19730 redirection triggers one and the DSN options are not passed any further.
19731
19732
19733
19734 .section "Redirection data" "SECID124"
19735 The router operates by interpreting a text string which it obtains either by
19736 expanding the contents of the &%data%& option, or by reading the entire
19737 contents of a file whose name is given in the &%file%& option. These two
19738 options are mutually exclusive. The first is commonly used for handling system
19739 aliases, in a configuration like this:
19740 .code
19741 system_aliases:
19742   driver = redirect
19743   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19744 .endd
19745 If the lookup fails, the expanded string in this example is empty. When the
19746 expansion of &%data%& results in an empty string, the router declines. A forced
19747 expansion failure also causes the router to decline; other expansion failures
19748 cause delivery to be deferred.
19749
19750 A configuration using &%file%& is commonly used for handling users'
19751 &_.forward_& files, like this:
19752 .code
19753 userforward:
19754   driver = redirect
19755   check_local_user
19756   file = $home/.forward
19757   no_verify
19758 .endd
19759 If the file does not exist, or causes no action to be taken (for example, it is
19760 empty or consists only of comments), the router declines. &*Warning*&: This
19761 is not the case when the file contains syntactically valid items that happen to
19762 yield empty addresses, for example, items containing only RFC 2822 address
19763 comments.
19764
19765
19766
19767 .section "Forward files and address verification" "SECID125"
19768 .cindex "address redirection" "while verifying"
19769 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19770 &_.forward_& files, as in the example above. There are two reasons for this:
19771
19772 .ilist
19773 When Exim is receiving an incoming SMTP message from a remote host, it is
19774 running under the Exim uid, not as root. Exim is unable to change uid to read
19775 the file as the user, and it may not be able to read it as the Exim user. So in
19776 practice the router may not be able to operate.
19777 .next
19778 However, even when the router can operate, the existence of a &_.forward_& file
19779 is unimportant when verifying an address. What should be checked is whether the
19780 local part is a valid user name or not. Cutting out the redirection processing
19781 saves some resources.
19782 .endlist
19783
19784
19785
19786
19787
19788
19789 .section "Interpreting redirection data" "SECID126"
19790 .cindex "Sieve filter" "specifying in redirection data"
19791 .cindex "filter" "specifying in redirection data"
19792 The contents of the data string, whether obtained from &%data%& or &%file%&,
19793 can be interpreted in two different ways:
19794
19795 .ilist
19796 If the &%allow_filter%& option is set true, and the data begins with the text
19797 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19798 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19799 respectively. Details of the syntax and semantics of filter files are described
19800 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19801 document is intended for use by end users.
19802 .next
19803 Otherwise, the data must be a comma-separated list of redirection items, as
19804 described in the next section.
19805 .endlist
19806
19807 When a message is redirected to a file (a &"mail folder"&), the file name given
19808 in a non-filter redirection list must always be an absolute path. A filter may
19809 generate a relative path &-- how this is handled depends on the transport's
19810 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19811 for the &(appendfile)& transport.
19812
19813
19814
19815 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19816 .cindex "address redirection" "non-filter list items"
19817 When the redirection data is not an Exim or Sieve filter, for example, if it
19818 comes from a conventional alias or forward file, it consists of a list of
19819 addresses, file names, pipe commands, or certain special items (see section
19820 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19821 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19822 depending on their default values. The items in the list are separated by
19823 commas or newlines.
19824 If a comma is required in an item, the entire item must be enclosed in double
19825 quotes.
19826
19827 Lines starting with a # character are comments, and are ignored, and # may
19828 also appear following a comma, in which case everything between the # and the
19829 next newline character is ignored.
19830
19831 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19832 double quotes are retained because some forms of mail address require their use
19833 (but never to enclose the entire address). In the following description,
19834 &"item"& refers to what remains after any surrounding double quotes have been
19835 removed.
19836
19837 .vindex "&$local_part$&"
19838 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19839 and the expansion contains a reference to &$local_part$&, you should make use
19840 of the &%quote_local_part%& expansion operator, in case the local part contains
19841 special characters. For example, to redirect all mail for the domain
19842 &'obsolete.example'&, retaining the existing local part, you could use this
19843 setting:
19844 .code
19845 data = ${quote_local_part:$local_part}@newdomain.example
19846 .endd
19847
19848
19849 .section "Redirecting to a local mailbox" "SECTredlocmai"
19850 .cindex "routing" "loops in"
19851 .cindex "loop" "while routing, avoidance of"
19852 .cindex "address redirection" "to local mailbox"
19853 A redirection item may safely be the same as the address currently under
19854 consideration. This does not cause a routing loop, because a router is
19855 automatically skipped if any ancestor of the address that is being processed
19856 is the same as the current address and was processed by the current router.
19857 Such an address is therefore passed to the following routers, so it is handled
19858 as if there were no redirection. When making this loop-avoidance test, the
19859 complete local part, including any prefix or suffix, is used.
19860
19861 .cindex "address redirection" "local part without domain"
19862 Specifying the same local part without a domain is a common usage in personal
19863 filter files when the user wants to have messages delivered to the local
19864 mailbox and also forwarded elsewhere. For example, the user whose login is
19865 &'cleo'& might have a &_.forward_& file containing this:
19866 .code
19867 cleo, cleopatra@egypt.example
19868 .endd
19869 .cindex "backslash in alias file"
19870 .cindex "alias file" "backslash in"
19871 For compatibility with other MTAs, such unqualified local parts may be
19872 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19873 it does make a difference if more than one domain is being handled
19874 synonymously.
19875
19876 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19877 2822 address that does not include a domain, the item is qualified using the
19878 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19879 addresses are qualified using the value in &%qualify_recipient%&, but you can
19880 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19881
19882 Care must be taken if there are alias names for local users.
19883 Consider an MTA handling a single local domain where the system alias file
19884 contains:
19885 .code
19886 Sam.Reman: spqr
19887 .endd
19888 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19889 messages in the local mailbox, and also forward copies elsewhere. He creates
19890 this forward file:
19891 .code
19892 Sam.Reman, spqr@reme.elsewhere.example
19893 .endd
19894 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19895 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19896 second time round, because it has previously routed it,
19897 and the following routers presumably cannot handle the alias. The forward file
19898 should really contain
19899 .code
19900 spqr, spqr@reme.elsewhere.example
19901 .endd
19902 but because this is such a common error, the &%check_ancestor%& option (see
19903 below) exists to provide a way to get round it. This is normally set on a
19904 &(redirect)& router that is handling users' &_.forward_& files.
19905
19906
19907
19908 .section "Special items in redirection lists" "SECTspecitredli"
19909 In addition to addresses, the following types of item may appear in redirection
19910 lists (that is, in non-filter redirection data):
19911
19912 .ilist
19913 .cindex "pipe" "in redirection list"
19914 .cindex "address redirection" "to pipe"
19915 An item is treated as a pipe command if it begins with &"|"& and does not parse
19916 as a valid RFC 2822 address that includes a domain. A transport for running the
19917 command must be specified by the &%pipe_transport%& option.
19918 Normally, either the router or the transport specifies a user and a group under
19919 which to run the delivery. The default is to use the Exim user and group.
19920
19921 Single or double quotes can be used for enclosing the individual arguments of
19922 the pipe command; no interpretation of escapes is done for single quotes. If
19923 the command contains a comma character, it is necessary to put the whole item
19924 in double quotes, for example:
19925 .code
19926 "|/some/command ready,steady,go"
19927 .endd
19928 since items in redirection lists are terminated by commas. Do not, however,
19929 quote just the command. An item such as
19930 .code
19931 |"/some/command ready,steady,go"
19932 .endd
19933 is interpreted as a pipe with a rather strange command name, and no arguments.
19934
19935 Note that the above example assumes that the text comes from a lookup source
19936 of some sort, so that the quotes are part of the data.  If composing a
19937 redirect router with a &%data%& option directly specifying this command, the
19938 quotes will be used by the configuration parser to define the extent of one
19939 string, but will not be passed down into the redirect router itself.  There
19940 are two main approaches to get around this: escape quotes to be part of the
19941 data itself, or avoid using this mechanism and instead create a custom
19942 transport with the &%command%& option set and reference that transport from
19943 an &%accept%& router.
19944
19945 .next
19946 .cindex "file" "in redirection list"
19947 .cindex "address redirection" "to file"
19948 An item is interpreted as a path name if it begins with &"/"& and does not
19949 parse as a valid RFC 2822 address that includes a domain. For example,
19950 .code
19951 /home/world/minbari
19952 .endd
19953 is treated as a file name, but
19954 .code
19955 /s=molari/o=babylon/@x400gate.way
19956 .endd
19957 is treated as an address. For a file name, a transport must be specified using
19958 the &%file_transport%& option. However, if the generated path name ends with a
19959 forward slash character, it is interpreted as a directory name rather than a
19960 file name, and &%directory_transport%& is used instead.
19961
19962 Normally, either the router or the transport specifies a user and a group under
19963 which to run the delivery. The default is to use the Exim user and group.
19964
19965 .cindex "&_/dev/null_&"
19966 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19967 bypassed at a high level, and the log entry shows &"**bypassed**"&
19968 instead of a transport name. In this case the user and group are not used.
19969
19970 .next
19971 .cindex "included address list"
19972 .cindex "address redirection" "included external list"
19973 If an item is of the form
19974 .code
19975 :include:<path name>
19976 .endd
19977 a list of further items is taken from the given file and included at that
19978 point. &*Note*&: Such a file can not be a filter file; it is just an
19979 out-of-line addition to the list. The items in the included list are separated
19980 by commas or newlines and are not subject to expansion. If this is the first
19981 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19982 the alias name. This example is incorrect:
19983 .code
19984 list1    :include:/opt/lists/list1
19985 .endd
19986 It must be given as
19987 .code
19988 list1:   :include:/opt/lists/list1
19989 .endd
19990 .next
19991 .cindex "address redirection" "to black hole"
19992 .cindex "delivery" "discard"
19993 .cindex "delivery" "blackhole"
19994 .cindex "black hole"
19995 .cindex "abandoning mail"
19996 Sometimes you want to throw away mail to a particular local part.  Making the
19997 &%data%& option expand to an empty string does not work, because that causes
19998 the router to decline. Instead, the alias item
19999 .code
20000 :blackhole:
20001 .endd
20002 can be used. It does what its name implies. No delivery is
20003 done, and no error message is generated. This has the same effect as specifying
20004 &_/dev/null_& as a destination, but it can be independently disabled.
20005
20006 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20007 delivery is done for the original local part, even if other redirection items
20008 are present. If you are generating a multi-item list (for example, by reading a
20009 database) and need the ability to provide a no-op item, you must use
20010 &_/dev/null_&.
20011
20012 .next
20013 .cindex "delivery" "forcing failure"
20014 .cindex "delivery" "forcing deferral"
20015 .cindex "failing delivery" "forcing"
20016 .cindex "deferred delivery, forcing"
20017 .cindex "customizing" "failure message"
20018 An attempt to deliver a particular address can be deferred or forced to fail by
20019 redirection items of the form
20020 .code
20021 :defer:
20022 :fail:
20023 .endd
20024 respectively. When a redirection list contains such an item, it applies
20025 to the entire redirection; any other items in the list are ignored. Any
20026 text following &':fail:'& or &':defer:'& is placed in the error text
20027 associated with the failure. For example, an alias file might contain:
20028 .code
20029 X.Employee:  :fail: Gone away, no forwarding address
20030 .endd
20031 In the case of an address that is being verified from an ACL or as the subject
20032 of a
20033 .cindex "VRFY" "error text, display of"
20034 VRFY command, the text is included in the SMTP error response by
20035 default.
20036 .cindex "EXPN" "error text, display of"
20037 The text is not included in the response to an EXPN command. In non-SMTP cases
20038 the text is included in the error message that Exim generates.
20039
20040 .cindex "SMTP" "error codes"
20041 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20042 &':fail:'&. However, if the message starts with three digits followed by a
20043 space, optionally followed by an extended code of the form &'n.n.n'&, also
20044 followed by a space, and the very first digit is the same as the default error
20045 code, the code from the message is used instead. If the very first digit is
20046 incorrect, a panic error is logged, and the default code is used. You can
20047 suppress the use of the supplied code in a redirect router by setting the
20048 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20049 ignored.
20050
20051 .vindex "&$acl_verify_message$&"
20052 In an ACL, an explicitly provided message overrides the default, but the
20053 default message is available in the variable &$acl_verify_message$& and can
20054 therefore be included in a custom message if this is desired.
20055
20056 Normally the error text is the rest of the redirection list &-- a comma does
20057 not terminate it &-- but a newline does act as a terminator. Newlines are not
20058 normally present in alias expansions. In &(lsearch)& lookups they are removed
20059 as part of the continuation process, but they may exist in other kinds of
20060 lookup and in &':include:'& files.
20061
20062 During routing for message delivery (as opposed to verification), a redirection
20063 containing &':fail:'& causes an immediate failure of the incoming address,
20064 whereas &':defer:'& causes the message to remain on the queue so that a
20065 subsequent delivery attempt can happen at a later time. If an address is
20066 deferred for too long, it will ultimately fail, because the normal retry
20067 rules still apply.
20068
20069 .next
20070 .cindex "alias file" "exception to default"
20071 Sometimes it is useful to use a single-key search type with a default (see
20072 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20073 for exceptions to the default. These can be handled by aliasing them to
20074 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20075 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20076 results in an empty redirection list has the same effect.
20077 .endlist
20078
20079
20080 .section "Duplicate addresses" "SECTdupaddr"
20081 .cindex "duplicate addresses"
20082 .cindex "address duplicate, discarding"
20083 .cindex "pipe" "duplicated"
20084 Exim removes duplicate addresses from the list to which it is delivering, so as
20085 to deliver just one copy to each address. This does not apply to deliveries
20086 routed to pipes by different immediate parent addresses, but an indirect
20087 aliasing scheme of the type
20088 .code
20089 pipe:       |/some/command $local_part
20090 localpart1: pipe
20091 localpart2: pipe
20092 .endd
20093 does not work with a message that is addressed to both local parts, because
20094 when the second is aliased to the intermediate local part &"pipe"& it gets
20095 discarded as being the same as a previously handled address. However, a scheme
20096 such as
20097 .code
20098 localpart1: |/some/command $local_part
20099 localpart2: |/some/command $local_part
20100 .endd
20101 does result in two different pipe deliveries, because the immediate parents of
20102 the pipes are distinct.
20103
20104
20105
20106 .section "Repeated redirection expansion" "SECID128"
20107 .cindex "repeated redirection expansion"
20108 .cindex "address redirection" "repeated for each delivery attempt"
20109 When a message cannot be delivered to all of its recipients immediately,
20110 leading to two or more delivery attempts, redirection expansion is carried out
20111 afresh each time for those addresses whose children were not all previously
20112 delivered. If redirection is being used as a mailing list, this can lead to new
20113 members of the list receiving copies of old messages. The &%one_time%& option
20114 can be used to avoid this.
20115
20116
20117 .section "Errors in redirection lists" "SECID129"
20118 .cindex "address redirection" "errors"
20119 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20120 error is skipped, and an entry is written to the main log. This may be useful
20121 for mailing lists that are automatically managed. Otherwise, if an error is
20122 detected while generating the list of new addresses, the original address is
20123 deferred. See also &%syntax_errors_to%&.
20124
20125
20126
20127 .section "Private options for the redirect router" "SECID130"
20128
20129 .cindex "options" "&(redirect)& router"
20130 The private options for the &(redirect)& router are as follows:
20131
20132
20133 .option allow_defer redirect boolean false
20134 Setting this option allows the use of &':defer:'& in non-filter redirection
20135 data, or the &%defer%& command in an Exim filter file.
20136
20137
20138 .option allow_fail redirect boolean false
20139 .cindex "failing delivery" "from filter"
20140 If this option is true, the &':fail:'& item can be used in a redirection list,
20141 and the &%fail%& command may be used in an Exim filter file.
20142
20143
20144 .option allow_filter redirect boolean false
20145 .cindex "filter" "enabling use of"
20146 .cindex "Sieve filter" "enabling use of"
20147 Setting this option allows Exim to interpret redirection data that starts with
20148 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20149 are some features of Exim filter files that some administrators may wish to
20150 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20151
20152 It is also possible to lock out Exim filters or Sieve filters while allowing
20153 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20154
20155
20156 The filter is run using the uid and gid set by the generic &%user%& and
20157 &%group%& options. These take their defaults from the password data if
20158 &%check_local_user%& is set, so in the normal case of users' personal filter
20159 files, the filter is run as the relevant user. When &%allow_filter%& is set
20160 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20161
20162
20163
20164 .option allow_freeze redirect boolean false
20165 .cindex "freezing messages" "allowing in filter"
20166 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20167 This command is more normally encountered in system filters, and is disabled by
20168 default for redirection filters because it isn't something you usually want to
20169 let ordinary users do.
20170
20171
20172
20173 .option check_ancestor redirect boolean false
20174 This option is concerned with handling generated addresses that are the same
20175 as some address in the list of redirection ancestors of the current address.
20176 Although it is turned off by default in the code, it is set in the default
20177 configuration file for handling users' &_.forward_& files. It is recommended
20178 for this use of the &(redirect)& router.
20179
20180 When &%check_ancestor%& is set, if a generated address (including the domain)
20181 is the same as any ancestor of the current address, it is replaced by a copy of
20182 the current address. This helps in the case where local part A is aliased to B,
20183 and B has a &_.forward_& file pointing back to A. For example, within a single
20184 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20185 &_&~jb/.forward_& contains:
20186 .code
20187 \Joe.Bloggs, <other item(s)>
20188 .endd
20189 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20190 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20191 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20192 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20193 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20194 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20195 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20196 original address. See also the &%repeat_use%& option below.
20197
20198
20199 .option check_group redirect boolean "see below"
20200 When the &%file%& option is used, the group owner of the file is checked only
20201 when this option is set. The permitted groups are those listed in the
20202 &%owngroups%& option, together with the user's default group if
20203 &%check_local_user%& is set. If the file has the wrong group, routing is
20204 deferred. The default setting for this option is true if &%check_local_user%&
20205 is set and the &%modemask%& option permits the group write bit, or if the
20206 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20207
20208
20209
20210 .option check_owner redirect boolean "see below"
20211 When the &%file%& option is used, the owner of the file is checked only when
20212 this option is set. If &%check_local_user%& is set, the local user is
20213 permitted; otherwise the owner must be one of those listed in the &%owners%&
20214 option. The default value for this option is true if &%check_local_user%& or
20215 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20216
20217
20218 .option data redirect string&!! unset
20219 This option is mutually exclusive with &%file%&. One or other of them must be
20220 set, but not both. The contents of &%data%& are expanded, and then used as the
20221 list of forwarding items, or as a set of filtering instructions. If the
20222 expansion is forced to fail, or the result is an empty string or a string that
20223 has no effect (consists entirely of comments), the router declines.
20224
20225 When filtering instructions are used, the string must begin with &"#Exim
20226 filter"&, and all comments in the string, including this initial one, must be
20227 terminated with newline characters. For example:
20228 .code
20229 data = #Exim filter\n\
20230        if $h_to: contains Exim then save $home/mail/exim endif
20231 .endd
20232 If you are reading the data from a database where newlines cannot be included,
20233 you can use the &${sg}$& expansion item to turn the escape string of your
20234 choice into a newline.
20235
20236
20237 .option directory_transport redirect string&!! unset
20238 A &(redirect)& router sets up a direct delivery to a directory when a path name
20239 ending with a slash is specified as a new &"address"&. The transport used is
20240 specified by this option, which, after expansion, must be the name of a
20241 configured transport. This should normally be an &(appendfile)& transport.
20242
20243
20244 .option file redirect string&!! unset
20245 This option specifies the name of a file that contains the redirection data. It
20246 is mutually exclusive with the &%data%& option. The string is expanded before
20247 use; if the expansion is forced to fail, the router declines. Other expansion
20248 failures cause delivery to be deferred. The result of a successful expansion
20249 must be an absolute path. The entire file is read and used as the redirection
20250 data. If the data is an empty string or a string that has no effect (consists
20251 entirely of comments), the router declines.
20252
20253 .cindex "NFS" "checking for file existence"
20254 If the attempt to open the file fails with a &"does not exist"& error, Exim
20255 runs a check on the containing directory,
20256 unless &%ignore_enotdir%& is true (see below).
20257 If the directory does not appear to exist, delivery is deferred. This can
20258 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20259 is a mount problem. If the containing directory does exist, but the file does
20260 not, the router declines.
20261
20262
20263 .option file_transport redirect string&!! unset
20264 .vindex "&$address_file$&"
20265 A &(redirect)& router sets up a direct delivery to a file when a path name not
20266 ending in a slash is specified as a new &"address"&. The transport used is
20267 specified by this option, which, after expansion, must be the name of a
20268 configured transport. This should normally be an &(appendfile)& transport. When
20269 it is running, the file name is in &$address_file$&.
20270
20271
20272 .option filter_prepend_home redirect boolean true
20273 When this option is true, if a &(save)& command in an Exim filter specifies a
20274 relative path, and &$home$& is defined, it is automatically prepended to the
20275 relative path. If this option is set false, this action does not happen. The
20276 relative path is then passed to the transport unmodified.
20277
20278
20279 .option forbid_blackhole redirect boolean false
20280 If this option is true, the &':blackhole:'& item may not appear in a
20281 redirection list.
20282
20283
20284 .option forbid_exim_filter redirect boolean false
20285 If this option is set true, only Sieve filters are permitted when
20286 &%allow_filter%& is true.
20287
20288
20289
20290
20291 .option forbid_file redirect boolean false
20292 .cindex "delivery" "to file; forbidding"
20293 .cindex "Sieve filter" "forbidding delivery to a file"
20294 .cindex "Sieve filter" "&""keep""& facility; disabling"
20295 If this option is true, this router may not generate a new address that
20296 specifies delivery to a local file or directory, either from a filter or from a
20297 conventional forward file. This option is forced to be true if &%one_time%& is
20298 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20299 locks out the Sieve's &"keep"& facility.
20300
20301
20302 .option forbid_filter_dlfunc redirect boolean false
20303 .cindex "filter" "locking out certain features"
20304 If this option is true, string expansions in Exim filters are not allowed to
20305 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20306 functions.
20307
20308 .option forbid_filter_existstest redirect boolean false
20309 .cindex "expansion" "statting a file"
20310 If this option is true, string expansions in Exim filters are not allowed to
20311 make use of the &%exists%& condition or the &%stat%& expansion item.
20312
20313 .option forbid_filter_logwrite redirect boolean false
20314 If this option is true, use of the logging facility in Exim filters is not
20315 permitted. Logging is in any case available only if the filter is being run
20316 under some unprivileged uid (which is normally the case for ordinary users'
20317 &_.forward_& files).
20318
20319
20320 .option forbid_filter_lookup redirect boolean false
20321 If this option is true, string expansions in Exim filter files are not allowed
20322 to make use of &%lookup%& items.
20323
20324
20325 .option forbid_filter_perl redirect boolean false
20326 This option has an effect only if Exim is built with embedded Perl support. If
20327 it is true, string expansions in Exim filter files are not allowed to make use
20328 of the embedded Perl support.
20329
20330
20331 .option forbid_filter_readfile redirect boolean false
20332 If this option is true, string expansions in Exim filter files are not allowed
20333 to make use of &%readfile%& items.
20334
20335
20336 .option forbid_filter_readsocket redirect boolean false
20337 If this option is true, string expansions in Exim filter files are not allowed
20338 to make use of &%readsocket%& items.
20339
20340
20341 .option forbid_filter_reply redirect boolean false
20342 If this option is true, this router may not generate an automatic reply
20343 message. Automatic replies can be generated only from Exim or Sieve filter
20344 files, not from traditional forward files. This option is forced to be true if
20345 &%one_time%& is set.
20346
20347
20348 .option forbid_filter_run redirect boolean false
20349 If this option is true, string expansions in Exim filter files are not allowed
20350 to make use of &%run%& items.
20351
20352
20353 .option forbid_include redirect boolean false
20354 If this option is true, items of the form
20355 .code
20356 :include:<path name>
20357 .endd
20358 are not permitted in non-filter redirection lists.
20359
20360
20361 .option forbid_pipe redirect boolean false
20362 .cindex "delivery" "to pipe; forbidding"
20363 If this option is true, this router may not generate a new address which
20364 specifies delivery to a pipe, either from an Exim filter or from a conventional
20365 forward file. This option is forced to be true if &%one_time%& is set.
20366
20367
20368 .option forbid_sieve_filter redirect boolean false
20369 If this option is set true, only Exim filters are permitted when
20370 &%allow_filter%& is true.
20371
20372
20373 .cindex "SMTP" "error codes"
20374 .option forbid_smtp_code redirect boolean false
20375 If this option is set true, any SMTP error codes that are present at the start
20376 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20377 the default codes (451 and 550, respectively) are always used.
20378
20379
20380
20381
20382 .option hide_child_in_errmsg redirect boolean false
20383 .cindex "bounce message" "redirection details; suppressing"
20384 If this option is true, it prevents Exim from quoting a child address if it
20385 generates a bounce or delay message for it. Instead it says &"an address
20386 generated from <&'the top level address'&>"&. Of course, this applies only to
20387 bounces generated locally. If a message is forwarded to another host, &'its'&
20388 bounce may well quote the generated address.
20389
20390
20391 .option ignore_eacces redirect boolean false
20392 .cindex "EACCES"
20393 If this option is set and an attempt to open a redirection file yields the
20394 EACCES error (permission denied), the &(redirect)& router behaves as if the
20395 file did not exist.
20396
20397
20398 .option ignore_enotdir redirect boolean false
20399 .cindex "ENOTDIR"
20400 If this option is set and an attempt to open a redirection file yields the
20401 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20402 router behaves as if the file did not exist.
20403
20404 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20405 router that has the &%file%& option set discovers that the file does not exist
20406 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20407 against unmounted NFS directories. If the parent can not be statted, delivery
20408 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20409 is set, because that option tells Exim to ignore &"something on the path is not
20410 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20411 that some operating systems give ENOENT where others give ENOTDIR.
20412
20413
20414
20415 .option include_directory redirect string unset
20416 If this option is set, the path names of any &':include:'& items in a
20417 redirection list must start with this directory.
20418
20419
20420 .option modemask redirect "octal integer" 022
20421 This specifies mode bits which must not be set for a file specified by the
20422 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20423
20424
20425 .option one_time redirect boolean false
20426 .cindex "one-time aliasing/forwarding expansion"
20427 .cindex "alias file" "one-time expansion"
20428 .cindex "forward file" "one-time expansion"
20429 .cindex "mailing lists" "one-time expansion"
20430 .cindex "address redirection" "one-time expansion"
20431 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20432 files each time it tries to deliver a message causes a problem when one or more
20433 of the generated addresses fails be delivered at the first attempt. The problem
20434 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20435 but of what happens when the redirection list changes during the time that the
20436 message is on Exim's queue. This is particularly true in the case of mailing
20437 lists, where new subscribers might receive copies of messages that were posted
20438 before they subscribed.
20439
20440 If &%one_time%& is set and any addresses generated by the router fail to
20441 deliver at the first attempt, the failing addresses are added to the message as
20442 &"top level"& addresses, and the parent address that generated them is marked
20443 &"delivered"&. Thus, redirection does not happen again at the next delivery
20444 attempt.
20445
20446 &*Warning 1*&: Any header line addition or removal that is specified by this
20447 router would be lost if delivery did not succeed at the first attempt. For this
20448 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20449 permitted when &%one_time%& is set.
20450
20451 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20452 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20453 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20454
20455 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20456 &%one_time%&.
20457
20458 The original top-level address is remembered with each of the generated
20459 addresses, and is output in any log messages. However, any intermediate parent
20460 addresses are not recorded. This makes a difference to the log only if
20461 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20462 typically be used for mailing lists, where there is normally just one level of
20463 expansion.
20464
20465
20466 .option owners redirect "string list" unset
20467 .cindex "ownership" "alias file"
20468 .cindex "ownership" "forward file"
20469 .cindex "alias file" "ownership"
20470 .cindex "forward file" "ownership"
20471 This specifies a list of permitted owners for the file specified by &%file%&.
20472 This list is in addition to the local user when &%check_local_user%& is set.
20473 See &%check_owner%& above.
20474
20475
20476 .option owngroups redirect "string list" unset
20477 This specifies a list of permitted groups for the file specified by &%file%&.
20478 The list is in addition to the local user's primary group when
20479 &%check_local_user%& is set. See &%check_group%& above.
20480
20481
20482 .option pipe_transport redirect string&!! unset
20483 .vindex "&$address_pipe$&"
20484 A &(redirect)& router sets up a direct delivery to a pipe when a string
20485 starting with a vertical bar character is specified as a new &"address"&. The
20486 transport used is specified by this option, which, after expansion, must be the
20487 name of a configured transport. This should normally be a &(pipe)& transport.
20488 When the transport is run, the pipe command is in &$address_pipe$&.
20489
20490
20491 .option qualify_domain redirect string&!! unset
20492 .vindex "&$qualify_recipient$&"
20493 If this option is set, and an unqualified address (one without a domain) is
20494 generated, and that address would normally be qualified by the global setting
20495 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20496 expanding this string. If the expansion fails, the router declines. If you want
20497 to revert to the default, you can have the expansion generate
20498 &$qualify_recipient$&.
20499
20500 This option applies to all unqualified addresses generated by Exim filters,
20501 but for traditional &_.forward_& files, it applies only to addresses that are
20502 not preceded by a backslash. Sieve filters cannot generate unqualified
20503 addresses.
20504
20505 .option qualify_preserve_domain redirect boolean false
20506 .cindex "domain" "in redirection; preserving"
20507 .cindex "preserving domain in redirection"
20508 .cindex "address redirection" "domain; preserving"
20509 If this option is set, the router's local &%qualify_domain%& option must not be
20510 set (a configuration error occurs if it is). If an unqualified address (one
20511 without a domain) is generated, it is qualified with the domain of the parent
20512 address (the immediately preceding ancestor) instead of the global
20513 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20514 this applies whether or not the address is preceded by a backslash.
20515
20516
20517 .option repeat_use redirect boolean true
20518 If this option is set false, the router is skipped for a child address that has
20519 any ancestor that was routed by this router. This test happens before any of
20520 the other preconditions are tested. Exim's default anti-looping rules skip
20521 only when the ancestor is the same as the current address. See also
20522 &%check_ancestor%& above and the generic &%redirect_router%& option.
20523
20524
20525 .option reply_transport redirect string&!! unset
20526 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20527 &%vacation%& command is used in a filter file. The transport used is specified
20528 by this option, which, after expansion, must be the name of a configured
20529 transport. This should normally be an &(autoreply)& transport. Other transports
20530 are unlikely to do anything sensible or useful.
20531
20532
20533 .option rewrite redirect boolean true
20534 .cindex "address redirection" "disabling rewriting"
20535 If this option is set false, addresses generated by the router are not
20536 subject to address rewriting. Otherwise, they are treated like new addresses
20537 and are rewritten according to the global rewriting rules.
20538
20539
20540 .option sieve_subaddress redirect string&!! unset
20541 The value of this option is passed to a Sieve filter to specify the
20542 :subaddress part of an address.
20543
20544 .option sieve_useraddress redirect string&!! unset
20545 The value of this option is passed to a Sieve filter to specify the :user part
20546 of an address. However, if it is unset, the entire original local part
20547 (including any prefix or suffix) is used for :user.
20548
20549
20550 .option sieve_vacation_directory redirect string&!! unset
20551 .cindex "Sieve filter" "vacation directory"
20552 To enable the &"vacation"& extension for Sieve filters, you must set
20553 &%sieve_vacation_directory%& to the directory where vacation databases are held
20554 (do not put anything else in that directory), and ensure that the
20555 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20556 needs their own directory; Exim will create it if necessary.
20557
20558
20559
20560 .option skip_syntax_errors redirect boolean false
20561 .cindex "forward file" "broken"
20562 .cindex "address redirection" "broken files"
20563 .cindex "alias file" "broken"
20564 .cindex "broken alias or forward files"
20565 .cindex "ignoring faulty addresses"
20566 .cindex "skipping faulty addresses"
20567 .cindex "error" "skipping bad syntax"
20568 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20569 non-filter redirection data are skipped, and each failing address is logged. If
20570 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20571 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20572 are expanded and placed at the head of the error message generated by
20573 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20574 be the same address as the generic &%errors_to%& option. The
20575 &%skip_syntax_errors%& option is often used when handling mailing lists.
20576
20577 If all the addresses in a redirection list are skipped because of syntax
20578 errors, the router declines to handle the original address, and it is passed to
20579 the following routers.
20580
20581 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20582 error in the filter causes filtering to be abandoned without any action being
20583 taken. The incident is logged, and the router declines to handle the address,
20584 so it is passed to the following routers.
20585
20586 .cindex "Sieve filter" "syntax errors in"
20587 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20588 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20589 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20590
20591 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20592 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20593 option, used with an address that does not get redirected, can be used to
20594 notify users of these errors, by means of a router like this:
20595 .code
20596 userforward:
20597   driver = redirect
20598   allow_filter
20599   check_local_user
20600   file = $home/.forward
20601   file_transport = address_file
20602   pipe_transport = address_pipe
20603   reply_transport = address_reply
20604   no_verify
20605   skip_syntax_errors
20606   syntax_errors_to = real-$local_part@$domain
20607   syntax_errors_text = \
20608    This is an automatically generated message. An error has\n\
20609    been found in your .forward file. Details of the error are\n\
20610    reported below. While this error persists, you will receive\n\
20611    a copy of this message for every message that is addressed\n\
20612    to you. If your .forward file is a filter file, or if it is\n\
20613    a non-filter file containing no valid forwarding addresses,\n\
20614    a copy of each incoming message will be put in your normal\n\
20615    mailbox. If a non-filter file contains at least one valid\n\
20616    forwarding address, forwarding to the valid addresses will\n\
20617    happen, and those will be the only deliveries that occur.
20618 .endd
20619 You also need a router to ensure that local addresses that are prefixed by
20620 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20621 put this immediately before the &(userforward)& router:
20622 .code
20623 real_localuser:
20624   driver = accept
20625   check_local_user
20626   local_part_prefix = real-
20627   transport = local_delivery
20628 .endd
20629 For security, it would probably be a good idea to restrict the use of this
20630 router to locally-generated messages, using a condition such as this:
20631 .code
20632   condition = ${if match {$sender_host_address}\
20633                          {\N^(|127\.0\.0\.1)$\N}}
20634 .endd
20635
20636
20637 .option syntax_errors_text redirect string&!! unset
20638 See &%skip_syntax_errors%& above.
20639
20640
20641 .option syntax_errors_to redirect string unset
20642 See &%skip_syntax_errors%& above.
20643 .ecindex IIDredrou1
20644 .ecindex IIDredrou2
20645
20646
20647
20648
20649
20650
20651 . ////////////////////////////////////////////////////////////////////////////
20652 . ////////////////////////////////////////////////////////////////////////////
20653
20654 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20655          "Environment for local transports"
20656 .scindex IIDenvlotra1 "local transports" "environment for"
20657 .scindex IIDenvlotra2 "environment" "local transports"
20658 .scindex IIDenvlotra3 "transport" "local; environment for"
20659 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20660 transport can be thought of as similar to a pipe.) Exim always runs transports
20661 in subprocesses, under specified uids and gids. Typical deliveries to local
20662 mailboxes run under the uid and gid of the local user.
20663
20664 Exim also sets a specific current directory while running the transport; for
20665 some transports a home directory setting is also relevant. The &(pipe)&
20666 transport is the only one that sets up environment variables; see section
20667 &<<SECTpipeenv>>& for details.
20668
20669 The values used for the uid, gid, and the directories may come from several
20670 different places. In many cases, the router that handles the address associates
20671 settings with that address as a result of its &%check_local_user%&, &%group%&,
20672 or &%user%& options. However, values may also be given in the transport's own
20673 configuration, and these override anything that comes from the router.
20674
20675
20676
20677 .section "Concurrent deliveries" "SECID131"
20678 .cindex "concurrent deliveries"
20679 .cindex "simultaneous deliveries"
20680 If two different messages for the same local recipient arrive more or less
20681 simultaneously, the two delivery processes are likely to run concurrently. When
20682 the &(appendfile)& transport is used to write to a file, Exim applies locking
20683 rules to stop concurrent processes from writing to the same file at the same
20684 time.
20685
20686 However, when you use a &(pipe)& transport, it is up to you to arrange any
20687 locking that is needed. Here is a silly example:
20688 .code
20689 my_transport:
20690   driver = pipe
20691   command = /bin/sh -c 'cat >>/some/file'
20692 .endd
20693 This is supposed to write the message at the end of the file. However, if two
20694 messages arrive at the same time, the file will be scrambled. You can use the
20695 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20696 file using the same algorithm that Exim itself uses.
20697
20698
20699
20700
20701 .section "Uids and gids" "SECTenvuidgid"
20702 .cindex "local transports" "uid and gid"
20703 .cindex "transport" "local; uid and gid"
20704 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20705 overrides any group that the router set in the address, even if &%user%& is not
20706 set for the transport. This makes it possible, for example, to run local mail
20707 delivery under the uid of the recipient (set by the router), but in a special
20708 group (set by the transport). For example:
20709 .code
20710 # Routers ...
20711 # User/group are set by check_local_user in this router
20712 local_users:
20713   driver = accept
20714   check_local_user
20715   transport = group_delivery
20716
20717 # Transports ...
20718 # This transport overrides the group
20719 group_delivery:
20720   driver = appendfile
20721   file = /var/spool/mail/$local_part
20722   group = mail
20723 .endd
20724 If &%user%& is set for a transport, its value overrides what is set in the
20725 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20726 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20727 set.
20728
20729 .oindex "&%initgroups%&"
20730 When the uid is taken from the transport's configuration, the &[initgroups()]&
20731 function is called for the groups associated with that uid if the
20732 &%initgroups%& option is set for the transport. When the uid is not specified
20733 by the transport, but is associated with the address by a router, the option
20734 for calling &[initgroups()]& is taken from the router configuration.
20735
20736 .cindex "&(pipe)& transport" "uid for"
20737 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20738 is set and &%user%& is not set, the uid of the process that called Exim to
20739 receive the message is used, and if &%group%& is not set, the corresponding
20740 original gid is also used.
20741
20742 This is the detailed preference order for obtaining a gid; the first of the
20743 following that is set is used:
20744
20745 .ilist
20746 A &%group%& setting of the transport;
20747 .next
20748 A &%group%& setting of the router;
20749 .next
20750 A gid associated with a user setting of the router, either as a result of
20751 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20752 .next
20753 The group associated with a non-numeric &%user%& setting of the transport;
20754 .next
20755 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20756 the uid is the creator's uid;
20757 .next
20758 The Exim gid if the Exim uid is being used as a default.
20759 .endlist
20760
20761 If, for example, the user is specified numerically on the router and there are
20762 no group settings, no gid is available. In this situation, an error occurs.
20763 This is different for the uid, for which there always is an ultimate default.
20764 The first of the following that is set is used:
20765
20766 .ilist
20767 A &%user%& setting of the transport;
20768 .next
20769 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20770 .next
20771 A &%user%& setting of the router;
20772 .next
20773 A &%check_local_user%& setting of the router;
20774 .next
20775 The Exim uid.
20776 .endlist
20777
20778 Of course, an error will still occur if the uid that is chosen is on the
20779 &%never_users%& list.
20780
20781
20782
20783
20784
20785 .section "Current and home directories" "SECID132"
20786 .cindex "current directory for local transport"
20787 .cindex "home directory" "for local transport"
20788 .cindex "transport" "local; home directory for"
20789 .cindex "transport" "local; current directory for"
20790 Routers may set current and home directories for local transports by means of
20791 the &%transport_current_directory%& and &%transport_home_directory%& options.
20792 However, if the transport's &%current_directory%& or &%home_directory%& options
20793 are set, they override the router's values. In detail, the home directory
20794 for a local transport is taken from the first of these values that is set:
20795
20796 .ilist
20797 The &%home_directory%& option on the transport;
20798 .next
20799 The &%transport_home_directory%& option on the router;
20800 .next
20801 The password data if &%check_local_user%& is set on the router;
20802 .next
20803 The &%router_home_directory%& option on the router.
20804 .endlist
20805
20806 The current directory is taken from the first of these values that is set:
20807
20808 .ilist
20809 The &%current_directory%& option on the transport;
20810 .next
20811 The &%transport_current_directory%& option on the router.
20812 .endlist
20813
20814
20815 If neither the router nor the transport sets a current directory, Exim uses the
20816 value of the home directory, if it is set. Otherwise it sets the current
20817 directory to &_/_& before running a local transport.
20818
20819
20820
20821 .section "Expansion variables derived from the address" "SECID133"
20822 .vindex "&$domain$&"
20823 .vindex "&$local_part$&"
20824 .vindex "&$original_domain$&"
20825 Normally a local delivery is handling a single address, and in that case the
20826 variables such as &$domain$& and &$local_part$& are set during local
20827 deliveries. However, in some circumstances more than one address may be handled
20828 at once (for example, while writing batch SMTP for onward transmission by some
20829 other means). In this case, the variables associated with the local part are
20830 never set, &$domain$& is set only if all the addresses have the same domain,
20831 and &$original_domain$& is never set.
20832 .ecindex IIDenvlotra1
20833 .ecindex IIDenvlotra2
20834 .ecindex IIDenvlotra3
20835
20836
20837
20838
20839
20840
20841
20842 . ////////////////////////////////////////////////////////////////////////////
20843 . ////////////////////////////////////////////////////////////////////////////
20844
20845 .chapter "Generic options for transports" "CHAPtransportgeneric"
20846 .scindex IIDgenoptra1 "generic options" "transport"
20847 .scindex IIDgenoptra2 "options" "generic; for transports"
20848 .scindex IIDgenoptra3 "transport" "generic options for"
20849 The following generic options apply to all transports:
20850
20851
20852 .option body_only transports boolean false
20853 .cindex "transport" "body only"
20854 .cindex "message" "transporting body only"
20855 .cindex "body of message" "transporting"
20856 If this option is set, the message's headers are not transported. It is
20857 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20858 or &(pipe)& transports, the settings of &%message_prefix%& and
20859 &%message_suffix%& should be checked, because this option does not
20860 automatically suppress them.
20861
20862
20863 .option current_directory transports string&!! unset
20864 .cindex "transport" "current directory for"
20865 This specifies the current directory that is to be set while running the
20866 transport, overriding any value that may have been set by the router.
20867 If the expansion fails for any reason, including forced failure, an error is
20868 logged, and delivery is deferred.
20869
20870
20871 .option disable_logging transports boolean false
20872 If this option is set true, nothing is logged for any
20873 deliveries by the transport or for any
20874 transport errors. You should not set this option unless you really, really know
20875 what you are doing.
20876
20877
20878 .option debug_print transports string&!! unset
20879 .cindex "testing" "variables in drivers"
20880 If this option is set and debugging is enabled (see the &%-d%& command line
20881 option), the string is expanded and included in the debugging output when the
20882 transport is run.
20883 If expansion of the string fails, the error message is written to the debugging
20884 output, and Exim carries on processing.
20885 This facility is provided to help with checking out the values of variables and
20886 so on when debugging driver configurations. For example, if a &%headers_add%&
20887 option is not working properly, &%debug_print%& could be used to output the
20888 variables it references. A newline is added to the text if it does not end with
20889 one.
20890 The variables &$transport_name$& and &$router_name$& contain the name of the
20891 transport and the router that called it.
20892
20893 .option delivery_date_add transports boolean false
20894 .cindex "&'Delivery-date:'& header line"
20895 If this option is true, a &'Delivery-date:'& header is added to the message.
20896 This gives the actual time the delivery was made. As this is not a standard
20897 header, Exim has a configuration option (&%delivery_date_remove%&) which
20898 requests its removal from incoming messages, so that delivered messages can
20899 safely be resent to other recipients.
20900
20901
20902 .option driver transports string unset
20903 This specifies which of the available transport drivers is to be used.
20904 There is no default, and this option must be set for every transport.
20905
20906
20907 .option envelope_to_add transports boolean false
20908 .cindex "&'Envelope-to:'& header line"
20909 If this option is true, an &'Envelope-to:'& header is added to the message.
20910 This gives the original address(es) in the incoming envelope that caused this
20911 delivery to happen. More than one address may be present if the transport is
20912 configured to handle several addresses at once, or if more than one original
20913 address was redirected to the same final address. As this is not a standard
20914 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20915 its removal from incoming messages, so that delivered messages can safely be
20916 resent to other recipients.
20917
20918
20919 .option event_action transports string&!! unset
20920 .cindex events
20921 This option declares a string to be expanded for Exim's events mechanism.
20922 For details see chapter &<<CHAPevents>>&.
20923
20924
20925 .option group transports string&!! "Exim group"
20926 .cindex "transport" "group; specifying"
20927 This option specifies a gid for running the transport process, overriding any
20928 value that the router supplies, and also overriding any value associated with
20929 &%user%& (see below).
20930
20931
20932 .option headers_add transports list&!! unset
20933 .cindex "header lines" "adding in transport"
20934 .cindex "transport" "header lines; adding"
20935 This option specifies a list of text headers,
20936 newline-separated (by default, changeable in the usual way),
20937 which are (separately) expanded and added to the header
20938 portion of a message as it is transported, as described in section
20939 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20940 routers. If the result of the expansion is an empty string, or if the expansion
20941 is forced to fail, no action is taken. Other expansion failures are treated as
20942 errors and cause the delivery to be deferred.
20943
20944 Unlike most options, &%headers_add%& can be specified multiple times
20945 for a transport; all listed headers are added.
20946
20947
20948 .option headers_only transports boolean false
20949 .cindex "transport" "header lines only"
20950 .cindex "message" "transporting headers only"
20951 .cindex "header lines" "transporting"
20952 If this option is set, the message's body is not transported. It is mutually
20953 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20954 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20955 checked, since this option does not automatically suppress them.
20956
20957
20958 .option headers_remove transports list&!! unset
20959 .cindex "header lines" "removing"
20960 .cindex "transport" "header lines; removing"
20961 This option specifies a list of header names,
20962 colon-separated (by default, changeable in the usual way);
20963 these headers are omitted from the message as it is transported, as described
20964 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20965 routers.
20966 Each list item is separately expanded.
20967 If the result of the expansion is an empty string, or if the expansion
20968 is forced to fail, no action is taken. Other expansion failures are treated as
20969 errors and cause the delivery to be deferred.
20970
20971 Unlike most options, &%headers_remove%& can be specified multiple times
20972 for a transport; all listed headers are removed.
20973
20974 &*Warning*&: Because of the separate expansion of the list items,
20975 items that contain a list separator must have it doubled.
20976 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20977
20978
20979
20980 .option headers_rewrite transports string unset
20981 .cindex "transport" "header lines; rewriting"
20982 .cindex "rewriting" "at transport time"
20983 This option allows addresses in header lines to be rewritten at transport time,
20984 that is, as the message is being copied to its destination. The contents of the
20985 option are a colon-separated list of rewriting rules. Each rule is in exactly
20986 the same form as one of the general rewriting rules that are applied when a
20987 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20988 example,
20989 .code
20990 headers_rewrite = a@b c@d f : \
20991                   x@y w@z
20992 .endd
20993 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20994 &'w@z'& in all address-bearing header lines. The rules are applied to the
20995 header lines just before they are written out at transport time, so they affect
20996 only those copies of the message that pass through the transport. However, only
20997 the message's original header lines, and any that were added by a system
20998 filter, are rewritten. If a router or transport adds header lines, they are not
20999 affected by this option. These rewriting rules are &'not'& applied to the
21000 envelope. You can change the return path using &%return_path%&, but you cannot
21001 change envelope recipients at this time.
21002
21003
21004 .option home_directory transports string&!! unset
21005 .cindex "transport" "home directory for"
21006 .vindex "&$home$&"
21007 This option specifies a home directory setting for a local transport,
21008 overriding any value that may be set by the router. The home directory is
21009 placed in &$home$& while expanding the transport's private options. It is also
21010 used as the current directory if no current directory is set by the
21011 &%current_directory%& option on the transport or the
21012 &%transport_current_directory%& option on the router. If the expansion fails
21013 for any reason, including forced failure, an error is logged, and delivery is
21014 deferred.
21015
21016
21017 .option initgroups transports boolean false
21018 .cindex "additional groups"
21019 .cindex "groups" "additional"
21020 .cindex "transport" "group; additional"
21021 If this option is true and the uid for the delivery process is provided by the
21022 transport, the &[initgroups()]& function is called when running the transport
21023 to ensure that any additional groups associated with the uid are set up.
21024
21025
21026 .option max_parallel transports integer&!! unset
21027 .cindex limit "transport parallelism"
21028 .cindex transport "parallel processes"
21029 .cindex transport "concurrency limit"
21030 .cindex "delivery" "parallelism for transport"
21031 If this option is set and expands to an integer greater than zero
21032 it limits the number of concurrent runs of the transport.
21033 The control does not apply to shadow transports.
21034
21035 .cindex "hints database" "transport concurrency control"
21036 Exim implements this control by means of a hints database in which a record is
21037 incremented whenever a transport process is being created. The record
21038 is decremented and possibly removed when the process terminates.
21039 Obviously there is scope for
21040 records to get left lying around if there is a system or program crash. To
21041 guard against this, Exim ignores any records that are more than six hours old.
21042
21043 If you use this option, you should also arrange to delete the
21044 relevant hints database whenever your system reboots. The names of the files
21045 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21046 may be one or two files, depending on the type of DBM in use. The same files
21047 are used for ETRN and smtp transport serialization.
21048
21049
21050 .option message_size_limit transports string&!! 0
21051 .cindex "limit" "message size per transport"
21052 .cindex "size" "of message, limit"
21053 .cindex "transport" "message size; limiting"
21054 This option controls the size of messages passed through the transport. It is
21055 expanded before use; the result of the expansion must be a sequence of decimal
21056 digits, optionally followed by K or M. If the expansion fails for any reason,
21057 including forced failure, or if the result is not of the required form,
21058 delivery is deferred. If the value is greater than zero and the size of a
21059 message exceeds this limit, the address is failed. If there is any chance that
21060 the resulting bounce message could be routed to the same transport, you should
21061 ensure that &%return_size_limit%& is less than the transport's
21062 &%message_size_limit%&, as otherwise the bounce message will fail to get
21063 delivered.
21064
21065
21066
21067 .option rcpt_include_affixes transports boolean false
21068 .cindex "prefix" "for local part, including in envelope"
21069 .cindex "suffix for local part" "including in envelope"
21070 .cindex "local part" "prefix"
21071 .cindex "local part" "suffix"
21072 When this option is false (the default), and an address that has had any
21073 affixes (prefixes or suffixes) removed from the local part is delivered by any
21074 form of SMTP or LMTP, the affixes are not included. For example, if a router
21075 that contains
21076 .code
21077 local_part_prefix = *-
21078 .endd
21079 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21080 is delivered with
21081 .code
21082 RCPT TO:<xyz@some.domain>
21083 .endd
21084 This is also the case when an ACL-time callout is being used to verify a
21085 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21086 whole local part is included in the RCPT command. This option applies to BSMTP
21087 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21088 &(lmtp)& and &(smtp)& transports.
21089
21090
21091 .option retry_use_local_part transports boolean "see below"
21092 .cindex "hints database" "retry keys"
21093 When a delivery suffers a temporary failure, a retry record is created
21094 in Exim's hints database. For remote deliveries, the key for the retry record
21095 is based on the name and/or IP address of the failing remote host. For local
21096 deliveries, the key is normally the entire address, including both the local
21097 part and the domain. This is suitable for most common cases of local delivery
21098 temporary failure &-- for example, exceeding a mailbox quota should delay only
21099 deliveries to that mailbox, not to the whole domain.
21100
21101 However, in some special cases you may want to treat a temporary local delivery
21102 as a failure associated with the domain, and not with a particular local part.
21103 (For example, if you are storing all mail for some domain in files.) You can do
21104 this by setting &%retry_use_local_part%& false.
21105
21106 For all the local transports, its default value is true. For remote transports,
21107 the default value is false for tidiness, but changing the value has no effect
21108 on a remote transport in the current implementation.
21109
21110
21111 .option return_path transports string&!! unset
21112 .cindex "envelope sender"
21113 .cindex "transport" "return path; changing"
21114 .cindex "return path" "changing in transport"
21115 If this option is set, the string is expanded at transport time and replaces
21116 the existing return path (envelope sender) value in the copy of the message
21117 that is being delivered. An empty return path is permitted. This feature is
21118 designed for remote deliveries, where the value of this option is used in the
21119 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21120 only effect is to change the address that is placed in the &'Return-path:'&
21121 header line, if one is added to the message (see the next option).
21122
21123 &*Note:*& A changed return path is not logged unless you add
21124 &%return_path_on_delivery%& to the log selector.
21125
21126 .vindex "&$return_path$&"
21127 The expansion can refer to the existing value via &$return_path$&. This is
21128 either the message's envelope sender, or an address set by the
21129 &%errors_to%& option on a router. If the expansion is forced to fail, no
21130 replacement occurs; if it fails for another reason, delivery is deferred. This
21131 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21132 section &<<SECTverp>>&.
21133
21134 &*Note*&: If a delivery error is detected locally, including the case when a
21135 remote server rejects a message at SMTP time, the bounce message is not sent to
21136 the value of this option. It is sent to the previously set errors address.
21137 This defaults to the incoming sender address, but can be changed by setting
21138 &%errors_to%& in a router.
21139
21140
21141
21142 .option return_path_add transports boolean false
21143 .cindex "&'Return-path:'& header line"
21144 If this option is true, a &'Return-path:'& header is added to the message.
21145 Although the return path is normally available in the prefix line of BSD
21146 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21147 have easy access to it.
21148
21149 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21150 the delivery SMTP server makes the final delivery"&. This implies that this
21151 header should not be present in incoming messages. Exim has a configuration
21152 option, &%return_path_remove%&, which requests removal of this header from
21153 incoming messages, so that delivered messages can safely be resent to other
21154 recipients.
21155
21156
21157 .option shadow_condition transports string&!! unset
21158 See &%shadow_transport%& below.
21159
21160
21161 .option shadow_transport transports string unset
21162 .cindex "shadow transport"
21163 .cindex "transport" "shadow"
21164 A local transport may set the &%shadow_transport%& option to the name of
21165 another local transport. Shadow remote transports are not supported.
21166
21167 Whenever a delivery to the main transport succeeds, and either
21168 &%shadow_condition%& is unset, or its expansion does not result in the empty
21169 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21170 passed to the shadow transport, with the same delivery address or addresses. If
21171 expansion fails, no action is taken except that non-forced expansion failures
21172 cause a log line to be written.
21173
21174 The result of the shadow transport is discarded and does not affect the
21175 subsequent processing of the message. Only a single level of shadowing is
21176 provided; the &%shadow_transport%& option is ignored on any transport when it
21177 is running as a shadow. Options concerned with output from pipes are also
21178 ignored. The log line for the successful delivery has an item added on the end,
21179 of the form
21180 .code
21181 ST=<shadow transport name>
21182 .endd
21183 If the shadow transport did not succeed, the error message is put in
21184 parentheses afterwards. Shadow transports can be used for a number of different
21185 purposes, including keeping more detailed log information than Exim normally
21186 provides, and implementing automatic acknowledgment policies based on message
21187 headers that some sites insist on.
21188
21189
21190 .option transport_filter transports string&!! unset
21191 .cindex "transport" "filter"
21192 .cindex "filter" "transport filter"
21193 This option sets up a filtering (in the Unix shell sense) process for messages
21194 at transport time. It should not be confused with mail filtering as set up by
21195 individual users or via a system filter.
21196 If unset, or expanding to an empty string, no filtering is done.
21197
21198 When the message is about to be written out, the command specified by
21199 &%transport_filter%& is started up in a separate, parallel process, and
21200 the entire message, including the header lines, is passed to it on its standard
21201 input (this in fact is done from a third process, to avoid deadlock). The
21202 command must be specified as an absolute path.
21203
21204 The lines of the message that are written to the transport filter are
21205 terminated by newline (&"\n"&). The message is passed to the filter before any
21206 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21207 lines beginning with a dot, and also before any processing implied by the
21208 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21209 &(pipe)& transports.
21210
21211 The standard error for the filter process is set to the same destination as its
21212 standard output; this is read and written to the message's ultimate
21213 destination. The process that writes the message to the filter, the
21214 filter itself, and the original process that reads the result and delivers it
21215 are all run in parallel, like a shell pipeline.
21216
21217 The filter can perform any transformations it likes, but of course should take
21218 care not to break RFC 2822 syntax. Exim does not check the result, except to
21219 test for a final newline when SMTP is in use. All messages transmitted over
21220 SMTP must end with a newline, so Exim supplies one if it is missing.
21221
21222 .cindex "content scanning" "per user"
21223 A transport filter can be used to provide content-scanning on a per-user basis
21224 at delivery time if the only required effect of the scan is to modify the
21225 message. For example, a content scan could insert a new header line containing
21226 a spam score. This could be interpreted by a filter in the user's MUA. It is
21227 not possible to discard a message at this stage.
21228
21229 .cindex "SMTP" "SIZE"
21230 A problem might arise if the filter increases the size of a message that is
21231 being sent down an SMTP connection. If the receiving SMTP server has indicated
21232 support for the SIZE parameter, Exim will have sent the size of the message
21233 at the start of the SMTP session. If what is actually sent is substantially
21234 more, the server might reject the message. This can be worked round by setting
21235 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21236 additions to the message, or to disable the use of SIZE altogether.
21237
21238 .vindex "&$pipe_addresses$&"
21239 The value of the &%transport_filter%& option is the command string for starting
21240 the filter, which is run directly from Exim, not under a shell. The string is
21241 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21242 Exim breaks it up into arguments and then expands each argument separately (see
21243 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21244 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21245 of arguments, one for each address that applies to this delivery. (This isn't
21246 an ideal name for this feature here, but as it was already implemented for the
21247 &(pipe)& transport, it seemed sensible not to change it.)
21248
21249 .vindex "&$host$&"
21250 .vindex "&$host_address$&"
21251 The expansion variables &$host$& and &$host_address$& are available when the
21252 transport is a remote one. They contain the name and IP address of the host to
21253 which the message is being sent. For example:
21254 .code
21255 transport_filter = /some/directory/transport-filter.pl \
21256   $host $host_address $sender_address $pipe_addresses
21257 .endd
21258
21259 Two problems arise if you want to use more complicated expansion items to
21260 generate transport filter commands, both of which due to the fact that the
21261 command is split up &'before'& expansion.
21262 .ilist
21263 If an expansion item contains white space, you must quote it, so that it is all
21264 part of the same command item. If the entire option setting is one such
21265 expansion item, you have to take care what kind of quoting you use. For
21266 example:
21267 .code
21268 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21269 .endd
21270 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21271 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21272 stripped by Exim when it read the option's value. When the value is used, if
21273 the single quotes were missing, the line would be split into two items,
21274 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21275 Exim tried to expand the first one.
21276 .next
21277 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21278 expansion cannot generate multiple arguments, or a command name followed by
21279 arguments. Consider this example:
21280 .code
21281 transport_filter = ${lookup{$host}lsearch{/a/file}\
21282                     {$value}{/bin/cat}}
21283 .endd
21284 The result of the lookup is interpreted as the name of the command, even
21285 if it contains white space. The simplest way round this is to use a shell:
21286 .code
21287 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21288                                {$value}{/bin/cat}}
21289 .endd
21290 .endlist
21291
21292 The filter process is run under the same uid and gid as the normal delivery.
21293 For remote deliveries this is the Exim uid/gid by default. The command should
21294 normally yield a zero return code. Transport filters are not supposed to fail.
21295 A non-zero code is taken to mean that the transport filter encountered some
21296 serious problem. Delivery of the message is deferred; the message remains on
21297 the queue and is tried again later. It is not possible to cause a message to be
21298 bounced from a transport filter.
21299
21300 If a transport filter is set on an autoreply transport, the original message is
21301 passed through the filter as it is being copied into the newly generated
21302 message, which happens if the &%return_message%& option is set.
21303
21304
21305 .option transport_filter_timeout transports time 5m
21306 .cindex "transport" "filter, timeout"
21307 When Exim is reading the output of a transport filter, it applies a timeout
21308 that can be set by this option. Exceeding the timeout is normally treated as a
21309 temporary delivery failure. However, if a transport filter is used with a
21310 &(pipe)& transport, a timeout in the transport filter is treated in the same
21311 way as a timeout in the pipe command itself. By default, a timeout is a hard
21312 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21313 becomes a temporary error.
21314
21315
21316 .option user transports string&!! "Exim user"
21317 .cindex "uid (user id)" "local delivery"
21318 .cindex "transport" "user, specifying"
21319 This option specifies the user under whose uid the delivery process is to be
21320 run, overriding any uid that may have been set by the router. If the user is
21321 given as a name, the uid is looked up from the password data, and the
21322 associated group is taken as the value of the gid to be used if the &%group%&
21323 option is not set.
21324
21325 For deliveries that use local transports, a user and group are normally
21326 specified explicitly or implicitly (for example, as a result of
21327 &%check_local_user%&) by the router or transport.
21328
21329 .cindex "hints database" "access by remote transport"
21330 For remote transports, you should leave this option unset unless you really are
21331 sure you know what you are doing. When a remote transport is running, it needs
21332 to be able to access Exim's hints databases, because each host may have its own
21333 retry data.
21334 .ecindex IIDgenoptra1
21335 .ecindex IIDgenoptra2
21336 .ecindex IIDgenoptra3
21337
21338
21339
21340
21341
21342
21343 . ////////////////////////////////////////////////////////////////////////////
21344 . ////////////////////////////////////////////////////////////////////////////
21345
21346 .chapter "Address batching in local transports" "CHAPbatching" &&&
21347          "Address batching"
21348 .cindex "transport" "local; address batching in"
21349 The only remote transport (&(smtp)&) is normally configured to handle more than
21350 one address at a time, so that when several addresses are routed to the same
21351 remote host, just one copy of the message is sent. Local transports, however,
21352 normally handle one address at a time. That is, a separate instance of the
21353 transport is run for each address that is routed to the transport. A separate
21354 copy of the message is delivered each time.
21355
21356 .cindex "batched local delivery"
21357 .oindex "&%batch_max%&"
21358 .oindex "&%batch_id%&"
21359 In special cases, it may be desirable to handle several addresses at once in a
21360 local transport, for example:
21361
21362 .ilist
21363 In an &(appendfile)& transport, when storing messages in files for later
21364 delivery by some other means, a single copy of the message with multiple
21365 recipients saves space.
21366 .next
21367 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21368 a single copy saves time, and is the normal way LMTP is expected to work.
21369 .next
21370 In a &(pipe)& transport, when passing the message
21371 to a scanner program or
21372 to some other delivery mechanism such as UUCP, multiple recipients may be
21373 acceptable.
21374 .endlist
21375
21376 These three local transports all have the same options for controlling multiple
21377 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21378 repeating the information for each transport, these options are described here.
21379
21380 The &%batch_max%& option specifies the maximum number of addresses that can be
21381 delivered together in a single run of the transport. Its default value is one
21382 (no batching). When more than one address is routed to a transport that has a
21383 &%batch_max%& value greater than one, the addresses are delivered in a batch
21384 (that is, in a single run of the transport with multiple recipients), subject
21385 to certain conditions:
21386
21387 .ilist
21388 .vindex "&$local_part$&"
21389 If any of the transport's options contain a reference to &$local_part$&, no
21390 batching is possible.
21391 .next
21392 .vindex "&$domain$&"
21393 If any of the transport's options contain a reference to &$domain$&, only
21394 addresses with the same domain are batched.
21395 .next
21396 .cindex "customizing" "batching condition"
21397 If &%batch_id%& is set, it is expanded for each address, and only those
21398 addresses with the same expanded value are batched. This allows you to specify
21399 customized batching conditions. Failure of the expansion for any reason,
21400 including forced failure, disables batching, but it does not stop the delivery
21401 from taking place.
21402 .next
21403 Batched addresses must also have the same errors address (where to send
21404 delivery errors), the same header additions and removals, the same user and
21405 group for the transport, and if a host list is present, the first host must
21406 be the same.
21407 .endlist
21408
21409 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21410 both when the file or pipe command is specified in the transport, and when it
21411 is specified by a &(redirect)& router, but all the batched addresses must of
21412 course be routed to the same file or pipe command. These two transports have an
21413 option called &%use_bsmtp%&, which causes them to deliver the message in
21414 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21415 &%check_string%& and &%escape_string%& options are forced to the values
21416 .code
21417 check_string = "."
21418 escape_string = ".."
21419 .endd
21420 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21421 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21422 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21423
21424 .cindex "&'Envelope-to:'& header line"
21425 If the generic &%envelope_to_add%& option is set for a batching transport, the
21426 &'Envelope-to:'& header that is added to the message contains all the addresses
21427 that are being processed together. If you are using a batching &(appendfile)&
21428 transport without &%use_bsmtp%&, the only way to preserve the recipient
21429 addresses is to set the &%envelope_to_add%& option.
21430
21431 .cindex "&(pipe)& transport" "with multiple addresses"
21432 .vindex "&$pipe_addresses$&"
21433 If you are using a &(pipe)& transport without BSMTP, and setting the
21434 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21435 the command. This is not a true variable; it is a bit of magic that causes each
21436 of the recipient addresses to be inserted into the command as a separate
21437 argument. This provides a way of accessing all the addresses that are being
21438 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21439 are specified by a &(redirect)& router.
21440
21441
21442
21443
21444 . ////////////////////////////////////////////////////////////////////////////
21445 . ////////////////////////////////////////////////////////////////////////////
21446
21447 .chapter "The appendfile transport" "CHAPappendfile"
21448 .scindex IIDapptra1 "&(appendfile)& transport"
21449 .scindex IIDapptra2 "transports" "&(appendfile)&"
21450 .cindex "directory creation"
21451 .cindex "creating directories"
21452 The &(appendfile)& transport delivers a message by appending it to an existing
21453 file, or by creating an entirely new file in a specified directory. Single
21454 files to which messages are appended can be in the traditional Unix mailbox
21455 format, or optionally in the MBX format supported by the Pine MUA and
21456 University of Washington IMAP daemon, &'inter alia'&. When each message is
21457 being delivered as a separate file, &"maildir"& format can optionally be used
21458 to give added protection against failures that happen part-way through the
21459 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21460 supported. For all file formats, Exim attempts to create as many levels of
21461 directory as necessary, provided that &%create_directory%& is set.
21462
21463 The code for the optional formats is not included in the Exim binary by
21464 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21465 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21466 included.
21467
21468 .cindex "quota" "system"
21469 Exim recognizes system quota errors, and generates an appropriate message. Exim
21470 also supports its own quota control within the transport, for use when the
21471 system facility is unavailable or cannot be used for some reason.
21472
21473 If there is an error while appending to a file (for example, quota exceeded or
21474 partition filled), Exim attempts to reset the file's length and last
21475 modification time back to what they were before. If there is an error while
21476 creating an entirely new file, the new file is removed.
21477
21478 Before appending to a file, a number of security checks are made, and the
21479 file is locked. A detailed description is given below, after the list of
21480 private options.
21481
21482 The &(appendfile)& transport is most commonly used for local deliveries to
21483 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21484 putting messages into files for remote delivery by some means other than Exim.
21485 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21486 option).
21487
21488
21489
21490 .section "The file and directory options" "SECTfildiropt"
21491 The &%file%& option specifies a single file, to which the message is appended;
21492 the &%directory%& option specifies a directory, in which a new file containing
21493 the message is created. Only one of these two options can be set, and for
21494 normal deliveries to mailboxes, one of them &'must'& be set.
21495
21496 .vindex "&$address_file$&"
21497 .vindex "&$local_part$&"
21498 However, &(appendfile)& is also used for delivering messages to files or
21499 directories whose names (or parts of names) are obtained from alias,
21500 forwarding, or filtering operations (for example, a &%save%& command in a
21501 user's Exim filter). When such a transport is running, &$local_part$& contains
21502 the local part that was aliased or forwarded, and &$address_file$& contains the
21503 name (or partial name) of the file or directory generated by the redirection
21504 operation. There are two cases:
21505
21506 .ilist
21507 If neither &%file%& nor &%directory%& is set, the redirection operation
21508 must specify an absolute path (one that begins with &`/`&). This is the most
21509 common case when users with local accounts use filtering to sort mail into
21510 different folders. See for example, the &(address_file)& transport in the
21511 default configuration. If the path ends with a slash, it is assumed to be the
21512 name of a directory. A delivery to a directory can also be forced by setting
21513 &%maildir_format%& or &%mailstore_format%&.
21514 .next
21515 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21516 used to determine the file or directory name for the delivery. Normally, the
21517 contents of &$address_file$& are used in some way in the string expansion.
21518 .endlist
21519
21520
21521 .cindex "Sieve filter" "configuring &(appendfile)&"
21522 .cindex "Sieve filter" "relative mailbox path handling"
21523 As an example of the second case, consider an environment where users do not
21524 have home directories. They may be permitted to use Exim filter commands of the
21525 form:
21526 .code
21527 save folder23
21528 .endd
21529 or Sieve filter commands of the form:
21530 .code
21531 require "fileinto";
21532 fileinto "folder23";
21533 .endd
21534 In this situation, the expansion of &%file%& or &%directory%& in the transport
21535 must transform the relative path into an appropriate absolute file name. In the
21536 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21537 is used as a result of a &"keep"& action in the filter. This example shows one
21538 way of handling this requirement:
21539 .code
21540 file = ${if eq{$address_file}{inbox} \
21541             {/var/mail/$local_part} \
21542             {${if eq{${substr_0_1:$address_file}}{/} \
21543                   {$address_file} \
21544                   {$home/mail/$address_file} \
21545             }} \
21546        }
21547 .endd
21548 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21549 location, absolute paths are used without change, and other folders are in the
21550 &_mail_& directory within the home directory.
21551
21552 &*Note 1*&: While processing an Exim filter, a relative path such as
21553 &_folder23_& is turned into an absolute path if a home directory is known to
21554 the router. In particular, this is the case if &%check_local_user%& is set. If
21555 you want to prevent this happening at routing time, you can set
21556 &%router_home_directory%& empty. This forces the router to pass the relative
21557 path to the transport.
21558
21559 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21560 the &%file%& or &%directory%& option is still used if it is set.
21561
21562
21563
21564
21565 .section "Private options for appendfile" "SECID134"
21566 .cindex "options" "&(appendfile)& transport"
21567
21568
21569
21570 .option allow_fifo appendfile boolean false
21571 .cindex "fifo (named pipe)"
21572 .cindex "named pipe (fifo)"
21573 .cindex "pipe" "named (fifo)"
21574 Setting this option permits delivery to named pipes (FIFOs) as well as to
21575 regular files. If no process is reading the named pipe at delivery time, the
21576 delivery is deferred.
21577
21578
21579 .option allow_symlink appendfile boolean false
21580 .cindex "symbolic link" "to mailbox"
21581 .cindex "mailbox" "symbolic link"
21582 By default, &(appendfile)& will not deliver if the path name for the file is
21583 that of a symbolic link. Setting this option relaxes that constraint, but there
21584 are security issues involved in the use of symbolic links. Be sure you know
21585 what you are doing if you set this. Details of exactly what this option affects
21586 are included in the discussion which follows this list of options.
21587
21588
21589 .option batch_id appendfile string&!! unset
21590 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21591 However, batching is automatically disabled for &(appendfile)& deliveries that
21592 happen as a result of forwarding or aliasing or other redirection directly to a
21593 file.
21594
21595
21596 .option batch_max appendfile integer 1
21597 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21598
21599
21600 .option check_group appendfile boolean false
21601 When this option is set, the group owner of the file defined by the &%file%&
21602 option is checked to see that it is the same as the group under which the
21603 delivery process is running. The default setting is false because the default
21604 file mode is 0600, which means that the group is irrelevant.
21605
21606
21607 .option check_owner appendfile boolean true
21608 When this option is set, the owner of the file defined by the &%file%& option
21609 is checked to ensure that it is the same as the user under which the delivery
21610 process is running.
21611
21612
21613 .option check_string appendfile string "see below"
21614 .cindex "&""From""& line"
21615 As &(appendfile)& writes the message, the start of each line is tested for
21616 matching &%check_string%&, and if it does, the initial matching characters are
21617 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21618 a literal string, not a regular expression, and the case of any letters it
21619 contains is significant.
21620
21621 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21622 are forced to &"."& and &".."& respectively, and any settings in the
21623 configuration are ignored. Otherwise, they default to &"From&~"& and
21624 &">From&~"& when the &%file%& option is set, and unset when any of the
21625 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21626
21627 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21628 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21629 &"From&~"& indicates the start of a new message. All four options need changing
21630 if another format is used. For example, to deliver to mailboxes in MMDF format:
21631 .cindex "MMDF format mailbox"
21632 .cindex "mailbox" "MMDF format"
21633 .code
21634 check_string = "\1\1\1\1\n"
21635 escape_string = "\1\1\1\1 \n"
21636 message_prefix = "\1\1\1\1\n"
21637 message_suffix = "\1\1\1\1\n"
21638 .endd
21639 .option create_directory appendfile boolean true
21640 .cindex "directory creation"
21641 When this option is true, Exim attempts to create any missing superior
21642 directories for the file that it is about to write. A created directory's mode
21643 is given by the &%directory_mode%& option.
21644
21645 The group ownership of a newly created directory is highly dependent on the
21646 operating system (and possibly the file system) that is being used. For
21647 example, in Solaris, if the parent directory has the setgid bit set, its group
21648 is propagated to the child; if not, the currently set group is used. However,
21649 in FreeBSD, the parent's group is always used.
21650
21651
21652
21653 .option create_file appendfile string anywhere
21654 This option constrains the location of files and directories that are created
21655 by this transport. It applies to files defined by the &%file%& option and
21656 directories defined by the &%directory%& option. In the case of maildir
21657 delivery, it applies to the top level directory, not the maildir directories
21658 beneath.
21659
21660 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21661 &"belowhome"&. In the second and third cases, a home directory must have been
21662 set for the transport. This option is not useful when an explicit file name is
21663 given for normal mailbox deliveries. It is intended for the case when file
21664 names are generated from users' &_.forward_& files. These are usually handled
21665 by an &(appendfile)& transport called &%address_file%&. See also
21666 &%file_must_exist%&.
21667
21668
21669 .option directory appendfile string&!! unset
21670 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21671 or &%directory%& must be set, unless the delivery is the direct result of a
21672 redirection (see section &<<SECTfildiropt>>&).
21673
21674 When &%directory%& is set, the string is expanded, and the message is delivered
21675 into a new file or files in or below the given directory, instead of being
21676 appended to a single mailbox file. A number of different formats are provided
21677 (see &%maildir_format%& and &%mailstore_format%&), and see section
21678 &<<SECTopdir>>& for further details of this form of delivery.
21679
21680
21681 .option directory_file appendfile string&!! "see below"
21682 .cindex "base62"
21683 .vindex "&$inode$&"
21684 When &%directory%& is set, but neither &%maildir_format%& nor
21685 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21686 whose name is obtained by expanding this string. The default value is:
21687 .code
21688 q${base62:$tod_epoch}-$inode
21689 .endd
21690 This generates a unique name from the current time, in base 62 form, and the
21691 inode of the file. The variable &$inode$& is available only when expanding this
21692 option.
21693
21694
21695 .option directory_mode appendfile "octal integer" 0700
21696 If &(appendfile)& creates any directories as a result of the
21697 &%create_directory%& option, their mode is specified by this option.
21698
21699
21700 .option escape_string appendfile string "see description"
21701 See &%check_string%& above.
21702
21703
21704 .option file appendfile string&!! unset
21705 This option is mutually exclusive with the &%directory%& option, but one of
21706 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21707 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21708 specifies a single file, to which the message is appended. One or more of
21709 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21710 &%file%&.
21711
21712 .cindex "NFS" "lock file"
21713 .cindex "locking files"
21714 .cindex "lock files"
21715 If you are using more than one host to deliver over NFS into the same
21716 mailboxes, you should always use lock files.
21717
21718 The string value is expanded for each delivery, and must yield an absolute
21719 path. The most common settings of this option are variations on one of these
21720 examples:
21721 .code
21722 file = /var/spool/mail/$local_part
21723 file = /home/$local_part/inbox
21724 file = $home/inbox
21725 .endd
21726 .cindex "&""sticky""& bit"
21727 In the first example, all deliveries are done into the same directory. If Exim
21728 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21729 create a file in the directory, so the &"sticky"& bit must be turned on for
21730 deliveries to be possible, or alternatively the &%group%& option can be used to
21731 run the delivery under a group id which has write access to the directory.
21732
21733
21734
21735 .option file_format appendfile string unset
21736 .cindex "file" "mailbox; checking existing format"
21737 This option requests the transport to check the format of an existing file
21738 before adding to it. The check consists of matching a specific string at the
21739 start of the file. The value of the option consists of an even number of
21740 colon-separated strings. The first of each pair is the test string, and the
21741 second is the name of a transport. If the transport associated with a matched
21742 string is not the current transport, control is passed over to the other
21743 transport. For example, suppose the standard &(local_delivery)& transport has
21744 this added to it:
21745 .code
21746 file_format = "From       : local_delivery :\
21747                \1\1\1\1\n : local_mmdf_delivery"
21748 .endd
21749 Mailboxes that begin with &"From"& are still handled by this transport, but if
21750 a mailbox begins with four binary ones followed by a newline, control is passed
21751 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21752 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21753 is assumed to match the current transport. If the start of a mailbox doesn't
21754 match any string, or if the transport named for a given string is not defined,
21755 delivery is deferred.
21756
21757
21758 .option file_must_exist appendfile boolean false
21759 If this option is true, the file specified by the &%file%& option must exist.
21760 A temporary error occurs if it does not, causing delivery to be deferred.
21761 If this option is false, the file is created if it does not exist.
21762
21763
21764 .option lock_fcntl_timeout appendfile time 0s
21765 .cindex "timeout" "mailbox locking"
21766 .cindex "mailbox" "locking, blocking and non-blocking"
21767 .cindex "locking files"
21768 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21769 when locking an open mailbox file. If the call fails, the delivery process
21770 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21771 Non-blocking calls are used so that the file is not kept open during the wait
21772 for the lock; the reason for this is to make it as safe as possible for
21773 deliveries over NFS in the case when processes might be accessing an NFS
21774 mailbox without using a lock file. This should not be done, but
21775 misunderstandings and hence misconfigurations are not unknown.
21776
21777 On a busy system, however, the performance of a non-blocking lock approach is
21778 not as good as using a blocking lock with a timeout. In this case, the waiting
21779 is done inside the system call, and Exim's delivery process acquires the lock
21780 and can proceed as soon as the previous lock holder releases it.
21781
21782 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21783 timeout, are used. There may still be some retrying: the maximum number of
21784 retries is
21785 .code
21786 (lock_retries * lock_interval) / lock_fcntl_timeout
21787 .endd
21788 rounded up to the next whole number. In other words, the total time during
21789 which &(appendfile)& is trying to get a lock is roughly the same, unless
21790 &%lock_fcntl_timeout%& is set very large.
21791
21792 You should consider setting this option if you are getting a lot of delayed
21793 local deliveries because of errors of the form
21794 .code
21795 failed to lock mailbox /some/file (fcntl)
21796 .endd
21797
21798 .option lock_flock_timeout appendfile time 0s
21799 This timeout applies to file locking when using &[flock()]& (see
21800 &%use_flock%&); the timeout operates in a similar manner to
21801 &%lock_fcntl_timeout%&.
21802
21803
21804 .option lock_interval appendfile time 3s
21805 This specifies the time to wait between attempts to lock the file. See below
21806 for details of locking.
21807
21808
21809 .option lock_retries appendfile integer 10
21810 This specifies the maximum number of attempts to lock the file. A value of zero
21811 is treated as 1. See below for details of locking.
21812
21813
21814 .option lockfile_mode appendfile "octal integer" 0600
21815 This specifies the mode of the created lock file, when a lock file is being
21816 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21817
21818
21819 .option lockfile_timeout appendfile time 30m
21820 .cindex "timeout" "mailbox locking"
21821 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21822 exists and is older than this value, it is assumed to have been left behind by
21823 accident, and Exim attempts to remove it.
21824
21825
21826 .option mailbox_filecount appendfile string&!! unset
21827 .cindex "mailbox" "specifying size of"
21828 .cindex "size" "of mailbox"
21829 If this option is set, it is expanded, and the result is taken as the current
21830 number of files in the mailbox. It must be a decimal number, optionally
21831 followed by K or M. This provides a way of obtaining this information from an
21832 external source that maintains the data.
21833
21834
21835 .option mailbox_size appendfile string&!! unset
21836 .cindex "mailbox" "specifying size of"
21837 .cindex "size" "of mailbox"
21838 If this option is set, it is expanded, and the result is taken as the current
21839 size the mailbox. It must be a decimal number, optionally followed by K or M.
21840 This provides a way of obtaining this information from an external source that
21841 maintains the data. This is likely to be helpful for maildir deliveries where
21842 it is computationally expensive to compute the size of a mailbox.
21843
21844
21845
21846 .option maildir_format appendfile boolean false
21847 .cindex "maildir format" "specifying"
21848 If this option is set with the &%directory%& option, the delivery is into a new
21849 file, in the &"maildir"& format that is used by other mail software. When the
21850 transport is activated directly from a &(redirect)& router (for example, the
21851 &(address_file)& transport in the default configuration), setting
21852 &%maildir_format%& causes the path received from the router to be treated as a
21853 directory, whether or not it ends with &`/`&. This option is available only if
21854 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21855 &<<SECTmaildirdelivery>>& below for further details.
21856
21857
21858 .option maildir_quota_directory_regex appendfile string "See below"
21859 .cindex "maildir format" "quota; directories included in"
21860 .cindex "quota" "maildir; directories included in"
21861 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21862 a regular expression for specifying directories, relative to the quota
21863 directory (see &%quota_directory%&), that should be included in the quota
21864 calculation. The default value is:
21865 .code
21866 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21867 .endd
21868 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21869 (directories whose names begin with a dot). If you want to exclude the
21870 &_Trash_&
21871 folder from the count (as some sites do), you need to change this setting to
21872 .code
21873 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21874 .endd
21875 This uses a negative lookahead in the regular expression to exclude the
21876 directory whose name is &_.Trash_&. When a directory is excluded from quota
21877 calculations, quota processing is bypassed for any messages that are delivered
21878 directly into that directory.
21879
21880
21881 .option maildir_retries appendfile integer 10
21882 This option specifies the number of times to retry when writing a file in
21883 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21884
21885
21886 .option maildir_tag appendfile string&!! unset
21887 This option applies only to deliveries in maildir format, and is described in
21888 section &<<SECTmaildirdelivery>>& below.
21889
21890
21891 .option maildir_use_size_file appendfile&!! boolean false
21892 .cindex "maildir format" "&_maildirsize_& file"
21893 The result of string expansion for this option must be a valid boolean value.
21894 If it is true, it enables support for &_maildirsize_& files. Exim
21895 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21896 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21897 value is zero. See &%maildir_quota_directory_regex%& above and section
21898 &<<SECTmaildirdelivery>>& below for further details.
21899
21900 .option maildirfolder_create_regex appendfile string unset
21901 .cindex "maildir format" "&_maildirfolder_& file"
21902 .cindex "&_maildirfolder_&, creating"
21903 The value of this option is a regular expression. If it is unset, it has no
21904 effect. Otherwise, before a maildir delivery takes place, the pattern is
21905 matched against the name of the maildir directory, that is, the directory
21906 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21907 delivery. If there is a match, Exim checks for the existence of a file called
21908 &_maildirfolder_& in the directory, and creates it if it does not exist.
21909 See section &<<SECTmaildirdelivery>>& for more details.
21910
21911
21912 .option mailstore_format appendfile boolean false
21913 .cindex "mailstore format" "specifying"
21914 If this option is set with the &%directory%& option, the delivery is into two
21915 new files in  &"mailstore"& format. The option is available only if
21916 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21917 below for further details.
21918
21919
21920 .option mailstore_prefix appendfile string&!! unset
21921 This option applies only to deliveries in mailstore format, and is described in
21922 section &<<SECTopdir>>& below.
21923
21924
21925 .option mailstore_suffix appendfile string&!! unset
21926 This option applies only to deliveries in mailstore format, and is described in
21927 section &<<SECTopdir>>& below.
21928
21929
21930 .option mbx_format appendfile boolean false
21931 .cindex "locking files"
21932 .cindex "file" "locking"
21933 .cindex "file" "MBX format"
21934 .cindex "MBX format, specifying"
21935 This option is available only if Exim has been compiled with SUPPORT_MBX
21936 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21937 the message is appended to the mailbox file in MBX format instead of
21938 traditional Unix format. This format is supported by Pine4 and its associated
21939 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21940
21941 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21942 automatically changed by the use of &%mbx_format%&. They should normally be set
21943 empty when using MBX format, so this option almost always appears in this
21944 combination:
21945 .code
21946 mbx_format = true
21947 message_prefix =
21948 message_suffix =
21949 .endd
21950 If none of the locking options are mentioned in the configuration,
21951 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21952 is possible to specify the other kinds of locking with &%mbx_format%&, but
21953 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21954 interworks with &'c-client'&, providing for shared access to the mailbox. It
21955 should not be used if any program that does not use this form of locking is
21956 going to access the mailbox, nor should it be used if the mailbox file is NFS
21957 mounted, because it works only when the mailbox is accessed from a single host.
21958
21959 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21960 the standard version of &'c-client'&, because as long as it has a mailbox open
21961 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21962 append messages to it.
21963
21964
21965 .option message_prefix appendfile string&!! "see below"
21966 .cindex "&""From""& line"
21967 The string specified here is expanded and output at the start of every message.
21968 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21969 in which case it is:
21970 .code
21971 message_prefix = "From ${if def:return_path{$return_path}\
21972   {MAILER-DAEMON}} $tod_bsdinbox\n"
21973 .endd
21974 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21975 &`\n`& to &`\r\n`& in &%message_prefix%&.
21976
21977 .option message_suffix appendfile string&!! "see below"
21978 The string specified here is expanded and output at the end of every message.
21979 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21980 in which case it is a single newline character. The suffix can be suppressed by
21981 setting
21982 .code
21983 message_suffix =
21984 .endd
21985 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21986 &`\n`& to &`\r\n`& in &%message_suffix%&.
21987
21988 .option mode appendfile "octal integer" 0600
21989 If the output file is created, it is given this mode. If it already exists and
21990 has wider permissions, they are reduced to this mode. If it has narrower
21991 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21992 if the delivery is the result of a &%save%& command in a filter file specifying
21993 a particular mode, the mode of the output file is always forced to take that
21994 value, and this option is ignored.
21995
21996
21997 .option mode_fail_narrower appendfile boolean true
21998 This option applies in the case when an existing mailbox file has a narrower
21999 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22000 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22001 continues with the delivery attempt, using the existing mode of the file.
22002
22003
22004 .option notify_comsat appendfile boolean false
22005 If this option is true, the &'comsat'& daemon is notified after every
22006 successful delivery to a user mailbox. This is the daemon that notifies logged
22007 on users about incoming mail.
22008
22009
22010 .option quota appendfile string&!! unset
22011 .cindex "quota" "imposed by Exim"
22012 This option imposes a limit on the size of the file to which Exim is appending,
22013 or to the total space used in the directory tree when the &%directory%& option
22014 is set. In the latter case, computation of the space used is expensive, because
22015 all the files in the directory (and any sub-directories) have to be
22016 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22017 &%maildir_use_size_file%& for ways to avoid this in environments where users
22018 have no shell access to their mailboxes).
22019
22020 As there is no interlock against two simultaneous deliveries into a
22021 multi-file mailbox, it is possible for the quota to be overrun in this case.
22022 For single-file mailboxes, of course, an interlock is a necessity.
22023
22024 A file's size is taken as its &'used'& value. Because of blocking effects, this
22025 may be a lot less than the actual amount of disk space allocated to the file.
22026 If the sizes of a number of files are being added up, the rounding effect can
22027 become quite noticeable, especially on systems that have large block sizes.
22028 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22029 the obvious value which users understand most easily.
22030
22031 The value of the option is expanded, and must then be a numerical value
22032 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22033 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
22034 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22035 be handled.
22036
22037 &*Note*&: A value of zero is interpreted as &"no quota"&.
22038
22039 The expansion happens while Exim is running as root, before it changes uid for
22040 the delivery. This means that files that are inaccessible to the end user can
22041 be used to hold quota values that are looked up in the expansion. When delivery
22042 fails because this quota is exceeded, the handling of the error is as for
22043 system quota failures.
22044
22045 By default, Exim's quota checking mimics system quotas, and restricts the
22046 mailbox to the specified maximum size, though the value is not accurate to the
22047 last byte, owing to separator lines and additional headers that may get added
22048 during message delivery. When a mailbox is nearly full, large messages may get
22049 refused even though small ones are accepted, because the size of the current
22050 message is added to the quota when the check is made. This behaviour can be
22051 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22052 for exceeding the quota does not include the current message. Thus, deliveries
22053 continue until the quota has been exceeded; thereafter, no further messages are
22054 delivered. See also &%quota_warn_threshold%&.
22055
22056
22057 .option quota_directory appendfile string&!! unset
22058 This option defines the directory to check for quota purposes when delivering
22059 into individual files. The default is the delivery directory, or, if a file
22060 called &_maildirfolder_& exists in a maildir directory, the parent of the
22061 delivery directory.
22062
22063
22064 .option quota_filecount appendfile string&!! 0
22065 This option applies when the &%directory%& option is set. It limits the total
22066 number of files in the directory (compare the inode limit in system quotas). It
22067 can only be used if &%quota%& is also set. The value is expanded; an expansion
22068 failure causes delivery to be deferred. A value of zero is interpreted as
22069 &"no quota"&.
22070
22071
22072 .option quota_is_inclusive appendfile boolean true
22073 See &%quota%& above.
22074
22075
22076 .option quota_size_regex appendfile string unset
22077 This option applies when one of the delivery modes that writes a separate file
22078 for each message is being used. When Exim wants to find the size of one of
22079 these files in order to test the quota, it first checks &%quota_size_regex%&.
22080 If this is set to a regular expression that matches the file name, and it
22081 captures one string, that string is interpreted as a representation of the
22082 file's size. The value of &%quota_size_regex%& is not expanded.
22083
22084 This feature is useful only when users have no shell access to their mailboxes
22085 &-- otherwise they could defeat the quota simply by renaming the files. This
22086 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22087 the file length to the file name. For example:
22088 .code
22089 maildir_tag = ,S=$message_size
22090 quota_size_regex = ,S=(\d+)
22091 .endd
22092 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22093 number of lines in the message.
22094
22095 The regular expression should not assume that the length is at the end of the
22096 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22097 sometimes add other information onto the ends of message file names.
22098
22099 Section &<<SECID136>>& contains further information.
22100
22101
22102 .option quota_warn_message appendfile string&!! "see below"
22103 See below for the use of this option. If it is not set when
22104 &%quota_warn_threshold%& is set, it defaults to
22105 .code
22106 quota_warn_message = "\
22107   To: $local_part@$domain\n\
22108   Subject: Your mailbox\n\n\
22109   This message is automatically created \
22110   by mail delivery software.\n\n\
22111   The size of your mailbox has exceeded \
22112   a warning threshold that is\n\
22113   set by the system administrator.\n"
22114 .endd
22115
22116
22117 .option quota_warn_threshold appendfile string&!! 0
22118 .cindex "quota" "warning threshold"
22119 .cindex "mailbox" "size warning"
22120 .cindex "size" "of mailbox"
22121 This option is expanded in the same way as &%quota%& (see above). If the
22122 resulting value is greater than zero, and delivery of the message causes the
22123 size of the file or total space in the directory tree to cross the given
22124 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22125 may be specified as a percentage of it by following the value with a percent
22126 sign. For example:
22127 .code
22128 quota = 10M
22129 quota_warn_threshold = 75%
22130 .endd
22131 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22132 percent sign is ignored.
22133
22134 The warning message itself is specified by the &%quota_warn_message%& option,
22135 and it must start with a &'To:'& header line containing the recipient(s) of the
22136 warning message. These do not necessarily have to include the recipient(s) of
22137 the original message. A &'Subject:'& line should also normally be supplied. You
22138 can include any other header lines that you want. If you do not include a
22139 &'From:'& line, the default is:
22140 .code
22141 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22142 .endd
22143 .oindex &%errors_reply_to%&
22144 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22145 option.
22146
22147 The &%quota%& option does not have to be set in order to use this option; they
22148 are independent of one another except when the threshold is specified as a
22149 percentage.
22150
22151
22152 .option use_bsmtp appendfile boolean false
22153 .cindex "envelope sender"
22154 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22155 format, with the envelope sender and recipient(s) included as SMTP commands. If
22156 you want to include a leading HELO command with such messages, you can do
22157 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22158 for details of batch SMTP.
22159
22160
22161 .option use_crlf appendfile boolean false
22162 .cindex "carriage return"
22163 .cindex "linefeed"
22164 This option causes lines to be terminated with the two-character CRLF sequence
22165 (carriage return, linefeed) instead of just a linefeed character. In the case
22166 of batched SMTP, the byte sequence written to the file is then an exact image
22167 of what would be sent down a real SMTP connection.
22168
22169 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22170 (which are used to supply the traditional &"From&~"& and blank line separators
22171 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22172 carriage return characters if these are needed. In cases where these options
22173 have non-empty defaults, the values end with a single linefeed, so they must be
22174 changed to end with &`\r\n`& if &%use_crlf%& is set.
22175
22176
22177 .option use_fcntl_lock appendfile boolean "see below"
22178 This option controls the use of the &[fcntl()]& function to lock a file for
22179 exclusive use when a message is being appended. It is set by default unless
22180 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22181 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22182 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22183
22184
22185 .option use_flock_lock appendfile boolean false
22186 This option is provided to support the use of &[flock()]& for file locking, for
22187 the few situations where it is needed. Most modern operating systems support
22188 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22189 each other. Exim uses &[fcntl()]& locking by default.
22190
22191 This option is required only if you are using an operating system where
22192 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22193 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22194 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22195
22196 .cindex "Solaris" "&[flock()]& support"
22197 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22198 have it (and some, I think, provide a not quite right version built on top of
22199 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22200 the ability to use it, and any attempt to do so will cause a configuration
22201 error.
22202
22203 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22204 is just being mapped onto &[fcntl()]& by the OS).
22205
22206
22207 .option use_lockfile appendfile boolean "see below"
22208 If this option is turned off, Exim does not attempt to create a lock file when
22209 appending to a mailbox file. In this situation, the only locking is by
22210 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22211 sure that every MUA that is ever going to look at your users' mailboxes uses
22212 &[fcntl()]& rather than a lock file, and even then only when you are not
22213 delivering over NFS from more than one host.
22214
22215 .cindex "NFS" "lock file"
22216 In order to append to an NFS file safely from more than one host, it is
22217 necessary to take out a lock &'before'& opening the file, and the lock file
22218 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22219 file corruption.
22220
22221 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22222 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22223 except when &%mbx_format%& is set.
22224
22225
22226 .option use_mbx_lock appendfile boolean "see below"
22227 This option is available only if Exim has been compiled with SUPPORT_MBX
22228 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22229 locking rules be used. It is set by default if &%mbx_format%& is set and none
22230 of the locking options are mentioned in the configuration. The locking rules
22231 are the same as are used by the &'c-client'& library that underlies Pine and
22232 the IMAP4 and POP daemons that come with it (see the discussion below). The
22233 rules allow for shared access to the mailbox. However, this kind of locking
22234 does not work when the mailbox is NFS mounted.
22235
22236 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22237 &%use_flock_lock%& to control what kind of locking is used in implementing the
22238 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22239 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22240
22241
22242
22243
22244 .section "Operational details for appending" "SECTopappend"
22245 .cindex "appending to a file"
22246 .cindex "file" "appending"
22247 Before appending to a file, the following preparations are made:
22248
22249 .ilist
22250 If the name of the file is &_/dev/null_&, no action is taken, and a success
22251 return is given.
22252
22253 .next
22254 .cindex "directory creation"
22255 If any directories on the file's path are missing, Exim creates them if the
22256 &%create_directory%& option is set. A created directory's mode is given by the
22257 &%directory_mode%& option.
22258
22259 .next
22260 If &%file_format%& is set, the format of an existing file is checked. If this
22261 indicates that a different transport should be used, control is passed to that
22262 transport.
22263
22264 .next
22265 .cindex "file" "locking"
22266 .cindex "locking files"
22267 .cindex "NFS" "lock file"
22268 If &%use_lockfile%& is set, a lock file is built in a way that will work
22269 reliably over NFS, as follows:
22270
22271 .olist
22272 Create a &"hitching post"& file whose name is that of the lock file with the
22273 current time, primary host name, and process id added, by opening for writing
22274 as a new file. If this fails with an access error, delivery is deferred.
22275 .next
22276 Close the hitching post file, and hard link it to the lock file name.
22277 .next
22278 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22279 Unlink the hitching post name.
22280 .next
22281 Otherwise, use &[stat()]& to get information about the hitching post file, and
22282 then unlink hitching post name. If the number of links is exactly two, creation
22283 of the lock file succeeded but something (for example, an NFS server crash and
22284 restart) caused this fact not to be communicated to the &[link()]& call.
22285 .next
22286 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22287 up to &%lock_retries%& times. However, since any program that writes to a
22288 mailbox should complete its task very quickly, it is reasonable to time out old
22289 lock files that are normally the result of user agent and system crashes. If an
22290 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22291 it before trying again.
22292 .endlist olist
22293
22294 .next
22295 A call is made to &[lstat()]& to discover whether the main file exists, and if
22296 so, what its characteristics are. If &[lstat()]& fails for any reason other
22297 than non-existence, delivery is deferred.
22298
22299 .next
22300 .cindex "symbolic link" "to mailbox"
22301 .cindex "mailbox" "symbolic link"
22302 If the file does exist and is a symbolic link, delivery is deferred, unless the
22303 &%allow_symlink%& option is set, in which case the ownership of the link is
22304 checked, and then &[stat()]& is called to find out about the real file, which
22305 is then subjected to the checks below. The check on the top-level link
22306 ownership prevents one user creating a link for another's mailbox in a sticky
22307 directory, though allowing symbolic links in this case is definitely not a good
22308 idea. If there is a chain of symbolic links, the intermediate ones are not
22309 checked.
22310
22311 .next
22312 If the file already exists but is not a regular file, or if the file's owner
22313 and group (if the group is being checked &-- see &%check_group%& above) are
22314 different from the user and group under which the delivery is running,
22315 delivery is deferred.
22316
22317 .next
22318 If the file's permissions are more generous than specified, they are reduced.
22319 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22320 is set false, in which case the delivery is tried using the existing
22321 permissions.
22322
22323 .next
22324 The file's inode number is saved, and the file is then opened for appending.
22325 If this fails because the file has vanished, &(appendfile)& behaves as if it
22326 hadn't existed (see below). For any other failures, delivery is deferred.
22327
22328 .next
22329 If the file is opened successfully, check that the inode number hasn't
22330 changed, that it is still a regular file, and that the owner and permissions
22331 have not changed. If anything is wrong, defer delivery and freeze the message.
22332
22333 .next
22334 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22335 option is set. Otherwise, check that the file is being created in a permitted
22336 directory if the &%create_file%& option is set (deferring on failure), and then
22337 open for writing as a new file, with the O_EXCL and O_CREAT options,
22338 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22339 set). In this case, which can happen if the link points to a non-existent file,
22340 the file is opened for writing using O_CREAT but not O_EXCL, because
22341 that prevents link following.
22342
22343 .next
22344 .cindex "loop" "while file testing"
22345 If opening fails because the file exists, obey the tests given above for
22346 existing files. However, to avoid looping in a situation where the file is
22347 being continuously created and destroyed, the exists/not-exists loop is broken
22348 after 10 repetitions, and the message is then frozen.
22349
22350 .next
22351 If opening fails with any other error, defer delivery.
22352
22353 .next
22354 .cindex "file" "locking"
22355 .cindex "locking files"
22356 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22357 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22358 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22359 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22360 file, and an exclusive lock on the file whose name is
22361 .code
22362 /tmp/.<device-number>.<inode-number>
22363 .endd
22364 using the device and inode numbers of the open mailbox file, in accordance with
22365 the MBX locking rules. This file is created with a mode that is specified by
22366 the &%lockfile_mode%& option.
22367
22368 If Exim fails to lock the file, there are two possible courses of action,
22369 depending on the value of the locking timeout. This is obtained from
22370 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22371
22372 If the timeout value is zero, the file is closed, Exim waits for
22373 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22374 to lock it again. This happens up to &%lock_retries%& times, after which the
22375 delivery is deferred.
22376
22377 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22378 &[flock()]& are used (with the given timeout), so there has already been some
22379 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22380 immediately. It retries up to
22381 .code
22382 (lock_retries * lock_interval) / <timeout>
22383 .endd
22384 times (rounded up).
22385 .endlist
22386
22387 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22388 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22389
22390
22391 .section "Operational details for delivery to a new file" "SECTopdir"
22392 .cindex "delivery" "to single file"
22393 .cindex "&""From""& line"
22394 When the &%directory%& option is set instead of &%file%&, each message is
22395 delivered into a newly-created file or set of files. When &(appendfile)& is
22396 activated directly from a &(redirect)& router, neither &%file%& nor
22397 &%directory%& is normally set, because the path for delivery is supplied by the
22398 router. (See for example, the &(address_file)& transport in the default
22399 configuration.) In this case, delivery is to a new file if either the path name
22400 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22401
22402 No locking is required while writing the message to a new file, so the various
22403 locking options of the transport are ignored. The &"From"& line that by default
22404 separates messages in a single file is not normally needed, nor is the escaping
22405 of message lines that start with &"From"&, and there is no need to ensure a
22406 newline at the end of each message. Consequently, the default values for
22407 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22408 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22409
22410 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22411 the files in the delivery directory by default. However, you can specify a
22412 different directory by setting &%quota_directory%&. Also, for maildir
22413 deliveries (see below) the &_maildirfolder_& convention is honoured.
22414
22415
22416 .cindex "maildir format"
22417 .cindex "mailstore format"
22418 There are three different ways in which delivery to individual files can be
22419 done, controlled by the settings of the &%maildir_format%& and
22420 &%mailstore_format%& options. Note that code to support maildir or mailstore
22421 formats is not included in the binary unless SUPPORT_MAILDIR or
22422 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22423
22424 .cindex "directory creation"
22425 In all three cases an attempt is made to create the directory and any necessary
22426 sub-directories if they do not exist, provided that the &%create_directory%&
22427 option is set (the default). The location of a created directory can be
22428 constrained by setting &%create_file%&. A created directory's mode is given by
22429 the &%directory_mode%& option. If creation fails, or if the
22430 &%create_directory%& option is not set when creation is required, delivery is
22431 deferred.
22432
22433
22434
22435 .section "Maildir delivery" "SECTmaildirdelivery"
22436 .cindex "maildir format" "description of"
22437 If the &%maildir_format%& option is true, Exim delivers each message by writing
22438 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22439 directory that is defined by the &%directory%& option (the &"delivery
22440 directory"&). If the delivery is successful, the file is renamed into the
22441 &_new_& subdirectory.
22442
22443 In the file name, <&'stime'&> is the current time of day in seconds, and
22444 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22445 Exim checks that the time-of-day clock has moved on by at least one microsecond
22446 before terminating the delivery process. This guarantees uniqueness for the
22447 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22448 opening it. If any response other than ENOENT (does not exist) is given,
22449 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22450
22451 Before Exim carries out a maildir delivery, it ensures that subdirectories
22452 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22453 do not exist, Exim tries to create them and any superior directories in their
22454 path, subject to the &%create_directory%& and &%create_file%& options. If the
22455 &%maildirfolder_create_regex%& option is set, and the regular expression it
22456 contains matches the delivery directory, Exim also ensures that a file called
22457 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22458 &_maildirfolder_& file cannot be created, delivery is deferred.
22459
22460 These features make it possible to use Exim to create all the necessary files
22461 and directories in a maildir mailbox, including subdirectories for maildir++
22462 folders. Consider this example:
22463 .code
22464 maildir_format = true
22465 directory = /var/mail/$local_part\
22466            ${if eq{$local_part_suffix}{}{}\
22467            {/.${substr_1:$local_part_suffix}}}
22468 maildirfolder_create_regex = /\.[^/]+$
22469 .endd
22470 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22471 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22472 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22473 not match this name, so Exim will not look for or create the file
22474 &_/var/mail/pimbo/maildirfolder_&, though it will create
22475 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22476
22477 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22478 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22479 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22480 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22481 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22482
22483 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22484 not inadvertently match the toplevel maildir directory, because a
22485 &_maildirfolder_& file at top level would completely break quota calculations.
22486
22487 .cindex "quota" "in maildir delivery"
22488 .cindex "maildir++"
22489 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22490 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22491 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22492 Exim assumes the directory is a maildir++ folder directory, which is one level
22493 down from the user's top level mailbox directory. This causes it to start at
22494 the parent directory instead of the current directory when calculating the
22495 amount of space used.
22496
22497 One problem with delivering into a multi-file mailbox is that it is
22498 computationally expensive to compute the size of the mailbox for quota
22499 checking. Various approaches have been taken to reduce the amount of work
22500 needed. The next two sections describe two of them. A third alternative is to
22501 use some external process for maintaining the size data, and use the expansion
22502 of the &%mailbox_size%& option as a way of importing it into Exim.
22503
22504
22505
22506
22507 .section "Using tags to record message sizes" "SECID135"
22508 If &%maildir_tag%& is set, the string is expanded for each delivery.
22509 When the maildir file is renamed into the &_new_& sub-directory, the
22510 tag is added to its name. However, if adding the tag takes the length of the
22511 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22512 the tag is dropped and the maildir file is created with no tag.
22513
22514
22515 .vindex "&$message_size$&"
22516 Tags can be used to encode the size of files in their names; see
22517 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22518 happens after the message has been written. The value of the &$message_size$&
22519 variable is set to the number of bytes actually written. If the expansion is
22520 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22521 be deferred. The expanded tag may contain any printing characters except &"/"&.
22522 Non-printing characters in the string are ignored; if the resulting string is
22523 empty, it is ignored. If it starts with an alphanumeric character, a leading
22524 colon is inserted; this default has not proven to be the path that popular
22525 maildir implementations have chosen (but changing it in Exim would break
22526 backwards compatibility).
22527
22528 For one common implementation, you might set:
22529 .code
22530 maildir_tag = ,S=${message_size}
22531 .endd
22532 but you should check the documentation of the other software to be sure.
22533
22534 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22535 as this allows Exim to extract the size from your tag, instead of having to
22536 &[stat()]& each message file.
22537
22538
22539 .section "Using a maildirsize file" "SECID136"
22540 .cindex "quota" "in maildir delivery"
22541 .cindex "maildir format" "&_maildirsize_& file"
22542 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22543 storing quota and message size information in a file called &_maildirsize_&
22544 within the toplevel maildir directory. If this file does not exist, Exim
22545 creates it, setting the quota from the &%quota%& option of the transport. If
22546 the maildir directory itself does not exist, it is created before any attempt
22547 to write a &_maildirsize_& file.
22548
22549 The &_maildirsize_& file is used to hold information about the sizes of
22550 messages in the maildir, thus speeding up quota calculations. The quota value
22551 in the file is just a cache; if the quota is changed in the transport, the new
22552 value overrides the cached value when the next message is delivered. The cache
22553 is maintained for the benefit of other programs that access the maildir and
22554 need to know the quota.
22555
22556 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22557 file is maintained (with a zero quota setting), but no quota is imposed.
22558
22559 A regular expression is available for controlling which directories in the
22560 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22561 See the description of the &%maildir_quota_directory_regex%& option above for
22562 details.
22563
22564
22565 .section "Mailstore delivery" "SECID137"
22566 .cindex "mailstore format" "description of"
22567 If the &%mailstore_format%& option is true, each message is written as two
22568 files in the given directory. A unique base name is constructed from the
22569 message id and the current delivery process, and the files that are written use
22570 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22571 contains the message's envelope, and the &_.msg_& file contains the message
22572 itself. The base name is placed in the variable &$mailstore_basename$&.
22573
22574 During delivery, the envelope is first written to a file with the suffix
22575 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22576 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22577 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22578 file before accessing either of them. An alternative approach is to wait for
22579 the absence of a &_.tmp_& file.
22580
22581 The envelope file starts with any text defined by the &%mailstore_prefix%&
22582 option, expanded and terminated by a newline if there isn't one. Then follows
22583 the sender address on one line, then all the recipient addresses, one per line.
22584 There can be more than one recipient only if the &%batch_max%& option is set
22585 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22586 appended to the file, followed by a newline if it does not end with one.
22587
22588 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22589 failure, it is ignored. Other expansion errors are treated as serious
22590 configuration errors, and delivery is deferred. The variable
22591 &$mailstore_basename$& is available for use during these expansions.
22592
22593
22594 .section "Non-special new file delivery" "SECID138"
22595 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22596 file is created directly in the named directory. For example, when delivering
22597 messages into files in batched SMTP format for later delivery to some host (see
22598 section &<<SECTbatchSMTP>>&), a setting such as
22599 .code
22600 directory = /var/bsmtp/$host
22601 .endd
22602 might be used. A message is written to a file with a temporary name, which is
22603 then renamed when the delivery is complete. The final name is obtained by
22604 expanding the contents of the &%directory_file%& option.
22605 .ecindex IIDapptra1
22606 .ecindex IIDapptra2
22607
22608
22609
22610
22611
22612
22613 . ////////////////////////////////////////////////////////////////////////////
22614 . ////////////////////////////////////////////////////////////////////////////
22615
22616 .chapter "The autoreply transport" "CHID8"
22617 .scindex IIDauttra1 "transports" "&(autoreply)&"
22618 .scindex IIDauttra2 "&(autoreply)& transport"
22619 The &(autoreply)& transport is not a true transport in that it does not cause
22620 the message to be transmitted. Instead, it generates a new mail message as an
22621 automatic reply to the incoming message. &'References:'& and
22622 &'Auto-Submitted:'& header lines are included. These are constructed according
22623 to the rules in RFCs 2822 and 3834, respectively.
22624
22625 If the router that passes the message to this transport does not have the
22626 &%unseen%& option set, the original message (for the current recipient) is not
22627 delivered anywhere. However, when the &%unseen%& option is set on the router
22628 that passes the message to this transport, routing of the address continues, so
22629 another router can set up a normal message delivery.
22630
22631
22632 The &(autoreply)& transport is usually run as the result of mail filtering, a
22633 &"vacation"& message being the standard example. However, it can also be run
22634 directly from a router like any other transport. To reduce the possibility of
22635 message cascades, messages created by the &(autoreply)& transport always have
22636 empty envelope sender addresses, like bounce messages.
22637
22638 The parameters of the message to be sent can be specified in the configuration
22639 by options described below. However, these are used only when the address
22640 passed to the transport does not contain its own reply information. When the
22641 transport is run as a consequence of a
22642 &%mail%&
22643 or &%vacation%& command in a filter file, the parameters of the message are
22644 supplied by the filter, and passed with the address. The transport's options
22645 that define the message are then ignored (so they are not usually set in this
22646 case). The message is specified entirely by the filter or by the transport; it
22647 is never built from a mixture of options. However, the &%file_optional%&,
22648 &%mode%&, and &%return_message%& options apply in all cases.
22649
22650 &(Autoreply)& is implemented as a local transport. When used as a result of a
22651 command in a user's filter file, &(autoreply)& normally runs under the uid and
22652 gid of the user, and with appropriate current and home directories (see chapter
22653 &<<CHAPenvironment>>&).
22654
22655 There is a subtle difference between routing a message to a &(pipe)& transport
22656 that generates some text to be returned to the sender, and routing it to an
22657 &(autoreply)& transport. This difference is noticeable only if more than one
22658 address from the same message is so handled. In the case of a pipe, the
22659 separate outputs from the different addresses are gathered up and returned to
22660 the sender in a single message, whereas if &(autoreply)& is used, a separate
22661 message is generated for each address that is passed to it.
22662
22663 Non-printing characters are not permitted in the header lines generated for the
22664 message that &(autoreply)& creates, with the exception of newlines that are
22665 immediately followed by white space. If any non-printing characters are found,
22666 the transport defers.
22667 Whether characters with the top bit set count as printing characters or not is
22668 controlled by the &%print_topbitchars%& global option.
22669
22670 If any of the generic options for manipulating headers (for example,
22671 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22672 of the original message that is included in the generated message when
22673 &%return_message%& is set. They do not apply to the generated message itself.
22674
22675 .vindex "&$sender_address$&"
22676 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22677 the message, indicating that there were no recipients, it does not treat this
22678 as an error. This means that autoreplies sent to &$sender_address$& when this
22679 is empty (because the incoming message is a bounce message) do not cause
22680 problems. They are just discarded.
22681
22682
22683
22684 .section "Private options for autoreply" "SECID139"
22685 .cindex "options" "&(autoreply)& transport"
22686
22687 .option bcc autoreply string&!! unset
22688 This specifies the addresses that are to receive &"blind carbon copies"& of the
22689 message when the message is specified by the transport.
22690
22691
22692 .option cc autoreply string&!! unset
22693 This specifies recipients of the message and the contents of the &'Cc:'& header
22694 when the message is specified by the transport.
22695
22696
22697 .option file autoreply string&!! unset
22698 The contents of the file are sent as the body of the message when the message
22699 is specified by the transport. If both &%file%& and &%text%& are set, the text
22700 string comes first.
22701
22702
22703 .option file_expand autoreply boolean false
22704 If this is set, the contents of the file named by the &%file%& option are
22705 subjected to string expansion as they are added to the message.
22706
22707
22708 .option file_optional autoreply boolean false
22709 If this option is true, no error is generated if the file named by the &%file%&
22710 option or passed with the address does not exist or cannot be read.
22711
22712
22713 .option from autoreply string&!! unset
22714 This specifies the contents of the &'From:'& header when the message is
22715 specified by the transport.
22716
22717
22718 .option headers autoreply string&!! unset
22719 This specifies additional RFC 2822 headers that are to be added to the message
22720 when the message is specified by the transport. Several can be given by using
22721 &"\n"& to separate them. There is no check on the format.
22722
22723
22724 .option log autoreply string&!! unset
22725 This option names a file in which a record of every message sent is logged when
22726 the message is specified by the transport.
22727
22728
22729 .option mode autoreply "octal integer" 0600
22730 If either the log file or the &"once"& file has to be created, this mode is
22731 used.
22732
22733
22734 .option never_mail autoreply "address list&!!" unset
22735 If any run of the transport creates a message with a recipient that matches any
22736 item in the list, that recipient is quietly discarded. If all recipients are
22737 discarded, no message is created. This applies both when the recipients are
22738 generated by a filter and when they are specified in the transport.
22739
22740
22741
22742 .option once autoreply string&!! unset
22743 This option names a file or DBM database in which a record of each &'To:'&
22744 recipient is kept when the message is specified by the transport. &*Note*&:
22745 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22746
22747 If &%once%& is unset, or is set to an empty string, the message is always sent.
22748 By default, if &%once%& is set to a non-empty file name, the message
22749 is not sent if a potential recipient is already listed in the database.
22750 However, if the &%once_repeat%& option specifies a time greater than zero, the
22751 message is sent if that much time has elapsed since a message was last sent to
22752 this recipient. A setting of zero time for &%once_repeat%& (the default)
22753 prevents a message from being sent a second time &-- in this case, zero means
22754 infinity.
22755
22756 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22757 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22758 greater than zero, it changes the way Exim implements the &%once%& option.
22759 Instead of using a DBM file to record every recipient it sends to, it uses a
22760 regular file, whose size will never get larger than the given value.
22761
22762 In the file, Exim keeps a linear list of recipient addresses and the times at
22763 which they were sent messages. If the file is full when a new address needs to
22764 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22765 means that a given recipient may receive multiple messages, but at
22766 unpredictable intervals that depend on the rate of turnover of addresses in the
22767 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22768
22769
22770 .option once_file_size autoreply integer 0
22771 See &%once%& above.
22772
22773
22774 .option once_repeat autoreply time&!! 0s
22775 See &%once%& above.
22776 After expansion, the value of this option must be a valid time value.
22777
22778
22779 .option reply_to autoreply string&!! unset
22780 This specifies the contents of the &'Reply-To:'& header when the message is
22781 specified by the transport.
22782
22783
22784 .option return_message autoreply boolean false
22785 If this is set, a copy of the original message is returned with the new
22786 message, subject to the maximum size set in the &%return_size_limit%& global
22787 configuration option.
22788
22789
22790 .option subject autoreply string&!! unset
22791 This specifies the contents of the &'Subject:'& header when the message is
22792 specified by the transport. It is tempting to quote the original subject in
22793 automatic responses. For example:
22794 .code
22795 subject = Re: $h_subject:
22796 .endd
22797 There is a danger in doing this, however. It may allow a third party to
22798 subscribe your users to an opt-in mailing list, provided that the list accepts
22799 bounce messages as subscription confirmations. Well-managed lists require a
22800 non-bounce message to confirm a subscription, so the danger is relatively
22801 small.
22802
22803
22804
22805 .option text autoreply string&!! unset
22806 This specifies a single string to be used as the body of the message when the
22807 message is specified by the transport. If both &%text%& and &%file%& are set,
22808 the text comes first.
22809
22810
22811 .option to autoreply string&!! unset
22812 This specifies recipients of the message and the contents of the &'To:'& header
22813 when the message is specified by the transport.
22814 .ecindex IIDauttra1
22815 .ecindex IIDauttra2
22816
22817
22818
22819
22820 . ////////////////////////////////////////////////////////////////////////////
22821 . ////////////////////////////////////////////////////////////////////////////
22822
22823 .chapter "The lmtp transport" "CHAPLMTP"
22824 .cindex "transports" "&(lmtp)&"
22825 .cindex "&(lmtp)& transport"
22826 .cindex "LMTP" "over a pipe"
22827 .cindex "LMTP" "over a socket"
22828 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22829 specified command
22830 or by interacting with a Unix domain socket.
22831 This transport is something of a cross between the &(pipe)& and &(smtp)&
22832 transports. Exim also has support for using LMTP over TCP/IP; this is
22833 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22834 to be of minority interest, the default build-time configure in &_src/EDITME_&
22835 has it commented out. You need to ensure that
22836 .code
22837 TRANSPORT_LMTP=yes
22838 .endd
22839 .cindex "options" "&(lmtp)& transport"
22840 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22841 included in the Exim binary. The private options of the &(lmtp)& transport are
22842 as follows:
22843
22844 .option batch_id lmtp string&!! unset
22845 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22846
22847
22848 .option batch_max lmtp integer 1
22849 This limits the number of addresses that can be handled in a single delivery.
22850 Most LMTP servers can handle several addresses at once, so it is normally a
22851 good idea to increase this value. See the description of local delivery
22852 batching in chapter &<<CHAPbatching>>&.
22853
22854
22855 .option command lmtp string&!! unset
22856 This option must be set if &%socket%& is not set. The string is a command which
22857 is run in a separate process. It is split up into a command name and list of
22858 arguments, each of which is separately expanded (so expansion cannot change the
22859 number of arguments). The command is run directly, not via a shell. The message
22860 is passed to the new process using the standard input and output to operate the
22861 LMTP protocol.
22862
22863 .option ignore_quota lmtp boolean false
22864 .cindex "LMTP" "ignoring quota errors"
22865 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22866 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22867 in its response to the LHLO command.
22868
22869 .option socket lmtp string&!! unset
22870 This option must be set if &%command%& is not set. The result of expansion must
22871 be the name of a Unix domain socket. The transport connects to the socket and
22872 delivers the message to it using the LMTP protocol.
22873
22874
22875 .option timeout lmtp time 5m
22876 The transport is aborted if the created process or Unix domain socket does not
22877 respond to LMTP commands or message input within this timeout. Delivery
22878 is deferred, and will be tried again later. Here is an example of a typical
22879 LMTP transport:
22880 .code
22881 lmtp:
22882   driver = lmtp
22883   command = /some/local/lmtp/delivery/program
22884   batch_max = 20
22885   user = exim
22886 .endd
22887 This delivers up to 20 addresses at a time, in a mixture of domains if
22888 necessary, running as the user &'exim'&.
22889
22890
22891
22892 . ////////////////////////////////////////////////////////////////////////////
22893 . ////////////////////////////////////////////////////////////////////////////
22894
22895 .chapter "The pipe transport" "CHAPpipetransport"
22896 .scindex IIDpiptra1 "transports" "&(pipe)&"
22897 .scindex IIDpiptra2 "&(pipe)& transport"
22898 The &(pipe)& transport is used to deliver messages via a pipe to a command
22899 running in another process. One example is the use of &(pipe)& as a
22900 pseudo-remote transport for passing messages to some other delivery mechanism
22901 (such as UUCP). Another is the use by individual users to automatically process
22902 their incoming messages. The &(pipe)& transport can be used in one of the
22903 following ways:
22904
22905 .ilist
22906 .vindex "&$local_part$&"
22907 A router routes one address to a transport in the normal way, and the
22908 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22909 contains the local part of the address (as usual), and the command that is run
22910 is specified by the &%command%& option on the transport.
22911 .next
22912 .vindex "&$pipe_addresses$&"
22913 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22914 transport can handle more than one address in a single run. In this case, when
22915 more than one address is routed to the transport, &$local_part$& is not set
22916 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22917 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22918 that are routed to the transport.
22919 .next
22920 .vindex "&$address_pipe$&"
22921 A router redirects an address directly to a pipe command (for example, from an
22922 alias or forward file). In this case, &$address_pipe$& contains the text of the
22923 pipe command, and the &%command%& option on the transport is ignored unless
22924 &%force_command%& is set. If only one address is being transported
22925 (&%batch_max%& is not greater than one, or only one address was redirected to
22926 this pipe command), &$local_part$& contains the local part that was redirected.
22927 .endlist
22928
22929
22930 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22931 deliver messages over pipes using the LMTP interactive protocol. This is
22932 implemented by the &(lmtp)& transport.
22933
22934 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22935 &_.forward_& file, the command runs under the uid and gid of that user. In
22936 other cases, the uid and gid have to be specified explicitly, either on the
22937 transport or on the router that handles the address. Current and &"home"&
22938 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22939 details of the local delivery environment and chapter &<<CHAPbatching>>&
22940 for a discussion of local delivery batching.
22941
22942
22943 .section "Concurrent delivery" "SECID140"
22944 If two messages arrive at almost the same time, and both are routed to a pipe
22945 delivery, the two pipe transports may be run concurrently. You must ensure that
22946 any pipe commands you set up are robust against this happening. If the commands
22947 write to a file, the &%exim_lock%& utility might be of use.
22948 Alternatively the &%max_parallel%& option could be used with a value
22949 of "1" to enforce serialization.
22950
22951
22952
22953
22954 .section "Returned status and data" "SECID141"
22955 .cindex "&(pipe)& transport" "returned data"
22956 If the command exits with a non-zero return code, the delivery is deemed to
22957 have failed, unless either the &%ignore_status%& option is set (in which case
22958 the return code is treated as zero), or the return code is one of those listed
22959 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22960 later"&. In this case, delivery is deferred. Details of a permanent failure are
22961 logged, but are not included in the bounce message, which merely contains
22962 &"local delivery failed"&.
22963
22964 If the command exits on a signal and the &%freeze_signal%& option is set then
22965 the message will be frozen in the queue. If that option is not set, a bounce
22966 will be sent as normal.
22967
22968 If the return code is greater than 128 and the command being run is a shell
22969 script, it normally means that the script was terminated by a signal whose
22970 value is the return code minus 128. The &%freeze_signal%& option does not
22971 apply in this case.
22972
22973 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22974 return code is set to 127. This is the value that a shell returns if it is
22975 asked to run a non-existent command. The wording for the log line suggests that
22976 a non-existent command may be the problem.
22977
22978 The &%return_output%& option can affect the result of a pipe delivery. If it is
22979 set and the command produces any output on its standard output or standard
22980 error streams, the command is considered to have failed, even if it gave a zero
22981 return code or if &%ignore_status%& is set. The output from the command is
22982 included as part of the bounce message. The &%return_fail_output%& option is
22983 similar, except that output is returned only when the command exits with a
22984 failure return code, that is, a value other than zero or a code that matches
22985 &%temp_errors%&.
22986
22987
22988
22989 .section "How the command is run" "SECThowcommandrun"
22990 .cindex "&(pipe)& transport" "path for command"
22991 The command line is (by default) broken down into a command name and arguments
22992 by the &(pipe)& transport itself. The &%allow_commands%& and
22993 &%restrict_to_path%& options can be used to restrict the commands that may be
22994 run.
22995
22996 .cindex "quoting" "in pipe command"
22997 Unquoted arguments are delimited by white space. If an argument appears in
22998 double quotes, backslash is interpreted as an escape character in the usual
22999 way. If an argument appears in single quotes, no escaping is done.
23000
23001 String expansion is applied to the command line except when it comes from a
23002 traditional &_.forward_& file (commands from a filter file are expanded). The
23003 expansion is applied to each argument in turn rather than to the whole line.
23004 For this reason, any string expansion item that contains white space must be
23005 quoted so as to be contained within a single argument. A setting such as
23006 .code
23007 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23008 .endd
23009 will not work, because the expansion item gets split between several
23010 arguments. You have to write
23011 .code
23012 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23013 .endd
23014 to ensure that it is all in one argument. The expansion is done in this way,
23015 argument by argument, so that the number of arguments cannot be changed as a
23016 result of expansion, and quotes or backslashes in inserted variables do not
23017 interact with external quoting. However, this leads to problems if you want to
23018 generate multiple arguments (or the command name plus arguments) from a single
23019 expansion. In this situation, the simplest solution is to use a shell. For
23020 example:
23021 .code
23022 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23023 .endd
23024
23025 .cindex "transport" "filter"
23026 .cindex "filter" "transport filter"
23027 .vindex "&$pipe_addresses$&"
23028 Special handling takes place when an argument consists of precisely the text
23029 &`$pipe_addresses`&. This is not a general expansion variable; the only
23030 place this string is recognized is when it appears as an argument for a pipe or
23031 transport filter command. It causes each address that is being handled to be
23032 inserted in the argument list at that point &'as a separate argument'&. This
23033 avoids any problems with spaces or shell metacharacters, and is of use when a
23034 &(pipe)& transport is handling groups of addresses in a batch.
23035
23036 If &%force_command%& is enabled on the transport, Special handling takes place
23037 for an argument that consists of precisely the text &`$address_pipe`&.  It
23038 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23039 argument is inserted in the argument list at that point
23040 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23041 the only item in the argument; in fact, if it were then &%force_command%&
23042 should behave as a no-op.  Rather, it should be used to adjust the command
23043 run while preserving the argument vector separation.
23044
23045 After splitting up into arguments and expansion, the resulting command is run
23046 in a subprocess directly from the transport, &'not'& under a shell. The
23047 message that is being delivered is supplied on the standard input, and the
23048 standard output and standard error are both connected to a single pipe that is
23049 read by Exim. The &%max_output%& option controls how much output the command
23050 may produce, and the &%return_output%& and &%return_fail_output%& options
23051 control what is done with it.
23052
23053 Not running the command under a shell (by default) lessens the security risks
23054 in cases when a command from a user's filter file is built out of data that was
23055 taken from an incoming message. If a shell is required, it can of course be
23056 explicitly specified as the command to be run. However, there are circumstances
23057 where existing commands (for example, in &_.forward_& files) expect to be run
23058 under a shell and cannot easily be modified. To allow for these cases, there is
23059 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23060 works. Instead of breaking up the command line as just described, it expands it
23061 as a single string and passes the result to &_/bin/sh_&. The
23062 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23063 with &%use_shell%&, and the whole mechanism is inherently less secure.
23064
23065
23066
23067 .section "Environment variables" "SECTpipeenv"
23068 .cindex "&(pipe)& transport" "environment for command"
23069 .cindex "environment" "&(pipe)& transport"
23070 The environment variables listed below are set up when the command is invoked.
23071 This list is a compromise for maximum compatibility with other MTAs. Note that
23072 the &%environment%& option can be used to add additional variables to this
23073 environment. The environment for the &(pipe)& transport is not subject
23074 to the &%add_environment%& and &%keep_environment%& main config options.
23075 .display
23076 &`DOMAIN            `&   the domain of the address
23077 &`HOME              `&   the home directory, if set
23078 &`HOST              `&   the host name when called from a router (see below)
23079 &`LOCAL_PART        `&   see below
23080 &`LOCAL_PART_PREFIX `&   see below
23081 &`LOCAL_PART_SUFFIX `&   see below
23082 &`LOGNAME           `&   see below
23083 &`MESSAGE_ID        `&   Exim's local ID for the message
23084 &`PATH              `&   as specified by the &%path%& option below
23085 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23086 &`RECIPIENT         `&   the complete recipient address
23087 &`SENDER            `&   the sender of the message (empty if a bounce)
23088 &`SHELL             `&   &`/bin/sh`&
23089 &`TZ                `&   the value of the &%timezone%& option, if set
23090 &`USER              `&   see below
23091 .endd
23092 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23093 router, LOCAL_PART is set to the local part of the address. When it is
23094 called as a result of a forward or alias expansion, LOCAL_PART is set to
23095 the local part of the address that was expanded. In both cases, any affixes are
23096 removed from the local part, and made available in LOCAL_PART_PREFIX and
23097 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23098 same value as LOCAL_PART for compatibility with other MTAs.
23099
23100 .cindex "HOST"
23101 HOST is set only when a &(pipe)& transport is called from a router that
23102 associates hosts with an address, typically when using &(pipe)& as a
23103 pseudo-remote transport. HOST is set to the first host name specified by
23104 the router.
23105
23106 .cindex "HOME"
23107 If the transport's generic &%home_directory%& option is set, its value is used
23108 for the HOME environment variable. Otherwise, a home directory may be set
23109 by the router's &%transport_home_directory%& option, which defaults to the
23110 user's home directory if &%check_local_user%& is set.
23111
23112
23113 .section "Private options for pipe" "SECID142"
23114 .cindex "options" "&(pipe)& transport"
23115
23116
23117
23118 .option allow_commands pipe "string list&!!" unset
23119 .cindex "&(pipe)& transport" "permitted commands"
23120 The string is expanded, and is then interpreted as a colon-separated list of
23121 permitted commands. If &%restrict_to_path%& is not set, the only commands
23122 permitted are those in the &%allow_commands%& list. They need not be absolute
23123 paths; the &%path%& option is still used for relative paths. If
23124 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23125 in the &%allow_commands%& list, or a name without any slashes that is found on
23126 the path. In other words, if neither &%allow_commands%& nor
23127 &%restrict_to_path%& is set, there is no restriction on the command, but
23128 otherwise only commands that are permitted by one or the other are allowed. For
23129 example, if
23130 .code
23131 allow_commands = /usr/bin/vacation
23132 .endd
23133 and &%restrict_to_path%& is not set, the only permitted command is
23134 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23135 &%use_shell%& is set.
23136
23137
23138 .option batch_id pipe string&!! unset
23139 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23140
23141
23142 .option batch_max pipe integer 1
23143 This limits the number of addresses that can be handled in a single delivery.
23144 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23145
23146
23147 .option check_string pipe string unset
23148 As &(pipe)& writes the message, the start of each line is tested for matching
23149 &%check_string%&, and if it does, the initial matching characters are replaced
23150 by the contents of &%escape_string%&, provided both are set. The value of
23151 &%check_string%& is a literal string, not a regular expression, and the case of
23152 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23153 of &%check_string%& and &%escape_string%& are forced to values that implement
23154 the SMTP escaping protocol. Any settings made in the configuration file are
23155 ignored.
23156
23157
23158 .option command pipe string&!! unset
23159 This option need not be set when &(pipe)& is being used to deliver to pipes
23160 obtained directly from address redirections. In other cases, the option must be
23161 set, to provide a command to be run. It need not yield an absolute path (see
23162 the &%path%& option below). The command is split up into separate arguments by
23163 Exim, and each argument is separately expanded, as described in section
23164 &<<SECThowcommandrun>>& above.
23165
23166
23167 .option environment pipe string&!! unset
23168 .cindex "&(pipe)& transport" "environment for command"
23169 .cindex "environment" "&(pipe)& transport"
23170 This option is used to add additional variables to the environment in which the
23171 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23172 a string which is expanded, and then interpreted as a colon-separated list of
23173 environment settings of the form <&'name'&>=<&'value'&>.
23174
23175
23176 .option escape_string pipe string unset
23177 See &%check_string%& above.
23178
23179
23180 .option freeze_exec_fail pipe boolean false
23181 .cindex "exec failure"
23182 .cindex "failure of exec"
23183 .cindex "&(pipe)& transport" "failure of exec"
23184 Failure to exec the command in a pipe transport is by default treated like
23185 any other failure while running the command. However, if &%freeze_exec_fail%&
23186 is set, failure to exec is treated specially, and causes the message to be
23187 frozen, whatever the setting of &%ignore_status%&.
23188
23189
23190 .option freeze_signal pipe boolean false
23191 .cindex "signal exit"
23192 .cindex "&(pipe)& transport", "signal exit"
23193 Normally if the process run by a command in a pipe transport exits on a signal,
23194 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23195 frozen in Exim's queue instead.
23196
23197
23198 .option force_command pipe boolean false
23199 .cindex "force command"
23200 .cindex "&(pipe)& transport", "force command"
23201 Normally when a router redirects an address directly to a pipe command
23202 the &%command%& option on the transport is ignored.  If &%force_command%&
23203 is set, the &%command%& option will used. This is especially
23204 useful for forcing a wrapper or additional argument to be added to the
23205 command. For example:
23206 .code
23207 command = /usr/bin/remote_exec myhost -- $address_pipe
23208 force_command
23209 .endd
23210
23211 Note that &$address_pipe$& is handled specially in &%command%& when
23212 &%force_command%& is set, expanding out to the original argument vector as
23213 separate items, similarly to a Unix shell &`"$@"`& construct.
23214
23215
23216 .option ignore_status pipe boolean false
23217 If this option is true, the status returned by the subprocess that is set up to
23218 run the command is ignored, and Exim behaves as if zero had been returned.
23219 Otherwise, a non-zero status or termination by signal causes an error return
23220 from the transport unless the status value is one of those listed in
23221 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23222
23223 &*Note*&: This option does not apply to timeouts, which do not return a status.
23224 See the &%timeout_defer%& option for how timeouts are handled.
23225
23226
23227 .option log_defer_output pipe boolean false
23228 .cindex "&(pipe)& transport" "logging output"
23229 If this option is set, and the status returned by the command is
23230 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23231 and any output was produced on stdout or stderr, the first line of it is
23232 written to the main log.
23233
23234
23235 .option log_fail_output pipe boolean false
23236 If this option is set, and the command returns any output on stdout or
23237 stderr, and also ends with a return code that is neither zero nor one of
23238 the return codes listed in &%temp_errors%& (that is, the delivery
23239 failed), the first line of output is written to the main log. This
23240 option and &%log_output%& are mutually exclusive.  Only one of them may
23241 be set.
23242
23243
23244 .option log_output pipe boolean false
23245 If this option is set and the command returns any output on stdout or
23246 stderr, the first line of output is written to the main log, whatever
23247 the return code. This option and &%log_fail_output%& are mutually
23248 exclusive. Only one of them may be set.
23249
23250
23251 .option max_output pipe integer 20K
23252 This specifies the maximum amount of output that the command may produce on its
23253 standard output and standard error file combined. If the limit is exceeded, the
23254 process running the command is killed. This is intended as a safety measure to
23255 catch runaway processes. The limit is applied independently of the settings of
23256 the options that control what is done with such output (for example,
23257 &%return_output%&). Because of buffering effects, the amount of output may
23258 exceed the limit by a small amount before Exim notices.
23259
23260
23261 .option message_prefix pipe string&!! "see below"
23262 The string specified here is expanded and output at the start of every message.
23263 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23264 .code
23265 message_prefix = \
23266   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23267   ${tod_bsdinbox}\n
23268 .endd
23269 .cindex "Cyrus"
23270 .cindex "&%tmail%&"
23271 .cindex "&""From""& line"
23272 This is required by the commonly used &_/usr/bin/vacation_& program.
23273 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23274 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23275 setting
23276 .code
23277 message_prefix =
23278 .endd
23279 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23280 &`\n`& to &`\r\n`& in &%message_prefix%&.
23281
23282
23283 .option message_suffix pipe string&!! "see below"
23284 The string specified here is expanded and output at the end of every message.
23285 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23286 The suffix can be suppressed by setting
23287 .code
23288 message_suffix =
23289 .endd
23290 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23291 &`\n`& to &`\r\n`& in &%message_suffix%&.
23292
23293
23294 .option path pipe string&!! "/bin:/usr/bin"
23295 .new
23296 This option is expanded and
23297 .wen
23298 specifies the string that is set up in the PATH environment
23299 variable of the subprocess.
23300 If the &%command%& option does not yield an absolute path name, the command is
23301 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23302 apply to a command specified as a transport filter.
23303
23304
23305 .option permit_coredump pipe boolean false
23306 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23307 a core-dump of a pipe command, enable this command.  This enables core-dumps
23308 during delivery and affects both the Exim binary and the pipe command run.
23309 It is recommended that this option remain off unless and until you have a need
23310 for it and that this only be enabled when needed, as the risk of excessive
23311 resource consumption can be quite high.  Note also that Exim is typically
23312 installed as a setuid binary and most operating systems will inhibit coredumps
23313 of these by default, so further OS-specific action may be required.
23314
23315
23316 .option pipe_as_creator pipe boolean false
23317 .cindex "uid (user id)" "local delivery"
23318 If the generic &%user%& option is not set and this option is true, the delivery
23319 process is run under the uid that was in force when Exim was originally called
23320 to accept the message. If the group id is not otherwise set (via the generic
23321 &%group%& option), the gid that was in force when Exim was originally called to
23322 accept the message is used.
23323
23324
23325 .option restrict_to_path pipe boolean false
23326 When this option is set, any command name not listed in &%allow_commands%& must
23327 contain no slashes. The command is searched for only in the directories listed
23328 in the &%path%& option. This option is intended for use in the case when a pipe
23329 command has been generated from a user's &_.forward_& file. This is usually
23330 handled by a &(pipe)& transport called &%address_pipe%&.
23331
23332
23333 .option return_fail_output pipe boolean false
23334 If this option is true, and the command produced any output and ended with a
23335 return code other than zero or one of the codes listed in &%temp_errors%& (that
23336 is, the delivery failed), the output is returned in the bounce message.
23337 However, if the message has a null sender (that is, it is itself a bounce
23338 message), output from the command is discarded. This option and
23339 &%return_output%& are mutually exclusive. Only one of them may be set.
23340
23341
23342
23343 .option return_output pipe boolean false
23344 If this option is true, and the command produced any output, the delivery is
23345 deemed to have failed whatever the return code from the command, and the output
23346 is returned in the bounce message. Otherwise, the output is just discarded.
23347 However, if the message has a null sender (that is, it is a bounce message),
23348 output from the command is always discarded, whatever the setting of this
23349 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23350 of them may be set.
23351
23352
23353
23354 .option temp_errors pipe "string list" "see below"
23355 .cindex "&(pipe)& transport" "temporary failure"
23356 This option contains either a colon-separated list of numbers, or a single
23357 asterisk. If &%ignore_status%& is false
23358 and &%return_output%& is not set,
23359 and the command exits with a non-zero return code, the failure is treated as
23360 temporary and the delivery is deferred if the return code matches one of the
23361 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23362 codes are treated as permanent errors. The default setting contains the codes
23363 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23364 compiled on a system that does not define these macros, it assumes values of 75
23365 and 73, respectively.
23366
23367
23368 .option timeout pipe time 1h
23369 If the command fails to complete within this time, it is killed. This normally
23370 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23371 specifies no timeout. In order to ensure that any subprocesses created by the
23372 command are also killed, Exim makes the initial process a process group leader,
23373 and kills the whole process group on a timeout. However, this can be defeated
23374 if one of the processes starts a new process group.
23375
23376 .option timeout_defer pipe boolean false
23377 A timeout in a &(pipe)& transport, either in the command that the transport
23378 runs, or in a transport filter that is associated with it, is by default
23379 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23380 is set true, both kinds of timeout become temporary errors, causing the
23381 delivery to be deferred.
23382
23383 .option umask pipe "octal integer" 022
23384 This specifies the umask setting for the subprocess that runs the command.
23385
23386
23387 .option use_bsmtp pipe boolean false
23388 .cindex "envelope sender"
23389 If this option is set true, the &(pipe)& transport writes messages in &"batch
23390 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23391 commands. If you want to include a leading HELO command with such messages,
23392 you can do so by setting the &%message_prefix%& option. See section
23393 &<<SECTbatchSMTP>>& for details of batch SMTP.
23394
23395 .option use_classresources pipe boolean false
23396 .cindex "class resources (BSD)"
23397 This option is available only when Exim is running on FreeBSD, NetBSD, or
23398 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23399 resource limits when a &(pipe)& transport is run to perform a delivery. The
23400 limits for the uid under which the pipe is to run are obtained from the login
23401 class database.
23402
23403
23404 .option use_crlf pipe boolean false
23405 .cindex "carriage return"
23406 .cindex "linefeed"
23407 This option causes lines to be terminated with the two-character CRLF sequence
23408 (carriage return, linefeed) instead of just a linefeed character. In the case
23409 of batched SMTP, the byte sequence written to the pipe is then an exact image
23410 of what would be sent down a real SMTP connection.
23411
23412 The contents of the &%message_prefix%& and &%message_suffix%& options are
23413 written verbatim, so must contain their own carriage return characters if these
23414 are needed. When &%use_bsmtp%& is not set, the default values for both
23415 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23416 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23417
23418
23419 .option use_shell pipe boolean false
23420 .vindex "&$pipe_addresses$&"
23421 If this option is set, it causes the command to be passed to &_/bin/sh_&
23422 instead of being run directly from the transport, as described in section
23423 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23424 where the command is expected to be run under a shell and cannot easily be
23425 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23426 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23427 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23428 its &%-c%& option.
23429
23430
23431
23432 .section "Using an external local delivery agent" "SECID143"
23433 .cindex "local delivery" "using an external agent"
23434 .cindex "&'procmail'&"
23435 .cindex "external local delivery"
23436 .cindex "delivery" "&'procmail'&"
23437 .cindex "delivery" "by external agent"
23438 The &(pipe)& transport can be used to pass all messages that require local
23439 delivery to a separate local delivery agent such as &%procmail%&. When doing
23440 this, care must be taken to ensure that the pipe is run under an appropriate
23441 uid and gid. In some configurations one wants this to be a uid that is trusted
23442 by the delivery agent to supply the correct sender of the message. It may be
23443 necessary to recompile or reconfigure the delivery agent so that it trusts an
23444 appropriate user. The following is an example transport and router
23445 configuration for &%procmail%&:
23446 .code
23447 # transport
23448 procmail_pipe:
23449   driver = pipe
23450   command = /usr/local/bin/procmail -d $local_part
23451   return_path_add
23452   delivery_date_add
23453   envelope_to_add
23454   check_string = "From "
23455   escape_string = ">From "
23456   umask = 077
23457   user = $local_part
23458   group = mail
23459
23460 # router
23461 procmail:
23462   driver = accept
23463   check_local_user
23464   transport = procmail_pipe
23465 .endd
23466 In this example, the pipe is run as the local user, but with the group set to
23467 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23468 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23469 user to supply a correct sender address. If you do not specify either a
23470 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23471 home directory is the user's home directory by default.
23472
23473 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23474 .code
23475 IFS=" "
23476 .endd
23477 as shown in some &%procmail%& documentation, because Exim does not by default
23478 use a shell to run pipe commands.
23479
23480 .cindex "Cyrus"
23481 The next example shows a transport and a router for a system where local
23482 deliveries are handled by the Cyrus IMAP server.
23483 .code
23484 # transport
23485 local_delivery_cyrus:
23486   driver = pipe
23487   command = /usr/cyrus/bin/deliver \
23488             -m ${substr_1:$local_part_suffix} -- $local_part
23489   user = cyrus
23490   group = mail
23491   return_output
23492   log_output
23493   message_prefix =
23494   message_suffix =
23495
23496 # router
23497 local_user_cyrus:
23498   driver = accept
23499   check_local_user
23500   local_part_suffix = .*
23501   transport = local_delivery_cyrus
23502 .endd
23503 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23504 &%return_output%& to cause any text written by Cyrus to be returned to the
23505 sender.
23506 .ecindex IIDpiptra1
23507 .ecindex IIDpiptra2
23508
23509
23510 . ////////////////////////////////////////////////////////////////////////////
23511 . ////////////////////////////////////////////////////////////////////////////
23512
23513 .chapter "The smtp transport" "CHAPsmtptrans"
23514 .scindex IIDsmttra1 "transports" "&(smtp)&"
23515 .scindex IIDsmttra2 "&(smtp)& transport"
23516 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23517 or LMTP protocol. The list of hosts to try can either be taken from the address
23518 that is being processed (having been set up by the router), or specified
23519 explicitly for the transport. Timeout and retry processing (see chapter
23520 &<<CHAPretry>>&) is applied to each IP address independently.
23521
23522
23523 .section "Multiple messages on a single connection" "SECID144"
23524 The sending of multiple messages over a single TCP/IP connection can arise in
23525 two ways:
23526
23527 .ilist
23528 If a message contains more than &%max_rcpt%& (see below) addresses that are
23529 routed to the same host, more than one copy of the message has to be sent to
23530 that host. In this situation, multiple copies may be sent in a single run of
23531 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23532 does when it has too many addresses to send in one message also depends on the
23533 value of the global &%remote_max_parallel%& option. Details are given in
23534 section &<<SECToutSMTPTCP>>&.)
23535 .next
23536 .cindex "hints database" "remembering routing"
23537 When a message has been successfully delivered over a TCP/IP connection, Exim
23538 looks in its hints database to see if there are any other messages awaiting a
23539 connection to the same host. If there are, a new delivery process is started
23540 for one of them, and the current TCP/IP connection is passed on to it. The new
23541 process may in turn send multiple copies and possibly create yet another
23542 process.
23543 .endlist
23544
23545
23546 For each copy sent over the same TCP/IP connection, a sequence counter is
23547 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23548 no further messages are sent over that connection.
23549
23550
23551
23552 .section "Use of the $host and $host_address variables" "SECID145"
23553 .vindex "&$host$&"
23554 .vindex "&$host_address$&"
23555 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23556 &$host_address$& are the name and IP address of the first host on the host list
23557 passed by the router. However, when the transport is about to connect to a
23558 specific host, and while it is connected to that host, &$host$& and
23559 &$host_address$& are set to the values for that host. These are the values
23560 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23561 &%serialize_hosts%&, and the various TLS options are expanded.
23562
23563
23564 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23565 .vindex &$tls_bits$&
23566 .vindex &$tls_cipher$&
23567 .vindex &$tls_peerdn$&
23568 .vindex &$tls_sni$&
23569 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23570 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23571 are the values that were set when the message was received.
23572 These are the values that are used for options that are expanded before any
23573 SMTP connections are made. Just before each connection is made, these four
23574 variables are emptied. If TLS is subsequently started, they are set to the
23575 appropriate values for the outgoing connection, and these are the values that
23576 are in force when any authenticators are run and when the
23577 &%authenticated_sender%& option is expanded.
23578
23579 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23580 and will be removed in a future release.
23581
23582
23583 .section "Private options for smtp" "SECID146"
23584 .cindex "options" "&(smtp)& transport"
23585 The private options of the &(smtp)& transport are as follows:
23586
23587
23588 .option address_retry_include_sender smtp boolean true
23589 .cindex "4&'xx'& responses" "retrying after"
23590 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23591 is the combination of sender and recipient that is delayed in subsequent queue
23592 runs until the retry time is reached. You can delay the recipient without
23593 reference to the sender (which is what earlier versions of Exim did), by
23594 setting &%address_retry_include_sender%& false. However, this can lead to
23595 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23596
23597 .option allow_localhost smtp boolean false
23598 .cindex "local host" "sending to"
23599 .cindex "fallback" "hosts specified on transport"
23600 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23601 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23602 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23603 the delivery anyway. This should be used only in special cases when the
23604 configuration ensures that no looping will result (for example, a differently
23605 configured Exim is listening on the port to which the message is sent).
23606
23607
23608 .option authenticated_sender smtp string&!! unset
23609 .cindex "Cyrus"
23610 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23611 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23612 overriding any existing authenticated sender value. If the string expansion is
23613 forced to fail, the option is ignored. Other expansion failures cause delivery
23614 to be deferred. If the result of expansion is an empty string, that is also
23615 ignored.
23616
23617 The expansion happens after the outgoing connection has been made and TLS
23618 started, if required. This means that the &$host$&, &$host_address$&,
23619 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23620 particular connection.
23621
23622 If the SMTP session is not authenticated, the expansion of
23623 &%authenticated_sender%& still happens (and can cause the delivery to be
23624 deferred if it fails), but no AUTH= item is added to MAIL commands
23625 unless &%authenticated_sender_force%& is true.
23626
23627 This option allows you to use the &(smtp)& transport in LMTP mode to
23628 deliver mail to Cyrus IMAP and provide the proper local part as the
23629 &"authenticated sender"&, via a setting such as:
23630 .code
23631 authenticated_sender = $local_part
23632 .endd
23633 This removes the need for IMAP subfolders to be assigned special ACLs to
23634 allow direct delivery to those subfolders.
23635
23636 Because of expected uses such as that just described for Cyrus (when no
23637 domain is involved), there is no checking on the syntax of the provided
23638 value.
23639
23640
23641 .option authenticated_sender_force smtp boolean false
23642 If this option is set true, the &%authenticated_sender%& option's value
23643 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23644 authenticated as a client.
23645
23646
23647 .option command_timeout smtp time 5m
23648 This sets a timeout for receiving a response to an SMTP command that has been
23649 sent out. It is also used when waiting for the initial banner line from the
23650 remote host. Its value must not be zero.
23651
23652
23653 .option connect_timeout smtp time 5m
23654 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23655 to a remote host. A setting of zero allows the system timeout (typically
23656 several minutes) to act. To have any effect, the value of this option must be
23657 less than the system timeout. However, it has been observed that on some
23658 systems there is no system timeout, which is why the default value for this
23659 option is 5 minutes, a value recommended by RFC 1123.
23660
23661
23662 .option connection_max_messages smtp integer 500
23663 .cindex "SMTP" "passed connection"
23664 .cindex "SMTP" "multiple deliveries"
23665 .cindex "multiple SMTP deliveries"
23666 This controls the maximum number of separate message deliveries that are sent
23667 over a single TCP/IP connection. If the value is zero, there is no limit.
23668 For testing purposes, this value can be overridden by the &%-oB%& command line
23669 option.
23670
23671
23672 .option data_timeout smtp time 5m
23673 This sets a timeout for the transmission of each block in the data portion of
23674 the message. As a result, the overall timeout for a message depends on the size
23675 of the message. Its value must not be zero. See also &%final_timeout%&.
23676
23677
23678 .option dkim_domain smtp string&!! unset
23679 .option dkim_selector smtp string&!! unset
23680 .option dkim_private_key smtp string&!! unset
23681 .option dkim_canon smtp string&!! unset
23682 .option dkim_strict smtp string&!! unset
23683 .option dkim_sign_headers smtp string&!! unset
23684 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
23685
23686
23687 .option delay_after_cutoff smtp boolean true
23688 This option controls what happens when all remote IP addresses for a given
23689 domain have been inaccessible for so long that they have passed their retry
23690 cutoff times.
23691
23692 In the default state, if the next retry time has not been reached for any of
23693 them, the address is bounced without trying any deliveries. In other words,
23694 Exim delays retrying an IP address after the final cutoff time until a new
23695 retry time is reached, and can therefore bounce an address without ever trying
23696 a delivery, when machines have been down for a long time. Some people are
23697 unhappy at this prospect, so...
23698
23699 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23700 addresses are past their final cutoff time, Exim tries to deliver to those
23701 IP addresses that have not been tried since the message arrived. If there are
23702 none, of if they all fail, the address is bounced. In other words, it does not
23703 delay when a new message arrives, but immediately tries those expired IP
23704 addresses that haven't been tried since the message arrived. If there is a
23705 continuous stream of messages for the dead hosts, unsetting
23706 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23707 to them.
23708
23709
23710 .option dns_qualify_single smtp boolean true
23711 If the &%hosts%& or &%fallback_hosts%& option is being used,
23712 and the &%gethostbyname%& option is false,
23713 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23714 in chapter &<<CHAPdnslookup>>& for more details.
23715
23716
23717 .option dns_search_parents smtp boolean false
23718 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23719 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23720 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23721 details.
23722
23723
23724 .option dnssec_request_domains smtp "domain list&!!" unset
23725 .cindex "MX record" "security"
23726 .cindex "DNSSEC" "MX lookup"
23727 .cindex "security" "MX lookup"
23728 .cindex "DNS" "DNSSEC"
23729 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23730 the dnssec request bit set.
23731 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23732
23733
23734
23735 .option dnssec_require_domains smtp "domain list&!!" unset
23736 .cindex "MX record" "security"
23737 .cindex "DNSSEC" "MX lookup"
23738 .cindex "security" "MX lookup"
23739 .cindex "DNS" "DNSSEC"
23740 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23741 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23742 (AD bit) set will be ignored and logged as a host-lookup failure.
23743 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23744
23745
23746
23747 .option dscp smtp string&!! unset
23748 .cindex "DCSP" "outbound"
23749 This option causes the DSCP value associated with a socket to be set to one
23750 of a number of fixed strings or to numeric value.
23751 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23752 Common values include &`throughput`&, &`mincost`&, and on newer systems
23753 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23754
23755 The outbound packets from Exim will be marked with this value in the header
23756 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23757 that these values will have any effect, not be stripped by networking
23758 equipment, or do much of anything without cooperation with your Network
23759 Engineer and those of all network operators between the source and destination.
23760
23761
23762 .option fallback_hosts smtp "string list" unset
23763 .cindex "fallback" "hosts specified on transport"
23764 String expansion is not applied to this option. The argument must be a
23765 colon-separated list of host names or IP addresses, optionally also including
23766 port numbers, though the separator can be changed, as described in section
23767 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23768 item in a &%route_list%& setting for the &(manualroute)& router, as described
23769 in section &<<SECTformatonehostitem>>&.
23770
23771 Fallback hosts can also be specified on routers, which associate them with the
23772 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23773 &%fallback_hosts%& specified on the transport is used only if the address does
23774 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23775 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23776 However, &%hosts_randomize%& does apply to fallback host lists.
23777
23778 If Exim is unable to deliver to any of the hosts for a particular address, and
23779 the errors are not permanent rejections, the address is put on a separate
23780 transport queue with its host list replaced by the fallback hosts, unless the
23781 address was routed via MX records and the current host was in the original MX
23782 list. In that situation, the fallback host list is not used.
23783
23784 Once normal deliveries are complete, the fallback queue is delivered by
23785 re-running the same transports with the new host lists. If several failing
23786 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23787 copy of the message is sent.
23788
23789 The resolution of the host names on the fallback list is controlled by the
23790 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23791 both to cases when the host list comes with the address and when it is taken
23792 from &%hosts%&. This option provides a &"use a smart host only if delivery
23793 fails"& facility.
23794
23795
23796 .option final_timeout smtp time 10m
23797 This is the timeout that applies while waiting for the response to the final
23798 line containing just &"."& that terminates a message. Its value must not be
23799 zero.
23800
23801 .option gethostbyname smtp boolean false
23802 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23803 being used, names are looked up using &[gethostbyname()]&
23804 (or &[getipnodebyname()]& when available)
23805 instead of using the DNS. Of course, that function may in fact use the DNS, but
23806 it may also consult other sources of information such as &_/etc/hosts_&.
23807
23808 .option gnutls_compat_mode smtp boolean unset
23809 This option controls whether GnuTLS is used in compatibility mode in an Exim
23810 server. This reduces security slightly, but improves interworking with older
23811 implementations of TLS.
23812
23813 .option helo_data smtp string&!! "see below"
23814 .cindex "HELO" "argument, setting"
23815 .cindex "EHLO" "argument, setting"
23816 .cindex "LHLO argument setting"
23817 The value of this option is expanded after a connection to a another host has
23818 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23819 command that starts the outgoing SMTP or LMTP session. The default value of the
23820 option is:
23821 .code
23822 $primary_hostname
23823 .endd
23824 During the expansion, the variables &$host$& and &$host_address$& are set to
23825 the identity of the remote host, and the variables &$sending_ip_address$& and
23826 &$sending_port$& are set to the local IP address and port number that are being
23827 used. These variables can be used to generate different values for different
23828 servers or different local IP addresses. For example, if you want the string
23829 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23830 interface address, you could use this:
23831 .code
23832 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23833   {$primary_hostname}}
23834 .endd
23835 The use of &%helo_data%& applies both to sending messages and when doing
23836 callouts.
23837
23838 .option hosts smtp "string list&!!" unset
23839 Hosts are associated with an address by a router such as &(dnslookup)&, which
23840 finds the hosts by looking up the address domain in the DNS, or by
23841 &(manualroute)&, which has lists of hosts in its configuration. However,
23842 email addresses can be passed to the &(smtp)& transport by any router, and not
23843 all of them can provide an associated list of hosts.
23844
23845 The &%hosts%& option specifies a list of hosts to be used if the address being
23846 processed does not have any hosts associated with it. The hosts specified by
23847 &%hosts%& are also used, whether or not the address has its own hosts, if
23848 &%hosts_override%& is set.
23849
23850 The string is first expanded, before being interpreted as a colon-separated
23851 list of host names or IP addresses, possibly including port numbers. The
23852 separator may be changed to something other than colon, as described in section
23853 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23854 item in a &%route_list%& setting for the &(manualroute)& router, as described
23855 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23856 of the &(manualroute)& router is not available here.
23857
23858 If the expansion fails, delivery is deferred. Unless the failure was caused by
23859 the inability to complete a lookup, the error is logged to the panic log as
23860 well as the main log. Host names are looked up either by searching directly for
23861 address records in the DNS or by calling &[gethostbyname()]& (or
23862 &[getipnodebyname()]& when available), depending on the setting of the
23863 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23864 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23865 address are used.
23866
23867 During delivery, the hosts are tried in order, subject to their retry status,
23868 unless &%hosts_randomize%& is set.
23869
23870
23871 .option hosts_avoid_esmtp smtp "host list&!!" unset
23872 .cindex "ESMTP, avoiding use of"
23873 .cindex "HELO" "forcing use of"
23874 .cindex "EHLO" "avoiding use of"
23875 .cindex "PIPELINING" "avoiding the use of"
23876 This option is for use with broken hosts that announce ESMTP facilities (for
23877 example, PIPELINING) and then fail to implement them properly. When a host
23878 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23879 start of the SMTP session. This means that it cannot use any of the ESMTP
23880 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23881
23882
23883 .option hosts_avoid_pipelining smtp "host list&!!" unset
23884 .cindex "PIPELINING" "avoiding the use of"
23885 Exim will not use the SMTP PIPELINING extension when delivering to any host
23886 that matches this list, even if the server host advertises PIPELINING support.
23887
23888
23889 .option hosts_avoid_tls smtp "host list&!!" unset
23890 .cindex "TLS" "avoiding for certain hosts"
23891 Exim will not try to start a TLS session when delivering to any host that
23892 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23893
23894 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23895 .cindex "TLS" "avoiding for certain hosts"
23896 Exim will not try to start a TLS session for a verify callout,
23897 or when delivering in cutthrough mode,
23898 to any host that matches this list.
23899
23900
23901 .option hosts_max_try smtp integer 5
23902 .cindex "host" "maximum number to try"
23903 .cindex "limit" "number of hosts tried"
23904 .cindex "limit" "number of MX tried"
23905 .cindex "MX record" "maximum tried"
23906 This option limits the number of IP addresses that are tried for any one
23907 delivery in cases where there are temporary delivery errors. Section
23908 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23909
23910
23911 .option hosts_max_try_hardlimit smtp integer 50
23912 This is an additional check on the maximum number of IP addresses that Exim
23913 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23914 why it exists.
23915
23916
23917
23918 .option hosts_nopass_tls smtp "host list&!!" unset
23919 .cindex "TLS" "passing connection"
23920 .cindex "multiple SMTP deliveries"
23921 .cindex "TLS" "multiple message deliveries"
23922 For any host that matches this list, a connection on which a TLS session has
23923 been started will not be passed to a new delivery process for sending another
23924 message on the same connection. See section &<<SECTmulmessam>>& for an
23925 explanation of when this might be needed.
23926
23927
23928 .option hosts_override smtp boolean false
23929 If this option is set and the &%hosts%& option is also set, any hosts that are
23930 attached to the address are ignored, and instead the hosts specified by the
23931 &%hosts%& option are always used. This option does not apply to
23932 &%fallback_hosts%&.
23933
23934
23935 .option hosts_randomize smtp boolean false
23936 .cindex "randomized host list"
23937 .cindex "host" "list of; randomized"
23938 .cindex "fallback" "randomized hosts"
23939 If this option is set, and either the list of hosts is taken from the
23940 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23941 were not obtained from MX records (this includes fallback hosts from the
23942 router), and were not randomized by the router, the order of trying the hosts
23943 is randomized each time the transport runs. Randomizing the order of a host
23944 list can be used to do crude load sharing.
23945
23946 When &%hosts_randomize%& is true, a host list may be split into groups whose
23947 order is separately randomized. This makes it possible to set up MX-like
23948 behaviour. The boundaries between groups are indicated by an item that is just
23949 &`+`& in the host list. For example:
23950 .code
23951 hosts = host1:host2:host3:+:host4:host5
23952 .endd
23953 The order of the first three hosts and the order of the last two hosts is
23954 randomized for each use, but the first three always end up before the last two.
23955 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23956
23957 .option hosts_require_auth smtp "host list&!!" unset
23958 .cindex "authentication" "required by client"
23959 This option provides a list of servers for which authentication must succeed
23960 before Exim will try to transfer a message. If authentication fails for
23961 servers which are not in this list, Exim tries to send unauthenticated. If
23962 authentication fails for one of these servers, delivery is deferred. This
23963 temporary error is detectable in the retry rules, so it can be turned into a
23964 hard failure if required. See also &%hosts_try_auth%&, and chapter
23965 &<<CHAPSMTPAUTH>>& for details of authentication.
23966
23967
23968 .option hosts_request_ocsp smtp "host list&!!" *
23969 .cindex "TLS" "requiring for certain servers"
23970 Exim will request a Certificate Status on a
23971 TLS session for any host that matches this list.
23972 &%tls_verify_certificates%& should also be set for the transport.
23973
23974 .option hosts_require_ocsp smtp "host list&!!" unset
23975 .cindex "TLS" "requiring for certain servers"
23976 Exim will request, and check for a valid Certificate Status being given, on a
23977 TLS session for any host that matches this list.
23978 &%tls_verify_certificates%& should also be set for the transport.
23979
23980 .option hosts_require_tls smtp "host list&!!" unset
23981 .cindex "TLS" "requiring for certain servers"
23982 Exim will insist on using a TLS session when delivering to any host that
23983 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23984 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23985 incoming messages, use an appropriate ACL.
23986
23987 .option hosts_try_auth smtp "host list&!!" unset
23988 .cindex "authentication" "optional in client"
23989 This option provides a list of servers to which, provided they announce
23990 authentication support, Exim will attempt to authenticate as a client when it
23991 connects. If authentication fails, Exim will try to transfer the message
23992 unauthenticated. See also &%hosts_require_auth%&, and chapter
23993 &<<CHAPSMTPAUTH>>& for details of authentication.
23994
23995 .option hosts_try_chunking smtp "host list&!!" *
23996 .cindex CHUNKING "enabling, in client"
23997 .cindex BDAT "SMTP command"
23998 .cindex "RFC 3030" "CHUNKING"
23999 This option provides a list of servers to which, provided they announce
24000 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24001 BDAT will not be used in conjunction with a transport filter.
24002
24003 .option hosts_try_fastopen smtp "host list!!" unset
24004 .cindex "fast open, TCP" "enabling, in client"
24005 .cindex "TCP Fast Open" "enabling, in client"
24006 .cindex "RFC 7413" "TCP Fast Open"
24007 This option provides a list of servers to which, provided
24008 the facility is supported by this system, Exim will attempt to
24009 perform a TCP Fast Open.
24010 No data is sent on the SYN segment but, if the remote server also
24011 supports the facility, it can send its SMTP banner immediately after
24012 the SYN,ACK segment.  This can save up to one round-trip time.
24013
24014 The facility is only active for previously-contacted servers,
24015 as the initiator must present a cookie in the SYN segment.
24016
24017 On (at least some) current Linux distributions the facility must be enabled
24018 in the kernel by the sysadmin before the support is usable.
24019
24020 .option hosts_try_prdr smtp "host list&!!" *
24021 .cindex "PRDR" "enabling, optional in client"
24022 This option provides a list of servers to which, provided they announce
24023 PRDR support, Exim will attempt to negotiate PRDR
24024 for multi-recipient messages.
24025 The option can usually be left as default.
24026
24027 .option interface smtp "string list&!!" unset
24028 .cindex "bind IP address"
24029 .cindex "IP address" "binding"
24030 .vindex "&$host$&"
24031 .vindex "&$host_address$&"
24032 This option specifies which interface to bind to when making an outgoing SMTP
24033 call. The value is an IP address, not an interface name such as
24034 &`eth0`&. Do not confuse this with the interface address that was used when a
24035 message was received, which is in &$received_ip_address$&, formerly known as
24036 &$interface_address$&. The name was changed to minimize confusion with the
24037 outgoing interface address. There is no variable that contains an outgoing
24038 interface address because, unless it is set by this option, its value is
24039 unknown.
24040
24041 During the expansion of the &%interface%& option the variables &$host$& and
24042 &$host_address$& refer to the host to which a connection is about to be made
24043 during the expansion of the string. Forced expansion failure, or an empty
24044 string result causes the option to be ignored. Otherwise, after expansion, the
24045 string must be a list of IP addresses, colon-separated by default, but the
24046 separator can be changed in the usual way. For example:
24047 .code
24048 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24049 .endd
24050 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24051 connection. If none of them are the correct type, the option is ignored. If
24052 &%interface%& is not set, or is ignored, the system's IP functions choose which
24053 interface to use if the host has more than one.
24054
24055
24056 .option keepalive smtp boolean true
24057 .cindex "keepalive" "on outgoing connection"
24058 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24059 connections. When set, it causes the kernel to probe idle connections
24060 periodically, by sending packets with &"old"& sequence numbers. The other end
24061 of the connection should send a acknowledgment if the connection is still okay
24062 or a reset if the connection has been aborted. The reason for doing this is
24063 that it has the beneficial effect of freeing up certain types of connection
24064 that can get stuck when the remote host is disconnected without tidying up the
24065 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24066 unreachable hosts.
24067
24068
24069 .option lmtp_ignore_quota smtp boolean false
24070 .cindex "LMTP" "ignoring quota errors"
24071 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24072 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24073 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24074
24075 .option max_rcpt smtp integer 100
24076 .cindex "RCPT" "maximum number of outgoing"
24077 This option limits the number of RCPT commands that are sent in a single
24078 SMTP message transaction. Each set of addresses is treated independently, and
24079 so can cause parallel connections to the same host if &%remote_max_parallel%&
24080 permits this.
24081
24082
24083 .option multi_domain smtp boolean&!! true
24084 .vindex "&$domain$&"
24085 When this option is set, the &(smtp)& transport can handle a number of
24086 addresses containing a mixture of different domains provided they all resolve
24087 to the same list of hosts. Turning the option off restricts the transport to
24088 handling only one domain at a time. This is useful if you want to use
24089 &$domain$& in an expansion for the transport, because it is set only when there
24090 is a single domain involved in a remote delivery.
24091
24092 It is expanded per-address and can depend on any of
24093 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24094 &$host$&, &$host_address$& and &$host_port$&.
24095
24096 .option port smtp string&!! "see below"
24097 .cindex "port" "sending TCP/IP"
24098 .cindex "TCP/IP" "setting outgoing port"
24099 This option specifies the TCP/IP port on the server to which Exim connects.
24100 &*Note:*& Do not confuse this with the port that was used when a message was
24101 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24102 The name was changed to minimize confusion with the outgoing port. There is no
24103 variable that contains an outgoing port.
24104
24105 If the value of this option begins with a digit it is taken as a port number;
24106 otherwise it is looked up using &[getservbyname()]&. The default value is
24107 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24108 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24109 is deferred.
24110
24111
24112
24113 .option protocol smtp string smtp
24114 .cindex "LMTP" "over TCP/IP"
24115 .cindex "ssmtp protocol" "outbound"
24116 .cindex "TLS" "SSL-on-connect outbound"
24117 .vindex "&$port$&"
24118 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24119 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24120 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24121 deliveries into closed message stores. Exim also has support for running LMTP
24122 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24123
24124 If this option is set to &"smtps"&, the default value for the &%port%& option
24125 changes to &"smtps"&, and the transport initiates TLS immediately after
24126 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24127 The Internet standards bodies strongly discourage use of this mode.
24128
24129
24130 .option retry_include_ip_address smtp boolean&!! true
24131 Exim normally includes both the host name and the IP address in the key it
24132 constructs for indexing retry data after a temporary delivery failure. This
24133 means that when one of several IP addresses for a host is failing, it gets
24134 tried periodically (controlled by the retry rules), but use of the other IP
24135 addresses is not affected.
24136
24137 However, in some dialup environments hosts are assigned a different IP address
24138 each time they connect. In this situation the use of the IP address as part of
24139 the retry key leads to undesirable behaviour. Setting this option false causes
24140 Exim to use only the host name.
24141 Since it is expanded it can be made to depend on the host or domain.
24142
24143
24144 .option serialize_hosts smtp "host list&!!" unset
24145 .cindex "serializing connections"
24146 .cindex "host" "serializing connections"
24147 Because Exim operates in a distributed manner, if several messages for the same
24148 host arrive at around the same time, more than one simultaneous connection to
24149 the remote host can occur. This is not usually a problem except when there is a
24150 slow link between the hosts. In that situation it may be helpful to restrict
24151 Exim to one connection at a time. This can be done by setting
24152 &%serialize_hosts%& to match the relevant hosts.
24153
24154 .cindex "hints database" "serializing deliveries to a host"
24155 Exim implements serialization by means of a hints database in which a record is
24156 written whenever a process connects to one of the restricted hosts. The record
24157 is deleted when the connection is completed. Obviously there is scope for
24158 records to get left lying around if there is a system or program crash. To
24159 guard against this, Exim ignores any records that are more than six hours old.
24160
24161 If you set up this kind of serialization, you should also arrange to delete the
24162 relevant hints database whenever your system reboots. The names of the files
24163 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24164 may be one or two files, depending on the type of DBM in use. The same files
24165 are used for ETRN serialization.
24166
24167 See also the &%max_parallel%& generic transport option.
24168
24169
24170 .option size_addition smtp integer 1024
24171 .cindex "SMTP" "SIZE"
24172 .cindex "message" "size issue for transport filter"
24173 .cindex "size" "of message"
24174 .cindex "transport" "filter"
24175 .cindex "filter" "transport filter"
24176 If a remote SMTP server indicates that it supports the SIZE option of the
24177 MAIL command, Exim uses this to pass over the message size at the start of
24178 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24179 sends, to allow for headers and other text that may be added during delivery by
24180 configuration options or in a transport filter. It may be necessary to increase
24181 this if a lot of text is added to messages.
24182
24183 Alternatively, if the value of &%size_addition%& is set negative, it disables
24184 the use of the SIZE option altogether.
24185
24186
24187 .option socks_proxy smtp string&!! unset
24188 .cindex proxy SOCKS
24189 This option enables use of SOCKS proxies for connections made by the
24190 transport.  For details see section &<<SECTproxySOCKS>>&.
24191
24192
24193 .option tls_certificate smtp string&!! unset
24194 .cindex "TLS" "client certificate, location of"
24195 .cindex "certificate" "client, location of"
24196 .vindex "&$host$&"
24197 .vindex "&$host_address$&"
24198 The value of this option must be the absolute path to a file which contains the
24199 client's certificate, for possible use when sending a message over an encrypted
24200 connection. The values of &$host$& and &$host_address$& are set to the name and
24201 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24202 details of TLS.
24203
24204 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24205 certificate when sending messages as a client. The global option of the same
24206 name specifies the certificate for Exim as a server; it is not automatically
24207 assumed that the same certificate should be used when Exim is operating as a
24208 client.
24209
24210
24211 .option tls_crl smtp string&!! unset
24212 .cindex "TLS" "client certificate revocation list"
24213 .cindex "certificate" "revocation list for client"
24214 This option specifies a certificate revocation list. The expanded value must
24215 be the name of a file that contains a CRL in PEM format.
24216
24217
24218 .option tls_dh_min_bits smtp integer 1024
24219 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24220 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24221 key agreement is negotiated, the server will provide a large prime number
24222 for use.  This option establishes the minimum acceptable size of that number.
24223 If the parameter offered by the server is too small, then the TLS handshake
24224 will fail.
24225
24226 Only supported when using GnuTLS.
24227
24228
24229 .option tls_privatekey smtp string&!! unset
24230 .cindex "TLS" "client private key, location of"
24231 .vindex "&$host$&"
24232 .vindex "&$host_address$&"
24233 The value of this option must be the absolute path to a file which contains the
24234 client's private key. This is used when sending a message over an encrypted
24235 connection using a client certificate. The values of &$host$& and
24236 &$host_address$& are set to the name and address of the server during the
24237 expansion. If this option is unset, or the expansion is forced to fail, or the
24238 result is an empty string, the private key is assumed to be in the same file as
24239 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24240
24241
24242 .option tls_require_ciphers smtp string&!! unset
24243 .cindex "TLS" "requiring specific ciphers"
24244 .cindex "cipher" "requiring specific"
24245 .vindex "&$host$&"
24246 .vindex "&$host_address$&"
24247 The value of this option must be a list of permitted cipher suites, for use
24248 when setting up an outgoing encrypted connection. (There is a global option of
24249 the same name for controlling incoming connections.) The values of &$host$& and
24250 &$host_address$& are set to the name and address of the server during the
24251 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24252 is used in different ways by OpenSSL and GnuTLS (see sections
24253 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24254 ciphers is a preference order.
24255
24256
24257
24258 .option tls_sni smtp string&!! unset
24259 .cindex "TLS" "Server Name Indication"
24260 .vindex "&$tls_sni$&"
24261 If this option is set then it sets the $tls_out_sni variable and causes any
24262 TLS session to pass this value as the Server Name Indication extension to
24263 the remote side, which can be used by the remote side to select an appropriate
24264 certificate and private key for the session.
24265
24266 See &<<SECTtlssni>>& for more information.
24267
24268 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24269 TLS extensions.
24270
24271
24272
24273
24274 .option tls_tempfail_tryclear smtp boolean true
24275 .cindex "4&'xx'& responses" "to STARTTLS"
24276 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24277 setting up a TLS session, this option determines whether or not Exim should try
24278 to deliver the message unencrypted. If it is set false, delivery to the
24279 current host is deferred; if there are other hosts, they are tried. If this
24280 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24281 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24282 TLS negotiation fails, Exim closes the current connection (because it is in an
24283 unknown state), opens a new one to the same host, and then tries the delivery
24284 in clear.
24285
24286
24287 .option tls_try_verify_hosts smtp "host list&!!" *
24288 .cindex "TLS" "server certificate verification"
24289 .cindex "certificate" "verification of server"
24290 This option gives a list of hosts for which, on encrypted connections,
24291 certificate verification will be tried but need not succeed.
24292 The &%tls_verify_certificates%& option must also be set.
24293 Note that unless the host is in this list
24294 TLS connections will be denied to hosts using self-signed certificates
24295 when &%tls_verify_certificates%& is matched.
24296 The &$tls_out_certificate_verified$& variable is set when
24297 certificate verification succeeds.
24298
24299
24300 .option tls_verify_cert_hostnames smtp "host list&!!" *
24301 .cindex "TLS" "server certificate hostname verification"
24302 .cindex "certificate" "verification of server"
24303 This option give a list of hosts for which,
24304 while verifying the server certificate,
24305 checks will be included on the host name
24306 (note that this will generally be the result of a DNS MX lookup)
24307 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24308 limited to being the initial component of a 3-or-more component FQDN.
24309
24310 There is no equivalent checking on client certificates.
24311
24312
24313 .option tls_verify_certificates smtp string&!! system
24314 .cindex "TLS" "server certificate verification"
24315 .cindex "certificate" "verification of server"
24316 .vindex "&$host$&"
24317 .vindex "&$host_address$&"
24318 The value of this option must be either the
24319 word "system"
24320 or the absolute path to
24321 a file or directory containing permitted certificates for servers,
24322 for use when setting up an encrypted connection.
24323
24324 The "system" value for the option will use a location compiled into the SSL library.
24325 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24326 is taken as empty and an explicit location
24327 must be specified.
24328
24329 The use of a directory for the option value is not available for GnuTLS versions
24330 preceding 3.3.6 and a single file must be used.
24331
24332 With OpenSSL the certificates specified
24333 explicitly
24334 either by file or directory
24335 are added to those given by the system default location.
24336
24337 The values of &$host$& and
24338 &$host_address$& are set to the name and address of the server during the
24339 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24340
24341 For back-compatibility,
24342 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24343 (a single-colon empty list counts as being set)
24344 and certificate verification fails the TLS connection is closed.
24345
24346
24347 .option tls_verify_hosts smtp "host list&!!" unset
24348 .cindex "TLS" "server certificate verification"
24349 .cindex "certificate" "verification of server"
24350 This option gives a list of hosts for which, on encrypted connections,
24351 certificate verification must succeed.
24352 The &%tls_verify_certificates%& option must also be set.
24353 If both this option and &%tls_try_verify_hosts%& are unset
24354 operation is as if this option selected all hosts.
24355
24356
24357
24358
24359 .section "How the limits for the number of hosts to try are used" &&&
24360          "SECTvalhosmax"
24361 .cindex "host" "maximum number to try"
24362 .cindex "limit" "hosts; maximum number tried"
24363 There are two options that are concerned with the number of hosts that are
24364 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24365 &%hosts_max_try_hardlimit%&.
24366
24367
24368 The &%hosts_max_try%& option limits the number of hosts that are tried
24369 for a single delivery. However, despite the term &"host"& in its name, the
24370 option actually applies to each IP address independently. In other words, a
24371 multihomed host is treated as several independent hosts, just as it is for
24372 retrying.
24373
24374 Many of the larger ISPs have multiple MX records which often point to
24375 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24376 created as a result of routing one of these domains.
24377
24378 Trying every single IP address on such a long list does not seem sensible; if
24379 several at the top of the list fail, it is reasonable to assume there is some
24380 problem that is likely to affect all of them. Roughly speaking, the value of
24381 &%hosts_max_try%& is the maximum number that are tried before deferring the
24382 delivery. However, the logic cannot be quite that simple.
24383
24384 Firstly, IP addresses that are skipped because their retry times have not
24385 arrived do not count, and in addition, addresses that are past their retry
24386 limits are also not counted, even when they are tried. This means that when
24387 some IP addresses are past their retry limits, more than the value of
24388 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24389 that all IP addresses are considered before timing out an email address (but
24390 see below for an exception).
24391
24392 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24393 list to see if there is a subsequent host with a different (higher valued) MX.
24394 If there is, that host is considered next, and the current IP address is used
24395 but not counted. This behaviour helps in the case of a domain with a retry rule
24396 that hardly ever delays any hosts, as is now explained:
24397
24398 Consider the case of a long list of hosts with one MX value, and a few with a
24399 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24400 hosts at the top of the list are tried at first. With the default retry rule,
24401 which specifies increasing retry times, the higher MX hosts are eventually
24402 tried when those at the top of the list are skipped because they have not
24403 reached their retry times.
24404
24405 However, it is common practice to put a fixed short retry time on domains for
24406 large ISPs, on the grounds that their servers are rarely down for very long.
24407 Unfortunately, these are exactly the domains that tend to resolve to long lists
24408 of hosts. The short retry time means that the lowest MX hosts are tried every
24409 time. The attempts may be in a different order because of random sorting, but
24410 without the special MX check, the higher MX hosts would never be tried until
24411 all the lower MX hosts had timed out (which might be several days), because
24412 there are always some lower MX hosts that have reached their retry times. With
24413 the special check, Exim considers at least one IP address from each MX value at
24414 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24415 reached.
24416
24417 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24418 particular, Exim normally eventually tries all the IP addresses before timing
24419 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24420 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24421 been set up with hundreds of IP addresses for some domains. It can
24422 take a very long time indeed for an address to time out in these cases.
24423
24424 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24425 Exim never tries more than this number of IP addresses; if it hits this limit
24426 and they are all timed out, the email address is bounced, even though not all
24427 possible IP addresses have been tried.
24428 .ecindex IIDsmttra1
24429 .ecindex IIDsmttra2
24430
24431
24432
24433
24434
24435 . ////////////////////////////////////////////////////////////////////////////
24436 . ////////////////////////////////////////////////////////////////////////////
24437
24438 .chapter "Address rewriting" "CHAPrewrite"
24439 .scindex IIDaddrew "rewriting" "addresses"
24440 There are some circumstances in which Exim automatically rewrites domains in
24441 addresses. The two most common are when an address is given without a domain
24442 (referred to as an &"unqualified address"&) or when an address contains an
24443 abbreviated domain that is expanded by DNS lookup.
24444
24445 Unqualified envelope addresses are accepted only for locally submitted
24446 messages, or for messages that are received from hosts matching
24447 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24448 appropriate. Unqualified addresses in header lines are qualified if they are in
24449 locally submitted messages, or messages from hosts that are permitted to send
24450 unqualified envelope addresses. Otherwise, unqualified addresses in header
24451 lines are neither qualified nor rewritten.
24452
24453 One situation in which Exim does &'not'& automatically rewrite a domain is
24454 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24455 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24456 do this. The new RFCs do not contain this suggestion.
24457
24458
24459 .section "Explicitly configured address rewriting" "SECID147"
24460 This chapter describes the rewriting rules that can be used in the
24461 main rewrite section of the configuration file, and also in the generic
24462 &%headers_rewrite%& option that can be set on any transport.
24463
24464 Some people believe that configured address rewriting is a Mortal Sin.
24465 Others believe that life is not possible without it. Exim provides the
24466 facility; you do not have to use it.
24467
24468 The main rewriting rules that appear in the &"rewrite"& section of the
24469 configuration file are applied to addresses in incoming messages, both envelope
24470 addresses and addresses in header lines. Each rule specifies the types of
24471 address to which it applies.
24472
24473 Whether or not addresses in header lines are rewritten depends on the origin of
24474 the headers and the type of rewriting. Global rewriting, that is, rewriting
24475 rules from the rewrite section of the configuration file, is applied only to
24476 those headers that were received with the message. Header lines that are added
24477 by ACLs or by a system filter or by individual routers or transports (which
24478 are specific to individual recipient addresses) are not rewritten by the global
24479 rules.
24480
24481 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24482 applies all headers except those added by routers and transports. That is, as
24483 well as the headers that were received with the message, it also applies to
24484 headers that were added by an ACL or a system filter.
24485
24486
24487 In general, rewriting addresses from your own system or domain has some
24488 legitimacy. Rewriting other addresses should be done only with great care and
24489 in special circumstances. The author of Exim believes that rewriting should be
24490 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24491 Although it can sometimes be used as a routing tool, this is very strongly
24492 discouraged.
24493
24494 There are two commonly encountered circumstances where rewriting is used, as
24495 illustrated by these examples:
24496
24497 .ilist
24498 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24499 exchange mail with each other behind a firewall, but there is only a single
24500 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24501 &'hitch.fict.example'& when sending mail off-site.
24502 .next
24503 A host rewrites the local parts of its own users so that, for example,
24504 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24505 .endlist
24506
24507
24508
24509 .section "When does rewriting happen?" "SECID148"
24510 .cindex "rewriting" "timing of"
24511 .cindex "&ACL;" "rewriting addresses in"
24512 Configured address rewriting can take place at several different stages of a
24513 message's processing.
24514
24515 .vindex "&$sender_address$&"
24516 At the start of an ACL for MAIL, the sender address may have been rewritten
24517 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24518 ordinary rewrite rules have yet been applied. If, however, the sender address
24519 is verified in the ACL, it is rewritten before verification, and remains
24520 rewritten thereafter. The subsequent value of &$sender_address$& is the
24521 rewritten address. This also applies if sender verification happens in a
24522 RCPT ACL. Otherwise, when the sender address is not verified, it is
24523 rewritten as soon as a message's header lines have been received.
24524
24525 .vindex "&$domain$&"
24526 .vindex "&$local_part$&"
24527 Similarly, at the start of an ACL for RCPT, the current recipient's address
24528 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24529 rewrite rules have yet been applied to it. However, the behaviour is different
24530 from the sender address when a recipient is verified. The address is rewritten
24531 for the verification, but the rewriting is not remembered at this stage. The
24532 value of &$local_part$& and &$domain$& after verification are always the same
24533 as they were before (that is, they contain the unrewritten &-- except for
24534 SMTP-time rewriting &-- address).
24535
24536 As soon as a message's header lines have been received, all the envelope
24537 recipient addresses are permanently rewritten, and rewriting is also applied to
24538 the addresses in the header lines (if configured). This happens before adding
24539 any header lines that were specified in MAIL or RCPT ACLs, and
24540 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24541 before the DATA ACL and &[local_scan()]& functions are run.
24542
24543 When an address is being routed, either for delivery or for verification,
24544 rewriting is applied immediately to child addresses that are generated by
24545 redirection, unless &%no_rewrite%& is set on the router.
24546
24547 .cindex "envelope sender" "rewriting at transport time"
24548 .cindex "rewriting" "at transport time"
24549 .cindex "header lines" "rewriting at transport time"
24550 At transport time, additional rewriting of addresses in header lines can be
24551 specified by setting the generic &%headers_rewrite%& option on a transport.
24552 This option contains rules that are identical in form to those in the rewrite
24553 section of the configuration file. They are applied to the original message
24554 header lines and any that were added by ACLs or a system filter. They are not
24555 applied to header lines that are added by routers or the transport.
24556
24557 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24558 transport option. However, it is not possible to rewrite envelope recipients at
24559 transport time.
24560
24561
24562
24563
24564 .section "Testing the rewriting rules that apply on input" "SECID149"
24565 .cindex "rewriting" "testing"
24566 .cindex "testing" "rewriting"
24567 Exim's input rewriting configuration appears in a part of the run time
24568 configuration file headed by &"begin rewrite"&. It can be tested by the
24569 &%-brw%& command line option. This takes an address (which can be a full RFC
24570 2822 address) as its argument. The output is a list of how the address would be
24571 transformed by the rewriting rules for each of the different places it might
24572 appear in an incoming message, that is, for each different header and for the
24573 envelope sender and recipient fields. For example,
24574 .code
24575 exim -brw ph10@exim.workshop.example
24576 .endd
24577 might produce the output
24578 .code
24579 sender: Philip.Hazel@exim.workshop.example
24580 from: Philip.Hazel@exim.workshop.example
24581 to: ph10@exim.workshop.example
24582 cc: ph10@exim.workshop.example
24583 bcc: ph10@exim.workshop.example
24584 reply-to: Philip.Hazel@exim.workshop.example
24585 env-from: Philip.Hazel@exim.workshop.example
24586 env-to: ph10@exim.workshop.example
24587 .endd
24588 which shows that rewriting has been set up for that address when used in any of
24589 the source fields, but not when it appears as a recipient address. At the
24590 present time, there is no equivalent way of testing rewriting rules that are
24591 set for a particular transport.
24592
24593
24594 .section "Rewriting rules" "SECID150"
24595 .cindex "rewriting" "rules"
24596 The rewrite section of the configuration file consists of lines of rewriting
24597 rules in the form
24598 .display
24599 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24600 .endd
24601 Rewriting rules that are specified for the &%headers_rewrite%& generic
24602 transport option are given as a colon-separated list. Each item in the list
24603 takes the same form as a line in the main rewriting configuration (except that
24604 any colons must be doubled, of course).
24605
24606 The formats of source patterns and replacement strings are described below.
24607 Each is terminated by white space, unless enclosed in double quotes, in which
24608 case normal quoting conventions apply inside the quotes. The flags are single
24609 characters which may appear in any order. Spaces and tabs between them are
24610 ignored.
24611
24612 For each address that could potentially be rewritten, the rules are scanned in
24613 order, and replacements for the address from earlier rules can themselves be
24614 replaced by later rules (but see the &"q"& and &"R"& flags).
24615
24616 The order in which addresses are rewritten is undefined, may change between
24617 releases, and must not be relied on, with one exception: when a message is
24618 received, the envelope sender is always rewritten first, before any header
24619 lines are rewritten. For example, the replacement string for a rewrite of an
24620 address in &'To:'& must not assume that the message's address in &'From:'& has
24621 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24622 that the envelope sender has already been rewritten.
24623
24624 .vindex "&$domain$&"
24625 .vindex "&$local_part$&"
24626 The variables &$local_part$& and &$domain$& can be used in the replacement
24627 string to refer to the address that is being rewritten. Note that lookup-driven
24628 rewriting can be done by a rule of the form
24629 .code
24630 *@*   ${lookup ...
24631 .endd
24632 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24633 refer to the address that is being rewritten.
24634
24635
24636 .section "Rewriting patterns" "SECID151"
24637 .cindex "rewriting" "patterns"
24638 .cindex "address list" "in a rewriting pattern"
24639 The source pattern in a rewriting rule is any item which may appear in an
24640 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24641 single-item address list, which means that it is expanded before being tested
24642 against the address. As always, if you use a regular expression as a pattern,
24643 you must take care to escape dollar and backslash characters, or use the &`\N`&
24644 facility to suppress string expansion within the regular expression.
24645
24646 Domains in patterns should be given in lower case. Local parts in patterns are
24647 case-sensitive. If you want to do case-insensitive matching of local parts, you
24648 can use a regular expression that starts with &`^(?i)`&.
24649
24650 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24651 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24652 depending on the type of match which occurred. These can be used in the
24653 replacement string to insert portions of the incoming address. &$0$& always
24654 refers to the complete incoming address. When a regular expression is used, the
24655 numerical variables are set from its capturing subexpressions. For other types
24656 of pattern they are set as follows:
24657
24658 .ilist
24659 If a local part or domain starts with an asterisk, the numerical variables
24660 refer to the character strings matched by asterisks, with &$1$& associated with
24661 the first asterisk, and &$2$& with the second, if present. For example, if the
24662 pattern
24663 .code
24664 *queen@*.fict.example
24665 .endd
24666 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24667 .code
24668 $0 = hearts-queen@wonderland.fict.example
24669 $1 = hearts-
24670 $2 = wonderland
24671 .endd
24672 Note that if the local part does not start with an asterisk, but the domain
24673 does, it is &$1$& that contains the wild part of the domain.
24674
24675 .next
24676 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24677 of the domain are placed in the next available numerical variables. Suppose,
24678 for example, that the address &'foo@bar.baz.example'& is processed by a
24679 rewriting rule of the form
24680 .display
24681 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24682 .endd
24683 and the key in the file that matches the domain is &`*.baz.example`&. Then
24684 .code
24685 $1 = foo
24686 $2 = bar
24687 $3 = baz.example
24688 .endd
24689 If the address &'foo@baz.example'& is looked up, this matches the same
24690 wildcard file entry, and in this case &$2$& is set to the empty string, but
24691 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24692 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24693 whole domain. For non-partial domain lookups, no numerical variables are set.
24694 .endlist
24695
24696
24697 .section "Rewriting replacements" "SECID152"
24698 .cindex "rewriting" "replacements"
24699 If the replacement string for a rule is a single asterisk, addresses that
24700 match the pattern and the flags are &'not'& rewritten, and no subsequent
24701 rewriting rules are scanned. For example,
24702 .code
24703 hatta@lookingglass.fict.example  *  f
24704 .endd
24705 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24706 &'From:'& headers.
24707
24708 .vindex "&$domain$&"
24709 .vindex "&$local_part$&"
24710 If the replacement string is not a single asterisk, it is expanded, and must
24711 yield a fully qualified address. Within the expansion, the variables
24712 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24713 Any letters they contain retain their original case &-- they are not lower
24714 cased. The numerical variables are set up according to the type of pattern that
24715 matched the address, as described above. If the expansion is forced to fail by
24716 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24717 current rule is abandoned, but subsequent rules may take effect. Any other
24718 expansion failure causes the entire rewriting operation to be abandoned, and an
24719 entry written to the panic log.
24720
24721
24722
24723 .section "Rewriting flags" "SECID153"
24724 There are three different kinds of flag that may appear on rewriting rules:
24725
24726 .ilist
24727 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24728 c, f, h, r, s, t.
24729 .next
24730 A flag that specifies rewriting at SMTP time: S.
24731 .next
24732 Flags that control the rewriting process: Q, q, R, w.
24733 .endlist
24734
24735 For rules that are part of the &%headers_rewrite%& generic transport option,
24736 E, F, T, and S are not permitted.
24737
24738
24739
24740 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24741          "SECID154"
24742 .cindex "rewriting" "flags"
24743 If none of the following flag letters, nor the &"S"& flag (see section
24744 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24745 and to both the sender and recipient fields of the envelope, whereas a
24746 transport-time rewriting rule just applies to all headers. Otherwise, the
24747 rewriting rule is skipped unless the relevant addresses are being processed.
24748 .display
24749 &`E`&       rewrite all envelope fields
24750 &`F`&       rewrite the envelope From field
24751 &`T`&       rewrite the envelope To field
24752 &`b`&       rewrite the &'Bcc:'& header
24753 &`c`&       rewrite the &'Cc:'& header
24754 &`f`&       rewrite the &'From:'& header
24755 &`h`&       rewrite all headers
24756 &`r`&       rewrite the &'Reply-To:'& header
24757 &`s`&       rewrite the &'Sender:'& header
24758 &`t`&       rewrite the &'To:'& header
24759 .endd
24760 "All headers" means all of the headers listed above that can be selected
24761 individually, plus their &'Resent-'& versions. It does not include
24762 other headers such as &'Subject:'& etc.
24763
24764 You should be particularly careful about rewriting &'Sender:'& headers, and
24765 restrict this to special known cases in your own domains.
24766
24767
24768 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24769 .cindex "SMTP" "rewriting malformed addresses"
24770 .cindex "RCPT" "rewriting argument of"
24771 .cindex "MAIL" "rewriting argument of"
24772 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24773 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24774 before any other processing; even before syntax checking. The pattern is
24775 required to be a regular expression, and it is matched against the whole of the
24776 data for the command, including any surrounding angle brackets.
24777
24778 .vindex "&$domain$&"
24779 .vindex "&$local_part$&"
24780 This form of rewrite rule allows for the handling of addresses that are not
24781 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24782 input). Because the input is not required to be a syntactically valid address,
24783 the variables &$local_part$& and &$domain$& are not available during the
24784 expansion of the replacement string. The result of rewriting replaces the
24785 original address in the MAIL or RCPT command.
24786
24787
24788 .section "Flags controlling the rewriting process" "SECID155"
24789 There are four flags which control the way the rewriting process works. These
24790 take effect only when a rule is invoked, that is, when the address is of the
24791 correct type (matches the flags) and matches the pattern:
24792
24793 .ilist
24794 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24795 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24796 absence of &"Q"& the rewritten address must always include a domain.
24797 .next
24798 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24799 even if no rewriting actually takes place because of a &"fail"& in the
24800 expansion. The &"q"& flag is not effective if the address is of the wrong type
24801 (does not match the flags) or does not match the pattern.
24802 .next
24803 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24804 address, up to ten times. It can be combined with the &"q"& flag, to stop
24805 rewriting once it fails to match (after at least one successful rewrite).
24806 .next
24807 .cindex "rewriting" "whole addresses"
24808 When an address in a header is rewritten, the rewriting normally applies only
24809 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24810 left unchanged. For example, rewriting might change
24811 .code
24812 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24813 .endd
24814 into
24815 .code
24816 From: Ford Prefect <prefectf@hitch.fict.example>
24817 .endd
24818 .cindex "RFC 2047"
24819 Sometimes there is a need to replace the whole address item, and this can be
24820 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24821 causes an address in a header line to be rewritten, the entire address is
24822 replaced, not just the working part. The replacement must be a complete RFC
24823 2822 address, including the angle brackets if necessary. If text outside angle
24824 brackets contains a character whose value is greater than 126 or less than 32
24825 (except for tab), the text is encoded according to RFC 2047. The character set
24826 is taken from &%headers_charset%&, which gets its default at build time.
24827
24828 When the &"w"& flag is set on a rule that causes an envelope address to be
24829 rewritten, all but the working part of the replacement address is discarded.
24830 .endlist
24831
24832
24833 .section "Rewriting examples" "SECID156"
24834 Here is an example of the two common rewriting paradigms:
24835 .code
24836 *@*.hitch.fict.example  $1@hitch.fict.example
24837 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24838                      {$value}fail}@hitch.fict.example bctfrF
24839 .endd
24840 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24841 the string expansion to fail if the lookup does not succeed. In this context it
24842 has the effect of leaving the original address unchanged, but Exim goes on to
24843 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24844 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24845 explicitly, which would cause the rewritten address to be the same as before,
24846 at the cost of a small bit of processing. Not supplying either of these is an
24847 error, since the rewritten address would then contain no local part.
24848
24849 The first example above replaces the domain with a superior, more general
24850 domain. This may not be desirable for certain local parts. If the rule
24851 .code
24852 root@*.hitch.fict.example  *
24853 .endd
24854 were inserted before the first rule, rewriting would be suppressed for the
24855 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24856
24857 Rewriting can be made conditional on a number of tests, by making use of
24858 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24859 messages that originate outside the local host:
24860 .code
24861 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24862                          {$1@hitch.fict.example}fail}"
24863 .endd
24864 The replacement string is quoted in this example because it contains white
24865 space.
24866
24867 .cindex "rewriting" "bang paths"
24868 .cindex "bang paths" "rewriting"
24869 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24870 an address it treats it as an unqualified local part which it qualifies with
24871 the local qualification domain (if the source of the message is local or if the
24872 remote host is permitted to send unqualified addresses). Rewriting can
24873 sometimes be used to handle simple bang paths with a fixed number of
24874 components. For example, the rule
24875 .code
24876 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24877 .endd
24878 rewrites a two-component bang path &'host.name!user'& as the domain address
24879 &'user@host.name'&. However, there is a security implication in using this as
24880 a global rewriting rule for envelope addresses. It can provide a backdoor
24881 method for using your system as a relay, because the incoming addresses appear
24882 to be local. If the bang path addresses are received via SMTP, it is safer to
24883 use the &"S"& flag to rewrite them as they are received, so that relay checking
24884 can be done on the rewritten addresses.
24885 .ecindex IIDaddrew
24886
24887
24888
24889
24890
24891 . ////////////////////////////////////////////////////////////////////////////
24892 . ////////////////////////////////////////////////////////////////////////////
24893
24894 .chapter "Retry configuration" "CHAPretry"
24895 .scindex IIDretconf1 "retry" "configuration, description of"
24896 .scindex IIDregconf2 "configuration file" "retry section"
24897 The &"retry"& section of the runtime configuration file contains a list of
24898 retry rules that control how often Exim tries to deliver messages that cannot
24899 be delivered at the first attempt. If there are no retry rules (the section is
24900 empty or not present), there are no retries. In this situation, temporary
24901 errors are treated as permanent. The default configuration contains a single,
24902 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24903 line option can be used to test which retry rule will be used for a given
24904 address, domain and error.
24905
24906 The most common cause of retries is temporary failure to deliver to a remote
24907 host because the host is down, or inaccessible because of a network problem.
24908 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24909 address) basis, not on a per-message basis. Thus, if one message has recently
24910 been delayed, delivery of a new message to the same host is not immediately
24911 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24912 log selector is set, the message
24913 .cindex "retry" "time not reached"
24914 &"retry time not reached"& is written to the main log whenever a delivery is
24915 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24916 the handling of errors during remote deliveries.
24917
24918 Retry processing applies to routing as well as to delivering, except as covered
24919 in the next paragraph. The retry rules do not distinguish between these
24920 actions. It is not possible, for example, to specify different behaviour for
24921 failures to route the domain &'snark.fict.example'& and failures to deliver to
24922 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24923 added complication, so did not implement it. However, although they share the
24924 same retry rule, the actual retry times for routing and transporting a given
24925 domain are maintained independently.
24926
24927 When a delivery is not part of a queue run (typically an immediate delivery on
24928 receipt of a message), the routers are always run, and local deliveries are
24929 always attempted, even if retry times are set for them. This makes for better
24930 behaviour if one particular message is causing problems (for example, causing
24931 quota overflow, or provoking an error in a filter file). If such a delivery
24932 suffers a temporary failure, the retry data is updated as normal, and
24933 subsequent delivery attempts from queue runs occur only when the retry time for
24934 the local address is reached.
24935
24936 .section "Changing retry rules" "SECID157"
24937 If you change the retry rules in your configuration, you should consider
24938 whether or not to delete the retry data that is stored in Exim's spool area in
24939 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24940 always safe; that is why they are called &"hints"&.
24941
24942 The hints retry data contains suggested retry times based on the previous
24943 rules. In the case of a long-running problem with a remote host, it might
24944 record the fact that the host has timed out. If your new rules increase the
24945 timeout time for such a host, you should definitely remove the old retry data
24946 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24947 messages that it should now be retaining.
24948
24949
24950
24951 .section "Format of retry rules" "SECID158"
24952 .cindex "retry" "rules"
24953 Each retry rule occupies one line and consists of three or four parts,
24954 separated by white space: a pattern, an error name, an optional list of sender
24955 addresses, and a list of retry parameters. The pattern and sender lists must be
24956 enclosed in double quotes if they contain white space. The rules are searched
24957 in order until one is found where the pattern, error name, and sender list (if
24958 present) match the failing host or address, the error that occurred, and the
24959 message's sender, respectively.
24960
24961
24962 The pattern is any single item that may appear in an address list (see section
24963 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24964 which means that it is expanded before being tested against the address that
24965 has been delayed. A negated address list item is permitted. Address
24966 list processing treats a plain domain name as if it were preceded by &"*@"&,
24967 which makes it possible for many retry rules to start with just a domain. For
24968 example,
24969 .code
24970 lookingglass.fict.example        *  F,24h,30m;
24971 .endd
24972 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24973 whereas
24974 .code
24975 alice@lookingglass.fict.example  *  F,24h,30m;
24976 .endd
24977 applies only to temporary failures involving the local part &%alice%&.
24978 In practice, almost all rules start with a domain name pattern without a local
24979 part.
24980
24981 .cindex "regular expressions" "in retry rules"
24982 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24983 must match a complete address, not just a domain, because that is how regular
24984 expressions work in address lists.
24985 .display
24986 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24987 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24988 .endd
24989
24990
24991 .section "Choosing which retry rule to use for address errors" "SECID159"
24992 When Exim is looking for a retry rule after a routing attempt has failed (for
24993 example, after a DNS timeout), each line in the retry configuration is tested
24994 against the complete address only if &%retry_use_local_part%& is set for the
24995 router. Otherwise, only the domain is used, except when matching against a
24996 regular expression, when the local part of the address is replaced with &"*"&.
24997 A domain on its own can match a domain pattern, or a pattern that starts with
24998 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24999 &%check_local_user%& is true, and false for other routers.
25000
25001 Similarly, when Exim is looking for a retry rule after a local delivery has
25002 failed (for example, after a mailbox full error), each line in the retry
25003 configuration is tested against the complete address only if
25004 &%retry_use_local_part%& is set for the transport (it defaults true for all
25005 local transports).
25006
25007 .cindex "4&'xx'& responses" "retry rules for"
25008 However, when Exim is looking for a retry rule after a remote delivery attempt
25009 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25010 whole address is always used as the key when searching the retry rules. The
25011 rule that is found is used to create a retry time for the combination of the
25012 failing address and the message's sender. It is the combination of sender and
25013 recipient that is delayed in subsequent queue runs until its retry time is
25014 reached. You can delay the recipient without regard to the sender by setting
25015 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25016 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25017 commands.
25018
25019
25020
25021 .section "Choosing which retry rule to use for host and message errors" &&&
25022          "SECID160"
25023 For a temporary error that is not related to an individual address (for
25024 example, a connection timeout), each line in the retry configuration is checked
25025 twice. First, the name of the remote host is used as a domain name (preceded by
25026 &"*@"& when matching a regular expression). If this does not match the line,
25027 the domain from the email address is tried in a similar fashion. For example,
25028 suppose the MX records for &'a.b.c.example'& are
25029 .code
25030 a.b.c.example  MX  5  x.y.z.example
25031                MX  6  p.q.r.example
25032                MX  7  m.n.o.example
25033 .endd
25034 and the retry rules are
25035 .code
25036 p.q.r.example    *      F,24h,30m;
25037 a.b.c.example    *      F,4d,45m;
25038 .endd
25039 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25040 first rule matches neither the host nor the domain, so Exim looks at the second
25041 rule. This does not match the host, but it does match the domain, so it is used
25042 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25043 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25044 first retry rule is used, because it matches the host.
25045
25046 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25047 first rule to determine retry times, but for all the other hosts for the domain
25048 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25049 routing to &'a.b.c.example'& suffers a temporary failure.
25050
25051 &*Note*&: The host name is used when matching the patterns, not its IP address.
25052 However, if a message is routed directly to an IP address without the use of a
25053 host name, for example, if a &(manualroute)& router contains a setting such as:
25054 .code
25055 route_list = *.a.example  192.168.34.23
25056 .endd
25057 then the &"host name"& that is used when searching for a retry rule is the
25058 textual form of the IP address.
25059
25060 .section "Retry rules for specific errors" "SECID161"
25061 .cindex "retry" "specific errors; specifying"
25062 The second field in a retry rule is the name of a particular error, or an
25063 asterisk, which matches any error. The errors that can be tested for are:
25064
25065 .vlist
25066 .vitem &%auth_failed%&
25067 Authentication failed when trying to send to a host in the
25068 &%hosts_require_auth%& list in an &(smtp)& transport.
25069
25070 .vitem &%data_4xx%&
25071 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25072 after the command, or after sending the message's data.
25073
25074 .vitem &%mail_4xx%&
25075 A 4&'xx'& error was received for an outgoing MAIL command.
25076
25077 .vitem &%rcpt_4xx%&
25078 A 4&'xx'& error was received for an outgoing RCPT command.
25079 .endlist
25080
25081 For the three 4&'xx'& errors, either the first or both of the x's can be given
25082 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25083 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25084 and have retries every ten minutes with a one-hour timeout, you could set up a
25085 retry rule of this form:
25086 .code
25087 the.domain.name  rcpt_452   F,1h,10m
25088 .endd
25089 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25090 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25091
25092 .vlist
25093 .vitem &%lost_connection%&
25094 A server unexpectedly closed the SMTP connection. There may, of course,
25095 legitimate reasons for this (host died, network died), but if it repeats a lot
25096 for the same host, it indicates something odd.
25097
25098 .vitem &%lookup%&
25099 A DNS lookup for a host failed.
25100 Note that a &%dnslookup%& router will need to have matched
25101 its &%fail_defer_domains%& option for this retry type to be usable.
25102 Also note that a &%manualroute%& router will probably need
25103 its &%host_find_failed%& option set to &%defer%&.
25104
25105 .vitem &%refused_MX%&
25106 A connection to a host obtained from an MX record was refused.
25107
25108 .vitem &%refused_A%&
25109 A connection to a host not obtained from an MX record was refused.
25110
25111 .vitem &%refused%&
25112 A connection was refused.
25113
25114 .vitem &%timeout_connect_MX%&
25115 A connection attempt to a host obtained from an MX record timed out.
25116
25117 .vitem &%timeout_connect_A%&
25118 A connection attempt to a host not obtained from an MX record timed out.
25119
25120 .vitem &%timeout_connect%&
25121 A connection attempt timed out.
25122
25123 .vitem &%timeout_MX%&
25124 There was a timeout while connecting or during an SMTP session with a host
25125 obtained from an MX record.
25126
25127 .vitem &%timeout_A%&
25128 There was a timeout while connecting or during an SMTP session with a host not
25129 obtained from an MX record.
25130
25131 .vitem &%timeout%&
25132 There was a timeout while connecting or during an SMTP session.
25133
25134 .vitem &%tls_required%&
25135 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25136 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25137 to STARTTLS, or there was a problem setting up the TLS connection.
25138
25139 .vitem &%quota%&
25140 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25141 transport.
25142
25143 .vitem &%quota_%&<&'time'&>
25144 .cindex "quota" "error testing in retry rule"
25145 .cindex "retry" "quota error testing"
25146 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25147 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25148 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25149 for four days.
25150 .endlist
25151
25152 .cindex "mailbox" "time of last read"
25153 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25154 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25155 it should be based on the last time that the user accessed the mailbox.
25156 However, it is not always possible to determine this. Exim uses the following
25157 heuristic rules:
25158
25159 .ilist
25160 If the mailbox is a single file, the time of last access (the &"atime"&) is
25161 used. As no new messages are being delivered (because the mailbox is over
25162 quota), Exim does not access the file, so this is the time of last user access.
25163 .next
25164 .cindex "maildir format" "time of last read"
25165 For a maildir delivery, the time of last modification of the &_new_&
25166 subdirectory is used. As the mailbox is over quota, no new files are created in
25167 the &_new_& subdirectory, because no new messages are being delivered. Any
25168 change to the &_new_& subdirectory is therefore assumed to be the result of an
25169 MUA moving a new message to the &_cur_& directory when it is first read. The
25170 time that is used is therefore the last time that the user read a new message.
25171 .next
25172 For other kinds of multi-file mailbox, the time of last access cannot be
25173 obtained, so a retry rule that uses this type of error field is never matched.
25174 .endlist
25175
25176 The quota errors apply both to system-enforced quotas and to Exim's own quota
25177 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25178 when a local delivery is deferred because a partition is full (the ENOSPC
25179 error).
25180
25181
25182
25183 .section "Retry rules for specified senders" "SECID162"
25184 .cindex "retry" "rules; sender-specific"
25185 You can specify retry rules that apply only when the failing message has a
25186 specific sender. In particular, this can be used to define retry rules that
25187 apply only to bounce messages. The third item in a retry rule can be of this
25188 form:
25189 .display
25190 &`senders=`&<&'address list'&>
25191 .endd
25192 The retry timings themselves are then the fourth item. For example:
25193 .code
25194 *   rcpt_4xx   senders=:   F,1h,30m
25195 .endd
25196 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25197 host. If the address list contains white space, it must be enclosed in quotes.
25198 For example:
25199 .code
25200 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25201 .endd
25202 &*Warning*&: This facility can be unhelpful if it is used for host errors
25203 (which do not depend on the recipient). The reason is that the sender is used
25204 only to match the retry rule. Once the rule has been found for a host error,
25205 its contents are used to set a retry time for the host, and this will apply to
25206 all messages, not just those with specific senders.
25207
25208 When testing retry rules using &%-brt%&, you can supply a sender using the
25209 &%-f%& command line option, like this:
25210 .code
25211 exim -f "" -brt user@dom.ain
25212 .endd
25213 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25214 list is never matched.
25215
25216
25217
25218
25219
25220 .section "Retry parameters" "SECID163"
25221 .cindex "retry" "parameters in rules"
25222 The third (or fourth, if a senders list is present) field in a retry rule is a
25223 sequence of retry parameter sets, separated by semicolons. Each set consists of
25224 .display
25225 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25226 .endd
25227 The letter identifies the algorithm for computing a new retry time; the cutoff
25228 time is the time beyond which this algorithm no longer applies, and the
25229 arguments vary the algorithm's action. The cutoff time is measured from the
25230 time that the first failure for the domain (combined with the local part if
25231 relevant) was detected, not from the time the message was received.
25232
25233 .cindex "retry" "algorithms"
25234 .cindex "retry" "fixed intervals"
25235 .cindex "retry" "increasing intervals"
25236 .cindex "retry" "random intervals"
25237 The available algorithms are:
25238
25239 .ilist
25240 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25241 the interval.
25242 .next
25243 &'G'&: retry at geometrically increasing intervals. The first argument
25244 specifies a starting value for the interval, and the second a multiplier, which
25245 is used to increase the size of the interval at each retry.
25246 .next
25247 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25248 retry, the previous interval is multiplied by the factor in order to get a
25249 maximum for the next interval. The minimum interval is the first argument of
25250 the parameter, and an actual interval is chosen randomly between them. Such a
25251 rule has been found to be helpful in cluster configurations when all the
25252 members of the cluster restart at once, and may therefore synchronize their
25253 queue processing times.
25254 .endlist
25255
25256 When computing the next retry time, the algorithm definitions are scanned in
25257 order until one whose cutoff time has not yet passed is reached. This is then
25258 used to compute a new retry time that is later than the current time. In the
25259 case of fixed interval retries, this simply means adding the interval to the
25260 current time. For geometrically increasing intervals, retry intervals are
25261 computed from the rule's parameters until one that is greater than the previous
25262 interval is found. The main configuration variable
25263 .cindex "limit" "retry interval"
25264 .cindex "retry" "interval, maximum"
25265 .oindex "&%retry_interval_max%&"
25266 &%retry_interval_max%& limits the maximum interval between retries. It
25267 cannot be set greater than &`24h`&, which is its default value.
25268
25269 A single remote domain may have a number of hosts associated with it, and each
25270 host may have more than one IP address. Retry algorithms are selected on the
25271 basis of the domain name, but are applied to each IP address independently. If,
25272 for example, a host has two IP addresses and one is unusable, Exim will
25273 generate retry times for it and will not try to use it until its next retry
25274 time comes. Thus the good IP address is likely to be tried first most of the
25275 time.
25276
25277 .cindex "hints database" "use for retrying"
25278 Retry times are hints rather than promises. Exim does not make any attempt to
25279 run deliveries exactly at the computed times. Instead, a queue runner process
25280 starts delivery processes for delayed messages periodically, and these attempt
25281 new deliveries only for those addresses that have passed their next retry time.
25282 If a new message arrives for a deferred address, an immediate delivery attempt
25283 occurs only if the address has passed its retry time. In the absence of new
25284 messages, the minimum time between retries is the interval between queue runner
25285 processes. There is not much point in setting retry times of five minutes if
25286 your queue runners happen only once an hour, unless there are a significant
25287 number of incoming messages (which might be the case on a system that is
25288 sending everything to a smart host, for example).
25289
25290 The data in the retry hints database can be inspected by using the
25291 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25292 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25293 &'exinext'& utility script can be used to find out what the next retry times
25294 are for the hosts associated with a particular mail domain, and also for local
25295 deliveries that have been deferred.
25296
25297
25298 .section "Retry rule examples" "SECID164"
25299 Here are some example retry rules:
25300 .code
25301 alice@wonderland.fict.example quota_5d  F,7d,3h
25302 wonderland.fict.example       quota_5d
25303 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25304 lookingglass.fict.example     *         F,24h,30m;
25305 *                 refused_A   F,2h,20m;
25306 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25307 .endd
25308 The first rule sets up special handling for mail to
25309 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25310 mailbox has not been read for at least 5 days. Retries continue every three
25311 hours for 7 days. The second rule handles over-quota errors for all other local
25312 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25313 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25314 fail are bounced immediately if the mailbox has not been read for at least 5
25315 days.
25316
25317 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25318 happen every 15 minutes for an hour, then with geometrically increasing
25319 intervals until two days have passed since a delivery first failed. After the
25320 first hour there is a delay of one hour, then two hours, then four hours, and
25321 so on (this is a rather extreme example).
25322
25323 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25324 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25325 all other domains, with special action for connection refusal from hosts that
25326 were not obtained from an MX record.
25327
25328 The final rule in a retry configuration should always have asterisks in the
25329 first two fields so as to provide a general catch-all for any addresses that do
25330 not have their own special handling. This example tries every 15 minutes for 2
25331 hours, then with intervals starting at one hour and increasing by a factor of
25332 1.5 up to 16 hours, then every 8 hours up to 5 days.
25333
25334
25335
25336 .section "Timeout of retry data" "SECID165"
25337 .cindex "timeout" "of retry data"
25338 .oindex "&%retry_data_expire%&"
25339 .cindex "hints database" "data expiry"
25340 .cindex "retry" "timeout of data"
25341 Exim timestamps the data that it writes to its retry hints database. When it
25342 consults the data during a delivery it ignores any that is older than the value
25343 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25344 been tried for 7 days, Exim will try to deliver to it immediately a message
25345 arrives, and if that fails, it will calculate a retry time as if it were
25346 failing for the first time.
25347
25348 This improves the behaviour for messages routed to rarely-used hosts such as MX
25349 backups. If such a host was down at one time, and happens to be down again when
25350 Exim tries a month later, using the old retry data would imply that it had been
25351 down all the time, which is not a justified assumption.
25352
25353 If a host really is permanently dead, this behaviour causes a burst of retries
25354 every now and again, but only if messages routed to it are rare. If there is a
25355 message at least once every 7 days the retry data never expires.
25356
25357
25358
25359
25360 .section "Long-term failures" "SECID166"
25361 .cindex "delivery failure, long-term"
25362 .cindex "retry" "after long-term failure"
25363 Special processing happens when an email address has been failing for so long
25364 that the cutoff time for the last algorithm is reached. For example, using the
25365 default retry rule:
25366 .code
25367 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25368 .endd
25369 the cutoff time is four days. Reaching the retry cutoff is independent of how
25370 long any specific message has been failing; it is the length of continuous
25371 failure for the recipient address that counts.
25372
25373 When the cutoff time is reached for a local delivery, or for all the IP
25374 addresses associated with a remote delivery, a subsequent delivery failure
25375 causes Exim to give up on the address, and a bounce message is generated.
25376 In order to cater for new messages that use the failing address, a next retry
25377 time is still computed from the final algorithm, and is used as follows:
25378
25379 For local deliveries, one delivery attempt is always made for any subsequent
25380 messages. If this delivery fails, the address fails immediately. The
25381 post-cutoff retry time is not used.
25382
25383 If the delivery is remote, there are two possibilities, controlled by the
25384 .oindex "&%delay_after_cutoff%&"
25385 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25386 default. Until the post-cutoff retry time for one of the IP addresses is
25387 reached, the failing email address is bounced immediately, without a delivery
25388 attempt taking place. After that time, one new delivery attempt is made to
25389 those IP addresses that are past their retry times, and if that still fails,
25390 the address is bounced and new retry times are computed.
25391
25392 In other words, when all the hosts for a given email address have been failing
25393 for a long time, Exim bounces rather then defers until one of the hosts' retry
25394 times is reached. Then it tries once, and bounces if that attempt fails. This
25395 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25396 to a broken destination, but if the host does recover, Exim will eventually
25397 notice.
25398
25399 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25400 addresses are past their final cutoff time, Exim tries to deliver to those IP
25401 addresses that have not been tried since the message arrived. If there are
25402 no suitable IP addresses, or if they all fail, the address is bounced. In other
25403 words, it does not delay when a new message arrives, but tries the expired
25404 addresses immediately, unless they have been tried since the message arrived.
25405 If there is a continuous stream of messages for the failing domains, setting
25406 &%delay_after_cutoff%& false means that there will be many more attempts to
25407 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25408 true.
25409
25410 .section "Deliveries that work intermittently" "SECID167"
25411 .cindex "retry" "intermittently working deliveries"
25412 Some additional logic is needed to cope with cases where a host is
25413 intermittently available, or when a message has some attribute that prevents
25414 its delivery when others to the same address get through. In this situation,
25415 because some messages are successfully delivered, the &"retry clock"& for the
25416 host or address keeps getting reset by the successful deliveries, and so
25417 failing messages remain on the queue for ever because the cutoff time is never
25418 reached.
25419
25420 Two exceptional actions are applied to prevent this happening. The first
25421 applies to errors that are related to a message rather than a remote host.
25422 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25423 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25424 commands, and quota failures. For this type of error, if a message's arrival
25425 time is earlier than the &"first failed"& time for the error, the earlier time
25426 is used when scanning the retry rules to decide when to try next and when to
25427 time out the address.
25428
25429 The exceptional second action applies in all cases. If a message has been on
25430 the queue for longer than the cutoff time of any applicable retry rule for a
25431 given address, a delivery is attempted for that address, even if it is not yet
25432 time, and if this delivery fails, the address is timed out. A new retry time is
25433 not computed in this case, so that other messages for the same address are
25434 considered immediately.
25435 .ecindex IIDretconf1
25436 .ecindex IIDregconf2
25437
25438
25439
25440
25441
25442
25443 . ////////////////////////////////////////////////////////////////////////////
25444 . ////////////////////////////////////////////////////////////////////////////
25445
25446 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25447 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25448 .scindex IIDauthconf2 "authentication"
25449 The &"authenticators"& section of Exim's run time configuration is concerned
25450 with SMTP authentication. This facility is an extension to the SMTP protocol,
25451 described in RFC 2554, which allows a client SMTP host to authenticate itself
25452 to a server. This is a common way for a server to recognize clients that are
25453 permitted to use it as a relay. SMTP authentication is not of relevance to the
25454 transfer of mail between servers that have no managerial connection with each
25455 other.
25456
25457 .cindex "AUTH" "description of"
25458 Very briefly, the way SMTP authentication works is as follows:
25459
25460 .ilist
25461 The server advertises a number of authentication &'mechanisms'& in response to
25462 the client's EHLO command.
25463 .next
25464 The client issues an AUTH command, naming a specific mechanism. The command
25465 may, optionally, contain some authentication data.
25466 .next
25467 The server may issue one or more &'challenges'&, to which the client must send
25468 appropriate responses. In simple authentication mechanisms, the challenges are
25469 just prompts for user names and passwords. The server does not have to issue
25470 any challenges &-- in some mechanisms the relevant data may all be transmitted
25471 with the AUTH command.
25472 .next
25473 The server either accepts or denies authentication.
25474 .next
25475 If authentication succeeds, the client may optionally make use of the AUTH
25476 option on the MAIL command to pass an authenticated sender in subsequent
25477 mail transactions. Authentication lasts for the remainder of the SMTP
25478 connection.
25479 .next
25480 If authentication fails, the client may give up, or it may try a different
25481 authentication mechanism, or it may try transferring mail over the
25482 unauthenticated connection.
25483 .endlist
25484
25485 If you are setting up a client, and want to know which authentication
25486 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25487 SMTP port) on the server, and issue an EHLO command. The response to this
25488 includes the list of supported mechanisms. For example:
25489 .display
25490 &`$ `&&*&`telnet server.example 25`&*&
25491 &`Trying 192.168.34.25...`&
25492 &`Connected to server.example.`&
25493 &`Escape character is &#x0027;^]&#x0027;.`&
25494 &`220 server.example ESMTP Exim 4.20 ...`&
25495 &*&`ehlo client.example`&*&
25496 &`250-server.example Hello client.example [10.8.4.5]`&
25497 &`250-SIZE 52428800`&
25498 &`250-PIPELINING`&
25499 &`250-AUTH PLAIN`&
25500 &`250 HELP`&
25501 .endd
25502 The second-last line of this example output shows that the server supports
25503 authentication using the PLAIN mechanism. In Exim, the different authentication
25504 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25505 routers and transports, which authenticators are included in the binary is
25506 controlled by build-time definitions. The following are currently available,
25507 included by setting
25508 .code
25509 AUTH_CRAM_MD5=yes
25510 AUTH_CYRUS_SASL=yes
25511 AUTH_DOVECOT=yes
25512 AUTH_GSASL=yes
25513 AUTH_HEIMDAL_GSSAPI=yes
25514 AUTH_PLAINTEXT=yes
25515 AUTH_SPA=yes
25516 AUTH_TLS=yes
25517 .endd
25518 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25519 authentication mechanism (RFC 2195), and the second provides an interface to
25520 the Cyrus SASL authentication library.
25521 The third is an interface to Dovecot's authentication system, delegating the
25522 work via a socket interface.
25523 The fourth provides an interface to the GNU SASL authentication library, which
25524 provides mechanisms but typically not data sources.
25525 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25526 supporting setting a server keytab.
25527 The sixth can be configured to support
25528 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25529 not formally documented, but used by several MUAs. The seventh authenticator
25530 supports Microsoft's &'Secure Password Authentication'& mechanism.
25531 The eighth is an Exim authenticator but not an SMTP one;
25532 instead it can use information from a TLS negotiation.
25533
25534 The authenticators are configured using the same syntax as other drivers (see
25535 section &<<SECTfordricon>>&). If no authenticators are required, no
25536 authentication section need be present in the configuration file. Each
25537 authenticator can in principle have both server and client functions. When Exim
25538 is receiving SMTP mail, it is acting as a server; when it is sending out
25539 messages over SMTP, it is acting as a client. Authenticator configuration
25540 options are provided for use in both these circumstances.
25541
25542 To make it clear which options apply to which situation, the prefixes
25543 &%server_%& and &%client_%& are used on option names that are specific to
25544 either the server or the client function, respectively. Server and client
25545 functions are disabled if none of their options are set. If an authenticator is
25546 to be used for both server and client functions, a single definition, using
25547 both sets of options, is required. For example:
25548 .code
25549 cram:
25550   driver = cram_md5
25551   public_name = CRAM-MD5
25552   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25553   client_name = ph10
25554   client_secret = secret2
25555 .endd
25556 The &%server_%& option is used when Exim is acting as a server, and the
25557 &%client_%& options when it is acting as a client.
25558
25559 Descriptions of the individual authenticators are given in subsequent chapters.
25560 The remainder of this chapter covers the generic options for the
25561 authenticators, followed by general discussion of the way authentication works
25562 in Exim.
25563
25564 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25565 per-mechanism basis.  Please read carefully to determine which variables hold
25566 account labels such as usercodes and which hold passwords or other
25567 authenticating data.
25568
25569 Note that some mechanisms support two different identifiers for accounts: the
25570 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25571 and &'authz'& are commonly encountered.  The American spelling is standard here.
25572 Conceptually, authentication data such as passwords are tied to the identifier
25573 used to authenticate; servers may have rules to permit one user to act as a
25574 second user, so that after login the session is treated as though that second
25575 user had logged in.  That second user is the &'authorization id'&.  A robust
25576 configuration might confirm that the &'authz'& field is empty or matches the
25577 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25578 as verified data, the &'authz'& as an unverified request which the server might
25579 choose to honour.
25580
25581 A &'realm'& is a text string, typically a domain name, presented by a server
25582 to a client to help it select an account and credentials to use.  In some
25583 mechanisms, the client and server provably agree on the realm, but clients
25584 typically can not treat the realm as secure data to be blindly trusted.
25585
25586
25587
25588 .section "Generic options for authenticators" "SECID168"
25589 .cindex "authentication" "generic options"
25590 .cindex "options" "generic; for authenticators"
25591
25592 .option client_condition authenticators string&!! unset
25593 When Exim is authenticating as a client, it skips any authenticator whose
25594 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25595 used, for example, to skip plain text authenticators when the connection is not
25596 encrypted by a setting such as:
25597 .code
25598 client_condition = ${if !eq{$tls_out_cipher}{}}
25599 .endd
25600
25601
25602 .option client_set_id authenticators string&!! unset
25603 When client authentication succeeds, this condition is expanded; the
25604 result is used in the log lines for outbound messages.
25605 Typically it will be the user name used for authentication.
25606
25607
25608 .option driver authenticators string unset
25609 This option must always be set. It specifies which of the available
25610 authenticators is to be used.
25611
25612
25613 .option public_name authenticators string unset
25614 This option specifies the name of the authentication mechanism that the driver
25615 implements, and by which it is known to the outside world. These names should
25616 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25617 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25618 defaults to the driver's instance name.
25619
25620
25621 .option server_advertise_condition authenticators string&!! unset
25622 When a server is about to advertise an authentication mechanism, the condition
25623 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25624 mechanism is not advertised.
25625 If the expansion fails, the mechanism is not advertised. If the failure was not
25626 forced, and was not caused by a lookup defer, the incident is logged.
25627 See section &<<SECTauthexiser>>& below for further discussion.
25628
25629
25630 .option server_condition authenticators string&!! unset
25631 This option must be set for a &%plaintext%& server authenticator, where it
25632 is used directly to control authentication. See section &<<SECTplainserver>>&
25633 for details.
25634
25635 For the &(gsasl)& authenticator, this option is required for various
25636 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25637
25638 For the other authenticators, &%server_condition%& can be used as an additional
25639 authentication or authorization mechanism that is applied after the other
25640 authenticator conditions succeed. If it is set, it is expanded when the
25641 authenticator would otherwise return a success code. If the expansion is forced
25642 to fail, authentication fails. Any other expansion failure causes a temporary
25643 error code to be returned. If the result of a successful expansion is an empty
25644 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25645 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25646 other result, a temporary error code is returned, with the expanded string as
25647 the error text.
25648
25649
25650 .option server_debug_print authenticators string&!! unset
25651 If this option is set and authentication debugging is enabled (see the &%-d%&
25652 command line option), the string is expanded and included in the debugging
25653 output when the authenticator is run as a server. This can help with checking
25654 out the values of variables.
25655 If expansion of the string fails, the error message is written to the debugging
25656 output, and Exim carries on processing.
25657
25658
25659 .option server_set_id authenticators string&!! unset
25660 .vindex "&$authenticated_id$&"
25661 When an Exim server successfully authenticates a client, this string is
25662 expanded using data from the authentication, and preserved for any incoming
25663 messages in the variable &$authenticated_id$&. It is also included in the log
25664 lines for incoming messages. For example, a user/password authenticator
25665 configuration might preserve the user name that was used to authenticate, and
25666 refer to it subsequently during delivery of the message.
25667 If expansion fails, the option is ignored.
25668
25669
25670 .option server_mail_auth_condition authenticators string&!! unset
25671 This option allows a server to discard authenticated sender addresses supplied
25672 as part of MAIL commands in SMTP connections that are authenticated by the
25673 driver on which &%server_mail_auth_condition%& is set. The option is not used
25674 as part of the authentication process; instead its (unexpanded) value is
25675 remembered for later use.
25676 How it is used is described in the following section.
25677
25678
25679
25680
25681
25682 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25683 .cindex "authentication" "sender; authenticated"
25684 .cindex "AUTH" "on MAIL command"
25685 When a client supplied an AUTH= item on a MAIL command, Exim applies
25686 the following checks before accepting it as the authenticated sender of the
25687 message:
25688
25689 .ilist
25690 If the connection is not using extended SMTP (that is, HELO was used rather
25691 than EHLO), the use of AUTH= is a syntax error.
25692 .next
25693 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25694 .next
25695 .vindex "&$authenticated_sender$&"
25696 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25697 running, the value of &$authenticated_sender$& is set to the value obtained
25698 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25699 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25700 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25701 given for the MAIL command.
25702 .next
25703 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25704 is accepted and placed in &$authenticated_sender$& only if the client has
25705 authenticated.
25706 .next
25707 If the AUTH= value was accepted by either of the two previous rules, and
25708 the client has authenticated, and the authenticator has a setting for the
25709 &%server_mail_auth_condition%&, the condition is checked at this point. The
25710 valued that was saved from the authenticator is expanded. If the expansion
25711 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25712 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25713 the value of &$authenticated_sender$& is retained and passed on with the
25714 message.
25715 .endlist
25716
25717
25718 When &$authenticated_sender$& is set for a message, it is passed on to other
25719 hosts to which Exim authenticates as a client. Do not confuse this value with
25720 &$authenticated_id$&, which is a string obtained from the authentication
25721 process, and which is not usually a complete email address.
25722
25723 .vindex "&$sender_address$&"
25724 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25725 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25726 therefore make use of &$authenticated_sender$&. The converse is not true: the
25727 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25728 ACL is run.
25729
25730
25731
25732 .section "Authentication on an Exim server" "SECTauthexiser"
25733 .cindex "authentication" "on an Exim server"
25734 When Exim receives an EHLO command, it advertises the public names of those
25735 authenticators that are configured as servers, subject to the following
25736 conditions:
25737
25738 .ilist
25739 The client host must match &%auth_advertise_hosts%& (default *).
25740 .next
25741 It the &%server_advertise_condition%& option is set, its expansion must not
25742 yield the empty string, &"0"&, &"no"&, or &"false"&.
25743 .endlist
25744
25745 The order in which the authenticators are defined controls the order in which
25746 the mechanisms are advertised.
25747
25748 Some mail clients (for example, some versions of Netscape) require the user to
25749 provide a name and password for authentication whenever AUTH is advertised,
25750 even though authentication may not in fact be needed (for example, Exim may be
25751 set up to allow unconditional relaying from the client by an IP address check).
25752 You can make such clients more friendly by not advertising AUTH to them.
25753 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25754 that runs for RCPT) to relay without authentication, you should set
25755 .code
25756 auth_advertise_hosts = ! 10.9.8.0/24
25757 .endd
25758 so that no authentication mechanisms are advertised to them.
25759
25760 The &%server_advertise_condition%& controls the advertisement of individual
25761 authentication mechanisms. For example, it can be used to restrict the
25762 advertisement of a particular mechanism to encrypted connections, by a setting
25763 such as:
25764 .code
25765 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25766 .endd
25767 .vindex "&$tls_in_cipher$&"
25768 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25769 yields &"yes"&, which allows the advertisement to happen.
25770
25771 When an Exim server receives an AUTH command from a client, it rejects it
25772 immediately if AUTH was not advertised in response to an earlier EHLO
25773 command. This is the case if
25774
25775 .ilist
25776 The client host does not match &%auth_advertise_hosts%&; or
25777 .next
25778 No authenticators are configured with server options; or
25779 .next
25780 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25781 server authenticators.
25782 .endlist
25783
25784
25785 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25786 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25787 AUTH is accepted from any client host.
25788
25789 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25790 server authentication mechanism that was advertised in response to EHLO and
25791 that matches the one named in the AUTH command. If it finds one, it runs
25792 the appropriate authentication protocol, and authentication either succeeds or
25793 fails. If there is no matching advertised mechanism, the AUTH command is
25794 rejected with a 504 error.
25795
25796 .vindex "&$received_protocol$&"
25797 .vindex "&$sender_host_authenticated$&"
25798 When a message is received from an authenticated host, the value of
25799 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25800 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25801 public name) of the authenticator driver that successfully authenticated the
25802 client from which the message was received. This variable is empty if there was
25803 no successful authentication.
25804
25805
25806
25807
25808 .section "Testing server authentication" "SECID169"
25809 .cindex "authentication" "testing a server"
25810 .cindex "AUTH" "testing a server"
25811 .cindex "base64 encoding" "creating authentication test data"
25812 Exim's &%-bh%& option can be useful for testing server authentication
25813 configurations. The data for the AUTH command has to be sent using base64
25814 encoding. A quick way to produce such data for testing is the following Perl
25815 script:
25816 .code
25817 use MIME::Base64;
25818 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25819 .endd
25820 .cindex "binary zero" "in authentication data"
25821 This interprets its argument as a Perl string, and then encodes it. The
25822 interpretation as a Perl string allows binary zeros, which are required for
25823 some kinds of authentication, to be included in the data. For example, a
25824 command line to run this script on such data might be
25825 .code
25826 encode '\0user\0password'
25827 .endd
25828 Note the use of single quotes to prevent the shell interpreting the
25829 backslashes, so that they can be interpreted by Perl to specify characters
25830 whose code value is zero.
25831
25832 &*Warning 1*&: If either of the user or password strings starts with an octal
25833 digit, you must use three zeros instead of one after the leading backslash. If
25834 you do not, the octal digit that starts your string will be incorrectly
25835 interpreted as part of the code for the first character.
25836
25837 &*Warning 2*&: If there are characters in the strings that Perl interprets
25838 specially, you must use a Perl escape to prevent them being misinterpreted. For
25839 example, a command such as
25840 .code
25841 encode '\0user@domain.com\0pas$$word'
25842 .endd
25843 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25844
25845 If you have the &%mimencode%& command installed, another way to do produce
25846 base64-encoded strings is to run the command
25847 .code
25848 echo -e -n `\0user\0password' | mimencode
25849 .endd
25850 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25851 in the argument, and the &%-n%& option specifies no newline at the end of its
25852 output. However, not all versions of &%echo%& recognize these options, so you
25853 should check your version before relying on this suggestion.
25854
25855
25856
25857 .section "Authentication by an Exim client" "SECID170"
25858 .cindex "authentication" "on an Exim client"
25859 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25860 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25861 announces support for authentication, and the host matches an entry in either
25862 of these options, Exim (as a client) tries to authenticate as follows:
25863
25864 .ilist
25865 For each authenticator that is configured as a client, in the order in which
25866 they are defined in the configuration, it searches the authentication
25867 mechanisms announced by the server for one whose name matches the public name
25868 of the authenticator.
25869 .next
25870 .vindex "&$host$&"
25871 .vindex "&$host_address$&"
25872 When it finds one that matches, it runs the authenticator's client code. The
25873 variables &$host$& and &$host_address$& are available for any string expansions
25874 that the client might do. They are set to the server's name and IP address. If
25875 any expansion is forced to fail, the authentication attempt is abandoned, and
25876 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25877 delivery to be deferred.
25878 .next
25879 If the result of the authentication attempt is a temporary error or a timeout,
25880 Exim abandons trying to send the message to the host for the moment. It will
25881 try again later. If there are any backup hosts available, they are tried in the
25882 usual way.
25883 .next
25884 If the response to authentication is a permanent error (5&'xx'& code), Exim
25885 carries on searching the list of authenticators and tries another one if
25886 possible. If all authentication attempts give permanent errors, or if there are
25887 no attempts because no mechanisms match (or option expansions force failure),
25888 what happens depends on whether the host matches &%hosts_require_auth%& or
25889 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25890 delivery is deferred. The error can be detected in the retry rules, and thereby
25891 turned into a permanent error if you wish. In the second case, Exim tries to
25892 deliver the message unauthenticated.
25893 .endlist
25894
25895 .new
25896 Note that the hostlist test for whether to do authentication can be
25897 confused if name-IP lookups change between the time the peer is decided
25898 on and the transport running.  For example, with a manualroute
25899 router given a host name, and DNS "round-robin" use by that name: if
25900 the local resolver cache times out between the router and the transport
25901 running, the transport may get an IP for the name for its authentication
25902 check which does not match the connection peer IP.
25903 No authentication will then be done, despite the names being identical.
25904
25905 For such cases use a separate transport which always authenticates.
25906 .wen
25907
25908 .cindex "AUTH" "on MAIL command"
25909 When Exim has authenticated itself to a remote server, it adds the AUTH
25910 parameter to the MAIL commands it sends, if it has an authenticated sender for
25911 the message. If the message came from a remote host, the authenticated sender
25912 is the one that was receiving on an incoming MAIL command, provided that the
25913 incoming connection was authenticated and the &%server_mail_auth%& condition
25914 allowed the authenticated sender to be retained. If a local process calls Exim
25915 to send a message, the sender address that is built from the login name and
25916 &%qualify_domain%& is treated as authenticated. However, if the
25917 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25918 the authenticated sender that was received with the message.
25919 .ecindex IIDauthconf1
25920 .ecindex IIDauthconf2
25921
25922
25923
25924
25925
25926
25927 . ////////////////////////////////////////////////////////////////////////////
25928 . ////////////////////////////////////////////////////////////////////////////
25929
25930 .chapter "The plaintext authenticator" "CHAPplaintext"
25931 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25932 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25933 The &(plaintext)& authenticator can be configured to support the PLAIN and
25934 LOGIN authentication mechanisms, both of which transfer authentication data as
25935 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25936 security risk; you are strongly advised to insist on the use of SMTP encryption
25937 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25938 use unencrypted plain text, you should not use the same passwords for SMTP
25939 connections as you do for login accounts.
25940
25941 .section "Plaintext options" "SECID171"
25942 .cindex "options" "&(plaintext)& authenticator (server)"
25943 When configured as a server, &(plaintext)& uses the following options:
25944
25945 .option server_condition authenticators string&!! unset
25946 This is actually a global authentication option, but it must be set in order to
25947 configure the &(plaintext)& driver as a server. Its use is described below.
25948
25949 .option server_prompts plaintext string&!! unset
25950 The contents of this option, after expansion, must be a colon-separated list of
25951 prompt strings. If expansion fails, a temporary authentication rejection is
25952 given.
25953
25954 .section "Using plaintext in a server" "SECTplainserver"
25955 .cindex "AUTH" "in &(plaintext)& authenticator"
25956 .cindex "binary zero" "in &(plaintext)& authenticator"
25957 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25958         "in &(plaintext)& authenticator"
25959 .vindex "&$auth1$&, &$auth2$&, etc"
25960 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25961
25962 When running as a server, &(plaintext)& performs the authentication test by
25963 expanding a string. The data sent by the client with the AUTH command, or in
25964 response to subsequent prompts, is base64 encoded, and so may contain any byte
25965 values when decoded. If any data is supplied with the command, it is treated as
25966 a list of strings, separated by NULs (binary zeros), the first three of which
25967 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25968 (neither LOGIN nor PLAIN uses more than three strings).
25969
25970 For compatibility with previous releases of Exim, the values are also placed in
25971 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25972 variables for this purpose is now deprecated, as it can lead to confusion in
25973 string expansions that also use them for other things.
25974
25975 If there are more strings in &%server_prompts%& than the number of strings
25976 supplied with the AUTH command, the remaining prompts are used to obtain more
25977 data. Each response from the client may be a list of NUL-separated strings.
25978
25979 .vindex "&$authenticated_id$&"
25980 Once a sufficient number of data strings have been received,
25981 &%server_condition%& is expanded. If the expansion is forced to fail,
25982 authentication fails. Any other expansion failure causes a temporary error code
25983 to be returned. If the result of a successful expansion is an empty string,
25984 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25985 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25986 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25987 For any other result, a temporary error code is returned, with the expanded
25988 string as the error text
25989
25990 &*Warning*&: If you use a lookup in the expansion to find the user's
25991 password, be sure to make the authentication fail if the user is unknown.
25992 There are good and bad examples at the end of the next section.
25993
25994
25995
25996 .section "The PLAIN authentication mechanism" "SECID172"
25997 .cindex "PLAIN authentication mechanism"
25998 .cindex "authentication" "PLAIN mechanism"
25999 .cindex "binary zero" "in &(plaintext)& authenticator"
26000 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26001 sent as one item of data (that is, one combined string containing two NUL
26002 separators). The data is sent either as part of the AUTH command, or
26003 subsequently in response to an empty prompt from the server.
26004
26005 The second and third strings are a user name and a corresponding password.
26006 Using a single fixed user name and password as an example, this could be
26007 configured as follows:
26008 .code
26009 fixed_plain:
26010   driver = plaintext
26011   public_name = PLAIN
26012   server_prompts = :
26013   server_condition = \
26014     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26015   server_set_id = $auth2
26016 .endd
26017 Note that the default result strings from &%if%& (&"true"& or an empty string)
26018 are exactly what we want here, so they need not be specified. Obviously, if the
26019 password contains expansion-significant characters such as dollar, backslash,
26020 or closing brace, they have to be escaped.
26021
26022 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26023 the end of a string list are ignored). If all the data comes as part of the
26024 AUTH command, as is commonly the case, the prompt is not used. This
26025 authenticator is advertised in the response to EHLO as
26026 .code
26027 250-AUTH PLAIN
26028 .endd
26029 and a client host can authenticate itself by sending the command
26030 .code
26031 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26032 .endd
26033 As this contains three strings (more than the number of prompts), no further
26034 data is required from the client. Alternatively, the client may just send
26035 .code
26036 AUTH PLAIN
26037 .endd
26038 to initiate authentication, in which case the server replies with an empty
26039 prompt. The client must respond with the combined data string.
26040
26041 The data string is base64 encoded, as required by the RFC. This example,
26042 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26043 represents a zero byte. This is split up into three strings, the first of which
26044 is empty. The &%server_condition%& option in the authenticator checks that the
26045 second two are &`username`& and &`mysecret`& respectively.
26046
26047 Having just one fixed user name and password, as in this example, is not very
26048 realistic, though for a small organization with only a handful of
26049 authenticating clients it could make sense.
26050
26051 A more sophisticated instance of this authenticator could use the user name in
26052 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26053 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26054 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26055 This is an incorrect example:
26056 .code
26057 server_condition = \
26058   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26059 .endd
26060 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26061 which it then compares to the supplied password (&$auth3$&). Why is this example
26062 incorrect? It works fine for existing users, but consider what happens if a
26063 non-existent user name is given. The lookup fails, but as no success/failure
26064 strings are given for the lookup, it yields an empty string. Thus, to defeat
26065 the authentication, all a client has to do is to supply a non-existent user
26066 name and an empty password. The correct way of writing this test is:
26067 .code
26068 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26069   {${if eq{$value}{$auth3}}} {false}}
26070 .endd
26071 In this case, if the lookup succeeds, the result is checked; if the lookup
26072 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26073 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26074 always fails if its second argument is empty. However, the second way of
26075 writing the test makes the logic clearer.
26076
26077
26078 .section "The LOGIN authentication mechanism" "SECID173"
26079 .cindex "LOGIN authentication mechanism"
26080 .cindex "authentication" "LOGIN mechanism"
26081 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26082 in a number of programs. No data is sent with the AUTH command. Instead, a
26083 user name and password are supplied separately, in response to prompts. The
26084 plaintext authenticator can be configured to support this as in this example:
26085 .code
26086 fixed_login:
26087   driver = plaintext
26088   public_name = LOGIN
26089   server_prompts = User Name : Password
26090   server_condition = \
26091     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26092   server_set_id = $auth1
26093 .endd
26094 Because of the way plaintext operates, this authenticator accepts data supplied
26095 with the AUTH command (in contravention of the specification of LOGIN), but
26096 if the client does not supply it (as is the case for LOGIN clients), the prompt
26097 strings are used to obtain two data items.
26098
26099 Some clients are very particular about the precise text of the prompts. For
26100 example, Outlook Express is reported to recognize only &"Username:"& and
26101 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26102 strings. It uses the &%ldapauth%& expansion condition to check the user
26103 name and password by binding to an LDAP server:
26104 .code
26105 login:
26106   driver = plaintext
26107   public_name = LOGIN
26108   server_prompts = Username:: : Password::
26109   server_condition = ${if and{{ \
26110     !eq{}{$auth1} }{ \
26111     ldapauth{\
26112       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26113       pass=${quote:$auth2} \
26114       ldap://ldap.example.org/} }} }
26115   server_set_id = uid=$auth1,ou=people,o=example.org
26116 .endd
26117 We have to check that the username is not empty before using it, because LDAP
26118 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26119 operator to correctly quote the DN for authentication. However, the basic
26120 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26121 correct one to use for the password, because quoting is needed only to make
26122 the password conform to the Exim syntax. At the LDAP level, the password is an
26123 uninterpreted string.
26124
26125
26126 .section "Support for different kinds of authentication" "SECID174"
26127 A number of string expansion features are provided for the purpose of
26128 interfacing to different ways of user authentication. These include checking
26129 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26130 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26131 &<<SECTexpcond>>&.
26132
26133
26134
26135
26136 .section "Using plaintext in a client" "SECID175"
26137 .cindex "options" "&(plaintext)& authenticator (client)"
26138 The &(plaintext)& authenticator has two client options:
26139
26140 .option client_ignore_invalid_base64 plaintext boolean false
26141 If the client receives a server prompt that is not a valid base64 string,
26142 authentication is abandoned by default. However, if this option is set true,
26143 the error in the challenge is ignored and the client sends the response as
26144 usual.
26145
26146 .option client_send plaintext string&!! unset
26147 The string is a colon-separated list of authentication data strings. Each
26148 string is independently expanded before being sent to the server. The first
26149 string is sent with the AUTH command; any more strings are sent in response
26150 to prompts from the server. Before each string is expanded, the value of the
26151 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26152 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26153 way. Thus, the prompt that is received in response to sending the first string
26154 (with the AUTH command) can be used in the expansion of the second string, and
26155 so on. If an invalid base64 string is received when
26156 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26157 &$auth$&<&'n'&> variable.
26158
26159 &*Note*&: You cannot use expansion to create multiple strings, because
26160 splitting takes priority and happens first.
26161
26162 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26163 the data, further processing is applied to each string before it is sent. If
26164 there are any single circumflex characters in the string, they are converted to
26165 NULs. Should an actual circumflex be required as data, it must be doubled in
26166 the string.
26167
26168 This is an example of a client configuration that implements the PLAIN
26169 authentication mechanism with a fixed user name and password:
26170 .code
26171 fixed_plain:
26172   driver = plaintext
26173   public_name = PLAIN
26174   client_send = ^username^mysecret
26175 .endd
26176 The lack of colons means that the entire text is sent with the AUTH
26177 command, with the circumflex characters converted to NULs. A similar example
26178 that uses the LOGIN mechanism is:
26179 .code
26180 fixed_login:
26181   driver = plaintext
26182   public_name = LOGIN
26183   client_send = : username : mysecret
26184 .endd
26185 The initial colon means that the first string is empty, so no data is sent with
26186 the AUTH command itself. The remaining strings are sent in response to
26187 prompts.
26188 .ecindex IIDplaiauth1
26189 .ecindex IIDplaiauth2
26190
26191
26192
26193
26194 . ////////////////////////////////////////////////////////////////////////////
26195 . ////////////////////////////////////////////////////////////////////////////
26196
26197 .chapter "The cram_md5 authenticator" "CHID9"
26198 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26199 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26200 .cindex "CRAM-MD5 authentication mechanism"
26201 .cindex "authentication" "CRAM-MD5 mechanism"
26202 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26203 sends a challenge string to the client, and the response consists of a user
26204 name and the CRAM-MD5 digest of the challenge string combined with a secret
26205 string (password) which is known to both server and client. Thus, the secret
26206 is not sent over the network as plain text, which makes this authenticator more
26207 secure than &(plaintext)&. However, the downside is that the secret has to be
26208 available in plain text at either end.
26209
26210
26211 .section "Using cram_md5 as a server" "SECID176"
26212 .cindex "options" "&(cram_md5)& authenticator (server)"
26213 This authenticator has one server option, which must be set to configure the
26214 authenticator as a server:
26215
26216 .option server_secret cram_md5 string&!! unset
26217 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26218 When the server receives the client's response, the user name is placed in
26219 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26220 obtain the password for that user. The server then computes the CRAM-MD5 digest
26221 that the client should have sent, and checks that it received the correct
26222 string. If the expansion of &%server_secret%& is forced to fail, authentication
26223 fails. If the expansion fails for some other reason, a temporary error code is
26224 returned to the client.
26225
26226 For compatibility with previous releases of Exim, the user name is also placed
26227 in &$1$&. However, the use of this variables for this purpose is now
26228 deprecated, as it can lead to confusion in string expansions that also use
26229 numeric variables for other things.
26230
26231 For example, the following authenticator checks that the user name given by the
26232 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26233 user name, authentication fails.
26234 .code
26235 fixed_cram:
26236   driver = cram_md5
26237   public_name = CRAM-MD5
26238   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26239   server_set_id = $auth1
26240 .endd
26241 .vindex "&$authenticated_id$&"
26242 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26243 name in &$authenticated_id$&. A more typical configuration might look up the
26244 secret string in a file, using the user name as the key. For example:
26245 .code
26246 lookup_cram:
26247   driver = cram_md5
26248   public_name = CRAM-MD5
26249   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26250                   {$value}fail}
26251   server_set_id = $auth1
26252 .endd
26253 Note that this expansion explicitly forces failure if the lookup fails
26254 because &$auth1$& contains an unknown user name.
26255
26256 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26257 using the relevant libraries, you need to know the realm to specify in the
26258 lookup and then ask for the &"userPassword"& attribute for that user in that
26259 realm, with:
26260 .code
26261 cyrusless_crammd5:
26262   driver = cram_md5
26263   public_name = CRAM-MD5
26264   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26265                   dbmjz{/etc/sasldb2}{$value}fail}
26266   server_set_id = $auth1
26267 .endd
26268
26269 .section "Using cram_md5 as a client" "SECID177"
26270 .cindex "options" "&(cram_md5)& authenticator (client)"
26271 When used as a client, the &(cram_md5)& authenticator has two options:
26272
26273
26274
26275 .option client_name cram_md5 string&!! "the primary host name"
26276 This string is expanded, and the result used as the user name data when
26277 computing the response to the server's challenge.
26278
26279
26280 .option client_secret cram_md5 string&!! unset
26281 This option must be set for the authenticator to work as a client. Its value is
26282 expanded and the result used as the secret string when computing the response.
26283
26284
26285 .vindex "&$host$&"
26286 .vindex "&$host_address$&"
26287 Different user names and secrets can be used for different servers by referring
26288 to &$host$& or &$host_address$& in the options. Forced failure of either
26289 expansion string is treated as an indication that this authenticator is not
26290 prepared to handle this case. Exim moves on to the next configured client
26291 authenticator. Any other expansion failure causes Exim to give up trying to
26292 send the message to the current server.
26293
26294 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26295 strings, is:
26296 .code
26297 fixed_cram:
26298   driver = cram_md5
26299   public_name = CRAM-MD5
26300   client_name = ph10
26301   client_secret = secret
26302 .endd
26303 .ecindex IIDcramauth1
26304 .ecindex IIDcramauth2
26305
26306
26307
26308 . ////////////////////////////////////////////////////////////////////////////
26309 . ////////////////////////////////////////////////////////////////////////////
26310
26311 .chapter "The cyrus_sasl authenticator" "CHID10"
26312 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26313 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26314 .cindex "Cyrus" "SASL library"
26315 .cindex "Kerberos"
26316 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26317 Digital Ltd (&url(http://www.aldigital.co.uk)).
26318
26319 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26320 library implementation of the RFC 2222 (&"Simple Authentication and Security
26321 Layer"&). This library supports a number of authentication mechanisms,
26322 including PLAIN and LOGIN, but also several others that Exim does not support
26323 directly. In particular, there is support for Kerberos authentication.
26324
26325 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26326 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26327 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26328 name of the driver to determine which mechanism to support.
26329
26330 Where access to some kind of secret file is required, for example in GSSAPI
26331 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26332 user, and that the Cyrus SASL library has no way of escalating privileges
26333 by default. You may also find you need to set environment variables,
26334 depending on the driver you are using.
26335
26336 The application name provided by Exim is &"exim"&, so various SASL options may
26337 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26338 Kerberos, note that because of limitations in the GSSAPI interface,
26339 changing the server keytab might need to be communicated down to the Kerberos
26340 layer independently. The mechanism for doing so is dependent upon the Kerberos
26341 implementation.
26342
26343 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26344 may be set to point to an alternative keytab file. Exim will pass this
26345 variable through from its own inherited environment when started as root or the
26346 Exim user. The keytab file needs to be readable by the Exim user.
26347 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26348 environment variable.  In practice, for those releases, the Cyrus authenticator
26349 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26350 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26351
26352
26353 .section "Using cyrus_sasl as a server" "SECID178"
26354 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26355 (on a successful authentication) into &$auth1$&. For compatibility with
26356 previous releases of Exim, the username is also placed in &$1$&. However, the
26357 use of this variable for this purpose is now deprecated, as it can lead to
26358 confusion in string expansions that also use numeric variables for other
26359 things.
26360
26361
26362 .option server_hostname cyrus_sasl string&!! "see below"
26363 This option selects the hostname that is used when communicating with the
26364 library. The default value is &`$primary_hostname`&. It is up to the underlying
26365 SASL plug-in what it does with this data.
26366
26367
26368 .option server_mech cyrus_sasl string "see below"
26369 This option selects the authentication mechanism this driver should use. The
26370 default is the value of the generic &%public_name%& option. This option allows
26371 you to use a different underlying mechanism from the advertised name. For
26372 example:
26373 .code
26374 sasl:
26375   driver = cyrus_sasl
26376   public_name = X-ANYTHING
26377   server_mech = CRAM-MD5
26378   server_set_id = $auth1
26379 .endd
26380
26381 .option server_realm cyrus_sasl string&!! unset
26382 This specifies the SASL realm that the server claims to be in.
26383
26384
26385 .option server_service cyrus_sasl string &`smtp`&
26386 This is the SASL service that the server claims to implement.
26387
26388
26389 For straightforward cases, you do not need to set any of the authenticator's
26390 private options. All you need to do is to specify an appropriate mechanism as
26391 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26392 PLAIN, you could have two authenticators as follows:
26393 .code
26394 sasl_cram_md5:
26395   driver = cyrus_sasl
26396   public_name = CRAM-MD5
26397   server_set_id = $auth1
26398
26399 sasl_plain:
26400   driver = cyrus_sasl
26401   public_name = PLAIN
26402   server_set_id = $auth2
26403 .endd
26404 Cyrus SASL does implement the LOGIN authentication method, even though it is
26405 not a standard method. It is disabled by default in the source distribution,
26406 but it is present in many binary distributions.
26407 .ecindex IIDcyrauth1
26408 .ecindex IIDcyrauth2
26409
26410
26411
26412
26413 . ////////////////////////////////////////////////////////////////////////////
26414 . ////////////////////////////////////////////////////////////////////////////
26415 .chapter "The dovecot authenticator" "CHAPdovecot"
26416 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26417 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26418 This authenticator is an interface to the authentication facility of the
26419 Dovecot POP/IMAP server, which can support a number of authentication methods.
26420 Note that Dovecot must be configured to use auth-client not auth-userdb.
26421 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26422 to use the same mechanisms for SMTP authentication. This is a server
26423 authenticator only. There is only one option:
26424
26425 .option server_socket dovecot string unset
26426
26427 This option must specify the socket that is the interface to Dovecot
26428 authentication. The &%public_name%& option must specify an authentication
26429 mechanism that Dovecot is configured to support. You can have several
26430 authenticators for different mechanisms. For example:
26431 .code
26432 dovecot_plain:
26433   driver = dovecot
26434   public_name = PLAIN
26435   server_socket = /var/run/dovecot/auth-client
26436   server_set_id = $auth1
26437
26438 dovecot_ntlm:
26439   driver = dovecot
26440   public_name = NTLM
26441   server_socket = /var/run/dovecot/auth-client
26442   server_set_id = $auth1
26443 .endd
26444 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26445 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26446 option is passed in the Dovecot authentication command. If, for a TLS
26447 connection, a client certificate has been verified, the &"valid-client-cert"&
26448 option is passed. When authentication succeeds, the identity of the user
26449 who authenticated is placed in &$auth1$&.
26450 .ecindex IIDdcotauth1
26451 .ecindex IIDdcotauth2
26452
26453
26454 . ////////////////////////////////////////////////////////////////////////////
26455 . ////////////////////////////////////////////////////////////////////////////
26456 .chapter "The gsasl authenticator" "CHAPgsasl"
26457 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26458 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26459 .cindex "authentication" "GNU SASL"
26460 .cindex "authentication" "SASL"
26461 .cindex "authentication" "EXTERNAL"
26462 .cindex "authentication" "ANONYMOUS"
26463 .cindex "authentication" "PLAIN"
26464 .cindex "authentication" "LOGIN"
26465 .cindex "authentication" "DIGEST-MD5"
26466 .cindex "authentication" "CRAM-MD5"
26467 .cindex "authentication" "SCRAM-SHA-1"
26468 The &(gsasl)& authenticator provides server integration for the GNU SASL
26469 library and the mechanisms it provides.  This is new as of the 4.80 release
26470 and there are a few areas where the library does not let Exim smoothly
26471 scale to handle future authentication mechanisms, so no guarantee can be
26472 made that any particular new authentication mechanism will be supported
26473 without code changes in Exim.
26474
26475
26476 .option server_channelbinding gsasl boolean false
26477 Some authentication mechanisms are able to use external context at both ends
26478 of the session to bind the authentication to that context, and fail the
26479 authentication process if that context differs.  Specifically, some TLS
26480 ciphersuites can provide identifying information about the cryptographic
26481 context.
26482
26483 This means that certificate identity and verification becomes a non-issue,
26484 as a man-in-the-middle attack will cause the correct client and server to
26485 see different identifiers and authentication will fail.
26486
26487 This is currently only supported when using the GnuTLS library.  This is
26488 only usable by mechanisms which support "channel binding"; at time of
26489 writing, that's the SCRAM family.
26490
26491 This defaults off to ensure smooth upgrade across Exim releases, in case
26492 this option causes some clients to start failing.  Some future release
26493 of Exim may switch the default to be true.
26494
26495
26496 .option server_hostname gsasl string&!! "see below"
26497 This option selects the hostname that is used when communicating with the
26498 library. The default value is &`$primary_hostname`&.
26499 Some mechanisms will use this data.
26500
26501
26502 .option server_mech gsasl string "see below"
26503 This option selects the authentication mechanism this driver should use. The
26504 default is the value of the generic &%public_name%& option. This option allows
26505 you to use a different underlying mechanism from the advertised name. For
26506 example:
26507 .code
26508 sasl:
26509   driver = gsasl
26510   public_name = X-ANYTHING
26511   server_mech = CRAM-MD5
26512   server_set_id = $auth1
26513 .endd
26514
26515
26516 .option server_password gsasl string&!! unset
26517 Various mechanisms need access to the cleartext password on the server, so
26518 that proof-of-possession can be demonstrated on the wire, without sending
26519 the password itself.
26520
26521 The data available for lookup varies per mechanism.
26522 In all cases, &$auth1$& is set to the &'authentication id'&.
26523 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26524 if available, else the empty string.
26525 The &$auth3$& variable will always be the &'realm'& if available,
26526 else the empty string.
26527
26528 A forced failure will cause authentication to defer.
26529
26530 If using this option, it may make sense to set the &%server_condition%&
26531 option to be simply "true".
26532
26533
26534 .option server_realm gsasl string&!! unset
26535 This specifies the SASL realm that the server claims to be in.
26536 Some mechanisms will use this data.
26537
26538
26539 .option server_scram_iter gsasl string&!! unset
26540 This option provides data for the SCRAM family of mechanisms.
26541 &$auth1$& is not available at evaluation time.
26542 (This may change, as we receive feedback on use)
26543
26544
26545 .option server_scram_salt gsasl string&!! unset
26546 This option provides data for the SCRAM family of mechanisms.
26547 &$auth1$& is not available at evaluation time.
26548 (This may change, as we receive feedback on use)
26549
26550
26551 .option server_service gsasl string &`smtp`&
26552 This is the SASL service that the server claims to implement.
26553 Some mechanisms will use this data.
26554
26555
26556 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26557 .vindex "&$auth1$&, &$auth2$&, etc"
26558 These may be set when evaluating specific options, as detailed above.
26559 They will also be set when evaluating &%server_condition%&.
26560
26561 Unless otherwise stated below, the &(gsasl)& integration will use the following
26562 meanings for these variables:
26563
26564 .ilist
26565 .vindex "&$auth1$&"
26566 &$auth1$&: the &'authentication id'&
26567 .next
26568 .vindex "&$auth2$&"
26569 &$auth2$&: the &'authorization id'&
26570 .next
26571 .vindex "&$auth3$&"
26572 &$auth3$&: the &'realm'&
26573 .endlist
26574
26575 On a per-mechanism basis:
26576
26577 .ilist
26578 .cindex "authentication" "EXTERNAL"
26579 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26580 the &%server_condition%& option must be present.
26581 .next
26582 .cindex "authentication" "ANONYMOUS"
26583 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26584 the &%server_condition%& option must be present.
26585 .next
26586 .cindex "authentication" "GSSAPI"
26587 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26588 &$auth2$& will be set to the &'authorization id'&,
26589 the &%server_condition%& option must be present.
26590 .endlist
26591
26592 An &'anonymous token'& is something passed along as an unauthenticated
26593 identifier; this is analogous to FTP anonymous authentication passing an
26594 email address, or software-identifier@, as the "password".
26595
26596
26597 An example showing the password having the realm specified in the callback
26598 and demonstrating a Cyrus SASL to GSASL migration approach is:
26599 .code
26600 gsasl_cyrusless_crammd5:
26601   driver = gsasl
26602   public_name = CRAM-MD5
26603   server_realm = imap.example.org
26604   server_password = ${lookup{$auth1:$auth3:userPassword}\
26605                     dbmjz{/etc/sasldb2}{$value}fail}
26606   server_set_id = ${quote:$auth1}
26607   server_condition = yes
26608 .endd
26609
26610
26611 . ////////////////////////////////////////////////////////////////////////////
26612 . ////////////////////////////////////////////////////////////////////////////
26613
26614 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26615 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26616 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26617 .cindex "authentication" "GSSAPI"
26618 .cindex "authentication" "Kerberos"
26619 The &(heimdal_gssapi)& authenticator provides server integration for the
26620 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26621 reliably.
26622
26623 .option server_hostname heimdal_gssapi string&!! "see below"
26624 This option selects the hostname that is used, with &%server_service%&,
26625 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26626 identifier.  The default value is &`$primary_hostname`&.
26627
26628 .option server_keytab heimdal_gssapi string&!! unset
26629 If set, then Heimdal will not use the system default keytab (typically
26630 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26631 The value should be a pathname, with no &"file:"& prefix.
26632
26633 .option server_service heimdal_gssapi string&!! "smtp"
26634 This option specifies the service identifier used, in conjunction with
26635 &%server_hostname%&, for building the identifier for finding credentials
26636 from the keytab.
26637
26638
26639 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26640 Beware that these variables will typically include a realm, thus will appear
26641 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26642 not verified, so a malicious client can set it to anything.
26643
26644 The &$auth1$& field should be safely trustable as a value from the Key
26645 Distribution Center.  Note that these are not quite email addresses.
26646 Each identifier is for a role, and so the left-hand-side may include a
26647 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26648
26649 .vindex "&$auth1$&, &$auth2$&, etc"
26650 .ilist
26651 .vindex "&$auth1$&"
26652 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26653 .next
26654 .vindex "&$auth2$&"
26655 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26656 authentication.  If that was empty, this will also be set to the
26657 GSS Display Name.
26658 .endlist
26659
26660
26661 . ////////////////////////////////////////////////////////////////////////////
26662 . ////////////////////////////////////////////////////////////////////////////
26663
26664 .chapter "The spa authenticator" "CHAPspa"
26665 .scindex IIDspaauth1 "&(spa)& authenticator"
26666 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26667 .cindex "authentication" "Microsoft Secure Password"
26668 .cindex "authentication" "NTLM"
26669 .cindex "Microsoft Secure Password Authentication"
26670 .cindex "NTLM authentication"
26671 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26672 Password Authentication'& mechanism,
26673 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26674 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26675 taken from the Samba project (&url(http://www.samba.org)). The code for the
26676 server side was subsequently contributed by Tom Kistner. The mechanism works as
26677 follows:
26678
26679 .ilist
26680 After the AUTH command has been accepted, the client sends an SPA
26681 authentication request based on the user name and optional domain.
26682 .next
26683 The server sends back a challenge.
26684 .next
26685 The client builds a challenge response which makes use of the user's password
26686 and sends it to the server, which then accepts or rejects it.
26687 .endlist
26688
26689 Encryption is used to protect the password in transit.
26690
26691
26692
26693 .section "Using spa as a server" "SECID179"
26694 .cindex "options" "&(spa)& authenticator (server)"
26695 The &(spa)& authenticator has just one server option:
26696
26697 .option server_password spa string&!! unset
26698 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26699 This option is expanded, and the result must be the cleartext password for the
26700 authenticating user, whose name is at this point in &$auth1$&. For
26701 compatibility with previous releases of Exim, the user name is also placed in
26702 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26703 it can lead to confusion in string expansions that also use numeric variables
26704 for other things. For example:
26705 .code
26706 spa:
26707   driver = spa
26708   public_name = NTLM
26709   server_password = \
26710     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26711 .endd
26712 If the expansion is forced to fail, authentication fails. Any other expansion
26713 failure causes a temporary error code to be returned.
26714
26715
26716
26717
26718
26719 .section "Using spa as a client" "SECID180"
26720 .cindex "options" "&(spa)& authenticator (client)"
26721 The &(spa)& authenticator has the following client options:
26722
26723
26724
26725 .option client_domain spa string&!! unset
26726 This option specifies an optional domain for the authentication.
26727
26728
26729 .option client_password spa string&!! unset
26730 This option specifies the user's password, and must be set.
26731
26732
26733 .option client_username spa string&!! unset
26734 This option specifies the user name, and must be set. Here is an example of a
26735 configuration of this authenticator for use with the mail servers at
26736 &'msn.com'&:
26737 .code
26738 msn:
26739   driver = spa
26740   public_name = MSN
26741   client_username = msn/msn_username
26742   client_password = msn_plaintext_password
26743   client_domain = DOMAIN_OR_UNSET
26744 .endd
26745 .ecindex IIDspaauth1
26746 .ecindex IIDspaauth2
26747
26748
26749
26750
26751
26752 . ////////////////////////////////////////////////////////////////////////////
26753 . ////////////////////////////////////////////////////////////////////////////
26754
26755 .chapter "The tls authenticator" "CHAPtlsauth"
26756 .scindex IIDtlsauth1 "&(tls)& authenticator"
26757 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26758 .cindex "authentication" "Client Certificate"
26759 .cindex "authentication" "X509"
26760 .cindex "Certificate-based authentication"
26761 The &(tls)& authenticator provides server support for
26762 authentication based on client certificates.
26763
26764 It is not an SMTP authentication mechanism and is not
26765 advertised by the server as part of the SMTP EHLO response.
26766 It is an Exim authenticator in the sense that it affects
26767 the protocol element of the log line, can be tested for
26768 by the &%authenticated%& ACL condition, and can set
26769 the &$authenticated_id$& variable.
26770
26771 The client must present a verifiable certificate,
26772 for which it must have been requested via the
26773 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26774 (see &<<CHAPTLS>>&).
26775
26776 If an authenticator of this type is configured it is
26777 run before any SMTP-level communication is done,
26778 and can authenticate the connection.
26779 If it does, SMTP authentication is not offered.
26780
26781 A maximum of one authenticator of this type may be present.
26782
26783
26784 .cindex "options" "&(tls)& authenticator (server)"
26785 The &(tls)& authenticator has three server options:
26786
26787 .option server_param1 tls string&!! unset
26788 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26789 This option is expanded after the TLS negotiation and
26790 the result is placed in &$auth1$&.
26791 If the expansion is forced to fail, authentication fails. Any other expansion
26792 failure causes a temporary error code to be returned.
26793
26794 .option server_param2 tls string&!! unset
26795 .option server_param3 tls string&!! unset
26796 As above, for &$auth2$& and &$auth3$&.
26797
26798 &%server_param1%& may also be spelled &%server_param%&.
26799
26800
26801 Example:
26802 .code
26803 tls:
26804   driver = tls
26805   server_param1 =     ${certextract {subj_altname,mail,>:} \
26806                                     {$tls_in_peercert}}
26807   server_condition =  ${if forany {$auth1} \
26808                             {!= {0} \
26809                                 {${lookup ldap{ldap:///\
26810                          mailname=${quote_ldap_dn:${lc:$item}},\
26811                          ou=users,LDAP_DC?mailid} {$value}{0} \
26812                        }    }   } }
26813   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26814 .endd
26815 This accepts a client certificate that is verifiable against any
26816 of your configured trust-anchors
26817 (which usually means the full set of public CAs)
26818 and which has a SAN with a good account name.
26819 Note that the client cert is on the wire in-clear, including the SAN,
26820 whereas a plaintext SMTP AUTH done inside TLS is not.
26821
26822 . An alternative might use
26823 . .code
26824 .   server_param1 = ${sha256:$tls_in_peercert}
26825 . .endd
26826 . to require one of a set of specific certs that define a given account
26827 . (the verification is still required, but mostly irrelevant).
26828 . This would help for per-device use.
26829 .
26830 . However, for the future we really need support for checking a
26831 . user cert in LDAP - which probably wants a base-64 DER.
26832
26833 .ecindex IIDtlsauth1
26834 .ecindex IIDtlsauth2
26835
26836
26837 Note that because authentication is traditionally an SMTP operation,
26838 the &%authenticated%& ACL condition cannot be used in
26839 a connect- or helo-ACL.
26840
26841
26842
26843 . ////////////////////////////////////////////////////////////////////////////
26844 . ////////////////////////////////////////////////////////////////////////////
26845
26846 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26847          "Encrypted SMTP connections"
26848 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26849 .scindex IIDencsmtp2 "SMTP" "encryption"
26850 .cindex "TLS" "on SMTP connection"
26851 .cindex "OpenSSL"
26852 .cindex "GnuTLS"
26853 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26854 Sockets Layer), is implemented by making use of the OpenSSL library or the
26855 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26856 cryptographic code in the Exim distribution itself for implementing TLS. In
26857 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26858 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26859 You also need to understand the basic concepts of encryption at a managerial
26860 level, and in particular, the way that public keys, private keys, and
26861 certificates are used.
26862
26863 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26864 connection is established, the client issues a STARTTLS command. If the
26865 server accepts this, the client and the server negotiate an encryption
26866 mechanism. If the negotiation succeeds, the data that subsequently passes
26867 between them is encrypted.
26868
26869 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26870 and if so, what cipher suite is in use, whether the client supplied a
26871 certificate, and whether or not that certificate was verified. This makes it
26872 possible for an Exim server to deny or accept certain commands based on the
26873 encryption state.
26874
26875 &*Warning*&: Certain types of firewall and certain anti-virus products can
26876 disrupt TLS connections. You need to turn off SMTP scanning for these products
26877 in order to get TLS to work.
26878
26879
26880
26881 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26882          "SECID284"
26883 .cindex "ssmtp protocol"
26884 .cindex "smtps protocol"
26885 .cindex "SMTP" "ssmtp protocol"
26886 .cindex "SMTP" "smtps protocol"
26887 Early implementations of encrypted SMTP used a different TCP port from normal
26888 SMTP, and expected an encryption negotiation to start immediately, instead of
26889 waiting for a STARTTLS command from the client using the standard SMTP
26890 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26891 allocated for this purpose.
26892
26893 This approach was abandoned when encrypted SMTP was standardized, but there are
26894 still some legacy clients that use it. Exim supports these clients by means of
26895 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26896 numbers; the most common use is expected to be:
26897 .code
26898 tls_on_connect_ports = 465
26899 .endd
26900 The port numbers specified by this option apply to all SMTP connections, both
26901 via the daemon and via &'inetd'&. You still need to specify all the ports that
26902 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26903 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26904 an extra port &-- rather, it specifies different behaviour on a port that is
26905 defined elsewhere.
26906
26907 There is also a &%-tls-on-connect%& command line option. This overrides
26908 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26909
26910
26911
26912
26913
26914
26915 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26916 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26917 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26918 followed later, when the first versions of GnuTLS were released. To build Exim
26919 to use GnuTLS, you need to set
26920 .code
26921 USE_GNUTLS=yes
26922 .endd
26923 in Local/Makefile, in addition to
26924 .code
26925 SUPPORT_TLS=yes
26926 .endd
26927 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26928 include files and libraries for GnuTLS can be found.
26929
26930 There are some differences in usage when using GnuTLS instead of OpenSSL:
26931
26932 .ilist
26933 The &%tls_verify_certificates%& option
26934 cannot be the path of a directory
26935 for GnuTLS versions before 3.3.6
26936 (for later versions, or OpenSSL, it can be either).
26937 .next
26938 The default value for &%tls_dhparam%& differs for historical reasons.
26939 .next
26940 .vindex "&$tls_in_peerdn$&"
26941 .vindex "&$tls_out_peerdn$&"
26942 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26943 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26944 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26945 .next
26946 OpenSSL identifies cipher suites using hyphens as separators, for example:
26947 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26948 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26949 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26950 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26951 to handle its own older variants) when processing lists of cipher suites in the
26952 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26953 option).
26954 .next
26955 The &%tls_require_ciphers%& options operate differently, as described in the
26956 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26957 .next
26958 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26959 When using OpenSSL, this option is ignored.
26960 (If an API is found to let OpenSSL be configured in this way,
26961 let the Exim Maintainers know and we'll likely use it).
26962 .next
26963 Some other recently added features may only be available in one or the other.
26964 This should be documented with the feature.  If the documentation does not
26965 explicitly state that the feature is infeasible in the other TLS
26966 implementation, then patches are welcome.
26967 .endlist
26968
26969
26970 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26971 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26972 an explicit path; if the latter, then the text about generation still applies,
26973 but not the chosen filename.
26974 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26975 See the documentation of &%tls_dhparam%& for more information.
26976
26977 GnuTLS uses D-H parameters that may take a substantial amount of time
26978 to compute. It is unreasonable to re-compute them for every TLS session.
26979 Therefore, Exim keeps this data in a file in its spool directory, called
26980 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26981 of bits requested.
26982 The file is owned by the Exim user and is readable only by
26983 its owner. Every Exim process that start up GnuTLS reads the D-H
26984 parameters from this file. If the file does not exist, the first Exim process
26985 that needs it computes the data and writes it to a temporary file which is
26986 renamed once it is complete. It does not matter if several Exim processes do
26987 this simultaneously (apart from wasting a few resources). Once a file is in
26988 place, new Exim processes immediately start using it.
26989
26990 For maximum security, the parameters that are stored in this file should be
26991 recalculated periodically, the frequency depending on your paranoia level.
26992 If you are avoiding using the fixed D-H primes published in RFCs, then you
26993 are concerned about some advanced attacks and will wish to do this; if you do
26994 not regenerate then you might as well stick to the standard primes.
26995
26996 Arranging this is easy in principle; just delete the file when you want new
26997 values to be computed. However, there may be a problem. The calculation of new
26998 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26999 If the system is not very active, &_/dev/random_& may delay returning data
27000 until enough randomness (entropy) is available. This may cause Exim to hang for
27001 a substantial amount of time, causing timeouts on incoming connections.
27002
27003 The solution is to generate the parameters externally to Exim. They are stored
27004 in &_gnutls-params-N_& in PEM format, which means that they can be
27005 generated externally using the &(certtool)& command that is part of GnuTLS.
27006
27007 To replace the parameters with new ones, instead of deleting the file
27008 and letting Exim re-create it, you can generate new parameters using
27009 &(certtool)& and, when this has been done, replace Exim's cache file by
27010 renaming. The relevant commands are something like this:
27011 .code
27012 # ls
27013 [ look for file; assume gnutls-params-2236 is the most recent ]
27014 # rm -f new-params
27015 # touch new-params
27016 # chown exim:exim new-params
27017 # chmod 0600 new-params
27018 # certtool --generate-dh-params --bits 2236 >>new-params
27019 # openssl dhparam -noout -text -in new-params | head
27020 [ check the first line, make sure it's not more than 2236;
27021   if it is, then go back to the start ("rm") and repeat
27022   until the size generated is at most the size requested ]
27023 # chmod 0400 new-params
27024 # mv new-params gnutls-params-2236
27025 .endd
27026 If Exim never has to generate the parameters itself, the possibility of
27027 stalling is removed.
27028
27029 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27030 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27031 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27032 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27033 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27034 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27035 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27036 which applies to all D-H usage, client or server.  If the value returned by
27037 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27038 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27039 limit, which is still much higher than Exim historically used.
27040
27041 The filename and bits used will change as the GnuTLS maintainers change the
27042 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27043 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27044 2432 bits, while NSS is limited to 2236 bits.
27045
27046 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27047 increase the chance of the generated prime actually being within acceptable
27048 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27049 procedure above.  There is no sane procedure available to Exim to double-check
27050 the size of the generated prime, so it might still be too large.
27051
27052
27053 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27054 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27055 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27056 There is a function in the OpenSSL library that can be passed a list of cipher
27057 suites before the cipher negotiation takes place. This specifies which ciphers
27058 are acceptable. The list is colon separated and may contain names like
27059 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27060 directly to this function call.
27061 Many systems will install the OpenSSL manual-pages, so you may have
27062 &'ciphers(1)'& available to you.
27063 The following quotation from the OpenSSL
27064 documentation specifies what forms of item are allowed in the cipher string:
27065
27066 .ilist
27067 It can consist of a single cipher suite such as RC4-SHA.
27068 .next
27069 It can represent a list of cipher suites containing a certain algorithm,
27070 or cipher suites of a certain type. For example SHA1 represents all
27071 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27072 SSL v3 algorithms.
27073 .next
27074 Lists of cipher suites can be combined in a single cipher string using
27075 the + character. This is used as a logical and operation. For example
27076 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27077 algorithms.
27078 .endlist
27079
27080 Each cipher string can be optionally preceded by one of the characters &`!`&,
27081 &`-`& or &`+`&.
27082 .ilist
27083 If &`!`& is used, the ciphers are permanently deleted from the list. The
27084 ciphers deleted can never reappear in the list even if they are explicitly
27085 stated.
27086 .next
27087 If &`-`& is used, the ciphers are deleted from the list, but some or all
27088 of the ciphers can be added again by later options.
27089 .next
27090 If &`+`& is used, the ciphers are moved to the end of the list. This
27091 option does not add any new ciphers; it just moves matching existing ones.
27092 .endlist
27093
27094 If none of these characters is present, the string is interpreted as
27095 a list of ciphers to be appended to the current preference list. If the list
27096 includes any ciphers already present they will be ignored: that is, they will
27097 not be moved to the end of the list.
27098 .endlist
27099
27100 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27101 string:
27102 .code
27103 # note single-quotes to get ! past any shell history expansion
27104 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27105 .endd
27106
27107 This example will let the library defaults be permitted on the MX port, where
27108 there's probably no identity verification anyway, but ups the ante on the
27109 submission ports where the administrator might have some influence on the
27110 choice of clients used:
27111 .code
27112 # OpenSSL variant; see man ciphers(1)
27113 tls_require_ciphers = ${if =={$received_port}{25}\
27114                            {DEFAULT}\
27115                            {HIGH:!MD5:!SHA1}}
27116 .endd
27117
27118
27119
27120 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27121          "SECTreqciphgnu"
27122 .cindex "GnuTLS" "specifying parameters for"
27123 .cindex "TLS" "specifying ciphers (GnuTLS)"
27124 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27125 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27126 .cindex "TLS" "specifying protocols (GnuTLS)"
27127 .cindex "TLS" "specifying priority string (GnuTLS)"
27128 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27129 The GnuTLS library allows the caller to provide a "priority string", documented
27130 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27131 ciphersuite specification in OpenSSL.
27132
27133 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27134 and controls both protocols and ciphers.
27135
27136 The &%tls_require_ciphers%& option is available both as an global option,
27137 controlling how Exim behaves as a server, and also as an option of the
27138 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27139 the value is string expanded.  The resulting string is not an Exim list and
27140 the string is given to the GnuTLS library, so that Exim does not need to be
27141 aware of future feature enhancements of GnuTLS.
27142
27143 Documentation of the strings accepted may be found in the GnuTLS manual, under
27144 "Priority strings".  This is online as
27145 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27146 but beware that this relates to GnuTLS 3, which may be newer than the version
27147 installed on your system.  If you are using GnuTLS 3,
27148 then the example code
27149 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27150 on that site can be used to test a given string.
27151
27152 For example:
27153 .code
27154 # Disable older versions of protocols
27155 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27156 .endd
27157
27158 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27159 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27160 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27161
27162 This example will let the library defaults be permitted on the MX port, where
27163 there's probably no identity verification anyway, and lowers security further
27164 by increasing compatibility; but this ups the ante on the submission ports
27165 where the administrator might have some influence on the choice of clients
27166 used:
27167 .code
27168 # GnuTLS variant
27169 tls_require_ciphers = ${if =={$received_port}{25}\
27170                            {NORMAL:%COMPAT}\
27171                            {SECURE128}}
27172 .endd
27173
27174
27175 .section "Configuring an Exim server to use TLS" "SECID182"
27176 .cindex "TLS" "configuring an Exim server"
27177 When Exim has been built with TLS support, it advertises the availability of
27178 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27179 but not to any others. The default value of this option is unset, which means
27180 that STARTTLS is not advertised at all. This default is chosen because you
27181 need to set some other options in order to make TLS available, and also it is
27182 sensible for systems that want to use TLS only as a client.
27183
27184 If a client issues a STARTTLS command and there is some configuration
27185 problem in the server, the command is rejected with a 454 error. If the client
27186 persists in trying to issue SMTP commands, all except QUIT are rejected
27187 with the error
27188 .code
27189 554 Security failure
27190 .endd
27191 If a STARTTLS command is issued within an existing TLS session, it is
27192 rejected with a 554 error code.
27193
27194 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27195 must be set to match some hosts. The default is * which matches all hosts.
27196
27197 If this is all you do, TLS encryption will be enabled but not authentication -
27198 meaning that the peer has no assurance it is actually you he is talking to.
27199 You gain protection from a passive sniffer listening on the wire but not
27200 from someone able to intercept the communication.
27201
27202 Further protection requires some further configuration at the server end.
27203
27204 It is rumoured that all existing clients that support TLS/SSL use RSA
27205 encryption. To make this work you need to set, in the server,
27206 .code
27207 tls_certificate = /some/file/name
27208 tls_privatekey = /some/file/name
27209 .endd
27210 These options are, in fact, expanded strings, so you can make them depend on
27211 the identity of the client that is connected if you wish. The first file
27212 contains the server's X509 certificate, and the second contains the private key
27213 that goes with it. These files need to be
27214 PEM format and readable by the Exim user, and must
27215 always be given as full path names.
27216 The key must not be password-protected.
27217 They can be the same file if both the
27218 certificate and the key are contained within it. If &%tls_privatekey%& is not
27219 set, or if its expansion is forced to fail or results in an empty string, this
27220 is assumed to be the case. The certificate file may also contain intermediate
27221 certificates that need to be sent to the client to enable it to authenticate
27222 the server's certificate.
27223
27224 If you do not understand about certificates and keys, please try to find a
27225 source of this background information, which is not Exim-specific. (There are a
27226 few comments below in section &<<SECTcerandall>>&.)
27227
27228 &*Note*&: These options do not apply when Exim is operating as a client &--
27229 they apply only in the case of a server. If you need to use a certificate in an
27230 Exim client, you must set the options of the same names in an &(smtp)&
27231 transport.
27232
27233 With just these options, an Exim server will be able to use TLS. It does not
27234 require the client to have a certificate (but see below for how to insist on
27235 this). There is one other option that may be needed in other situations. If
27236 .code
27237 tls_dhparam = /some/file/name
27238 .endd
27239 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27240 with the parameters contained in the file.
27241 Set this to &`none`& to disable use of DH entirely, by making no prime
27242 available:
27243 .code
27244 tls_dhparam = none
27245 .endd
27246 This may also be set to a string identifying a standard prime to be used for
27247 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27248 used is &`ike23`&.  There are a few standard primes available, see the
27249 documentation for &%tls_dhparam%& for the complete list.
27250
27251 See the command
27252 .code
27253 openssl dhparam
27254 .endd
27255 for a way of generating file data.
27256
27257 The strings supplied for these three options are expanded every time a client
27258 host connects. It is therefore possible to use different certificates and keys
27259 for different hosts, if you so wish, by making use of the client's IP address
27260 in &$sender_host_address$& to control the expansion. If a string expansion is
27261 forced to fail, Exim behaves as if the option is not set.
27262
27263 .cindex "cipher" "logging"
27264 .cindex "log" "TLS cipher"
27265 .vindex "&$tls_in_cipher$&"
27266 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27267 an incoming TLS connection. It is included in the &'Received:'& header of an
27268 incoming message (by default &-- you can, of course, change this), and it is
27269 also included in the log line that records a message's arrival, keyed by
27270 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27271 condition can be used to test for specific cipher suites in ACLs.
27272
27273 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27274 can check the name of the cipher suite and vary their actions accordingly. The
27275 cipher suite names vary, depending on which TLS library is being used. For
27276 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27277 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27278 documentation for more details.
27279
27280 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27281 (again depending on the &%tls_cipher%& log selector).
27282
27283
27284 .section "Requesting and verifying client certificates" "SECID183"
27285 .cindex "certificate" "verification of client"
27286 .cindex "TLS" "client certificate verification"
27287 If you want an Exim server to request a certificate when negotiating a TLS
27288 session with a client, you must set either &%tls_verify_hosts%& or
27289 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27290 apply to all TLS connections. For any host that matches one of these options,
27291 Exim requests a certificate as part of the setup of the TLS session. The
27292 contents of the certificate are verified by comparing it with a list of
27293 expected certificates.
27294 These may be the system default set (depending on library version),
27295 an explicit file or,
27296 depending on library version, a directory, identified by
27297 &%tls_verify_certificates%&.
27298
27299 A file can contain multiple certificates, concatenated end to end. If a
27300 directory is used
27301 (OpenSSL only),
27302 each certificate must be in a separate file, with a name (or a symbolic link)
27303 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27304 certificate. You can compute the relevant hash by running the command
27305 .code
27306 openssl x509 -hash -noout -in /cert/file
27307 .endd
27308 where &_/cert/file_& contains a single certificate.
27309
27310 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27311 what happens if the client does not supply a certificate, or if the certificate
27312 does not match any of the certificates in the collection named by
27313 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27314 attempt to set up a TLS session is aborted, and the incoming connection is
27315 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27316 session continues. ACLs that run for subsequent SMTP commands can detect the
27317 fact that no certificate was verified, and vary their actions accordingly. For
27318 example, you can insist on a certificate before accepting a message for
27319 relaying, but not when the message is destined for local delivery.
27320
27321 .vindex "&$tls_in_peerdn$&"
27322 When a client supplies a certificate (whether it verifies or not), the value of
27323 the Distinguished Name of the certificate is made available in the variable
27324 &$tls_in_peerdn$& during subsequent processing of the message.
27325
27326 .cindex "log" "distinguished name"
27327 Because it is often a long text string, it is not included in the log line or
27328 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27329 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27330 &%received_header_text%& to change the &'Received:'& header. When no
27331 certificate is supplied, &$tls_in_peerdn$& is empty.
27332
27333
27334 .section "Revoked certificates" "SECID184"
27335 .cindex "TLS" "revoked certificates"
27336 .cindex "revocation list"
27337 .cindex "certificate" "revocation list"
27338 .cindex "OCSP" "stapling"
27339 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27340 certificates are revoked. If you have such a list, you can pass it to an Exim
27341 server using the global option called &%tls_crl%& and to an Exim client using
27342 an identically named option for the &(smtp)& transport. In each case, the value
27343 of the option is expanded and must then be the name of a file that contains a
27344 CRL in PEM format.
27345 The downside is that clients have to periodically re-download a potentially huge
27346 file from every certificate authority they know of.
27347
27348 The way with most moving parts at query time is Online Certificate
27349 Status Protocol (OCSP), where the client verifies the certificate
27350 against an OCSP server run by the CA.  This lets the CA track all
27351 usage of the certs.  It requires running software with access to the
27352 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27353 is based on HTTP and can be proxied accordingly.
27354
27355 The only widespread OCSP server implementation (known to this writer)
27356 comes as part of OpenSSL and aborts on an invalid request, such as
27357 connecting to the port and then disconnecting.  This requires
27358 re-entering the passphrase each time some random client does this.
27359
27360 The third way is OCSP Stapling; in this, the server using a certificate
27361 issued by the CA periodically requests an OCSP proof of validity from
27362 the OCSP server, then serves it up inline as part of the TLS
27363 negotiation.   This approach adds no extra round trips, does not let the
27364 CA track users, scales well with number of certs issued by the CA and is
27365 resilient to temporary OCSP server failures, as long as the server
27366 starts retrying to fetch an OCSP proof some time before its current
27367 proof expires.  The downside is that it requires server support.
27368
27369 Unless Exim is built with the support disabled,
27370 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27371 support for OCSP stapling is included.
27372
27373 There is a global option called &%tls_ocsp_file%&.
27374 The file specified therein is expected to be in DER format, and contain
27375 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27376 option will be re-expanded for SNI, if the &%tls_certificate%& option
27377 contains &`tls_in_sni`&, as per other TLS options.
27378
27379 Exim does not at this time implement any support for fetching a new OCSP
27380 proof.  The burden is on the administrator to handle this, outside of
27381 Exim.  The file specified should be replaced atomically, so that the
27382 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27383 on each connection, so a new file will be handled transparently on the
27384 next connection.
27385
27386 When built with OpenSSL Exim will check for a valid next update timestamp
27387 in the OCSP proof; if not present, or if the proof has expired, it will be
27388 ignored.
27389
27390 For the client to be able to verify the stapled OCSP the server must
27391 also supply, in its stapled information, any intermediate
27392 certificates for the chain leading to the OCSP proof from the signer
27393 of the server certificate.  There may be zero or one such. These
27394 intermediate certificates should be added to the server OCSP stapling
27395 file named by &%tls_ocsp_file%&.
27396
27397 Note that the proof only covers the terminal server certificate,
27398 not any of the chain from CA to it.
27399
27400 There is no current way to staple a proof for a client certificate.
27401
27402 .code
27403   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27404   OCSP server is supplied.  The server URL may be included in the
27405   server certificate, if the CA is helpful.
27406
27407   One failure mode seen was the OCSP Signer cert expiring before the end
27408   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27409   noted this as invalid overall, but the re-fetch script did not.
27410 .endd
27411
27412
27413
27414
27415 .section "Configuring an Exim client to use TLS" "SECID185"
27416 .cindex "cipher" "logging"
27417 .cindex "log" "TLS cipher"
27418 .cindex "log" "distinguished name"
27419 .cindex "TLS" "configuring an Exim client"
27420 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27421 deliveries as well as to incoming, the latter one causing logging of the
27422 server certificate's DN. The remaining client configuration for TLS is all
27423 within the &(smtp)& transport.
27424
27425 It is not necessary to set any options to have TLS work in the &(smtp)&
27426 transport. If Exim is built with TLS support, and TLS is advertised by a
27427 server, the &(smtp)& transport always tries to start a TLS session. However,
27428 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27429 transport) to a list of server hosts for which TLS should not be used.
27430
27431 If you do not want Exim to attempt to send messages unencrypted when an attempt
27432 to set up an encrypted connection fails in any way, you can set
27433 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27434 those hosts, delivery is always deferred if an encrypted connection cannot be
27435 set up. If there are any other hosts for the address, they are tried in the
27436 usual way.
27437
27438 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27439 the message unencrypted. It always does this if the response to STARTTLS is
27440 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27441 session after a success response code, what happens is controlled by the
27442 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27443 delivery to this host is deferred, and other hosts (if available) are tried. If
27444 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27445 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27446 negotiation fails, Exim closes the current connection (because it is in an
27447 unknown state), opens a new one to the same host, and then tries the delivery
27448 unencrypted.
27449
27450 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27451 transport provide the client with a certificate, which is passed to the server
27452 if it requests it. If the server is Exim, it will request a certificate only if
27453 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27454
27455 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27456 specifies a collection of expected server certificates.
27457 These may be the system default set (depending on library version),
27458 a file or,
27459 depending on library version, a directory,
27460 must name a file or,
27461 for OpenSSL only (not GnuTLS), a directory.
27462 The client verifies the server's certificate
27463 against this collection, taking into account any revoked certificates that are
27464 in the list defined by &%tls_crl%&.
27465 Failure to verify fails the TLS connection unless either of the
27466 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27467
27468 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27469 certificate verification to the listed servers.  Verification either must
27470 or need not succeed respectively.
27471
27472 The &(smtp)& transport has two OCSP-related options:
27473 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27474 is requested and required for the connection to proceed.  The default
27475 value is empty.
27476 &%hosts_request_ocsp%&; a host-list for which (additionally)
27477 a Certificate Status is requested (but not necessarily verified).  The default
27478 value is "*" meaning that requests are made unless configured
27479 otherwise.
27480
27481 The host(s) should also be in &%hosts_require_tls%&, and
27482 &%tls_verify_certificates%& configured for the transport,
27483 for OCSP to be relevant.
27484
27485 If
27486 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27487 list of permitted cipher suites. If either of these checks fails, delivery to
27488 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27489 alternative hosts, if any.
27490
27491  &*Note*&:
27492 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27493 is operating as a client. Exim does not assume that a server certificate (set
27494 by the global options of the same name) should also be used when operating as a
27495 client.
27496
27497 .vindex "&$host$&"
27498 .vindex "&$host_address$&"
27499 All the TLS options in the &(smtp)& transport are expanded before use, with
27500 &$host$& and &$host_address$& containing the name and address of the server to
27501 which the client is connected. Forced failure of an expansion causes Exim to
27502 behave as if the relevant option were unset.
27503
27504 .vindex &$tls_out_bits$&
27505 .vindex &$tls_out_cipher$&
27506 .vindex &$tls_out_peerdn$&
27507 .vindex &$tls_out_sni$&
27508 Before an SMTP connection is established, the
27509 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27510 variables are emptied. (Until the first connection, they contain the values
27511 that were set when the message was received.) If STARTTLS is subsequently
27512 successfully obeyed, these variables are set to the relevant values for the
27513 outgoing connection.
27514
27515
27516
27517 .section "Use of TLS Server Name Indication" "SECTtlssni"
27518 .cindex "TLS" "Server Name Indication"
27519 .vindex "&$tls_in_sni$&"
27520 .oindex "&%tls_in_sni%&"
27521 With TLS1.0 or above, there is an extension mechanism by which extra
27522 information can be included at various points in the protocol.  One of these
27523 extensions, documented in RFC 6066 (and before that RFC 4366) is
27524 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27525 client in the initial handshake, so that the server can examine the servername
27526 within and possibly choose to use different certificates and keys (and more)
27527 for this session.
27528
27529 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27530 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27531 address.
27532
27533 With SMTP to MX, there are the same problems here as in choosing the identity
27534 against which to validate a certificate: you can't rely on insecure DNS to
27535 provide the identity which you then cryptographically verify.  So this will
27536 be of limited use in that environment.
27537
27538 With SMTP to Submission, there is a well-defined hostname which clients are
27539 connecting to and can validate certificates against.  Thus clients &*can*&
27540 choose to include this information in the TLS negotiation.  If this becomes
27541 wide-spread, then hosters can choose to present different certificates to
27542 different clients.  Or even negotiate different cipher suites.
27543
27544 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27545 if not empty, will be sent on a TLS session as part of the handshake.  There's
27546 nothing more to it.  Choosing a sensible value not derived insecurely is the
27547 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27548 for the lifetime of the client connection (including during authentication).
27549
27550 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27551 received from a client.
27552 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27553
27554 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27555 option (prior to expansion) then the following options will be re-expanded
27556 during TLS session handshake, to permit alternative values to be chosen:
27557
27558 .ilist
27559 .vindex "&%tls_certificate%&"
27560 &%tls_certificate%&
27561 .next
27562 .vindex "&%tls_crl%&"
27563 &%tls_crl%&
27564 .next
27565 .vindex "&%tls_privatekey%&"
27566 &%tls_privatekey%&
27567 .next
27568 .vindex "&%tls_verify_certificates%&"
27569 &%tls_verify_certificates%&
27570 .next
27571 .vindex "&%tls_ocsp_file%&"
27572 &%tls_ocsp_file%&
27573 .endlist
27574
27575 Great care should be taken to deal with matters of case, various injection
27576 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27577 can always be referenced; it is important to remember that &$tls_in_sni$& is
27578 arbitrary unverified data provided prior to authentication.
27579 Further, the initial certificate is loaded before SNI is arrived, so
27580 an expansion for &%tls_certificate%& must have a default which is used
27581 when &$tls_in_sni$& is empty.
27582
27583 The Exim developers are proceeding cautiously and so far no other TLS options
27584 are re-expanded.
27585
27586 When Exim is built against OpenSSL, OpenSSL must have been built with support
27587 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27588 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27589 see &`-servername`& in the output, then OpenSSL has support.
27590
27591 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27592 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27593 built, then you have SNI support).
27594
27595
27596
27597 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27598          "SECTmulmessam"
27599 .cindex "multiple SMTP deliveries with TLS"
27600 .cindex "TLS" "multiple message deliveries"
27601 Exim sends multiple messages down the same TCP/IP connection by starting up
27602 an entirely new delivery process for each message, passing the socket from
27603 one process to the next. This implementation does not fit well with the use
27604 of TLS, because there is quite a lot of state information associated with a TLS
27605 connection, not just a socket identification. Passing all the state information
27606 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27607 session before passing the socket to a new process. The new process may then
27608 try to start a new TLS session, and if successful, may try to re-authenticate
27609 if AUTH is in use, before sending the next message.
27610
27611 The RFC is not clear as to whether or not an SMTP session continues in clear
27612 after TLS has been shut down, or whether TLS may be restarted again later, as
27613 just described. However, if the server is Exim, this shutdown and
27614 reinitialization works. It is not known which (if any) other servers operate
27615 successfully if the client closes a TLS session and continues with unencrypted
27616 SMTP, but there are certainly some that do not work. For such servers, Exim
27617 should not pass the socket to another process, because the failure of the
27618 subsequent attempt to use it would cause Exim to record a temporary host error,
27619 and delay other deliveries to that host.
27620
27621 To test for this case, Exim sends an EHLO command to the server after
27622 closing down the TLS session. If this fails in any way, the connection is
27623 closed instead of being passed to a new delivery process, but no retry
27624 information is recorded.
27625
27626 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27627 &(smtp)& transport to match those hosts for which Exim should not pass
27628 connections to new processes if TLS has been used.
27629
27630
27631
27632
27633 .section "Certificates and all that" "SECTcerandall"
27634 .cindex "certificate" "references to discussion"
27635 In order to understand fully how TLS works, you need to know about
27636 certificates, certificate signing, and certificate authorities. This is not the
27637 place to give a tutorial, especially as I do not know very much about it
27638 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27639 to Apache, currently at
27640 .display
27641 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27642 .endd
27643 Other parts of the &'modssl'& documentation are also helpful, and have
27644 links to further files.
27645 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27646 0-201-61598-3), contains both introductory and more in-depth descriptions.
27647 Some sample programs taken from the book are available from
27648 .display
27649 &url(http://www.rtfm.com/openssl-examples/)
27650 .endd
27651
27652
27653 .section "Certificate chains" "SECID186"
27654 The file named by &%tls_certificate%& may contain more than one
27655 certificate. This is useful in the case where the certificate that is being
27656 sent is validated by an intermediate certificate which the other end does
27657 not have. Multiple certificates must be in the correct order in the file.
27658 First the host's certificate itself, then the first intermediate
27659 certificate to validate the issuer of the host certificate, then the next
27660 intermediate certificate to validate the issuer of the first intermediate
27661 certificate, and so on, until finally (optionally) the root certificate.
27662 The root certificate must already be trusted by the recipient for
27663 validation to succeed, of course, but if it's not preinstalled, sending the
27664 root certificate along with the rest makes it available for the user to
27665 install if the receiving end is a client MUA that can interact with a user.
27666
27667 Note that certificates using MD5 are unlikely to work on today's Internet;
27668 even if your libraries allow loading them for use in Exim when acting as a
27669 server, increasingly clients will not accept such certificates.  The error
27670 diagnostics in such a case can be frustratingly vague.
27671
27672
27673
27674 .section "Self-signed certificates" "SECID187"
27675 .cindex "certificate" "self-signed"
27676 You can create a self-signed certificate using the &'req'& command provided
27677 with OpenSSL, like this:
27678 . ==== Do not shorten the duration here without reading and considering
27679 . ==== the text below.  Please leave it at 9999 days.
27680 .code
27681 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27682             -days 9999 -nodes
27683 .endd
27684 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27685 delimited and so can be identified independently. The &%-days%& option
27686 specifies a period for which the certificate is valid. The &%-nodes%& option is
27687 important: if you do not set it, the key is encrypted with a passphrase
27688 that you are prompted for, and any use that is made of the key causes more
27689 prompting for the passphrase. This is not helpful if you are going to use
27690 this certificate and key in an MTA, where prompting is not possible.
27691
27692 . ==== I expect to still be working 26 years from now.  The less technical
27693 . ==== debt I create, in terms of storing up trouble for my later years, the
27694 . ==== happier I will be then.  We really have reached the point where we
27695 . ==== should start, at the very least, provoking thought and making folks
27696 . ==== pause before proceeding, instead of leaving all the fixes until two
27697 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27698 . ==== -pdp, 2012
27699 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27700 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27701 the above command might produce a date in the past.  Think carefully about
27702 the lifetime of the systems you're deploying, and either reduce the duration
27703 of the certificate or reconsider your platform deployment.  (At time of
27704 writing, reducing the duration is the most likely choice, but the inexorable
27705 progression of time takes us steadily towards an era where this will not
27706 be a sensible resolution).
27707
27708 A self-signed certificate made in this way is sufficient for testing, and
27709 may be adequate for all your requirements if you are mainly interested in
27710 encrypting transfers, and not in secure identification.
27711
27712 However, many clients require that the certificate presented by the server be a
27713 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27714 certificate. In this situation, the self-signed certificate described above
27715 must be installed on the client host as a trusted root &'certification
27716 authority'& (CA), and the certificate used by Exim must be a user certificate
27717 signed with that self-signed certificate.
27718
27719 For information on creating self-signed CA certificates and using them to sign
27720 user certificates, see the &'General implementation overview'& chapter of the
27721 Open-source PKI book, available online at
27722 &url(http://ospkibook.sourceforge.net/).
27723 .ecindex IIDencsmtp1
27724 .ecindex IIDencsmtp2
27725
27726
27727
27728 . ////////////////////////////////////////////////////////////////////////////
27729 . ////////////////////////////////////////////////////////////////////////////
27730
27731 .chapter "Access control lists" "CHAPACL"
27732 .scindex IIDacl "&ACL;" "description"
27733 .cindex "control of incoming mail"
27734 .cindex "message" "controlling incoming"
27735 .cindex "policy control" "access control lists"
27736 Access Control Lists (ACLs) are defined in a separate section of the run time
27737 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27738 name, terminated by a colon. Here is a complete ACL section that contains just
27739 one very small ACL:
27740 .code
27741 begin acl
27742 small_acl:
27743   accept   hosts = one.host.only
27744 .endd
27745 You can have as many lists as you like in the ACL section, and the order in
27746 which they appear does not matter. The lists are self-terminating.
27747
27748 The majority of ACLs are used to control Exim's behaviour when it receives
27749 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27750 when a local process submits a message using SMTP by specifying the &%-bs%&
27751 option. The most common use is for controlling which recipients are accepted
27752 in incoming messages. In addition, you can define an ACL that is used to check
27753 local non-SMTP messages. The default configuration file contains an example of
27754 a realistic ACL for checking RCPT commands. This is discussed in chapter
27755 &<<CHAPdefconfil>>&.
27756
27757
27758 .section "Testing ACLs" "SECID188"
27759 The &%-bh%& command line option provides a way of testing your ACL
27760 configuration locally by running a fake SMTP session with which you interact.
27761
27762
27763 .section "Specifying when ACLs are used" "SECID189"
27764 .cindex "&ACL;" "options for specifying"
27765 In order to cause an ACL to be used, you have to name it in one of the relevant
27766 options in the main part of the configuration. These options are:
27767 .cindex "AUTH" "ACL for"
27768 .cindex "DATA" "ACLs for"
27769 .cindex "ETRN" "ACL for"
27770 .cindex "EXPN" "ACL for"
27771 .cindex "HELO" "ACL for"
27772 .cindex "EHLO" "ACL for"
27773 .cindex "DKIM" "ACL for"
27774 .cindex "MAIL" "ACL for"
27775 .cindex "QUIT, ACL for"
27776 .cindex "RCPT" "ACL for"
27777 .cindex "STARTTLS, ACL for"
27778 .cindex "VRFY" "ACL for"
27779 .cindex "SMTP" "connection, ACL for"
27780 .cindex "non-SMTP messages" "ACLs for"
27781 .cindex "MIME content scanning" "ACL for"
27782 .cindex "PRDR" "ACL for"
27783
27784 .table2 140pt
27785 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27786 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27787 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27788 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27789 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27790 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27791 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27792 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27793 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27794 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27795 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27796 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27797 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27798 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27799 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27800 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27801 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27802 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27803 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27804 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27805 .endtable
27806
27807 For example, if you set
27808 .code
27809 acl_smtp_rcpt = small_acl
27810 .endd
27811 the little ACL defined above is used whenever Exim receives a RCPT command
27812 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27813 done when RCPT commands arrive. A rejection of RCPT should cause the
27814 sending MTA to give up on the recipient address contained in the RCPT
27815 command, whereas rejection at other times may cause the client MTA to keep on
27816 trying to deliver the message. It is therefore recommended that you do as much
27817 testing as possible at RCPT time.
27818
27819
27820 .section "The non-SMTP ACLs" "SECID190"
27821 .cindex "non-SMTP messages" "ACLs for"
27822 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27823 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27824 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27825 the state of the SMTP connection such as encryption and authentication) are not
27826 relevant and are forbidden in these ACLs. However, the sender and recipients
27827 are known, so the &%senders%& and &%sender_domains%& conditions and the
27828 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27829 &$authenticated_sender$& are also available. You can specify added header lines
27830 in any of these ACLs.
27831
27832 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27833 non-SMTP message, before any of the message has been read. (This is the
27834 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27835 batched SMTP input, it runs after the DATA command has been reached. The
27836 result of this ACL is ignored; it cannot be used to reject a message. If you
27837 really need to, you could set a value in an ACL variable here and reject based
27838 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27839 controls, and in particular, it can be used to set
27840 .code
27841 control = suppress_local_fixups
27842 .endd
27843 This cannot be used in the other non-SMTP ACLs because by the time they are
27844 run, it is too late.
27845
27846 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27847 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27848
27849 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27850 kind of rejection is treated as permanent, because there is no way of sending a
27851 temporary error for these kinds of message.
27852
27853
27854 .section "The SMTP connect ACL" "SECID191"
27855 .cindex "SMTP" "connection, ACL for"
27856 .oindex &%smtp_banner%&
27857 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27858 session, after the test specified by &%host_reject_connection%& (which is now
27859 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27860 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27861 the message override the banner message that is otherwise specified by the
27862 &%smtp_banner%& option.
27863
27864
27865 .section "The EHLO/HELO ACL" "SECID192"
27866 .cindex "EHLO" "ACL for"
27867 .cindex "HELO" "ACL for"
27868 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27869 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27870 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27871 Note that a client may issue more than one EHLO or HELO command in an SMTP
27872 session, and indeed is required to issue a new EHLO or HELO after successfully
27873 setting up encryption following a STARTTLS command.
27874
27875 Note also that a deny neither forces the client to go away nor means that
27876 mail will be refused on the connection.  Consider checking for
27877 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27878
27879 If the command is accepted by an &%accept%& verb that has a &%message%&
27880 modifier, the message may not contain more than one line (it will be truncated
27881 at the first newline and a panic logged if it does). Such a message cannot
27882 affect the EHLO options that are listed on the second and subsequent lines of
27883 an EHLO response.
27884
27885
27886 .section "The DATA ACLs" "SECID193"
27887 .cindex "DATA" "ACLs for"
27888 Two ACLs are associated with the DATA command, because it is two-stage
27889 command, with two responses being sent to the client.
27890 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27891 is obeyed. This gives you control after all the RCPT commands, but before
27892 the message itself is received. It offers the opportunity to give a negative
27893 response to the DATA command before the data is transmitted. Header lines
27894 added by MAIL or RCPT ACLs are not visible at this time, but any that
27895 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27896
27897 You cannot test the contents of the message, for example, to verify addresses
27898 in the headers, at RCPT time or when the DATA command is received. Such
27899 tests have to appear in the ACL that is run after the message itself has been
27900 received, before the final response to the DATA command is sent. This is
27901 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27902 associated with the DATA command.
27903
27904 .cindex CHUNKING "BDAT command"
27905 .cindex BDAT "SMTP command"
27906 .cindex "RFC 3030" CHUNKING
27907 If CHUNKING was advertised and a BDAT command sequence is received,
27908 the &%acl_smtp_predata%& ACL is not run.
27909 . XXX why not?  It should be possible, for the first BDAT.
27910 The &%acl_smtp_data%& is run after the last BDAT command and all of
27911 the data specified is received.
27912
27913 For both of these ACLs, it is not possible to reject individual recipients. An
27914 error response rejects the entire message. Unfortunately, it is known that some
27915 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27916 before or after the data) correctly &-- they keep the message on their queues
27917 and try again later, but that is their problem, though it does waste some of
27918 your resources.
27919
27920 The &%acl_smtp_data%& ACL is run after
27921 the &%acl_smtp_data_prdr%&,
27922 the &%acl_smtp_dkim%&
27923 and the &%acl_smtp_mime%& ACLs.
27924
27925 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27926 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27927 enabled (which is the default).
27928
27929 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27930 received, and is executed for each DKIM signature found in a message.  If not
27931 otherwise specified, the default action is to accept.
27932
27933 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27934
27935 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27936
27937
27938 .section "The SMTP MIME ACL" "SECID194"
27939 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27940 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27941
27942 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27943
27944
27945 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27946 .cindex "PRDR" "ACL for"
27947 .oindex "&%prdr_enable%&"
27948 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27949 with PRDR support enabled (which is the default).
27950 It becomes active only when the PRDR feature is negotiated between
27951 client and server for a message, and more than one recipient
27952 has been accepted.
27953
27954 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27955 has been received, and is executed once for each recipient of the message
27956 with &$local_part$& and &$domain$& valid.
27957 The test may accept, defer or deny for individual recipients.
27958 The &%acl_smtp_data%& will still be called after this ACL and
27959 can reject the message overall, even if this ACL has accepted it
27960 for some or all recipients.
27961
27962 PRDR may be used to support per-user content filtering.  Without it
27963 one must defer any recipient after the first that has a different
27964 content-filter configuration.  With PRDR, the RCPT-time check
27965 .cindex "PRDR" "variable for"
27966 for this can be disabled when the variable &$prdr_requested$&
27967 is &"yes"&.
27968 Any required difference in behaviour of the main DATA-time
27969 ACL should however depend on the PRDR-time ACL having run, as Exim
27970 will avoid doing so in some situations (e.g.  single-recipient mails).
27971
27972 See also the &%prdr_enable%& global option
27973 and the &%hosts_try_prdr%& smtp transport option.
27974
27975 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27976 If the ACL is not defined, processing completes as if
27977 the feature was not requested by the client.
27978
27979 .section "The QUIT ACL" "SECTQUITACL"
27980 .cindex "QUIT, ACL for"
27981 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27982 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27983 does not in fact control any access.
27984 For this reason, it may only accept
27985 or warn as its final result.
27986
27987 This ACL can be used for tasks such as custom logging at the end of an SMTP
27988 session. For example, you can use ACL variables in other ACLs to count
27989 messages, recipients, etc., and log the totals at QUIT time using one or
27990 more &%logwrite%& modifiers on a &%warn%& verb.
27991
27992 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27993 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27994
27995 You do not need to have a final &%accept%&, but if you do, you can use a
27996 &%message%& modifier to specify custom text that is sent as part of the 221
27997 response to QUIT.
27998
27999 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28000 failure (for example, failure to open a log file, or when Exim is bombing out
28001 because it has detected an unrecoverable error), all SMTP commands from the
28002 client are given temporary error responses until QUIT is received or the
28003 connection is closed. In these special cases, the QUIT ACL does not run.
28004
28005
28006 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28007 .vindex &$acl_smtp_notquit$&
28008 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28009 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28010 trouble, such as being unable to write to its log files, this ACL is not run,
28011 because it might try to do things (such as write to log files) that make the
28012 situation even worse.
28013
28014 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28015 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28016 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28017 and &%warn%&.
28018
28019 .vindex &$smtp_notquit_reason$&
28020 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28021 to a string that indicates the reason for the termination of the SMTP
28022 connection. The possible values are:
28023 .table2
28024 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28025 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28026 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28027 .irow &`connection-lost`&          "The SMTP connection has been lost"
28028 .irow &`data-timeout`&             "Timeout while reading message data"
28029 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28030 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28031 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28032 .irow &`synchronization-error`&    "SMTP synchronization error"
28033 .irow &`tls-failed`&               "TLS failed to start"
28034 .endtable
28035 In most cases when an SMTP connection is closed without having received QUIT,
28036 Exim sends an SMTP response message before actually closing the connection.
28037 With the exception of the &`acl-drop`& case, the default message can be
28038 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28039 &%drop%& verb in another ACL, it is the message from the other ACL that is
28040 used.
28041
28042
28043 .section "Finding an ACL to use" "SECID195"
28044 .cindex "&ACL;" "finding which to use"
28045 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28046 you can use different ACLs in different circumstances. For example,
28047 .code
28048 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28049                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28050 .endd
28051 In the default configuration file there are some example settings for
28052 providing an RFC 4409 message submission service on port 587 and a
28053 non-standard &"smtps"& service on port 465. You can use a string
28054 expansion like this to choose an ACL for MUAs on these ports which is
28055 more appropriate for this purpose than the default ACL on port 25.
28056
28057 The expanded string does not have to be the name of an ACL in the
28058 configuration file; there are other possibilities. Having expanded the
28059 string, Exim searches for an ACL as follows:
28060
28061 .ilist
28062 If the string begins with a slash, Exim uses it as a file name, and reads its
28063 contents as an ACL. The lines are processed in the same way as lines in the
28064 Exim configuration file. In particular, continuation lines are supported, blank
28065 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28066 If the file does not exist or cannot be read, an error occurs (typically
28067 causing a temporary failure of whatever caused the ACL to be run). For example:
28068 .code
28069 acl_smtp_data = /etc/acls/\
28070   ${lookup{$sender_host_address}lsearch\
28071   {/etc/acllist}{$value}{default}}
28072 .endd
28073 This looks up an ACL file to use on the basis of the host's IP address, falling
28074 back to a default if the lookup fails. If an ACL is successfully read from a
28075 file, it is retained in memory for the duration of the Exim process, so that it
28076 can be re-used without having to re-read the file.
28077 .next
28078 If the string does not start with a slash, and does not contain any spaces,
28079 Exim searches the ACL section of the configuration for an ACL whose name
28080 matches the string.
28081 .next
28082 If no named ACL is found, or if the string contains spaces, Exim parses
28083 the string as an inline ACL. This can save typing in cases where you just
28084 want to have something like
28085 .code
28086 acl_smtp_vrfy = accept
28087 .endd
28088 in order to allow free use of the VRFY command. Such a string may contain
28089 newlines; it is processed in the same way as an ACL that is read from a file.
28090 .endlist
28091
28092
28093
28094
28095 .section "ACL return codes" "SECID196"
28096 .cindex "&ACL;" "return codes"
28097 Except for the QUIT ACL, which does not affect the SMTP return code (see
28098 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28099 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28100 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28101 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28102 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28103 This also causes a 4&'xx'& return code.
28104
28105 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28106 &"deny"&, because there is no mechanism for passing temporary errors to the
28107 submitters of non-SMTP messages.
28108
28109
28110 ACLs that are relevant to message reception may also return &"discard"&. This
28111 has the effect of &"accept"&, but causes either the entire message or an
28112 individual recipient address to be discarded. In other words, it is a
28113 blackholing facility. Use it with care.
28114
28115 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28116 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28117 RCPT ACL is to discard just the one recipient address. If there are no
28118 recipients left when the message's data is received, the DATA ACL is not
28119 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28120 remaining recipients. The &"discard"& return is not permitted for the
28121 &%acl_smtp_predata%& ACL.
28122
28123 .new
28124 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28125 is done on the address and the result determines the SMTP response.
28126 .wen
28127
28128
28129 .cindex "&[local_scan()]& function" "when all recipients discarded"
28130 The &[local_scan()]& function is always run, even if there are no remaining
28131 recipients; it may create new recipients.
28132
28133
28134
28135 .section "Unset ACL options" "SECID197"
28136 .cindex "&ACL;" "unset options"
28137 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28138 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28139 not defined at all. For any defined ACL, the default action when control
28140 reaches the end of the ACL statements is &"deny"&.
28141
28142 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28143 these two are ACLs that are used only for their side effects. They cannot be
28144 used to accept or reject anything.
28145
28146 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28147 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28148 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28149 when the ACL is not defined is &"accept"&.
28150
28151 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28152 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28153 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28154 messages over an SMTP connection. For an example, see the ACL in the default
28155 configuration file.
28156
28157
28158
28159
28160 .section "Data for message ACLs" "SECID198"
28161 .cindex "&ACL;" "data for message ACL"
28162 .vindex &$domain$&
28163 .vindex &$local_part$&
28164 .vindex &$sender_address$&
28165 .vindex &$sender_host_address$&
28166 .vindex &$smtp_command$&
28167 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28168 that contain information about the host and the message's sender (for example,
28169 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28170 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28171 &$local_part$& are set from the argument address. The entire SMTP command
28172 is available in &$smtp_command$&.
28173
28174 When an ACL for the AUTH parameter of MAIL is running, the variables that
28175 contain information about the host are set, but &$sender_address$& is not yet
28176 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28177 how it is used.
28178
28179 .vindex "&$message_size$&"
28180 The &$message_size$& variable is set to the value of the SIZE parameter on
28181 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28182 that parameter is not given. The value is updated to the true message size by
28183 the time the final DATA ACL is run (after the message data has been
28184 received).
28185
28186 .vindex "&$rcpt_count$&"
28187 .vindex "&$recipients_count$&"
28188 The &$rcpt_count$& variable increases by one for each RCPT command received.
28189 The &$recipients_count$& variable increases by one each time a RCPT command is
28190 accepted, so while an ACL for RCPT is being processed, it contains the number
28191 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28192 &$rcpt_count$& contains the total number of RCPT commands, and
28193 &$recipients_count$& contains the total number of accepted recipients.
28194
28195
28196
28197
28198
28199 .section "Data for non-message ACLs" "SECTdatfornon"
28200 .cindex "&ACL;" "data for non-message ACL"
28201 .vindex &$smtp_command_argument$&
28202 .vindex &$smtp_command$&
28203 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28204 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28205 and the entire SMTP command is available in &$smtp_command$&.
28206 These variables can be tested using a &%condition%& condition. For example,
28207 here is an ACL for use with AUTH, which insists that either the session is
28208 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28209 does not permit authentication methods that use cleartext passwords on
28210 unencrypted connections.
28211 .code
28212 acl_check_auth:
28213   accept encrypted = *
28214   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28215                      {CRAM-MD5}}
28216   deny   message   = TLS encryption or CRAM-MD5 required
28217 .endd
28218 (Another way of applying this restriction is to arrange for the authenticators
28219 that use cleartext passwords not to be advertised when the connection is not
28220 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28221 option to do this.)
28222
28223
28224
28225 .section "Format of an ACL" "SECID199"
28226 .cindex "&ACL;" "format of"
28227 .cindex "&ACL;" "verbs, definition of"
28228 An individual ACL consists of a number of statements. Each statement starts
28229 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28230 Modifiers can change the way the verb operates, define error and log messages,
28231 set variables, insert delays, and vary the processing of accepted messages.
28232
28233 If all the conditions are met, the verb is obeyed. The same condition may be
28234 used (with different arguments) more than once in the same statement. This
28235 provides a means of specifying an &"and"& conjunction between conditions. For
28236 example:
28237 .code
28238 deny  dnslists = list1.example
28239       dnslists = list2.example
28240 .endd
28241 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28242 the conditions and modifiers when it reaches a condition that fails. What
28243 happens then depends on the verb (and in one case, on a special modifier). Not
28244 all the conditions make sense at every testing point. For example, you cannot
28245 test a sender address in the ACL that is run for a VRFY command.
28246
28247
28248 .section "ACL verbs" "SECID200"
28249 The ACL verbs are as follows:
28250
28251 .ilist
28252 .cindex "&%accept%& ACL verb"
28253 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28254 of the conditions are not met, what happens depends on whether &%endpass%&
28255 appears among the conditions (for syntax see below). If the failing condition
28256 is before &%endpass%&, control is passed to the next ACL statement; if it is
28257 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28258 check a RCPT command:
28259 .code
28260 accept domains = +local_domains
28261        endpass
28262        verify = recipient
28263 .endd
28264 If the recipient domain does not match the &%domains%& condition, control
28265 passes to the next statement. If it does match, the recipient is verified, and
28266 the command is accepted if verification succeeds. However, if verification
28267 fails, the ACL yields &"deny"&, because the failing condition is after
28268 &%endpass%&.
28269
28270 The &%endpass%& feature has turned out to be confusing to many people, so its
28271 use is not recommended nowadays. It is always possible to rewrite an ACL so
28272 that &%endpass%& is not needed, and it is no longer used in the default
28273 configuration.
28274
28275 .cindex "&%message%& ACL modifier" "with &%accept%&"
28276 If a &%message%& modifier appears on an &%accept%& statement, its action
28277 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28278 (when an &%accept%& verb either accepts or passes control to the next
28279 statement), &%message%& can be used to vary the message that is sent when an
28280 SMTP command is accepted. For example, in a RCPT ACL you could have:
28281 .display
28282 &`accept  `&<&'some conditions'&>
28283 &`        message = OK, I will allow you through today`&
28284 .endd
28285 You can specify an SMTP response code, optionally followed by an &"extended
28286 response code"& at the start of the message, but the first digit must be the
28287 same as would be sent by default, which is 2 for an &%accept%& verb.
28288
28289 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28290 an error message that is used when access is denied. This behaviour is retained
28291 for backward compatibility, but current &"best practice"& is to avoid the use
28292 of &%endpass%&.
28293
28294
28295 .next
28296 .cindex "&%defer%& ACL verb"
28297 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28298 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28299 &%defer%& is the same as &%deny%&, because there is no way of sending a
28300 temporary error. For a RCPT command, &%defer%& is much the same as using a
28301 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28302 be used in any ACL, and even for a recipient it might be a simpler approach.
28303
28304
28305 .next
28306 .cindex "&%deny%& ACL verb"
28307 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28308 the conditions are not met, control is passed to the next ACL statement. For
28309 example,
28310 .code
28311 deny dnslists = blackholes.mail-abuse.org
28312 .endd
28313 rejects commands from hosts that are on a DNS black list.
28314
28315
28316 .next
28317 .cindex "&%discard%& ACL verb"
28318 &%discard%&: This verb behaves like &%accept%&, except that it returns
28319 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28320 that are concerned with receiving messages. When all the conditions are true,
28321 the sending entity receives a &"success"& response. However, &%discard%& causes
28322 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28323 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28324 message's recipients are discarded. Recipients that are discarded before DATA
28325 do not appear in the log line when the &%received_recipients%& log selector is set.
28326
28327 If the &%log_message%& modifier is set when &%discard%& operates,
28328 its contents are added to the line that is automatically written to the log.
28329 The &%message%& modifier operates exactly as it does for &%accept%&.
28330
28331
28332 .next
28333 .cindex "&%drop%& ACL verb"
28334 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28335 forcibly closed after the 5&'xx'& error message has been sent. For example:
28336 .code
28337 drop   message   = I don't take more than 20 RCPTs
28338        condition = ${if > {$rcpt_count}{20}}
28339 .endd
28340 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28341 The connection is always dropped after sending a 550 response.
28342
28343 .next
28344 .cindex "&%require%& ACL verb"
28345 &%require%&: If all the conditions are met, control is passed to the next ACL
28346 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28347 example, when checking a RCPT command,
28348 .code
28349 require message = Sender did not verify
28350         verify  = sender
28351 .endd
28352 passes control to subsequent statements only if the message's sender can be
28353 verified. Otherwise, it rejects the command. Note the positioning of the
28354 &%message%& modifier, before the &%verify%& condition. The reason for this is
28355 discussed in section &<<SECTcondmodproc>>&.
28356
28357 .next
28358 .cindex "&%warn%& ACL verb"
28359 &%warn%&: If all the conditions are true, a line specified by the
28360 &%log_message%& modifier is written to Exim's main log. Control always passes
28361 to the next ACL statement. If any condition is false, the log line is not
28362 written. If an identical log line is requested several times in the same
28363 message, only one copy is actually written to the log. If you want to force
28364 duplicates to be written, use the &%logwrite%& modifier instead.
28365
28366 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28367 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28368 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28369 first failing condition. There is more about adding header lines in section
28370 &<<SECTaddheadacl>>&.
28371
28372 If any condition on a &%warn%& statement cannot be completed (that is, there is
28373 some sort of defer), the log line specified by &%log_message%& is not written.
28374 This does not include the case of a forced failure from a lookup, which
28375 is considered to be a successful completion. After a defer, no further
28376 conditions or modifiers in the &%warn%& statement are processed. The incident
28377 is logged, and the ACL continues to be processed, from the next statement
28378 onwards.
28379
28380
28381 .vindex "&$acl_verify_message$&"
28382 When one of the &%warn%& conditions is an address verification that fails, the
28383 text of the verification failure message is in &$acl_verify_message$&. If you
28384 want this logged, you must set it up explicitly. For example:
28385 .code
28386 warn   !verify = sender
28387        log_message = sender verify failed: $acl_verify_message
28388 .endd
28389 .endlist
28390
28391 At the end of each ACL there is an implicit unconditional &%deny%&.
28392
28393 As you can see from the examples above, the conditions and modifiers are
28394 written one to a line, with the first one on the same line as the verb, and
28395 subsequent ones on following lines. If you have a very long condition, you can
28396 continue it onto several physical lines by the usual backslash continuation
28397 mechanism. It is conventional to align the conditions vertically.
28398
28399
28400
28401 .section "ACL variables" "SECTaclvariables"
28402 .cindex "&ACL;" "variables"
28403 There are some special variables that can be set during ACL processing. They
28404 can be used to pass information between different ACLs, different invocations
28405 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28406 transports, and filters that are used to deliver a message. The names of these
28407 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28408 an underscore, but the remainder of the name can be any sequence of
28409 alphanumeric characters and underscores that you choose. There is no limit on
28410 the number of ACL variables. The two sets act as follows:
28411 .ilist
28412 The values of those variables whose names begin with &$acl_c$& persist
28413 throughout an SMTP connection. They are never reset. Thus, a value that is set
28414 while receiving one message is still available when receiving the next message
28415 on the same SMTP connection.
28416 .next
28417 The values of those variables whose names begin with &$acl_m$& persist only
28418 while a message is being received. They are reset afterwards. They are also
28419 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28420 .endlist
28421
28422 When a message is accepted, the current values of all the ACL variables are
28423 preserved with the message and are subsequently made available at delivery
28424 time. The ACL variables are set by a modifier called &%set%&. For example:
28425 .code
28426 accept hosts = whatever
28427        set acl_m4 = some value
28428 accept authenticated = *
28429        set acl_c_auth = yes
28430 .endd
28431 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28432 be set. If you want to set a variable without taking any action, you can use a
28433 &%warn%& verb without any other modifiers or conditions.
28434
28435 .oindex &%strict_acl_vars%&
28436 What happens if a syntactically valid but undefined ACL variable is
28437 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28438 false (the default), an empty string is substituted; if it is true, an
28439 error is generated.
28440
28441 Versions of Exim before 4.64 have a limited set of numbered variables, but
28442 their names are compatible, so there is no problem with upgrading.
28443
28444
28445 .section "Condition and modifier processing" "SECTcondmodproc"
28446 .cindex "&ACL;" "conditions; processing"
28447 .cindex "&ACL;" "modifiers; processing"
28448 An exclamation mark preceding a condition negates its result. For example:
28449 .code
28450 deny   domains = *.dom.example
28451       !verify  = recipient
28452 .endd
28453 causes the ACL to return &"deny"& if the recipient domain ends in
28454 &'dom.example'& and the recipient address cannot be verified. Sometimes
28455 negation can be used on the right-hand side of a condition. For example, these
28456 two statements are equivalent:
28457 .code
28458 deny  hosts = !192.168.3.4
28459 deny !hosts =  192.168.3.4
28460 .endd
28461 However, for many conditions (&%verify%& being a good example), only left-hand
28462 side negation of the whole condition is possible.
28463
28464 The arguments of conditions and modifiers are expanded. A forced failure
28465 of an expansion causes a condition to be ignored, that is, it behaves as if the
28466 condition is true. Consider these two statements:
28467 .code
28468 accept  senders = ${lookup{$host_name}lsearch\
28469                   {/some/file}{$value}fail}
28470 accept  senders = ${lookup{$host_name}lsearch\
28471                   {/some/file}{$value}{}}
28472 .endd
28473 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28474 the returned list is searched, but if the lookup fails the behaviour is
28475 different in the two cases. The &%fail%& in the first statement causes the
28476 condition to be ignored, leaving no further conditions. The &%accept%& verb
28477 therefore succeeds. The second statement, however, generates an empty list when
28478 the lookup fails. No sender can match an empty list, so the condition fails,
28479 and therefore the &%accept%& also fails.
28480
28481 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28482 specify actions that are taken as the conditions for a statement are checked;
28483 others specify text for messages that are used when access is denied or a
28484 warning is generated. The &%control%& modifier affects the way an incoming
28485 message is handled.
28486
28487 The positioning of the modifiers in an ACL statement is important, because the
28488 processing of a verb ceases as soon as its outcome is known. Only those
28489 modifiers that have already been encountered will take effect. For example,
28490 consider this use of the &%message%& modifier:
28491 .code
28492 require message = Can't verify sender
28493         verify  = sender
28494         message = Can't verify recipient
28495         verify  = recipient
28496         message = This message cannot be used
28497 .endd
28498 If sender verification fails, Exim knows that the result of the statement is
28499 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28500 so its text is used as the error message. If sender verification succeeds, but
28501 recipient verification fails, the second message is used. If recipient
28502 verification succeeds, the third message becomes &"current"&, but is never used
28503 because there are no more conditions to cause failure.
28504
28505 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28506 modifier that is used, because all the conditions must be true for rejection to
28507 happen. Specifying more than one &%message%& modifier does not make sense, and
28508 the message can even be specified after all the conditions. For example:
28509 .code
28510 deny   hosts = ...
28511       !senders = *@my.domain.example
28512        message = Invalid sender from client host
28513 .endd
28514 The &"deny"& result does not happen until the end of the statement is reached,
28515 by which time Exim has set up the message.
28516
28517
28518
28519 .section "ACL modifiers" "SECTACLmodi"
28520 .cindex "&ACL;" "modifiers; list of"
28521 The ACL modifiers are as follows:
28522
28523 .vlist
28524 .vitem &*add_header*&&~=&~<&'text'&>
28525 This modifier specifies one or more header lines that are to be added to an
28526 incoming message, assuming, of course, that the message is ultimately
28527 accepted. For details, see section &<<SECTaddheadacl>>&.
28528
28529 .vitem &*continue*&&~=&~<&'text'&>
28530 .cindex "&%continue%& ACL modifier"
28531 .cindex "database" "updating in ACL"
28532 This modifier does nothing of itself, and processing of the ACL always
28533 continues with the next condition or modifier. The value of &%continue%& is in
28534 the side effects of expanding its argument. Typically this could be used to
28535 update a database. It is really just a syntactic tidiness, to avoid having to
28536 write rather ugly lines like this:
28537 .display
28538 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28539 .endd
28540 Instead, all you need is
28541 .display
28542 &`continue = `&<&'some expansion'&>
28543 .endd
28544
28545 .vitem &*control*&&~=&~<&'text'&>
28546 .cindex "&%control%& ACL modifier"
28547 This modifier affects the subsequent processing of the SMTP connection or of an
28548 incoming message that is accepted. The effect of the first type of control
28549 lasts for the duration of the connection, whereas the effect of the second type
28550 lasts only until the current message has been received. The message-specific
28551 controls always apply to the whole message, not to individual recipients,
28552 even if the &%control%& modifier appears in a RCPT ACL.
28553
28554 As there are now quite a few controls that can be applied, they are described
28555 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28556 in several different ways. For example:
28557
28558 . ==== As this is a nested list, any displays it contains must be indented
28559 . ==== as otherwise they are too far to the left. That comment applies only
28560 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28561 . ==== way.
28562
28563 .ilist
28564 It can be at the end of an &%accept%& statement:
28565 .code
28566     accept  ...some conditions
28567             control = queue_only
28568 .endd
28569 In this case, the control is applied when this statement yields &"accept"&, in
28570 other words, when the conditions are all true.
28571
28572 .next
28573 It can be in the middle of an &%accept%& statement:
28574 .code
28575     accept  ...some conditions...
28576             control = queue_only
28577             ...some more conditions...
28578 .endd
28579 If the first set of conditions are true, the control is applied, even if the
28580 statement does not accept because one of the second set of conditions is false.
28581 In this case, some subsequent statement must yield &"accept"& for the control
28582 to be relevant.
28583
28584 .next
28585 It can be used with &%warn%& to apply the control, leaving the
28586 decision about accepting or denying to a subsequent verb. For
28587 example:
28588 .code
28589     warn    ...some conditions...
28590             control = freeze
28591     accept  ...
28592 .endd
28593 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28594 &%logwrite%&, so it does not add anything to the message and does not write a
28595 log entry.
28596
28597 .next
28598 If you want to apply a control unconditionally, you can use it with a
28599 &%require%& verb. For example:
28600 .code
28601     require  control = no_multiline_responses
28602 .endd
28603 .endlist
28604
28605 .vitem &*delay*&&~=&~<&'time'&>
28606 .cindex "&%delay%& ACL modifier"
28607 .oindex "&%-bh%&"
28608 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28609 the time interval before proceeding. However, when testing Exim using the
28610 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28611 output instead). The time is given in the usual Exim notation, and the delay
28612 happens as soon as the modifier is processed. In an SMTP session, pending
28613 output is flushed before the delay is imposed.
28614
28615 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28616 example:
28617 .code
28618 deny    ...some conditions...
28619         delay = 30s
28620 .endd
28621 The delay happens if all the conditions are true, before the statement returns
28622 &"deny"&. Compare this with:
28623 .code
28624 deny    delay = 30s
28625         ...some conditions...
28626 .endd
28627 which waits for 30s before processing the conditions. The &%delay%& modifier
28628 can also be used with &%warn%& and together with &%control%&:
28629 .code
28630 warn    ...some conditions...
28631         delay = 2m
28632         control = freeze
28633 accept  ...
28634 .endd
28635
28636 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28637 responses to several commands are no longer buffered and sent in one packet (as
28638 they would normally be) because all output is flushed before imposing the
28639 delay. This optimization is disabled so that a number of small delays do not
28640 appear to the client as one large aggregated delay that might provoke an
28641 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28642 using a &%control%& modifier to set &%no_delay_flush%&.
28643
28644
28645 .vitem &*endpass*&
28646 .cindex "&%endpass%& ACL modifier"
28647 This modifier, which has no argument, is recognized only in &%accept%& and
28648 &%discard%& statements. It marks the boundary between the conditions whose
28649 failure causes control to pass to the next statement, and the conditions whose
28650 failure causes the ACL to return &"deny"&. This concept has proved to be
28651 confusing to some people, so the use of &%endpass%& is no longer recommended as
28652 &"best practice"&. See the description of &%accept%& above for more details.
28653
28654
28655 .vitem &*log_message*&&~=&~<&'text'&>
28656 .cindex "&%log_message%& ACL modifier"
28657 This modifier sets up a message that is used as part of the log message if the
28658 ACL denies access or a &%warn%& statement's conditions are true. For example:
28659 .code
28660 require log_message = wrong cipher suite $tls_in_cipher
28661         encrypted   = DES-CBC3-SHA
28662 .endd
28663 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28664 example:
28665 .display
28666 &`discard `&<&'some conditions'&>
28667 &`        log_message = Discarded $local_part@$domain because...`&
28668 .endd
28669 When access is denied, &%log_message%& adds to any underlying error message
28670 that may exist because of a condition failure. For example, while verifying a
28671 recipient address, a &':fail:'& redirection might have already set up a
28672 message.
28673
28674 The message may be defined before the conditions to which it applies, because
28675 the string expansion does not happen until Exim decides that access is to be
28676 denied. This means that any variables that are set by the condition are
28677 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28678 variables are set after a DNS black list lookup succeeds. If the expansion of
28679 &%log_message%& fails, or if the result is an empty string, the modifier is
28680 ignored.
28681
28682 .vindex "&$acl_verify_message$&"
28683 If you want to use a &%warn%& statement to log the result of an address
28684 verification, you can use &$acl_verify_message$& to include the verification
28685 error message.
28686
28687 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28688 the start of the logged message. If the same warning log message is requested
28689 more than once while receiving  a single email message, only one copy is
28690 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28691 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28692 is logged for a successful &%warn%& statement.
28693
28694 If &%log_message%& is not present and there is no underlying error message (for
28695 example, from the failure of address verification), but &%message%& is present,
28696 the &%message%& text is used for logging rejections. However, if any text for
28697 logging contains newlines, only the first line is logged. In the absence of
28698 both &%log_message%& and &%message%&, a default built-in message is used for
28699 logging rejections.
28700
28701
28702 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28703 .cindex "&%log_reject_target%& ACL modifier"
28704 .cindex "logging in ACL" "specifying which log"
28705 This modifier makes it possible to specify which logs are used for messages
28706 about ACL rejections. Its argument is a colon-separated list of words that can
28707 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28708 may be empty, in which case a rejection is not logged at all. For example, this
28709 ACL fragment writes no logging information when access is denied:
28710 .display
28711 &`deny `&<&'some conditions'&>
28712 &`     log_reject_target =`&
28713 .endd
28714 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28715 permanent and temporary rejections. Its effect lasts for the rest of the
28716 current ACL.
28717
28718
28719 .vitem &*logwrite*&&~=&~<&'text'&>
28720 .cindex "&%logwrite%& ACL modifier"
28721 .cindex "logging in ACL" "immediate"
28722 This modifier writes a message to a log file as soon as it is encountered when
28723 processing an ACL. (Compare &%log_message%&, which, except in the case of
28724 &%warn%& and &%discard%&, is used only if the ACL statement denies
28725 access.) The &%logwrite%& modifier can be used to log special incidents in
28726 ACLs. For example:
28727 .display
28728 &`accept `&<&'some special conditions'&>
28729 &`       control  = freeze`&
28730 &`       logwrite = froze message because ...`&
28731 .endd
28732 By default, the message is written to the main log. However, it may begin
28733 with a colon, followed by a comma-separated list of log names, and then
28734 another colon, to specify exactly which logs are to be written. For
28735 example:
28736 .code
28737 logwrite = :main,reject: text for main and reject logs
28738 logwrite = :panic: text for panic log only
28739 .endd
28740
28741
28742 .vitem &*message*&&~=&~<&'text'&>
28743 .cindex "&%message%& ACL modifier"
28744 This modifier sets up a text string that is expanded and used as a response
28745 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28746 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28747 there is some complication if &%endpass%& is involved; see the description of
28748 &%accept%& for details.)
28749
28750 The expansion of the message happens at the time Exim decides that the ACL is
28751 to end, not at the time it processes &%message%&. If the expansion fails, or
28752 generates an empty string, the modifier is ignored. Here is an example where
28753 &%message%& must be specified first, because the ACL ends with a rejection if
28754 the &%hosts%& condition fails:
28755 .code
28756 require  message = Host not recognized
28757          hosts = 10.0.0.0/8
28758 .endd
28759 (Once a condition has failed, no further conditions or modifiers are
28760 processed.)
28761
28762 .cindex "SMTP" "error codes"
28763 .oindex "&%smtp_banner%&
28764 For ACLs that are triggered by SMTP commands, the message is returned as part
28765 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28766 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28767 is accepted. In the case of the connect ACL, accepting with a message modifier
28768 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28769 accept message may not contain more than one line (otherwise it will be
28770 truncated at the first newline and a panic logged), and it cannot affect the
28771 EHLO options.
28772
28773 When SMTP is involved, the message may begin with an overriding response code,
28774 consisting of three digits optionally followed by an &"extended response code"&
28775 of the form &'n.n.n'&, each code being followed by a space. For example:
28776 .code
28777 deny  message = 599 1.2.3 Host not welcome
28778       hosts = 192.168.34.0/24
28779 .endd
28780 The first digit of the supplied response code must be the same as would be sent
28781 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28782 access, but for the predata ACL, note that the default success code is 354, not
28783 2&'xx'&.
28784
28785 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28786 the message modifier cannot override the 221 response code.
28787
28788 The text in a &%message%& modifier is literal; any quotes are taken as
28789 literals, but because the string is expanded, backslash escapes are processed
28790 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28791 response.
28792
28793 .vindex "&$acl_verify_message$&"
28794 For ACLs that are called by an &%acl =%& ACL condition, the message is
28795 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28796
28797 If &%message%& is used on a statement that verifies an address, the message
28798 specified overrides any message that is generated by the verification process.
28799 However, the original message is available in the variable
28800 &$acl_verify_message$&, so you can incorporate it into your message if you
28801 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28802 routers to be passed back as part of the SMTP response, you should either not
28803 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28804
28805 For compatibility with previous releases of Exim, a &%message%& modifier that
28806 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28807 modifier, but this usage is now deprecated. However, &%message%& acts only when
28808 all the conditions are true, wherever it appears in an ACL command, whereas
28809 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28810 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28811 effect.
28812
28813
28814 .vitem &*queue*&&~=&~<&'text'&>
28815 This modifier specifies the use of a named queue for spool files
28816 for the message.
28817 It can only be used before the message is received (i.e. not in
28818 the DATA ACL).
28819 This could be used, for example, for known high-volume burst sources
28820 of traffic, or for quarantine of messages.
28821 Separate queue-runner processes will be needed for named queues.
28822 If the text after expansion is empty, the default queue is used.
28823
28824
28825 .vitem &*remove_header*&&~=&~<&'text'&>
28826 This modifier specifies one or more header names in a colon-separated list
28827  that are to be removed from an incoming message, assuming, of course, that
28828 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28829
28830
28831 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28832 .cindex "&%set%& ACL modifier"
28833 This modifier puts a value into one of the ACL variables (see section
28834 &<<SECTaclvariables>>&).
28835
28836
28837 .vitem &*udpsend*&&~=&~<&'parameters'&>
28838 This modifier sends a UDP packet, for purposes such as statistics
28839 collection or behaviour monitoring. The parameters are expanded, and
28840 the result of the expansion must be a colon-separated list consisting
28841 of a destination server, port number, and the packet contents. The
28842 server can be specified as a host name or IPv4 or IPv6 address. The
28843 separator can be changed with the usual angle bracket syntax. For
28844 example, you might want to collect information on which hosts connect
28845 when:
28846 .code
28847 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28848              $tod_zulu $sender_host_address
28849 .endd
28850 .endlist
28851
28852
28853
28854
28855 .section "Use of the control modifier" "SECTcontrols"
28856 .cindex "&%control%& ACL modifier"
28857 The &%control%& modifier supports the following settings:
28858
28859 .vlist
28860 .vitem &*control&~=&~allow_auth_unadvertised*&
28861 This modifier allows a client host to use the SMTP AUTH command even when it
28862 has not been advertised in response to EHLO. Furthermore, because there are
28863 apparently some really broken clients that do this, Exim will accept AUTH after
28864 HELO (rather than EHLO) when this control is set. It should be used only if you
28865 really need it, and you should limit its use to those broken clients that do
28866 not work without it. For example:
28867 .code
28868 warn hosts   = 192.168.34.25
28869      control = allow_auth_unadvertised
28870 .endd
28871 Normally, when an Exim server receives an AUTH command, it checks the name of
28872 the authentication mechanism that is given in the command to ensure that it
28873 matches an advertised mechanism. When this control is set, the check that a
28874 mechanism has been advertised is bypassed. Any configured mechanism can be used
28875 by the client. This control is permitted only in the connection and HELO ACLs.
28876
28877
28878 .vitem &*control&~=&~caseful_local_part*& &&&
28879        &*control&~=&~caselower_local_part*&
28880 .cindex "&ACL;" "case of local part in"
28881 .cindex "case of local parts"
28882 .vindex "&$local_part$&"
28883 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28884 (that is, during RCPT processing). By default, the contents of &$local_part$&
28885 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28886 any uppercase letters in the original local part are restored in &$local_part$&
28887 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28888 is encountered.
28889
28890 These controls affect only the current recipient. Moreover, they apply only to
28891 local part handling that takes place directly in the ACL (for example, as a key
28892 in lookups). If a test to verify the recipient is obeyed, the case-related
28893 handling of the local part during the verification is controlled by the router
28894 configuration (see the &%caseful_local_part%& generic router option).
28895
28896 This facility could be used, for example, to add a spam score to local parts
28897 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28898 spam score:
28899 .code
28900 warn  control = caseful_local_part
28901       set acl_m4 = ${eval:\
28902                      $acl_m4 + \
28903                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28904                     }
28905       control = caselower_local_part
28906 .endd
28907 Notice that we put back the lower cased version afterwards, assuming that
28908 is what is wanted for subsequent tests.
28909
28910
28911 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
28912 .cindex "&ACL;" "cutthrough routing"
28913 .cindex "cutthrough" "requesting"
28914 This option requests delivery be attempted while the item is being received.
28915
28916 The option is usable in the RCPT ACL.
28917 If enabled for a message received via smtp and routed to an smtp transport,
28918 and only one transport, interface, destination host and port combination
28919 is used for all recipients of the message,
28920 then the delivery connection is made while the receiving connection is open
28921 and data is copied from one to the other.
28922
28923 An attempt to set this option for any recipient but the first
28924 for a mail will be quietly ignored.
28925 If a recipient-verify callout
28926 (with use_sender)
28927 connection is subsequently
28928 requested in the same ACL it is held open and used for
28929 any subsequent recipients and the data,
28930 otherwise one is made after the initial RCPT ACL completes.
28931
28932 Note that routers are used in verify mode,
28933 and cannot depend on content of received headers.
28934 Note also that headers cannot be
28935 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28936 Headers may be modified by routers (subject to the above) and transports.
28937
28938 All the usual ACLs are called; if one results in the message being
28939 rejected, all effort spent in delivery (including the costs on
28940 the ultimate destination) will be wasted.
28941 Note that in the case of data-time ACLs this includes the entire
28942 message body.
28943
28944 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28945 of outgoing messages is done, because it sends data to the ultimate destination
28946 before the entire message has been received from the source.
28947 It is not supported for messages received with the SMTP PRDR
28948 .new
28949 or CHUNKING
28950 .wen
28951 options in use.
28952
28953 Should the ultimate destination system positively accept or reject the mail,
28954 a corresponding indication is given to the source system and nothing is queued.
28955 If the item is successfully delivered in cutthrough mode
28956 the delivery log lines are tagged with ">>" rather than "=>" and appear
28957 before the acceptance "<=" line.
28958
28959 If there is a temporary error the item is queued for later delivery in the
28960 usual fashion.
28961 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
28962 to the control; the default value is &"spool"& and the alternate value
28963 &"pass"& copies an SMTP defer response from the target back to the initiator
28964 and does not queue the message.
28965 Note that this is independent of any recipient verify conditions in the ACL.
28966
28967 Delivery in this mode avoids the generation of a bounce mail to a
28968 (possibly faked)
28969 sender when the destination system is doing content-scan based rejection.
28970
28971
28972 .vitem &*control&~=&~debug/*&<&'options'&>
28973 .cindex "&ACL;" "enabling debug logging"
28974 .cindex "debugging" "enabling from an ACL"
28975 This control turns on debug logging, almost as though Exim had been invoked
28976 with &`-d`&, with the output going to a new logfile, by default called
28977 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28978 may access any variables already defined.  The logging may be adjusted with
28979 the &'opts'& option, which takes the same values as the &`-d`& command-line
28980 option.
28981 Logging may be stopped, and the file removed, with the &'kill'& option.
28982 Some examples (which depend on variables that don't exist in all
28983 contexts):
28984 .code
28985       control = debug
28986       control = debug/tag=.$sender_host_address
28987       control = debug/opts=+expand+acl
28988       control = debug/tag=.$message_exim_id/opts=+expand
28989       control = debug/kill
28990 .endd
28991
28992
28993 .vitem &*control&~=&~dkim_disable_verify*&
28994 .cindex "disable DKIM verify"
28995 .cindex "DKIM" "disable verify"
28996 This control turns off DKIM verification processing entirely.  For details on
28997 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28998
28999
29000 .vitem &*control&~=&~dscp/*&<&'value'&>
29001 .cindex "&ACL;" "setting DSCP value"
29002 .cindex "DSCP" "inbound"
29003 This option causes the DSCP value associated with the socket for the inbound
29004 connection to be adjusted to a given value, given as one of a number of fixed
29005 strings or to numeric value.
29006 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29007 Common values include &`throughput`&, &`mincost`&, and on newer systems
29008 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29009
29010 The outbound packets from Exim will be marked with this value in the header
29011 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29012 that these values will have any effect, not be stripped by networking
29013 equipment, or do much of anything without cooperation with your Network
29014 Engineer and those of all network operators between the source and destination.
29015
29016
29017 .vitem &*control&~=&~enforce_sync*& &&&
29018        &*control&~=&~no_enforce_sync*&
29019 .cindex "SMTP" "synchronization checking"
29020 .cindex "synchronization checking in SMTP"
29021 These controls make it possible to be selective about when SMTP synchronization
29022 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29023 state of the switch (it is true by default). See the description of this option
29024 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29025
29026 The effect of these two controls lasts for the remainder of the SMTP
29027 connection. They can appear in any ACL except the one for the non-SMTP
29028 messages. The most straightforward place to put them is in the ACL defined by
29029 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29030 before the first synchronization check. The expected use is to turn off the
29031 synchronization checks for badly-behaved hosts that you nevertheless need to
29032 work with.
29033
29034
29035 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29036 .cindex "fake defer"
29037 .cindex "defer, fake"
29038 This control works in exactly the same way as &%fakereject%& (described below)
29039 except that it causes an SMTP 450 response after the message data instead of a
29040 550 response. You must take care when using &%fakedefer%& because it causes the
29041 messages to be duplicated when the sender retries. Therefore, you should not
29042 use &%fakedefer%& if the message is to be delivered normally.
29043
29044 .vitem &*control&~=&~fakereject/*&<&'message'&>
29045 .cindex "fake rejection"
29046 .cindex "rejection, fake"
29047 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29048 words, only when an SMTP message is being received. If Exim accepts the
29049 message, instead the final 250 response, a 550 rejection message is sent.
29050 However, Exim proceeds to deliver the message as normal. The control applies
29051 only to the current message, not to any subsequent ones that may be received in
29052 the same SMTP connection.
29053
29054 The text for the 550 response is taken from the &%control%& modifier. If no
29055 message is supplied, the following is used:
29056 .code
29057 550-Your message has been rejected but is being
29058 550-kept for evaluation.
29059 550-If it was a legitimate message, it may still be
29060 550 delivered to the target recipient(s).
29061 .endd
29062 This facility should be used with extreme caution.
29063
29064 .vitem &*control&~=&~freeze*&
29065 .cindex "frozen messages" "forcing in ACL"
29066 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29067 other words, only when a message is being received. If the message is accepted,
29068 it is placed on Exim's queue and frozen. The control applies only to the
29069 current message, not to any subsequent ones that may be received in the same
29070 SMTP connection.
29071
29072 This modifier can optionally be followed by &`/no_tell`&. If the global option
29073 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29074 is told about the freezing), provided all the &*control=freeze*& modifiers that
29075 are obeyed for the current message have the &`/no_tell`& option.
29076
29077 .vitem &*control&~=&~no_delay_flush*&
29078 .cindex "SMTP" "output flushing, disabling for delay"
29079 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29080 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29081 use. This control, as long as it is encountered before the &%delay%& modifier,
29082 disables such output flushing.
29083
29084 .vitem &*control&~=&~no_callout_flush*&
29085 .cindex "SMTP" "output flushing, disabling for callout"
29086 Exim normally flushes SMTP output before performing a callout in an ACL, to
29087 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29088 use. This control, as long as it is encountered before the &%verify%& condition
29089 that causes the callout, disables such output flushing.
29090
29091 .vitem &*control&~=&~no_mbox_unspool*&
29092 This control is available when Exim is compiled with the content scanning
29093 extension. Content scanning may require a copy of the current message, or parts
29094 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29095 or spam scanner. Normally, such copies are deleted when they are no longer
29096 needed. If this control is set, the copies are not deleted. The control applies
29097 only to the current message, not to any subsequent ones that may be received in
29098 the same SMTP connection. It is provided for debugging purposes and is unlikely
29099 to be useful in production.
29100
29101 .vitem &*control&~=&~no_multiline_responses*&
29102 .cindex "multiline responses, suppressing"
29103 This control is permitted for any ACL except the one for non-SMTP messages.
29104 It seems that there are broken clients in use that cannot handle multiline
29105 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29106
29107 If this control is set, multiline SMTP responses from ACL rejections are
29108 suppressed. One way of doing this would have been to put out these responses as
29109 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29110 (&"use multiline responses for more"& it says &-- ha!), and some of the
29111 responses might get close to that. So this facility, which is after all only a
29112 sop to broken clients, is implemented by doing two very easy things:
29113
29114 .ilist
29115 Extra information that is normally output as part of a rejection caused by
29116 sender verification failure is omitted. Only the final line (typically &"sender
29117 verification failed"&) is sent.
29118 .next
29119 If a &%message%& modifier supplies a multiline response, only the first
29120 line is output.
29121 .endlist
29122
29123 The setting of the switch can, of course, be made conditional on the
29124 calling host. Its effect lasts until the end of the SMTP connection.
29125
29126 .vitem &*control&~=&~no_pipelining*&
29127 .cindex "PIPELINING" "suppressing advertising"
29128 This control turns off the advertising of the PIPELINING extension to SMTP in
29129 the current session. To be useful, it must be obeyed before Exim sends its
29130 response to an EHLO command. Therefore, it should normally appear in an ACL
29131 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29132 &%pipelining_advertise_hosts%&.
29133
29134 .vitem &*control&~=&~queue_only*&
29135 .oindex "&%queue_only%&"
29136 .cindex "queueing incoming messages"
29137 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29138 other words, only when a message is being received. If the message is accepted,
29139 it is placed on Exim's queue and left there for delivery by a subsequent queue
29140 runner. No immediate delivery process is started. In other words, it has the
29141 effect as the &%queue_only%& global option. However, the control applies only
29142 to the current message, not to any subsequent ones that may be received in the
29143 same SMTP connection.
29144
29145 .vitem &*control&~=&~submission/*&<&'options'&>
29146 .cindex "message" "submission"
29147 .cindex "submission mode"
29148 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29149 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29150 the current message is a submission from a local MUA. In this case, Exim
29151 operates in &"submission mode"&, and applies certain fixups to the message if
29152 necessary. For example, it adds a &'Date:'& header line if one is not present.
29153 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29154 late (the message has already been created).
29155
29156 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29157 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29158 submission mode; the available options for this control are described there.
29159 The control applies only to the current message, not to any subsequent ones
29160 that may be received in the same SMTP connection.
29161
29162 .vitem &*control&~=&~suppress_local_fixups*&
29163 .cindex "submission fixups, suppressing"
29164 This control applies to locally submitted (non TCP/IP) messages, and is the
29165 complement of &`control = submission`&. It disables the fixups that are
29166 normally applied to locally-submitted messages. Specifically:
29167
29168 .ilist
29169 Any &'Sender:'& header line is left alone (in this respect, it is a
29170 dynamic version of &%local_sender_retain%&).
29171 .next
29172 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29173 .next
29174 There is no check that &'From:'& corresponds to the actual sender.
29175 .endlist ilist
29176
29177 This control may be useful when a remotely-originated message is accepted,
29178 passed to some scanning program, and then re-submitted for delivery. It can be
29179 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29180 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29181 data is read.
29182
29183 &*Note:*& This control applies only to the current message, not to any others
29184 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29185
29186 .vitem &*control&~=&~utf8_downconvert*&
29187 This control enables conversion of UTF-8 in message addresses
29188 to a-label form.
29189 For details see section &<<SECTi18nMTA>>&.
29190 .endlist vlist
29191
29192
29193 .section "Summary of message fixup control" "SECTsummesfix"
29194 All four possibilities for message fixups can be specified:
29195
29196 .ilist
29197 Locally submitted, fixups applied: the default.
29198 .next
29199 Locally submitted, no fixups applied: use
29200 &`control = suppress_local_fixups`&.
29201 .next
29202 Remotely submitted, no fixups applied: the default.
29203 .next
29204 Remotely submitted, fixups applied: use &`control = submission`&.
29205 .endlist
29206
29207
29208
29209 .section "Adding header lines in ACLs" "SECTaddheadacl"
29210 .cindex "header lines" "adding in an ACL"
29211 .cindex "header lines" "position of added lines"
29212 .cindex "&%add_header%& ACL modifier"
29213 The &%add_header%& modifier can be used to add one or more extra header lines
29214 to an incoming message, as in this example:
29215 .code
29216 warn dnslists = sbl.spamhaus.org : \
29217                 dialup.mail-abuse.org
29218      add_header = X-blacklisted-at: $dnslist_domain
29219 .endd
29220 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29221 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29222 receiving a message). The message must ultimately be accepted for
29223 &%add_header%& to have any significant effect. You can use &%add_header%& with
29224 any ACL verb, including &%deny%& (though this is potentially useful only in a
29225 RCPT ACL).
29226
29227 Headers will not be added to the message if the modifier is used in
29228 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29229
29230 Leading and trailing newlines are removed from
29231 the data for the &%add_header%& modifier; if it then
29232 contains one or more newlines that
29233 are not followed by a space or a tab, it is assumed to contain multiple header
29234 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29235 front of any line that is not a valid header line.
29236
29237 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29238 They are added to the message before processing the DATA and MIME ACLs.
29239 However, if an identical header line is requested more than once, only one copy
29240 is actually added to the message. Further header lines may be accumulated
29241 during the DATA and MIME ACLs, after which they are added to the message, again
29242 with duplicates suppressed. Thus, it is possible to add two identical header
29243 lines to an SMTP message, but only if one is added before DATA and one after.
29244 In the case of non-SMTP messages, new headers are accumulated during the
29245 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29246 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29247 are included in the entry that is written to the reject log.
29248
29249 .cindex "header lines" "added; visibility of"
29250 Header lines are not visible in string expansions
29251 of message headers
29252 until they are added to the
29253 message. It follows that header lines defined in the MAIL, RCPT, and predata
29254 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29255 header lines that are added by the DATA or MIME ACLs are not visible in those
29256 ACLs. Because of this restriction, you cannot use header lines as a way of
29257 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29258 this, you can use ACL variables, as described in section
29259 &<<SECTaclvariables>>&.
29260
29261 The list of headers yet to be added is given by the &%$headers_added%& variable.
29262
29263 The &%add_header%& modifier acts immediately as it is encountered during the
29264 processing of an ACL. Notice the difference between these two cases:
29265 .display
29266 &`accept add_header = ADDED: some text`&
29267 &`       `&<&'some condition'&>
29268
29269 &`accept `&<&'some condition'&>
29270 &`       add_header = ADDED: some text`&
29271 .endd
29272 In the first case, the header line is always added, whether or not the
29273 condition is true. In the second case, the header line is added only if the
29274 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29275 ACL statement. All those that are encountered before a condition fails are
29276 honoured.
29277
29278 .cindex "&%warn%& ACL verb"
29279 For compatibility with previous versions of Exim, a &%message%& modifier for a
29280 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29281 effect only if all the conditions are true, even if it appears before some of
29282 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29283 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29284 are present on a &%warn%& verb, both are processed according to their
29285 specifications.
29286
29287 By default, new header lines are added to a message at the end of the existing
29288 header lines. However, you can specify that any particular header line should
29289 be added right at the start (before all the &'Received:'& lines), immediately
29290 after the first block of &'Received:'& lines, or immediately before any line
29291 that is not a &'Received:'& or &'Resent-something:'& header.
29292
29293 This is done by specifying &":at_start:"&, &":after_received:"&, or
29294 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29295 header line, respectively. (Header text cannot start with a colon, as there has
29296 to be a header name first.) For example:
29297 .code
29298 warn add_header = \
29299        :after_received:X-My-Header: something or other...
29300 .endd
29301 If more than one header line is supplied in a single &%add_header%& modifier,
29302 each one is treated independently and can therefore be placed differently. If
29303 you add more than one line at the start, or after the Received: block, they end
29304 up in reverse order.
29305
29306 &*Warning*&: This facility currently applies only to header lines that are
29307 added in an ACL. It does NOT work for header lines that are added in a
29308 system filter or in a router or transport.
29309
29310
29311
29312 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29313 .cindex "header lines" "removing in an ACL"
29314 .cindex "header lines" "position of removed lines"
29315 .cindex "&%remove_header%& ACL modifier"
29316 The &%remove_header%& modifier can be used to remove one or more header lines
29317 from an incoming message, as in this example:
29318 .code
29319 warn   message        = Remove internal headers
29320        remove_header  = x-route-mail1 : x-route-mail2
29321 .endd
29322 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29323 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29324 receiving a message). The message must ultimately be accepted for
29325 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29326 with any ACL verb, including &%deny%&, though this is really not useful for
29327 any verb that doesn't result in a delivered message.
29328
29329 Headers will not be removed from the message if the modifier is used in
29330 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29331
29332 More than one header can be removed at the same time by using a colon separated
29333 list of header names. The header matching is case insensitive. Wildcards are
29334 not permitted, nor is list expansion performed, so you cannot use hostlists to
29335 create a list of headers, however both connection and message variable expansion
29336 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29337 .code
29338 warn   hosts           = +internal_hosts
29339        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29340 warn   message         = Remove internal headers
29341        remove_header   = $acl_c_ihdrs
29342 .endd
29343 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29344 They are removed from the message before processing the DATA and MIME ACLs.
29345 There is no harm in attempting to remove the same header twice nor is removing
29346 a non-existent header. Further header lines to be removed may be accumulated
29347 during the DATA and MIME ACLs, after which they are removed from the message,
29348 if present. In the case of non-SMTP messages, headers to be removed are
29349 accumulated during the non-SMTP ACLs, and are removed from the message after
29350 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29351 ACL, there really is no effect because there is no logging of what headers
29352 would have been removed.
29353
29354 .cindex "header lines" "removed; visibility of"
29355 Header lines are not visible in string expansions until the DATA phase when it
29356 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29357 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29358 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29359 this restriction, you cannot use header lines as a way of controlling data
29360 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29361 you should instead use ACL variables, as described in section
29362 &<<SECTaclvariables>>&.
29363
29364 The &%remove_header%& modifier acts immediately as it is encountered during the
29365 processing of an ACL. Notice the difference between these two cases:
29366 .display
29367 &`accept remove_header = X-Internal`&
29368 &`       `&<&'some condition'&>
29369
29370 &`accept `&<&'some condition'&>
29371 &`       remove_header = X-Internal`&
29372 .endd
29373 In the first case, the header line is always removed, whether or not the
29374 condition is true. In the second case, the header line is removed only if the
29375 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29376 same ACL statement. All those that are encountered before a condition fails
29377 are honoured.
29378
29379 &*Warning*&: This facility currently applies only to header lines that are
29380 present during ACL processing. It does NOT remove header lines that are added
29381 in a system filter or in a router or transport.
29382
29383
29384
29385
29386 .section "ACL conditions" "SECTaclconditions"
29387 .cindex "&ACL;" "conditions; list of"
29388 Some of the conditions listed in this section are available only when Exim is
29389 compiled with the content-scanning extension. They are included here briefly
29390 for completeness. More detailed descriptions can be found in the discussion on
29391 content scanning in chapter &<<CHAPexiscan>>&.
29392
29393 Not all conditions are relevant in all circumstances. For example, testing
29394 senders and recipients does not make sense in an ACL that is being run as the
29395 result of the arrival of an ETRN command, and checks on message headers can be
29396 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29397 can use the same condition (with different parameters) more than once in the
29398 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29399 The conditions are as follows:
29400
29401
29402 .vlist
29403 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29404 .cindex "&ACL;" "nested"
29405 .cindex "&ACL;" "indirect"
29406 .cindex "&ACL;" "arguments"
29407 .cindex "&%acl%& ACL condition"
29408 The possible values of the argument are the same as for the
29409 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29410 &"accept"& the condition is true; if it returns &"deny"& the condition is
29411 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29412 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29413 condition false. This means that further processing of the &%warn%& verb
29414 ceases, but processing of the ACL continues.
29415
29416 If the argument is a named ACL, up to nine space-separated optional values
29417 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29418 and $acl_narg is set to the count of values.
29419 Previous values of these variables are restored after the call returns.
29420 The name and values are expanded separately.
29421 Note that spaces in complex expansions which are used as arguments
29422 will act as argument separators.
29423
29424 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29425 the connection is dropped. If it returns &"discard"&, the verb must be
29426 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29427 conditions are tested.
29428
29429 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29430 loops. This condition allows you to use different ACLs in different
29431 circumstances. For example, different ACLs can be used to handle RCPT commands
29432 for different local users or different local domains.
29433
29434 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29435 .cindex "&%authenticated%& ACL condition"
29436 .cindex "authentication" "ACL checking"
29437 .cindex "&ACL;" "testing for authentication"
29438 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29439 the name of the authenticator is tested against the list. To test for
29440 authentication by any authenticator, you can set
29441 .code
29442 authenticated = *
29443 .endd
29444
29445 .vitem &*condition&~=&~*&<&'string'&>
29446 .cindex "&%condition%& ACL condition"
29447 .cindex "customizing" "ACL condition"
29448 .cindex "&ACL;" "customized test"
29449 .cindex "&ACL;" "testing, customized"
29450 This feature allows you to make up custom conditions. If the result of
29451 expanding the string is an empty string, the number zero, or one of the strings
29452 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29453 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29454 any other value, some error is assumed to have occurred, and the ACL returns
29455 &"defer"&. However, if the expansion is forced to fail, the condition is
29456 ignored. The effect is to treat it as true, whether it is positive or
29457 negative.
29458
29459 .vitem &*decode&~=&~*&<&'location'&>
29460 .cindex "&%decode%& ACL condition"
29461 This condition is available only when Exim is compiled with the
29462 content-scanning extension, and it is allowed only in the ACL defined by
29463 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29464 If all goes well, the condition is true. It is false only if there are
29465 problems such as a syntax error or a memory shortage. For more details, see
29466 chapter &<<CHAPexiscan>>&.
29467
29468 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29469 .cindex "&%dnslists%& ACL condition"
29470 .cindex "DNS list" "in ACL"
29471 .cindex "black list (DNS)"
29472 .cindex "&ACL;" "testing a DNS list"
29473 This condition checks for entries in DNS black lists. These are also known as
29474 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29475 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29476 different variants of this condition to describe briefly here. See sections
29477 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29478
29479 .vitem &*domains&~=&~*&<&'domain&~list'&>
29480 .cindex "&%domains%& ACL condition"
29481 .cindex "domain" "ACL checking"
29482 .cindex "&ACL;" "testing a recipient domain"
29483 .vindex "&$domain_data$&"
29484 This condition is relevant only after a RCPT command. It checks that the domain
29485 of the recipient address is in the domain list. If percent-hack processing is
29486 enabled, it is done before this test is done. If the check succeeds with a
29487 lookup, the result of the lookup is placed in &$domain_data$& until the next
29488 &%domains%& test.
29489
29490 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29491 use &%domains%& in a DATA ACL.
29492
29493
29494 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29495 .cindex "&%encrypted%& ACL condition"
29496 .cindex "encryption" "checking in an ACL"
29497 .cindex "&ACL;" "testing for encryption"
29498 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29499 name of the cipher suite in use is tested against the list. To test for
29500 encryption without testing for any specific cipher suite(s), set
29501 .code
29502 encrypted = *
29503 .endd
29504
29505
29506 .vitem &*hosts&~=&~*&<&'host&~list'&>
29507 .cindex "&%hosts%& ACL condition"
29508 .cindex "host" "ACL checking"
29509 .cindex "&ACL;" "testing the client host"
29510 This condition tests that the calling host matches the host list. If you have
29511 name lookups or wildcarded host names and IP addresses in the same host list,
29512 you should normally put the IP addresses first. For example, you could have:
29513 .code
29514 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29515 .endd
29516 The lookup in this example uses the host name for its key. This is implied by
29517 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29518 and it wouldn't matter which way round you had these two items.)
29519
29520 The reason for the problem with host names lies in the left-to-right way that
29521 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29522 but when it reaches an item that requires a host name, it fails if it cannot
29523 find a host name to compare with the pattern. If the above list is given in the
29524 opposite order, the &%accept%& statement fails for a host whose name cannot be
29525 found, even if its IP address is 10.9.8.7.
29526
29527 If you really do want to do the name check first, and still recognize the IP
29528 address even if the name lookup fails, you can rewrite the ACL like this:
29529 .code
29530 accept hosts = dbm;/etc/friendly/hosts
29531 accept hosts = 10.9.8.7
29532 .endd
29533 The default action on failing to find the host name is to assume that the host
29534 is not in the list, so the first &%accept%& statement fails. The second
29535 statement can then check the IP address.
29536
29537 .vindex "&$host_data$&"
29538 If a &%hosts%& condition is satisfied by means of a lookup, the result
29539 of the lookup is made available in the &$host_data$& variable. This
29540 allows you, for example, to set up a statement like this:
29541 .code
29542 deny  hosts = net-lsearch;/some/file
29543 message = $host_data
29544 .endd
29545 which gives a custom error message for each denied host.
29546
29547 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29548 .cindex "&%local_parts%& ACL condition"
29549 .cindex "local part" "ACL checking"
29550 .cindex "&ACL;" "testing a local part"
29551 .vindex "&$local_part_data$&"
29552 This condition is relevant only after a RCPT command. It checks that the local
29553 part of the recipient address is in the list. If percent-hack processing is
29554 enabled, it is done before this test. If the check succeeds with a lookup, the
29555 result of the lookup is placed in &$local_part_data$&, which remains set until
29556 the next &%local_parts%& test.
29557
29558 .vitem &*malware&~=&~*&<&'option'&>
29559 .cindex "&%malware%& ACL condition"
29560 .cindex "&ACL;" "virus scanning"
29561 .cindex "&ACL;" "scanning for viruses"
29562 This condition is available only when Exim is compiled with the
29563 content-scanning extension. It causes the incoming message to be scanned for
29564 viruses. For details, see chapter &<<CHAPexiscan>>&.
29565
29566 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29567 .cindex "&%mime_regex%& ACL condition"
29568 .cindex "&ACL;" "testing by regex matching"
29569 This condition is available only when Exim is compiled with the
29570 content-scanning extension, and it is allowed only in the ACL defined by
29571 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29572 with any of the regular expressions. For details, see chapter
29573 &<<CHAPexiscan>>&.
29574
29575 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29576 .cindex "rate limiting"
29577 This condition can be used to limit the rate at which a user or host submits
29578 messages. Details are given in section &<<SECTratelimiting>>&.
29579
29580 .vitem &*recipients&~=&~*&<&'address&~list'&>
29581 .cindex "&%recipients%& ACL condition"
29582 .cindex "recipient" "ACL checking"
29583 .cindex "&ACL;" "testing a recipient"
29584 This condition is relevant only after a RCPT command. It checks the entire
29585 recipient address against a list of recipients.
29586
29587 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29588 .cindex "&%regex%& ACL condition"
29589 .cindex "&ACL;" "testing by regex matching"
29590 This condition is available only when Exim is compiled with the
29591 content-scanning extension, and is available only in the DATA, MIME, and
29592 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29593 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29594
29595 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29596 .cindex "&%sender_domains%& ACL condition"
29597 .cindex "sender" "ACL checking"
29598 .cindex "&ACL;" "testing a sender domain"
29599 .vindex "&$domain$&"
29600 .vindex "&$sender_address_domain$&"
29601 This condition tests the domain of the sender of the message against the given
29602 domain list. &*Note*&: The domain of the sender address is in
29603 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29604 of this condition. This is an exception to the general rule for testing domain
29605 lists. It is done this way so that, if this condition is used in an ACL for a
29606 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29607 influence the sender checking.
29608
29609 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29610 relaying, because sender addresses are easily, and commonly, forged.
29611
29612 .vitem &*senders&~=&~*&<&'address&~list'&>
29613 .cindex "&%senders%& ACL condition"
29614 .cindex "sender" "ACL checking"
29615 .cindex "&ACL;" "testing a sender"
29616 This condition tests the sender of the message against the given list. To test
29617 for a bounce message, which has an empty sender, set
29618 .code
29619 senders = :
29620 .endd
29621 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29622 relaying, because sender addresses are easily, and commonly, forged.
29623
29624 .vitem &*spam&~=&~*&<&'username'&>
29625 .cindex "&%spam%& ACL condition"
29626 .cindex "&ACL;" "scanning for spam"
29627 This condition is available only when Exim is compiled with the
29628 content-scanning extension. It causes the incoming message to be scanned by
29629 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29630
29631 .vitem &*verify&~=&~certificate*&
29632 .cindex "&%verify%& ACL condition"
29633 .cindex "TLS" "client certificate verification"
29634 .cindex "certificate" "verification of client"
29635 .cindex "&ACL;" "certificate verification"
29636 .cindex "&ACL;" "testing a TLS certificate"
29637 This condition is true in an SMTP session if the session is encrypted, and a
29638 certificate was received from the client, and the certificate was verified. The
29639 server requests a certificate only if the client matches &%tls_verify_hosts%&
29640 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29641
29642 .vitem &*verify&~=&~csa*&
29643 .cindex "CSA verification"
29644 This condition checks whether the sending host (the client) is authorized to
29645 send email. Details of how this works are given in section
29646 &<<SECTverifyCSA>>&.
29647
29648 .vitem &*verify&~=&~header_names_ascii*&
29649 .cindex "&%verify%& ACL condition"
29650 .cindex "&ACL;" "verifying header names only ASCII"
29651 .cindex "header lines" "verifying header names only ASCII"
29652 .cindex "verifying" "header names only ASCII"
29653 This condition is relevant only in an ACL that is run after a message has been
29654 received, that is, in an ACL specified by &%acl_smtp_data%& or
29655 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29656 there are no non-ASCII characters, also excluding control characters.  The
29657 allowable characters are decimal ASCII values 33 through 126.
29658
29659 Exim itself will handle headers with non-ASCII characters, but it can cause
29660 problems for downstream applications, so this option will allow their
29661 detection and rejection in the DATA ACL's.
29662
29663 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29664 .cindex "&%verify%& ACL condition"
29665 .cindex "&ACL;" "verifying sender in the header"
29666 .cindex "header lines" "verifying the sender in"
29667 .cindex "sender" "verifying in header"
29668 .cindex "verifying" "sender in header"
29669 This condition is relevant only in an ACL that is run after a message has been
29670 received, that is, in an ACL specified by &%acl_smtp_data%& or
29671 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29672 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29673 is loosely thought of as a &"sender"& address (hence the name of the test).
29674 However, an address that appears in one of these headers need not be an address
29675 that accepts bounce messages; only sender addresses in envelopes are required
29676 to accept bounces. Therefore, if you use the callout option on this check, you
29677 might want to arrange for a non-empty address in the MAIL command.
29678
29679 Details of address verification and the options are given later, starting at
29680 section &<<SECTaddressverification>>& (callouts are described in section
29681 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29682 condition to restrict it to bounce messages only:
29683 .code
29684 deny    senders = :
29685         message = A valid sender header is required for bounces
29686        !verify  = header_sender
29687 .endd
29688
29689 .vitem &*verify&~=&~header_syntax*&
29690 .cindex "&%verify%& ACL condition"
29691 .cindex "&ACL;" "verifying header syntax"
29692 .cindex "header lines" "verifying syntax"
29693 .cindex "verifying" "header syntax"
29694 This condition is relevant only in an ACL that is run after a message has been
29695 received, that is, in an ACL specified by &%acl_smtp_data%& or
29696 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29697 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29698 and &'Bcc:'&), returning true if there are no problems.
29699 Unqualified addresses (local parts without domains) are
29700 permitted only in locally generated messages and from hosts that match
29701 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29702 appropriate.
29703
29704 Note that this condition is a syntax check only. However, a common spamming
29705 ploy used to be to send syntactically invalid headers such as
29706 .code
29707 To: @
29708 .endd
29709 and this condition can be used to reject such messages, though they are not as
29710 common as they used to be.
29711
29712 .vitem &*verify&~=&~helo*&
29713 .cindex "&%verify%& ACL condition"
29714 .cindex "&ACL;" "verifying HELO/EHLO"
29715 .cindex "HELO" "verifying"
29716 .cindex "EHLO" "verifying"
29717 .cindex "verifying" "EHLO"
29718 .cindex "verifying" "HELO"
29719 This condition is true if a HELO or EHLO command has been received from the
29720 client host, and its contents have been verified. If there has been no previous
29721 attempt to verify the HELO/EHLO contents, it is carried out when this
29722 condition is encountered. See the description of the &%helo_verify_hosts%& and
29723 &%helo_try_verify_hosts%& options for details of how to request verification
29724 independently of this condition.
29725
29726 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29727 option), this condition is always true.
29728
29729
29730 .vitem &*verify&~=&~not_blind*&
29731 .cindex "verifying" "not blind"
29732 .cindex "bcc recipients, verifying none"
29733 This condition checks that there are no blind (bcc) recipients in the message.
29734 Every envelope recipient must appear either in a &'To:'& header line or in a
29735 &'Cc:'& header line for this condition to be true. Local parts are checked
29736 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29737 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29738 used only in a DATA or non-SMTP ACL.
29739
29740 There are, of course, many legitimate messages that make use of blind (bcc)
29741 recipients. This check should not be used on its own for blocking messages.
29742
29743
29744 .vitem &*verify&~=&~recipient/*&<&'options'&>
29745 .cindex "&%verify%& ACL condition"
29746 .cindex "&ACL;" "verifying recipient"
29747 .cindex "recipient" "verifying"
29748 .cindex "verifying" "recipient"
29749 .vindex "&$address_data$&"
29750 This condition is relevant only after a RCPT command. It verifies the current
29751 recipient. Details of address verification are given later, starting at section
29752 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29753 of &$address_data$& is the last value that was set while routing the address.
29754 This applies even if the verification fails. When an address that is being
29755 verified is redirected to a single address, verification continues with the new
29756 address, and in that case, the subsequent value of &$address_data$& is the
29757 value for the child address.
29758
29759 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29760 .cindex "&%verify%& ACL condition"
29761 .cindex "&ACL;" "verifying host reverse lookup"
29762 .cindex "host" "verifying reverse lookup"
29763 This condition ensures that a verified host name has been looked up from the IP
29764 address of the client host. (This may have happened already if the host name
29765 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29766 Verification ensures that the host name obtained from a reverse DNS lookup, or
29767 one of its aliases, does, when it is itself looked up in the DNS, yield the
29768 original IP address.
29769
29770 There is one possible option, &`defer_ok`&.  If this is present and a
29771 DNS operation returns a temporary error, the verify condition succeeds.
29772
29773 If this condition is used for a locally generated message (that is, when there
29774 is no client host involved), it always succeeds.
29775
29776 .vitem &*verify&~=&~sender/*&<&'options'&>
29777 .cindex "&%verify%& ACL condition"
29778 .cindex "&ACL;" "verifying sender"
29779 .cindex "sender" "verifying"
29780 .cindex "verifying" "sender"
29781 This condition is relevant only after a MAIL or RCPT command, or after a
29782 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29783 the message's sender is empty (that is, this is a bounce message), the
29784 condition is true. Otherwise, the sender address is verified.
29785
29786 .vindex "&$address_data$&"
29787 .vindex "&$sender_address_data$&"
29788 If there is data in the &$address_data$& variable at the end of routing, its
29789 value is placed in &$sender_address_data$& at the end of verification. This
29790 value can be used in subsequent conditions and modifiers in the same ACL
29791 statement. It does not persist after the end of the current statement. If you
29792 want to preserve the value for longer, you can save it in an ACL variable.
29793
29794 Details of verification are given later, starting at section
29795 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29796 to avoid doing it more than once per message.
29797
29798 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29799 .cindex "&%verify%& ACL condition"
29800 This is a variation of the previous option, in which a modified address is
29801 verified as a sender.
29802
29803 .new
29804 Note that '/' is legal in local-parts; if the address may have such
29805 (eg. is generated from the received message)
29806 they must be protected from the options parsing by doubling:
29807 .code
29808 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
29809 .endd
29810 .wen
29811 .endlist
29812
29813
29814
29815 .section "Using DNS lists" "SECTmorednslists"
29816 .cindex "DNS list" "in ACL"
29817 .cindex "black list (DNS)"
29818 .cindex "&ACL;" "testing a DNS list"
29819 In its simplest form, the &%dnslists%& condition tests whether the calling host
29820 is on at least one of a number of DNS lists by looking up the inverted IP
29821 address in one or more DNS domains. (Note that DNS list domains are not mail
29822 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29823 special options instead.) For example, if the calling host's IP
29824 address is 192.168.62.43, and the ACL statement is
29825 .code
29826 deny dnslists = blackholes.mail-abuse.org : \
29827                 dialups.mail-abuse.org
29828 .endd
29829 the following records are looked up:
29830 .code
29831 43.62.168.192.blackholes.mail-abuse.org
29832 43.62.168.192.dialups.mail-abuse.org
29833 .endd
29834 As soon as Exim finds an existing DNS record, processing of the list stops.
29835 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29836 to test that a host is on more than one list (an &"and"& conjunction), you can
29837 use two separate conditions:
29838 .code
29839 deny dnslists = blackholes.mail-abuse.org
29840      dnslists = dialups.mail-abuse.org
29841 .endd
29842 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29843 behaves as if the host does not match the list item, that is, as if the DNS
29844 record does not exist. If there are further items in the DNS list, they are
29845 processed.
29846
29847 This is usually the required action when &%dnslists%& is used with &%deny%&
29848 (which is the most common usage), because it prevents a DNS failure from
29849 blocking mail. However, you can change this behaviour by putting one of the
29850 following special items in the list:
29851 .display
29852 &`+include_unknown `&   behave as if the item is on the list
29853 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29854 &`+defer_unknown   `&   give a temporary error
29855 .endd
29856 .cindex "&`+include_unknown`&"
29857 .cindex "&`+exclude_unknown`&"
29858 .cindex "&`+defer_unknown`&"
29859 Each of these applies to any subsequent items on the list. For example:
29860 .code
29861 deny dnslists = +defer_unknown : foo.bar.example
29862 .endd
29863 Testing the list of domains stops as soon as a match is found. If you want to
29864 warn for one list and block for another, you can use two different statements:
29865 .code
29866 deny  dnslists = blackholes.mail-abuse.org
29867 warn  message  = X-Warn: sending host is on dialups list
29868       dnslists = dialups.mail-abuse.org
29869 .endd
29870 .cindex caching "of dns lookup"
29871 .cindex DNS TTL
29872 DNS list lookups are cached by Exim for the duration of the SMTP session
29873 (but limited by the DNS return TTL value),
29874 so a lookup based on the IP address is done at most once for any incoming
29875 connection (assuming long-enough TTL).
29876 Exim does not share information between multiple incoming
29877 connections (but your local name server cache should be active).
29878
29879
29880
29881 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29882 .cindex "DNS list" "keyed by explicit IP address"
29883 By default, the IP address that is used in a DNS list lookup is the IP address
29884 of the calling host. However, you can specify another IP address by listing it
29885 after the domain name, introduced by a slash. For example:
29886 .code
29887 deny dnslists = black.list.tld/192.168.1.2
29888 .endd
29889 This feature is not very helpful with explicit IP addresses; it is intended for
29890 use with IP addresses that are looked up, for example, the IP addresses of the
29891 MX hosts or nameservers of an email sender address. For an example, see section
29892 &<<SECTmulkeyfor>>& below.
29893
29894
29895
29896
29897 .section "DNS lists keyed on domain names" "SECID202"
29898 .cindex "DNS list" "keyed by domain name"
29899 There are some lists that are keyed on domain names rather than inverted IP
29900 addresses (see for example the &'domain based zones'& link at
29901 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29902 with these lists. You can change the name that is looked up in a DNS list by
29903 listing it after the domain name, introduced by a slash. For example,
29904 .code
29905 deny  message  = Sender's domain is listed at $dnslist_domain
29906       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29907 .endd
29908 This particular example is useful only in ACLs that are obeyed after the
29909 RCPT or DATA commands, when a sender address is available. If (for
29910 example) the message's sender is &'user@tld.example'& the name that is looked
29911 up by this example is
29912 .code
29913 tld.example.dsn.rfc-ignorant.org
29914 .endd
29915 A single &%dnslists%& condition can contain entries for both names and IP
29916 addresses. For example:
29917 .code
29918 deny dnslists = sbl.spamhaus.org : \
29919                 dsn.rfc-ignorant.org/$sender_address_domain
29920 .endd
29921 The first item checks the sending host's IP address; the second checks a domain
29922 name. The whole condition is true if either of the DNS lookups succeeds.
29923
29924
29925
29926
29927 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29928 .cindex "DNS list" "multiple keys for"
29929 The syntax described above for looking up explicitly-defined values (either
29930 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29931 name for the DNS list, what follows the slash can in fact be a list of items.
29932 As with all lists in Exim, the default separator is a colon. However, because
29933 this is a sublist within the list of DNS blacklist domains, it is necessary
29934 either to double the separators like this:
29935 .code
29936 dnslists = black.list.tld/name.1::name.2
29937 .endd
29938 or to change the separator character, like this:
29939 .code
29940 dnslists = black.list.tld/<;name.1;name.2
29941 .endd
29942 If an item in the list is an IP address, it is inverted before the DNS
29943 blacklist domain is appended. If it is not an IP address, no inversion
29944 occurs. Consider this condition:
29945 .code
29946 dnslists = black.list.tld/<;192.168.1.2;a.domain
29947 .endd
29948 The DNS lookups that occur are:
29949 .code
29950 2.1.168.192.black.list.tld
29951 a.domain.black.list.tld
29952 .endd
29953 Once a DNS record has been found (that matches a specific IP return
29954 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29955 are done. If there is a temporary DNS error, the rest of the sublist of domains
29956 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29957 only if no other DNS lookup in this sublist succeeds. In other words, a
29958 successful lookup for any of the items in the sublist overrides a temporary
29959 error for a previous item.
29960
29961 The ability to supply a list of items after the slash is in some sense just a
29962 syntactic convenience. These two examples have the same effect:
29963 .code
29964 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29965 dnslists = black.list.tld/a.domain::b.domain
29966 .endd
29967 However, when the data for the list is obtained from a lookup, the second form
29968 is usually much more convenient. Consider this example:
29969 .code
29970 deny message  = The mail servers for the domain \
29971                 $sender_address_domain \
29972                 are listed at $dnslist_domain ($dnslist_value); \
29973                 see $dnslist_text.
29974      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29975                                    ${lookup dnsdb {>|mxh=\
29976                                    $sender_address_domain} }} }
29977 .endd
29978 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29979 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29980 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29981 of expanding the condition might be something like this:
29982 .code
29983 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
29984 .endd
29985 Thus, this example checks whether or not the IP addresses of the sender
29986 domain's mail servers are on the Spamhaus black list.
29987
29988 The key that was used for a successful DNS list lookup is put into the variable
29989 &$dnslist_matched$& (see section &<<SECID204>>&).
29990
29991
29992
29993
29994 .section "Data returned by DNS lists" "SECID203"
29995 .cindex "DNS list" "data returned from"
29996 DNS lists are constructed using address records in the DNS. The original RBL
29997 just used the address 127.0.0.1 on the right hand side of each record, but the
29998 RBL+ list and some other lists use a number of values with different meanings.
29999 The values used on the RBL+ list are:
30000 .display
30001 127.1.0.1  RBL
30002 127.1.0.2  DUL
30003 127.1.0.3  DUL and RBL
30004 127.1.0.4  RSS
30005 127.1.0.5  RSS and RBL
30006 127.1.0.6  RSS and DUL
30007 127.1.0.7  RSS and DUL and RBL
30008 .endd
30009 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30010 different values. Some DNS lists may return more than one address record;
30011 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30012
30013
30014 .section "Variables set from DNS lists" "SECID204"
30015 .cindex "expansion" "variables, set from DNS list"
30016 .cindex "DNS list" "variables set from"
30017 .vindex "&$dnslist_domain$&"
30018 .vindex "&$dnslist_matched$&"
30019 .vindex "&$dnslist_text$&"
30020 .vindex "&$dnslist_value$&"
30021 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30022 the name of the overall domain that matched (for example,
30023 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30024 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30025 the DNS record. When the key is an IP address, it is not reversed in
30026 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30027 cases, for example:
30028 .code
30029 deny dnslists = spamhaus.example
30030 .endd
30031 the key is also available in another variable (in this case,
30032 &$sender_host_address$&). In more complicated cases, however, this is not true.
30033 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30034 might generate a dnslists lookup like this:
30035 .code
30036 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30037 .endd
30038 If this condition succeeds, the value in &$dnslist_matched$& might be
30039 &`192.168.6.7`& (for example).
30040
30041 If more than one address record is returned by the DNS lookup, all the IP
30042 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30043 The variable &$dnslist_text$& contains the contents of any associated TXT
30044 record. For lists such as RBL+ the TXT record for a merged entry is often not
30045 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30046 information.
30047
30048 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30049 &-- although these appear before the condition in the ACL, they are not
30050 expanded until after it has failed. For example:
30051 .code
30052 deny    hosts = !+local_networks
30053         message = $sender_host_address is listed \
30054                   at $dnslist_domain
30055         dnslists = rbl-plus.mail-abuse.example
30056 .endd
30057
30058
30059
30060 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30061 .cindex "DNS list" "matching specific returned data"
30062 You can add an equals sign and an IP address after a &%dnslists%& domain name
30063 in order to restrict its action to DNS records with a matching right hand side.
30064 For example,
30065 .code
30066 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30067 .endd
30068 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30069 any address record is considered to be a match. For the moment, we assume
30070 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30071 describes how multiple records are handled.
30072
30073 More than one IP address may be given for checking, using a comma as a
30074 separator. These are alternatives &-- if any one of them matches, the
30075 &%dnslists%& condition is true. For example:
30076 .code
30077 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30078 .endd
30079 If you want to specify a constraining address list and also specify names or IP
30080 addresses to be looked up, the constraining address list must be specified
30081 first. For example:
30082 .code
30083 deny dnslists = dsn.rfc-ignorant.org\
30084                 =127.0.0.2/$sender_address_domain
30085 .endd
30086
30087 If the character &`&&`& is used instead of &`=`&, the comparison for each
30088 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30089 In other words, the listed addresses are used as bit masks. The comparison is
30090 true if all the bits in the mask are present in the address that is being
30091 tested. For example:
30092 .code
30093 dnslists = a.b.c&0.0.0.3
30094 .endd
30095 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30096 want to test whether one bit or another bit is present (as opposed to both
30097 being present), you must use multiple values. For example:
30098 .code
30099 dnslists = a.b.c&0.0.0.1,0.0.0.2
30100 .endd
30101 matches if the final component of the address is an odd number or two times
30102 an odd number.
30103
30104
30105
30106 .section "Negated DNS matching conditions" "SECID205"
30107 You can supply a negative list of IP addresses as part of a &%dnslists%&
30108 condition. Whereas
30109 .code
30110 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30111 .endd
30112 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30113 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30114 .code
30115 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30116 .endd
30117 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30118 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30119 words, the result of the test is inverted if an exclamation mark appears before
30120 the &`=`& (or the &`&&`&) sign.
30121
30122 &*Note*&: This kind of negation is not the same as negation in a domain,
30123 host, or address list (which is why the syntax is different).
30124
30125 If you are using just one list, the negation syntax does not gain you much. The
30126 previous example is precisely equivalent to
30127 .code
30128 deny  dnslists = a.b.c
30129      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30130 .endd
30131 However, if you are using multiple lists, the negation syntax is clearer.
30132 Consider this example:
30133 .code
30134 deny  dnslists = sbl.spamhaus.org : \
30135                  list.dsbl.org : \
30136                  dnsbl.njabl.org!=127.0.0.3 : \
30137                  relays.ordb.org
30138 .endd
30139 Using only positive lists, this would have to be:
30140 .code
30141 deny  dnslists = sbl.spamhaus.org : \
30142                  list.dsbl.org
30143 deny  dnslists = dnsbl.njabl.org
30144      !dnslists = dnsbl.njabl.org=127.0.0.3
30145 deny  dnslists = relays.ordb.org
30146 .endd
30147 which is less clear, and harder to maintain.
30148
30149
30150
30151
30152 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30153 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30154 thereby providing more than one IP address. When an item in a &%dnslists%& list
30155 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30156 the match to specific results from the DNS lookup, there are two ways in which
30157 the checking can be handled. For example, consider the condition:
30158 .code
30159 dnslists = a.b.c=127.0.0.1
30160 .endd
30161 What happens if the DNS lookup for the incoming IP address yields both
30162 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30163 condition true because at least one given value was found, or is it false
30164 because at least one of the found values was not listed? And how does this
30165 affect negated conditions? Both possibilities are provided for with the help of
30166 additional separators &`==`& and &`=&&`&.
30167
30168 .ilist
30169 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30170 IP addresses matches one of the listed addresses. For the example above, the
30171 condition is true because 127.0.0.1 matches.
30172 .next
30173 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30174 looked up IP addresses matches one of the listed addresses. If the condition is
30175 changed to:
30176 .code
30177 dnslists = a.b.c==127.0.0.1
30178 .endd
30179 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30180 false because 127.0.0.2 is not listed. You would need to have:
30181 .code
30182 dnslists = a.b.c==127.0.0.1,127.0.0.2
30183 .endd
30184 for the condition to be true.
30185 .endlist
30186
30187 When &`!`& is used to negate IP address matching, it inverts the result, giving
30188 the precise opposite of the behaviour above. Thus:
30189 .ilist
30190 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30191 addresses matches one of the listed addresses. Consider:
30192 .code
30193 dnslists = a.b.c!&0.0.0.1
30194 .endd
30195 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30196 false because 127.0.0.1 matches.
30197 .next
30198 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30199 looked up IP address that does not match. Consider:
30200 .code
30201 dnslists = a.b.c!=&0.0.0.1
30202 .endd
30203 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30204 true, because 127.0.0.2 does not match. You would need to have:
30205 .code
30206 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30207 .endd
30208 for the condition to be false.
30209 .endlist
30210 When the DNS lookup yields only a single IP address, there is no difference
30211 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30212
30213
30214
30215
30216 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30217 .cindex "DNS list" "information from merged"
30218 When the facility for restricting the matching IP values in a DNS list is used,
30219 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30220 the true reason for rejection. This happens when lists are merged and the IP
30221 address in the A record is used to distinguish them; unfortunately there is
30222 only one TXT record. One way round this is not to use merged lists, but that
30223 can be inefficient because it requires multiple DNS lookups where one would do
30224 in the vast majority of cases when the host of interest is not on any of the
30225 lists.
30226
30227 A less inefficient way of solving this problem is available. If
30228 two domain names, comma-separated, are given, the second is used first to
30229 do an initial check, making use of any IP value restrictions that are set.
30230 If there is a match, the first domain is used, without any IP value
30231 restrictions, to get the TXT record. As a byproduct of this, there is also
30232 a check that the IP being tested is indeed on the first list. The first
30233 domain is the one that is put in &$dnslist_domain$&. For example:
30234 .code
30235 reject message  = \
30236          rejected because $sender_host_address is blacklisted \
30237          at $dnslist_domain\n$dnslist_text
30238        dnslists = \
30239          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30240          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30241 .endd
30242 For the first blacklist item, this starts by doing a lookup in
30243 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30244 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30245 value, and as long as something is found, it looks for the corresponding TXT
30246 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30247 The second blacklist item is processed similarly.
30248
30249 If you are interested in more than one merged list, the same list must be
30250 given several times, but because the results of the DNS lookups are cached,
30251 the DNS calls themselves are not repeated. For example:
30252 .code
30253 reject dnslists = \
30254          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30255          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30256          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30257          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30258 .endd
30259 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30260 values matches (or if no record is found), this is the only lookup that is
30261 done. Only if there is a match is one of the more specific lists consulted.
30262
30263
30264
30265 .section "DNS lists and IPv6" "SECTmorednslistslast"
30266 .cindex "IPv6" "DNS black lists"
30267 .cindex "DNS list" "IPv6 usage"
30268 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30269 nibble by nibble. For example, if the calling host's IP address is
30270 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30271 .code
30272 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30273   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30274 .endd
30275 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30276 lists contain wildcard records, intended for IPv4, that interact badly with
30277 IPv6. For example, the DNS entry
30278 .code
30279 *.3.some.list.example.    A    127.0.0.1
30280 .endd
30281 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30282 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30283
30284 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30285 &%condition%& condition, as in this example:
30286 .code
30287 deny   condition = ${if isip4{$sender_host_address}}
30288        dnslists  = some.list.example
30289 .endd
30290
30291 If an explicit key is being used for a DNS lookup and it may be an IPv6
30292 address you should specify alternate list separators for both the outer
30293 (DNS list name) list and inner (lookup keys) list:
30294 .code
30295        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30296 .endd
30297
30298 .section "Rate limiting incoming messages" "SECTratelimiting"
30299 .cindex "rate limiting" "client sending"
30300 .cindex "limiting client sending rates"
30301 .oindex "&%smtp_ratelimit_*%&"
30302 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30303 which clients can send email. This is more powerful than the
30304 &%smtp_ratelimit_*%& options, because those options control the rate of
30305 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30306 works across all connections (concurrent and sequential) from the same client
30307 host. The syntax of the &%ratelimit%& condition is:
30308 .display
30309 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30310 .endd
30311 If the average client sending rate is less than &'m'& messages per time
30312 period &'p'& then the condition is false; otherwise it is true.
30313
30314 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30315 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30316 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30317 of &'p'&.
30318
30319 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30320 time interval, for example, &`8h`& for eight hours. A larger time constant
30321 means that it takes Exim longer to forget a client's past behaviour. The
30322 parameter &'m'& is the maximum number of messages that a client is permitted to
30323 send in each time interval. It also specifies the number of messages permitted
30324 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30325 constant, you can allow a client to send more messages in a burst without
30326 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30327 both small, messages must be sent at an even rate.
30328
30329 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30330 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30331 when deploying the &%ratelimit%& ACL condition. The script prints usage
30332 instructions when it is run with no arguments.
30333
30334 The key is used to look up the data for calculating the client's average
30335 sending rate. This data is stored in Exim's spool directory, alongside the
30336 retry and other hints databases. The default key is &$sender_host_address$&,
30337 which means Exim computes the sending rate of each client host IP address.
30338 By changing the key you can change how Exim identifies clients for the purpose
30339 of ratelimiting. For example, to limit the sending rate of each authenticated
30340 user, independent of the computer they are sending from, set the key to
30341 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30342 example, &$authenticated_id$& is only meaningful if the client has
30343 authenticated (which you can check with the &%authenticated%& ACL condition).
30344
30345 The lookup key does not have to identify clients: If you want to limit the
30346 rate at which a recipient receives messages, you can use the key
30347 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30348 ACL.
30349
30350 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30351 specifies what Exim measures the rate of, for example messages or recipients
30352 or bytes. You can adjust the measurement using the &%unique=%& and/or
30353 &%count=%& options. You can also control when Exim updates the recorded rate
30354 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30355 separated by a slash, like the other parameters. They may appear in any order.
30356
30357 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30358 any options that alter the meaning of the stored data. The limit &'m'& is not
30359 stored, so you can alter the configured maximum rate and Exim will still
30360 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30361 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30362 behaviour. The lookup key is not affected by changes to the update mode and
30363 the &%count=%& option.
30364
30365
30366 .section "Ratelimit options for what is being measured" "ratoptmea"
30367 .cindex "rate limiting" "per_* options"
30368 The &%per_conn%& option limits the client's connection rate. It is not
30369 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30370 &%acl_not_smtp_start%& ACLs.
30371
30372 The &%per_mail%& option limits the client's rate of sending messages. This is
30373 the default if none of the &%per_*%& options is specified. It can be used in
30374 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30375 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30376
30377 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30378 the same ACLs as the &%per_mail%& option, though it is best to use this option
30379 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30380 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30381 in its MAIL command, which may be inaccurate or completely missing. You can
30382 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30383 in kilobytes, megabytes, or gigabytes, respectively.
30384
30385 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30386 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30387 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30388 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30389 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30390 in either case the rate limiting engine will see a message with many
30391 recipients as a large high-speed burst.
30392
30393 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30394 number of different recipients that the client has sent messages to in the
30395 last time period. That is, if the client repeatedly sends messages to the same
30396 recipient, its measured rate is not increased. This option can only be used in
30397 &%acl_smtp_rcpt%&.
30398
30399 The &%per_cmd%& option causes Exim to recompute the rate every time the
30400 condition is processed. This can be used to limit the rate of any SMTP
30401 command. If it is used in multiple ACLs it can limit the aggregate rate of
30402 multiple different commands.
30403
30404 The &%count=%& option can be used to alter how much Exim adds to the client's
30405 measured rate. For example, the &%per_byte%& option is equivalent to
30406 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30407 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30408 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30409
30410 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30411
30412
30413 .section "Ratelimit update modes" "ratoptupd"
30414 .cindex "rate limiting" "reading data without updating"
30415 You can specify one of three options with the &%ratelimit%& condition to
30416 control when its database is updated. This section describes the &%readonly%&
30417 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30418
30419 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30420 previously-computed rate to check against the limit.
30421
30422 For example, you can test the client's sending rate and deny it access (when
30423 it is too fast) in the connect ACL. If the client passes this check then it
30424 can go on to send a message, in which case its recorded rate will be updated
30425 in the MAIL ACL. Subsequent connections from the same client will check this
30426 new rate.
30427 .code
30428 acl_check_connect:
30429  deny ratelimit = 100 / 5m / readonly
30430     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30431                   (max $sender_rate_limit)
30432 # ...
30433 acl_check_mail:
30434  warn ratelimit = 100 / 5m / strict
30435     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30436                   (max $sender_rate_limit)
30437 .endd
30438
30439 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30440 processing a message then it may increase the client's measured rate more than
30441 it should. For example, this will happen if you check the &%per_rcpt%& option
30442 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30443 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30444 multiple update problems by using the &%readonly%& option on later ratelimit
30445 checks.
30446
30447 The &%per_*%& options described above do not make sense in some ACLs. If you
30448 use a &%per_*%& option in an ACL where it is not normally permitted then the
30449 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30450 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30451 next section) so you must specify the &%readonly%& option explicitly.
30452
30453
30454 .section "Ratelimit options for handling fast clients" "ratoptfast"
30455 .cindex "rate limiting" "strict and leaky modes"
30456 If a client's average rate is greater than the maximum, the rate limiting
30457 engine can react in two possible ways, depending on the presence of the
30458 &%strict%& or &%leaky%& update modes. This is independent of the other
30459 counter-measures (such as rejecting the message) that may be specified by the
30460 rest of the ACL.
30461
30462 The &%leaky%& (default) option means that the client's recorded rate is not
30463 updated if it is above the limit. The effect of this is that Exim measures the
30464 client's average rate of successfully sent email, which cannot be greater than
30465 the maximum allowed. If the client is over the limit it may suffer some
30466 counter-measures (as specified in the ACL), but it will still be able to send
30467 email at the configured maximum rate, whatever the rate of its attempts. This
30468 is generally the better choice if you have clients that retry automatically.
30469 For example, it does not prevent a sender with an over-aggressive retry rate
30470 from getting any email through.
30471
30472 The &%strict%& option means that the client's recorded rate is always
30473 updated. The effect of this is that Exim measures the client's average rate
30474 of attempts to send email, which can be much higher than the maximum it is
30475 actually allowed. If the client is over the limit it may be subjected to
30476 counter-measures by the ACL. It must slow down and allow sufficient time to
30477 pass that its computed rate falls below the maximum before it can send email
30478 again. The time (the number of smoothing periods) it must wait and not
30479 attempt to send mail can be calculated with this formula:
30480 .code
30481         ln(peakrate/maxrate)
30482 .endd
30483
30484
30485 .section "Limiting the rate of different events" "ratoptuniq"
30486 .cindex "rate limiting" "counting unique events"
30487 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30488 rate of different events. For example, the &%per_addr%& option uses this
30489 mechanism to count the number of different recipients that the client has
30490 sent messages to in the last time period; it is equivalent to
30491 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30492 measure the rate that a client uses different sender addresses with the
30493 options &`per_mail/unique=$sender_address`&.
30494
30495 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30496 has seen for that key. The whole set is thrown away when it is older than the
30497 rate smoothing period &'p'&, so each different event is counted at most once
30498 per period. In the &%leaky%& update mode, an event that causes the client to
30499 go over the limit is not added to the set, in the same way that the client's
30500 recorded rate is not updated in the same situation.
30501
30502 When you combine the &%unique=%& and &%readonly%& options, the specific
30503 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30504 rate.
30505
30506 The &%unique=%& mechanism needs more space in the ratelimit database than the
30507 other &%ratelimit%& options in order to store the event set. The number of
30508 unique values is potentially as large as the rate limit, so the extra space
30509 required increases with larger limits.
30510
30511 The uniqueification is not perfect: there is a small probability that Exim
30512 will think a new event has happened before. If the sender's rate is less than
30513 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30514 the measured rate can go above the limit, in which case Exim may under-count
30515 events by a significant margin. Fortunately, if the rate is high enough (2.7
30516 times the limit) that the false positive rate goes above 9%, then Exim will
30517 throw away the over-full event set before the measured rate falls below the
30518 limit. Therefore the only harm should be that exceptionally high sending rates
30519 are logged incorrectly; any countermeasures you configure will be as effective
30520 as intended.
30521
30522
30523 .section "Using rate limiting" "useratlim"
30524 Exim's other ACL facilities are used to define what counter-measures are taken
30525 when the rate limit is exceeded. This might be anything from logging a warning
30526 (for example, while measuring existing sending rates in order to define
30527 policy), through time delays to slow down fast senders, up to rejecting the
30528 message. For example:
30529 .code
30530 # Log all senders' rates
30531 warn ratelimit = 0 / 1h / strict
30532      log_message = Sender rate $sender_rate / $sender_rate_period
30533
30534 # Slow down fast senders; note the need to truncate $sender_rate
30535 # at the decimal point.
30536 warn ratelimit = 100 / 1h / per_rcpt / strict
30537      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30538                    $sender_rate_limit }s
30539
30540 # Keep authenticated users under control
30541 deny authenticated = *
30542      ratelimit = 100 / 1d / strict / $authenticated_id
30543
30544 # System-wide rate limit
30545 defer message = Sorry, too busy. Try again later.
30546      ratelimit = 10 / 1s / $primary_hostname
30547
30548 # Restrict incoming rate from each host, with a default
30549 # set using a macro and special cases looked up in a table.
30550 defer message = Sender rate exceeds $sender_rate_limit \
30551                messages per $sender_rate_period
30552      ratelimit = ${lookup {$sender_host_address} \
30553                    cdb {DB/ratelimits.cdb} \
30554                    {$value} {RATELIMIT} }
30555 .endd
30556 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30557 especially with the &%per_rcpt%& option, you may suffer from a performance
30558 bottleneck caused by locking on the ratelimit hints database. Apart from
30559 making your ACLs less complicated, you can reduce the problem by using a
30560 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30561 this means that Exim will lose its hints data after a reboot (including retry
30562 hints, the callout cache, and ratelimit data).
30563
30564
30565
30566 .section "Address verification" "SECTaddressverification"
30567 .cindex "verifying address" "options for"
30568 .cindex "policy control" "address verification"
30569 Several of the &%verify%& conditions described in section
30570 &<<SECTaclconditions>>& cause addresses to be verified. Section
30571 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30572 The verification conditions can be followed by options that modify the
30573 verification process. The options are separated from the keyword and from each
30574 other by slashes, and some of them contain parameters. For example:
30575 .code
30576 verify = sender/callout
30577 verify = recipient/defer_ok/callout=10s,defer_ok
30578 .endd
30579 The first stage of address verification, which always happens, is to run the
30580 address through the routers, in &"verify mode"&. Routers can detect the
30581 difference between verification and routing for delivery, and their actions can
30582 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30583 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30584 The available options are as follows:
30585
30586 .ilist
30587 If the &%callout%& option is specified, successful routing to one or more
30588 remote hosts is followed by a &"callout"& to those hosts as an additional
30589 check. Callouts and their sub-options are discussed in the next section.
30590 .next
30591 If there is a defer error while doing verification routing, the ACL
30592 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30593 options, the condition is forced to be true instead. Note that this is a main
30594 verification option as well as a suboption for callouts.
30595 .next
30596 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30597 discusses the reporting of sender address verification failures.
30598 .next
30599 The &%success_on_redirect%& option causes verification always to succeed
30600 immediately after a successful redirection. By default, if a redirection
30601 generates just one address, that address is also verified. See further
30602 discussion in section &<<SECTredirwhilveri>>&.
30603 .endlist
30604
30605 .cindex "verifying address" "differentiating failures"
30606 .vindex "&$recipient_verify_failure$&"
30607 .vindex "&$sender_verify_failure$&"
30608 .vindex "&$acl_verify_message$&"
30609 After an address verification failure, &$acl_verify_message$& contains the
30610 error message that is associated with the failure. It can be preserved by
30611 coding like this:
30612 .code
30613 warn  !verify = sender
30614        set acl_m0 = $acl_verify_message
30615 .endd
30616 If you are writing your own custom rejection message or log message when
30617 denying access, you can use this variable to include information about the
30618 verification failure.
30619
30620 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30621 appropriate) contains one of the following words:
30622
30623 .ilist
30624 &%qualify%&: The address was unqualified (no domain), and the message
30625 was neither local nor came from an exempted host.
30626 .next
30627 &%route%&: Routing failed.
30628 .next
30629 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30630 occurred at or before the MAIL command (that is, on initial
30631 connection, HELO, or MAIL).
30632 .next
30633 &%recipient%&: The RCPT command in a callout was rejected.
30634 .next
30635 &%postmaster%&: The postmaster check in a callout was rejected.
30636 .endlist
30637
30638 The main use of these variables is expected to be to distinguish between
30639 rejections of MAIL and rejections of RCPT in callouts.
30640
30641
30642
30643
30644 .section "Callout verification" "SECTcallver"
30645 .cindex "verifying address" "by callout"
30646 .cindex "callout" "verification"
30647 .cindex "SMTP" "callout verification"
30648 For non-local addresses, routing verifies the domain, but is unable to do any
30649 checking of the local part. There are situations where some means of verifying
30650 the local part is desirable. One way this can be done is to make an SMTP
30651 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30652 a subsequent host for a recipient address, to see if the host accepts the
30653 address. We use the term &'callout'& to cover both cases. Note that for a
30654 sender address, the callback is not to the client host that is trying to
30655 deliver the message, but to one of the hosts that accepts incoming mail for the
30656 sender's domain.
30657
30658 Exim does not do callouts by default. If you want them to happen, you must
30659 request them by setting appropriate options on the &%verify%& condition, as
30660 described below. This facility should be used with care, because it can add a
30661 lot of resource usage to the cost of verifying an address. However, Exim does
30662 cache the results of callouts, which helps to reduce the cost. Details of
30663 caching are in section &<<SECTcallvercache>>&.
30664
30665 Recipient callouts are usually used only between hosts that are controlled by
30666 the same administration. For example, a corporate gateway host could use
30667 callouts to check for valid recipients on an internal mailserver. A successful
30668 callout does not guarantee that a real delivery to the address would succeed;
30669 on the other hand, a failing callout does guarantee that a delivery would fail.
30670
30671 If the &%callout%& option is present on a condition that verifies an address, a
30672 second stage of verification occurs if the address is successfully routed to
30673 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30674 &(manualroute)& router, where the router specifies the hosts. However, if a
30675 router that does not set up hosts routes to an &(smtp)& transport with a
30676 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30677 &%hosts_override%& set, its hosts are always used, whether or not the router
30678 supplies a host list.
30679 Callouts are only supported on &(smtp)& transports.
30680
30681 The port that is used is taken from the transport, if it is specified and is a
30682 remote transport. (For routers that do verification only, no transport need be
30683 specified.) Otherwise, the default SMTP port is used. If a remote transport
30684 specifies an outgoing interface, this is used; otherwise the interface is not
30685 specified. Likewise, the text that is used for the HELO command is taken from
30686 the transport's &%helo_data%& option; if there is no transport, the value of
30687 &$smtp_active_hostname$& is used.
30688
30689 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30690 test whether a bounce message could be delivered to the sender address. The
30691 following SMTP commands are sent:
30692 .display
30693 &`HELO `&<&'local host name'&>
30694 &`MAIL FROM:<>`&
30695 &`RCPT TO:`&<&'the address to be tested'&>
30696 &`QUIT`&
30697 .endd
30698 LHLO is used instead of HELO if the transport's &%protocol%& option is
30699 set to &"lmtp"&.
30700
30701 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30702 settings.
30703
30704 A recipient callout check is similar. By default, it also uses an empty address
30705 for the sender. This default is chosen because most hosts do not make use of
30706 the sender address when verifying a recipient. Using the same address means
30707 that a single cache entry can be used for each recipient. Some sites, however,
30708 do make use of the sender address when verifying. These are catered for by the
30709 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30710
30711 If the response to the RCPT command is a 2&'xx'& code, the verification
30712 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30713 Exim tries the next host, if any. If there is a problem with all the remote
30714 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30715 &%callout%& option is given, in which case the condition is forced to succeed.
30716
30717 .cindex "SMTP" "output flushing, disabling for callout"
30718 A callout may take a little time. For this reason, Exim normally flushes SMTP
30719 output before performing a callout in an ACL, to avoid unexpected timeouts in
30720 clients when the SMTP PIPELINING extension is in use. The flushing can be
30721 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30722
30723
30724
30725
30726 .section "Additional parameters for callouts" "CALLaddparcall"
30727 .cindex "callout" "additional parameters for"
30728 The &%callout%& option can be followed by an equals sign and a number of
30729 optional parameters, separated by commas. For example:
30730 .code
30731 verify = recipient/callout=10s,defer_ok
30732 .endd
30733 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30734 separate verify options, is retained for backwards compatibility, but is now
30735 deprecated. The additional parameters for &%callout%& are as follows:
30736
30737
30738 .vlist
30739 .vitem <&'a&~time&~interval'&>
30740 .cindex "callout" "timeout, specifying"
30741 This specifies the timeout that applies for the callout attempt to each host.
30742 For example:
30743 .code
30744 verify = sender/callout=5s
30745 .endd
30746 The default is 30 seconds. The timeout is used for each response from the
30747 remote host. It is also used for the initial connection, unless overridden by
30748 the &%connect%& parameter.
30749
30750
30751 .vitem &*connect&~=&~*&<&'time&~interval'&>
30752 .cindex "callout" "connection timeout, specifying"
30753 This parameter makes it possible to set a different (usually smaller) timeout
30754 for making the SMTP connection. For example:
30755 .code
30756 verify = sender/callout=5s,connect=1s
30757 .endd
30758 If not specified, this timeout defaults to the general timeout value.
30759
30760 .vitem &*defer_ok*&
30761 .cindex "callout" "defer, action on"
30762 When this parameter is present, failure to contact any host, or any other kind
30763 of temporary error, is treated as success by the ACL. However, the cache is not
30764 updated in this circumstance.
30765
30766 .vitem &*fullpostmaster*&
30767 .cindex "callout" "full postmaster check"
30768 This operates like the &%postmaster%& option (see below), but if the check for
30769 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30770 accordance with the specification in RFC 2821. The RFC states that the
30771 unqualified address &'postmaster'& should be accepted.
30772
30773
30774 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30775 .cindex "callout" "sender when verifying header"
30776 When verifying addresses in header lines using the &%header_sender%&
30777 verification option, Exim behaves by default as if the addresses are envelope
30778 sender addresses from a message. Callout verification therefore tests to see
30779 whether a bounce message could be delivered, by using an empty address in the
30780 MAIL command. However, it is arguable that these addresses might never be used
30781 as envelope senders, and could therefore justifiably reject bounce messages
30782 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30783 address to use in the MAIL command. For example:
30784 .code
30785 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30786 .endd
30787 This parameter is available only for the &%header_sender%& verification option.
30788
30789
30790 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30791 .cindex "callout" "overall timeout, specifying"
30792 This parameter sets an overall timeout for performing a callout verification.
30793 For example:
30794 .code
30795 verify = sender/callout=5s,maxwait=30s
30796 .endd
30797 This timeout defaults to four times the callout timeout for individual SMTP
30798 commands. The overall timeout applies when there is more than one host that can
30799 be tried. The timeout is checked before trying the next host. This prevents
30800 very long delays if there are a large number of hosts and all are timing out
30801 (for example, when network connections are timing out).
30802
30803
30804 .vitem &*no_cache*&
30805 .cindex "callout" "cache, suppressing"
30806 .cindex "caching callout, suppressing"
30807 When this parameter is given, the callout cache is neither read nor updated.
30808
30809 .vitem &*postmaster*&
30810 .cindex "callout" "postmaster; checking"
30811 When this parameter is set, a successful callout check is followed by a similar
30812 check for the local part &'postmaster'& at the same domain. If this address is
30813 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30814 the postmaster check is recorded in a cache record; if it is a failure, this is
30815 used to fail subsequent callouts for the domain without a connection being
30816 made, until the cache record expires.
30817
30818 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30819 The postmaster check uses an empty sender in the MAIL command by default.
30820 You can use this parameter to do a postmaster check using a different address.
30821 For example:
30822 .code
30823 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30824 .endd
30825 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30826 one overrides. The &%postmaster%& parameter is equivalent to this example:
30827 .code
30828 require  verify = sender/callout=postmaster_mailfrom=
30829 .endd
30830 &*Warning*&: The caching arrangements for postmaster checking do not take
30831 account of the sender address. It is assumed that either the empty address or
30832 a fixed non-empty address will be used. All that Exim remembers is that the
30833 postmaster check for the domain succeeded or failed.
30834
30835
30836 .vitem &*random*&
30837 .cindex "callout" "&""random""& check"
30838 When this parameter is set, before doing the normal callout check, Exim does a
30839 check for a &"random"& local part at the same domain. The local part is not
30840 really random &-- it is defined by the expansion of the option
30841 &%callout_random_local_part%&, which defaults to
30842 .code
30843 $primary_hostname-$tod_epoch-testing
30844 .endd
30845 The idea here is to try to determine whether the remote host accepts all local
30846 parts without checking. If it does, there is no point in doing callouts for
30847 specific local parts. If the &"random"& check succeeds, the result is saved in
30848 a cache record, and used to force the current and subsequent callout checks to
30849 succeed without a connection being made, until the cache record expires.
30850
30851 .vitem &*use_postmaster*&
30852 .cindex "callout" "sender for recipient check"
30853 This parameter applies to recipient callouts only. For example:
30854 .code
30855 deny  !verify = recipient/callout=use_postmaster
30856 .endd
30857 .vindex "&$qualify_domain$&"
30858 It causes a non-empty postmaster address to be used in the MAIL command when
30859 performing the callout for the recipient, and also for a &"random"& check if
30860 that is configured. The local part of the address is &`postmaster`& and the
30861 domain is the contents of &$qualify_domain$&.
30862
30863 .vitem &*use_sender*&
30864 This option applies to recipient callouts only. For example:
30865 .code
30866 require  verify = recipient/callout=use_sender
30867 .endd
30868 It causes the message's actual sender address to be used in the MAIL
30869 command when performing the callout, instead of an empty address. There is no
30870 need to use this option unless you know that the called hosts make use of the
30871 sender when checking recipients. If used indiscriminately, it reduces the
30872 usefulness of callout caching.
30873 .endlist
30874
30875 If you use any of the parameters that set a non-empty sender for the MAIL
30876 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30877 &%use_sender%&), you should think about possible loops. Recipient checking is
30878 usually done between two hosts that are under the same management, and the host
30879 that receives the callouts is not normally configured to do callouts itself.
30880 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30881 these circumstances.
30882
30883 However, if you use a non-empty sender address for a callout to an arbitrary
30884 host, there is the likelihood that the remote host will itself initiate a
30885 callout check back to your host. As it is checking what appears to be a message
30886 sender, it is likely to use an empty address in MAIL, thus avoiding a
30887 callout loop. However, to be on the safe side it would be best to set up your
30888 own ACLs so that they do not do sender verification checks when the recipient
30889 is the address you use for header sender or postmaster callout checking.
30890
30891 Another issue to think about when using non-empty senders for callouts is
30892 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30893 by the sender/recipient combination; thus, for any given recipient, many more
30894 actual callouts are performed than when an empty sender or postmaster is used.
30895
30896
30897
30898
30899 .section "Callout caching" "SECTcallvercache"
30900 .cindex "hints database" "callout cache"
30901 .cindex "callout" "cache, description of"
30902 .cindex "caching" "callout"
30903 Exim caches the results of callouts in order to reduce the amount of resources
30904 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30905 option. A hints database called &"callout"& is used for the cache. Two
30906 different record types are used: one records the result of a callout check for
30907 a specific address, and the other records information that applies to the
30908 entire domain (for example, that it accepts the local part &'postmaster'&).
30909
30910 When an original callout fails, a detailed SMTP error message is given about
30911 the failure. However, for subsequent failures use the cache data, this message
30912 is not available.
30913
30914 The expiry times for negative and positive address cache records are
30915 independent, and can be set by the global options &%callout_negative_expire%&
30916 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30917
30918 If a host gives a negative response to an SMTP connection, or rejects any
30919 commands up to and including
30920 .code
30921 MAIL FROM:<>
30922 .endd
30923 (but not including the MAIL command with a non-empty address),
30924 any callout attempt is bound to fail. Exim remembers such failures in a
30925 domain cache record, which it uses to fail callouts for the domain without
30926 making new connections, until the domain record times out. There are two
30927 separate expiry times for domain cache records:
30928 &%callout_domain_negative_expire%& (default 3h) and
30929 &%callout_domain_positive_expire%& (default 7d).
30930
30931 Domain records expire when the negative expiry time is reached if callouts
30932 cannot be made for the domain, or if the postmaster check failed.
30933 Otherwise, they expire when the positive expiry time is reached. This
30934 ensures that, for example, a host that stops accepting &"random"& local parts
30935 will eventually be noticed.
30936
30937 The callout caching mechanism is based on the domain of the address that is
30938 being tested. If the domain routes to several hosts, it is assumed that their
30939 behaviour will be the same.
30940
30941
30942
30943 .section "Sender address verification reporting" "SECTsenaddver"
30944 .cindex "verifying" "suppressing error details"
30945 See section &<<SECTaddressverification>>& for a general discussion of
30946 verification. When sender verification fails in an ACL, the details of the
30947 failure are given as additional output lines before the 550 response to the
30948 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30949 you might see:
30950 .code
30951 MAIL FROM:<xyz@abc.example>
30952 250 OK
30953 RCPT TO:<pqr@def.example>
30954 550-Verification failed for <xyz@abc.example>
30955 550-Called:   192.168.34.43
30956 550-Sent:     RCPT TO:<xyz@abc.example>
30957 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30958 550 Sender verification failed
30959 .endd
30960 If more than one RCPT command fails in the same way, the details are given
30961 only for the first of them. However, some administrators do not want to send
30962 out this much information. You can suppress the details by adding
30963 &`/no_details`& to the ACL statement that requests sender verification. For
30964 example:
30965 .code
30966 verify = sender/no_details
30967 .endd
30968
30969 .section "Redirection while verifying" "SECTredirwhilveri"
30970 .cindex "verifying" "redirection while"
30971 .cindex "address redirection" "while verifying"
30972 A dilemma arises when a local address is redirected by aliasing or forwarding
30973 during verification: should the generated addresses themselves be verified,
30974 or should the successful expansion of the original address be enough to verify
30975 it? By default, Exim takes the following pragmatic approach:
30976
30977 .ilist
30978 When an incoming address is redirected to just one child address, verification
30979 continues with the child address, and if that fails to verify, the original
30980 verification also fails.
30981 .next
30982 When an incoming address is redirected to more than one child address,
30983 verification does not continue. A success result is returned.
30984 .endlist
30985
30986 This seems the most reasonable behaviour for the common use of aliasing as a
30987 way of redirecting different local parts to the same mailbox. It means, for
30988 example, that a pair of alias entries of the form
30989 .code
30990 A.Wol:   aw123
30991 aw123:   :fail: Gone away, no forwarding address
30992 .endd
30993 work as expected, with both local parts causing verification failure. When a
30994 redirection generates more than one address, the behaviour is more like a
30995 mailing list, where the existence of the alias itself is sufficient for
30996 verification to succeed.
30997
30998 It is possible, however, to change the default behaviour so that all successful
30999 redirections count as successful verifications, however many new addresses are
31000 generated. This is specified by the &%success_on_redirect%& verification
31001 option. For example:
31002 .code
31003 require verify = recipient/success_on_redirect/callout=10s
31004 .endd
31005 In this example, verification succeeds if a router generates a new address, and
31006 the callout does not occur, because no address was routed to a remote host.
31007
31008 When verification is being tested via the &%-bv%& option, the treatment of
31009 redirections is as just described, unless the &%-v%& or any debugging option is
31010 also specified. In that case, full verification is done for every generated
31011 address and a report is output for each of them.
31012
31013
31014
31015 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31016 .cindex "CSA" "verifying"
31017 Client SMTP Authorization is a system that allows a site to advertise
31018 which machines are and are not permitted to send email. This is done by placing
31019 special SRV records in the DNS; these are looked up using the client's HELO
31020 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31021 Authorization checks in Exim are performed by the ACL condition:
31022 .code
31023 verify = csa
31024 .endd
31025 This fails if the client is not authorized. If there is a DNS problem, or if no
31026 valid CSA SRV record is found, or if the client is authorized, the condition
31027 succeeds. These three cases can be distinguished using the expansion variable
31028 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31029 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31030 be likely to cause problems for legitimate email.
31031
31032 The error messages produced by the CSA code include slightly more
31033 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31034 looking up the CSA SRV record, or problems looking up the CSA target
31035 address record. There are four reasons for &$csa_status$& being &"fail"&:
31036
31037 .ilist
31038 The client's host name is explicitly not authorized.
31039 .next
31040 The client's IP address does not match any of the CSA target IP addresses.
31041 .next
31042 The client's host name is authorized but it has no valid target IP addresses
31043 (for example, the target's addresses are IPv6 and the client is using IPv4).
31044 .next
31045 The client's host name has no CSA SRV record but a parent domain has asserted
31046 that all subdomains must be explicitly authorized.
31047 .endlist
31048
31049 The &%csa%& verification condition can take an argument which is the domain to
31050 use for the DNS query. The default is:
31051 .code
31052 verify = csa/$sender_helo_name
31053 .endd
31054 This implementation includes an extension to CSA. If the query domain
31055 is an address literal such as [192.0.2.95], or if it is a bare IP
31056 address, Exim searches for CSA SRV records in the reverse DNS as if
31057 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31058 meaningful to say:
31059 .code
31060 verify = csa/$sender_host_address
31061 .endd
31062 In fact, this is the check that Exim performs if the client does not say HELO.
31063 This extension can be turned off by setting the main configuration option
31064 &%dns_csa_use_reverse%& to be false.
31065
31066 If a CSA SRV record is not found for the domain itself, a search
31067 is performed through its parent domains for a record which might be
31068 making assertions about subdomains. The maximum depth of this search is limited
31069 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31070 default. Exim does not look for CSA SRV records in a top level domain, so the
31071 default settings handle HELO domains as long as seven
31072 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31073 of legitimate HELO domains.
31074
31075 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31076 direct SRV lookups, this is not sufficient because of the extra parent domain
31077 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31078 addresses into lookups in the reverse DNS space. The result of a successful
31079 lookup such as:
31080 .code
31081 ${lookup dnsdb {csa=$sender_helo_name}}
31082 .endd
31083 has two space-separated fields: an authorization code and a target host name.
31084 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31085 authorization required but absent, or &"?"& for unknown.
31086
31087
31088
31089
31090 .section "Bounce address tag validation" "SECTverifyPRVS"
31091 .cindex "BATV, verifying"
31092 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31093 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31094 Genuine incoming bounce messages should therefore always be addressed to
31095 recipients that have a valid tag. This scheme is a way of detecting unwanted
31096 bounce messages caused by sender address forgeries (often called &"collateral
31097 spam"&), because the recipients of such messages do not include valid tags.
31098
31099 There are two expansion items to help with the implementation of the BATV
31100 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31101 the original envelope sender address by using a simple key to add a hash of the
31102 address and some time-based randomizing information. The &%prvs%& expansion
31103 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31104 The syntax of these expansion items is described in section
31105 &<<SECTexpansionitems>>&.
31106
31107 As an example, suppose the secret per-address keys are stored in an MySQL
31108 database. A query to look up the key for an address could be defined as a macro
31109 like this:
31110 .code
31111 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31112                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31113                 }{$value}}
31114 .endd
31115 Suppose also that the senders who make use of BATV are defined by an address
31116 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31117 use this:
31118 .code
31119 # Bounces: drop unsigned addresses for BATV senders
31120 deny message = This address does not send an unsigned reverse path
31121      senders = :
31122      recipients = +batv_senders
31123
31124 # Bounces: In case of prvs-signed address, check signature.
31125 deny message = Invalid reverse path signature.
31126      senders = :
31127      condition  = ${prvscheck {$local_part@$domain}\
31128                   {PRVSCHECK_SQL}{1}}
31129      !condition = $prvscheck_result
31130 .endd
31131 The first statement rejects recipients for bounce messages that are addressed
31132 to plain BATV sender addresses, because it is known that BATV senders do not
31133 send out messages with plain sender addresses. The second statement rejects
31134 recipients that are prvs-signed, but with invalid signatures (either because
31135 the key is wrong, or the signature has timed out).
31136
31137 A non-prvs-signed address is not rejected by the second statement, because the
31138 &%prvscheck%& expansion yields an empty string if its first argument is not a
31139 prvs-signed address, thus causing the &%condition%& condition to be false. If
31140 the first argument is a syntactically valid prvs-signed address, the yield is
31141 the third string (in this case &"1"&), whether or not the cryptographic and
31142 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31143 of the checks (empty for failure, &"1"& for success).
31144
31145 There is one more issue you must consider when implementing prvs-signing:
31146 you have to ensure that the routers accept prvs-signed addresses and
31147 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31148 router to remove the signature with a configuration along these lines:
31149 .code
31150 batv_redirect:
31151   driver = redirect
31152   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31153 .endd
31154 This works because, if the third argument of &%prvscheck%& is empty, the result
31155 of the expansion of a prvs-signed address is the decoded value of the original
31156 address. This router should probably be the first of your routers that handles
31157 local addresses.
31158
31159 To create BATV-signed addresses in the first place, a transport of this form
31160 can be used:
31161 .code
31162 external_smtp_batv:
31163   driver = smtp
31164   return_path = ${prvs {$return_path} \
31165                        {${lookup mysql{SELECT \
31166                        secret FROM batv_prvs WHERE \
31167                        sender='${quote_mysql:$sender_address}'} \
31168                        {$value}fail}}}
31169 .endd
31170 If no key can be found for the existing return path, no signing takes place.
31171
31172
31173
31174 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31175 .cindex "&ACL;" "relay control"
31176 .cindex "relaying" "control by ACL"
31177 .cindex "policy control" "relay control"
31178 An MTA is said to &'relay'& a message if it receives it from some host and
31179 delivers it directly to another host as a result of a remote address contained
31180 within it. Redirecting a local address via an alias or forward file and then
31181 passing the message on to another host is not relaying,
31182 .cindex "&""percent hack""&"
31183 but a redirection as a result of the &"percent hack"& is.
31184
31185 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31186 A host which is acting as a gateway or an MX backup is concerned with incoming
31187 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31188 a host which is acting as a smart host for a number of clients is concerned
31189 with outgoing relaying from those clients to the Internet at large. Often the
31190 same host is fulfilling both functions,
31191 . ///
31192 . as illustrated in the diagram below,
31193 . ///
31194 but in principle these two kinds of relaying are entirely independent. What is
31195 not wanted is the transmission of mail from arbitrary remote hosts through your
31196 system to arbitrary domains.
31197
31198
31199 You can implement relay control by means of suitable statements in the ACL that
31200 runs for each RCPT command. For convenience, it is often easiest to use
31201 Exim's named list facility to define the domains and hosts involved. For
31202 example, suppose you want to do the following:
31203
31204 .ilist
31205 Deliver a number of domains to mailboxes on the local host (or process them
31206 locally in some other way). Let's say these are &'my.dom1.example'& and
31207 &'my.dom2.example'&.
31208 .next
31209 Relay mail for a number of other domains for which you are the secondary MX.
31210 These might be &'friend1.example'& and &'friend2.example'&.
31211 .next
31212 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31213 Suppose your LAN is 192.168.45.0/24.
31214 .endlist
31215
31216
31217 In the main part of the configuration, you put the following definitions:
31218 .code
31219 domainlist local_domains    = my.dom1.example : my.dom2.example
31220 domainlist relay_to_domains = friend1.example : friend2.example
31221 hostlist   relay_from_hosts = 192.168.45.0/24
31222 .endd
31223 Now you can use these definitions in the ACL that is run for every RCPT
31224 command:
31225 .code
31226 acl_check_rcpt:
31227   accept domains = +local_domains : +relay_to_domains
31228   accept hosts   = +relay_from_hosts
31229 .endd
31230 The first statement accepts any RCPT command that contains an address in
31231 the local or relay domains. For any other domain, control passes to the second
31232 statement, which accepts the command only if it comes from one of the relay
31233 hosts. In practice, you will probably want to make your ACL more sophisticated
31234 than this, for example, by including sender and recipient verification. The
31235 default configuration includes a more comprehensive example, which is described
31236 in chapter &<<CHAPdefconfil>>&.
31237
31238
31239
31240 .section "Checking a relay configuration" "SECTcheralcon"
31241 .cindex "relaying" "checking control of"
31242 You can check the relay characteristics of your configuration in the same way
31243 that you can test any ACL behaviour for an incoming SMTP connection, by using
31244 the &%-bh%& option to run a fake SMTP session with which you interact.
31245 .ecindex IIDacl
31246
31247
31248
31249 . ////////////////////////////////////////////////////////////////////////////
31250 . ////////////////////////////////////////////////////////////////////////////
31251
31252 .chapter "Content scanning at ACL time" "CHAPexiscan"
31253 .scindex IIDcosca "content scanning" "at ACL time"
31254 The extension of Exim to include content scanning at ACL time, formerly known
31255 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31256 was integrated into the main source for Exim release 4.50, and Tom continues to
31257 maintain it. Most of the wording of this chapter is taken from Tom's
31258 specification.
31259
31260 It is also possible to scan the content of messages at other times. The
31261 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31262 scanning after all the ACLs have run. A transport filter can be used to scan
31263 messages at delivery time (see the &%transport_filter%& option, described in
31264 chapter &<<CHAPtransportgeneric>>&).
31265
31266 If you want to include the ACL-time content-scanning features when you compile
31267 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31268 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31269
31270 .ilist
31271 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31272 for all MIME parts for SMTP and non-SMTP messages, respectively.
31273 .next
31274 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31275 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31276 run at the end of message reception (the &%acl_smtp_data%& ACL).
31277 .next
31278 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31279 of messages, or parts of messages, for debugging purposes.
31280 .next
31281 Additional expansion variables that are set in the new ACL and by the new
31282 conditions.
31283 .next
31284 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31285 .endlist
31286
31287 Content-scanning is continually evolving, and new features are still being
31288 added. While such features are still unstable and liable to incompatible
31289 changes, they are made available in Exim by setting options whose names begin
31290 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31291 this manual. You can find out about them by reading the file called
31292 &_doc/experimental.txt_&.
31293
31294 All the content-scanning facilities work on a MBOX copy of the message that is
31295 temporarily created in a file called:
31296 .display
31297 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31298 .endd
31299 The &_.eml_& extension is a friendly hint to virus scanners that they can
31300 expect an MBOX-like structure inside that file. The file is created when the
31301 first content scanning facility is called. Subsequent calls to content
31302 scanning conditions open the same file again. The directory is recursively
31303 removed when the &%acl_smtp_data%& ACL has finished running, unless
31304 .code
31305 control = no_mbox_unspool
31306 .endd
31307 has been encountered. When the MIME ACL decodes files, they are put into the
31308 same directory by default.
31309
31310
31311
31312 .section "Scanning for viruses" "SECTscanvirus"
31313 .cindex "virus scanning"
31314 .cindex "content scanning" "for viruses"
31315 .cindex "content scanning" "the &%malware%& condition"
31316 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31317 It supports a &"generic"& interface to scanners called via the shell, and
31318 specialized interfaces for &"daemon"& type virus scanners, which are resident
31319 in memory and thus are much faster.
31320
31321 A timeout of 2 minutes is applied to a scanner call (by default);
31322 if it expires then a defer action is taken.
31323
31324 .oindex "&%av_scanner%&"
31325 You can set the &%av_scanner%& option in the main part of the configuration
31326 to specify which scanner to use, together with any additional options that
31327 are needed. The basic syntax is as follows:
31328 .display
31329 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31330 .endd
31331 If you do not set &%av_scanner%&, it defaults to
31332 .code
31333 av_scanner = sophie:/var/run/sophie
31334 .endd
31335 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31336 before use.
31337 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31338 The following scanner types are supported in this release:
31339
31340 .vlist
31341 .vitem &%avast%&
31342 .cindex "virus scanners" "avast"
31343 This is the scanner daemon of Avast. It has been tested with Avast Core
31344 Security (currently at version 1.1.7).
31345 You can get a trial version at &url(http://www.avast.com) or for Linux
31346 at &url(http://www.avast.com/linux-server-antivirus).
31347 This scanner type takes one option,
31348 which can be either a full path to a UNIX socket,
31349 or host and port specifiers separated by white space.
31350 The host may be a name or an IP address; the port is either a
31351 single number or a pair of numbers with a dash between.
31352 Any further options are given, on separate lines,
31353 to the daemon as options before the main scan command.
31354 For example:
31355 .code
31356 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31357 av_scanner = avast:192.168.2.22 5036
31358 .endd
31359 If you omit the argument, the default path
31360 &_/var/run/avast/scan.sock_&
31361 is used.
31362 If you use a remote host,
31363 you need to make Exim's spool directory available to it,
31364 as the scanner is passed a file path, not file contents.
31365 For information about available commands and their options you may use
31366 .code
31367 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31368     FLAGS
31369     SENSITIVITY
31370     PACK
31371 .endd
31372
31373
31374 .vitem &%aveserver%&
31375 .cindex "virus scanners" "Kaspersky"
31376 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31377 at &url(http://www.kaspersky.com). This scanner type takes one option,
31378 which is the path to the daemon's UNIX socket. The default is shown in this
31379 example:
31380 .code
31381 av_scanner = aveserver:/var/run/aveserver
31382 .endd
31383
31384
31385 .vitem &%clamd%&
31386 .cindex "virus scanners" "clamd"
31387 This daemon-type scanner is GPL and free. You can get it at
31388 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31389 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31390 in the MIME ACL. This is no longer believed to be necessary.
31391
31392 The options are a list of server specifiers, which may be
31393 a UNIX socket specification,
31394 a TCP socket specification,
31395 or a (global) option.
31396
31397 A socket specification consists of a space-separated list.
31398 For a Unix socket the first element is a full path for the socket,
31399 for a TCP socket the first element is the IP address
31400 and the second a port number,
31401 Any further elements are per-server (non-global) options.
31402 These per-server options are supported:
31403 .code
31404 retry=<timespec>        Retry on connect fail
31405 .endd
31406
31407 The &`retry`& option specifies a time after which a single retry for
31408 a failed connect is made.  The default is to not retry.
31409
31410 If a Unix socket file is specified, only one server is supported.
31411
31412 Examples:
31413 .code
31414 av_scanner = clamd:/opt/clamd/socket
31415 av_scanner = clamd:192.0.2.3 1234
31416 av_scanner = clamd:192.0.2.3 1234:local
31417 av_scanner = clamd:192.0.2.3 1234 retry=10s
31418 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31419 .endd
31420 If the value of av_scanner points to a UNIX socket file or contains the
31421 &`local`&
31422 option, then the ClamAV interface will pass a filename containing the data
31423 to be scanned, which will should normally result in less I/O happening and be
31424 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31425 Exim does not assume that there is a common filesystem with the remote host.
31426 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31427 you be running a version of ClamAV prior to 0.95.
31428
31429 The final example shows that multiple TCP targets can be specified.  Exim will
31430 randomly use one for each incoming email (i.e. it load balances them).  Note
31431 that only TCP targets may be used if specifying a list of scanners; a UNIX
31432 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31433 unavailable, Exim will try the remaining one(s) until it finds one that works.
31434 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31435 not keep track of scanner state between multiple messages, and the scanner
31436 selection is random, so the message will get logged in the mainlog for each
31437 email that the down scanner gets chosen first (message wrapped to be readable):
31438 .code
31439 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31440    clamd: connection to localhost, port 3310 failed
31441    (Connection refused)
31442 .endd
31443
31444 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31445 contributing the code for this scanner.
31446
31447 .vitem &%cmdline%&
31448 .cindex "virus scanners" "command line interface"
31449 This is the keyword for the generic command line scanner interface. It can be
31450 used to attach virus scanners that are invoked from the shell. This scanner
31451 type takes 3 mandatory options:
31452
31453 .olist
31454 The full path and name of the scanner binary, with all command line options,
31455 and a placeholder (&`%s`&) for the directory to scan.
31456
31457 .next
31458 A regular expression to match against the STDOUT and STDERR output of the
31459 virus scanner. If the expression matches, a virus was found. You must make
31460 absolutely sure that this expression matches on &"virus found"&. This is called
31461 the &"trigger"& expression.
31462
31463 .next
31464 Another regular expression, containing exactly one pair of parentheses, to
31465 match the name of the virus found in the scanners output. This is called the
31466 &"name"& expression.
31467 .endlist olist
31468
31469 For example, Sophos Sweep reports a virus on a line like this:
31470 .code
31471 Virus 'W32/Magistr-B' found in file ./those.bat
31472 .endd
31473 For the trigger expression, we can match the phrase &"found in file"&. For the
31474 name expression, we want to extract the W32/Magistr-B string, so we can match
31475 for the single quotes left and right of it. Altogether, this makes the
31476 configuration setting:
31477 .code
31478 av_scanner = cmdline:\
31479              /path/to/sweep -ss -all -rec -archive %s:\
31480              found in file:'(.+)'
31481 .endd
31482 .vitem &%drweb%&
31483 .cindex "virus scanners" "DrWeb"
31484 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31485 takes one option,
31486 either a full path to a UNIX socket,
31487 or host and port specifiers separated by white space.
31488 The host may be a name or an IP address; the port is either a
31489 single number or a pair of numbers with a dash between.
31490 For example:
31491 .code
31492 av_scanner = drweb:/var/run/drwebd.sock
31493 av_scanner = drweb:192.168.2.20 31337
31494 .endd
31495 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31496 is used. Thanks to Alex Miller for contributing the code for this scanner.
31497
31498 .vitem &%f-protd%&
31499 .cindex "virus scanners" "f-protd"
31500 The f-protd scanner is accessed via HTTP over TCP.
31501 One argument is taken, being a space-separated hostname and port number
31502 (or port-range).
31503 For example:
31504 .code
31505 av_scanner = f-protd:localhost 10200-10204
31506 .endd
31507 If you omit the argument, the default values show above are used.
31508
31509 .vitem &%fsecure%&
31510 .cindex "virus scanners" "F-Secure"
31511 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31512 argument which is the path to a UNIX socket. For example:
31513 .code
31514 av_scanner = fsecure:/path/to/.fsav
31515 .endd
31516 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31517 Thelmen for contributing the code for this scanner.
31518
31519 .vitem &%kavdaemon%&
31520 .cindex "virus scanners" "Kaspersky"
31521 This is the scanner daemon of Kaspersky Version 4. This version of the
31522 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31523 scanner type takes one option, which is the path to the daemon's UNIX socket.
31524 For example:
31525 .code
31526 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31527 .endd
31528 The default path is &_/var/run/AvpCtl_&.
31529
31530 .vitem &%mksd%&
31531 .cindex "virus scanners" "mksd"
31532 This is a daemon type scanner that is aimed mainly at Polish users, though some
31533 parts of documentation are now available in English. You can get it at
31534 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31535 the maximum number of processes used simultaneously to scan the attachments,
31536 provided that mksd has
31537 been run with at least the same number of child processes. For example:
31538 .code
31539 av_scanner = mksd:2
31540 .endd
31541 You can safely omit this option (the default value is 1).
31542
31543 .vitem &%sock%&
31544 .cindex "virus scanners" "simple socket-connected"
31545 This is a general-purpose way of talking to simple scanner daemons
31546 running on the local machine.
31547 There are four options:
31548 an address (which may be an IP address and port, or the path of a Unix socket),
31549 a commandline to send (may include a single %s which will be replaced with
31550 the path to the mail file to be scanned),
31551 an RE to trigger on from the returned data,
31552 an RE to extract malware_name from the returned data.
31553 For example:
31554 .code
31555 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31556 .endd
31557 Default for the socket specifier is &_/tmp/malware.sock_&.
31558 Default for the commandline is &_%s\n_&.
31559 Both regular-expressions are required.
31560
31561 .vitem &%sophie%&
31562 .cindex "virus scanners" "Sophos and Sophie"
31563 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31564 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31565 for this scanner type is the path to the UNIX socket that Sophie uses for
31566 client communication. For example:
31567 .code
31568 av_scanner = sophie:/tmp/sophie
31569 .endd
31570 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31571 the option.
31572 .endlist
31573
31574 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31575 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31576 ACL.
31577
31578 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31579 makes it possible to use different scanners. See further below for an example.
31580 The &%malware%& condition caches its results, so when you use it multiple times
31581 for the same message, the actual scanning process is only carried out once.
31582 However, using expandable items in &%av_scanner%& disables this caching, in
31583 which case each use of the &%malware%& condition causes a new scan of the
31584 message.
31585
31586 The &%malware%& condition takes a right-hand argument that is expanded before
31587 use and taken as a list, slash-separated by default.
31588 The first element can then be one of
31589
31590 .ilist
31591 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31592 The condition succeeds if a virus was found, and fail otherwise. This is the
31593 recommended usage.
31594 .next
31595 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31596 the condition fails immediately.
31597 .next
31598 A regular expression, in which case the message is scanned for viruses. The
31599 condition succeeds if a virus is found and its name matches the regular
31600 expression. This allows you to take special actions on certain types of virus.
31601 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31602 unless the separator is changed (in the usual way).
31603 .endlist
31604
31605 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31606 messages even if there is a problem with the virus scanner.
31607 Otherwise, such a problem causes the ACL to defer.
31608
31609 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31610 specify a non-default timeout.  The default is two minutes.
31611 For example:
31612 .code
31613 malware = * / defer_ok / tmo=10s
31614 .endd
31615 A timeout causes the ACL to defer.
31616
31617 .vindex "&$callout_address$&"
31618 When a connection is made to the scanner the expansion variable &$callout_address$&
31619 is set to record the actual address used.
31620
31621 .vindex "&$malware_name$&"
31622 When a virus is found, the condition sets up an expansion variable called
31623 &$malware_name$& that contains the name of the virus. You can use it in a
31624 &%message%& modifier that specifies the error returned to the sender, and/or in
31625 logging data.
31626
31627 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31628 imposed by your anti-virus scanner.
31629
31630 Here is a very simple scanning example:
31631 .code
31632 deny message = This message contains malware ($malware_name)
31633      malware = *
31634 .endd
31635 The next example accepts messages when there is a problem with the scanner:
31636 .code
31637 deny message = This message contains malware ($malware_name)
31638      malware = */defer_ok
31639 .endd
31640 The next example shows how to use an ACL variable to scan with both sophie and
31641 aveserver. It assumes you have set:
31642 .code
31643 av_scanner = $acl_m0
31644 .endd
31645 in the main Exim configuration.
31646 .code
31647 deny message = This message contains malware ($malware_name)
31648      set acl_m0 = sophie
31649      malware = *
31650
31651 deny message = This message contains malware ($malware_name)
31652      set acl_m0 = aveserver
31653      malware = *
31654 .endd
31655
31656
31657 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31658 .cindex "content scanning" "for spam"
31659 .cindex "spam scanning"
31660 .cindex "SpamAssassin"
31661 .cindex "Rspamd"
31662 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31663 score and a report for the message.
31664 Support is also provided for Rspamd.
31665
31666 For more information about installation and configuration of SpamAssassin or
31667 Rspamd refer to their respective websites at
31668 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31669
31670 SpamAssassin can be installed with CPAN by running:
31671 .code
31672 perl -MCPAN -e 'install Mail::SpamAssassin'
31673 .endd
31674 SpamAssassin has its own set of configuration files. Please review its
31675 documentation to see how you can tweak it. The default installation should work
31676 nicely, however.
31677
31678 .oindex "&%spamd_address%&"
31679 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31680 intend to use an instance running on the local host you do not need to set
31681 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31682 you must set the &%spamd_address%& option in the global part of the Exim
31683 configuration as follows (example):
31684 .code
31685 spamd_address = 192.168.99.45 387
31686 .endd
31687 The SpamAssassin protocol relies on a TCP half-close from the client.
31688 If your SpamAssassin client side is running a Linux system with an
31689 iptables firewall, consider setting
31690 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
31691 timeout, Exim uses when waiting for a response from the SpamAssassin
31692 server (currently defaulting to 120s).  With a lower value the Linux
31693 connection tracking may consider your half-closed connection as dead too
31694 soon.
31695
31696
31697 To use Rspamd (which by default listens on all local addresses
31698 on TCP port 11333)
31699 you should add &%variant=rspamd%& after the address/port pair, for example:
31700 .code
31701 spamd_address = 127.0.0.1 11333 variant=rspamd
31702 .endd
31703
31704 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31705 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31706 file name instead of an address/port pair:
31707 .code
31708 spamd_address = /var/run/spamd_socket
31709 .endd
31710 You can have multiple &%spamd%& servers to improve scalability. These can
31711 reside on other hardware reachable over the network. To specify multiple
31712 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31713 option, separated with colons (the separator can be changed in the usual way):
31714 .code
31715 spamd_address = 192.168.2.10 783 : \
31716                 192.168.2.11 783 : \
31717                 192.168.2.12 783
31718 .endd
31719 Up to 32 &%spamd%& servers are supported.
31720 When a server fails to respond to the connection attempt, all other
31721 servers are tried until one succeeds. If no server responds, the &%spam%&
31722 condition defers.
31723
31724 Unix and TCP socket specifications may be mixed in any order.
31725 Each element of the list is a list itself, space-separated by default
31726 and changeable in the usual way; take care to not double the separator.
31727
31728 For TCP socket specifications a host name or IP (v4 or v6, but
31729 subject to list-separator quoting rules) address can be used,
31730 and the port can be one or a dash-separated pair.
31731 In the latter case, the range is tried in strict order.
31732
31733 Elements after the first for Unix sockets, or second for TCP socket,
31734 are options.
31735 The supported options are:
31736 .code
31737 pri=<priority>      Selection priority
31738 weight=<value>      Selection bias
31739 time=<start>-<end>  Use only between these times of day
31740 retry=<timespec>    Retry on connect fail
31741 tmo=<timespec>      Connection time limit
31742 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31743 .endd
31744
31745 The &`pri`& option specifies a priority for the server within the list,
31746 higher values being tried first.
31747 The default priority is 1.
31748
31749 The &`weight`& option specifies a selection bias.
31750 Within a priority set
31751 servers are queried in a random fashion, weighted by this value.
31752 The default value for selection bias is 1.
31753
31754 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31755 in the local time zone; each element being one or more digits.
31756 Either the seconds or both minutes and seconds, plus the leading &`.`&
31757 characters, may be omitted and will be taken as zero.
31758
31759 Timeout specifications for the &`retry`& and &`tmo`& options
31760 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31761
31762 The &`tmo`& option specifies an overall timeout for communication.
31763 The default value is two minutes.
31764
31765 The &`retry`& option specifies a time after which a single retry for
31766 a failed connect is made.
31767 The default is to not retry.
31768
31769 The &%spamd_address%& variable is expanded before use if it starts with
31770 a dollar sign. In this case, the expansion may return a string that is
31771 used as the list so that multiple spamd servers can be the result of an
31772 expansion.
31773
31774 .vindex "&$callout_address$&"
31775 When a connection is made to the server the expansion variable &$callout_address$&
31776 is set to record the actual address used.
31777
31778 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31779 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31780 .code
31781 deny message = This message was classified as SPAM
31782      spam = joe
31783 .endd
31784 The right-hand side of the &%spam%& condition specifies a name. This is
31785 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31786 to scan using a specific profile, but rather use the SpamAssassin system-wide
31787 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31788 Rspamd does not use this setting. However, you must put something on the
31789 right-hand side.
31790
31791 The name allows you to use per-domain or per-user antispam profiles in
31792 principle, but this is not straightforward in practice, because a message may
31793 have multiple recipients, not necessarily all in the same domain. Because the
31794 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31795 read the contents of the message, the variables &$local_part$& and &$domain$&
31796 are not set.
31797 Careful enforcement of single-recipient messages
31798 (e.g. by responding with defer in the recipient ACL for all recipients
31799 after the first),
31800 or the use of PRDR,
31801 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31802 are needed to use this feature.
31803
31804 The right-hand side of the &%spam%& condition is expanded before being used, so
31805 you can put lookups or conditions there. When the right-hand side evaluates to
31806 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31807
31808
31809 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31810 large ones may cause significant performance degradation. As most spam messages
31811 are quite small, it is recommended that you do not scan the big ones. For
31812 example:
31813 .code
31814 deny message = This message was classified as SPAM
31815      condition = ${if < {$message_size}{10K}}
31816      spam = nobody
31817 .endd
31818
31819 The &%spam%& condition returns true if the threshold specified in the user's
31820 SpamAssassin profile has been matched or exceeded. If you want to use the
31821 &%spam%& condition for its side effects (see the variables below), you can make
31822 it always return &"true"& by appending &`:true`& to the username.
31823
31824 .cindex "spam scanning" "returned variables"
31825 When the &%spam%& condition is run, it sets up a number of expansion
31826 variables.
31827 Except for &$spam_report$&,
31828 these variables are saved with the received message so are
31829 available for use at delivery time.
31830
31831 .vlist
31832 .vitem &$spam_score$&
31833 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31834 for inclusion in log or reject messages.
31835
31836 .vitem &$spam_score_int$&
31837 The spam score of the message, multiplied by ten, as an integer value. For
31838 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31839 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31840 The integer value is useful for numeric comparisons in conditions.
31841
31842 .vitem &$spam_bar$&
31843 A string consisting of a number of &"+"& or &"-"& characters, representing the
31844 integer part of the spam score value. A spam score of 4.4 would have a
31845 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31846 headers, since MUAs can match on such strings. The maximum length of the
31847 spam bar is 50 characters.
31848
31849 .vitem &$spam_report$&
31850 A multiline text table, containing the full SpamAssassin report for the
31851 message. Useful for inclusion in headers or reject messages.
31852 This variable is only usable in a DATA-time ACL.
31853 Beware that SpamAssassin may return non-ASCII characters, especially
31854 when running in country-specific locales, which are not legal
31855 unencoded in headers.
31856
31857 .vitem &$spam_action$&
31858 For SpamAssassin either 'reject' or 'no action' depending on the
31859 spam score versus threshold.
31860 For Rspamd, the recommended action.
31861
31862 .endlist
31863
31864 The &%spam%& condition caches its results unless expansion in
31865 spamd_address was used. If you call it again with the same user name, it
31866 does not scan again, but rather returns the same values as before.
31867
31868 The &%spam%& condition returns DEFER if there is any error while running
31869 the message through SpamAssassin or if the expansion of spamd_address
31870 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31871 statement block), append &`/defer_ok`& to the right-hand side of the
31872 spam condition, like this:
31873 .code
31874 deny message = This message was classified as SPAM
31875      spam    = joe/defer_ok
31876 .endd
31877 This causes messages to be accepted even if there is a problem with &%spamd%&.
31878
31879 Here is a longer, commented example of the use of the &%spam%&
31880 condition:
31881 .code
31882 # put headers in all messages (no matter if spam or not)
31883 warn  spam = nobody:true
31884       add_header = X-Spam-Score: $spam_score ($spam_bar)
31885       add_header = X-Spam-Report: $spam_report
31886
31887 # add second subject line with *SPAM* marker when message
31888 # is over threshold
31889 warn  spam = nobody
31890       add_header = Subject: *SPAM* $h_Subject:
31891
31892 # reject spam at high scores (> 12)
31893 deny  message = This message scored $spam_score spam points.
31894       spam = nobody:true
31895       condition = ${if >{$spam_score_int}{120}{1}{0}}
31896 .endd
31897
31898
31899
31900 .section "Scanning MIME parts" "SECTscanmimepart"
31901 .cindex "content scanning" "MIME parts"
31902 .cindex "MIME content scanning"
31903 .oindex "&%acl_smtp_mime%&"
31904 .oindex "&%acl_not_smtp_mime%&"
31905 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31906 each MIME part of an SMTP message, including multipart types, in the sequence
31907 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31908 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31909 options may both refer to the same ACL if you want the same processing in both
31910 cases.
31911
31912 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31913 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31914 the case of a non-SMTP message. However, a MIME ACL is called only if the
31915 message contains a &'Content-Type:'& header line. When a call to a MIME
31916 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31917 result code is sent to the client. In the case of an SMTP message, the
31918 &%acl_smtp_data%& ACL is not called when this happens.
31919
31920 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31921 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31922 condition to match against the raw MIME part. You can also use the
31923 &%mime_regex%& condition to match against the decoded MIME part (see section
31924 &<<SECTscanregex>>&).
31925
31926 At the start of a MIME ACL, a number of variables are set from the header
31927 information for the relevant MIME part. These are described below. The contents
31928 of the MIME part are not by default decoded into a disk file except for MIME
31929 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31930 part into a disk file, you can use the &%decode%& condition. The general
31931 syntax is:
31932 .display
31933 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31934 .endd
31935 The right hand side is expanded before use. After expansion,
31936 the value can be:
31937
31938 .olist
31939 &"0"& or &"false"&, in which case no decoding is done.
31940 .next
31941 The string &"default"&. In that case, the file is put in the temporary
31942 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31943 a sequential file name consisting of the message id and a sequence number. The
31944 full path and name is available in &$mime_decoded_filename$& after decoding.
31945 .next
31946 A full path name starting with a slash. If the full name is an existing
31947 directory, it is used as a replacement for the default directory. The filename
31948 is then sequentially assigned. If the path does not exist, it is used as
31949 the full path and file name.
31950 .next
31951 If the string does not start with a slash, it is used as the
31952 filename, and the default path is then used.
31953 .endlist
31954 The &%decode%& condition normally succeeds. It is only false for syntax
31955 errors or unusual circumstances such as memory shortages. You can easily decode
31956 a file with its original, proposed filename using
31957 .code
31958 decode = $mime_filename
31959 .endd
31960 However, you should keep in mind that &$mime_filename$& might contain
31961 anything. If you place files outside of the default path, they are not
31962 automatically unlinked.
31963
31964 For RFC822 attachments (these are messages attached to messages, with a
31965 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31966 as for the primary message, only that the &$mime_is_rfc822$& expansion
31967 variable is set (see below). Attached messages are always decoded to disk
31968 before being checked, and the files are unlinked once the check is done.
31969
31970 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31971 used to match regular expressions against raw and decoded MIME parts,
31972 respectively. They are described in section &<<SECTscanregex>>&.
31973
31974 .cindex "MIME content scanning" "returned variables"
31975 The following list describes all expansion variables that are
31976 available in the MIME ACL:
31977
31978 .vlist
31979 .vitem &$mime_boundary$&
31980 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31981 have a boundary string, which is stored in this variable. If the current part
31982 has no boundary parameter in the &'Content-Type:'& header, this variable
31983 contains the empty string.
31984
31985 .vitem &$mime_charset$&
31986 This variable contains the character set identifier, if one was found in the
31987 &'Content-Type:'& header. Examples for charset identifiers are:
31988 .code
31989 us-ascii
31990 gb2312 (Chinese)
31991 iso-8859-1
31992 .endd
31993 Please note that this value is not normalized, so you should do matches
31994 case-insensitively.
31995
31996 .vitem &$mime_content_description$&
31997 This variable contains the normalized content of the &'Content-Description:'&
31998 header. It can contain a human-readable description of the parts content. Some
31999 implementations repeat the filename for attachments here, but they are usually
32000 only used for display purposes.
32001
32002 .vitem &$mime_content_disposition$&
32003 This variable contains the normalized content of the &'Content-Disposition:'&
32004 header. You can expect strings like &"attachment"& or &"inline"& here.
32005
32006 .vitem &$mime_content_id$&
32007 This variable contains the normalized content of the &'Content-ID:'& header.
32008 This is a unique ID that can be used to reference a part from another part.
32009
32010 .vitem &$mime_content_size$&
32011 This variable is set only after the &%decode%& modifier (see above) has been
32012 successfully run. It contains the size of the decoded part in kilobytes. The
32013 size is always rounded up to full kilobytes, so only a completely empty part
32014 has a &$mime_content_size$& of zero.
32015
32016 .vitem &$mime_content_transfer_encoding$&
32017 This variable contains the normalized content of the
32018 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32019 type. Typical values are &"base64"& and &"quoted-printable"&.
32020
32021 .vitem &$mime_content_type$&
32022 If the MIME part has a &'Content-Type:'& header, this variable contains its
32023 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32024 are some examples of popular MIME types, as they may appear in this variable:
32025 .code
32026 text/plain
32027 text/html
32028 application/octet-stream
32029 image/jpeg
32030 audio/midi
32031 .endd
32032 If the MIME part has no &'Content-Type:'& header, this variable contains the
32033 empty string.
32034
32035 .vitem &$mime_decoded_filename$&
32036 This variable is set only after the &%decode%& modifier (see above) has been
32037 successfully run. It contains the full path and file name of the file
32038 containing the decoded data.
32039 .endlist
32040
32041 .cindex "RFC 2047"
32042 .vlist
32043 .vitem &$mime_filename$&
32044 This is perhaps the most important of the MIME variables. It contains a
32045 proposed filename for an attachment, if one was found in either the
32046 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32047 RFC2047
32048 or RFC2231
32049 decoded, but no additional sanity checks are done.
32050  If no filename was
32051 found, this variable contains the empty string.
32052
32053 .vitem &$mime_is_coverletter$&
32054 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32055 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32056 content in the cover letter, while not restricting attachments at all.
32057
32058 The variable contains 1 (true) for a MIME part believed to be part of the
32059 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32060 follows:
32061
32062 .olist
32063 The outermost MIME part of a message is always a cover letter.
32064
32065 .next
32066 If a multipart/alternative or multipart/related MIME part is a cover letter,
32067 so are all MIME subparts within that multipart.
32068
32069 .next
32070 If any other multipart is a cover letter, the first subpart is a cover letter,
32071 and the rest are attachments.
32072
32073 .next
32074 All parts contained within an attachment multipart are attachments.
32075 .endlist olist
32076
32077 As an example, the following will ban &"HTML mail"& (including that sent with
32078 alternative plain text), while allowing HTML files to be attached. HTML
32079 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32080 .code
32081 deny message = HTML mail is not accepted here
32082 !condition = $mime_is_rfc822
32083 condition = $mime_is_coverletter
32084 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32085 .endd
32086 .vitem &$mime_is_multipart$&
32087 This variable has the value 1 (true) when the current part has the main type
32088 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32089 Since multipart entities only serve as containers for other parts, you may not
32090 want to carry out specific actions on them.
32091
32092 .vitem &$mime_is_rfc822$&
32093 This variable has the value 1 (true) if the current part is not a part of the
32094 checked message itself, but part of an attached message. Attached message
32095 decoding is fully recursive.
32096
32097 .vitem &$mime_part_count$&
32098 This variable is a counter that is raised for each processed MIME part. It
32099 starts at zero for the very first part (which is usually a multipart). The
32100 counter is per-message, so it is reset when processing RFC822 attachments (see
32101 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32102 complete, so you can use it in the DATA ACL to determine the number of MIME
32103 parts of a message. For non-MIME messages, this variable contains the value -1.
32104 .endlist
32105
32106
32107
32108 .section "Scanning with regular expressions" "SECTscanregex"
32109 .cindex "content scanning" "with regular expressions"
32110 .cindex "regular expressions" "content scanning with"
32111 You can specify your own custom regular expression matches on the full body of
32112 the message, or on individual MIME parts.
32113
32114 The &%regex%& condition takes one or more regular expressions as arguments and
32115 matches them against the full message (when called in the DATA ACL) or a raw
32116 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32117 linewise, with a maximum line length of 32K characters. That means you cannot
32118 have multiline matches with the &%regex%& condition.
32119
32120 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32121 to 32K of decoded content (the whole content at once, not linewise). If the
32122 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32123 is decoded automatically when &%mime_regex%& is executed (using default path
32124 and filename values). If the decoded data is larger than  32K, only the first
32125 32K characters are checked.
32126
32127 The regular expressions are passed as a colon-separated list. To include a
32128 literal colon, you must double it. Since the whole right-hand side string is
32129 expanded before being used, you must also escape dollar signs and backslashes
32130 with more backslashes, or use the &`\N`& facility to disable expansion.
32131 Here is a simple example that contains two regular expressions:
32132 .code
32133 deny message = contains blacklisted regex ($regex_match_string)
32134      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32135 .endd
32136 The conditions returns true if any one of the regular expressions matches. The
32137 &$regex_match_string$& expansion variable is then set up and contains the
32138 matching regular expression.
32139 The expansion variables &$regex1$& &$regex2$& etc
32140 are set to any substrings captured by the regular expression.
32141
32142 &*Warning*&: With large messages, these conditions can be fairly
32143 CPU-intensive.
32144
32145 .ecindex IIDcosca
32146
32147
32148
32149
32150 . ////////////////////////////////////////////////////////////////////////////
32151 . ////////////////////////////////////////////////////////////////////////////
32152
32153 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32154          "Local scan function"
32155 .scindex IIDlosca "&[local_scan()]& function" "description of"
32156 .cindex "customizing" "input scan using C function"
32157 .cindex "policy control" "by local scan function"
32158 In these days of email worms, viruses, and ever-increasing spam, some sites
32159 want to apply a lot of checking to messages before accepting them.
32160
32161 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32162 passing messages to external virus and spam scanning software. You can also do
32163 a certain amount in Exim itself through string expansions and the &%condition%&
32164 condition in the ACL that runs after the SMTP DATA command or the ACL for
32165 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32166
32167 To allow for further customization to a site's own requirements, there is the
32168 possibility of linking Exim with a private message scanning function, written
32169 in C. If you want to run code that is written in something other than C, you
32170 can of course use a little C stub to call it.
32171
32172 The local scan function is run once for every incoming message, at the point
32173 when Exim is just about to accept the message.
32174 It can therefore be used to control non-SMTP messages from local processes as
32175 well as messages arriving via SMTP.
32176
32177 Exim applies a timeout to calls of the local scan function, and there is an
32178 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32179 Zero means &"no timeout"&.
32180 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32181 before calling the local scan function, so that the most common types of crash
32182 are caught. If the timeout is exceeded or one of those signals is caught, the
32183 incoming message is rejected with a temporary error if it is an SMTP message.
32184 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32185 code. The incident is logged on the main and reject logs.
32186
32187
32188
32189 .section "Building Exim to use a local scan function" "SECID207"
32190 .cindex "&[local_scan()]& function" "building Exim to use"
32191 To make use of the local scan function feature, you must tell Exim where your
32192 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32193 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32194 directory, so you might set
32195 .code
32196 LOCAL_SCAN_SOURCE=Local/local_scan.c
32197 .endd
32198 for example. The function must be called &[local_scan()]&. It is called by
32199 Exim after it has received a message, when the success return code is about to
32200 be sent. This is after all the ACLs have been run. The return code from your
32201 function controls whether the message is actually accepted or not. There is a
32202 commented template function (that just accepts the message) in the file
32203 _src/local_scan.c_.
32204
32205 If you want to make use of Exim's run time configuration file to set options
32206 for your &[local_scan()]& function, you must also set
32207 .code
32208 LOCAL_SCAN_HAS_OPTIONS=yes
32209 .endd
32210 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32211
32212
32213
32214
32215 .section "API for local_scan()" "SECTapiforloc"
32216 .cindex "&[local_scan()]& function" "API description"
32217 You must include this line near the start of your code:
32218 .code
32219 #include "local_scan.h"
32220 .endd
32221 This header file defines a number of variables and other values, and the
32222 prototype for the function itself. Exim is coded to use unsigned char values
32223 almost exclusively, and one of the things this header defines is a shorthand
32224 for &`unsigned char`& called &`uschar`&.
32225 It also contains the following macro definitions, to simplify casting character
32226 strings and pointers to character strings:
32227 .code
32228 #define CS   (char *)
32229 #define CCS  (const char *)
32230 #define CSS  (char **)
32231 #define US   (unsigned char *)
32232 #define CUS  (const unsigned char *)
32233 #define USS  (unsigned char **)
32234 .endd
32235 The function prototype for &[local_scan()]& is:
32236 .code
32237 extern int local_scan(int fd, uschar **return_text);
32238 .endd
32239 The arguments are as follows:
32240
32241 .ilist
32242 &%fd%& is a file descriptor for the file that contains the body of the message
32243 (the -D file). The file is open for reading and writing, but updating it is not
32244 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32245
32246 The descriptor is positioned at character 19 of the file, which is the first
32247 character of the body itself, because the first 19 characters are the message
32248 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32249 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32250 case this changes in some future version.
32251 .next
32252 &%return_text%& is an address which you can use to return a pointer to a text
32253 string at the end of the function. The value it points to on entry is NULL.
32254 .endlist
32255
32256 The function must return an &%int%& value which is one of the following macros:
32257
32258 .vlist
32259 .vitem &`LOCAL_SCAN_ACCEPT`&
32260 .vindex "&$local_scan_data$&"
32261 The message is accepted. If you pass back a string of text, it is saved with
32262 the message, and made available in the variable &$local_scan_data$&. No
32263 newlines are permitted (if there are any, they are turned into spaces) and the
32264 maximum length of text is 1000 characters.
32265
32266 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32267 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32268 queued without immediate delivery, and is frozen.
32269
32270 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32271 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32272 queued without immediate delivery.
32273
32274 .vitem &`LOCAL_SCAN_REJECT`&
32275 The message is rejected; the returned text is used as an error message which is
32276 passed back to the sender and which is also logged. Newlines are permitted &--
32277 they cause a multiline response for SMTP rejections, but are converted to
32278 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32279 used.
32280
32281 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32282 The message is temporarily rejected; the returned text is used as an error
32283 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32284 problem"& is used.
32285
32286 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32287 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32288 message is not written to the reject log. It has the effect of unsetting the
32289 &%rejected_header%& log selector for just this rejection. If
32290 &%rejected_header%& is already unset (see the discussion of the
32291 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32292 same as LOCAL_SCAN_REJECT.
32293
32294 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32295 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32296 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32297 .endlist
32298
32299 If the message is not being received by interactive SMTP, rejections are
32300 reported by writing to &%stderr%& or by sending an email, as configured by the
32301 &%-oe%& command line options.
32302
32303
32304
32305 .section "Configuration options for local_scan()" "SECTconoptloc"
32306 .cindex "&[local_scan()]& function" "configuration options"
32307 It is possible to have option settings in the main configuration file
32308 that set values in static variables in the &[local_scan()]& module. If you
32309 want to do this, you must have the line
32310 .code
32311 LOCAL_SCAN_HAS_OPTIONS=yes
32312 .endd
32313 in your &_Local/Makefile_& when you build Exim. (This line is in
32314 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32315 file, you must define static variables to hold the option values, and a table
32316 to define them.
32317
32318 The table must be a vector called &%local_scan_options%&, of type
32319 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32320 and a pointer to the variable that holds the value. The entries must appear in
32321 alphabetical order. Following &%local_scan_options%& you must also define a
32322 variable called &%local_scan_options_count%& that contains the number of
32323 entries in the table. Here is a short example, showing two kinds of option:
32324 .code
32325 static int my_integer_option = 42;
32326 static uschar *my_string_option = US"a default string";
32327
32328 optionlist local_scan_options[] = {
32329   { "my_integer", opt_int,       &my_integer_option },
32330   { "my_string",  opt_stringptr, &my_string_option }
32331 };
32332
32333 int local_scan_options_count =
32334   sizeof(local_scan_options)/sizeof(optionlist);
32335 .endd
32336 The values of the variables can now be changed from Exim's runtime
32337 configuration file by including a local scan section as in this example:
32338 .code
32339 begin local_scan
32340 my_integer = 99
32341 my_string = some string of text...
32342 .endd
32343 The available types of option data are as follows:
32344
32345 .vlist
32346 .vitem &*opt_bool*&
32347 This specifies a boolean (true/false) option. The address should point to a
32348 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32349 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32350 whether such a variable has been set at all, you can initialize it to
32351 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32352 values.)
32353
32354 .vitem &*opt_fixed*&
32355 This specifies a fixed point number, such as is used for load averages.
32356 The address should point to a variable of type &`int`&. The value is stored
32357 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32358
32359 .vitem &*opt_int*&
32360 This specifies an integer; the address should point to a variable of type
32361 &`int`&. The value may be specified in any of the integer formats accepted by
32362 Exim.
32363
32364 .vitem &*opt_mkint*&
32365 This is the same as &%opt_int%&, except that when such a value is output in a
32366 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32367 printed with the suffix K or M.
32368
32369 .vitem &*opt_octint*&
32370 This also specifies an integer, but the value is always interpreted as an
32371 octal integer, whether or not it starts with the digit zero, and it is
32372 always output in octal.
32373
32374 .vitem &*opt_stringptr*&
32375 This specifies a string value; the address must be a pointer to a
32376 variable that points to a string (for example, of type &`uschar *`&).
32377
32378 .vitem &*opt_time*&
32379 This specifies a time interval value. The address must point to a variable of
32380 type &`int`&. The value that is placed there is a number of seconds.
32381 .endlist
32382
32383 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32384 out the values of all the &[local_scan()]& options.
32385
32386
32387
32388 .section "Available Exim variables" "SECID208"
32389 .cindex "&[local_scan()]& function" "available Exim variables"
32390 The header &_local_scan.h_& gives you access to a number of C variables. These
32391 are the only ones that are guaranteed to be maintained from release to release.
32392 Note, however, that you can obtain the value of any Exim expansion variable,
32393 including &$recipients$&, by calling &'expand_string()'&. The exported
32394 C variables are as follows:
32395
32396 .vlist
32397 .vitem &*int&~body_linecount*&
32398 This variable contains the number of lines in the message's body.
32399
32400 .vitem &*int&~body_zerocount*&
32401 This variable contains the number of binary zero bytes in the message's body.
32402
32403 .vitem &*unsigned&~int&~debug_selector*&
32404 This variable is set to zero when no debugging is taking place. Otherwise, it
32405 is a bitmap of debugging selectors. Two bits are identified for use in
32406 &[local_scan()]&; they are defined as macros:
32407
32408 .ilist
32409 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32410 testing option that is not privileged &-- any caller may set it. All the
32411 other selector bits can be set only by admin users.
32412
32413 .next
32414 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32415 by the &`+local_scan`& debug selector. It is not included in the default set
32416 of debugging bits.
32417 .endlist ilist
32418
32419 Thus, to write to the debugging output only when &`+local_scan`& has been
32420 selected, you should use code like this:
32421 .code
32422 if ((debug_selector & D_local_scan) != 0)
32423   debug_printf("xxx", ...);
32424 .endd
32425 .vitem &*uschar&~*expand_string_message*&
32426 After a failing call to &'expand_string()'& (returned value NULL), the
32427 variable &%expand_string_message%& contains the error message, zero-terminated.
32428
32429 .vitem &*header_line&~*header_list*&
32430 A pointer to a chain of header lines. The &%header_line%& structure is
32431 discussed below.
32432
32433 .vitem &*header_line&~*header_last*&
32434 A pointer to the last of the header lines.
32435
32436 .vitem &*uschar&~*headers_charset*&
32437 The value of the &%headers_charset%& configuration option.
32438
32439 .vitem &*BOOL&~host_checking*&
32440 This variable is TRUE during a host checking session that is initiated by the
32441 &%-bh%& command line option.
32442
32443 .vitem &*uschar&~*interface_address*&
32444 The IP address of the interface that received the message, as a string. This
32445 is NULL for locally submitted messages.
32446
32447 .vitem &*int&~interface_port*&
32448 The port on which this message was received. When testing with the &%-bh%&
32449 command line option, the value of this variable is -1 unless a port has been
32450 specified via the &%-oMi%& option.
32451
32452 .vitem &*uschar&~*message_id*&
32453 This variable contains Exim's message id for the incoming message (the value of
32454 &$message_exim_id$&) as a zero-terminated string.
32455
32456 .vitem &*uschar&~*received_protocol*&
32457 The name of the protocol by which the message was received.
32458
32459 .vitem &*int&~recipients_count*&
32460 The number of accepted recipients.
32461
32462 .vitem &*recipient_item&~*recipients_list*&
32463 .cindex "recipient" "adding in local scan"
32464 .cindex "recipient" "removing in local scan"
32465 The list of accepted recipients, held in a vector of length
32466 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32467 can add additional recipients by calling &'receive_add_recipient()'& (see
32468 below). You can delete recipients by removing them from the vector and
32469 adjusting the value in &%recipients_count%&. In particular, by setting
32470 &%recipients_count%& to zero you remove all recipients. If you then return the
32471 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32472 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32473 and then call &'receive_add_recipient()'& as often as needed.
32474
32475 .vitem &*uschar&~*sender_address*&
32476 The envelope sender address. For bounce messages this is the empty string.
32477
32478 .vitem &*uschar&~*sender_host_address*&
32479 The IP address of the sending host, as a string. This is NULL for
32480 locally-submitted messages.
32481
32482 .vitem &*uschar&~*sender_host_authenticated*&
32483 The name of the authentication mechanism that was used, or NULL if the message
32484 was not received over an authenticated SMTP connection.
32485
32486 .vitem &*uschar&~*sender_host_name*&
32487 The name of the sending host, if known.
32488
32489 .vitem &*int&~sender_host_port*&
32490 The port on the sending host.
32491
32492 .vitem &*BOOL&~smtp_input*&
32493 This variable is TRUE for all SMTP input, including BSMTP.
32494
32495 .vitem &*BOOL&~smtp_batched_input*&
32496 This variable is TRUE for BSMTP input.
32497
32498 .vitem &*int&~store_pool*&
32499 The contents of this variable control which pool of memory is used for new
32500 requests. See section &<<SECTmemhanloc>>& for details.
32501 .endlist
32502
32503
32504 .section "Structure of header lines" "SECID209"
32505 The &%header_line%& structure contains the members listed below.
32506 You can add additional header lines by calling the &'header_add()'& function
32507 (see below). You can cause header lines to be ignored (deleted) by setting
32508 their type to *.
32509
32510
32511 .vlist
32512 .vitem &*struct&~header_line&~*next*&
32513 A pointer to the next header line, or NULL for the last line.
32514
32515 .vitem &*int&~type*&
32516 A code identifying certain headers that Exim recognizes. The codes are printing
32517 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32518 Notice in particular that any header line whose type is * is not transmitted
32519 with the message. This flagging is used for header lines that have been
32520 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32521 lines.) Effectively, * means &"deleted"&.
32522
32523 .vitem &*int&~slen*&
32524 The number of characters in the header line, including the terminating and any
32525 internal newlines.
32526
32527 .vitem &*uschar&~*text*&
32528 A pointer to the text of the header. It always ends with a newline, followed by
32529 a zero byte. Internal newlines are preserved.
32530 .endlist
32531
32532
32533
32534 .section "Structure of recipient items" "SECID210"
32535 The &%recipient_item%& structure contains these members:
32536
32537 .vlist
32538 .vitem &*uschar&~*address*&
32539 This is a pointer to the recipient address as it was received.
32540
32541 .vitem &*int&~pno*&
32542 This is used in later Exim processing when top level addresses are created by
32543 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32544 and must always contain -1 at this stage.
32545
32546 .vitem &*uschar&~*errors_to*&
32547 If this value is not NULL, bounce messages caused by failing to deliver to the
32548 recipient are sent to the address it contains. In other words, it overrides the
32549 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32550 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32551 an unqualified address, Exim qualifies it using the domain from
32552 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32553 is NULL for all recipients.
32554 .endlist
32555
32556
32557
32558 .section "Available Exim functions" "SECID211"
32559 .cindex "&[local_scan()]& function" "available Exim functions"
32560 The header &_local_scan.h_& gives you access to a number of Exim functions.
32561 These are the only ones that are guaranteed to be maintained from release to
32562 release:
32563
32564 .vlist
32565 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32566        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32567
32568 This function creates a child process that runs the command specified by
32569 &%argv%&. The environment for the process is specified by &%envp%&, which can
32570 be NULL if no environment variables are to be passed. A new umask is supplied
32571 for the process in &%newumask%&.
32572
32573 Pipes to the standard input and output of the new process are set up
32574 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32575 standard error is cloned to the standard output. If there are any file
32576 descriptors &"in the way"& in the new process, they are closed. If the final
32577 argument is TRUE, the new process is made into a process group leader.
32578
32579 The function returns the pid of the new process, or -1 if things go wrong.
32580
32581 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32582 This function waits for a child process to terminate, or for a timeout (in
32583 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32584 return value is as follows:
32585
32586 .ilist
32587 >= 0
32588
32589 The process terminated by a normal exit and the value is the process
32590 ending status.
32591
32592 .next
32593 < 0 and > &--256
32594
32595 The process was terminated by a signal and the value is the negation of the
32596 signal number.
32597
32598 .next
32599 &--256
32600
32601 The process timed out.
32602 .next
32603 &--257
32604
32605 The was some other error in wait(); &%errno%& is still set.
32606 .endlist
32607
32608 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32609 This function provide you with a means of submitting a new message to
32610 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32611 want, but this packages it all up for you.) The function creates a pipe,
32612 forks a subprocess that is running
32613 .code
32614 exim -t -oem -oi -f <>
32615 .endd
32616 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32617 that is connected to the standard input. The yield of the function is the PID
32618 of the subprocess. You can then write a message to the file descriptor, with
32619 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32620
32621 When you have finished, call &'child_close()'& to wait for the process to
32622 finish and to collect its ending status. A timeout value of zero is usually
32623 fine in this circumstance. Unless you have made a mistake with the recipient
32624 addresses, you should get a return code of zero.
32625
32626
32627 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32628        *sender_authentication)*&
32629 This function is a more sophisticated version of &'child_open()'&. The command
32630 that it runs is:
32631 .display
32632 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32633 .endd
32634 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32635
32636
32637 .vitem &*void&~debug_printf(char&~*,&~...)*&
32638 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32639 output is written to the standard error stream. If no debugging is selected,
32640 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32641 conditional on the &`local_scan`& debug selector by coding like this:
32642 .code
32643 if ((debug_selector & D_local_scan) != 0)
32644   debug_printf("xxx", ...);
32645 .endd
32646
32647 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32648 This is an interface to Exim's string expansion code. The return value is the
32649 expanded string, or NULL if there was an expansion failure.
32650 The C variable &%expand_string_message%& contains an error message after an
32651 expansion failure. If expansion does not change the string, the return value is
32652 the pointer to the input string. Otherwise, the return value points to a new
32653 block of memory that was obtained by a call to &'store_get()'&. See section
32654 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32655
32656 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32657 This function allows you to an add additional header line at the end of the
32658 existing ones. The first argument is the type, and should normally be a space
32659 character. The second argument is a format string and any number of
32660 substitution arguments as for &[sprintf()]&. You may include internal newlines
32661 if you want, and you must ensure that the string ends with a newline.
32662
32663 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32664         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32665 This function adds a new header line at a specified point in the header
32666 chain. The header itself is specified as for &'header_add()'&.
32667
32668 If &%name%& is NULL, the new header is added at the end of the chain if
32669 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32670 NULL, the header lines are searched for the first non-deleted header that
32671 matches the name. If one is found, the new header is added before it if
32672 &%after%& is false. If &%after%& is true, the new header is added after the
32673 found header and any adjacent subsequent ones with the same name (even if
32674 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32675 option controls where the header is added. If it is true, addition is at the
32676 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32677 headers, or at the top if there are no &'Received:'& headers, you could use
32678 .code
32679 header_add_at_position(TRUE, US"Received", TRUE,
32680   ' ', "X-xxx: ...");
32681 .endd
32682 Normally, there is always at least one non-deleted &'Received:'& header, but
32683 there may not be if &%received_header_text%& expands to an empty string.
32684
32685
32686 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32687 This function removes header lines. If &%occurrence%& is zero or negative, all
32688 occurrences of the header are removed. If occurrence is greater than zero, that
32689 particular instance of the header is removed. If no header(s) can be found that
32690 match the specification, the function does nothing.
32691
32692
32693 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32694         int&~length,&~BOOL&~notdel)*&"
32695 This function tests whether the given header has the given name. It is not just
32696 a string comparison, because white space is permitted between the name and the
32697 colon. If the &%notdel%& argument is true, a false return is forced for all
32698 &"deleted"& headers; otherwise they are not treated specially. For example:
32699 .code
32700 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32701 .endd
32702 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32703 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32704 This function base64-encodes a string, which is passed by address and length.
32705 The text may contain bytes of any value, including zero. The result is passed
32706 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32707 zero-terminated.
32708
32709 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32710 This function decodes a base64-encoded string. Its arguments are a
32711 zero-terminated base64-encoded string and the address of a variable that is set
32712 to point to the result, which is in dynamic memory. The length of the decoded
32713 string is the yield of the function. If the input is invalid base64 data, the
32714 yield is -1. A zero byte is added to the end of the output string to make it
32715 easy to interpret as a C string (assuming it contains no zeros of its own). The
32716 added zero byte is not included in the returned count.
32717
32718 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32719 This function checks for a match in a domain list. Domains are always
32720 matched caselessly. The return value is one of the following:
32721 .display
32722 &`OK     `& match succeeded
32723 &`FAIL   `& match failed
32724 &`DEFER  `& match deferred
32725 .endd
32726 DEFER is usually caused by some kind of lookup defer, such as the
32727 inability to contact a database.
32728
32729 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32730         BOOL&~caseless)*&"
32731 This function checks for a match in a local part list. The third argument
32732 controls case-sensitivity. The return values are as for
32733 &'lss_match_domain()'&.
32734
32735 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32736         BOOL&~caseless)*&"
32737 This function checks for a match in an address list. The third argument
32738 controls the case-sensitivity of the local part match. The domain is always
32739 matched caselessly. The return values are as for &'lss_match_domain()'&.
32740
32741 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32742         uschar&~*list)*&"
32743 This function checks for a match in a host list. The most common usage is
32744 expected to be
32745 .code
32746 lss_match_host(sender_host_name, sender_host_address, ...)
32747 .endd
32748 .vindex "&$sender_host_address$&"
32749 An empty address field matches an empty item in the host list. If the host name
32750 is NULL, the name corresponding to &$sender_host_address$& is automatically
32751 looked up if a host name is required to match an item in the list. The return
32752 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32753 returns ERROR in the case when it had to look up a host name, but the lookup
32754 failed.
32755
32756 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32757         *format,&~...)*&"
32758 This function writes to Exim's log files. The first argument should be zero (it
32759 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32760 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32761 them. It specifies to which log or logs the message is written. The remaining
32762 arguments are a format and relevant insertion arguments. The string should not
32763 contain any newlines, not even at the end.
32764
32765
32766 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32767 This function adds an additional recipient to the message. The first argument
32768 is the recipient address. If it is unqualified (has no domain), it is qualified
32769 with the &%qualify_recipient%& domain. The second argument must always be -1.
32770
32771 This function does not allow you to specify a private &%errors_to%& address (as
32772 described with the structure of &%recipient_item%& above), because it pre-dates
32773 the addition of that field to the structure. However, it is easy to add such a
32774 value afterwards. For example:
32775 .code
32776  receive_add_recipient(US"monitor@mydom.example", -1);
32777  recipients_list[recipients_count-1].errors_to =
32778    US"postmaster@mydom.example";
32779 .endd
32780
32781 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32782 This is a convenience function to remove a named recipient from the list of
32783 recipients. It returns true if a recipient was removed, and false if no
32784 matching recipient could be found. The argument must be a complete email
32785 address.
32786 .endlist
32787
32788
32789 .cindex "RFC 2047"
32790 .vlist
32791 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32792   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32793 This function decodes strings that are encoded according to RFC 2047. Typically
32794 these are the contents of header lines. First, each &"encoded word"& is decoded
32795 from the Q or B encoding into a byte-string. Then, if provided with the name of
32796 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32797 made  to translate the result to the named character set. If this fails, the
32798 binary string is returned with an error message.
32799
32800 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32801 maximum MIME word length is enforced. The third argument is the target
32802 encoding, or NULL if no translation is wanted.
32803
32804 .cindex "binary zero" "in RFC 2047 decoding"
32805 .cindex "RFC 2047" "binary zero in"
32806 If a binary zero is encountered in the decoded string, it is replaced by the
32807 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32808 not be 0 because header lines are handled as zero-terminated strings.
32809
32810 The function returns the result of processing the string, zero-terminated; if
32811 &%lenptr%& is not NULL, the length of the result is set in the variable to
32812 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32813
32814 If an error is encountered, the function returns NULL and uses the &%error%&
32815 argument to return an error message. The variable pointed to by &%error%& is
32816 set to NULL if there is no error; it may be set non-NULL even when the function
32817 returns a non-NULL value if decoding was successful, but there was a problem
32818 with translation.
32819
32820
32821 .vitem &*int&~smtp_fflush(void)*&
32822 This function is used in conjunction with &'smtp_printf()'&, as described
32823 below.
32824
32825 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32826 The arguments of this function are like &[printf()]&; it writes to the SMTP
32827 output stream. You should use this function only when there is an SMTP output
32828 stream, that is, when the incoming message is being received via interactive
32829 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32830 is FALSE. If you want to test for an incoming message from another host (as
32831 opposed to a local process that used the &%-bs%& command line option), you can
32832 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32833 is involved.
32834
32835 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32836 output function, so it can be used for all forms of SMTP connection.
32837
32838 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32839 must start with an appropriate response code: 550 if you are going to return
32840 LOCAL_SCAN_REJECT, 451 if you are going to return
32841 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32842 initial lines of a multi-line response, the code must be followed by a hyphen
32843 to indicate that the line is not the final response line. You must also ensure
32844 that the lines you write terminate with CRLF. For example:
32845 .code
32846 smtp_printf("550-this is some extra info\r\n");
32847 return LOCAL_SCAN_REJECT;
32848 .endd
32849 Note that you can also create multi-line responses by including newlines in
32850 the data returned via the &%return_text%& argument. The added value of using
32851 &'smtp_printf()'& is that, for instance, you could introduce delays between
32852 multiple output lines.
32853
32854 The &'smtp_printf()'& function does not return any error indication, because it
32855 does not automatically flush pending output, and therefore does not test
32856 the state of the stream. (In the main code of Exim, flushing and error
32857 detection is done when Exim is ready for the next SMTP input command.) If
32858 you want to flush the output and check for an error (for example, the
32859 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32860 arguments. It flushes the output stream, and returns a non-zero value if there
32861 is an error.
32862
32863 .vitem &*void&~*store_get(int)*&
32864 This function accesses Exim's internal store (memory) manager. It gets a new
32865 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32866 runs out of memory. See the next section for a discussion of memory handling.
32867
32868 .vitem &*void&~*store_get_perm(int)*&
32869 This function is like &'store_get()'&, but it always gets memory from the
32870 permanent pool. See the next section for a discussion of memory handling.
32871
32872 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32873 See below.
32874
32875 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32876 See below.
32877
32878 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32879 These three functions create strings using Exim's dynamic memory facilities.
32880 The first makes a copy of an entire string. The second copies up to a maximum
32881 number of characters, indicated by the second argument. The third uses a format
32882 and insertion arguments to create a new string. In each case, the result is a
32883 pointer to a new string in the current memory pool. See the next section for
32884 more discussion.
32885 .endlist
32886
32887
32888
32889 .section "More about Exim's memory handling" "SECTmemhanloc"
32890 .cindex "&[local_scan()]& function" "memory handling"
32891 No function is provided for freeing memory, because that is never needed.
32892 The dynamic memory that Exim uses when receiving a message is automatically
32893 recycled if another message is received by the same process (this applies only
32894 to incoming SMTP connections &-- other input methods can supply only one
32895 message at a time). After receiving the last message, a reception process
32896 terminates.
32897
32898 Because it is recycled, the normal dynamic memory cannot be used for holding
32899 data that must be preserved over a number of incoming messages on the same SMTP
32900 connection. However, Exim in fact uses two pools of dynamic memory; the second
32901 one is not recycled, and can be used for this purpose.
32902
32903 If you want to allocate memory that remains available for subsequent messages
32904 in the same SMTP connection, you should set
32905 .code
32906 store_pool = POOL_PERM
32907 .endd
32908 before calling the function that does the allocation. There is no need to
32909 restore the value if you do not need to; however, if you do want to revert to
32910 the normal pool, you can either restore the previous value of &%store_pool%& or
32911 set it explicitly to POOL_MAIN.
32912
32913 The pool setting applies to all functions that get dynamic memory, including
32914 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32915 There is also a convenience function called &'store_get_perm()'& that gets a
32916 block of memory from the permanent pool while preserving the value of
32917 &%store_pool%&.
32918 .ecindex IIDlosca
32919
32920
32921
32922
32923 . ////////////////////////////////////////////////////////////////////////////
32924 . ////////////////////////////////////////////////////////////////////////////
32925
32926 .chapter "System-wide message filtering" "CHAPsystemfilter"
32927 .scindex IIDsysfil1 "filter" "system filter"
32928 .scindex IIDsysfil2 "filtering all mail"
32929 .scindex IIDsysfil3 "system filter"
32930 The previous chapters (on ACLs and the local scan function) describe checks
32931 that can be applied to messages before they are accepted by a host. There is
32932 also a mechanism for checking messages once they have been received, but before
32933 they are delivered. This is called the &'system filter'&.
32934
32935 The system filter operates in a similar manner to users' filter files, but it
32936 is run just once per message (however many recipients the message has).
32937 It should not normally be used as a substitute for routing, because &%deliver%&
32938 commands in a system router provide new envelope recipient addresses.
32939 The system filter must be an Exim filter. It cannot be a Sieve filter.
32940
32941 The system filter is run at the start of a delivery attempt, before any routing
32942 is done. If a message fails to be completely delivered at the first attempt,
32943 the system filter is run again at the start of every retry.
32944 If you want your filter to do something only once per message, you can make use
32945 of the &%first_delivery%& condition in an &%if%& command in the filter to
32946 prevent it happening on retries.
32947
32948 .vindex "&$domain$&"
32949 .vindex "&$local_part$&"
32950 &*Warning*&: Because the system filter runs just once, variables that are
32951 specific to individual recipient addresses, such as &$local_part$& and
32952 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32953 you want to run a centrally-specified filter for each recipient address
32954 independently, you can do so by setting up a suitable &(redirect)& router, as
32955 described in section &<<SECTperaddfil>>& below.
32956
32957
32958 .section "Specifying a system filter" "SECID212"
32959 .cindex "uid (user id)" "system filter"
32960 .cindex "gid (group id)" "system filter"
32961 The name of the file that contains the system filter must be specified by
32962 setting &%system_filter%&. If you want the filter to run under a uid and gid
32963 other than root, you must also set &%system_filter_user%& and
32964 &%system_filter_group%& as appropriate. For example:
32965 .code
32966 system_filter = /etc/mail/exim.filter
32967 system_filter_user = exim
32968 .endd
32969 If a system filter generates any deliveries directly to files or pipes (via the
32970 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32971 specified by setting &%system_filter_file_transport%& and
32972 &%system_filter_pipe_transport%&, respectively. Similarly,
32973 &%system_filter_reply_transport%& must be set to handle any messages generated
32974 by the &%reply%& command.
32975
32976
32977 .section "Testing a system filter" "SECID213"
32978 You can run simple tests of a system filter in the same way as for a user
32979 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32980 are permitted only in system filters are recognized.
32981
32982 If you want to test the combined effect of a system filter and a user filter,
32983 you can use both &%-bF%& and &%-bf%& on the same command line.
32984
32985
32986
32987 .section "Contents of a system filter" "SECID214"
32988 The language used to specify system filters is the same as for users' filter
32989 files. It is described in the separate end-user document &'Exim's interface to
32990 mail filtering'&. However, there are some additional features that are
32991 available only in system filters; these are described in subsequent sections.
32992 If they are encountered in a user's filter file or when testing with &%-bf%&,
32993 they cause errors.
32994
32995 .cindex "frozen messages" "manual thaw; testing in filter"
32996 There are two special conditions which, though available in users' filter
32997 files, are designed for use in system filters. The condition &%first_delivery%&
32998 is true only for the first attempt at delivering a message, and
32999 &%manually_thawed%& is true only if the message has been frozen, and
33000 subsequently thawed by an admin user. An explicit forced delivery counts as a
33001 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33002
33003 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33004 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33005 succeed, it will not be tried again.
33006 If you want Exim to retry an unseen delivery until it succeeds, you should
33007 arrange to set it up every time the filter runs.
33008
33009 When a system filter finishes running, the values of the variables &$n0$& &--
33010 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33011 users' filter files. Thus a system filter can, for example, set up &"scores"&
33012 to which users' filter files can refer.
33013
33014
33015
33016 .section "Additional variable for system filters" "SECID215"
33017 .vindex "&$recipients$&"
33018 The expansion variable &$recipients$&, containing a list of all the recipients
33019 of the message (separated by commas and white space), is available in system
33020 filters. It is not available in users' filters for privacy reasons.
33021
33022
33023
33024 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33025 .cindex "freezing messages"
33026 .cindex "message" "freezing"
33027 .cindex "message" "forced failure"
33028 .cindex "&%fail%&" "in system filter"
33029 .cindex "&%freeze%& in system filter"
33030 .cindex "&%defer%& in system filter"
33031 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33032 always available in system filters, but are not normally enabled in users'
33033 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33034 for the &(redirect)& router.) These commands can optionally be followed by the
33035 word &%text%& and a string containing an error message, for example:
33036 .code
33037 fail text "this message looks like spam to me"
33038 .endd
33039 The keyword &%text%& is optional if the next character is a double quote.
33040
33041 The &%defer%& command defers delivery of the original recipients of the
33042 message. The &%fail%& command causes all the original recipients to be failed,
33043 and a bounce message to be created. The &%freeze%& command suspends all
33044 delivery attempts for the original recipients. In all cases, any new deliveries
33045 that are specified by the filter are attempted as normal after the filter has
33046 run.
33047
33048 The &%freeze%& command is ignored if the message has been manually unfrozen and
33049 not manually frozen since. This means that automatic freezing by a system
33050 filter can be used as a way of checking out suspicious messages. If a message
33051 is found to be all right, manually unfreezing it allows it to be delivered.
33052
33053 .cindex "log" "&%fail%& command log line"
33054 .cindex "&%fail%&" "log line; reducing"
33055 The text given with a fail command is used as part of the bounce message as
33056 well as being written to the log. If the message is quite long, this can fill
33057 up a lot of log space when such failures are common. To reduce the size of the
33058 log message, Exim interprets the text in a special way if it starts with the
33059 two characters &`<<`& and contains &`>>`& later. The text between these two
33060 strings is written to the log, and the rest of the text is used in the bounce
33061 message. For example:
33062 .code
33063 fail "<<filter test 1>>Your message is rejected \
33064      because it contains attachments that we are \
33065      not prepared to receive."
33066 .endd
33067
33068 .cindex "loop" "caused by &%fail%&"
33069 Take great care with the &%fail%& command when basing the decision to fail on
33070 the contents of the message, because the bounce message will of course include
33071 the contents of the original message and will therefore trigger the &%fail%&
33072 command again (causing a mail loop) unless steps are taken to prevent this.
33073 Testing the &%error_message%& condition is one way to prevent this. You could
33074 use, for example
33075 .code
33076 if $message_body contains "this is spam" and not error_message
33077 then fail text "spam is not wanted here" endif
33078 .endd
33079 though of course that might let through unwanted bounce messages. The
33080 alternative is clever checking of the body and/or headers to detect bounces
33081 generated by the filter.
33082
33083 The interpretation of a system filter file ceases after a
33084 &%defer%&,
33085 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33086 set up earlier in the filter file are honoured, so you can use a sequence such
33087 as
33088 .code
33089 mail ...
33090 freeze
33091 .endd
33092 to send a specified message when the system filter is freezing (or deferring or
33093 failing) a message. The normal deliveries for the message do not, of course,
33094 take place.
33095
33096
33097
33098 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33099 .cindex "header lines" "adding; in system filter"
33100 .cindex "header lines" "removing; in system filter"
33101 .cindex "filter" "header lines; adding/removing"
33102 Two filter commands that are available only in system filters are:
33103 .code
33104 headers add <string>
33105 headers remove <string>
33106 .endd
33107 The argument for the &%headers add%& is a string that is expanded and then
33108 added to the end of the message's headers. It is the responsibility of the
33109 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33110 space is ignored, and if the string is otherwise empty, or if the expansion is
33111 forced to fail, the command has no effect.
33112
33113 You can use &"\n"& within the string, followed by white space, to specify
33114 continued header lines. More than one header may be added in one command by
33115 including &"\n"& within the string without any following white space. For
33116 example:
33117 .code
33118 headers add "X-header-1: ....\n  \
33119              continuation of X-header-1 ...\n\
33120              X-header-2: ...."
33121 .endd
33122 Note that the header line continuation white space after the first newline must
33123 be placed before the backslash that continues the input string, because white
33124 space after input continuations is ignored.
33125
33126 The argument for &%headers remove%& is a colon-separated list of header names.
33127 This command applies only to those headers that are stored with the message;
33128 those that are added at delivery time (such as &'Envelope-To:'& and
33129 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33130 header with the same name, they are all removed.
33131
33132 The &%headers%& command in a system filter makes an immediate change to the set
33133 of header lines that was received with the message (with possible additions
33134 from ACL processing). Subsequent commands in the system filter operate on the
33135 modified set, which also forms the basis for subsequent message delivery.
33136 Unless further modified during routing or transporting, this set of headers is
33137 used for all recipients of the message.
33138
33139 During routing and transporting, the variables that refer to the contents of
33140 header lines refer only to those lines that are in this set. Thus, header lines
33141 that are added by a system filter are visible to users' filter files and to all
33142 routers and transports. This contrasts with the manipulation of header lines by
33143 routers and transports, which is not immediate, but which instead is saved up
33144 until the message is actually being written (see section
33145 &<<SECTheadersaddrem>>&).
33146
33147 If the message is not delivered at the first attempt, header lines that were
33148 added by the system filter are stored with the message, and so are still
33149 present at the next delivery attempt. Header lines that were removed are still
33150 present, but marked &"deleted"& so that they are not transported with the
33151 message. For this reason, it is usual to make the &%headers%& command
33152 conditional on &%first_delivery%& so that the set of header lines is not
33153 modified more than once.
33154
33155 Because header modification in a system filter acts immediately, you have to
33156 use an indirect approach if you want to modify the contents of a header line.
33157 For example:
33158 .code
33159 headers add "Old-Subject: $h_subject:"
33160 headers remove "Subject"
33161 headers add "Subject: new subject (was: $h_old-subject:)"
33162 headers remove "Old-Subject"
33163 .endd
33164
33165
33166
33167 .section "Setting an errors address in a system filter" "SECID217"
33168 .cindex "envelope sender"
33169 In a system filter, if a &%deliver%& command is followed by
33170 .code
33171 errors_to <some address>
33172 .endd
33173 in order to change the envelope sender (and hence the error reporting) for that
33174 delivery, any address may be specified. (In a user filter, only the current
33175 user's address can be set.) For example, if some mail is being monitored, you
33176 might use
33177 .code
33178 unseen deliver monitor@spying.example errors_to root@local.example
33179 .endd
33180 to take a copy which would not be sent back to the normal error reporting
33181 address if its delivery failed.
33182
33183
33184
33185 .section "Per-address filtering" "SECTperaddfil"
33186 .vindex "&$domain$&"
33187 .vindex "&$local_part$&"
33188 In contrast to the system filter, which is run just once per message for each
33189 delivery attempt, it is also possible to set up a system-wide filtering
33190 operation that runs once for each recipient address. In this case, variables
33191 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33192 filter file could be made dependent on them. This is an example of a router
33193 which implements such a filter:
33194 .code
33195 central_filter:
33196   check_local_user
33197   driver = redirect
33198   domains = +local_domains
33199   file = /central/filters/$local_part
33200   no_verify
33201   allow_filter
33202   allow_freeze
33203 .endd
33204 The filter is run in a separate process under its own uid. Therefore, either
33205 &%check_local_user%& must be set (as above), in which case the filter is run as
33206 the local user, or the &%user%& option must be used to specify which user to
33207 use. If both are set, &%user%& overrides.
33208
33209 Care should be taken to ensure that none of the commands in the filter file
33210 specify a significant delivery if the message is to go on to be delivered to
33211 its intended recipient. The router will not then claim to have dealt with the
33212 address, so it will be passed on to subsequent routers to be delivered in the
33213 normal way.
33214 .ecindex IIDsysfil1
33215 .ecindex IIDsysfil2
33216 .ecindex IIDsysfil3
33217
33218
33219
33220
33221
33222
33223 . ////////////////////////////////////////////////////////////////////////////
33224 . ////////////////////////////////////////////////////////////////////////////
33225
33226 .chapter "Message processing" "CHAPmsgproc"
33227 .scindex IIDmesproc "message" "general processing"
33228 Exim performs various transformations on the sender and recipient addresses of
33229 all messages that it handles, and also on the messages' header lines. Some of
33230 these are optional and configurable, while others always take place. All of
33231 this processing, except rewriting as a result of routing, and the addition or
33232 removal of header lines while delivering, happens when a message is received,
33233 before it is placed on Exim's queue.
33234
33235 Some of the automatic processing takes place by default only for
33236 &"locally-originated"& messages. This adjective is used to describe messages
33237 that are not received over TCP/IP, but instead are passed to an Exim process on
33238 its standard input. This includes the interactive &"local SMTP"& case that is
33239 set up by the &%-bs%& command line option.
33240
33241 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33242 or ::1) are not considered to be locally-originated. Exim does not treat the
33243 loopback interface specially in any way.
33244
33245 If you want the loopback interface to be treated specially, you must ensure
33246 that there are appropriate entries in your ACLs.
33247
33248
33249
33250
33251 .section "Submission mode for non-local messages" "SECTsubmodnon"
33252 .cindex "message" "submission"
33253 .cindex "submission mode"
33254 Processing that happens automatically for locally-originated messages (unless
33255 &%suppress_local_fixups%& is set) can also be requested for messages that are
33256 received over TCP/IP. The term &"submission mode"& is used to describe this
33257 state. Submission mode is set by the modifier
33258 .code
33259 control = submission
33260 .endd
33261 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33262 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33263 a local submission, and is normally used when the source of the message is
33264 known to be an MUA running on a client host (as opposed to an MTA). For
33265 example, to set submission mode for messages originating on the IPv4 loopback
33266 interface, you could include the following in the MAIL ACL:
33267 .code
33268 warn  hosts = 127.0.0.1
33269       control = submission
33270 .endd
33271 .cindex "&%sender_retain%& submission option"
33272 There are some options that can be used when setting submission mode. A slash
33273 is used to separate options. For example:
33274 .code
33275 control = submission/sender_retain
33276 .endd
33277 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33278 true and &%local_from_check%& false for the current incoming message. The first
33279 of these allows an existing &'Sender:'& header in the message to remain, and
33280 the second suppresses the check to ensure that &'From:'& matches the
33281 authenticated sender. With this setting, Exim still fixes up messages by adding
33282 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33283 attempt to check sender authenticity in header lines.
33284
33285 When &%sender_retain%& is not set, a submission mode setting may specify a
33286 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33287 example:
33288 .code
33289 control = submission/domain=some.domain
33290 .endd
33291 The domain may be empty. How this value is used is described in sections
33292 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33293 that allows you to specify the user's full name for inclusion in a created
33294 &'Sender:'& or &'From:'& header line. For example:
33295 .code
33296 accept authenticated = *
33297        control = submission/domain=wonderland.example/\
33298                             name=${lookup {$authenticated_id} \
33299                                    lsearch {/etc/exim/namelist}}
33300 .endd
33301 Because the name may contain any characters, including slashes, the &%name%&
33302 option must be given last. The remainder of the string is used as the name. For
33303 the example above, if &_/etc/exim/namelist_& contains:
33304 .code
33305 bigegg:  Humpty Dumpty
33306 .endd
33307 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33308 line would be:
33309 .code
33310 Sender: Humpty Dumpty <bigegg@wonderland.example>
33311 .endd
33312 .cindex "return path" "in submission mode"
33313 By default, submission mode forces the return path to the same address as is
33314 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33315 specified, the return path is also left unchanged.
33316
33317 &*Note*&: The changes caused by submission mode take effect after the predata
33318 ACL. This means that any sender checks performed before the fix-ups use the
33319 untrusted sender address specified by the user, not the trusted sender address
33320 specified by submission mode. Although this might be slightly unexpected, it
33321 does mean that you can configure ACL checks to spot that a user is trying to
33322 spoof another's address.
33323
33324 .section "Line endings" "SECTlineendings"
33325 .cindex "line endings"
33326 .cindex "carriage return"
33327 .cindex "linefeed"
33328 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33329 linefeed) is the line ending for messages transmitted over the Internet using
33330 SMTP over TCP/IP. However, within individual operating systems, different
33331 conventions are used. For example, Unix-like systems use just LF, but others
33332 use CRLF or just CR.
33333
33334 Exim was designed for Unix-like systems, and internally, it stores messages
33335 using the system's convention of a single LF as a line terminator. When
33336 receiving a message, all line endings are translated to this standard format.
33337 Originally, it was thought that programs that passed messages directly to an
33338 MTA within an operating system would use that system's convention. Experience
33339 has shown that this is not the case; for example, there are Unix applications
33340 that use CRLF in this circumstance. For this reason, and for compatibility with
33341 other MTAs, the way Exim handles line endings for all messages is now as
33342 follows:
33343
33344 .ilist
33345 LF not preceded by CR is treated as a line ending.
33346 .next
33347 CR is treated as a line ending; if it is immediately followed by LF, the LF
33348 is ignored.
33349 .next
33350 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33351 nor a local message in the state where a line containing only a dot is a
33352 terminator.
33353 .next
33354 If a bare CR is encountered within a header line, an extra space is added after
33355 the line terminator so as not to end the header line. The reasoning behind this
33356 is that bare CRs in header lines are most likely either to be mistakes, or
33357 people trying to play silly games.
33358 .next
33359 If the first header line received in a message ends with CRLF, a subsequent
33360 bare LF in a header line is treated in the same way as a bare CR in a header
33361 line.
33362 .endlist
33363
33364
33365
33366
33367
33368 .section "Unqualified addresses" "SECID218"
33369 .cindex "unqualified addresses"
33370 .cindex "address" "qualification"
33371 By default, Exim expects every envelope address it receives from an external
33372 host to be fully qualified. Unqualified addresses cause negative responses to
33373 SMTP commands. However, because SMTP is used as a means of transporting
33374 messages from MUAs running on personal workstations, there is sometimes a
33375 requirement to accept unqualified addresses from specific hosts or IP networks.
33376
33377 Exim has two options that separately control which hosts may send unqualified
33378 sender or recipient addresses in SMTP commands, namely
33379 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33380 cases, if an unqualified address is accepted, it is qualified by adding the
33381 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33382
33383 .oindex "&%qualify_domain%&"
33384 .oindex "&%qualify_recipient%&"
33385 Unqualified addresses in header lines are automatically qualified for messages
33386 that are locally originated, unless the &%-bnq%& option is given on the command
33387 line. For messages received over SMTP, unqualified addresses in header lines
33388 are qualified only if unqualified addresses are permitted in SMTP commands. In
33389 other words, such qualification is also controlled by
33390 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33391
33392
33393
33394
33395 .section "The UUCP From line" "SECID219"
33396 .cindex "&""From""& line"
33397 .cindex "UUCP" "&""From""& line"
33398 .cindex "sender" "address"
33399 .oindex "&%uucp_from_pattern%&"
33400 .oindex "&%uucp_from_sender%&"
33401 .cindex "envelope sender"
33402 .cindex "Sendmail compatibility" "&""From""& line"
33403 Messages that have come from UUCP (and some other applications) often begin
33404 with a line containing the envelope sender and a timestamp, following the word
33405 &"From"&. Examples of two common formats are:
33406 .code
33407 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33408 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33409 .endd
33410 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33411 Exim recognizes such lines at the start of messages that are submitted to it
33412 via the command line (that is, on the standard input). It does not recognize
33413 such lines in incoming SMTP messages, unless the sending host matches
33414 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33415 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33416 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33417 default value matches the two common cases shown above and puts the address
33418 that follows &"From"& into &$1$&.
33419
33420 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33421 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33422 a trusted user, the message's sender address is constructed by expanding the
33423 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33424 then parsed as an RFC 2822 address. If there is no domain, the local part is
33425 qualified with &%qualify_domain%& unless it is the empty string. However, if
33426 the command line &%-f%& option is used, it overrides the &"From"& line.
33427
33428 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33429 sender address is not changed. This is also the case for incoming SMTP messages
33430 that are permitted to contain &"From"& lines.
33431
33432 Only one &"From"& line is recognized. If there is more than one, the second is
33433 treated as a data line that starts the body of the message, as it is not valid
33434 as a header line. This also happens if a &"From"& line is present in an
33435 incoming SMTP message from a source that is not permitted to send them.
33436
33437
33438
33439 .section "Resent- header lines" "SECID220"
33440 .cindex "&%Resent-%& header lines"
33441 .cindex "header lines" "Resent-"
33442 RFC 2822 makes provision for sets of header lines starting with the string
33443 &`Resent-`& to be added to a message when it is resent by the original
33444 recipient to somebody else. These headers are &'Resent-Date:'&,
33445 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33446 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33447
33448 .blockquote
33449 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33450 processing of replies or other such automatic actions on messages.'&
33451 .endblockquote
33452
33453 This leaves things a bit vague as far as other processing actions such as
33454 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33455 follows:
33456
33457 .ilist
33458 A &'Resent-From:'& line that just contains the login id of the submitting user
33459 is automatically rewritten in the same way as &'From:'& (see below).
33460 .next
33461 If there's a rewriting rule for a particular header line, it is also applied to
33462 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33463 &'From:'& also rewrites &'Resent-From:'&.
33464 .next
33465 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33466 also removed.
33467 .next
33468 For a locally-submitted message,
33469 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33470 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33471 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33472 included in log lines in this case.
33473 .next
33474 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33475 &%Resent-%& header lines are present.
33476 .endlist
33477
33478
33479
33480
33481 .section "The Auto-Submitted: header line" "SECID221"
33482 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33483 includes the header line:
33484 .code
33485 Auto-Submitted: auto-replied
33486 .endd
33487
33488 .section "The Bcc: header line" "SECID222"
33489 .cindex "&'Bcc:'& header line"
33490 If Exim is called with the &%-t%& option, to take recipient addresses from a
33491 message's header, it removes any &'Bcc:'& header line that may exist (after
33492 extracting its addresses). If &%-t%& is not present on the command line, any
33493 existing &'Bcc:'& is not removed.
33494
33495
33496 .section "The Date: header line" "SECID223"
33497 .cindex "&'Date:'& header line"
33498 .cindex "header lines" "Date:"
33499 If a locally-generated or submission-mode message has no &'Date:'& header line,
33500 Exim adds one, using the current date and time, unless the
33501 &%suppress_local_fixups%& control has been specified.
33502
33503 .section "The Delivery-date: header line" "SECID224"
33504 .cindex "&'Delivery-date:'& header line"
33505 .oindex "&%delivery_date_remove%&"
33506 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33507 set. Exim can be configured to add them to the final delivery of messages. (See
33508 the generic &%delivery_date_add%& transport option.) They should not be present
33509 in messages in transit. If the &%delivery_date_remove%& configuration option is
33510 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33511 messages.
33512
33513
33514 .section "The Envelope-to: header line" "SECID225"
33515 .cindex "&'Envelope-to:'& header line"
33516 .cindex "header lines" "Envelope-to:"
33517 .oindex "&%envelope_to_remove%&"
33518 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33519 Exim can be configured to add them to the final delivery of messages. (See the
33520 generic &%envelope_to_add%& transport option.) They should not be present in
33521 messages in transit. If the &%envelope_to_remove%& configuration option is set
33522 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33523 messages.
33524
33525
33526 .section "The From: header line" "SECTthefrohea"
33527 .cindex "&'From:'& header line"
33528 .cindex "header lines" "From:"
33529 .cindex "Sendmail compatibility" "&""From""& line"
33530 .cindex "message" "submission"
33531 .cindex "submission mode"
33532 If a submission-mode message does not contain a &'From:'& header line, Exim
33533 adds one if either of the following conditions is true:
33534
33535 .ilist
33536 The envelope sender address is not empty (that is, this is not a bounce
33537 message). The added header line copies the envelope sender address.
33538 .next
33539 .vindex "&$authenticated_id$&"
33540 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33541 .olist
33542 .vindex "&$qualify_domain$&"
33543 If no domain is specified by the submission control, the local part is
33544 &$authenticated_id$& and the domain is &$qualify_domain$&.
33545 .next
33546 If a non-empty domain is specified by the submission control, the local
33547 part is &$authenticated_id$&, and the domain is the specified domain.
33548 .next
33549 If an empty domain is specified by the submission control,
33550 &$authenticated_id$& is assumed to be the complete address.
33551 .endlist
33552 .endlist
33553
33554 A non-empty envelope sender takes precedence.
33555
33556 If a locally-generated incoming message does not contain a &'From:'& header
33557 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33558 containing the sender's address. The calling user's login name and full name
33559 are used to construct the address, as described in section &<<SECTconstr>>&.
33560 They are obtained from the password data by calling &[getpwuid()]& (but see the
33561 &%unknown_login%& configuration option). The address is qualified with
33562 &%qualify_domain%&.
33563
33564 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33565 &'From:'& header line containing just the unqualified login name of the calling
33566 user, this is replaced by an address containing the user's login name and full
33567 name as described in section &<<SECTconstr>>&.
33568
33569
33570 .section "The Message-ID: header line" "SECID226"
33571 .cindex "&'Message-ID:'& header line"
33572 .cindex "header lines" "Message-ID:"
33573 .cindex "message" "submission"
33574 .oindex "&%message_id_header_text%&"
33575 If a locally-generated or submission-mode incoming message does not contain a
33576 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33577 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33578 to the message. If there are any &'Resent-:'& headers in the message, it
33579 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33580 message id, preceded by the letter E to ensure it starts with a letter, and
33581 followed by @ and the primary host name. Additional information can be included
33582 in this header line by setting the &%message_id_header_text%& and/or
33583 &%message_id_header_domain%& options.
33584
33585
33586 .section "The Received: header line" "SECID227"
33587 .cindex "&'Received:'& header line"
33588 .cindex "header lines" "Received:"
33589 A &'Received:'& header line is added at the start of every message. The
33590 contents are defined by the &%received_header_text%& configuration option, and
33591 Exim automatically adds a semicolon and a timestamp to the configured string.
33592
33593 The &'Received:'& header is generated as soon as the message's header lines
33594 have been received. At this stage, the timestamp in the &'Received:'& header
33595 line is the time that the message started to be received. This is the value
33596 that is seen by the DATA ACL and by the &[local_scan()]& function.
33597
33598 Once a message is accepted, the timestamp in the &'Received:'& header line is
33599 changed to the time of acceptance, which is (apart from a small delay while the
33600 -H spool file is written) the earliest time at which delivery could start.
33601
33602
33603 .section "The References: header line" "SECID228"
33604 .cindex "&'References:'& header line"
33605 .cindex "header lines" "References:"
33606 Messages created by the &(autoreply)& transport include a &'References:'&
33607 header line. This is constructed according to the rules that are described in
33608 section 3.64 of RFC 2822 (which states that replies should contain such a
33609 header line), and section 3.14 of RFC 3834 (which states that automatic
33610 responses are not different in this respect). However, because some mail
33611 processing software does not cope well with very long header lines, no more
33612 than 12 message IDs are copied from the &'References:'& header line in the
33613 incoming message. If there are more than 12, the first one and then the final
33614 11 are copied, before adding the message ID of the incoming message.
33615
33616
33617
33618 .section "The Return-path: header line" "SECID229"
33619 .cindex "&'Return-path:'& header line"
33620 .cindex "header lines" "Return-path:"
33621 .oindex "&%return_path_remove%&"
33622 &'Return-path:'& header lines are defined as something an MTA may insert when
33623 it does the final delivery of messages. (See the generic &%return_path_add%&
33624 transport option.) Therefore, they should not be present in messages in
33625 transit. If the &%return_path_remove%& configuration option is set (the
33626 default), Exim removes &'Return-path:'& header lines from incoming messages.
33627
33628
33629
33630 .section "The Sender: header line" "SECTthesenhea"
33631 .cindex "&'Sender:'& header line"
33632 .cindex "message" "submission"
33633 .cindex "header lines" "Sender:"
33634 For a locally-originated message from an untrusted user, Exim may remove an
33635 existing &'Sender:'& header line, and it may add a new one. You can modify
33636 these actions by setting the &%local_sender_retain%& option true, the
33637 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33638 control setting.
33639
33640 When a local message is received from an untrusted user and
33641 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33642 control has not been set, a check is made to see if the address given in the
33643 &'From:'& header line is the correct (local) sender of the message. The address
33644 that is expected has the login name as the local part and the value of
33645 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33646 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33647 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33648 line is added to the message.
33649
33650 If you set &%local_from_check%& false, this checking does not occur. However,
33651 the removal of an existing &'Sender:'& line still happens, unless you also set
33652 &%local_sender_retain%& to be true. It is not possible to set both of these
33653 options true at the same time.
33654
33655 .cindex "submission mode"
33656 By default, no processing of &'Sender:'& header lines is done for messages
33657 received over TCP/IP or for messages submitted by trusted users. However, when
33658 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33659 not specified on the submission control, the following processing takes place:
33660
33661 .vindex "&$authenticated_id$&"
33662 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33663 authenticated, and &$authenticated_id$& is not empty, a sender address is
33664 created as follows:
33665
33666 .ilist
33667 .vindex "&$qualify_domain$&"
33668 If no domain is specified by the submission control, the local part is
33669 &$authenticated_id$& and the domain is &$qualify_domain$&.
33670 .next
33671 If a non-empty domain is specified by the submission control, the local part
33672 is &$authenticated_id$&, and the domain is the specified domain.
33673 .next
33674 If an empty domain is specified by the submission control,
33675 &$authenticated_id$& is assumed to be the complete address.
33676 .endlist
33677
33678 This address is compared with the address in the &'From:'& header line. If they
33679 are different, a &'Sender:'& header line containing the created address is
33680 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33681 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33682
33683 .cindex "return path" "created from &'Sender:'&"
33684 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33685 the message (the envelope sender address) is changed to be the same address,
33686 except in the case of submission mode when &%sender_retain%& is specified.
33687
33688
33689
33690 .section "Adding and removing header lines in routers and transports" &&&
33691          "SECTheadersaddrem"
33692 .cindex "header lines" "adding; in router or transport"
33693 .cindex "header lines" "removing; in router or transport"
33694 When a message is delivered, the addition and removal of header lines can be
33695 specified in a system filter, or on any of the routers and transports that
33696 process the message. Section &<<SECTaddremheasys>>& contains details about
33697 modifying headers in a system filter. Header lines can also be added in an ACL
33698 as a message is received (see section &<<SECTaddheadacl>>&).
33699
33700 In contrast to what happens in a system filter, header modifications that are
33701 specified on routers and transports apply only to the particular recipient
33702 addresses that are being processed by those routers and transports. These
33703 changes do not actually take place until a copy of the message is being
33704 transported. Therefore, they do not affect the basic set of header lines, and
33705 they do not affect the values of the variables that refer to header lines.
33706
33707 &*Note*&: In particular, this means that any expansions in the configuration of
33708 the transport cannot refer to the modified header lines, because such
33709 expansions all occur before the message is actually transported.
33710
33711 For both routers and transports, the argument of a &%headers_add%&
33712 option must be in the form of one or more RFC 2822 header lines, separated by
33713 newlines (coded as &"\n"&). For example:
33714 .code
33715 headers_add = X-added-header: added by $primary_hostname\n\
33716               X-added-second: another added header line
33717 .endd
33718 Exim does not check the syntax of these added header lines.
33719
33720 Multiple &%headers_add%& options for a single router or transport can be
33721 specified; the values will append to a single list of header lines.
33722 Each header-line is separately expanded.
33723
33724 The argument of a &%headers_remove%& option must consist of a colon-separated
33725 list of header names. This is confusing, because header names themselves are
33726 often terminated by colons. In this case, the colons are the list separators,
33727 not part of the names. For example:
33728 .code
33729 headers_remove = return-receipt-to:acknowledge-to
33730 .endd
33731
33732 Multiple &%headers_remove%& options for a single router or transport can be
33733 specified; the arguments will append to a single header-names list.
33734 Each item is separately expanded.
33735 Note that colons in complex expansions which are used to
33736 form all or part of a &%headers_remove%& list
33737 will act as list separators.
33738
33739 When &%headers_add%& or &%headers_remove%& is specified on a router,
33740 items are expanded at routing time,
33741 and then associated with all addresses that are
33742 accepted by that router, and also with any new addresses that it generates. If
33743 an address passes through several routers as a result of aliasing or
33744 forwarding, the changes are cumulative.
33745
33746 .oindex "&%unseen%&"
33747 However, this does not apply to multiple routers that result from the use of
33748 the &%unseen%& option. Any header modifications that were specified by the
33749 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33750
33751 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33752 settings cannot be delivered together in a batch, so a transport is always
33753 dealing with a set of addresses that have the same header-processing
33754 requirements.
33755
33756 The transport starts by writing the original set of header lines that arrived
33757 with the message, possibly modified by the system filter. As it writes out
33758 these lines, it consults the list of header names that were attached to the
33759 recipient address(es) by &%headers_remove%& options in routers, and it also
33760 consults the transport's own &%headers_remove%& option. Header lines whose
33761 names are on either of these lists are not written out. If there are multiple
33762 instances of any listed header, they are all skipped.
33763
33764 After the remaining original header lines have been written, new header
33765 lines that were specified by routers' &%headers_add%& options are written, in
33766 the order in which they were attached to the address. These are followed by any
33767 header lines specified by the transport's &%headers_add%& option.
33768
33769 This way of handling header line modifications in routers and transports has
33770 the following consequences:
33771
33772 .ilist
33773 The original set of header lines, possibly modified by the system filter,
33774 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33775 to it, at all times.
33776 .next
33777 Header lines that are added by a router's
33778 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33779 expansion syntax in subsequent routers or the transport.
33780 .next
33781 Conversely, header lines that are specified for removal by &%headers_remove%&
33782 in a router remain visible to subsequent routers and the transport.
33783 .next
33784 Headers added to an address by &%headers_add%& in a router cannot be removed by
33785 a later router or by a transport.
33786 .next
33787 An added header can refer to the contents of an original header that is to be
33788 removed, even it has the same name as the added header. For example:
33789 .code
33790 headers_remove = subject
33791 headers_add = Subject: new subject (was: $h_subject:)
33792 .endd
33793 .endlist
33794
33795 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33796 for a &(redirect)& router that has the &%one_time%& option set.
33797
33798
33799
33800
33801
33802 .section "Constructed addresses" "SECTconstr"
33803 .cindex "address" "constructed"
33804 .cindex "constructed address"
33805 When Exim constructs a sender address for a locally-generated message, it uses
33806 the form
33807 .display
33808 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33809 .endd
33810 For example:
33811 .code
33812 Zaphod Beeblebrox <zaphod@end.univ.example>
33813 .endd
33814 The user name is obtained from the &%-F%& command line option if set, or
33815 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33816 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33817 ampersand character, this is replaced by the login name with the first letter
33818 upper cased, as is conventional in a number of operating systems. See the
33819 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33820 The &%unknown_username%& option can be used to specify user names in cases when
33821 there is no password file entry.
33822
33823 .cindex "RFC 2047"
33824 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33825 parts of it if necessary. In addition, if it contains any non-printing
33826 characters, it is encoded as described in RFC 2047, which defines a way of
33827 including non-ASCII characters in header lines. The value of the
33828 &%headers_charset%& option specifies the name of the encoding that is used (the
33829 characters are assumed to be in this encoding). The setting of
33830 &%print_topbitchars%& controls whether characters with the top bit set (that
33831 is, with codes greater than 127) count as printing characters or not.
33832
33833
33834
33835 .section "Case of local parts" "SECID230"
33836 .cindex "case of local parts"
33837 .cindex "local part" "case of"
33838 RFC 2822 states that the case of letters in the local parts of addresses cannot
33839 be assumed to be non-significant. Exim preserves the case of local parts of
33840 addresses, but by default it uses a lower-cased form when it is routing,
33841 because on most Unix systems, usernames are in lower case and case-insensitive
33842 routing is required. However, any particular router can be made to use the
33843 original case for local parts by setting the &%caseful_local_part%& generic
33844 router option.
33845
33846 .cindex "mixed-case login names"
33847 If you must have mixed-case user names on your system, the best way to proceed,
33848 assuming you want case-independent handling of incoming email, is to set up
33849 your first router to convert incoming local parts in your domains to the
33850 correct case by means of a file lookup. For example:
33851 .code
33852 correct_case:
33853   driver = redirect
33854   domains = +local_domains
33855   data = ${lookup{$local_part}cdb\
33856               {/etc/usercased.cdb}{$value}fail}\
33857               @$domain
33858 .endd
33859 For this router, the local part is forced to lower case by the default action
33860 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33861 up a new local part in the correct case. If you then set &%caseful_local_part%&
33862 on any subsequent routers which process your domains, they will operate on
33863 local parts with the correct case in a case-sensitive manner.
33864
33865
33866
33867 .section "Dots in local parts" "SECID231"
33868 .cindex "dot" "in local part"
33869 .cindex "local part" "dots in"
33870 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33871 part may not begin or end with a dot, nor have two consecutive dots in the
33872 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33873 empty components for compatibility.
33874
33875
33876
33877 .section "Rewriting addresses" "SECID232"
33878 .cindex "rewriting" "addresses"
33879 Rewriting of sender and recipient addresses, and addresses in headers, can
33880 happen automatically, or as the result of configuration options, as described
33881 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33882 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33883
33884 Automatic rewriting includes qualification, as mentioned above. The other case
33885 in which it can happen is when an incomplete non-local domain is given. The
33886 routing process may cause this to be expanded into the full domain name. For
33887 example, a header such as
33888 .code
33889 To: hare@teaparty
33890 .endd
33891 might get rewritten as
33892 .code
33893 To: hare@teaparty.wonderland.fict.example
33894 .endd
33895 Rewriting as a result of routing is the one kind of message processing that
33896 does not happen at input time, as it cannot be done until the address has
33897 been routed.
33898
33899 Strictly, one should not do &'any'& deliveries of a message until all its
33900 addresses have been routed, in case any of the headers get changed as a
33901 result of routing. However, doing this in practice would hold up many
33902 deliveries for unreasonable amounts of time, just because one address could not
33903 immediately be routed. Exim therefore does not delay other deliveries when
33904 routing of one or more addresses is deferred.
33905 .ecindex IIDmesproc
33906
33907
33908
33909 . ////////////////////////////////////////////////////////////////////////////
33910 . ////////////////////////////////////////////////////////////////////////////
33911
33912 .chapter "SMTP processing" "CHAPSMTP"
33913 .scindex IIDsmtpproc1 "SMTP" "processing details"
33914 .scindex IIDsmtpproc2 "LMTP" "processing details"
33915 Exim supports a number of different ways of using the SMTP protocol, and its
33916 LMTP variant, which is an interactive protocol for transferring messages into a
33917 closed mail store application. This chapter contains details of how SMTP is
33918 processed. For incoming mail, the following are available:
33919
33920 .ilist
33921 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33922 .next
33923 SMTP over the standard input and output (the &%-bs%& option);
33924 .next
33925 Batched SMTP on the standard input (the &%-bS%& option).
33926 .endlist
33927
33928 For mail delivery, the following are available:
33929
33930 .ilist
33931 SMTP over TCP/IP (the &(smtp)& transport);
33932 .next
33933 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33934 &"lmtp"&);
33935 .next
33936 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33937 transport);
33938 .next
33939 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33940 the &%use_bsmtp%& option set).
33941 .endlist
33942
33943 &'Batched SMTP'& is the name for a process in which batches of messages are
33944 stored in or read from files (or pipes), in a format in which SMTP commands are
33945 used to contain the envelope information.
33946
33947
33948
33949 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33950 .cindex "SMTP" "outgoing over TCP/IP"
33951 .cindex "outgoing SMTP over TCP/IP"
33952 .cindex "LMTP" "over TCP/IP"
33953 .cindex "outgoing LMTP over TCP/IP"
33954 .cindex "EHLO"
33955 .cindex "HELO"
33956 .cindex "SIZE option on MAIL command"
33957 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33958 The &%protocol%& option selects which protocol is to be used, but the actual
33959 processing is the same in both cases.
33960
33961 If, in response to its EHLO command, Exim is told that the SIZE
33962 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33963 command. The value of <&'n'&> is the message size plus the value of the
33964 &%size_addition%& option (default 1024) to allow for additions to the message
33965 such as per-transport header lines, or changes made in a
33966 .cindex "transport" "filter"
33967 .cindex "filter" "transport filter"
33968 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33969 suppressed.
33970
33971 If the remote server advertises support for PIPELINING, Exim uses the
33972 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33973 required for the transaction.
33974
33975 If the remote server advertises support for the STARTTLS command, and Exim
33976 was built to support TLS encryption, it tries to start a TLS session unless the
33977 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33978 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33979 is called for verification.
33980
33981 If the remote server advertises support for the AUTH command, Exim scans
33982 the authenticators configuration for any suitable client settings, as described
33983 in chapter &<<CHAPSMTPAUTH>>&.
33984
33985 .cindex "carriage return"
33986 .cindex "linefeed"
33987 Responses from the remote host are supposed to be terminated by CR followed by
33988 LF. However, there are known to be hosts that do not send CR characters, so in
33989 order to be able to interwork with such hosts, Exim treats LF on its own as a
33990 line terminator.
33991
33992 If a message contains a number of different addresses, all those with the same
33993 characteristics (for example, the same envelope sender) that resolve to the
33994 same set of hosts, in the same order, are sent in a single SMTP transaction,
33995 even if they are for different domains, unless there are more than the setting
33996 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33997 they are split into groups containing no more than &%max_rcpt%&s addresses
33998 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33999 in parallel sessions. The order of hosts with identical MX values is not
34000 significant when checking whether addresses can be batched in this way.
34001
34002 When the &(smtp)& transport suffers a temporary failure that is not
34003 message-related, Exim updates its transport-specific database, which contains
34004 records indexed by host name that remember which messages are waiting for each
34005 particular host. It also updates the retry database with new retry times.
34006
34007 .cindex "hints database" "retry keys"
34008 Exim's retry hints are based on host name plus IP address, so if one address of
34009 a multi-homed host is broken, it will soon be skipped most of the time.
34010 See the next section for more detail about error handling.
34011
34012 .cindex "SMTP" "passed connection"
34013 .cindex "SMTP" "batching over TCP/IP"
34014 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34015 looks in the hints database for the transport to see if there are any queued
34016 messages waiting for the host to which it is connected. If it finds one, it
34017 creates a new Exim process using the &%-MC%& option (which can only be used by
34018 a process running as root or the Exim user) and passes the TCP/IP socket to it
34019 so that it can deliver another message using the same socket. The new process
34020 does only those deliveries that are routed to the connected host, and may in
34021 turn pass the socket on to a third process, and so on.
34022
34023 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34024 limit the number of messages sent down a single TCP/IP connection.
34025
34026 .cindex "asterisk" "after IP address"
34027 The second and subsequent messages delivered down an existing connection are
34028 identified in the main log by the addition of an asterisk after the closing
34029 square bracket of the IP address.
34030
34031
34032
34033
34034 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34035 .cindex "error" "in outgoing SMTP"
34036 .cindex "SMTP" "errors in outgoing"
34037 .cindex "host" "error"
34038 Three different kinds of error are recognized for outgoing SMTP: host errors,
34039 message errors, and recipient errors.
34040
34041 .vlist
34042 .vitem "&*Host errors*&"
34043 A host error is not associated with a particular message or with a
34044 particular recipient of a message. The host errors are:
34045
34046 .ilist
34047 Connection refused or timed out,
34048 .next
34049 Any error response code on connection,
34050 .next
34051 Any error response code to EHLO or HELO,
34052 .next
34053 Loss of connection at any time, except after &"."&,
34054 .next
34055 I/O errors at any time,
34056 .next
34057 Timeouts during the session, other than in response to MAIL, RCPT or
34058 the &"."& at the end of the data.
34059 .endlist ilist
34060
34061 For a host error, a permanent error response on connection, or in response to
34062 EHLO, causes all addresses routed to the host to be failed. Any other host
34063 error causes all addresses to be deferred, and retry data to be created for the
34064 host. It is not tried again, for any message, until its retry time arrives. If
34065 the current set of addresses are not all delivered in this run (to some
34066 alternative host), the message is added to the list of those waiting for this
34067 host, so if it is still undelivered when a subsequent successful delivery is
34068 made to the host, it will be sent down the same SMTP connection.
34069
34070 .vitem "&*Message errors*&"
34071 .cindex "message" "error"
34072 A message error is associated with a particular message when sent to a
34073 particular host, but not with a particular recipient of the message. The
34074 message errors are:
34075
34076 .ilist
34077 Any error response code to MAIL, DATA, or the &"."& that terminates
34078 the data,
34079 .next
34080 Timeout after MAIL,
34081 .next
34082 Timeout or loss of connection after the &"."& that terminates the data. A
34083 timeout after the DATA command itself is treated as a host error, as is loss of
34084 connection at any other time.
34085 .endlist ilist
34086
34087 For a message error, a permanent error response (5&'xx'&) causes all addresses
34088 to be failed, and a delivery error report to be returned to the sender. A
34089 temporary error response (4&'xx'&), or one of the timeouts, causes all
34090 addresses to be deferred. Retry data is not created for the host, but instead,
34091 a retry record for the combination of host plus message id is created. The
34092 message is not added to the list of those waiting for this host. This ensures
34093 that the failing message will not be sent to this host again until the retry
34094 time arrives. However, other messages that are routed to the host are not
34095 affected, so if it is some property of the message that is causing the error,
34096 it will not stop the delivery of other mail.
34097
34098 If the remote host specified support for the SIZE parameter in its response
34099 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34100 over-large message will cause a message error because the error arrives as a
34101 response to MAIL.
34102
34103 .vitem "&*Recipient errors*&"
34104 .cindex "recipient" "error"
34105 A recipient error is associated with a particular recipient of a message. The
34106 recipient errors are:
34107
34108 .ilist
34109 Any error response to RCPT,
34110 .next
34111 Timeout after RCPT.
34112 .endlist
34113
34114 For a recipient error, a permanent error response (5&'xx'&) causes the
34115 recipient address to be failed, and a bounce message to be returned to the
34116 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34117 address to be deferred, and routing retry data to be created for it. This is
34118 used to delay processing of the address in subsequent queue runs, until its
34119 routing retry time arrives. This applies to all messages, but because it
34120 operates only in queue runs, one attempt will be made to deliver a new message
34121 to the failing address before the delay starts to operate. This ensures that,
34122 if the failure is really related to the message rather than the recipient
34123 (&"message too big for this recipient"& is a possible example), other messages
34124 have a chance of getting delivered. If a delivery to the address does succeed,
34125 the retry information gets cleared, so all stuck messages get tried again, and
34126 the retry clock is reset.
34127
34128 The message is not added to the list of those waiting for this host. Use of the
34129 host for other messages is unaffected, and except in the case of a timeout,
34130 other recipients are processed independently, and may be successfully delivered
34131 in the current SMTP session. After a timeout it is of course impossible to
34132 proceed with the session, so all addresses get deferred. However, those other
34133 than the one that failed do not suffer any subsequent retry delays. Therefore,
34134 if one recipient is causing trouble, the others have a chance of getting
34135 through when a subsequent delivery attempt occurs before the failing
34136 recipient's retry time.
34137 .endlist
34138
34139 In all cases, if there are other hosts (or IP addresses) available for the
34140 current set of addresses (for example, from multiple MX records), they are
34141 tried in this run for any undelivered addresses, subject of course to their
34142 own retry data. In other words, recipient error retry data does not take effect
34143 until the next delivery attempt.
34144
34145 Some hosts have been observed to give temporary error responses to every
34146 MAIL command at certain times (&"insufficient space"& has been seen). It
34147 would be nice if such circumstances could be recognized, and defer data for the
34148 host itself created, but this is not possible within the current Exim design.
34149 What actually happens is that retry data for every (host, message) combination
34150 is created.
34151
34152 The reason that timeouts after MAIL and RCPT are treated specially is that
34153 these can sometimes arise as a result of the remote host's verification
34154 procedures. Exim makes this assumption, and treats them as if a temporary error
34155 response had been received. A timeout after &"."& is treated specially because
34156 it is known that some broken implementations fail to recognize the end of the
34157 message if the last character of the last line is a binary zero. Thus, it is
34158 helpful to treat this case as a message error.
34159
34160 Timeouts at other times are treated as host errors, assuming a problem with the
34161 host, or the connection to it. If a timeout after MAIL, RCPT,
34162 or &"."& is really a connection problem, the assumption is that at the next try
34163 the timeout is likely to occur at some other point in the dialogue, causing it
34164 then to be treated as a host error.
34165
34166 There is experimental evidence that some MTAs drop the connection after the
34167 terminating &"."& if they do not like the contents of the message for some
34168 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34169 should be given. That is why Exim treats this case as a message rather than a
34170 host error, in order not to delay other messages to the same host.
34171
34172
34173
34174
34175 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34176 .cindex "SMTP" "incoming over TCP/IP"
34177 .cindex "incoming SMTP over TCP/IP"
34178 .cindex "inetd"
34179 .cindex "daemon"
34180 Incoming SMTP messages can be accepted in one of two ways: by running a
34181 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34182 &_/etc/inetd.conf_& should be like this:
34183 .code
34184 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34185 .endd
34186 Exim distinguishes between this case and the case of a locally running user
34187 agent using the &%-bs%& option by checking whether or not the standard input is
34188 a socket. When it is, either the port must be privileged (less than 1024), or
34189 the caller must be root or the Exim user. If any other user passes a socket
34190 with an unprivileged port number, Exim prints a message on the standard error
34191 stream and exits with an error code.
34192
34193 By default, Exim does not make a log entry when a remote host connects or
34194 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34195 unexpected. It can be made to write such log entries by setting the
34196 &%smtp_connection%& log selector.
34197
34198 .cindex "carriage return"
34199 .cindex "linefeed"
34200 Commands from the remote host are supposed to be terminated by CR followed by
34201 LF. However, there are known to be hosts that do not send CR characters. In
34202 order to be able to interwork with such hosts, Exim treats LF on its own as a
34203 line terminator.
34204 Furthermore, because common code is used for receiving messages from all
34205 sources, a CR on its own is also interpreted as a line terminator. However, the
34206 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34207
34208 .cindex "EHLO" "invalid data"
34209 .cindex "HELO" "invalid data"
34210 One area that sometimes gives rise to problems concerns the EHLO or
34211 HELO commands. Some clients send syntactically invalid versions of these
34212 commands, which Exim rejects by default. (This is nothing to do with verifying
34213 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34214 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34215 match the broken hosts that send invalid commands.
34216
34217 .cindex "SIZE option on MAIL command"
34218 .cindex "MAIL" "SIZE option"
34219 The amount of disk space available is checked whenever SIZE is received on
34220 a MAIL command, independently of whether &%message_size_limit%& or
34221 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34222 false. A temporary error is given if there is not enough space. If
34223 &%check_spool_space%& is set, the check is for that amount of space plus the
34224 value given with SIZE, that is, it checks that the addition of the incoming
34225 message will not reduce the space below the threshold.
34226
34227 When a message is successfully received, Exim includes the local message id in
34228 its response to the final &"."& that terminates the data. If the remote host
34229 logs this text it can help with tracing what has happened to a message.
34230
34231 The Exim daemon can limit the number of simultaneous incoming connections it is
34232 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34233 number of simultaneous incoming connections from a single remote host (see the
34234 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34235 rejected using the SMTP temporary error code 421.
34236
34237 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34238 subprocess has finished, as this can get lost at busy times. Instead, it looks
34239 for completed subprocesses every time it wakes up. Provided there are other
34240 things happening (new incoming calls, starts of queue runs), completed
34241 processes will be noticed and tidied away. On very quiet systems you may
34242 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34243 it will be noticed when the daemon next wakes up.
34244
34245 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34246 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34247 high system load &-- for details see the &%smtp_accept_reserve%&,
34248 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34249 applies in both the daemon and &'inetd'& cases.
34250
34251 Exim normally starts a delivery process for each message received, though this
34252 can be varied by means of the &%-odq%& command line option and the
34253 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34254 number of simultaneously running delivery processes started in this way from
34255 SMTP input can be limited by the &%smtp_accept_queue%& and
34256 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34257 subsequently received messages are just put on the input queue without starting
34258 a delivery process.
34259
34260 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34261 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34262 started up from the &'inetd'& daemon, because in that case each connection is
34263 handled by an entirely independent Exim process. Control by load average is,
34264 however, available with &'inetd'&.
34265
34266 Exim can be configured to verify addresses in incoming SMTP commands as they
34267 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34268 to rewrite addresses at this time &-- before any syntax checking is done. See
34269 section &<<SECTrewriteS>>&.
34270
34271 Exim can also be configured to limit the rate at which a client host submits
34272 MAIL and RCPT commands in a single SMTP session. See the
34273 &%smtp_ratelimit_hosts%& option.
34274
34275
34276
34277 .section "Unrecognized SMTP commands" "SECID234"
34278 .cindex "SMTP" "unrecognized commands"
34279 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34280 commands during a single SMTP connection, it drops the connection after sending
34281 the error response to the last command. The default value for
34282 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34283 abuse that subvert web servers into making connections to SMTP ports; in these
34284 circumstances, a number of non-SMTP lines are sent first.
34285
34286
34287 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34288 .cindex "SMTP" "syntax errors"
34289 .cindex "SMTP" "protocol errors"
34290 A syntax error is detected if an SMTP command is recognized, but there is
34291 something syntactically wrong with its data, for example, a malformed email
34292 address in a RCPT command. Protocol errors include invalid command
34293 sequencing such as RCPT before MAIL. If Exim receives more than
34294 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34295 drops the connection after sending the error response to the last command. The
34296 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34297 broken clients that loop sending bad commands (yes, it has been seen).
34298
34299
34300
34301 .section "Use of non-mail SMTP commands" "SECID236"
34302 .cindex "SMTP" "non-mail commands"
34303 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34304 DATA. Exim counts such commands, and drops the connection if there are too
34305 many of them in a single SMTP session. This action catches some
34306 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34307 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34308 defines what &"too many"& means. Its default value is 10.
34309
34310 When a new message is expected, one occurrence of RSET is not counted. This
34311 allows a client to send one RSET between messages (this is not necessary,
34312 but some clients do it). Exim also allows one uncounted occurrence of HELO
34313 or EHLO, and one occurrence of STARTTLS between messages. After
34314 starting up a TLS session, another EHLO is expected, and so it too is not
34315 counted.
34316
34317 The first occurrence of AUTH in a connection, or immediately following
34318 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34319 RCPT, DATA, and QUIT are counted.
34320
34321 You can control which hosts are subject to the limit set by
34322 &%smtp_accept_max_nonmail%& by setting
34323 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34324 the limit apply to all hosts. This option means that you can exclude any
34325 specific badly-behaved hosts that you have to live with.
34326
34327
34328
34329
34330 .section "The VRFY and EXPN commands" "SECID237"
34331 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34332 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34333 appropriate) in order to decide whether the command should be accepted or not.
34334
34335 .cindex "VRFY" "processing"
34336 When no ACL is defined for VRFY, or if it rejects without
34337 setting an explicit response code, the command is accepted
34338 (with a 252 SMTP response code)
34339 in order to support awkward clients that do a VRFY before every RCPT.
34340 When VRFY is accepted, it runs exactly the same code as when Exim is
34341 called with the &%-bv%& option, and returns 250/451/550
34342 SMTP response codes.
34343
34344 .cindex "EXPN" "processing"
34345 If no ACL for EXPN is defined, the command is rejected.
34346 When EXPN is accepted, a single-level expansion of the address is done.
34347 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34348 than a verification (the &%-bv%& option). If an unqualified local part is given
34349 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34350 of VRFY and EXPN commands are logged on the main and reject logs, and
34351 VRFY verification failures are logged on the main log for consistency with
34352 RCPT failures.
34353
34354
34355
34356 .section "The ETRN command" "SECTETRN"
34357 .cindex "ETRN" "processing"
34358 RFC 1985 describes an SMTP command called ETRN that is designed to
34359 overcome the security problems of the TURN command (which has fallen into
34360 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34361 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34362 should be accepted or not. If no ACL is defined, the command is rejected.
34363
34364 The ETRN command is concerned with &"releasing"& messages that are awaiting
34365 delivery to certain hosts. As Exim does not organize its message queue by host,
34366 the only form of ETRN that is supported by default is the one where the
34367 text starts with the &"#"& prefix, in which case the remainder of the text is
34368 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34369 the &%-R%& option to happen, with the remainder of the ETRN text as its
34370 argument. For example,
34371 .code
34372 ETRN #brigadoon
34373 .endd
34374 runs the command
34375 .code
34376 exim -R brigadoon
34377 .endd
34378 which causes a delivery attempt on all messages with undelivered addresses
34379 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34380 default), Exim prevents the simultaneous execution of more than one queue run
34381 for the same argument string as a result of an ETRN command. This stops
34382 a misbehaving client from starting more than one queue runner at once.
34383
34384 .cindex "hints database" "ETRN serialization"
34385 Exim implements the serialization by means of a hints database in which a
34386 record is written whenever a process is started by ETRN, and deleted when
34387 the process completes. However, Exim does not keep the SMTP session waiting for
34388 the ETRN process to complete. Once ETRN is accepted, the client is sent
34389 a &"success"& return code. Obviously there is scope for hints records to get
34390 left lying around if there is a system or program crash. To guard against this,
34391 Exim ignores any records that are more than six hours old.
34392
34393 .oindex "&%smtp_etrn_command%&"
34394 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34395 used. This specifies a command that is run whenever ETRN is received,
34396 whatever the form of its argument. For
34397 example:
34398 .code
34399 smtp_etrn_command = /etc/etrn_command $domain \
34400                     $sender_host_address
34401 .endd
34402 .vindex "&$domain$&"
34403 The string is split up into arguments which are independently expanded. The
34404 expansion variable &$domain$& is set to the argument of the ETRN command,
34405 and no syntax checking is done on the contents of this argument. Exim does not
34406 wait for the command to complete, so its status code is not checked. Exim runs
34407 under its own uid and gid when receiving incoming SMTP, so it is not possible
34408 for it to change them before running the command.
34409
34410
34411
34412 .section "Incoming local SMTP" "SECID238"
34413 .cindex "SMTP" "local incoming"
34414 Some user agents use SMTP to pass messages to their local MTA using the
34415 standard input and output, as opposed to passing the envelope on the command
34416 line and writing the message to the standard input. This is supported by the
34417 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34418 messages over TCP/IP (including the use of ACLs), except that the envelope
34419 sender given in a MAIL command is ignored unless the caller is trusted. In
34420 an ACL you can detect this form of SMTP input by testing for an empty host
34421 identification. It is common to have this as the first line in the ACL that
34422 runs for RCPT commands:
34423 .code
34424 accept hosts = :
34425 .endd
34426 This accepts SMTP messages from local processes without doing any other tests.
34427
34428
34429
34430 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34431 .cindex "SMTP" "batched outgoing"
34432 .cindex "batched SMTP output"
34433 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34434 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34435 be output in BSMTP format. No SMTP responses are possible for this form of
34436 delivery. All it is doing is using SMTP commands as a way of transmitting the
34437 envelope along with the message.
34438
34439 The message is written to the file or pipe preceded by the SMTP commands
34440 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34441 the message that start with a dot have an extra dot added. The SMTP command
34442 HELO is not normally used. If it is required, the &%message_prefix%& option
34443 can be used to specify it.
34444
34445 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34446 one recipient address at a time by default. However, you can arrange for them
34447 to handle several addresses at once by setting the &%batch_max%& option. When
34448 this is done for BSMTP, messages may contain multiple RCPT commands. See
34449 chapter &<<CHAPbatching>>& for more details.
34450
34451 .vindex "&$host$&"
34452 When one or more addresses are routed to a BSMTP transport by a router that
34453 sets up a host list, the name of the first host on the list is available to the
34454 transport in the variable &$host$&. Here is an example of such a transport and
34455 router:
34456 .code
34457 begin routers
34458 route_append:
34459   driver = manualroute
34460   transport = smtp_appendfile
34461   route_list = domain.example  batch.host.example
34462
34463 begin transports
34464 smtp_appendfile:
34465   driver = appendfile
34466   directory = /var/bsmtp/$host
34467   batch_max = 1000
34468   use_bsmtp
34469   user = exim
34470 .endd
34471 This causes messages addressed to &'domain.example'& to be written in BSMTP
34472 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34473 message (unless there are more than 1000 recipients).
34474
34475
34476
34477 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34478 .cindex "SMTP" "batched incoming"
34479 .cindex "batched SMTP input"
34480 The &%-bS%& command line option causes Exim to accept one or more messages by
34481 reading SMTP on the standard input, but to generate no responses. If the caller
34482 is trusted, the senders in the MAIL commands are believed; otherwise the
34483 sender is always the caller of Exim. Unqualified senders and receivers are not
34484 rejected (there seems little point) but instead just get qualified. HELO
34485 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34486 as NOOP; QUIT quits.
34487
34488 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34489 ACL is run in the same way as for non-SMTP local input.
34490
34491 If an error is detected while reading a message, including a missing &"."& at
34492 the end, Exim gives up immediately. It writes details of the error to the
34493 standard output in a stylized way that the calling program should be able to
34494 make some use of automatically, for example:
34495 .code
34496 554 Unexpected end of file
34497 Transaction started in line 10
34498 Error detected in line 14
34499 .endd
34500 It writes a more verbose version, for human consumption, to the standard error
34501 file, for example:
34502 .code
34503 An error was detected while processing a file of BSMTP input.
34504 The error message was:
34505
34506 501 '>' missing at end of address
34507
34508 The SMTP transaction started in line 10.
34509 The error was detected in line 12.
34510 The SMTP command at fault was:
34511
34512 rcpt to:<malformed@in.com.plete
34513
34514 1 previous message was successfully processed.
34515 The rest of the batch was abandoned.
34516 .endd
34517 The return code from Exim is zero only if there were no errors. It is 1 if some
34518 messages were accepted before an error was detected, and 2 if no messages were
34519 accepted.
34520 .ecindex IIDsmtpproc1
34521 .ecindex IIDsmtpproc2
34522
34523
34524
34525 . ////////////////////////////////////////////////////////////////////////////
34526 . ////////////////////////////////////////////////////////////////////////////
34527
34528 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34529          "Customizing messages"
34530 When a message fails to be delivered, or remains on the queue for more than a
34531 configured amount of time, Exim sends a message to the original sender, or
34532 to an alternative configured address. The text of these messages is built into
34533 the code of Exim, but it is possible to change it, either by adding a single
34534 string, or by replacing each of the paragraphs by text supplied in a file.
34535
34536 The &'From:'& and &'To:'& header lines are automatically generated; you can
34537 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34538 option. Exim also adds the line
34539 .code
34540 Auto-Submitted: auto-generated
34541 .endd
34542 to all warning and bounce messages,
34543
34544
34545 .section "Customizing bounce messages" "SECID239"
34546 .cindex "customizing" "bounce message"
34547 .cindex "bounce message" "customizing"
34548 If &%bounce_message_text%& is set, its contents are included in the default
34549 message immediately after &"This message was created automatically by mail
34550 delivery software."& The string is not expanded. It is not used if
34551 &%bounce_message_file%& is set.
34552
34553 When &%bounce_message_file%& is set, it must point to a template file for
34554 constructing error messages. The file consists of a series of text items,
34555 separated by lines consisting of exactly four asterisks. If the file cannot be
34556 opened, default text is used and a message is written to the main and panic
34557 logs. If any text item in the file is empty, default text is used for that
34558 item.
34559
34560 .vindex "&$bounce_recipient$&"
34561 .vindex "&$bounce_return_size_limit$&"
34562 Each item of text that is read from the file is expanded, and there are two
34563 expansion variables which can be of use here: &$bounce_recipient$& is set to
34564 the recipient of an error message while it is being created, and
34565 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34566 option, rounded to a whole number.
34567
34568 The items must appear in the file in the following order:
34569
34570 .ilist
34571 The first item is included in the headers, and should include at least a
34572 &'Subject:'& header. Exim does not check the syntax of these headers.
34573 .next
34574 The second item forms the start of the error message. After it, Exim lists the
34575 failing addresses with their error messages.
34576 .next
34577 The third item is used to introduce any text from pipe transports that is to be
34578 returned to the sender. It is omitted if there is no such text.
34579 .next
34580 The fourth, fifth and sixth items will be ignored and may be empty.
34581 The fields exist for back-compatibility
34582 .endlist
34583
34584 The default state (&%bounce_message_file%& unset) is equivalent to the
34585 following file, in which the sixth item is empty. The &'Subject:'& and some
34586 other lines have been split in order to fit them on the page:
34587 .code
34588 Subject: Mail delivery failed
34589   ${if eq{$sender_address}{$bounce_recipient}
34590   {: returning message to sender}}
34591 ****
34592 This message was created automatically by mail delivery software.
34593
34594 A message ${if eq{$sender_address}{$bounce_recipient}
34595   {that you sent }{sent by
34596
34597 <$sender_address>
34598
34599 }}could not be delivered to all of its recipients.
34600 This is a permanent error. The following address(es) failed:
34601 ****
34602 The following text was generated during the delivery attempt(s):
34603 ****
34604 ------ This is a copy of the message, including all the headers.
34605   ------
34606 ****
34607 ------ The body of the message is $message_size characters long;
34608   only the first
34609 ------ $bounce_return_size_limit or so are included here.
34610 ****
34611 .endd
34612 .section "Customizing warning messages" "SECTcustwarn"
34613 .cindex "customizing" "warning message"
34614 .cindex "warning of delay" "customizing the message"
34615 The option &%warn_message_file%& can be pointed at a template file for use when
34616 warnings about message delays are created. In this case there are only three
34617 text sections:
34618
34619 .ilist
34620 The first item is included in the headers, and should include at least a
34621 &'Subject:'& header. Exim does not check the syntax of these headers.
34622 .next
34623 The second item forms the start of the warning message. After it, Exim lists
34624 the delayed addresses.
34625 .next
34626 The third item then ends the message.
34627 .endlist
34628
34629 The default state is equivalent to the following file, except that some lines
34630 have been split here, in order to fit them on the page:
34631 .code
34632 Subject: Warning: message $message_exim_id delayed
34633   $warn_message_delay
34634 ****
34635 This message was created automatically by mail delivery software.
34636
34637 A message ${if eq{$sender_address}{$warn_message_recipients}
34638 {that you sent }{sent by
34639
34640 <$sender_address>
34641
34642 }}has not been delivered to all of its recipients after
34643 more than $warn_message_delay on the queue on $primary_hostname.
34644
34645 The message identifier is:     $message_exim_id
34646 The subject of the message is: $h_subject
34647 The date of the message is:    $h_date
34648
34649 The following address(es) have not yet been delivered:
34650 ****
34651 No action is required on your part. Delivery attempts will
34652 continue for some time, and this warning may be repeated at
34653 intervals if the message remains undelivered. Eventually the
34654 mail delivery software will give up, and when that happens,
34655 the message will be returned to you.
34656 .endd
34657 .vindex "&$warn_message_delay$&"
34658 .vindex "&$warn_message_recipients$&"
34659 However, in the default state the subject and date lines are omitted if no
34660 appropriate headers exist. During the expansion of this file,
34661 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34662 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34663 of recipients for the warning message. There may be more than one if there are
34664 multiple addresses with different &%errors_to%& settings on the routers that
34665 handled them.
34666
34667
34668
34669
34670 . ////////////////////////////////////////////////////////////////////////////
34671 . ////////////////////////////////////////////////////////////////////////////
34672
34673 .chapter "Some common configuration settings" "CHAPcomconreq"
34674 This chapter discusses some configuration settings that seem to be fairly
34675 common. More examples and discussion can be found in the Exim book.
34676
34677
34678
34679 .section "Sending mail to a smart host" "SECID240"
34680 .cindex "smart host" "example router"
34681 If you want to send all mail for non-local domains to a &"smart host"&, you
34682 should replace the default &(dnslookup)& router with a router which does the
34683 routing explicitly:
34684 .code
34685 send_to_smart_host:
34686   driver = manualroute
34687   route_list = !+local_domains smart.host.name
34688   transport = remote_smtp
34689 .endd
34690 You can use the smart host's IP address instead of the name if you wish.
34691 If you are using Exim only to submit messages to a smart host, and not for
34692 receiving incoming messages, you can arrange for it to do the submission
34693 synchronously by setting the &%mua_wrapper%& option (see chapter
34694 &<<CHAPnonqueueing>>&).
34695
34696
34697
34698
34699 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34700 .cindex "mailing lists"
34701 Exim can be used to run simple mailing lists, but for large and/or complicated
34702 requirements, the use of additional specialized mailing list software such as
34703 Majordomo or Mailman is recommended.
34704
34705 The &(redirect)& router can be used to handle mailing lists where each list
34706 is maintained in a separate file, which can therefore be managed by an
34707 independent manager. The &%domains%& router option can be used to run these
34708 lists in a separate domain from normal mail. For example:
34709 .code
34710 lists:
34711   driver = redirect
34712   domains = lists.example
34713   file = /usr/lists/$local_part
34714   forbid_pipe
34715   forbid_file
34716   errors_to = $local_part-request@lists.example
34717   no_more
34718 .endd
34719 This router is skipped for domains other than &'lists.example'&. For addresses
34720 in that domain, it looks for a file that matches the local part. If there is no
34721 such file, the router declines, but because &%no_more%& is set, no subsequent
34722 routers are tried, and so the whole delivery fails.
34723
34724 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34725 expanded into a file name or a pipe delivery, which is usually inappropriate in
34726 a mailing list.
34727
34728 .oindex "&%errors_to%&"
34729 The &%errors_to%& option specifies that any delivery errors caused by addresses
34730 taken from a mailing list are to be sent to the given address rather than the
34731 original sender of the message. However, before acting on this, Exim verifies
34732 the error address, and ignores it if verification fails.
34733
34734 For example, using the configuration above, mail sent to
34735 &'dicts@lists.example'& is passed on to those addresses contained in
34736 &_/usr/lists/dicts_&, with error reports directed to
34737 &'dicts-request@lists.example'&, provided that this address can be verified.
34738 There could be a file called &_/usr/lists/dicts-request_& containing
34739 the address(es) of this particular list's manager(s), but other approaches,
34740 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34741 or &%local_part_suffix%& options) to handle addresses of the form
34742 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34743
34744
34745
34746 .section "Syntax errors in mailing lists" "SECID241"
34747 .cindex "mailing lists" "syntax errors in"
34748 If an entry in redirection data contains a syntax error, Exim normally defers
34749 delivery of the original address. That means that a syntax error in a mailing
34750 list holds up all deliveries to the list. This may not be appropriate when a
34751 list is being maintained automatically from data supplied by users, and the
34752 addresses are not rigorously checked.
34753
34754 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34755 entries that fail to parse, noting the incident in the log. If in addition
34756 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34757 whenever a broken address is skipped. It is usually appropriate to set
34758 &%syntax_errors_to%& to the same address as &%errors_to%&.
34759
34760
34761
34762 .section "Re-expansion of mailing lists" "SECID242"
34763 .cindex "mailing lists" "re-expansion of"
34764 Exim remembers every individual address to which a message has been delivered,
34765 in order to avoid duplication, but it normally stores only the original
34766 recipient addresses with a message. If all the deliveries to a mailing list
34767 cannot be done at the first attempt, the mailing list is re-expanded when the
34768 delivery is next tried. This means that alterations to the list are taken into
34769 account at each delivery attempt, so addresses that have been added to
34770 the list since the message arrived will therefore receive a copy of the
34771 message, even though it pre-dates their subscription.
34772
34773 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34774 on the &(redirect)& router. If this is done, any addresses generated by the
34775 router that fail to deliver at the first attempt are added to the message as
34776 &"top level"& addresses, and the parent address that generated them is marked
34777 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34778 subsequent delivery attempts. The disadvantage of this is that if any of the
34779 failing addresses are incorrect, correcting them in the file has no effect on
34780 pre-existing messages.
34781
34782 The original top-level address is remembered with each of the generated
34783 addresses, and is output in any log messages. However, any intermediate parent
34784 addresses are not recorded. This makes a difference to the log only if the
34785 &%all_parents%& selector is set, but for mailing lists there is normally only
34786 one level of expansion anyway.
34787
34788
34789
34790 .section "Closed mailing lists" "SECID243"
34791 .cindex "mailing lists" "closed"
34792 The examples so far have assumed open mailing lists, to which anybody may
34793 send mail. It is also possible to set up closed lists, where mail is accepted
34794 from specified senders only. This is done by making use of the generic
34795 &%senders%& option to restrict the router that handles the list.
34796
34797 The following example uses the same file as a list of recipients and as a list
34798 of permitted senders. It requires three routers:
34799 .code
34800 lists_request:
34801   driver = redirect
34802   domains = lists.example
34803   local_part_suffix = -request
34804   file = /usr/lists/$local_part$local_part_suffix
34805   no_more
34806
34807 lists_post:
34808   driver = redirect
34809   domains = lists.example
34810   senders = ${if exists {/usr/lists/$local_part}\
34811              {lsearch;/usr/lists/$local_part}{*}}
34812   file = /usr/lists/$local_part
34813   forbid_pipe
34814   forbid_file
34815   errors_to = $local_part-request@lists.example
34816   no_more
34817
34818 lists_closed:
34819   driver = redirect
34820   domains = lists.example
34821   allow_fail
34822   data = :fail: $local_part@lists.example is a closed mailing list
34823 .endd
34824 All three routers have the same &%domains%& setting, so for any other domains,
34825 they are all skipped. The first router runs only if the local part ends in
34826 &%-request%&. It handles messages to the list manager(s) by means of an open
34827 mailing list.
34828
34829 The second router runs only if the &%senders%& precondition is satisfied. It
34830 checks for the existence of a list that corresponds to the local part, and then
34831 checks that the sender is on the list by means of a linear search. It is
34832 necessary to check for the existence of the file before trying to search it,
34833 because otherwise Exim thinks there is a configuration error. If the file does
34834 not exist, the expansion of &%senders%& is *, which matches all senders. This
34835 means that the router runs, but because there is no list, declines, and
34836 &%no_more%& ensures that no further routers are run. The address fails with an
34837 &"unrouteable address"& error.
34838
34839 The third router runs only if the second router is skipped, which happens when
34840 a mailing list exists, but the sender is not on it. This router forcibly fails
34841 the address, giving a suitable error message.
34842
34843
34844
34845
34846 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34847 .cindex "VERP"
34848 .cindex "Variable Envelope Return Paths"
34849 .cindex "envelope sender"
34850 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34851 are a way of helping mailing list administrators discover which subscription
34852 address is the cause of a particular delivery failure. The idea is to encode
34853 the original recipient address in the outgoing envelope sender address, so that
34854 if the message is forwarded by another host and then subsequently bounces, the
34855 original recipient can be extracted from the recipient address of the bounce.
34856
34857 .oindex &%errors_to%&
34858 .oindex &%return_path%&
34859 Envelope sender addresses can be modified by Exim using two different
34860 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34861 list examples), or the &%return_path%& option on a transport. The second of
34862 these is effective only if the message is successfully delivered to another
34863 host; it is not used for errors detected on the local host (see the description
34864 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34865 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34866 .code
34867 verp_smtp:
34868   driver = smtp
34869   max_rcpt = 1
34870   return_path = \
34871     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34872       {$1-request+$local_part=$domain@your.dom.example}fail}
34873 .endd
34874 This has the effect of rewriting the return path (envelope sender) on outgoing
34875 SMTP messages, if the local part of the original return path ends in
34876 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34877 local part and domain of the recipient into the return path. Suppose, for
34878 example, that a message whose return path has been set to
34879 &'somelist-request@your.dom.example'& is sent to
34880 &'subscriber@other.dom.example'&. In the transport, the return path is
34881 rewritten as
34882 .code
34883 somelist-request+subscriber=other.dom.example@your.dom.example
34884 .endd
34885 .vindex "&$local_part$&"
34886 For this to work, you must tell Exim to send multiple copies of messages that
34887 have more than one recipient, so that each copy has just one recipient. This is
34888 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34889 might be sent to several different recipients in the same domain, in which case
34890 &$local_part$& is not available in the transport, because it is not unique.
34891
34892 Unless your host is doing nothing but mailing list deliveries, you should
34893 probably use a separate transport for the VERP deliveries, so as not to use
34894 extra resources in making one-per-recipient copies for other deliveries. This
34895 can easily be done by expanding the &%transport%& option in the router:
34896 .code
34897 dnslookup:
34898   driver = dnslookup
34899   domains = ! +local_domains
34900   transport = \
34901     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34902       {verp_smtp}{remote_smtp}}
34903   no_more
34904 .endd
34905 If you want to change the return path using &%errors_to%& in a router instead
34906 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34907 routers that handle mailing list addresses. This will ensure that all delivery
34908 errors, including those detected on the local host, are sent to the VERP
34909 address.
34910
34911 On a host that does no local deliveries and has no manual routing, only the
34912 &(dnslookup)& router needs to be changed. A special transport is not needed for
34913 SMTP deliveries. Every mailing list recipient has its own return path value,
34914 and so Exim must hand them to the transport one at a time. Here is an example
34915 of a &(dnslookup)& router that implements VERP:
34916 .code
34917 verp_dnslookup:
34918   driver = dnslookup
34919   domains = ! +local_domains
34920   transport = remote_smtp
34921   errors_to = \
34922     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34923      {$1-request+$local_part=$domain@your.dom.example}fail}
34924   no_more
34925 .endd
34926 Before you start sending out messages with VERPed return paths, you must also
34927 configure Exim to accept the bounce messages that come back to those paths.
34928 Typically this is done by setting a &%local_part_suffix%& option for a
34929 router, and using this to route the messages to wherever you want to handle
34930 them.
34931
34932 The overhead incurred in using VERP depends very much on the size of the
34933 message, the number of recipient addresses that resolve to the same remote
34934 host, and the speed of the connection over which the message is being sent. If
34935 a lot of addresses resolve to the same host and the connection is slow, sending
34936 a separate copy of the message for each address may take substantially longer
34937 than sending a single copy with many recipients (for which VERP cannot be
34938 used).
34939
34940
34941
34942
34943
34944
34945 .section "Virtual domains" "SECTvirtualdomains"
34946 .cindex "virtual domains"
34947 .cindex "domain" "virtual"
34948 The phrase &'virtual domain'& is unfortunately used with two rather different
34949 meanings:
34950
34951 .ilist
34952 A domain for which there are no real mailboxes; all valid local parts are
34953 aliases for other email addresses. Common examples are organizational
34954 top-level domains and &"vanity"& domains.
34955 .next
34956 One of a number of independent domains that are all handled by the same host,
34957 with mailboxes on that host, but where the mailbox owners do not necessarily
34958 have login accounts on that host.
34959 .endlist
34960
34961 The first usage is probably more common, and does seem more &"virtual"& than
34962 the second. This kind of domain can be handled in Exim with a straightforward
34963 aliasing router. One approach is to create a separate alias file for each
34964 virtual domain. Exim can test for the existence of the alias file to determine
34965 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34966 to a router of this form:
34967 .code
34968 virtual:
34969   driver = redirect
34970   domains = dsearch;/etc/mail/virtual
34971   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34972   no_more
34973 .endd
34974 The &%domains%& option specifies that the router is to be skipped, unless there
34975 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34976 domain that is being processed. When the router runs, it looks up the local
34977 part in the file to find a new address (or list of addresses). The &%no_more%&
34978 setting ensures that if the lookup fails (leading to &%data%& being an empty
34979 string), Exim gives up on the address without trying any subsequent routers.
34980
34981 This one router can handle all the virtual domains because the alias file names
34982 follow a fixed pattern. Permissions can be arranged so that appropriate people
34983 can edit the different alias files. A successful aliasing operation results in
34984 a new envelope recipient address, which is then routed from scratch.
34985
34986 The other kind of &"virtual"& domain can also be handled in a straightforward
34987 way. One approach is to create a file for each domain containing a list of
34988 valid local parts, and use it in a router like this:
34989 .code
34990 my_domains:
34991   driver = accept
34992   domains = dsearch;/etc/mail/domains
34993   local_parts = lsearch;/etc/mail/domains/$domain
34994   transport = my_mailboxes
34995 .endd
34996 The address is accepted if there is a file for the domain, and the local part
34997 can be found in the file. The &%domains%& option is used to check for the
34998 file's existence because &%domains%& is tested before the &%local_parts%&
34999 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35000 because that option is tested after &%local_parts%&. The transport is as
35001 follows:
35002 .code
35003 my_mailboxes:
35004   driver = appendfile
35005   file = /var/mail/$domain/$local_part
35006   user = mail
35007 .endd
35008 This uses a directory of mailboxes for each domain. The &%user%& setting is
35009 required, to specify which uid is to be used for writing to the mailboxes.
35010
35011 The configuration shown here is just one example of how you might support this
35012 requirement. There are many other ways this kind of configuration can be set
35013 up, for example, by using a database instead of separate files to hold all the
35014 information about the domains.
35015
35016
35017
35018 .section "Multiple user mailboxes" "SECTmulbox"
35019 .cindex "multiple mailboxes"
35020 .cindex "mailbox" "multiple"
35021 .cindex "local part" "prefix"
35022 .cindex "local part" "suffix"
35023 Heavy email users often want to operate with multiple mailboxes, into which
35024 incoming mail is automatically sorted. A popular way of handling this is to
35025 allow users to use multiple sender addresses, so that replies can easily be
35026 identified. Users are permitted to add prefixes or suffixes to their local
35027 parts for this purpose. The wildcard facility of the generic router options
35028 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35029 example, consider this router:
35030 .code
35031 userforward:
35032   driver = redirect
35033   check_local_user
35034   file = $home/.forward
35035   local_part_suffix = -*
35036   local_part_suffix_optional
35037   allow_filter
35038 .endd
35039 .vindex "&$local_part_suffix$&"
35040 It runs a user's &_.forward_& file for all local parts of the form
35041 &'username-*'&. Within the filter file the user can distinguish different
35042 cases by testing the variable &$local_part_suffix$&. For example:
35043 .code
35044 if $local_part_suffix contains -special then
35045 save /home/$local_part/Mail/special
35046 endif
35047 .endd
35048 If the filter file does not exist, or does not deal with such addresses, they
35049 fall through to subsequent routers, and, assuming no subsequent use of the
35050 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35051 control over which suffixes are valid.
35052
35053 Alternatively, a suffix can be used to trigger the use of a different
35054 &_.forward_& file &-- which is the way a similar facility is implemented in
35055 another MTA:
35056 .code
35057 userforward:
35058   driver = redirect
35059   check_local_user
35060   file = $home/.forward$local_part_suffix
35061   local_part_suffix = -*
35062   local_part_suffix_optional
35063   allow_filter
35064 .endd
35065 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35066 example, &_.forward-special_& is used. Once again, if the appropriate file
35067 does not exist, or does not deal with the address, it is passed on to
35068 subsequent routers, which could, if required, look for an unqualified
35069 &_.forward_& file to use as a default.
35070
35071
35072
35073 .section "Simplified vacation processing" "SECID244"
35074 .cindex "vacation processing"
35075 The traditional way of running the &'vacation'& program is for a user to set up
35076 a pipe command in a &_.forward_& file
35077 (see section &<<SECTspecitredli>>& for syntax details).
35078 This is prone to error by inexperienced users. There are two features of Exim
35079 that can be used to make this process simpler for users:
35080
35081 .ilist
35082 A local part prefix such as &"vacation-"& can be specified on a router which
35083 can cause the message to be delivered directly to the &'vacation'& program, or
35084 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35085 &_.forward_& file are then much simpler. For example:
35086 .code
35087 spqr, vacation-spqr
35088 .endd
35089 .next
35090 The &%require_files%& generic router option can be used to trigger a
35091 vacation delivery by checking for the existence of a certain file in the
35092 user's home directory. The &%unseen%& generic option should also be used, to
35093 ensure that the original delivery also proceeds. In this case, all the user has
35094 to do is to create a file called, say, &_.vacation_&, containing a vacation
35095 message.
35096 .endlist
35097
35098 Another advantage of both these methods is that they both work even when the
35099 use of arbitrary pipes by users is locked out.
35100
35101
35102
35103 .section "Taking copies of mail" "SECID245"
35104 .cindex "message" "copying every"
35105 Some installations have policies that require archive copies of all messages to
35106 be made. A single copy of each message can easily be taken by an appropriate
35107 command in a system filter, which could, for example, use a different file for
35108 each day's messages.
35109
35110 There is also a shadow transport mechanism that can be used to take copies of
35111 messages that are successfully delivered by local transports, one copy per
35112 delivery. This could be used, &'inter alia'&, to implement automatic
35113 notification of delivery by sites that insist on doing such things.
35114
35115
35116
35117 .section "Intermittently connected hosts" "SECID246"
35118 .cindex "intermittently connected hosts"
35119 It has become quite common (because it is cheaper) for hosts to connect to the
35120 Internet periodically rather than remain connected all the time. The normal
35121 arrangement is that mail for such hosts accumulates on a system that is
35122 permanently connected.
35123
35124 Exim was designed for use on permanently connected hosts, and so it is not
35125 particularly well-suited to use in an intermittently connected environment.
35126 Nevertheless there are some features that can be used.
35127
35128
35129 .section "Exim on the upstream server host" "SECID247"
35130 It is tempting to arrange for incoming mail for the intermittently connected
35131 host to remain on Exim's queue until the client connects. However, this
35132 approach does not scale very well. Two different kinds of waiting message are
35133 being mixed up in the same queue &-- those that cannot be delivered because of
35134 some temporary problem, and those that are waiting for their destination host
35135 to connect. This makes it hard to manage the queue, as well as wasting
35136 resources, because each queue runner scans the entire queue.
35137
35138 A better approach is to separate off those messages that are waiting for an
35139 intermittently connected host. This can be done by delivering these messages
35140 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35141 format, from where they are transmitted by other software when their
35142 destination connects. This makes it easy to collect all the mail for one host
35143 in a single directory, and to apply local timeout rules on a per-message basis
35144 if required.
35145
35146 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35147 you are doing this, you should configure Exim with a long retry period for the
35148 intermittent host. For example:
35149 .code
35150 cheshire.wonderland.fict.example    *   F,5d,24h
35151 .endd
35152 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35153 which messages it has queued up for that host. Once the intermittent host comes
35154 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35155 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35156 causes all the queued up messages to be delivered, often down a single SMTP
35157 connection. While the host remains connected, any new messages get delivered
35158 immediately.
35159
35160 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35161 issued with a different IP address each time it connects, Exim's retry
35162 mechanisms on the holding host get confused, because the IP address is normally
35163 used as part of the key string for holding retry information. This can be
35164 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35165 Since this has disadvantages for permanently connected hosts, it is best to
35166 arrange a separate transport for the intermittently connected ones.
35167
35168
35169
35170 .section "Exim on the intermittently connected client host" "SECID248"
35171 The value of &%smtp_accept_queue_per_connection%& should probably be
35172 increased, or even set to zero (that is, disabled) on the intermittently
35173 connected host, so that all incoming messages down a single connection get
35174 delivered immediately.
35175
35176 .cindex "SMTP" "passed connection"
35177 .cindex "SMTP" "multiple deliveries"
35178 .cindex "multiple SMTP deliveries"
35179 Mail waiting to be sent from an intermittently connected host will probably
35180 not have been routed, because without a connection DNS lookups are not
35181 possible. This means that if a normal queue run is done at connection time,
35182 each message is likely to be sent in a separate SMTP session. This can be
35183 avoided by starting the queue run with a command line option beginning with
35184 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35185 first pass, routing is done but no deliveries take place. The second pass is a
35186 normal queue run; since all the messages have been previously routed, those
35187 destined for the same host are likely to get sent as multiple deliveries in a
35188 single SMTP connection.
35189
35190
35191
35192 . ////////////////////////////////////////////////////////////////////////////
35193 . ////////////////////////////////////////////////////////////////////////////
35194
35195 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35196          "Exim as a non-queueing client"
35197 .cindex "client, non-queueing"
35198 .cindex "smart host" "suppressing queueing"
35199 On a personal computer, it is a common requirement for all
35200 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35201 configured to operate that way, for all the popular operating systems.
35202 However, there are some MUAs for Unix-like systems that cannot be so
35203 configured: they submit messages using the command line interface of
35204 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35205 messages this way.
35206
35207 If the personal computer runs continuously, there is no problem, because it can
35208 run a conventional MTA that handles delivery to the smart host, and deal with
35209 any delays via its queueing mechanism. However, if the computer does not run
35210 continuously or runs different operating systems at different times, queueing
35211 email is not desirable.
35212
35213 There is therefore a requirement for something that can provide the
35214 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35215 any queueing or retrying facilities. Furthermore, the delivery to the smart
35216 host should be synchronous, so that if it fails, the sending MUA is immediately
35217 informed. In other words, we want something that extends an MUA that submits
35218 to a local MTA via the command line so that it behaves like one that submits
35219 to a remote smart host using TCP/SMTP.
35220
35221 There are a number of applications (for example, there is one called &'ssmtp'&)
35222 that do this job. However, people have found them to be lacking in various
35223 ways. For instance, you might want to allow aliasing and forwarding to be done
35224 before sending a message to the smart host.
35225
35226 Exim already had the necessary infrastructure for doing this job. Just a few
35227 tweaks were needed to make it behave as required, though it is somewhat of an
35228 overkill to use a fully-featured MTA for this purpose.
35229
35230 .oindex "&%mua_wrapper%&"
35231 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35232 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35233 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35234 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35235 compatible router and transport configuration. Typically there will be just one
35236 router and one transport, sending everything to a smart host.
35237
35238 When run in MUA wrapping mode, the behaviour of Exim changes in the
35239 following ways:
35240
35241 .ilist
35242 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35243 In other words, the only way to submit messages is via the command line.
35244 .next
35245 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35246 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35247 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35248 does not finish until the delivery attempt is complete. If the delivery is
35249 successful, a zero return code is given.
35250 .next
35251 Address redirection is permitted, but the final routing for all addresses must
35252 be to the same remote transport, and to the same list of hosts. Furthermore,
35253 the return address (envelope sender) must be the same for all recipients, as
35254 must any added or deleted header lines. In other words, it must be possible to
35255 deliver the message in a single SMTP transaction, however many recipients there
35256 are.
35257 .next
35258 If these conditions are not met, or if routing any address results in a
35259 failure or defer status, or if Exim is unable to deliver all the recipients
35260 successfully to one of the smart hosts, delivery of the entire message fails.
35261 .next
35262 Because no queueing is allowed, all failures are treated as permanent; there
35263 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35264 smart host. Furthermore, because only a single yes/no response can be given to
35265 the caller, it is not possible to deliver to some recipients and not others. If
35266 there is an error (temporary or permanent) for any recipient, all are failed.
35267 .next
35268 If more than one smart host is listed, Exim will try another host after a
35269 connection failure or a timeout, in the normal way. However, if this kind of
35270 failure happens for all the hosts, the delivery fails.
35271 .next
35272 When delivery fails, an error message is written to the standard error stream
35273 (as well as to Exim's log), and Exim exits to the caller with a return code
35274 value 1. The message is expunged from Exim's spool files. No bounce messages
35275 are ever generated.
35276 .next
35277 No retry data is maintained, and any retry rules are ignored.
35278 .next
35279 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35280 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35281 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35282 .endlist
35283
35284 The overall effect is that Exim makes a single synchronous attempt to deliver
35285 the message, failing if there is any kind of problem. Because no local
35286 deliveries are done and no daemon can be run, Exim does not need root
35287 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35288 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35289 the advantages and disadvantages of running without root privilege.
35290
35291
35292
35293
35294 . ////////////////////////////////////////////////////////////////////////////
35295 . ////////////////////////////////////////////////////////////////////////////
35296
35297 .chapter "Log files" "CHAPlog"
35298 .scindex IIDloggen "log" "general description"
35299 .cindex "log" "types of"
35300 Exim writes three different logs, referred to as the main log, the reject log,
35301 and the panic log:
35302
35303 .ilist
35304 .cindex "main log"
35305 The main log records the arrival of each message and each delivery in a single
35306 line in each case. The format is as compact as possible, in an attempt to keep
35307 down the size of log files. Two-character flag sequences make it easy to pick
35308 out these lines. A number of other events are recorded in the main log. Some of
35309 them are optional, in which case the &%log_selector%& option controls whether
35310 they are included or not. A Perl script called &'eximstats'&, which does simple
35311 analysis of main log files, is provided in the Exim distribution (see section
35312 &<<SECTmailstat>>&).
35313 .next
35314 .cindex "reject log"
35315 The reject log records information from messages that are rejected as a result
35316 of a configuration option (that is, for policy reasons).
35317 The first line of each rejection is a copy of the line that is also written to
35318 the main log. Then, if the message's header has been read at the time the log
35319 is written, its contents are written to this log. Only the original header
35320 lines are available; header lines added by ACLs are not logged. You can use the
35321 reject log to check that your policy controls are working correctly; on a busy
35322 host this may be easier than scanning the main log for rejection messages. You
35323 can suppress the writing of the reject log by setting &%write_rejectlog%&
35324 false.
35325 .next
35326 .cindex "panic log"
35327 .cindex "system log"
35328 When certain serious errors occur, Exim writes entries to its panic log. If the
35329 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35330 are usually written to the main log as well, but can get lost amid the mass of
35331 other entries. The panic log should be empty under normal circumstances. It is
35332 therefore a good idea to check it (or to have a &'cron'& script check it)
35333 regularly, in order to become aware of any problems. When Exim cannot open its
35334 panic log, it tries as a last resort to write to the system log (syslog). This
35335 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35336 message itself is written at priority LOG_CRIT.
35337 .endlist
35338
35339 Every log line starts with a timestamp, in the format shown in the following
35340 example. Note that many of the examples shown in this chapter are line-wrapped.
35341 In the log file, this would be all on one line:
35342 .code
35343 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35344   by QUIT
35345 .endd
35346 By default, the timestamps are in the local timezone. There are two
35347 ways of changing this:
35348
35349 .ilist
35350 You can set the &%timezone%& option to a different time zone; in particular, if
35351 you set
35352 .code
35353 timezone = UTC
35354 .endd
35355 the timestamps will be in UTC (aka GMT).
35356 .next
35357 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35358 example:
35359 .code
35360 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35361 .endd
35362 .endlist
35363
35364 .cindex "log" "process ids in"
35365 .cindex "pid (process id)" "in log lines"
35366 Exim does not include its process id in log lines by default, but you can
35367 request that it does so by specifying the &`pid`& log selector (see section
35368 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35369 brackets, immediately after the time and date.
35370
35371
35372
35373
35374 .section "Where the logs are written" "SECTwhelogwri"
35375 .cindex "log" "destination"
35376 .cindex "log" "to file"
35377 .cindex "log" "to syslog"
35378 .cindex "syslog"
35379 The logs may be written to local files, or to syslog, or both. However, it
35380 should be noted that many syslog implementations use UDP as a transport, and
35381 are therefore unreliable in the sense that messages are not guaranteed to
35382 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35383 It has also been reported that on large log files (tens of megabytes) you may
35384 need to tweak syslog to prevent it syncing the file with each write &-- on
35385 Linux this has been seen to make syslog take 90% plus of CPU time.
35386
35387 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35388 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35389 configuration. This latter string is expanded, so it can contain, for example,
35390 references to the host name:
35391 .code
35392 log_file_path = /var/log/$primary_hostname/exim_%slog
35393 .endd
35394 It is generally advisable, however, to set the string in &_Local/Makefile_&
35395 rather than at run time, because then the setting is available right from the
35396 start of Exim's execution. Otherwise, if there's something it wants to log
35397 before it has read the configuration file (for example, an error in the
35398 configuration file) it will not use the path you want, and may not be able to
35399 log at all.
35400
35401 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35402 list, currently limited to at most two items. This is one option where the
35403 facility for changing a list separator may not be used. The list must always be
35404 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35405 otherwise the item must either be an absolute path, containing &`%s`& at the
35406 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35407 implying the use of a default path.
35408
35409 When Exim encounters an empty item in the list, it searches the list defined by
35410 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35411 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35412 mean &"use the path specified at build time"&. It no such item exists, log
35413 files are written in the &_log_& subdirectory of the spool directory. This is
35414 equivalent to the setting:
35415 .code
35416 log_file_path = $spool_directory/log/%slog
35417 .endd
35418 If you do not specify anything at build time or run time,
35419 or if you unset the option at run time (i.e. &`log_file_path = `&),
35420 that is where the logs are written.
35421
35422 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35423 are in use &-- see section &<<SECTdatlogfil>>& below.
35424
35425 Here are some examples of possible settings:
35426 .display
35427 &`LOG_FILE_PATH=syslog                    `& syslog only
35428 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35429 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35430 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35431 .endd
35432 If there are more than two paths in the list, the first is used and a panic
35433 error is logged.
35434
35435
35436
35437 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35438 .cindex "log" "cycling local files"
35439 .cindex "cycling logs"
35440 .cindex "&'exicyclog'&"
35441 .cindex "log" "local files; writing to"
35442 Some operating systems provide centralized and standardized methods for cycling
35443 log files. For those that do not, a utility script called &'exicyclog'& is
35444 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35445 main and reject logs each time it is called. The maximum number of old logs to
35446 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35447
35448 An Exim delivery process opens the main log when it first needs to write to it,
35449 and it keeps the file open in case subsequent entries are required &-- for
35450 example, if a number of different deliveries are being done for the same
35451 message. However, remote SMTP deliveries can take a long time, and this means
35452 that the file may be kept open long after it is renamed if &'exicyclog'& or
35453 something similar is being used to rename log files on a regular basis. To
35454 ensure that a switch of log files is noticed as soon as possible, Exim calls
35455 &[stat()]& on the main log's name before reusing an open file, and if the file
35456 does not exist, or its inode has changed, the old file is closed and Exim
35457 tries to open the main log from scratch. Thus, an old log file may remain open
35458 for quite some time, but no Exim processes should write to it once it has been
35459 renamed.
35460
35461
35462
35463 .section "Datestamped log files" "SECTdatlogfil"
35464 .cindex "log" "datestamped files"
35465 Instead of cycling the main and reject log files by renaming them
35466 periodically, some sites like to use files whose names contain a datestamp,
35467 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35468 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35469 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35470 point where the datestamp is required. For example:
35471 .code
35472 log_file_path = /var/spool/exim/log/%slog-%D
35473 log_file_path = /var/log/exim-%s-%D.log
35474 log_file_path = /var/spool/exim/log/%D-%slog
35475 log_file_path = /var/log/exim/%s.%M
35476 .endd
35477 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35478 examples of names generated by the above examples:
35479 .code
35480 /var/spool/exim/log/mainlog-20021225
35481 /var/log/exim-reject-20021225.log
35482 /var/spool/exim/log/20021225-mainlog
35483 /var/log/exim/main.200212
35484 .endd
35485 When this form of log file is specified, Exim automatically switches to new
35486 files at midnight. It does not make any attempt to compress old logs; you
35487 will need to write your own script if you require this. You should not
35488 run &'exicyclog'& with this form of logging.
35489
35490 The location of the panic log is also determined by &%log_file_path%&, but it
35491 is not datestamped, because rotation of the panic log does not make sense.
35492 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35493 the string. In addition, if it immediately follows a slash, a following
35494 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35495 character is removed. Thus, the four examples above would give these panic
35496 log names:
35497 .code
35498 /var/spool/exim/log/paniclog
35499 /var/log/exim-panic.log
35500 /var/spool/exim/log/paniclog
35501 /var/log/exim/panic
35502 .endd
35503
35504
35505 .section "Logging to syslog" "SECID249"
35506 .cindex "log" "syslog; writing to"
35507 The use of syslog does not change what Exim logs or the format of its messages,
35508 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35509 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35510 that, the same strings are written to syslog as to log files. The syslog
35511 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35512 by default, but you can change these by setting the &%syslog_facility%& and
35513 &%syslog_processname%& options, respectively. If Exim was compiled with
35514 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35515 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35516 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35517 the time and host name to each line.
35518 The three log streams are mapped onto syslog priorities as follows:
35519
35520 .ilist
35521 &'mainlog'& is mapped to LOG_INFO
35522 .next
35523 &'rejectlog'& is mapped to LOG_NOTICE
35524 .next
35525 &'paniclog'& is mapped to LOG_ALERT
35526 .endlist
35527
35528 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35529 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35530 these are routed by syslog to the same place. You can suppress this duplication
35531 by setting &%syslog_duplication%& false.
35532
35533 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35534 entries contain multiple lines when headers are included. To cope with both
35535 these cases, entries written to syslog are split into separate &[syslog()]&
35536 calls at each internal newline, and also after a maximum of
35537 870 data characters. (This allows for a total syslog line length of 1024, when
35538 additions such as timestamps are added.) If you are running a syslog
35539 replacement that can handle lines longer than the 1024 characters allowed by
35540 RFC 3164, you should set
35541 .code
35542 SYSLOG_LONG_LINES=yes
35543 .endd
35544 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35545 lines, but it still splits at internal newlines in &'reject'& log entries.
35546
35547 To make it easy to re-assemble split lines later, each component of a split
35548 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35549 where <&'n'&> is the component number and <&'m'&> is the total number of
35550 components in the entry. The / delimiter is used when the line was split
35551 because it was too long; if it was split because of an internal newline, the \
35552 delimiter is used. For example, supposing the length limit to be 50 instead of
35553 870, the following would be the result of a typical rejection message to
35554 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35555 name, and pid as added by syslog:
35556 .code
35557 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35558 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35559 [3/5]  when scanning for sender: missing or malformed lo
35560 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35561 [5/5] mple>)
35562 .endd
35563 The same error might cause the following lines to be written to &"rejectlog"&
35564 (LOG_NOTICE):
35565 .code
35566 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35567 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35568 [3/18] er when scanning for sender: missing or malformed
35569 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35570 [5\18] .example>)
35571 [6\18] Recipients: ph10@some.domain.cam.example
35572 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35573 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35574 [9\18]        id 16RdAL-0006pc-00
35575 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35576 [11\18] 09:43 +0100
35577 [12\18] F From: <>
35578 [13\18]   Subject: this is a test header
35579 [18\18]   X-something: this is another header
35580 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35581 [16\18] le>
35582 [17\18] B Bcc:
35583 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35584 .endd
35585 Log lines that are neither too long nor contain newlines are written to syslog
35586 without modification.
35587
35588 If only syslog is being used, the Exim monitor is unable to provide a log tail
35589 display, unless syslog is routing &'mainlog'& to a file on the local host and
35590 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35591 where it is.
35592
35593
35594
35595 .section "Log line flags" "SECID250"
35596 One line is written to the main log for each message received, and for each
35597 successful, unsuccessful, and delayed delivery. These lines can readily be
35598 picked out by the distinctive two-character flags that immediately follow the
35599 timestamp. The flags are:
35600 .display
35601 &`<=`&     message arrival
35602 &`(=`&     message fakereject
35603 &`=>`&     normal message delivery
35604 &`->`&     additional address in same delivery
35605 &`>>`&     cutthrough message delivery
35606 &`*>`&     delivery suppressed by &%-N%&
35607 &`**`&     delivery failed; address bounced
35608 &`==`&     delivery deferred; temporary problem
35609 .endd
35610
35611
35612 .section "Logging message reception" "SECID251"
35613 .cindex "log" "reception line"
35614 The format of the single-line entry in the main log that is written for every
35615 message received is shown in the basic example below, which is split over
35616 several lines in order to fit it on the page:
35617 .code
35618 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35619   H=mailer.fict.example [192.168.123.123] U=exim
35620   P=smtp S=5678 id=<incoming message id>
35621 .endd
35622 The address immediately following &"<="& is the envelope sender address. A
35623 bounce message is shown with the sender address &"<>"&, and if it is locally
35624 generated, this is followed by an item of the form
35625 .code
35626 R=<message id>
35627 .endd
35628 which is a reference to the message that caused the bounce to be sent.
35629
35630 .cindex "HELO"
35631 .cindex "EHLO"
35632 For messages from other hosts, the H and U fields identify the remote host and
35633 record the RFC 1413 identity of the user that sent the message, if one was
35634 received. The number given in square brackets is the IP address of the sending
35635 host. If there is a single, unparenthesized  host name in the H field, as
35636 above, it has been verified to correspond to the IP address (see the
35637 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35638 by the remote host in the SMTP HELO or EHLO command, and has not been
35639 verified. If verification yields a different name to that given for HELO or
35640 EHLO, the verified name appears first, followed by the HELO or EHLO
35641 name in parentheses.
35642
35643 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35644 without brackets, in the HELO or EHLO command, leading to entries in
35645 the log containing text like these examples:
35646 .code
35647 H=(10.21.32.43) [192.168.8.34]
35648 H=([10.21.32.43]) [192.168.8.34]
35649 .endd
35650 This can be confusing. Only the final address in square brackets can be relied
35651 on.
35652
35653 For locally generated messages (that is, messages not received over TCP/IP),
35654 the H field is omitted, and the U field contains the login name of the caller
35655 of Exim.
35656
35657 .cindex "authentication" "logging"
35658 .cindex "AUTH" "logging"
35659 For all messages, the P field specifies the protocol used to receive the
35660 message. This is the value that is stored in &$received_protocol$&. In the case
35661 of incoming SMTP messages, the value indicates whether or not any SMTP
35662 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35663 session was encrypted, there is an additional X field that records the cipher
35664 suite that was used.
35665
35666 .cindex log protocol
35667 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35668 hosts that have authenticated themselves using the SMTP AUTH command. The first
35669 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35670 there is an additional item A= followed by the name of the authenticator that
35671 was used. If an authenticated identification was set up by the authenticator's
35672 &%server_set_id%& option, this is logged too, separated by a colon from the
35673 authenticator name.
35674
35675 .cindex "size" "of message"
35676 The id field records the existing message id, if present. The size of the
35677 received message is given by the S field. When the message is delivered,
35678 headers may be removed or added, so that the size of delivered copies of the
35679 message may not correspond with this value (and indeed may be different to each
35680 other).
35681
35682 The &%log_selector%& option can be used to request the logging of additional
35683 data when a message is received. See section &<<SECTlogselector>>& below.
35684
35685
35686
35687 .section "Logging deliveries" "SECID252"
35688 .cindex "log" "delivery line"
35689 The format of the single-line entry in the main log that is written for every
35690 delivery is shown in one of the examples below, for local and remote
35691 deliveries, respectively. Each example has been split into multiple lines in order
35692 to fit it on the page:
35693 .code
35694 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35695   <marv@hitch.fict.example> R=localuser T=local_delivery
35696 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35697   monk@holistic.fict.example R=dnslookup T=remote_smtp
35698   H=holistic.fict.example [192.168.234.234]
35699 .endd
35700 For ordinary local deliveries, the original address is given in angle brackets
35701 after the final delivery address, which might be a pipe or a file. If
35702 intermediate address(es) exist between the original and the final address, the
35703 last of these is given in parentheses after the final address. The R and T
35704 fields record the router and transport that were used to process the address.
35705
35706 If SMTP AUTH was used for the delivery there is an additional item A=
35707 followed by the name of the authenticator that was used.
35708 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35709 option, this is logged too, separated by a colon from the authenticator name.
35710
35711 If a shadow transport was run after a successful local delivery, the log line
35712 for the successful delivery has an item added on the end, of the form
35713 .display
35714 &`ST=<`&&'shadow transport name'&&`>`&
35715 .endd
35716 If the shadow transport did not succeed, the error message is put in
35717 parentheses afterwards.
35718
35719 .cindex "asterisk" "after IP address"
35720 When more than one address is included in a single delivery (for example, two
35721 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35722 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35723 down a single SMTP connection, an asterisk follows the IP address in the log
35724 lines for the second and subsequent messages.
35725
35726 .cindex "delivery" "cutthrough; logging"
35727 .cindex "cutthrough" "logging"
35728 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35729 line precedes the reception line, since cutthrough waits for a possible
35730 rejection from the destination in case it can reject the sourced item.
35731
35732 The generation of a reply message by a filter file gets logged as a
35733 &"delivery"& to the addressee, preceded by &">"&.
35734
35735 The &%log_selector%& option can be used to request the logging of additional
35736 data when a message is delivered. See section &<<SECTlogselector>>& below.
35737
35738
35739 .section "Discarded deliveries" "SECID253"
35740 .cindex "discarded messages"
35741 .cindex "message" "discarded"
35742 .cindex "delivery" "discarded; logging"
35743 When a message is discarded as a result of the command &"seen finish"& being
35744 obeyed in a filter file which generates no deliveries, a log entry of the form
35745 .code
35746 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35747   <low.club@bridge.example> R=userforward
35748 .endd
35749 is written, to record why no deliveries are logged. When a message is discarded
35750 because it is aliased to &":blackhole:"& the log line is like this:
35751 .code
35752 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35753   <hole@nowhere.example> R=blackhole_router
35754 .endd
35755
35756
35757 .section "Deferred deliveries" "SECID254"
35758 When a delivery is deferred, a line of the following form is logged:
35759 .code
35760 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35761   R=dnslookup T=smtp defer (146): Connection refused
35762 .endd
35763 In the case of remote deliveries, the error is the one that was given for the
35764 last IP address that was tried. Details of individual SMTP failures are also
35765 written to the log, so the above line would be preceded by something like
35766 .code
35767 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35768   mail1.endrest.example [192.168.239.239]: Connection refused
35769 .endd
35770 When a deferred address is skipped because its retry time has not been reached,
35771 a message is written to the log, but this can be suppressed by setting an
35772 appropriate value in &%log_selector%&.
35773
35774
35775
35776 .section "Delivery failures" "SECID255"
35777 .cindex "delivery" "failure; logging"
35778 If a delivery fails because an address cannot be routed, a line of the
35779 following form is logged:
35780 .code
35781 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35782   <jim@trek99.example>: unknown mail domain
35783 .endd
35784 If a delivery fails at transport time, the router and transport are shown, and
35785 the response from the remote host is included, as in this example:
35786 .code
35787 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35788   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35789   after pipelined RCPT TO:<ace400@pb.example>: host
35790   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35791   <ace400@pb.example>...Addressee unknown
35792 .endd
35793 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35794 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35795 disabling PIPELINING. The log lines for all forms of delivery failure are
35796 flagged with &`**`&.
35797
35798
35799
35800 .section "Fake deliveries" "SECID256"
35801 .cindex "delivery" "fake; logging"
35802 If a delivery does not actually take place because the &%-N%& option has been
35803 used to suppress it, a normal delivery line is written to the log, except that
35804 &"=>"& is replaced by &"*>"&.
35805
35806
35807
35808 .section "Completion" "SECID257"
35809 A line of the form
35810 .code
35811 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35812 .endd
35813 is written to the main log when a message is about to be removed from the spool
35814 at the end of its processing.
35815
35816
35817
35818
35819 .section "Summary of Fields in Log Lines" "SECID258"
35820 .cindex "log" "summary of fields"
35821 A summary of the field identifiers that are used in log lines is shown in
35822 the following table:
35823 .display
35824 &`A   `&        authenticator name (and optional id and sender)
35825 &`C   `&        SMTP confirmation on delivery
35826 &`    `&        command list for &"no mail in SMTP session"&
35827 &`CV  `&        certificate verification status
35828 &`D   `&        duration of &"no mail in SMTP session"&
35829 &`DN  `&        distinguished name from peer certificate
35830 &`DS  `&        DNSSEC secured lookups
35831 &`DT  `&        on &`=>`& lines: time taken for a delivery
35832 &`F   `&        sender address (on delivery lines)
35833 &`H   `&        host name and IP address
35834 &`I   `&        local interface used
35835 &`K   `&        CHUNKING extension used
35836 &`id  `&        message id for incoming message
35837 &`P   `&        on &`<=`& lines: protocol used
35838 &`    `&        on &`=>`& and &`**`& lines: return path
35839 &`PRDR`&        PRDR extension used
35840 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
35841 &`Q   `&        alternate queue name
35842 &`QT  `&        on &`=>`& lines: time spent on queue so far
35843 &`    `&        on &"Completed"& lines: time spent on queue
35844 &`R   `&        on &`<=`& lines: reference for local bounce
35845 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35846 &`S   `&        size of message in bytes
35847 &`SNI `&        server name indication from TLS client hello
35848 &`ST  `&        shadow transport name
35849 &`T   `&        on &`<=`& lines: message subject (topic)
35850 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35851 &`U   `&        local user or RFC 1413 identity
35852 &`X   `&        TLS cipher suite
35853 .endd
35854
35855
35856 .section "Other log entries" "SECID259"
35857 Various other types of log entry are written from time to time. Most should be
35858 self-explanatory. Among the more common are:
35859
35860 .ilist
35861 .cindex "retry" "time not reached"
35862 &'retry time not reached'&&~&~An address previously suffered a temporary error
35863 during routing or local delivery, and the time to retry has not yet arrived.
35864 This message is not written to an individual message log file unless it happens
35865 during the first delivery attempt.
35866 .next
35867 &'retry time not reached for any host'&&~&~An address previously suffered
35868 temporary errors during remote delivery, and the retry time has not yet arrived
35869 for any of the hosts to which it is routed.
35870 .next
35871 .cindex "spool directory" "file locked"
35872 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35873 some other Exim process is already working on the message. This can be quite
35874 common if queue running processes are started at frequent intervals. The
35875 &'exiwhat'& utility script can be used to find out what Exim processes are
35876 doing.
35877 .next
35878 .cindex "error" "ignored"
35879 &'error ignored'&&~&~There are several circumstances that give rise to this
35880 message:
35881 .olist
35882 Exim failed to deliver a bounce message whose age was greater than
35883 &%ignore_bounce_errors_after%&. The bounce was discarded.
35884 .next
35885 A filter file set up a delivery using the &"noerror"& option, and the delivery
35886 failed. The delivery was discarded.
35887 .next
35888 A delivery set up by a router configured with
35889 . ==== As this is a nested list, any displays it contains must be indented
35890 . ==== as otherwise they are too far to the left.
35891 .code
35892     errors_to = <>
35893 .endd
35894 failed. The delivery was discarded.
35895 .endlist olist
35896 .endlist ilist
35897
35898
35899
35900
35901
35902 .section "Reducing or increasing what is logged" "SECTlogselector"
35903 .cindex "log" "selectors"
35904 By setting the &%log_selector%& global option, you can disable some of Exim's
35905 default logging, or you can request additional logging. The value of
35906 &%log_selector%& is made up of names preceded by plus or minus characters. For
35907 example:
35908 .code
35909 log_selector = +arguments -retry_defer
35910 .endd
35911 The list of optional log items is in the following table, with the default
35912 selection marked by asterisks:
35913 .display
35914 &` 8bitmime                   `&  received 8BITMIME status
35915 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35916 &` address_rewrite            `&  address rewriting
35917 &` all_parents                `&  all parents in => lines
35918 &` arguments                  `&  command line arguments
35919 &`*connection_reject          `&  connection rejections
35920 &`*delay_delivery             `&  immediate delivery delayed
35921 &` deliver_time               `&  time taken to perform delivery
35922 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35923 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35924 &` dnssec                     `&  DNSSEC secured lookups
35925 &`*etrn                       `&  ETRN commands
35926 &`*host_lookup_failed         `&  as it says
35927 &` ident_timeout              `&  timeout for ident connection
35928 &` incoming_interface         `&  local interface on <= and => lines
35929 &` incoming_port              `&  remote port on <= lines
35930 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35931 &` outgoing_interface         `&  local interface on => lines
35932 &` outgoing_port              `&  add remote port to => lines
35933 &`*queue_run                  `&  start and end queue runs
35934 &` queue_time                 `&  time on queue for one recipient
35935 &` queue_time_overall         `&  time on queue for whole message
35936 &` pid                        `&  Exim process id
35937 &` proxy                      `&  proxy address on <= and => lines
35938 &` received_recipients        `&  recipients on <= lines
35939 &` received_sender            `&  sender on <= lines
35940 &`*rejected_header            `&  header contents on reject log
35941 &`*retry_defer                `&  &"retry time not reached"&
35942 &` return_path_on_delivery    `&  put return path on => and ** lines
35943 &` sender_on_delivery         `&  add sender to => lines
35944 &`*sender_verify_fail         `&  sender verification failures
35945 &`*size_reject                `&  rejection because too big
35946 &`*skip_delivery              `&  delivery skipped in a queue run
35947 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35948 &` smtp_connection            `&  incoming SMTP connections
35949 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35950 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35951 &` smtp_no_mail               `&  session with no MAIL commands
35952 &` smtp_protocol_error        `&  SMTP protocol errors
35953 &` smtp_syntax_error          `&  SMTP syntax errors
35954 &` subject                    `&  contents of &'Subject:'& on <= lines
35955 &`*tls_certificate_verified   `&  certificate verification status
35956 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35957 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35958 &` tls_sni                    `&  TLS SNI on <= lines
35959 &` unknown_in_list            `&  DNS lookup failed in list match
35960
35961 &` all                        `&  all of the above
35962 .endd
35963 See also the &%slow_lookup_log%& main configuration option,
35964 section &<<SECID99>>&
35965
35966 More details on each of these items follows:
35967
35968 .ilist
35969 .cindex "8BITMIME"
35970 .cindex "log" "8BITMIME"
35971 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35972 which may help in tracking down interoperability issues with ancient MTAs
35973 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35974 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35975 &`7BIT`& and &`8BITMIME`& respectively.
35976 .next
35977 .cindex "&%warn%& ACL verb" "log when skipping"
35978 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35979 its conditions cannot be evaluated, a log line to this effect is written if
35980 this log selector is set.
35981 .next
35982 .cindex "log" "rewriting"
35983 .cindex "rewriting" "logging"
35984 &%address_rewrite%&: This applies both to global rewrites and per-transport
35985 rewrites, but not to rewrites in filters run as an unprivileged user (because
35986 such users cannot access the log).
35987 .next
35988 .cindex "log" "full parentage"
35989 &%all_parents%&: Normally only the original and final addresses are logged on
35990 delivery lines; with this selector, intermediate parents are given in
35991 parentheses between them.
35992 .next
35993 .cindex "log" "Exim arguments"
35994 .cindex "Exim arguments, logging"
35995 &%arguments%&: This causes Exim to write the arguments with which it was called
35996 to the main log, preceded by the current working directory. This is a debugging
35997 feature, added to make it easier to find out how certain MUAs call
35998 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35999 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36000 that are empty or that contain white space are quoted. Non-printing characters
36001 are shown as escape sequences. This facility cannot log unrecognized arguments,
36002 because the arguments are checked before the configuration file is read. The
36003 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36004 between the caller and Exim.
36005 .next
36006 .cindex "log" "connection rejections"
36007 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36008 connection is rejected, for whatever reason.
36009 .next
36010 .cindex "log" "delayed delivery"
36011 .cindex "delayed delivery, logging"
36012 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36013 started for an incoming message because the load is too high or too many
36014 messages were received on one connection. Logging does not occur if no delivery
36015 process is started because &%queue_only%& is set or &%-odq%& was used.
36016 .next
36017 .cindex "log" "delivery duration"
36018 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36019 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36020 .next
36021 .cindex "log" "message size on delivery"
36022 .cindex "size" "of message"
36023 &%delivery_size%&: For each delivery, the size of message delivered is added to
36024 the &"=>"& line, tagged with S=.
36025 .next
36026 .cindex "log" "dnslist defer"
36027 .cindex "DNS list" "logging defer"
36028 .cindex "black list (DNS)"
36029 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36030 DNS black list suffers a temporary error.
36031 .next
36032 .cindex log dnssec
36033 .cindex dnssec logging
36034 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36035 dns lookups gave secure results a tag of DS is added.
36036 For acceptance this covers the reverse and forward lookups for host name verification.
36037 It does not cover helo-name verification.
36038 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36039 .next
36040 .cindex "log" "ETRN commands"
36041 .cindex "ETRN" "logging"
36042 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36043 is run to determine whether or not it is actually accepted. An invalid ETRN
36044 command, or one received within a message transaction is not logged by this
36045 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36046 .next
36047 .cindex "log" "host lookup failure"
36048 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36049 any addresses, or when a lookup of an IP address fails to find a host name, a
36050 log line is written. This logging does not apply to direct DNS lookups when
36051 routing email addresses, but it does apply to &"byname"& lookups.
36052 .next
36053 .cindex "log" "ident timeout"
36054 .cindex "RFC 1413" "logging timeout"
36055 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36056 client's ident port times out.
36057 .next
36058 .cindex "log" "incoming interface"
36059 .cindex "log" "local interface"
36060 .cindex "log" "local address and port"
36061 .cindex "TCP/IP" "logging local address and port"
36062 .cindex "interface" "logging"
36063 &%incoming_interface%&: The interface on which a message was received is added
36064 to the &"<="& line as an IP address in square brackets, tagged by I= and
36065 followed by a colon and the port number. The local interface and port are also
36066 added to other SMTP log lines, for example &"SMTP connection from"&, to
36067 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36068 The latter can be disabled by turning off the &%outgoing_interface%& option.
36069 .next
36070 .cindex log "incoming proxy address"
36071 .cindex proxy "logging proxy address"
36072 .cindex "TCP/IP" "logging proxy address"
36073 &%proxy%&: The internal (closest to the system running Exim) IP address
36074 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36075 on a proxied connection
36076 or the &"=>"& line for a message delivered on a proxied connection.
36077 See &<<SECTproxyInbound>>& for more information.
36078 .next
36079 .cindex "log" "incoming remote port"
36080 .cindex "port" "logging remote"
36081 .cindex "TCP/IP" "logging incoming remote port"
36082 .vindex "&$sender_fullhost$&"
36083 .vindex "&$sender_rcvhost$&"
36084 &%incoming_port%&: The remote port number from which a message was received is
36085 added to log entries and &'Received:'& header lines, following the IP address
36086 in square brackets, and separated from it by a colon. This is implemented by
36087 changing the value that is put in the &$sender_fullhost$& and
36088 &$sender_rcvhost$& variables. Recording the remote port number has become more
36089 important with the widening use of NAT (see RFC 2505).
36090 .next
36091 .cindex "log" "dropped connection"
36092 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36093 connection is unexpectedly dropped.
36094 .next
36095 .cindex "log" "outgoing interface"
36096 .cindex "log" "local interface"
36097 .cindex "log" "local address and port"
36098 .cindex "TCP/IP" "logging local address and port"
36099 .cindex "interface" "logging"
36100 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36101 interface on which a message was sent is added to delivery lines as an I= tag
36102 followed by IP address in square brackets. You can disable this by turning
36103 off the &%outgoing_interface%& option.
36104 .next
36105 .cindex "log" "outgoing remote port"
36106 .cindex "port" "logging outgoint remote"
36107 .cindex "TCP/IP" "logging outgoing remote port"
36108 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36109 containing => tags) following the IP address.
36110 The local port is also added if &%incoming_interface%& and
36111 &%outgoing_interface%& are both enabled.
36112 This option is not included in the default setting, because for most ordinary
36113 configurations, the remote port number is always 25 (the SMTP port), and the
36114 local port is a random ephemeral port.
36115 .next
36116 .cindex "log" "process ids in"
36117 .cindex "pid (process id)" "in log lines"
36118 &%pid%&: The current process id is added to every log line, in square brackets,
36119 immediately after the time and date.
36120 .next
36121 .cindex "log" "queue run"
36122 .cindex "queue runner" "logging"
36123 &%queue_run%&: The start and end of every queue run are logged.
36124 .next
36125 .cindex "log" "queue time"
36126 &%queue_time%&: The amount of time the message has been in the queue on the
36127 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36128 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36129 includes reception time as well as the delivery time for the current address.
36130 This means that it may be longer than the difference between the arrival and
36131 delivery log line times, because the arrival log line is not written until the
36132 message has been successfully received.
36133 .next
36134 &%queue_time_overall%&: The amount of time the message has been in the queue on
36135 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36136 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36137 message, so it includes reception time as well as the total delivery time.
36138 .next
36139 .cindex "log" "recipients"
36140 &%received_recipients%&: The recipients of a message are listed in the main log
36141 as soon as the message is received. The list appears at the end of the log line
36142 that is written when a message is received, preceded by the word &"for"&. The
36143 addresses are listed after they have been qualified, but before any rewriting
36144 has taken place.
36145 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36146 in the list.
36147 .next
36148 .cindex "log" "sender reception"
36149 &%received_sender%&: The unrewritten original sender of a message is added to
36150 the end of the log line that records the message's arrival, after the word
36151 &"from"& (before the recipients if &%received_recipients%& is also set).
36152 .next
36153 .cindex "log" "header lines for rejection"
36154 &%rejected_header%&: If a message's header has been received at the time a
36155 rejection is written to the reject log, the complete header is added to the
36156 log. Header logging can be turned off individually for messages that are
36157 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36158 .next
36159 .cindex "log" "retry defer"
36160 &%retry_defer%&: A log line is written if a delivery is deferred because a
36161 retry time has not yet been reached. However, this &"retry time not reached"&
36162 message is always omitted from individual message logs after the first delivery
36163 attempt.
36164 .next
36165 .cindex "log" "return path"
36166 &%return_path_on_delivery%&: The return path that is being transmitted with
36167 the message is included in delivery and bounce lines, using the tag P=.
36168 This is omitted if no delivery actually happens, for example, if routing fails,
36169 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36170 .next
36171 .cindex "log" "sender on delivery"
36172 &%sender_on_delivery%&: The message's sender address is added to every delivery
36173 and bounce line, tagged by F= (for &"from"&).
36174 This is the original sender that was received with the message; it is not
36175 necessarily the same as the outgoing return path.
36176 .next
36177 .cindex "log" "sender verify failure"
36178 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36179 gives details of a sender verification failure is not written. Log lines for
36180 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36181 detail is lost.
36182 .next
36183 .cindex "log" "size rejection"
36184 &%size_reject%&: A log line is written whenever a message is rejected because
36185 it is too big.
36186 .next
36187 .cindex "log" "frozen messages; skipped"
36188 .cindex "frozen messages" "logging skipping"
36189 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36190 queue run because it is frozen or because another process is already delivering
36191 it.
36192 .cindex "&""spool file is locked""&"
36193 The message that is written is &"spool file is locked"&.
36194 .next
36195 .cindex "log" "smtp confirmation"
36196 .cindex "SMTP" "logging confirmation"
36197 .cindex "LMTP" "logging confirmation"
36198 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36199 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36200 A number of MTAs (including Exim) return an identifying string in this
36201 response.
36202 .next
36203 .cindex "log" "SMTP connections"
36204 .cindex "SMTP" "logging connections"
36205 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36206 established or closed, unless the connection is from a host that matches
36207 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36208 only when the closure is unexpected.) This applies to connections from local
36209 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36210 dropped in the middle of a message, a log line is always written, whether or
36211 not this selector is set, but otherwise nothing is written at the start and end
36212 of connections unless this selector is enabled.
36213
36214 For TCP/IP connections to an Exim daemon, the current number of connections is
36215 included in the log message for each new connection, but note that the count is
36216 reset if the daemon is restarted.
36217 Also, because connections are closed (and the closure is logged) in
36218 subprocesses, the count may not include connections that have been closed but
36219 whose termination the daemon has not yet noticed. Thus, while it is possible to
36220 match up the opening and closing of connections in the log, the value of the
36221 logged counts may not be entirely accurate.
36222 .next
36223 .cindex "log" "SMTP transaction; incomplete"
36224 .cindex "SMTP" "logging incomplete transactions"
36225 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36226 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36227 and the message sender plus any accepted recipients are included in the log
36228 line. This can provide evidence of dictionary attacks.
36229 .next
36230 .cindex "log" "non-MAIL SMTP sessions"
36231 .cindex "MAIL" "logging session without"
36232 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36233 connection terminates without having issued a MAIL command. This includes both
36234 the case when the connection is dropped, and the case when QUIT is used. It
36235 does not include cases where the connection is rejected right at the start (by
36236 an ACL, or because there are too many connections, or whatever). These cases
36237 already have their own log lines.
36238
36239 The log line that is written contains the identity of the client in the usual
36240 way, followed by D= and a time, which records the duration of the connection.
36241 If the connection was authenticated, this fact is logged exactly as it is for
36242 an incoming message, with an A= item. If the connection was encrypted, CV=,
36243 DN=, and X= items may appear as they do for an incoming message, controlled by
36244 the same logging options.
36245
36246 Finally, if any SMTP commands were issued during the connection, a C= item
36247 is added to the line, listing the commands that were used. For example,
36248 .code
36249 C=EHLO,QUIT
36250 .endd
36251 shows that the client issued QUIT straight after EHLO. If there were fewer
36252 than 20 commands, they are all listed. If there were more than 20 commands,
36253 the last 20 are listed, preceded by &"..."&. However, with the default
36254 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36255 have been aborted before 20 non-mail commands are processed.
36256 .next
36257 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36258 colon-separated, is appended to the A= item for a message arrival or delivery
36259 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36260 was accepted or used.
36261 .next
36262 .cindex "log" "SMTP protocol error"
36263 .cindex "SMTP" "logging protocol error"
36264 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36265 encountered. Exim does not have perfect detection of all protocol errors
36266 because of transmission delays and the use of pipelining. If PIPELINING has
36267 been advertised to a client, an Exim server assumes that the client will use
36268 it, and therefore it does not count &"expected"& errors (for example, RCPT
36269 received after rejecting MAIL) as protocol errors.
36270 .next
36271 .cindex "SMTP" "logging syntax errors"
36272 .cindex "SMTP" "syntax errors; logging"
36273 .cindex "SMTP" "unknown command; logging"
36274 .cindex "log" "unknown SMTP command"
36275 .cindex "log" "SMTP syntax error"
36276 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36277 encountered. An unrecognized command is treated as a syntax error. For an
36278 external connection, the host identity is given; for an internal connection
36279 using &%-bs%& the sender identification (normally the calling user) is given.
36280 .next
36281 .cindex "log" "subject"
36282 .cindex "subject, logging"
36283 &%subject%&: The subject of the message is added to the arrival log line,
36284 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36285 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36286 specifies whether characters with values greater than 127 should be logged
36287 unchanged, or whether they should be rendered as escape sequences.
36288 .next
36289 .cindex "log" "certificate verification"
36290 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36291 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36292 verified, and &`CV=no`& if not.
36293 .next
36294 .cindex "log" "TLS cipher"
36295 .cindex "TLS" "logging cipher"
36296 &%tls_cipher%&: When a message is sent or received over an encrypted
36297 connection, the cipher suite used is added to the log line, preceded by X=.
36298 .next
36299 .cindex "log" "TLS peer DN"
36300 .cindex "TLS" "logging peer DN"
36301 &%tls_peerdn%&: When a message is sent or received over an encrypted
36302 connection, and a certificate is supplied by the remote host, the peer DN is
36303 added to the log line, preceded by DN=.
36304 .next
36305 .cindex "log" "TLS SNI"
36306 .cindex "TLS" "logging SNI"
36307 &%tls_sni%&: When a message is received over an encrypted connection, and
36308 the remote host provided the Server Name Indication extension, the SNI is
36309 added to the log line, preceded by SNI=.
36310 .next
36311 .cindex "log" "DNS failure in list"
36312 &%unknown_in_list%&: This setting causes a log entry to be written when the
36313 result of a list match is failure because a DNS lookup failed.
36314 .endlist
36315
36316
36317 .section "Message log" "SECID260"
36318 .cindex "message" "log file for"
36319 .cindex "log" "message log; description of"
36320 .cindex "&_msglog_& directory"
36321 .oindex "&%preserve_message_logs%&"
36322 In addition to the general log files, Exim writes a log file for each message
36323 that it handles. The names of these per-message logs are the message ids, and
36324 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36325 message log contains copies of the log lines that apply to the message. This
36326 makes it easier to inspect the status of an individual message without having
36327 to search the main log. A message log is deleted when processing of the message
36328 is complete, unless &%preserve_message_logs%& is set, but this should be used
36329 only with great care because they can fill up your disk very quickly.
36330
36331 On a heavily loaded system, it may be desirable to disable the use of
36332 per-message logs, in order to reduce disk I/O. This can be done by setting the
36333 &%message_logs%& option false.
36334 .ecindex IIDloggen
36335
36336
36337
36338
36339 . ////////////////////////////////////////////////////////////////////////////
36340 . ////////////////////////////////////////////////////////////////////////////
36341
36342 .chapter "Exim utilities" "CHAPutils"
36343 .scindex IIDutils "utilities"
36344 A number of utility scripts and programs are supplied with Exim and are
36345 described in this chapter. There is also the Exim Monitor, which is covered in
36346 the next chapter. The utilities described here are:
36347
36348 .itable none 0 0 3  7* left  15* left  40* left
36349 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36350   "list what Exim processes are doing"
36351 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36352 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36353 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36354 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36355                                                 various criteria"
36356 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36357 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36358   "extract statistics from the log"
36359 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36360   "check address acceptance from given IP"
36361 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36362 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36363 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36364 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36365 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36366 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36367 .endtable
36368
36369 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36370 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36371 &url(http://duncanthrax.net/exilog/) for details.
36372
36373
36374
36375
36376 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36377 .cindex "&'exiwhat'&"
36378 .cindex "process, querying"
36379 .cindex "SIGUSR1"
36380 On operating systems that can restart a system call after receiving a signal
36381 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36382 a line describing what it is doing to the file &_exim-process.info_& in the
36383 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36384 processes it can find, having first emptied the file. It then waits for one
36385 second to allow the Exim processes to react before displaying the results. In
36386 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36387 send the signal to the Exim processes, so it is normally run as root.
36388
36389 &*Warning*&: This is not an efficient process. It is intended for occasional
36390 use by system administrators. It is not sensible, for example, to set up a
36391 script that sends SIGUSR1 signals to Exim processes at short intervals.
36392
36393
36394 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36395 varies in different operating systems. Not only are different options used,
36396 but the format of the output is different. For this reason, there are some
36397 system configuration options that configure exactly how &'exiwhat'& works. If
36398 it doesn't seem to be working for you, check the following compile-time
36399 options:
36400 .display
36401 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36402 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36403 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36404 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36405 .endd
36406 An example of typical output from &'exiwhat'& is
36407 .code
36408 164 daemon: -q1h, listening on port 25
36409 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36410 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36411   [10.19.42.42] (editor@ref.example)
36412 10592 handling incoming call from [192.168.243.242]
36413 10628 accepting a local non-SMTP message
36414 .endd
36415 The first number in the output line is the process number. The third line has
36416 been split here, in order to fit it on the page.
36417
36418
36419
36420 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36421 .cindex "&'exiqgrep'&"
36422 .cindex "queue" "grepping"
36423 This utility is a Perl script contributed by Matt Hubbard. It runs
36424 .code
36425 exim -bpu
36426 .endd
36427 or (in case &*-a*& switch is specified)
36428 .code
36429 exim -bp
36430 .endd
36431 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36432 contain alternate exim configuration the queue management might be using.
36433
36434 to obtain a queue listing, and then greps the output to select messages
36435 that match given criteria. The following selection options are available:
36436
36437 .vlist
36438 .vitem &*-f*&&~<&'regex'&>
36439 Match the sender address using a case-insensitive search. The field that is
36440 tested is enclosed in angle brackets, so you can test for bounce messages with
36441 .code
36442 exiqgrep -f '^<>$'
36443 .endd
36444 .vitem &*-r*&&~<&'regex'&>
36445 Match a recipient address using a case-insensitive search. The field that is
36446 tested is not enclosed in angle brackets.
36447
36448 .vitem &*-s*&&~<&'regex'&>
36449 Match against the size field.
36450
36451 .vitem &*-y*&&~<&'seconds'&>
36452 Match messages that are younger than the given time.
36453
36454 .vitem &*-o*&&~<&'seconds'&>
36455 Match messages that are older than the given time.
36456
36457 .vitem &*-z*&
36458 Match only frozen messages.
36459
36460 .vitem &*-x*&
36461 Match only non-frozen messages.
36462 .endlist
36463
36464 The following options control the format of the output:
36465
36466 .vlist
36467 .vitem &*-c*&
36468 Display only the count of matching messages.
36469
36470 .vitem &*-l*&
36471 Long format &-- display the full message information as output by Exim. This is
36472 the default.
36473
36474 .vitem &*-i*&
36475 Display message ids only.
36476
36477 .vitem &*-b*&
36478 Brief format &-- one line per message.
36479
36480 .vitem &*-R*&
36481 Display messages in reverse order.
36482
36483 .vitem &*-a*&
36484 Include delivered recipients in queue listing.
36485 .endlist
36486
36487 There is one more option, &%-h%&, which outputs a list of options.
36488
36489
36490
36491 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36492 .cindex "&'exiqsumm'&"
36493 .cindex "queue" "summary"
36494 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36495 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36496 running a command such as
36497 .code
36498 exim -bp | exiqsumm
36499 .endd
36500 The output consists of one line for each domain that has messages waiting for
36501 it, as in the following example:
36502 .code
36503 3   2322   74m   66m  msn.com.example
36504 .endd
36505 Each line lists the number of pending deliveries for a domain, their total
36506 volume, and the length of time that the oldest and the newest messages have
36507 been waiting. Note that the number of pending deliveries is greater than the
36508 number of messages when messages have more than one recipient.
36509
36510 A summary line is output at the end. By default the output is sorted on the
36511 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36512 the output to be sorted by oldest message and by count of messages,
36513 respectively. There are also three options that split the messages for each
36514 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36515 separates frozen messages, and &%-s%& separates messages according to their
36516 sender.
36517
36518 The output of &'exim -bp'& contains the original addresses in the message, so
36519 this also applies to the output from &'exiqsumm'&. No domains from addresses
36520 generated by aliasing or forwarding are included (unless the &%one_time%&
36521 option of the &(redirect)& router has been used to convert them into &"top
36522 level"& addresses).
36523
36524
36525
36526
36527 .section "Extracting specific information from the log (exigrep)" &&&
36528          "SECTextspeinf"
36529 .cindex "&'exigrep'&"
36530 .cindex "log" "extracts; grepping for"
36531 The &'exigrep'& utility is a Perl script that searches one or more main log
36532 files for entries that match a given pattern. When it finds a match, it
36533 extracts all the log entries for the relevant message, not just those that
36534 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36535 given message, or all mail for a given user, or for a given host, for example.
36536 The input files can be in Exim log format or syslog format.
36537 If a matching log line is not associated with a specific message, it is
36538 included in &'exigrep'&'s output without any additional lines. The usage is:
36539 .display
36540 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36541 .endd
36542 If no log file names are given on the command line, the standard input is read.
36543
36544 The &%-t%& argument specifies a number of seconds. It adds an additional
36545 condition for message selection. Messages that are complete are shown only if
36546 they spent more than <&'n'&> seconds on the queue.
36547
36548 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36549 makes it case-sensitive. This may give a performance improvement when searching
36550 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36551 option; with &%-I%& they do not. In both cases it is possible to change the
36552 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36553
36554 The &%-l%& option means &"literal"&, that is, treat all characters in the
36555 pattern as standing for themselves. Otherwise the pattern must be a Perl
36556 regular expression.
36557
36558 The &%-v%& option inverts the matching condition. That is, a line is selected
36559 if it does &'not'& match the pattern.
36560
36561 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36562 that are generated as a result/response to a message that &'exigrep'& matched
36563 normally.
36564
36565 Example of &%-M%&:
36566 user_a sends a message to user_b, which generates a bounce back to user_b. If
36567 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36568 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36569 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36570 when searching for &"user_a"& will show both messages since the bounce is
36571 &"related"& to or a &"result"& of the first message that was found by the
36572 search term.
36573
36574 If the location of a &'zcat'& command is known from the definition of
36575 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36576 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36577 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36578 autodetection of some well known compression extensions.
36579
36580
36581 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36582 .cindex "&'exipick'&"
36583 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36584 lists messages from the queue according to a variety of criteria. For details
36585 of &'exipick'&'s facilities, visit the web page at
36586 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36587 the &%--help%& option.
36588
36589
36590 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36591 .cindex "log" "cycling local files"
36592 .cindex "cycling logs"
36593 .cindex "&'exicyclog'&"
36594 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36595 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36596 you are using log files with datestamps in their names (see section
36597 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36598 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36599 There are two command line options for &'exicyclog'&:
36600 .ilist
36601 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36602 default that is set when Exim is built. The default default is 10.
36603 .next
36604 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36605 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36606 overriding the script's default, which is to find the setting from Exim's
36607 configuration.
36608 .endlist
36609
36610 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36611 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36612 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36613 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36614 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36615 logs are handled similarly.
36616
36617 If the limit is greater than 99, the script uses 3-digit numbers such as
36618 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36619 to one that is greater, or &'vice versa'&, you will have to fix the names of
36620 any existing log files.
36621
36622 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36623 the end are deleted. All files with numbers greater than 01 are compressed,
36624 using a compression command which is configured by the COMPRESS_COMMAND
36625 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36626 root &%crontab%& entry of the form
36627 .code
36628 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36629 .endd
36630 assuming you have used the name &"exim"& for the Exim user. You can run
36631 &'exicyclog'& as root if you wish, but there is no need.
36632
36633
36634
36635 .section "Mail statistics (eximstats)" "SECTmailstat"
36636 .cindex "statistics"
36637 .cindex "&'eximstats'&"
36638 A Perl script called &'eximstats'& is provided for extracting statistical
36639 information from log files. The output is either plain text, or HTML.
36640 Exim log files are also supported by the &'Lire'& system produced by the
36641 LogReport Foundation &url(http://www.logreport.org).
36642
36643 The &'eximstats'& script has been hacked about quite a bit over time. The
36644 latest version is the result of some extensive revision by Steve Campbell. A
36645 lot of information is given by default, but there are options for suppressing
36646 various parts of it. Following any options, the arguments to the script are a
36647 list of files, which should be main log files. For example:
36648 .code
36649 eximstats -nr /var/spool/exim/log/mainlog.01
36650 .endd
36651 By default, &'eximstats'& extracts information about the number and volume of
36652 messages received from or delivered to various hosts. The information is sorted
36653 both by message count and by volume, and the top fifty hosts in each category
36654 are listed on the standard output. Similar information, based on email
36655 addresses or domains instead of hosts can be requested by means of various
36656 options. For messages delivered and received locally, similar statistics are
36657 also produced per user.
36658
36659 The output also includes total counts and statistics about delivery errors, and
36660 histograms showing the number of messages received and deliveries made in each
36661 hour of the day. A delivery with more than one address in its envelope (for
36662 example, an SMTP transaction with more than one RCPT command) is counted
36663 as a single delivery by &'eximstats'&.
36664
36665 Though normally more deliveries than receipts are reported (as messages may
36666 have multiple recipients), it is possible for &'eximstats'& to report more
36667 messages received than delivered, even though the queue is empty at the start
36668 and end of the period in question. If an incoming message contains no valid
36669 recipients, no deliveries are recorded for it. A bounce message is handled as
36670 an entirely separate message.
36671
36672 &'eximstats'& always outputs a grand total summary giving the volume and number
36673 of messages received and deliveries made, and the number of hosts involved in
36674 each case. It also outputs the number of messages that were delayed (that is,
36675 not completely delivered at the first attempt), and the number that had at
36676 least one address that failed.
36677
36678 The remainder of the output is in sections that can be independently disabled
36679 or modified by various options. It consists of a summary of deliveries by
36680 transport, histograms of messages received and delivered per time interval
36681 (default per hour), information about the time messages spent on the queue,
36682 a list of relayed messages, lists of the top fifty sending hosts, local
36683 senders, destination hosts, and destination local users by count and by volume,
36684 and a list of delivery errors that occurred.
36685
36686 The relay information lists messages that were actually relayed, that is, they
36687 came from a remote host and were directly delivered to some other remote host,
36688 without being processed (for example, for aliasing or forwarding) locally.
36689
36690 There are quite a few options for &'eximstats'& to control exactly what it
36691 outputs. These are documented in the Perl script itself, and can be extracted
36692 by running the command &(perldoc)& on the script. For example:
36693 .code
36694 perldoc /usr/exim/bin/eximstats
36695 .endd
36696
36697 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36698 .cindex "&'exim_checkaccess'&"
36699 .cindex "policy control" "checking access"
36700 .cindex "checking access"
36701 The &%-bh%& command line argument allows you to run a fake SMTP session with
36702 debugging output, in order to check what Exim is doing when it is applying
36703 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36704 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36705 sometimes you just want to answer the question &"Does this address have
36706 access?"& without bothering with any further details.
36707
36708 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36709 two arguments, an IP address and an email address:
36710 .code
36711 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36712 .endd
36713 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36714 given email address would be accepted in a RCPT command in a TCP/IP
36715 connection from the host with the given IP address. The output of the utility
36716 is either the word &"accepted"&, or the SMTP error response, for example:
36717 .code
36718 Rejected:
36719 550 Relay not permitted
36720 .endd
36721 When running this test, the utility uses &`<>`& as the envelope sender address
36722 for the MAIL command, but you can change this by providing additional
36723 options. These are passed directly to the Exim command. For example, to specify
36724 that the test is to be run with the sender address &'himself@there.example'&
36725 you can use:
36726 .code
36727 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36728                  -f himself@there.example
36729 .endd
36730 Note that these additional Exim command line items must be given after the two
36731 mandatory arguments.
36732
36733 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36734 while running its checks. You can run checks that include callouts by using
36735 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36736
36737
36738
36739 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36740 .cindex "DBM" "building dbm files"
36741 .cindex "building DBM files"
36742 .cindex "&'exim_dbmbuild'&"
36743 .cindex "lower casing"
36744 .cindex "binary zero" "in lookup key"
36745 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36746 the format used by the &(lsearch)& lookup (see section
36747 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36748 names as keys and the remainder of the information as data. The lower-casing
36749 can be prevented by calling the program with the &%-nolc%& option.
36750
36751 A terminating zero is included as part of the key string. This is expected by
36752 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36753 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36754 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36755 files.
36756
36757 The program requires two arguments: the name of the input file (which can be a
36758 single hyphen to indicate the standard input), and the name of the output file.
36759 It creates the output under a temporary name, and then renames it if all went
36760 well.
36761
36762 .cindex "USE_DB"
36763 If the native DB interface is in use (USE_DB is set in a compile-time
36764 configuration file &-- this is common in free versions of Unix) the two file
36765 names must be different, because in this mode the Berkeley DB functions create
36766 a single output file using exactly the name given. For example,
36767 .code
36768 exim_dbmbuild /etc/aliases /etc/aliases.db
36769 .endd
36770 reads the system alias file and creates a DBM version of it in
36771 &_/etc/aliases.db_&.
36772
36773 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36774 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36775 environment, the suffixes are added to the second argument of
36776 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36777 when the Berkeley functions are used in compatibility mode (though this is not
36778 recommended), because in that case it adds a &_.db_& suffix to the file name.
36779
36780 If a duplicate key is encountered, the program outputs a warning, and when it
36781 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36782 option is used. By default, only the first of a set of duplicates is used &--
36783 this makes it compatible with &(lsearch)& lookups. There is an option
36784 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36785 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36786 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36787 return code is 2.
36788
36789
36790
36791
36792 .section "Finding individual retry times (exinext)" "SECTfinindret"
36793 .cindex "retry" "times"
36794 .cindex "&'exinext'&"
36795 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36796 fish specific information out of the retry database. Given a mail domain (or a
36797 complete address), it looks up the hosts for that domain, and outputs any retry
36798 information for the hosts or for the domain. At present, the retry information
36799 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36800 output. For example:
36801 .code
36802 $ exinext piglet@milne.fict.example
36803 kanga.milne.example:192.168.8.1 error 146: Connection refused
36804   first failed: 21-Feb-1996 14:57:34
36805   last tried:   21-Feb-1996 14:57:34
36806   next try at:  21-Feb-1996 15:02:34
36807 roo.milne.example:192.168.8.3 error 146: Connection refused
36808   first failed: 20-Jan-1996 13:12:08
36809   last tried:   21-Feb-1996 11:42:03
36810   next try at:  21-Feb-1996 19:42:03
36811   past final cutoff time
36812 .endd
36813 You can also give &'exinext'& a local part, without a domain, and it
36814 will give any retry information for that local part in your default domain.
36815 A message id can be used to obtain retry information pertaining to a specific
36816 message. This exists only when an attempt to deliver a message to a remote host
36817 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36818 &'exinext'& is not particularly efficient, but then it is not expected to be
36819 run very often.
36820
36821 The &'exinext'& utility calls Exim to find out information such as the location
36822 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36823 passed on to the &'exim'& commands. The first specifies an alternate Exim
36824 configuration file, and the second sets macros for use within the configuration
36825 file. These features are mainly to help in testing, but might also be useful in
36826 environments where more than one configuration file is in use.
36827
36828
36829
36830 .section "Hints database maintenance" "SECThindatmai"
36831 .cindex "hints database" "maintenance"
36832 .cindex "maintaining Exim's hints database"
36833 Three utility programs are provided for maintaining the DBM files that Exim
36834 uses to contain its delivery hint information. Each program requires two
36835 arguments. The first specifies the name of Exim's spool directory, and the
36836 second is the name of the database it is to operate on. These are as follows:
36837
36838 .ilist
36839 &'retry'&: the database of retry information
36840 .next
36841 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36842 for remote hosts
36843 .next
36844 &'callout'&: the callout cache
36845 .next
36846 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36847 .next
36848 &'misc'&: other hints data
36849 .endlist
36850
36851 The &'misc'& database is used for
36852
36853 .ilist
36854 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36855 .next
36856 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36857 &(smtp)& transport)
36858 .next
36859 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36860 in a transport)
36861 .endlist
36862
36863
36864
36865 .section "exim_dumpdb" "SECID261"
36866 .cindex "&'exim_dumpdb'&"
36867 The entire contents of a database are written to the standard output by the
36868 &'exim_dumpdb'& program, which has no options or arguments other than the
36869 spool and database names. For example, to dump the retry database:
36870 .code
36871 exim_dumpdb /var/spool/exim retry
36872 .endd
36873 Two lines of output are produced for each entry:
36874 .code
36875 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36876 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36877 .endd
36878 The first item on the first line is the key of the record. It starts with one
36879 of the letters R, or T, depending on whether it refers to a routing or
36880 transport retry. For a local delivery, the next part is the local address; for
36881 a remote delivery it is the name of the remote host, followed by its failing IP
36882 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36883 transport). If the remote port is not the standard one (port 25), it is added
36884 to the IP address. Then there follows an error code, an additional error code,
36885 and a textual description of the error.
36886
36887 The three times on the second line are the time of first failure, the time of
36888 the last delivery attempt, and the computed time for the next attempt. The line
36889 ends with an asterisk if the cutoff time for the last retry rule has been
36890 exceeded.
36891
36892 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36893 consists of a host name followed by a list of ids for messages that are or were
36894 waiting to be delivered to that host. If there are a very large number for any
36895 one host, continuation records, with a sequence number added to the host name,
36896 may be seen. The data in these records is often out of date, because a message
36897 may be routed to several alternative hosts, and Exim makes no effort to keep
36898 cross-references.
36899
36900
36901
36902 .section "exim_tidydb" "SECID262"
36903 .cindex "&'exim_tidydb'&"
36904 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36905 database. If run with no options, it removes all records that are more than 30
36906 days old. The age is calculated from the date and time that the record was last
36907 updated. Note that, in the case of the retry database, it is &'not'& the time
36908 since the first delivery failure. Information about a host that has been down
36909 for more than 30 days will remain in the database, provided that the record is
36910 updated sufficiently often.
36911
36912 The cutoff date can be altered by means of the &%-t%& option, which must be
36913 followed by a time. For example, to remove all records older than a week from
36914 the retry database:
36915 .code
36916 exim_tidydb -t 7d /var/spool/exim retry
36917 .endd
36918 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36919 message ids. In the former these appear as data in records keyed by host &--
36920 they were messages that were waiting for that host &-- and in the latter they
36921 are the keys for retry information for messages that have suffered certain
36922 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36923 message ids in database records are those of messages that are still on the
36924 queue. Message ids for messages that no longer exist are removed from
36925 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36926 For the &'retry'& database, records whose keys are non-existent message ids are
36927 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36928 whenever it removes information from the database.
36929
36930 Certain records are automatically removed by Exim when they are no longer
36931 needed, but others are not. For example, if all the MX hosts for a domain are
36932 down, a retry record is created for each one. If the primary MX host comes back
36933 first, its record is removed when Exim successfully delivers to it, but the
36934 records for the others remain because Exim has not tried to use those hosts.
36935
36936 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36937 hints databases. You should do this at a quiet time of day, because it requires
36938 a database to be locked (and therefore inaccessible to Exim) while it does its
36939 work. Removing records from a DBM file does not normally make the file smaller,
36940 but all the common DBM libraries are able to re-use the space that is released.
36941 After an initial phase of increasing in size, the databases normally reach a
36942 point at which they no longer get any bigger, as long as they are regularly
36943 tidied.
36944
36945 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36946 databases is likely to keep on increasing.
36947
36948
36949
36950
36951 .section "exim_fixdb" "SECID263"
36952 .cindex "&'exim_fixdb'&"
36953 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36954 Its main use is for testing Exim, but it might also be occasionally useful for
36955 getting round problems in a live system. It has no options, and its interface
36956 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36957 key of a database record can then be entered, and the data for that record is
36958 displayed.
36959
36960 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36961 except the &'retry'& database, that is the only operation that can be carried
36962 out. For the &'retry'& database, each field is output preceded by a number, and
36963 data for individual fields can be changed by typing the field number followed
36964 by new data, for example:
36965 .code
36966 > 4 951102:1000
36967 .endd
36968 resets the time of the next delivery attempt. Time values are given as a
36969 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36970 used as optional separators.
36971
36972
36973
36974
36975 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36976 .cindex "mailbox" "maintenance"
36977 .cindex "&'exim_lock'&"
36978 .cindex "locking mailboxes"
36979 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36980 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36981 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36982 a user agent while investigating a problem. The utility requires the name of
36983 the file as its first argument. If the locking is successful, the second
36984 argument is run as a command (using C's &[system()]& function); if there is no
36985 second argument, the value of the SHELL environment variable is used; if this
36986 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36987 is unlocked and the utility ends. The following options are available:
36988
36989 .vlist
36990 .vitem &%-fcntl%&
36991 Use &[fcntl()]& locking on the open mailbox.
36992
36993 .vitem &%-flock%&
36994 Use &[flock()]& locking on the open mailbox, provided the operating system
36995 supports it.
36996
36997 .vitem &%-interval%&
36998 This must be followed by a number, which is a number of seconds; it sets the
36999 interval to sleep between retries (default 3).
37000
37001 .vitem &%-lockfile%&
37002 Create a lock file before opening the mailbox.
37003
37004 .vitem &%-mbx%&
37005 Lock the mailbox using MBX rules.
37006
37007 .vitem &%-q%&
37008 Suppress verification output.
37009
37010 .vitem &%-retries%&
37011 This must be followed by a number; it sets the number of times to try to get
37012 the lock (default 10).
37013
37014 .vitem &%-restore_time%&
37015 This option causes &%exim_lock%& to restore the modified and read times to the
37016 locked file before exiting. This allows you to access a locked mailbox (for
37017 example, to take a backup copy) without disturbing the times that the user
37018 subsequently sees.
37019
37020 .vitem &%-timeout%&
37021 This must be followed by a number, which is a number of seconds; it sets a
37022 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37023 default), a non-blocking call is used.
37024
37025 .vitem &%-v%&
37026 Generate verbose output.
37027 .endlist
37028
37029 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37030 default is to create a lock file and also to use &[fcntl()]& locking on the
37031 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37032 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37033 requires that the directory containing the file be writeable. Locking by lock
37034 file does not last for ever; Exim assumes that a lock file is expired if it is
37035 more than 30 minutes old.
37036
37037 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37038 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37039 to be taken out on the open mailbox, and an exclusive lock on the file
37040 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37041 number of the mailbox file. When the locking is released, if an exclusive lock
37042 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37043
37044 The default output contains verification of the locking that takes place. The
37045 &%-v%& option causes some additional information to be given. The &%-q%& option
37046 suppresses all output except error messages.
37047
37048 A command such as
37049 .code
37050 exim_lock /var/spool/mail/spqr
37051 .endd
37052 runs an interactive shell while the file is locked, whereas
37053 .display
37054 &`exim_lock -q /var/spool/mail/spqr <<End`&
37055 <&'some commands'&>
37056 &`End`&
37057 .endd
37058 runs a specific non-interactive sequence of commands while the file is locked,
37059 suppressing all verification output. A single command can be run by a command
37060 such as
37061 .code
37062 exim_lock -q /var/spool/mail/spqr \
37063   "cp /var/spool/mail/spqr /some/where"
37064 .endd
37065 Note that if a command is supplied, it must be entirely contained within the
37066 second argument &-- hence the quotes.
37067 .ecindex IIDutils
37068
37069
37070 . ////////////////////////////////////////////////////////////////////////////
37071 . ////////////////////////////////////////////////////////////////////////////
37072
37073 .chapter "The Exim monitor" "CHAPeximon"
37074 .scindex IIDeximon "Exim monitor" "description"
37075 .cindex "X-windows"
37076 .cindex "&'eximon'&"
37077 .cindex "Local/eximon.conf"
37078 .cindex "&_exim_monitor/EDITME_&"
37079 The Exim monitor is an application which displays in an X window information
37080 about the state of Exim's queue and what Exim is doing. An admin user can
37081 perform certain operations on messages from this GUI interface; however all
37082 such facilities are also available from the command line, and indeed, the
37083 monitor itself makes use of the command line to perform any actions requested.
37084
37085
37086
37087 .section "Running the monitor" "SECID264"
37088 The monitor is started by running the script called &'eximon'&. This is a shell
37089 script that sets up a number of environment variables, and then runs the
37090 binary called &_eximon.bin_&. The default appearance of the monitor window can
37091 be changed by editing the &_Local/eximon.conf_& file created by editing
37092 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37093 parameters are for.
37094
37095 The parameters that get built into the &'eximon'& script can be overridden for
37096 a particular invocation by setting up environment variables of the same names,
37097 preceded by &`EXIMON_`&. For example, a shell command such as
37098 .code
37099 EXIMON_LOG_DEPTH=400 eximon
37100 .endd
37101 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37102 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37103 overrides the Exim log file configuration. This makes it possible to have
37104 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37105 syslog messages are routed to a file on the local host.
37106
37107 X resources can be used to change the appearance of the window in the normal
37108 way. For example, a resource setting of the form
37109 .code
37110 Eximon*background: gray94
37111 .endd
37112 changes the colour of the background to light grey rather than white. The
37113 stripcharts are drawn with both the data lines and the reference lines in
37114 black. This means that the reference lines are not visible when on top of the
37115 data. However, their colour can be changed by setting a resource called
37116 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37117 For example, if your X server is running Unix, you could set up lighter
37118 reference lines in the stripcharts by obeying
37119 .code
37120 xrdb -merge <<End
37121 Eximon*highlight: gray
37122 End
37123 .endd
37124 .cindex "admin user"
37125 In order to see the contents of messages on the queue, and to operate on them,
37126 &'eximon'& must either be run as root or by an admin user.
37127
37128 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37129 contain X11 resource parameters interpreted by the X11 library.  In addition,
37130 if the first parameter starts with the string "gdb" then it is removed and the
37131 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37132 versioned variants of gdb can be invoked).
37133
37134 The monitor's window is divided into three parts. The first contains one or
37135 more stripcharts and two action buttons, the second contains a &"tail"& of the
37136 main log file, and the third is a display of the queue of messages awaiting
37137 delivery, with two more action buttons. The following sections describe these
37138 different parts of the display.
37139
37140
37141
37142
37143 .section "The stripcharts" "SECID265"
37144 .cindex "stripchart"
37145 The first stripchart is always a count of messages on the queue. Its name can
37146 be configured by setting QUEUE_STRIPCHART_NAME in the
37147 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37148 configuration script by regular expression matches on log file entries, making
37149 it possible to display, for example, counts of messages delivered to certain
37150 hosts or using certain transports. The supplied defaults display counts of
37151 received and delivered messages, and of local and SMTP deliveries. The default
37152 period between stripchart updates is one minute; this can be adjusted by a
37153 parameter in the &_Local/eximon.conf_& file.
37154
37155 The stripchart displays rescale themselves automatically as the value they are
37156 displaying changes. There are always 10 horizontal lines in each chart; the
37157 title string indicates the value of each division when it is greater than one.
37158 For example, &"x2"& means that each division represents a value of 2.
37159
37160 It is also possible to have a stripchart which shows the percentage fullness of
37161 a particular disk partition, which is useful when local deliveries are confined
37162 to a single partition.
37163
37164 .cindex "&%statvfs%& function"
37165 This relies on the availability of the &[statvfs()]& function or equivalent in
37166 the operating system. Most, but not all versions of Unix that support Exim have
37167 this. For this particular stripchart, the top of the chart always represents
37168 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37169 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37170 &_Local/eximon.conf_& file.
37171
37172
37173
37174
37175 .section "Main action buttons" "SECID266"
37176 .cindex "size" "of monitor window"
37177 .cindex "Exim monitor" "window size"
37178 .cindex "window size"
37179 Below the stripcharts there is an action button for quitting the monitor. Next
37180 to this is another button marked &"Size"&. They are placed here so that
37181 shrinking the window to its default minimum size leaves just the queue count
37182 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37183 the window to expand to its maximum size, unless it is already at the maximum,
37184 in which case it is reduced to its minimum.
37185
37186 When expanding to the maximum, if the window cannot be fully seen where it
37187 currently is, it is moved back to where it was the last time it was at full
37188 size. When it is expanding from its minimum size, the old position is
37189 remembered, and next time it is reduced to the minimum it is moved back there.
37190
37191 The idea is that you can keep a reduced window just showing one or two
37192 stripcharts at a convenient place on your screen, easily expand it to show
37193 the full window when required, and just as easily put it back to what it was.
37194 The idea is copied from what the &'twm'& window manager does for its
37195 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37196 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37197
37198 Normally, the monitor starts up with the window at its full size, but it can be
37199 built so that it starts up with the window at its smallest size, by setting
37200 START_SMALL=yes in &_Local/eximon.conf_&.
37201
37202
37203
37204 .section "The log display" "SECID267"
37205 .cindex "log" "tail of; in monitor"
37206 The second section of the window is an area in which a display of the tail of
37207 the main log is maintained.
37208 To save space on the screen, the timestamp on each log line is shortened by
37209 removing the date and, if &%log_timezone%& is set, the timezone.
37210 The log tail is not available when the only destination for logging data is
37211 syslog, unless the syslog lines are routed to a local file whose name is passed
37212 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37213
37214 The log sub-window has a scroll bar at its lefthand side which can be used to
37215 move back to look at earlier text, and the up and down arrow keys also have a
37216 scrolling effect. The amount of log that is kept depends on the setting of
37217 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37218 to use. When this is full, the earlier 50% of data is discarded &-- this is
37219 much more efficient than throwing it away line by line. The sub-window also has
37220 a horizontal scroll bar for accessing the ends of long log lines. This is the
37221 only means of horizontal scrolling; the right and left arrow keys are not
37222 available. Text can be cut from this part of the window using the mouse in the
37223 normal way. The size of this subwindow is controlled by parameters in the
37224 configuration file &_Local/eximon.conf_&.
37225
37226 Searches of the text in the log window can be carried out by means of the ^R
37227 and ^S keystrokes, which default to a reverse and a forward search,
37228 respectively. The search covers only the text that is displayed in the window.
37229 It cannot go further back up the log.
37230
37231 The point from which the search starts is indicated by a caret marker. This is
37232 normally at the end of the text in the window, but can be positioned explicitly
37233 by pointing and clicking with the left mouse button, and is moved automatically
37234 by a successful search. If new text arrives in the window when it is scrolled
37235 back, the caret remains where it is, but if the window is not scrolled back,
37236 the caret is moved to the end of the new text.
37237
37238 Pressing ^R or ^S pops up a window into which the search text can be typed.
37239 There are buttons for selecting forward or reverse searching, for carrying out
37240 the search, and for cancelling. If the &"Search"& button is pressed, the search
37241 happens and the window remains so that further searches can be done. If the
37242 &"Return"& key is pressed, a single search is done and the window is closed. If
37243 ^C is typed the search is cancelled.
37244
37245 The searching facility is implemented using the facilities of the Athena text
37246 widget. By default this pops up a window containing both &"search"& and
37247 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37248 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37249 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37250 provided version of &%TextPop%& when the remaining parts of the text widget
37251 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37252 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37253 on these systems, at the expense of having unwanted items in the search popup
37254 window.
37255
37256
37257
37258 .section "The queue display" "SECID268"
37259 .cindex "queue" "display in monitor"
37260 The bottom section of the monitor window contains a list of all messages that
37261 are on the queue, which includes those currently being received or delivered,
37262 as well as those awaiting delivery. The size of this subwindow is controlled by
37263 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37264 at which it is updated is controlled by another parameter in the same file &--
37265 the default is 5 minutes, since queue scans can be quite expensive. However,
37266 there is an &"Update"& action button just above the display which can be used
37267 to force an update of the queue display at any time.
37268
37269 When a host is down for some time, a lot of pending mail can build up for it,
37270 and this can make it hard to deal with other messages on the queue. To help
37271 with this situation there is a button next to &"Update"& called &"Hide"&. If
37272 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37273 type anything in here and press &"Return"&, the text is added to a chain of
37274 such texts, and if every undelivered address in a message matches at least one
37275 of the texts, the message is not displayed.
37276
37277 If there is an address that does not match any of the texts, all the addresses
37278 are displayed as normal. The matching happens on the ends of addresses so, for
37279 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37280 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37281 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37282 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37283 a hide request is automatically cancelled after one hour.
37284
37285 While the dialogue box is displayed, you can't press any buttons or do anything
37286 else to the monitor window. For this reason, if you want to cut text from the
37287 queue display to use in the dialogue box, you have to do the cutting before
37288 pressing the &"Hide"& button.
37289
37290 The queue display contains, for each unhidden queued message, the length of
37291 time it has been on the queue, the size of the message, the message id, the
37292 message sender, and the first undelivered recipient, all on one line. If it is
37293 a bounce message, the sender is shown as &"<>"&. If there is more than one
37294 recipient to which the message has not yet been delivered, subsequent ones are
37295 listed on additional lines, up to a maximum configured number, following which
37296 an ellipsis is displayed. Recipients that have already received the message are
37297 not shown.
37298
37299 .cindex "frozen messages" "display"
37300 If a message is frozen, an asterisk is displayed at the left-hand side.
37301
37302 The queue display has a vertical scroll bar, and can also be scrolled by means
37303 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37304 The text searching facilities, as described above for the log window, are also
37305 available, but the caret is always moved to the end of the text when the queue
37306 display is updated.
37307
37308
37309
37310 .section "The queue menu" "SECID269"
37311 .cindex "queue" "menu in monitor"
37312 If the &%shift%& key is held down and the left button is clicked when the mouse
37313 pointer is over the text for any message, an action menu pops up, and the first
37314 line of the queue display for the message is highlighted. This does not affect
37315 any selected text.
37316
37317 If you want to use some other event for popping up the menu, you can set the
37318 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37319 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37320 value set in this parameter is a standard X event description. For example, to
37321 run eximon using &%ctrl%& rather than &%shift%& you could use
37322 .code
37323 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37324 .endd
37325 The title of the menu is the message id, and it contains entries which act as
37326 follows:
37327
37328 .ilist
37329 &'message log'&: The contents of the message log for the message are displayed
37330 in a new text window.
37331 .next
37332 &'headers'&: Information from the spool file that contains the envelope
37333 information and headers is displayed in a new text window. See chapter
37334 &<<CHAPspool>>& for a description of the format of spool files.
37335 .next
37336 &'body'&: The contents of the spool file containing the body of the message are
37337 displayed in a new text window. There is a default limit of 20,000 bytes to the
37338 amount of data displayed. This can be changed by setting the BODY_MAX
37339 option at compile time, or the EXIMON_BODY_MAX option at run time.
37340 .next
37341 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37342 delivery of the message. This causes an automatic thaw if the message is
37343 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37344 a new text window. The delivery is run in a separate process, to avoid holding
37345 up the monitor while the delivery proceeds.
37346 .next
37347 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37348 that the message be frozen.
37349 .next
37350 .cindex "thawing messages"
37351 .cindex "unfreezing messages"
37352 .cindex "frozen messages" "thawing"
37353 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37354 that the message be thawed.
37355 .next
37356 .cindex "delivery" "forcing failure"
37357 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37358 that Exim gives up trying to deliver the message. A bounce message is generated
37359 for any remaining undelivered addresses.
37360 .next
37361 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37362 that the message be deleted from the system without generating a bounce
37363 message.
37364 .next
37365 &'add recipient'&: A dialog box is displayed into which a recipient address can
37366 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37367 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37368 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37369 causes a call to Exim to be made using the &%-Mar%& option to request that an
37370 additional recipient be added to the message, unless the entry box is empty, in
37371 which case no action is taken.
37372 .next
37373 &'mark delivered'&: A dialog box is displayed into which a recipient address
37374 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37375 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37376 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37377 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37378 recipient address as already delivered, unless the entry box is empty, in which
37379 case no action is taken.
37380 .next
37381 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37382 mark all recipient addresses as already delivered.
37383 .next
37384 &'edit sender'&: A dialog box is displayed initialized with the current
37385 sender's address. Pressing RETURN causes a call to Exim to be made using the
37386 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37387 in which case no action is taken. If you want to set an empty sender (as in
37388 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37389 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37390 the address is qualified with that domain.
37391 .endlist
37392
37393 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37394 other cases when a call to Exim is made, if there is any output from Exim (in
37395 particular, if the command fails) a window containing the command and the
37396 output is displayed. Otherwise, the results of the action are normally apparent
37397 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37398 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37399 if no output is generated.
37400
37401 The queue display is automatically updated for actions such as freezing and
37402 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37403 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37404 force an update of the display after one of these actions.
37405
37406 In any text window that is displayed as result of a menu action, the normal
37407 cut-and-paste facility is available, and searching can be carried out using ^R
37408 and ^S, as described above for the log tail window.
37409 .ecindex IIDeximon
37410
37411
37412
37413
37414
37415 . ////////////////////////////////////////////////////////////////////////////
37416 . ////////////////////////////////////////////////////////////////////////////
37417
37418 .chapter "Security considerations" "CHAPsecurity"
37419 .scindex IIDsecurcon "security" "discussion of"
37420 This chapter discusses a number of issues concerned with security, some of
37421 which are also covered in other parts of this manual.
37422
37423 For reasons that this author does not understand, some people have promoted
37424 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37425 existence of this chapter in the documentation. However, the intent of the
37426 chapter is simply to describe the way Exim works in relation to certain
37427 security concerns, not to make any specific claims about the effectiveness of
37428 its security as compared with other MTAs.
37429
37430 What follows is a description of the way Exim is supposed to be. Best efforts
37431 have been made to try to ensure that the code agrees with the theory, but an
37432 absence of bugs can never be guaranteed. Any that are reported will get fixed
37433 as soon as possible.
37434
37435
37436 .section "Building a more &""hardened""& Exim" "SECID286"
37437 .cindex "security" "build-time features"
37438 There are a number of build-time options that can be set in &_Local/Makefile_&
37439 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37440 Exim administrator who does not have the root password, or by someone who has
37441 penetrated the Exim (but not the root) account. These options are as follows:
37442
37443 .ilist
37444 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37445 start of any file names used with the &%-C%& option. When it is set, these file
37446 names are also not allowed to contain the sequence &"/../"&. (However, if the
37447 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37448 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37449 default setting for &%ALT_CONFIG_PREFIX%&.
37450
37451 If the permitted configuration files are confined to a directory to
37452 which only root has access, this guards against someone who has broken
37453 into the Exim account from running a privileged Exim with an arbitrary
37454 configuration file, and using it to break into other accounts.
37455 .next
37456
37457 If a non-trusted configuration file (i.e. not the default configuration file
37458 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37459 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37460 the next item), then root privilege is retained only if the caller of Exim is
37461 root. This locks out the possibility of testing a configuration using &%-C%&
37462 right through message reception and delivery, even if the caller is root. The
37463 reception works, but by that time, Exim is running as the Exim user, so when
37464 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37465 privilege to be lost. However, root can test reception and delivery using two
37466 separate commands.
37467
37468 .next
37469 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37470 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37471 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37472 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37473 the restrictive side.  Requiring build-time selection of safe macros is onerous
37474 but this option is intended solely as a transition mechanism to permit
37475 previously-working configurations to continue to work after release 4.73.
37476 .next
37477 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37478 is disabled.
37479 .next
37480 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37481 never to be used for any deliveries. This is like the &%never_users%& runtime
37482 option, but it cannot be overridden; the runtime option adds additional users
37483 to the list. The default setting is &"root"&; this prevents a non-root user who
37484 is permitted to modify the runtime file from using Exim as a way to get root.
37485 .endlist
37486
37487
37488
37489 .section "Root privilege" "SECID270"
37490 .cindex "setuid"
37491 .cindex "root privilege"
37492 The Exim binary is normally setuid to root, which means that it gains root
37493 privilege (runs as root) when it starts execution. In some special cases (for
37494 example, when the daemon is not in use and there are no local deliveries), it
37495 may be possible to run Exim setuid to some user other than root. This is
37496 discussed in the next section. However, in most installations, root privilege
37497 is required for two things:
37498
37499 .ilist
37500 To set up a socket connected to the standard SMTP port (25) when initialising
37501 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37502 not required.
37503 .next
37504 To be able to change uid and gid in order to read users' &_.forward_& files and
37505 perform local deliveries as the receiving user or as specified in the
37506 configuration.
37507 .endlist
37508
37509 It is not necessary to be root to do any of the other things Exim does, such as
37510 receiving messages and delivering them externally over SMTP, and it is
37511 obviously more secure if Exim does not run as root except when necessary.
37512 For this reason, a user and group for Exim to use must be defined in
37513 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37514 group"&. Their values can be changed by the run time configuration, though this
37515 is not recommended. Often a user called &'exim'& is used, but some sites use
37516 &'mail'& or another user name altogether.
37517
37518 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37519 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37520 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37521
37522 After a new Exim process has interpreted its command line options, it changes
37523 uid and gid in the following cases:
37524
37525 .ilist
37526 .oindex "&%-C%&"
37527 .oindex "&%-D%&"
37528 If the &%-C%& option is used to specify an alternate configuration file, or if
37529 the &%-D%& option is used to define macro values for the configuration, and the
37530 calling process is not running as root, the uid and gid are changed to those of
37531 the calling process.
37532 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37533 option may not be used at all.
37534 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37535 can be supplied if the calling process is running as root, the Exim run-time
37536 user or CONFIGURE_OWNER, if defined.
37537 .next
37538 .oindex "&%-be%&"
37539 .oindex "&%-bf%&"
37540 .oindex "&%-bF%&"
37541 If the expansion test option (&%-be%&) or one of the filter testing options
37542 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37543 calling process.
37544 .next
37545 If the process is not a daemon process or a queue runner process or a delivery
37546 process or a process for testing address routing (started with &%-bt%&), the
37547 uid and gid are changed to the Exim user and group. This means that Exim always
37548 runs under its own uid and gid when receiving messages. This also applies when
37549 testing address verification
37550 .oindex "&%-bv%&"
37551 .oindex "&%-bh%&"
37552 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37553 option).
37554 .next
37555 For a daemon, queue runner, delivery, or address testing process, the uid
37556 remains as root at this stage, but the gid is changed to the Exim group.
37557 .endlist
37558
37559 The processes that initially retain root privilege behave as follows:
37560
37561 .ilist
37562 A daemon process changes the gid to the Exim group and the uid to the Exim
37563 user after setting up one or more listening sockets. The &[initgroups()]&
37564 function is called, so that if the Exim user is in any additional groups, they
37565 will be used during message reception.
37566 .next
37567 A queue runner process retains root privilege throughout its execution. Its
37568 job is to fork a controlled sequence of delivery processes.
37569 .next
37570 A delivery process retains root privilege throughout most of its execution,
37571 but any actual deliveries (that is, the transports themselves) are run in
37572 subprocesses which always change to a non-root uid and gid. For local
37573 deliveries this is typically the uid and gid of the owner of the mailbox; for
37574 remote deliveries, the Exim uid and gid are used. Once all the delivery
37575 subprocesses have been run, a delivery process changes to the Exim uid and gid
37576 while doing post-delivery tidying up such as updating the retry database and
37577 generating bounce and warning messages.
37578
37579 While the recipient addresses in a message are being routed, the delivery
37580 process runs as root. However, if a user's filter file has to be processed,
37581 this is done in a subprocess that runs under the individual user's uid and
37582 gid. A system filter is run as root unless &%system_filter_user%& is set.
37583 .next
37584 A process that is testing addresses (the &%-bt%& option) runs as root so that
37585 the routing is done in the same environment as a message delivery.
37586 .endlist
37587
37588
37589
37590
37591 .section "Running Exim without privilege" "SECTrunexiwitpri"
37592 .cindex "privilege, running without"
37593 .cindex "unprivileged running"
37594 .cindex "root privilege" "running without"
37595 Some installations like to run Exim in an unprivileged state for more of its
37596 operation, for added security. Support for this mode of operation is provided
37597 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37598 gid are changed to the Exim user and group at the start of a delivery process
37599 (and also queue runner and address testing processes). This means that address
37600 routing is no longer run as root, and the deliveries themselves cannot change
37601 to any other uid.
37602
37603 .cindex SIGHUP
37604 .cindex "daemon" "restarting"
37605 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37606 that the daemon can still be started in the usual way, and it can respond
37607 correctly to SIGHUP because the re-invocation regains root privilege.
37608
37609 An alternative approach is to make Exim setuid to the Exim user and also setgid
37610 to the Exim group. If you do this, the daemon must be started from a root
37611 process. (Calling Exim from a root process makes it behave in the way it does
37612 when it is setuid root.) However, the daemon cannot restart itself after a
37613 SIGHUP signal because it cannot regain privilege.
37614
37615 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37616 stops Exim from trying to re-invoke itself to do a delivery after a message has
37617 been received. Such a re-invocation is a waste of resources because it has no
37618 effect.
37619
37620 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37621 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37622 to the Exim user seems a clean approach, but there is one complication:
37623
37624 In this style of operation, Exim is running with the real uid and gid set to
37625 those of the calling process, and the effective uid/gid set to Exim's values.
37626 Ideally, any association with the calling process' uid/gid should be dropped,
37627 that is, the real uid/gid should be reset to the effective values so as to
37628 discard any privileges that the caller may have. While some operating systems
37629 have a function that permits this action for a non-root effective uid, quite a
37630 number of them do not. Because of this lack of standardization, Exim does not
37631 address this problem at this time.
37632
37633 For this reason, the recommended approach for &"mostly unprivileged"& running
37634 is to keep the Exim binary setuid to root, and to set
37635 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37636 be used in the most straightforward way.
37637
37638 If you configure Exim not to run delivery processes as root, there are a
37639 number of restrictions on what you can do:
37640
37641 .ilist
37642 You can deliver only as the Exim user/group. You should  explicitly use the
37643 &%user%& and &%group%& options to override routers or local transports that
37644 normally deliver as the recipient. This makes sure that configurations that
37645 work in this mode function the same way in normal mode. Any implicit or
37646 explicit specification of another user causes an error.
37647 .next
37648 Use of &_.forward_& files is severely restricted, such that it is usually
37649 not worthwhile to include them in the configuration.
37650 .next
37651 Users who wish to use &_.forward_& would have to make their home directory and
37652 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37653 and their equivalents in Exim filters, cannot be used. While they could be
37654 enabled in the Exim user's name, that would be insecure and not very useful.
37655 .next
37656 Unless the local user mailboxes are all owned by the Exim user (possible in
37657 some POP3 or IMAP-only environments):
37658
37659 .olist
37660 They must be owned by the Exim group and be writeable by that group. This
37661 implies you must set &%mode%& in the appendfile configuration, as well as the
37662 mode of the mailbox files themselves.
37663 .next
37664 You must set &%no_check_owner%&, since most or all of the files will not be
37665 owned by the Exim user.
37666 .next
37667 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37668 on a newly created mailbox when unprivileged. This also implies that new
37669 mailboxes need to be created manually.
37670 .endlist olist
37671 .endlist ilist
37672
37673
37674 These restrictions severely restrict what can be done in local deliveries.
37675 However, there are no restrictions on remote deliveries. If you are running a
37676 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37677 gives more security at essentially no cost.
37678
37679 If you are using the &%mua_wrapper%& facility (see chapter
37680 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37681
37682
37683
37684
37685 .section "Delivering to local files" "SECID271"
37686 Full details of the checks applied by &(appendfile)& before it writes to a file
37687 are given in chapter &<<CHAPappendfile>>&.
37688
37689
37690
37691 .section "Running local commands" "SECTsecconslocalcmds"
37692 .cindex "security" "local commands"
37693 .cindex "security" "command injection attacks"
37694 There are a number of ways in which an administrator can configure Exim to run
37695 commands based upon received, untrustworthy, data. Further, in some
37696 configurations a user who can control a &_.forward_& file can also arrange to
37697 run commands. Configuration to check includes, but is not limited to:
37698
37699 .ilist
37700 Use of &%use_shell%& in the pipe transport: various forms of shell command
37701 injection may be possible with this option present. It is dangerous and should
37702 be used only with considerable caution. Consider constraints which whitelist
37703 allowed characters in a variable which is to be used in a pipe transport that
37704 has &%use_shell%& enabled.
37705 .next
37706 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37707 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37708 &_.forward_& files in a redirect router. If Exim is running on a central mail
37709 hub to which ordinary users do not have shell access, but home directories are
37710 NFS mounted (for instance) then administrators should review the list of these
37711 forbid options available, and should bear in mind that the options that may
37712 need forbidding can change as new features are added between releases.
37713 .next
37714 The &%${run...}%& expansion item does not use a shell by default, but
37715 administrators can configure use of &_/bin/sh_& as part of the command.
37716 Such invocations should be viewed with prejudicial suspicion.
37717 .next
37718 Administrators who use embedded Perl are advised to explore how Perl's
37719 taint checking might apply to their usage.
37720 .next
37721 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37722 administrators are well advised to view its use with suspicion, in case (for
37723 instance) it allows a local-part to contain embedded Exim directives.
37724 .next
37725 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37726 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37727 each can reference arbitrary lists and files, rather than just being a list
37728 of opaque strings.
37729 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37730 real-world security vulnerabilities caused by its use with untrustworthy data
37731 injected in, for SQL injection attacks.
37732 Consider the use of the &%inlisti%& expansion condition instead.
37733 .endlist
37734
37735
37736
37737
37738 .section "Trust in configuration data" "SECTsecconfdata"
37739 .cindex "security" "data sources"
37740 .cindex "security" "regular expressions"
37741 .cindex "regular expressions" "security"
37742 .cindex "PCRE" "security"
37743 If configuration data for Exim can come from untrustworthy sources, there
37744 are some issues to be aware of:
37745
37746 .ilist
37747 Use of &%${expand...}%& may provide a path for shell injection attacks.
37748 .next
37749 Letting untrusted data provide a regular expression is unwise.
37750 .next
37751 Using &%${match...}%& to apply a fixed regular expression against untrusted
37752 data may result in pathological behaviour within PCRE.  Be aware of what
37753 "backtracking" means and consider options for being more strict with a regular
37754 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37755 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37756 possessive quantifiers or just not using regular expressions against untrusted
37757 data.
37758 .next
37759 It can be important to correctly use &%${quote:...}%&,
37760 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37761 items to ensure that data is correctly constructed.
37762 .next
37763 Some lookups might return multiple results, even though normal usage is only
37764 expected to yield one result.
37765 .endlist
37766
37767
37768
37769
37770 .section "IPv4 source routing" "SECID272"
37771 .cindex "source routing" "in IP packets"
37772 .cindex "IP source routing"
37773 Many operating systems suppress IP source-routed packets in the kernel, but
37774 some cannot be made to do this, so Exim does its own check. It logs incoming
37775 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37776 IPv6. No special checking is currently done.
37777
37778
37779
37780 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37781 Support for these SMTP commands is disabled by default. If required, they can
37782 be enabled by defining suitable ACLs.
37783
37784
37785
37786
37787 .section "Privileged users" "SECID274"
37788 .cindex "trusted users"
37789 .cindex "admin user"
37790 .cindex "privileged user"
37791 .cindex "user" "trusted"
37792 .cindex "user" "admin"
37793 Exim recognizes two sets of users with special privileges. Trusted users are
37794 able to submit new messages to Exim locally, but supply their own sender
37795 addresses and information about a sending host. For other users submitting
37796 local messages, Exim sets up the sender address from the uid, and doesn't
37797 permit a remote host to be specified.
37798
37799 .oindex "&%-f%&"
37800 However, an untrusted user is permitted to use the &%-f%& command line option
37801 in the special form &%-f <>%& to indicate that a delivery failure for the
37802 message should not cause an error report. This affects the message's envelope,
37803 but it does not affect the &'Sender:'& header. Untrusted users may also be
37804 permitted to use specific forms of address with the &%-f%& option by setting
37805 the &%untrusted_set_sender%& option.
37806
37807 Trusted users are used to run processes that receive mail messages from some
37808 other mail domain and pass them on to Exim for delivery either locally, or over
37809 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37810 as any user listed in the &%trusted_users%& configuration option, or under any
37811 group listed in the &%trusted_groups%& option.
37812
37813 Admin users are permitted to do things to the messages on Exim's queue. They
37814 can freeze or thaw messages, cause them to be returned to their senders, remove
37815 them entirely, or modify them in various ways. In addition, admin users can run
37816 the Exim monitor and see all the information it is capable of providing, which
37817 includes the contents of files on the spool.
37818
37819 .oindex "&%-M%&"
37820 .oindex "&%-q%&"
37821 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37822 delivery of messages on its queue is restricted to admin users. This
37823 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37824 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37825 queue is also restricted to admin users. This restriction can be relaxed by
37826 setting &%no_queue_list_requires_admin%&.
37827
37828 Exim recognizes an admin user if the calling process is running as root or as
37829 the Exim user or if any of the groups associated with the calling process is
37830 the Exim group. It is not necessary actually to be running under the Exim
37831 group. However, if admin users who are not root or the Exim user are to access
37832 the contents of files on the spool via the Exim monitor (which runs
37833 unprivileged), Exim must be built to allow group read access to its spool
37834 files.
37835
37836
37837
37838 .section "Spool files" "SECID275"
37839 .cindex "spool directory" "files"
37840 Exim's spool directory and everything it contains is owned by the Exim user and
37841 set to the Exim group. The mode for spool files is defined in the
37842 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37843 any user who is a member of the Exim group can access these files.
37844
37845
37846
37847 .section "Use of argv[0]" "SECID276"
37848 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37849 of specific strings, Exim assumes certain options. For example, calling Exim
37850 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37851 to calling it with the option &%-bS%&. There are no security implications in
37852 this.
37853
37854
37855
37856 .section "Use of %f formatting" "SECID277"
37857 The only use made of &"%f"& by Exim is in formatting load average values. These
37858 are actually stored in integer variables as 1000 times the load average.
37859 Consequently, their range is limited and so therefore is the length of the
37860 converted output.
37861
37862
37863
37864 .section "Embedded Exim path" "SECID278"
37865 Exim uses its own path name, which is embedded in the code, only when it needs
37866 to re-exec in order to regain root privilege. Therefore, it is not root when it
37867 does so. If some bug allowed the path to get overwritten, it would lead to an
37868 arbitrary program's being run as exim, not as root.
37869
37870
37871
37872 .section "Dynamic module directory" "SECTdynmoddir"
37873 Any dynamically loadable modules must be installed into the directory
37874 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37875 loading it.
37876
37877
37878 .section "Use of sprintf()" "SECID279"
37879 .cindex "&[sprintf()]&"
37880 A large number of occurrences of &"sprintf"& in the code are actually calls to
37881 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37882 The intermediate formatting is done into a large fixed buffer by a function
37883 that runs through the format string itself, and checks the length of each
37884 conversion before performing it, thus preventing buffer overruns.
37885
37886 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37887 the output buffer is known to be sufficiently long to contain the converted
37888 string.
37889
37890
37891
37892 .section "Use of debug_printf() and log_write()" "SECID280"
37893 Arbitrary strings are passed to both these functions, but they do their
37894 formatting by calling the function &'string_vformat()'&, which runs through
37895 the format string itself, and checks the length of each conversion.
37896
37897
37898
37899 .section "Use of strcat() and strcpy()" "SECID281"
37900 These are used only in cases where the output buffer is known to be large
37901 enough to hold the result.
37902 .ecindex IIDsecurcon
37903
37904
37905
37906
37907 . ////////////////////////////////////////////////////////////////////////////
37908 . ////////////////////////////////////////////////////////////////////////////
37909
37910 .chapter "Format of spool files" "CHAPspool"
37911 .scindex IIDforspo1 "format" "spool files"
37912 .scindex IIDforspo2 "spool directory" "format of files"
37913 .scindex IIDforspo3 "spool files" "format of"
37914 .cindex "spool files" "editing"
37915 A message on Exim's queue consists of two files, whose names are the message id
37916 followed by -D and -H, respectively. The data portion of the message is kept in
37917 the -D file on its own. The message's envelope, status, and headers are all
37918 kept in the -H file, whose format is described in this chapter. Each of these
37919 two files contains the final component of its own name as its first line. This
37920 is insurance against disk crashes where the directory is lost but the files
37921 themselves are recoverable.
37922
37923 Some people are tempted into editing -D files in order to modify messages. You
37924 need to be extremely careful if you do this; it is not recommended and you are
37925 on your own if you do it. Here are some of the pitfalls:
37926
37927 .ilist
37928 You must ensure that Exim does not try to deliver the message while you are
37929 fiddling with it. The safest way is to take out a write lock on the -D file,
37930 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37931 place, the lock will be retained. If you write a new file and rename it, the
37932 lock will be lost at the instant of rename.
37933 .next
37934 .vindex "&$body_linecount$&"
37935 If you change the number of lines in the file, the value of
37936 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
37937 cause incomplete transmission of messages or undeliverable messages.
37938 .next
37939 If the message is in MIME format, you must take care not to break it.
37940 .next
37941 If the message is cryptographically signed, any change will invalidate the
37942 signature.
37943 .endlist
37944 All in all, modifying -D files is fraught with danger.
37945
37946 Files whose names end with -J may also be seen in the &_input_& directory (or
37947 its subdirectories when &%split_spool_directory%& is set). These are journal
37948 files, used to record addresses to which the message has been delivered during
37949 the course of a delivery attempt. If there are still undelivered recipients at
37950 the end, the -H file is updated, and the -J file is deleted. If, however, there
37951 is some kind of crash (for example, a power outage) before this happens, the -J
37952 file remains in existence. When Exim next processes the message, it notices the
37953 -J file and uses it to update the -H file before starting the next delivery
37954 attempt.
37955
37956 .section "Format of the -H file" "SECID282"
37957 .cindex "uid (user id)" "in spool file"
37958 .cindex "gid (group id)" "in spool file"
37959 The second line of the -H file contains the login name for the uid of the
37960 process that called Exim to read the message, followed by the numerical uid and
37961 gid. For a locally generated message, this is normally the user who sent the
37962 message. For a message received over TCP/IP via the daemon, it is
37963 normally the Exim user.
37964
37965 The third line of the file contains the address of the message's sender as
37966 transmitted in the envelope, contained in angle brackets. The sender address is
37967 empty for bounce messages. For incoming SMTP mail, the sender address is given
37968 in the MAIL command. For locally generated mail, the sender address is
37969 created by Exim from the login name of the current user and the configured
37970 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37971 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37972 &"<>"& or an address that matches &%untrusted_set_senders%&.
37973
37974 The fourth line contains two numbers. The first is the time that the message
37975 was received, in the conventional Unix form &-- the number of seconds since the
37976 start of the epoch. The second number is a count of the number of messages
37977 warning of delayed delivery that have been sent to the sender.
37978
37979 There follow a number of lines starting with a hyphen. These can appear in any
37980 order, and are omitted when not relevant:
37981
37982 .vlist
37983 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37984 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37985 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37986 recognized, to provide backward compatibility. In the old format, a line of
37987 this form is present for every ACL variable that is not empty. The number
37988 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37989 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37990 the data string for the variable. The string itself starts at the beginning of
37991 the next line, and is followed by a newline character. It may contain internal
37992 newlines.
37993
37994 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37995 A line of this form is present for every ACL connection variable that is
37996 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37997 The length is the length of the data string for the variable. The string itself
37998 starts at the beginning of the next line, and is followed by a newline
37999 character. It may contain internal newlines.
38000
38001 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38002 A line of this form is present for every ACL message variable that is defined.
38003 Note that there is a space between &%-aclm%& and the rest of the name. The
38004 length is the length of the data string for the variable. The string itself
38005 starts at the beginning of the next line, and is followed by a newline
38006 character. It may contain internal newlines.
38007
38008 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38009 This is present if, when the message was received over SMTP, the value of
38010 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38011
38012 .vitem &%-allow_unqualified_recipient%&
38013 This is present if unqualified recipient addresses are permitted in header
38014 lines (to stop such addresses from being qualified if rewriting occurs at
38015 transport time). Local messages that were input using &%-bnq%& and remote
38016 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38017
38018 .vitem &%-allow_unqualified_sender%&
38019 This is present if unqualified sender addresses are permitted in header lines
38020 (to stop such addresses from being qualified if rewriting occurs at transport
38021 time). Local messages that were input using &%-bnq%& and remote messages from
38022 hosts that match &%sender_unqualified_hosts%& set this flag.
38023
38024 .vitem "&%-auth_id%&&~<&'text'&>"
38025 The id information for a message received on an authenticated SMTP connection
38026 &-- the value of the &$authenticated_id$& variable.
38027
38028 .vitem "&%-auth_sender%&&~<&'address'&>"
38029 The address of an authenticated sender &-- the value of the
38030 &$authenticated_sender$& variable.
38031
38032 .vitem "&%-body_linecount%&&~<&'number'&>"
38033 This records the number of lines in the body of the message, and is always
38034 present.
38035
38036 .vitem "&%-body_zerocount%&&~<&'number'&>"
38037 This records the number of binary zero bytes in the body of the message, and is
38038 present if the number is greater than zero.
38039
38040 .vitem &%-deliver_firsttime%&
38041 This is written when a new message is first added to the spool. When the spool
38042 file is updated after a deferral, it is omitted.
38043
38044 .vitem "&%-frozen%&&~<&'time'&>"
38045 .cindex "frozen messages" "spool data"
38046 The message is frozen, and the freezing happened at <&'time'&>.
38047
38048 .vitem "&%-helo_name%&&~<&'text'&>"
38049 This records the host name as specified by a remote host in a HELO or EHLO
38050 command.
38051
38052 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38053 This records the IP address of the host from which the message was received and
38054 the remote port number that was used. It is omitted for locally generated
38055 messages.
38056
38057 .vitem "&%-host_auth%&&~<&'text'&>"
38058 If the message was received on an authenticated SMTP connection, this records
38059 the name of the authenticator &-- the value of the
38060 &$sender_host_authenticated$& variable.
38061
38062 .vitem &%-host_lookup_failed%&
38063 This is present if an attempt to look up the sending host's name from its IP
38064 address failed. It corresponds to the &$host_lookup_failed$& variable.
38065
38066 .vitem "&%-host_name%&&~<&'text'&>"
38067 .cindex "reverse DNS lookup"
38068 .cindex "DNS" "reverse lookup"
38069 This records the name of the remote host from which the message was received,
38070 if the host name was looked up from the IP address when the message was being
38071 received. It is not present if no reverse lookup was done.
38072
38073 .vitem "&%-ident%&&~<&'text'&>"
38074 For locally submitted messages, this records the login of the originating user,
38075 unless it was a trusted user and the &%-oMt%& option was used to specify an
38076 ident value. For messages received over TCP/IP, this records the ident string
38077 supplied by the remote host, if any.
38078
38079 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38080 This records the IP address of the local interface and the port number through
38081 which a message was received from a remote host. It is omitted for locally
38082 generated messages.
38083
38084 .vitem &%-local%&
38085 The message is from a local sender.
38086
38087 .vitem &%-localerror%&
38088 The message is a locally-generated bounce message.
38089
38090 .vitem "&%-local_scan%&&~<&'string'&>"
38091 This records the data string that was returned by the &[local_scan()]& function
38092 when the message was received &-- the value of the &$local_scan_data$&
38093 variable. It is omitted if no data was returned.
38094
38095 .vitem &%-manual_thaw%&
38096 The message was frozen but has been thawed manually, that is, by an explicit
38097 Exim command rather than via the auto-thaw process.
38098
38099 .vitem &%-N%&
38100 A testing delivery process was started using the &%-N%& option to suppress any
38101 actual deliveries, but delivery was deferred. At any further delivery attempts,
38102 &%-N%& is assumed.
38103
38104 .vitem &%-received_protocol%&
38105 This records the value of the &$received_protocol$& variable, which contains
38106 the name of the protocol by which the message was received.
38107
38108 .vitem &%-sender_set_untrusted%&
38109 The envelope sender of this message was set by an untrusted local caller (used
38110 to ensure that the caller is displayed in queue listings).
38111
38112 .vitem "&%-spam_score_int%&&~<&'number'&>"
38113 If a message was scanned by SpamAssassin, this is present. It records the value
38114 of &$spam_score_int$&.
38115
38116 .vitem &%-tls_certificate_verified%&
38117 A TLS certificate was received from the client that sent this message, and the
38118 certificate was verified by the server.
38119
38120 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38121 When the message was received over an encrypted connection, this records the
38122 name of the cipher suite that was used.
38123
38124 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38125 When the message was received over an encrypted connection, and a certificate
38126 was received from the client, this records the Distinguished Name from that
38127 certificate.
38128 .endlist
38129
38130 Following the options there is a list of those addresses to which the message
38131 is not to be delivered. This set of addresses is initialized from the command
38132 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38133 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38134 the address is added to this set. The addresses are kept internally as a
38135 balanced binary tree, and it is a representation of that tree which is written
38136 to the spool file. If an address is expanded via an alias or forward file, the
38137 original address is added to the tree when deliveries to all its child
38138 addresses are complete.
38139
38140 If the tree is empty, there is a single line in the spool file containing just
38141 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38142 Y or N, followed by an address. The address is the value for the node of the
38143 tree, and the letters indicate whether the node has a left branch and/or a
38144 right branch attached to it, respectively. If branches exist, they immediately
38145 follow. Here is an example of a three-node tree:
38146 .code
38147 YY darcy@austen.fict.example
38148 NN alice@wonderland.fict.example
38149 NN editor@thesaurus.ref.example
38150 .endd
38151 After the non-recipients tree, there is a list of the message's recipients.
38152 This is a simple list, preceded by a count. It includes all the original
38153 recipients of the message, including those to whom the message has already been
38154 delivered. In the simplest case, the list contains one address per line. For
38155 example:
38156 .code
38157 4
38158 editor@thesaurus.ref.example
38159 darcy@austen.fict.example
38160 rdo@foundation
38161 alice@wonderland.fict.example
38162 .endd
38163 However, when a child address has been added to the top-level addresses as a
38164 result of the use of the &%one_time%& option on a &(redirect)& router, each
38165 line is of the following form:
38166 .display
38167 <&'top-level address'&> <&'errors_to address'&> &&&
38168   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38169 .endd
38170 The 01 flag bit indicates the presence of the three other fields that follow
38171 the top-level address. Other bits may be used in future to support additional
38172 fields. The <&'parent number'&> is the offset in the recipients list of the
38173 original parent of the &"one time"& address. The first two fields are the
38174 envelope sender that is associated with this address and its length. If the
38175 length is zero, there is no special envelope sender (there are then two space
38176 characters in the line). A non-empty field can arise from a &(redirect)& router
38177 that has an &%errors_to%& setting.
38178
38179
38180 A blank line separates the envelope and status information from the headers
38181 which follow. A header may occupy several lines of the file, and to save effort
38182 when reading it in, each header is preceded by a number and an identifying
38183 character. The number is the number of characters in the header, including any
38184 embedded newlines and the terminating newline. The character is one of the
38185 following:
38186
38187 .table2 50pt
38188 .row <&'blank'&>         "header in which Exim has no special interest"
38189 .row &`B`&               "&'Bcc:'& header"
38190 .row &`C`&               "&'Cc:'& header"
38191 .row &`F`&               "&'From:'& header"
38192 .row &`I`&               "&'Message-id:'& header"
38193 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38194 .row &`R`&               "&'Reply-To:'& header"
38195 .row &`S`&               "&'Sender:'& header"
38196 .row &`T`&               "&'To:'& header"
38197 .row &`*`&               "replaced or deleted header"
38198 .endtable
38199
38200 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38201 purposes. They are not transmitted when the message is delivered. Here is a
38202 typical set of headers:
38203 .code
38204 111P Received: by hobbit.fict.example with local (Exim 4.00)
38205 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38206 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38207 038* X-rewrote-sender: bb@hobbit.fict.example
38208 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38209 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38210 099* To: alice@wonderland.fict.example, rdo@foundation,
38211 darcy@austen.fict.example, editor@thesaurus.ref.example
38212 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38213 darcy@austen.fict.example, editor@thesaurus.ref.example
38214 038  Date: Fri, 11 May 2001 10:28:59 +0100
38215 .endd
38216 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38217 &'To:'& header have been rewritten, the last one because routing expanded the
38218 unqualified domain &'foundation'&.
38219 .ecindex IIDforspo1
38220 .ecindex IIDforspo2
38221 .ecindex IIDforspo3
38222
38223 . ////////////////////////////////////////////////////////////////////////////
38224 . ////////////////////////////////////////////////////////////////////////////
38225
38226 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38227          "DKIM Support"
38228 .cindex "DKIM"
38229
38230 DKIM is a mechanism by which messages sent by some entity can be provably
38231 linked to a domain which that entity controls.  It permits reputation to
38232 be tracked on a per-domain basis, rather than merely upon source IP address.
38233 DKIM is documented in RFC 4871.
38234
38235 DKIM support is compiled into Exim by default if TLS support is present.
38236 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38237
38238 Exim's DKIM implementation allows for
38239 .olist
38240 Signing outgoing messages: This function is implemented in the SMTP transport.
38241 It can co-exist with all other Exim features
38242 (including transport filters)
38243 except cutthrough delivery.
38244 .next
38245 Verifying signatures in incoming messages: This is implemented by an additional
38246 ACL (acl_smtp_dkim), which can be called several times per message, with
38247 different signature contexts.
38248 .endlist
38249
38250 In typical Exim style, the verification implementation does not include any
38251 default "policy". Instead it enables you to build your own policy using
38252 Exim's standard controls.
38253
38254 Please note that verification of DKIM signatures in incoming mail is turned
38255 on by default for logging purposes. For each signature in incoming email,
38256 exim will log a line displaying the most important signature details, and the
38257 signature status. Here is an example (with line-breaks added for clarity):
38258 .code
38259 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38260     d=facebookmail.com s=q1-2009b
38261     c=relaxed/relaxed a=rsa-sha1
38262     i=@facebookmail.com t=1252484542 [verification succeeded]
38263 .endd
38264 You might want to turn off DKIM verification processing entirely for internal
38265 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38266 control modifier. This should typically be done in the RCPT ACL, at points
38267 where you accept mail from relay sources (internal hosts or authenticated
38268 senders).
38269
38270
38271 .section "Signing outgoing messages" "SECDKIMSIGN"
38272 .cindex "DKIM" "signing"
38273
38274 Signing is enabled by setting private options on the SMTP transport.
38275 These options take (expandable) strings as arguments.
38276
38277 .option dkim_domain smtp string&!! unset
38278 MANDATORY:
38279 The domain you want to sign with. The result of this expanded
38280 option is put into the &%$dkim_domain%& expansion variable.
38281 If it is empty after expansion, DKIM signing is not done.
38282
38283 .option dkim_selector smtp string&!! unset
38284 MANDATORY:
38285 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38286 variable to look up a matching selector. The result is put in the expansion
38287 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38288 option along with &%$dkim_domain%&.
38289
38290 .option dkim_private_key smtp string&!! unset
38291 MANDATORY:
38292 This sets the private key to use. You can use the &%$dkim_domain%& and
38293 &%$dkim_selector%& expansion variables to determine the private key to use.
38294 The result can either
38295 .ilist
38296 be a valid RSA private key in ASCII armor, including line breaks.
38297 .next
38298 start with a slash, in which case it is treated as a file that contains
38299 the private key.
38300 .next
38301 be "0", "false" or the empty string, in which case the message will not
38302 be signed. This case will not result in an error, even if &%dkim_strict%&
38303 is set.
38304 .endlist
38305
38306 .option dkim_canon smtp string&!! unset
38307 OPTIONAL:
38308 This option sets the canonicalization method used when signing a message.
38309 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38310 The option defaults to "relaxed" when unset. Note: the current implementation
38311 only supports using the same canonicalization method for both headers and body.
38312
38313 .option dkim_strict smtp string&!! unset
38314 OPTIONAL:
38315 This  option  defines  how  Exim  behaves  when  signing a message that
38316 should be signed fails for some reason.  When the expansion evaluates to
38317 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38318 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38319 variables here.
38320
38321 .option dkim_sign_headers smtp string&!! unset
38322 OPTIONAL:
38323 When set, this option must expand to (or be specified as) a colon-separated
38324 list of header names. Headers with these names will be included in the message
38325 signature. When unspecified, the header names recommended in RFC4871 will be
38326 used.
38327
38328
38329 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38330 .cindex "DKIM" "verification"
38331
38332 Verification of DKIM signatures in SMTP incoming email is implemented via the
38333 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38334 syntactically(!) correct signature in the incoming message.
38335 A missing ACL definition defaults to accept.
38336 If any ACL call does not accept, the message is not accepted.
38337 If a cutthrough delivery was in progress for the message it is
38338 summarily dropped (having wasted the transmission effort).
38339
38340 To evaluate the signature in the ACL a large number of expansion variables
38341 containing the signature status and its details are set up during the
38342 runtime of the ACL.
38343
38344 Calling the ACL only for existing signatures is not sufficient to build
38345 more advanced policies. For that reason, the global option
38346 &%dkim_verify_signers%&, and a global expansion variable
38347 &%$dkim_signers%& exist.
38348
38349 The global option &%dkim_verify_signers%& can be set to a colon-separated
38350 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38351 called. It is expanded when the message has been received. At this point,
38352 the expansion variable &%$dkim_signers%& already contains a colon-separated
38353 list of signer domains and identities for the message. When
38354 &%dkim_verify_signers%& is not specified in the main configuration,
38355 it defaults as:
38356 .code
38357 dkim_verify_signers = $dkim_signers
38358 .endd
38359 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38360 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38361 call the ACL for known domains or identities. This would be achieved as follows:
38362 .code
38363 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38364 .endd
38365 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38366 and "ebay.com", plus all domains and identities that have signatures in the message.
38367 You can also be more creative in constructing your policy. For example:
38368 .code
38369 dkim_verify_signers = $sender_address_domain:$dkim_signers
38370 .endd
38371
38372 If a domain or identity is listed several times in the (expanded) value of
38373 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38374
38375
38376 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38377 available (from most to least important):
38378
38379
38380 .vlist
38381 .vitem &%$dkim_cur_signer%&
38382 The signer that is being evaluated in this ACL run. This can be a domain or
38383 an identity. This is one of the list items from the expanded main option
38384 &%dkim_verify_signers%& (see above).
38385
38386 .vitem &%$dkim_verify_status%&
38387 A string describing the general status of the signature. One of
38388 .ilist
38389 &%none%&: There is no signature in the message for the current domain or
38390 identity (as reflected by &%$dkim_cur_signer%&).
38391 .next
38392 &%invalid%&: The signature could not be verified due to a processing error.
38393 More detail is available in &%$dkim_verify_reason%&.
38394 .next
38395 &%fail%&: Verification of the signature failed.  More detail is
38396 available in &%$dkim_verify_reason%&.
38397 .next
38398 &%pass%&: The signature passed verification. It is valid.
38399 .endlist
38400
38401 .vitem &%$dkim_verify_reason%&
38402 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38403 "fail" or "invalid". One of
38404 .ilist
38405 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38406 key for the domain could not be retrieved. This may be a temporary problem.
38407 .next
38408 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38409 record for the domain is syntactically invalid.
38410 .next
38411 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38412 body hash does not match the one specified in the signature header. This
38413 means that the message body was modified in transit.
38414 .next
38415 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38416 could not be verified. This may mean that headers were modified,
38417 re-written or otherwise changed in a way which is incompatible with
38418 DKIM verification. It may of course also mean that the signature is forged.
38419 .endlist
38420
38421 .vitem &%$dkim_domain%&
38422 The signing domain. IMPORTANT: This variable is only populated if there is
38423 an actual signature in the message for the current domain or identity (as
38424 reflected by &%$dkim_cur_signer%&).
38425
38426 .vitem &%$dkim_identity%&
38427 The signing identity, if present. IMPORTANT: This variable is only populated
38428 if there is an actual signature in the message for the current domain or
38429 identity (as reflected by &%$dkim_cur_signer%&).
38430
38431 .vitem &%$dkim_selector%&
38432 The key record selector string.
38433
38434 .vitem &%$dkim_algo%&
38435 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38436
38437 .vitem &%$dkim_canon_body%&
38438 The body canonicalization method. One of 'relaxed' or 'simple'.
38439
38440 .vitem &%dkim_canon_headers%&
38441 The header canonicalization method. One of 'relaxed' or 'simple'.
38442
38443 .vitem &%$dkim_copiedheaders%&
38444 A transcript of headers and their values which are included in the signature
38445 (copied from the 'z=' tag of the signature).
38446 Note that RFC6376 requires that verification fail if the From: header is
38447 not included in the signature.  Exim does not enforce this; sites wishing
38448 strict enforcement should code the check explicitly.
38449
38450 .vitem &%$dkim_bodylength%&
38451 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38452 limit was set by the signer, "9999999999999" is returned. This makes sure
38453 that this variable always expands to an integer value.
38454
38455 .vitem &%$dkim_created%&
38456 UNIX timestamp reflecting the date and time when the signature was created.
38457 When this was not specified by the signer, "0" is returned.
38458
38459 .vitem &%$dkim_expires%&
38460 UNIX timestamp reflecting the date and time when the signer wants the
38461 signature to be treated as "expired". When this was not specified by the
38462 signer, "9999999999999" is returned. This makes it possible to do useful
38463 integer size comparisons against this value.
38464
38465 .vitem &%$dkim_headernames%&
38466 A colon-separated list of names of headers included in the signature.
38467
38468 .vitem &%$dkim_key_testing%&
38469 "1" if the key record has the "testing" flag set, "0" if not.
38470
38471 .vitem &%$dkim_key_nosubdomains%&
38472 "1" if the key record forbids subdomaining, "0" otherwise.
38473
38474 .vitem &%$dkim_key_srvtype%&
38475 Service type (tag s=) from the key record. Defaults to "*" if not specified
38476 in the key record.
38477
38478 .vitem &%$dkim_key_granularity%&
38479 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38480 in the key record.
38481
38482 .vitem &%$dkim_key_notes%&
38483 Notes from the key record (tag n=).
38484
38485 .vitem &%$dkim_key_length%&
38486 Number of bits in the key.
38487 .endlist
38488
38489 In addition, two ACL conditions are provided:
38490
38491 .vlist
38492 .vitem &%dkim_signers%&
38493 ACL condition that checks a colon-separated list of domains or identities
38494 for a match against the domain or identity that the ACL is currently verifying
38495 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38496 verb to a group of domains or identities. For example:
38497
38498 .code
38499 # Warn when Mail purportedly from GMail has no gmail signature
38500 warn log_message = GMail sender without gmail.com DKIM signature
38501      sender_domains = gmail.com
38502      dkim_signers = gmail.com
38503      dkim_status = none
38504 .endd
38505
38506 Note that the above does not check for a total lack of DKIM signing;
38507 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38508
38509 .vitem &%dkim_status%&
38510 ACL condition that checks a colon-separated list of possible DKIM verification
38511 results against the actual result of verification. This is typically used
38512 to restrict an ACL verb to a list of verification outcomes, for example:
38513
38514 .code
38515 deny message = Mail from Paypal with invalid/missing signature
38516      sender_domains = paypal.com:paypal.de
38517      dkim_signers = paypal.com:paypal.de
38518      dkim_status = none:invalid:fail
38519 .endd
38520
38521 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38522 see the documentation of the &%$dkim_verify_status%& expansion variable above
38523 for more information of what they mean.
38524 .endlist
38525
38526 . ////////////////////////////////////////////////////////////////////////////
38527 . ////////////////////////////////////////////////////////////////////////////
38528
38529 .chapter "Proxies" "CHAPproxies" &&&
38530          "Proxy support"
38531 .cindex "proxy support"
38532 .cindex "proxy" "access via"
38533
38534 A proxy is an intermediate system through which communication is passed.
38535 Proxies may provide a security, availability or load-distribution function.
38536
38537
38538 .section "Inbound proxies" SECTproxyInbound
38539 .cindex proxy inbound
38540 .cindex proxy "server side"
38541 .cindex proxy "Proxy protocol"
38542 .cindex "Proxy protocol" proxy
38543
38544 Exim has support for receiving inbound SMTP connections via a proxy
38545 that uses &"Proxy Protocol"& to speak to it.
38546 To include this support, include &"SUPPORT_PROXY=yes"&
38547 in Local/Makefile.
38548
38549 It was built on specifications from:
38550 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
38551 That URL was revised in May 2014 to version 2 spec:
38552 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
38553
38554 The purpose of this facility is so that an application load balancer,
38555 such as HAProxy, can sit in front of several Exim servers
38556 to distribute load.
38557 Exim uses the local protocol communication with the proxy to obtain
38558 the remote SMTP system IP address and port information.
38559 There is no logging if a host passes or
38560 fails Proxy Protocol negotiation, but it can easily be determined and
38561 recorded in an ACL (example is below).
38562
38563 Use of a proxy is enabled by setting the &%hosts_proxy%&
38564 main configuration option to a hostlist; connections from these
38565 hosts will use Proxy Protocol.
38566 Exim supports both version 1 and version 2 of the Proxy Protocol and
38567 automatically determines which version is in use.
38568
38569 The Proxy Protocol header is the first data received on a TCP connection
38570 and is inserted before any TLS-on-connect handshake from the client; Exim
38571 negotiates TLS between Exim-as-server and the remote client, not between
38572 Exim and the proxy server.
38573
38574 The following expansion variables are usable
38575 (&"internal"& and &"external"& here refer to the interfaces
38576 of the proxy):
38577 .display
38578 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38579 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38580 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38581 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38582 &'proxy_session        '& boolean: SMTP connection via proxy
38583 .endd
38584 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38585 there was a protocol error.
38586
38587 Since the real connections are all coming from the proxy, and the
38588 per host connection tracking is done before Proxy Protocol is
38589 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38590 handle all of the parallel volume you expect per inbound proxy.
38591 With the option set so high, you lose the ability
38592 to protect your server from many connections from one IP.
38593 In order to prevent your server from overload, you
38594 need to add a per connection ratelimit to your connect ACL.
38595 A possible solution is:
38596 .display
38597   # Set max number of connections per host
38598   LIMIT   = 5
38599   # Or do some kind of IP lookup in a flat file or database
38600   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38601
38602   defer   message        = Too many connections from this IP right now
38603           ratelimit      = LIMIT / 5s / per_conn / strict
38604 .endd
38605
38606
38607
38608 .section "Outbound proxies" SECTproxySOCKS
38609 .cindex proxy outbound
38610 .cindex proxy "client side"
38611 .cindex proxy SOCKS
38612 .cindex SOCKS proxy
38613 Exim has support for sending outbound SMTP via a proxy
38614 using a protocol called SOCKS5 (defined by RFC1928).
38615 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38616 Local/Makefile.
38617
38618 Use of a proxy is enabled by setting the &%socks_proxy%& option
38619 on an smtp transport.
38620 The option value is expanded and should then be a list
38621 (colon-separated by default) of proxy specifiers.
38622 Each proxy specifier is a list
38623 (space-separated by default) where the initial element
38624 is an IP address and any subsequent elements are options.
38625
38626 Options are a string <name>=<value>.
38627 The list of options is in the following table:
38628 .display
38629 &'auth   '& authentication method
38630 &'name   '& authentication username
38631 &'pass   '& authentication password
38632 &'port   '& tcp port
38633 &'tmo    '& connection timeout
38634 &'pri    '& priority
38635 &'weight '& selection bias
38636 .endd
38637
38638 More details on each of these options follows:
38639
38640 .ilist
38641 .cindex authentication "to proxy"
38642 .cindex proxy authentication
38643 &%auth%&: Either &"none"& (default) or &"name"&.
38644 Using &"name"& selects username/password authentication per RFC 1929
38645 for access to the proxy.
38646 Default is &"none"&.
38647 .next
38648 &%name%&: sets the username for the &"name"& authentication method.
38649 Default is empty.
38650 .next
38651 &%pass%&: sets the password for the &"name"& authentication method.
38652 Default is empty.
38653 .next
38654 &%port%&: the TCP port number to use for the connection to the proxy.
38655 Default is 1080.
38656 .next
38657 &%tmo%&: sets a connection timeout in seconds for this proxy.
38658 Default is 5.
38659 .next
38660 &%pri%&: specifies a priority for the proxy within the list,
38661 higher values being tried first.
38662 The default priority is 1.
38663 .next
38664 &%weight%&: specifies a selection bias.
38665 Within a priority set servers are queried in a random fashion,
38666 weighted by this value.
38667 The default value for selection bias is 1.
38668 .endlist
38669
38670 Proxies from the list are tried according to their priority
38671 and weight settings until one responds.  The timeout for the
38672 overall connection applies to the set of proxied attempts.
38673
38674 .section Logging SECTproxyLog
38675 To log the (local) IP of a proxy in the incoming or delivery logline,
38676 add &"+proxy"& to the &%log_selector%& option.
38677 This will add a component tagged with &"PRX="& to the line.
38678
38679 . ////////////////////////////////////////////////////////////////////////////
38680 . ////////////////////////////////////////////////////////////////////////////
38681
38682 .chapter "Internationalisation" "CHAPi18n" &&&
38683          "Internationalisation""
38684 .cindex internationalisation "email address"
38685 .cindex EAI
38686 .cindex i18n
38687 .cindex UTF-8 "mail name handling"
38688
38689 Exim has support for Internationalised mail names.
38690 To include this it must be built with SUPPORT_I18N and the libidn library.
38691 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38692
38693 .new
38694 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
38695 instead of it) then IDNA2008 is supported; this adds an extra library
38696 requirement, upon libidn2.
38697 .wen
38698
38699 .section "MTA operations" SECTi18nMTA
38700 .cindex SMTPUTF8 "ESMTP option"
38701 The main configuration option &%smtputf8_advertise_hosts%& specifies
38702 a host list.  If this matches the sending host and
38703 accept_8bitmime is true (the default) then the ESMTP option
38704 SMTPUTF8 will be advertised.
38705
38706 If the sender specifies the SMTPUTF8 option on a MAIL command
38707 international handling for the message is enabled and
38708 the expansion variable &$message_smtputf8$& will have value TRUE.
38709
38710 The option &%allow_utf8_domains%& is set to true for this
38711 message. All DNS lookups are converted to a-label form
38712 whatever the setting of &%allow_utf8_domains%&
38713 when Exim is built with SUPPORT_I18N.
38714
38715 Both localparts and domain are maintained as the original
38716 UTF-8 form internally; any comparison or regular-expression use will
38717 require appropriate care.  Filenames created, eg. by
38718 the appendfile transport, will have UTF-8 names.
38719
38720 HELO names sent by the smtp transport will have any UTF-8
38721 components expanded to a-label form,
38722 and any certificate name checks will be done using the a-label
38723 form of the name.
38724
38725 .cindex log protocol
38726 .cindex SMTPUTF8 logging
38727 Log lines and Received-by: header lines will acquire a "utf8"
38728 prefix on the protocol element, eg. utf8esmtp.
38729
38730 The following expansion operators can be used:
38731 .code
38732 ${utf8_domain_to_alabel:str}
38733 ${utf8_domain_from_alabel:str}
38734 ${utf8_localpart_to_alabel:str}
38735 ${utf8_localpart_from_alabel:str}
38736 .endd
38737
38738 ACLs may use the following modifier:
38739 .display
38740 control = utf8_downconvert
38741 control = utf8_downconvert/<value>
38742 .endd
38743 This sets a flag requiring that addresses are converted to
38744 a-label form before smtp delivery, for use in a
38745 Message Submission Agent context.
38746 If a value is appended it may be:
38747 .display
38748 &`1  `& (default) mandatory downconversion
38749 &`0  `& no downconversion
38750 &`-1 `& if SMTPUTF8 not supported by destination host
38751 .endd
38752
38753 If mua_wrapper is set, the utf8_downconvert control
38754 is initially set to -1.
38755
38756
38757 There is no explicit support for VRFY and EXPN.
38758 Configurations supporting these should inspect
38759 &$smtp_command_argument$& for an SMTPUTF8 argument.
38760
38761 There is no support for LMTP on Unix sockets.
38762 Using the "lmtp" protocol option on an smtp transport,
38763 for LMTP over TCP, should work as expected.
38764
38765 There is no support for DSN unitext handling,
38766 and no provision for converting logging from or to UTF-8.
38767
38768
38769
38770 .section "MDA operations" SECTi18nMDA
38771 To aid in constructing names suitable for IMAP folders
38772 the following expansion operator can be used:
38773 .code
38774 ${imapfolder {<string>} {<sep>} {<specials>}}
38775 .endd
38776
38777 The string is converted from the charset specified by
38778 the "headers charset" command (in a filter file)
38779 or &%headers_charset%& main configuration option (otherwise),
38780 to the
38781 modified UTF-7 encoding specified by RFC 2060,
38782 with the following exception: All occurences of <sep>
38783 (which has to be a single character)
38784 are replaced with periods ("."), and all periods and slashes that are not
38785 <sep> and are not in the <specials> string are BASE64 encoded.
38786
38787 The third argument can be omitted, defaulting to an empty string.
38788 The second argument can be omitted, defaulting to "/".
38789
38790 This is the encoding used by Courier for Maildir names on disk, and followed
38791 by many other IMAP servers.
38792
38793 Examples:
38794 .display
38795 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38796 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38797 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38798 .endd
38799
38800 Note that the source charset setting is vital, and also that characters
38801 must be representable in UTF-16.
38802
38803
38804 . ////////////////////////////////////////////////////////////////////////////
38805 . ////////////////////////////////////////////////////////////////////////////
38806
38807 .chapter "Events" "CHAPevents" &&&
38808          "Events"
38809 .cindex events
38810
38811 The events mechanism in Exim can be used to intercept processing at a number
38812 of points.  It was originally invented to give a way to do customised logging
38813 actions (for example, to a database) but can also be used to modify some
38814 processing actions.
38815
38816 Most installations will never need to use Events.
38817 The support can be left out of a build by defining DISABLE_EVENT=yes
38818 in &_Local/Makefile_&.
38819
38820 There are two major classes of events: main and transport.
38821 The main configuration option &%event_action%& controls reception events;
38822 a transport option &%event_action%& controls delivery events.
38823
38824 Both options are a string which is expanded when the event fires.
38825 An example might look like:
38826 .cindex logging custom
38827 .code
38828 event_action = ${if eq {msg:delivery}{$event_name} \
38829 {${lookup pgsql {SELECT * FROM record_Delivery( \
38830     '${quote_pgsql:$sender_address_domain}',\
38831     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38832     '${quote_pgsql:$domain}', \
38833     '${quote_pgsql:${lc:$local_part}}', \
38834     '${quote_pgsql:$host_address}', \
38835     '${quote_pgsql:${lc:$host}}', \
38836     '${quote_pgsql:$message_exim_id}')}} \
38837 } {}}
38838 .endd
38839
38840 Events have names which correspond to the point in process at which they fire.
38841 The name is placed in the variable &$event_name$& and the event action
38842 expansion must check this, as it will be called for every possible event type.
38843
38844 The current list of events is:
38845 .display
38846 &`msg:complete           after    main       `& per message
38847 &`msg:delivery           after    transport  `& per recipient
38848 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38849 &`msg:rcpt:defer         after    transport  `& per recipient
38850 &`msg:host:defer         after    transport  `& per attempt
38851 &`msg:fail:delivery      after    main       `& per recipient
38852 &`msg:fail:internal      after    main       `& per recipient
38853 &`tcp:connect            before   transport  `& per connection
38854 &`tcp:close              after    transport  `& per connection
38855 &`tls:cert               before   both       `& per certificate in verification chain
38856 &`smtp:connect           after    transport  `& per connection
38857 .endd
38858 New event types may be added in future.
38859
38860 The event name is a colon-separated list, defining the type of
38861 event in a tree of possibilities.  It may be used as a list
38862 or just matched on as a whole.  There will be no spaces in the name.
38863
38864 The second column in the table above describes whether the event fires
38865 before or after the action is associates with.  Those which fire before
38866 can be used to affect that action (more on this below).
38867
38868 An additional variable, &$event_data$&, is filled with information varying
38869 with the event type:
38870 .display
38871 &`msg:delivery         `& smtp confirmation message
38872 &`msg:rcpt:host:defer  `& error string
38873 &`msg:rcpt:defer       `& error string
38874 &`msg:host:defer       `& error string
38875 &`tls:cert             `& verification chain depth
38876 &`smtp:connect         `& smtp banner
38877 .endd
38878
38879 The :defer events populate one extra variable: &$event_defer_errno$&.
38880
38881 For complex operations an ACL expansion can be used in &%event_action%&
38882 however due to the multiple contexts that Exim operates in during
38883 the course of its processing:
38884 .ilist
38885 variables set in transport events will not be visible outside that
38886 transport call
38887 .next
38888 acl_m variables in a server context are lost on a new connection,
38889 and after smtp helo/ehlo/mail/starttls/rset commands
38890 .endlist
38891 Using an ACL expansion with the logwrite modifier can be
38892 a useful way of writing to the main log.
38893
38894 The expansion of the event_action option should normally
38895 return an empty string.  Should it return anything else the
38896 following will be forced:
38897 .display
38898 &`msg:delivery     `&  (ignored)
38899 &`msg:host:defer   `&  (ignored)
38900 &`msg:fail:delivery`&  (ignored)
38901 &`tcp:connect      `&  do not connect
38902 &`tcp:close        `&  (ignored)
38903 &`tls:cert         `&  refuse verification
38904 &`smtp:connect     `&  close connection
38905 .endd
38906 No other use is made of the result string.
38907
38908 For a tcp:connect event, if the connection is being made to a proxy
38909 then the address and port variables will be that of the proxy and not
38910 the target system.
38911
38912 For tls:cert events, if GnuTLS is in use this will trigger only per
38913 chain element received on the connection.
38914 For OpenSSL it will trigger for every chain element including those
38915 loaded locally.
38916
38917 . ////////////////////////////////////////////////////////////////////////////
38918 . ////////////////////////////////////////////////////////////////////////////
38919
38920 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38921          "Adding drivers or lookups"
38922 .cindex "adding drivers"
38923 .cindex "new drivers, adding"
38924 .cindex "drivers" "adding new"
38925 The following actions have to be taken in order to add a new router, transport,
38926 authenticator, or lookup type to Exim:
38927
38928 .olist
38929 Choose a name for the driver or lookup type that does not conflict with any
38930 existing name; I will use &"newdriver"& in what follows.
38931 .next
38932 Add to &_src/EDITME_& the line:
38933 .display
38934 <&'type'&>&`_NEWDRIVER=yes`&
38935 .endd
38936 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38937 code is not to be included in the binary by default, comment this line out. You
38938 should also add any relevant comments about the driver or lookup type.
38939 .next
38940 Add to &_src/config.h.defaults_& the line:
38941 .code
38942 #define <type>_NEWDRIVER
38943 .endd
38944 .next
38945 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38946 and create a table entry as is done for all the other drivers and lookup types.
38947 .next
38948 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38949 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38950 Add your &`NEWDRIVER`& to that list.
38951 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38952 simple form that most lookups have.
38953 .next
38954 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38955 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38956 driver or lookup type and add it to the definition of OBJ.
38957 .next
38958 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38959 &_src_&.
38960 .next
38961 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38962 as for other drivers and lookups.
38963 .endlist
38964
38965 Then all you need to do is write the code! A good way to start is to make a
38966 proforma by copying an existing module of the same type, globally changing all
38967 occurrences of the name, and cutting out most of the code. Note that any
38968 options you create must be listed in alphabetical order, because the tables are
38969 searched using a binary chop procedure.
38970
38971 There is a &_README_& file in each of the sub-directories of &_src_& describing
38972 the interface that is expected.
38973
38974
38975
38976
38977 . ////////////////////////////////////////////////////////////////////////////
38978 . ////////////////////////////////////////////////////////////////////////////
38979
38980 . /////////////////////////////////////////////////////////////////////////////
38981 . These lines are processing instructions for the Simple DocBook Processor that
38982 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38983 . PDFs than using xmlto and fop. They will be ignored by all other XML
38984 . processors.
38985 . /////////////////////////////////////////////////////////////////////////////
38986
38987 .literal xml
38988 <?sdop
38989   format="newpage"
38990   foot_right_recto="&chaptertitle;"
38991   foot_right_verso="&chaptertitle;"
38992 ?>
38993 .literal off
38994
38995 .makeindex "Options index"   "option"
38996 .makeindex "Variables index" "variable"
38997 .makeindex "Concept index"   "concept"
38998
38999
39000 . /////////////////////////////////////////////////////////////////////////////
39001 . /////////////////////////////////////////////////////////////////////////////