0068b2f73f1b9c30bf0ed3b522aa43dacb27fdce
[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.80"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2013
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 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 .new
557 Releases have also been authorized to be performed by Todd Lyons who signs with
558 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
559 Pennock and Todd Lyons through a common associate.
560 .wen
561
562 The signatures for the tar bundles are in:
563 .display
564 &_exim-n.nn.tar.gz.asc_&
565 &_exim-n.nn.tar.bz2.asc_&
566 .endd
567 For each released version, the log of changes is made separately available in a
568 separate file in the directory &_ChangeLogs_& so that it is possible to
569 find out what has changed without having to download the entire distribution.
570
571 .cindex "documentation" "available formats"
572 The main distribution contains ASCII versions of this specification and other
573 documentation; other formats of the documents are available in separate files
574 inside the &_exim4_& directory of the FTP site:
575 .display
576 &_exim-html-n.nn.tar.gz_&
577 &_exim-pdf-n.nn.tar.gz_&
578 &_exim-postscript-n.nn.tar.gz_&
579 &_exim-texinfo-n.nn.tar.gz_&
580 .endd
581 These tar files contain only the &_doc_& directory, not the complete
582 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
583
584
585 .section "Limitations" "SECID6"
586 .ilist
587 .cindex "limitations of Exim"
588 .cindex "bang paths" "not handled by Exim"
589 Exim is designed for use as an Internet MTA, and therefore handles addresses in
590 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
591 simple two-component bang paths can be converted by a straightforward rewriting
592 configuration. This restriction does not prevent Exim from being interfaced to
593 UUCP as a transport mechanism, provided that domain addresses are used.
594 .next
595 .cindex "domainless addresses"
596 .cindex "address" "without domain"
597 Exim insists that every address it handles has a domain attached. For incoming
598 local messages, domainless addresses are automatically qualified with a
599 configured domain value. Configuration options specify from which remote
600 systems unqualified addresses are acceptable. These are then qualified on
601 arrival.
602 .next
603 .cindex "transport" "external"
604 .cindex "external transports"
605 The only external transport mechanisms that are currently implemented are SMTP
606 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
607 transport is available, and there are facilities for writing messages to files
608 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
609 to send messages to other transport mechanisms such as UUCP, provided they can
610 handle domain-style addresses. Batched SMTP input is also catered for.
611 .next
612 Exim is not designed for storing mail for dial-in hosts. When the volumes of
613 such mail are large, it is better to get the messages &"delivered"& into files
614 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
615 other means.
616 .next
617 Although Exim does have basic facilities for scanning incoming messages, these
618 are not comprehensive enough to do full virus or spam scanning. Such operations
619 are best carried out using additional specialized software packages. If you
620 compile Exim with the content-scanning extension, straightforward interfaces to
621 a number of common scanners are provided.
622 .endlist
623
624
625 .section "Run time configuration" "SECID7"
626 Exim's run time configuration is held in a single text file that is divided
627 into a number of sections. The entries in this file consist of keywords and
628 values, in the style of Smail 3 configuration files. A default configuration
629 file which is suitable for simple online installations is provided in the
630 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
631
632
633 .section "Calling interface" "SECID8"
634 .cindex "Sendmail compatibility" "command line interface"
635 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
636 can be a straight replacement for &_/usr/lib/sendmail_& or
637 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
638 about Sendmail in order to run Exim. For actions other than sending messages,
639 Sendmail-compatible options also exist, but those that produce output (for
640 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
641 format. There are also some additional options that are compatible with Smail
642 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
643 documents all Exim's command line options. This information is automatically
644 made into the man page that forms part of the Exim distribution.
645
646 Control of messages on the queue can be done via certain privileged command
647 line options. There is also an optional monitor program called &'eximon'&,
648 which displays current information in an X window, and which contains a menu
649 interface to Exim's command line administration options.
650
651
652
653 .section "Terminology" "SECID9"
654 .cindex "terminology definitions"
655 .cindex "body of message" "definition of"
656 The &'body'& of a message is the actual data that the sender wants to transmit.
657 It is the last part of a message, and is separated from the &'header'& (see
658 below) by a blank line.
659
660 .cindex "bounce message" "definition of"
661 When a message cannot be delivered, it is normally returned to the sender in a
662 delivery failure message or a &"non-delivery report"& (NDR). The term
663 &'bounce'& is commonly used for this action, and the error reports are often
664 called &'bounce messages'&. This is a convenient shorthand for &"delivery
665 failure error report"&. Such messages have an empty sender address in the
666 message's &'envelope'& (see below) to ensure that they cannot themselves give
667 rise to further bounce messages.
668
669 The term &'default'& appears frequently in this manual. It is used to qualify a
670 value which is used in the absence of any setting in the configuration. It may
671 also qualify an action which is taken unless a configuration setting specifies
672 otherwise.
673
674 The term &'defer'& is used when the delivery of a message to a specific
675 destination cannot immediately take place for some reason (a remote host may be
676 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
677 until a later time.
678
679 The word &'domain'& is sometimes used to mean all but the first component of a
680 host's name. It is &'not'& used in that sense here, where it normally refers to
681 the part of an email address following the @ sign.
682
683 .cindex "envelope, definition of"
684 .cindex "sender" "definition of"
685 A message in transit has an associated &'envelope'&, as well as a header and a
686 body. The envelope contains a sender address (to which bounce messages should
687 be delivered), and any number of recipient addresses. References to the
688 sender or the recipients of a message usually mean the addresses in the
689 envelope. An MTA uses these addresses for delivery, and for returning bounce
690 messages, not the addresses that appear in the header lines.
691
692 .cindex "message" "header, definition of"
693 .cindex "header section" "definition of"
694 The &'header'& of a message is the first part of a message's text, consisting
695 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
696 &'Subject:'&, etc. Long header lines can be split over several text lines by
697 indenting the continuations. The header is separated from the body by a blank
698 line.
699
700 .cindex "local part" "definition of"
701 .cindex "domain" "definition of"
702 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
703 part of an email address that precedes the @ sign. The part that follows the
704 @ sign is called the &'domain'& or &'mail domain'&.
705
706 .cindex "local delivery" "definition of"
707 .cindex "remote delivery, definition of"
708 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
709 delivery to a file or a pipe on the local host from delivery by SMTP over
710 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
711 host it is running on are &'remote'&.
712
713 .cindex "return path" "definition of"
714 &'Return path'& is another name that is used for the sender address in a
715 message's envelope.
716
717 .cindex "queue" "definition of"
718 The term &'queue'& is used to refer to the set of messages awaiting delivery,
719 because this term is in widespread use in the context of MTAs. However, in
720 Exim's case the reality is more like a pool than a queue, because there is
721 normally no ordering of waiting messages.
722
723 .cindex "queue runner" "definition of"
724 The term &'queue runner'& is used to describe a process that scans the queue
725 and attempts to deliver those messages whose retry times have come. This term
726 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
727 the waiting messages are normally processed in an unpredictable order.
728
729 .cindex "spool directory" "definition of"
730 The term &'spool directory'& is used for a directory in which Exim keeps the
731 messages on its queue &-- that is, those that it is in the process of
732 delivering. This should not be confused with the directory in which local
733 mailboxes are stored, which is called a &"spool directory"& by some people. In
734 the Exim documentation, &"spool"& is always used in the first sense.
735
736
737
738
739
740
741 . ////////////////////////////////////////////////////////////////////////////
742 . ////////////////////////////////////////////////////////////////////////////
743
744 .chapter "Incorporated code" "CHID2"
745 .cindex "incorporated code"
746 .cindex "regular expressions" "library"
747 .cindex "PCRE"
748 .cindex "OpenDMARC"
749 A number of pieces of external code are included in the Exim distribution.
750
751 .ilist
752 Regular expressions are supported in the main Exim program and in the
753 Exim monitor using the freely-distributable PCRE library, copyright
754 &copy; University of Cambridge. The source to PCRE is no longer shipped with
755 Exim, so you will need to use the version of PCRE shipped with your system,
756 or obtain and install the full version of the library from
757 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
758 .next
759 .cindex "cdb" "acknowledgment"
760 Support for the cdb (Constant DataBase) lookup method is provided by code
761 contributed by Nigel Metheringham of (at the time he contributed it) Planet
762 Online Ltd. The implementation is completely contained within the code of Exim.
763 It does not link against an external cdb library. The code contains the
764 following statements:
765
766 .blockquote
767 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
768
769 This program is free software; you can redistribute it and/or modify it under
770 the terms of the GNU General Public License as published by the Free Software
771 Foundation; either version 2 of the License, or (at your option) any later
772 version.
773 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
774 the spec and sample code for cdb can be obtained from
775 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
776 some code from Dan Bernstein's implementation (which has no license
777 restrictions applied to it).
778 .endblockquote
779 .next
780 .cindex "SPA authentication"
781 .cindex "Samba project"
782 .cindex "Microsoft Secure Password Authentication"
783 Client support for Microsoft's &'Secure Password Authentication'& is provided
784 by code contributed by Marc Prud'hommeaux. Server support was contributed by
785 Tom Kistner. This includes code taken from the Samba project, which is released
786 under the Gnu GPL.
787 .next
788 .cindex "Cyrus"
789 .cindex "&'pwcheck'& daemon"
790 .cindex "&'pwauthd'& daemon"
791 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
792 by code taken from the Cyrus-SASL library and adapted by Alexander S.
793 Sabourenkov. The permission notice appears below, in accordance with the
794 conditions expressed therein.
795
796 .blockquote
797 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
798
799 Redistribution and use in source and binary forms, with or without
800 modification, are permitted provided that the following conditions
801 are met:
802
803 .olist
804 Redistributions of source code must retain the above copyright
805 notice, this list of conditions and the following disclaimer.
806 .next
807 Redistributions in binary form must reproduce the above copyright
808 notice, this list of conditions and the following disclaimer in
809 the documentation and/or other materials provided with the
810 distribution.
811 .next
812 The name &"Carnegie Mellon University"& must not be used to
813 endorse or promote products derived from this software without
814 prior written permission. For permission or any other legal
815 details, please contact
816 .display
817               Office of Technology Transfer
818               Carnegie Mellon University
819               5000 Forbes Avenue
820               Pittsburgh, PA  15213-3890
821               (412) 268-4387, fax: (412) 268-7395
822               tech-transfer@andrew.cmu.edu
823 .endd
824 .next
825 Redistributions of any form whatsoever must retain the following
826 acknowledgment:
827
828 &"This product includes software developed by Computing Services
829 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
830
831 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
832 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
833 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
834 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
835 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
836 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
837 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
838 .endlist
839 .endblockquote
840
841 .next
842 .cindex "Exim monitor" "acknowledgment"
843 .cindex "X-windows"
844 .cindex "Athena"
845 The Exim Monitor program, which is an X-Window application, includes
846 modified versions of the Athena StripChart and TextPop widgets.
847 This code is copyright by DEC and MIT, and their permission notice appears
848 below, in accordance with the conditions expressed therein.
849
850 .blockquote
851 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
852 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
853
854 All Rights Reserved
855
856 Permission to use, copy, modify, and distribute this software and its
857 documentation for any purpose and without fee is hereby granted,
858 provided that the above copyright notice appear in all copies and that
859 both that copyright notice and this permission notice appear in
860 supporting documentation, and that the names of Digital or MIT not be
861 used in advertising or publicity pertaining to distribution of the
862 software without specific, written prior permission.
863
864 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
865 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
866 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
867 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
868 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
869 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
870 SOFTWARE.
871 .endblockquote
872
873 .next
874 .new
875 .cindex "opendmarc" "acknowledgment"
876 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
877 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
878 derived code are indicated in the respective source files. The full OpenDMARC
879 license is provided in the LICENSE.opendmarc file contained in the distributed
880 source code.
881 .wen
882
883 .next
884 Many people have contributed code fragments, some large, some small, that were
885 not covered by any specific licence requirements. It is assumed that the
886 contributors are happy to see their code incorporated into Exim under the GPL.
887 .endlist
888
889
890
891
892
893 . ////////////////////////////////////////////////////////////////////////////
894 . ////////////////////////////////////////////////////////////////////////////
895
896 .chapter "How Exim receives and delivers mail" "CHID11" &&&
897          "Receiving and delivering mail"
898
899
900 .section "Overall philosophy" "SECID10"
901 .cindex "design philosophy"
902 Exim is designed to work efficiently on systems that are permanently connected
903 to the Internet and are handling a general mix of mail. In such circumstances,
904 most messages can be delivered immediately. Consequently, Exim does not
905 maintain independent queues of messages for specific domains or hosts, though
906 it does try to send several messages in a single SMTP connection after a host
907 has been down, and it also maintains per-host retry information.
908
909
910 .section "Policy control" "SECID11"
911 .cindex "policy control" "overview"
912 Policy controls are now an important feature of MTAs that are connected to the
913 Internet. Perhaps their most important job is to stop MTAs being abused as
914 &"open relays"& by misguided individuals who send out vast amounts of
915 unsolicited junk, and want to disguise its source. Exim provides flexible
916 facilities for specifying policy controls on incoming mail:
917
918 .ilist
919 .cindex "&ACL;" "introduction"
920 Exim 4 (unlike previous versions of Exim) implements policy controls on
921 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
922 series of statements that may either grant or deny access. ACLs can be used at
923 several places in the SMTP dialogue while receiving a message from a remote
924 host. However, the most common places are after each RCPT command, and at the
925 very end of the message. The sysadmin can specify conditions for accepting or
926 rejecting individual recipients or the entire message, respectively, at these
927 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
928 error code.
929 .next
930 An ACL is also available for locally generated, non-SMTP messages. In this
931 case, the only available actions are to accept or deny the entire message.
932 .next
933 When Exim is compiled with the content-scanning extension, facilities are
934 provided in the ACL mechanism for passing the message to external virus and/or
935 spam scanning software. The result of such a scan is passed back to the ACL,
936 which can then use it to decide what to do with the message.
937 .next
938 When a message has been received, either from a remote host or from the local
939 host, but before the final acknowledgment has been sent, a locally supplied C
940 function called &[local_scan()]& can be run to inspect the message and decide
941 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
942 is accepted, the list of recipients can be modified by the function.
943 .next
944 Using the &[local_scan()]& mechanism is another way of calling external scanner
945 software. The &%SA-Exim%& add-on package works this way. It does not require
946 Exim to be compiled with the content-scanning extension.
947 .next
948 After a message has been accepted, a further checking mechanism is available in
949 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
950 runs at the start of every delivery process.
951 .endlist
952
953
954
955 .section "User filters" "SECID12"
956 .cindex "filter" "introduction"
957 .cindex "Sieve filter"
958 In a conventional Exim configuration, users are able to run private filters by
959 setting up appropriate &_.forward_& files in their home directories. See
960 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
961 configuration needed to support this, and the separate document entitled
962 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
963 of filtering are available:
964
965 .ilist
966 Sieve filters are written in the standard filtering language that is defined
967 by RFC 3028.
968 .next
969 Exim filters are written in a syntax that is unique to Exim, but which is more
970 powerful than Sieve, which it pre-dates.
971 .endlist
972
973 User filters are run as part of the routing process, described below.
974
975
976
977 .section "Message identification" "SECTmessiden"
978 .cindex "message ids" "details of format"
979 .cindex "format" "of message id"
980 .cindex "id of message"
981 .cindex "base62"
982 .cindex "base36"
983 .cindex "Darwin"
984 .cindex "Cygwin"
985 Every message handled by Exim is given a &'message id'& which is sixteen
986 characters long. It is divided into three parts, separated by hyphens, for
987 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
988 normally encoding numbers in base 62. However, in the Darwin operating
989 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
990 (avoiding the use of lower case letters) is used instead, because the message
991 id is used to construct file names, and the names of files in those systems are
992 not always case-sensitive.
993
994 .cindex "pid (process id)" "re-use of"
995 The detail of the contents of the message id have changed as Exim has evolved.
996 Earlier versions relied on the operating system not re-using a process id (pid)
997 within one second. On modern operating systems, this assumption can no longer
998 be made, so the algorithm had to be changed. To retain backward compatibility,
999 the format of the message id was retained, which is why the following rules are
1000 somewhat eccentric:
1001
1002 .ilist
1003 The first six characters of the message id are the time at which the message
1004 started to be received, to a granularity of one second. That is, this field
1005 contains the number of seconds since the start of the epoch (the normal Unix
1006 way of representing the date and time of day).
1007 .next
1008 After the first hyphen, the next six characters are the id of the process that
1009 received the message.
1010 .next
1011 There are two different possibilities for the final two characters:
1012 .olist
1013 .oindex "&%localhost_number%&"
1014 If &%localhost_number%& is not set, this value is the fractional part of the
1015 time of reception, normally in units of 1/2000 of a second, but for systems
1016 that must use base 36 instead of base 62 (because of case-insensitive file
1017 systems), the units are 1/1000 of a second.
1018 .next
1019 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1020 the fractional part of the time, which in this case is in units of 1/200
1021 (1/100) of a second.
1022 .endlist
1023 .endlist
1024
1025 After a message has been received, Exim waits for the clock to tick at the
1026 appropriate resolution before proceeding, so that if another message is
1027 received by the same process, or by another process with the same (re-used)
1028 pid, it is guaranteed that the time will be different. In most cases, the clock
1029 will already have ticked while the message was being received.
1030
1031
1032 .section "Receiving mail" "SECID13"
1033 .cindex "receiving mail"
1034 .cindex "message" "reception"
1035 The only way Exim can receive mail from another host is using SMTP over
1036 TCP/IP, in which case the sender and recipient addresses are transferred using
1037 SMTP commands. However, from a locally running process (such as a user's MUA),
1038 there are several possibilities:
1039
1040 .ilist
1041 If the process runs Exim with the &%-bm%& option, the message is read
1042 non-interactively (usually via a pipe), with the recipients taken from the
1043 command line, or from the body of the message if &%-t%& is also used.
1044 .next
1045 If the process runs Exim with the &%-bS%& option, the message is also read
1046 non-interactively, but in this case the recipients are listed at the start of
1047 the message in a series of SMTP RCPT commands, terminated by a DATA
1048 command. This is so-called &"batch SMTP"& format,
1049 but it isn't really SMTP. The SMTP commands are just another way of passing
1050 envelope addresses in a non-interactive submission.
1051 .next
1052 If the process runs Exim with the &%-bs%& option, the message is read
1053 interactively, using the SMTP protocol. A two-way pipe is normally used for
1054 passing data between the local process and the Exim process.
1055 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1056 example, the ACLs for SMTP commands are used for this form of submission.
1057 .next
1058 A local process may also make a TCP/IP call to the host's loopback address
1059 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1060 does not treat the loopback address specially. It treats all such connections
1061 in the same way as connections from other hosts.
1062 .endlist
1063
1064
1065 .cindex "message sender, constructed by Exim"
1066 .cindex "sender" "constructed by Exim"
1067 In the three cases that do not involve TCP/IP, the sender address is
1068 constructed from the login name of the user that called Exim and a default
1069 qualification domain (which can be set by the &%qualify_domain%& configuration
1070 option). For local or batch SMTP, a sender address that is passed using the
1071 SMTP MAIL command is ignored. However, the system administrator may allow
1072 certain users (&"trusted users"&) to specify a different sender address
1073 unconditionally, or all users to specify certain forms of different sender
1074 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1075 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1076 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1077 users to change sender addresses.
1078
1079 Messages received by either of the non-interactive mechanisms are subject to
1080 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1081 (either over TCP/IP, or interacting with a local process) can be checked by a
1082 number of ACLs that operate at different times during the SMTP session. Either
1083 individual recipients, or the entire message, can be rejected if local policy
1084 requirements are not met. The &[local_scan()]& function (see chapter
1085 &<<CHAPlocalscan>>&) is run for all incoming messages.
1086
1087 Exim can be configured not to start a delivery process when a message is
1088 received; this can be unconditional, or depend on the number of incoming SMTP
1089 connections or the system load. In these situations, new messages wait on the
1090 queue until a queue runner process picks them up. However, in standard
1091 configurations under normal conditions, delivery is started as soon as a
1092 message is received.
1093
1094
1095
1096
1097
1098 .section "Handling an incoming message" "SECID14"
1099 .cindex "spool directory" "files that hold a message"
1100 .cindex "file" "how a message is held"
1101 When Exim accepts a message, it writes two files in its spool directory. The
1102 first contains the envelope information, the current status of the message, and
1103 the header lines, and the second contains the body of the message. The names of
1104 the two spool files consist of the message id, followed by &`-H`& for the
1105 file containing the envelope and header, and &`-D`& for the data file.
1106
1107 .cindex "spool directory" "&_input_& sub-directory"
1108 By default all these message files are held in a single directory called
1109 &_input_& inside the general Exim spool directory. Some operating systems do
1110 not perform very well if the number of files in a directory gets large; to
1111 improve performance in such cases, the &%split_spool_directory%& option can be
1112 used. This causes Exim to split up the input files into 62 sub-directories
1113 whose names are single letters or digits. When this is done, the queue is
1114 processed one sub-directory at a time instead of all at once, which can improve
1115 overall performance even when there are not enough files in each directory to
1116 affect file system performance.
1117
1118 The envelope information consists of the address of the message's sender and
1119 the addresses of the recipients. This information is entirely separate from
1120 any addresses contained in the header lines. The status of the message includes
1121 a list of recipients who have already received the message. The format of the
1122 first spool file is described in chapter &<<CHAPspool>>&.
1123
1124 .cindex "rewriting" "addresses"
1125 Address rewriting that is specified in the rewrite section of the configuration
1126 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1127 both in the header lines and the envelope, at the time the message is accepted.
1128 If during the course of delivery additional addresses are generated (for
1129 example, via aliasing), these new addresses are rewritten as soon as they are
1130 generated. At the time a message is actually delivered (transported) further
1131 rewriting can take place; because this is a transport option, it can be
1132 different for different forms of delivery. It is also possible to specify the
1133 addition or removal of certain header lines at the time the message is
1134 delivered (see chapters &<<CHAProutergeneric>>& and
1135 &<<CHAPtransportgeneric>>&).
1136
1137
1138
1139 .section "Life of a message" "SECID15"
1140 .cindex "message" "life of"
1141 .cindex "message" "frozen"
1142 A message remains in the spool directory until it is completely delivered to
1143 its recipients or to an error address, or until it is deleted by an
1144 administrator or by the user who originally created it. In cases when delivery
1145 cannot proceed &-- for example, when a message can neither be delivered to its
1146 recipients nor returned to its sender, the message is marked &"frozen"& on the
1147 spool, and no more deliveries are attempted.
1148
1149 .cindex "frozen messages" "thawing"
1150 .cindex "message" "thawing frozen"
1151 An administrator can &"thaw"& such messages when the problem has been
1152 corrected, and can also freeze individual messages by hand if necessary. In
1153 addition, an administrator can force a delivery error, causing a bounce message
1154 to be sent.
1155
1156 .oindex "&%timeout_frozen_after%&"
1157 .oindex "&%ignore_bounce_errors_after%&"
1158 There are options called &%ignore_bounce_errors_after%& and
1159 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1160 The first applies only to frozen bounces, the second to any frozen messages.
1161
1162 .cindex "message" "log file for"
1163 .cindex "log" "file for each message"
1164 While Exim is working on a message, it writes information about each delivery
1165 attempt to its main log file. This includes successful, unsuccessful, and
1166 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1167 lines are also written to a separate &'message log'& file for each message.
1168 These logs are solely for the benefit of the administrator, and are normally
1169 deleted along with the spool files when processing of a message is complete.
1170 The use of individual message logs can be disabled by setting
1171 &%no_message_logs%&; this might give an improvement in performance on very busy
1172 systems.
1173
1174 .cindex "journal file"
1175 .cindex "file" "journal"
1176 All the information Exim itself needs to set up a delivery is kept in the first
1177 spool file, along with the header lines. When a successful delivery occurs, the
1178 address is immediately written at the end of a journal file, whose name is the
1179 message id followed by &`-J`&. At the end of a delivery run, if there are some
1180 addresses left to be tried again later, the first spool file (the &`-H`& file)
1181 is updated to indicate which these are, and the journal file is then deleted.
1182 Updating the spool file is done by writing a new file and renaming it, to
1183 minimize the possibility of data loss.
1184
1185 Should the system or the program crash after a successful delivery but before
1186 the spool file has been updated, the journal is left lying around. The next
1187 time Exim attempts to deliver the message, it reads the journal file and
1188 updates the spool file before proceeding. This minimizes the chances of double
1189 deliveries caused by crashes.
1190
1191
1192
1193 .section "Processing an address for delivery" "SECTprocaddress"
1194 .cindex "drivers" "definition of"
1195 .cindex "router" "definition of"
1196 .cindex "transport" "definition of"
1197 The main delivery processing elements of Exim are called &'routers'& and
1198 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1199 number of them is provided in the source distribution, and compile-time options
1200 specify which ones are included in the binary. Run time options specify which
1201 ones are actually used for delivering messages.
1202
1203 .cindex "drivers" "instance definition"
1204 Each driver that is specified in the run time configuration is an &'instance'&
1205 of that particular driver type. Multiple instances are allowed; for example,
1206 you can set up several different &(smtp)& transports, each with different
1207 option values that might specify different ports or different timeouts. Each
1208 instance has its own identifying name. In what follows we will normally use the
1209 instance name when discussing one particular instance (that is, one specific
1210 configuration of the driver), and the generic driver name when discussing
1211 the driver's features in general.
1212
1213 A &'router'& is a driver that operates on an address, either determining how
1214 its delivery should happen, by assigning it to a specific transport, or
1215 converting the address into one or more new addresses (for example, via an
1216 alias file). A router may also explicitly choose to fail an address, causing it
1217 to be bounced.
1218
1219 A &'transport'& is a driver that transmits a copy of the message from Exim's
1220 spool to some destination. There are two kinds of transport: for a &'local'&
1221 transport, the destination is a file or a pipe on the local host, whereas for a
1222 &'remote'& transport the destination is some other host. A message is passed
1223 to a specific transport as a result of successful routing. If a message has
1224 several recipients, it may be passed to a number of different transports.
1225
1226 .cindex "preconditions" "definition of"
1227 An address is processed by passing it to each configured router instance in
1228 turn, subject to certain preconditions, until a router accepts the address or
1229 specifies that it should be bounced. We will describe this process in more
1230 detail shortly. First, as a simple example, we consider how each recipient
1231 address in a message is processed in a small configuration of three routers.
1232
1233 To make this a more concrete example, it is described in terms of some actual
1234 routers, but remember, this is only an example. You can configure Exim's
1235 routers in many different ways, and there may be any number of routers in a
1236 configuration.
1237
1238 The first router that is specified in a configuration is often one that handles
1239 addresses in domains that are not recognized specially by the local host. These
1240 are typically addresses for arbitrary domains on the Internet. A precondition
1241 is set up which looks for the special domains known to the host (for example,
1242 its own domain name), and the router is run for addresses that do &'not'&
1243 match. Typically, this is a router that looks up domains in the DNS in order to
1244 find the hosts to which this address routes. If it succeeds, the address is
1245 assigned to a suitable SMTP transport; if it does not succeed, the router is
1246 configured to fail the address.
1247
1248 The second router is reached only when the domain is recognized as one that
1249 &"belongs"& to the local host. This router does redirection &-- also known as
1250 aliasing and forwarding. When it generates one or more new addresses from the
1251 original, each of them is routed independently from the start. Otherwise, the
1252 router may cause an address to fail, or it may simply decline to handle the
1253 address, in which case the address is passed to the next router.
1254
1255 The final router in many configurations is one that checks to see if the
1256 address belongs to a local mailbox. The precondition may involve a check to
1257 see if the local part is the name of a login account, or it may look up the
1258 local part in a file or a database. If its preconditions are not met, or if
1259 the router declines, we have reached the end of the routers. When this happens,
1260 the address is bounced.
1261
1262
1263
1264 .section "Processing an address for verification" "SECID16"
1265 .cindex "router" "for verification"
1266 .cindex "verifying address" "overview"
1267 As well as being used to decide how to deliver to an address, Exim's routers
1268 are also used for &'address verification'&. Verification can be requested as
1269 one of the checks to be performed in an ACL for incoming messages, on both
1270 sender and recipient addresses, and it can be tested using the &%-bv%& and
1271 &%-bvs%& command line options.
1272
1273 When an address is being verified, the routers are run in &"verify mode"&. This
1274 does not affect the way the routers work, but it is a state that can be
1275 detected. By this means, a router can be skipped or made to behave differently
1276 when verifying. A common example is a configuration in which the first router
1277 sends all messages to a message-scanning program, unless they have been
1278 previously scanned. Thus, the first router accepts all addresses without any
1279 checking, making it useless for verifying. Normally, the &%no_verify%& option
1280 would be set for such a router, causing it to be skipped in verify mode.
1281
1282
1283
1284
1285 .section "Running an individual router" "SECTrunindrou"
1286 .cindex "router" "running details"
1287 .cindex "preconditions" "checking"
1288 .cindex "router" "result of running"
1289 As explained in the example above, a number of preconditions are checked before
1290 running a router. If any are not met, the router is skipped, and the address is
1291 passed to the next router. When all the preconditions on a router &'are'& met,
1292 the router is run. What happens next depends on the outcome, which is one of
1293 the following:
1294
1295 .ilist
1296 &'accept'&: The router accepts the address, and either assigns it to a
1297 transport, or generates one or more &"child"& addresses. Processing the
1298 original address ceases,
1299 .oindex "&%unseen%&"
1300 unless the &%unseen%& option is set on the router. This option
1301 can be used to set up multiple deliveries with different routing (for example,
1302 for keeping archive copies of messages). When &%unseen%& is set, the address is
1303 passed to the next router. Normally, however, an &'accept'& return marks the
1304 end of routing.
1305
1306 Any child addresses generated by the router are processed independently,
1307 starting with the first router by default. It is possible to change this by
1308 setting the &%redirect_router%& option to specify which router to start at for
1309 child addresses. Unlike &%pass_router%& (see below) the router specified by
1310 &%redirect_router%& may be anywhere in the router configuration.
1311 .next
1312 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1313 requests that the address be passed to another router. By default the address
1314 is passed to the next router, but this can be changed by setting the
1315 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1316 must be below the current router (to avoid loops).
1317 .next
1318 &'decline'&: The router declines to accept the address because it does not
1319 recognize it at all. By default, the address is passed to the next router, but
1320 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1321 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1322 &'decline'& into &'fail'&.
1323 .next
1324 &'fail'&: The router determines that the address should fail, and queues it for
1325 the generation of a bounce message. There is no further processing of the
1326 original address unless &%unseen%& is set on the router.
1327 .next
1328 &'defer'&: The router cannot handle the address at the present time. (A
1329 database may be offline, or a DNS lookup may have timed out.) No further
1330 processing of the address happens in this delivery attempt. It is tried again
1331 next time the message is considered for delivery.
1332 .next
1333 &'error'&: There is some error in the router (for example, a syntax error in
1334 its configuration). The action is as for defer.
1335 .endlist
1336
1337 If an address reaches the end of the routers without having been accepted by
1338 any of them, it is bounced as unrouteable. The default error message in this
1339 situation is &"unrouteable address"&, but you can set your own message by
1340 making use of the &%cannot_route_message%& option. This can be set for any
1341 router; the value from the last router that &"saw"& the address is used.
1342
1343 Sometimes while routing you want to fail a delivery when some conditions are
1344 met but others are not, instead of passing the address on for further routing.
1345 You can do this by having a second router that explicitly fails the delivery
1346 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1347 facility for this purpose.
1348
1349
1350 .section "Duplicate addresses" "SECID17"
1351 .cindex "case of local parts"
1352 .cindex "address duplicate, discarding"
1353 .cindex "duplicate addresses"
1354 Once routing is complete, Exim scans the addresses that are assigned to local
1355 and remote transports, and discards any duplicates that it finds. During this
1356 check, local parts are treated as case-sensitive. This happens only when
1357 actually delivering a message; when testing routers with &%-bt%&, all the
1358 routed addresses are shown.
1359
1360
1361
1362 .section "Router preconditions" "SECTrouprecon"
1363 .cindex "router" "preconditions, order of processing"
1364 .cindex "preconditions" "order of processing"
1365 The preconditions that are tested for each router are listed below, in the
1366 order in which they are tested. The individual configuration options are
1367 described in more detail in chapter &<<CHAProutergeneric>>&.
1368
1369 .ilist
1370 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1371 the local parts handled by the router may or must have certain prefixes and/or
1372 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1373 skipped. These conditions are tested first. When an affix is present, it is
1374 removed from the local part before further processing, including the evaluation
1375 of any other conditions.
1376 .next
1377 Routers can be designated for use only when not verifying an address, that is,
1378 only when routing it for delivery (or testing its delivery routing). If the
1379 &%verify%& option is set false, the router is skipped when Exim is verifying an
1380 address.
1381 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1382 &%verify_recipient%&, which independently control the use of the router for
1383 sender and recipient verification. You can set these options directly if
1384 you want a router to be used for only one type of verification.
1385 .new "Note that cutthrough delivery is classed as a recipient verification for this purpose."
1386 .next
1387 If the &%address_test%& option is set false, the router is skipped when Exim is
1388 run with the &%-bt%& option to test an address routing. This can be helpful
1389 when the first router sends all new messages to a scanner of some sort; it
1390 makes it possible to use &%-bt%& to test subsequent delivery routing without
1391 having to simulate the effect of the scanner.
1392 .next
1393 Routers can be designated for use only when verifying an address, as
1394 opposed to routing it for delivery. The &%verify_only%& option controls this.
1395 .new "Again, cutthrough delivery counts as a verification."
1396 .next
1397 Individual routers can be explicitly skipped when running the routers to
1398 check an address given in the SMTP EXPN command (see the &%expn%& option).
1399 .next
1400 If the &%domains%& option is set, the domain of the address must be in the set
1401 of domains that it defines.
1402 .next
1403 .vindex "&$local_part_prefix$&"
1404 .vindex "&$local_part$&"
1405 .vindex "&$local_part_suffix$&"
1406 If the &%local_parts%& option is set, the local part of the address must be in
1407 the set of local parts that it defines. If &%local_part_prefix%& or
1408 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1409 part before this check. If you want to do precondition tests on local parts
1410 that include affixes, you can do so by using a &%condition%& option (see below)
1411 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1412 &$local_part_suffix$& as necessary.
1413 .next
1414 .vindex "&$local_user_uid$&"
1415 .vindex "&$local_user_gid$&"
1416 .vindex "&$home$&"
1417 If the &%check_local_user%& option is set, the local part must be the name of
1418 an account on the local host. If this check succeeds, the uid and gid of the
1419 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1420 user's home directory is placed in &$home$&; these values can be used in the
1421 remaining preconditions.
1422 .next
1423 If the &%router_home_directory%& option is set, it is expanded at this point,
1424 because it overrides the value of &$home$&. If this expansion were left till
1425 later, the value of &$home$& as set by &%check_local_user%& would be used in
1426 subsequent tests. Having two different values of &$home$& in the same router
1427 could lead to confusion.
1428 .next
1429 If the &%senders%& option is set, the envelope sender address must be in the
1430 set of addresses that it defines.
1431 .next
1432 If the &%require_files%& option is set, the existence or non-existence of
1433 specified files is tested.
1434 .next
1435 .cindex "customizing" "precondition"
1436 If the &%condition%& option is set, it is evaluated and tested. This option
1437 uses an expanded string to allow you to set up your own custom preconditions.
1438 Expanded strings are described in chapter &<<CHAPexpand>>&.
1439 .endlist
1440
1441
1442 Note that &%require_files%& comes near the end of the list, so you cannot use
1443 it to check for the existence of a file in which to lookup up a domain, local
1444 part, or sender. However, as these options are all expanded, you can use the
1445 &%exists%& expansion condition to make such tests within each condition. The
1446 &%require_files%& option is intended for checking files that the router may be
1447 going to use internally, or which are needed by a specific transport (for
1448 example, &_.procmailrc_&).
1449
1450
1451
1452 .section "Delivery in detail" "SECID18"
1453 .cindex "delivery" "in detail"
1454 When a message is to be delivered, the sequence of events is as follows:
1455
1456 .ilist
1457 If a system-wide filter file is specified, the message is passed to it. The
1458 filter may add recipients to the message, replace the recipients, discard the
1459 message, cause a new message to be generated, or cause the message delivery to
1460 fail. The format of the system filter file is the same as for Exim user filter
1461 files, described in the separate document entitled &'Exim's interfaces to mail
1462 filtering'&.
1463 .cindex "Sieve filter" "not available for system filter"
1464 (&*Note*&: Sieve cannot be used for system filter files.)
1465
1466 Some additional features are available in system filters &-- see chapter
1467 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1468 filter only once per delivery attempt, however many recipients it has. However,
1469 if there are several delivery attempts because one or more addresses could not
1470 be immediately delivered, the system filter is run each time. The filter
1471 condition &%first_delivery%& can be used to detect the first run of the system
1472 filter.
1473 .next
1474 Each recipient address is offered to each configured router in turn, subject to
1475 its preconditions, until one is able to handle it. If no router can handle the
1476 address, that is, if they all decline, the address is failed. Because routers
1477 can be targeted at particular domains, several locally handled domains can be
1478 processed entirely independently of each other.
1479 .next
1480 .cindex "routing" "loops in"
1481 .cindex "loop" "while routing"
1482 A router that accepts an address may assign it to a local or a remote
1483 transport. However, the transport is not run at this time. Instead, the address
1484 is placed on a list for the particular transport, which will be run later.
1485 Alternatively, the router may generate one or more new addresses (typically
1486 from alias, forward, or filter files). New addresses are fed back into this
1487 process from the top, but in order to avoid loops, a router ignores any address
1488 which has an identically-named ancestor that was processed by itself.
1489 .next
1490 When all the routing has been done, addresses that have been successfully
1491 handled are passed to their assigned transports. When local transports are
1492 doing real local deliveries, they handle only one address at a time, but if a
1493 local transport is being used as a pseudo-remote transport (for example, to
1494 collect batched SMTP messages for transmission by some other means) multiple
1495 addresses can be handled. Remote transports can always handle more than one
1496 address at a time, but can be configured not to do so, or to restrict multiple
1497 addresses to the same domain.
1498 .next
1499 Each local delivery to a file or a pipe runs in a separate process under a
1500 non-privileged uid, and these deliveries are run one at a time. Remote
1501 deliveries also run in separate processes, normally under a uid that is private
1502 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1503 run in parallel. The maximum number of simultaneous remote deliveries for any
1504 one message is set by the &%remote_max_parallel%& option.
1505 The order in which deliveries are done is not defined, except that all local
1506 deliveries happen before any remote deliveries.
1507 .next
1508 .cindex "queue runner"
1509 When it encounters a local delivery during a queue run, Exim checks its retry
1510 database to see if there has been a previous temporary delivery failure for the
1511 address before running the local transport. If there was a previous failure,
1512 Exim does not attempt a new delivery until the retry time for the address is
1513 reached. However, this happens only for delivery attempts that are part of a
1514 queue run. Local deliveries are always attempted when delivery immediately
1515 follows message reception, even if retry times are set for them. This makes for
1516 better behaviour if one particular message is causing problems (for example,
1517 causing quota overflow, or provoking an error in a filter file).
1518 .next
1519 .cindex "delivery" "retry in remote transports"
1520 Remote transports do their own retry handling, since an address may be
1521 deliverable to one of a number of hosts, each of which may have a different
1522 retry time. If there have been previous temporary failures and no host has
1523 reached its retry time, no delivery is attempted, whether in a queue run or
1524 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1525 .next
1526 If there were any permanent errors, a bounce message is returned to an
1527 appropriate address (the sender in the common case), with details of the error
1528 for each failing address. Exim can be configured to send copies of bounce
1529 messages to other addresses.
1530 .next
1531 .cindex "delivery" "deferral"
1532 If one or more addresses suffered a temporary failure, the message is left on
1533 the queue, to be tried again later. Delivery of these addresses is said to be
1534 &'deferred'&.
1535 .next
1536 When all the recipient addresses have either been delivered or bounced,
1537 handling of the message is complete. The spool files and message log are
1538 deleted, though the message log can optionally be preserved if required.
1539 .endlist
1540
1541
1542
1543
1544 .section "Retry mechanism" "SECID19"
1545 .cindex "delivery" "retry mechanism"
1546 .cindex "retry" "description of mechanism"
1547 .cindex "queue runner"
1548 Exim's mechanism for retrying messages that fail to get delivered at the first
1549 attempt is the queue runner process. You must either run an Exim daemon that
1550 uses the &%-q%& option with a time interval to start queue runners at regular
1551 intervals, or use some other means (such as &'cron'&) to start them. If you do
1552 not arrange for queue runners to be run, messages that fail temporarily at the
1553 first attempt will remain on your queue for ever. A queue runner process works
1554 its way through the queue, one message at a time, trying each delivery that has
1555 passed its retry time.
1556 You can run several queue runners at once.
1557
1558 Exim uses a set of configured rules to determine when next to retry the failing
1559 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1560 should give up trying to deliver to the address, at which point it generates a
1561 bounce message. If no retry rules are set for a particular host, address, and
1562 error combination, no retries are attempted, and temporary errors are treated
1563 as permanent.
1564
1565
1566
1567 .section "Temporary delivery failure" "SECID20"
1568 .cindex "delivery" "temporary failure"
1569 There are many reasons why a message may not be immediately deliverable to a
1570 particular address. Failure to connect to a remote machine (because it, or the
1571 connection to it, is down) is one of the most common. Temporary failures may be
1572 detected during routing as well as during the transport stage of delivery.
1573 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1574 is on a file system where the user is over quota. Exim can be configured to
1575 impose its own quotas on local mailboxes; where system quotas are set they will
1576 also apply.
1577
1578 If a host is unreachable for a period of time, a number of messages may be
1579 waiting for it by the time it recovers, and sending them in a single SMTP
1580 connection is clearly beneficial. Whenever a delivery to a remote host is
1581 deferred,
1582 .cindex "hints database"
1583 Exim makes a note in its hints database, and whenever a successful
1584 SMTP delivery has happened, it looks to see if any other messages are waiting
1585 for the same host. If any are found, they are sent over the same SMTP
1586 connection, subject to a configuration limit as to the maximum number in any
1587 one connection.
1588
1589
1590
1591 .section "Permanent delivery failure" "SECID21"
1592 .cindex "delivery" "permanent failure"
1593 .cindex "bounce message" "when generated"
1594 When a message cannot be delivered to some or all of its intended recipients, a
1595 bounce message is generated. Temporary delivery failures turn into permanent
1596 errors when their timeout expires. All the addresses that fail in a given
1597 delivery attempt are listed in a single message. If the original message has
1598 many recipients, it is possible for some addresses to fail in one delivery
1599 attempt and others to fail subsequently, giving rise to more than one bounce
1600 message. The wording of bounce messages can be customized by the administrator.
1601 See chapter &<<CHAPemsgcust>>& for details.
1602
1603 .cindex "&'X-Failed-Recipients:'& header line"
1604 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1605 failed addresses, for the benefit of programs that try to analyse such messages
1606 automatically.
1607
1608 .cindex "bounce message" "recipient of"
1609 A bounce message is normally sent to the sender of the original message, as
1610 obtained from the message's envelope. For incoming SMTP messages, this is the
1611 address given in the MAIL command. However, when an address is expanded via a
1612 forward or alias file, an alternative address can be specified for delivery
1613 failures of the generated addresses. For a mailing list expansion (see section
1614 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1615 of the list.
1616
1617
1618
1619 .section "Failures to deliver bounce messages" "SECID22"
1620 .cindex "bounce message" "failure to deliver"
1621 If a bounce message (either locally generated or received from a remote host)
1622 itself suffers a permanent delivery failure, the message is left on the queue,
1623 but it is frozen, awaiting the attention of an administrator. There are options
1624 that can be used to make Exim discard such failed messages, or to keep them
1625 for only a short time (see &%timeout_frozen_after%& and
1626 &%ignore_bounce_errors_after%&).
1627
1628
1629
1630
1631
1632 . ////////////////////////////////////////////////////////////////////////////
1633 . ////////////////////////////////////////////////////////////////////////////
1634
1635 .chapter "Building and installing Exim" "CHID3"
1636 .scindex IIDbuex "building Exim"
1637
1638 .section "Unpacking" "SECID23"
1639 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1640 creates a directory with the name of the current release (for example,
1641 &_exim-&version()_&) into which the following files are placed:
1642
1643 .table2 140pt
1644 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1645 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1646   documented"
1647 .irow &_LICENCE_&         "the GNU General Public Licence"
1648 .irow &_Makefile_&        "top-level make file"
1649 .irow &_NOTICE_&          "conditions for the use of Exim"
1650 .irow &_README_&          "list of files, directories and simple build &&&
1651   instructions"
1652 .endtable
1653
1654 Other files whose names begin with &_README_& may also be present. The
1655 following subdirectories are created:
1656
1657 .table2 140pt
1658 .irow &_Local_&           "an empty directory for local configuration files"
1659 .irow &_OS_&              "OS-specific files"
1660 .irow &_doc_&             "documentation files"
1661 .irow &_exim_monitor_&    "source files for the Exim monitor"
1662 .irow &_scripts_&         "scripts used in the build process"
1663 .irow &_src_&             "remaining source files"
1664 .irow &_util_&            "independent utilities"
1665 .endtable
1666
1667 The main utility programs are contained in the &_src_& directory, and are built
1668 with the Exim binary. The &_util_& directory contains a few optional scripts
1669 that may be useful to some sites.
1670
1671
1672 .section "Multiple machine architectures and operating systems" "SECID24"
1673 .cindex "building Exim" "multiple OS/architectures"
1674 The building process for Exim is arranged to make it easy to build binaries for
1675 a number of different architectures and operating systems from the same set of
1676 source files. Compilation does not take place in the &_src_& directory.
1677 Instead, a &'build directory'& is created for each architecture and operating
1678 system.
1679 .cindex "symbolic link" "to build directory"
1680 Symbolic links to the sources are installed in this directory, which is where
1681 the actual building takes place. In most cases, Exim can discover the machine
1682 architecture and operating system for itself, but the defaults can be
1683 overridden if necessary.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need
1690 to install the PCRE or PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(http://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 file name is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1753 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1754 versions of Berkeley DB can be obtained from
1755 &url(http://www.sleepycat.com/).
1756 .next
1757 .cindex "&'tdb'& DBM library"
1758 Yet another DBM library, called &'tdb'&, is available from
1759 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1760 operates on a single file.
1761 .endlist
1762
1763 .cindex "USE_DB"
1764 .cindex "DBM libraries" "configuration for building"
1765 Exim and its utilities can be compiled to use any of these interfaces. In order
1766 to use any version of the Berkeley DB package in native mode, you must set
1767 USE_DB in an appropriate configuration file (typically
1768 &_Local/Makefile_&). For example:
1769 .code
1770 USE_DB=yes
1771 .endd
1772 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1773 error is diagnosed if you set more than one of these.
1774
1775 At the lowest level, the build-time configuration sets none of these options,
1776 thereby assuming an interface of type (1). However, some operating system
1777 configuration files (for example, those for the BSD operating systems and
1778 Linux) assume type (4) by setting USE_DB as their default, and the
1779 configuration files for Cygwin set USE_GDBM. Anything you set in
1780 &_Local/Makefile_&, however, overrides these system defaults.
1781
1782 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1783 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1784 in one of these lines:
1785 .code
1786 DBMLIB = -ldb
1787 DBMLIB = -ltdb
1788 .endd
1789 Settings like that will work if the DBM library is installed in the standard
1790 place. Sometimes it is not, and the library's header file may also not be in
1791 the default path. You may need to set INCLUDE to specify where the header
1792 file is, and to specify the path to the library more fully in DBMLIB, as in
1793 this example:
1794 .code
1795 INCLUDE=-I/usr/local/include/db-4.1
1796 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1797 .endd
1798 There is further detailed discussion about the various DBM libraries in the
1799 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1800
1801
1802
1803 .section "Pre-building configuration" "SECID25"
1804 .cindex "building Exim" "pre-building configuration"
1805 .cindex "configuration for building Exim"
1806 .cindex "&_Local/Makefile_&"
1807 .cindex "&_src/EDITME_&"
1808 Before building Exim, a local configuration file that specifies options
1809 independent of any operating system has to be created with the name
1810 &_Local/Makefile_&. A template for this file is supplied as the file
1811 &_src/EDITME_&, and it contains full descriptions of all the option settings
1812 therein. These descriptions are therefore not repeated here. If you are
1813 building Exim for the first time, the simplest thing to do is to copy
1814 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1815
1816 There are three settings that you must supply, because Exim will not build
1817 without them. They are the location of the run time configuration file
1818 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1819 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1820 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1821 a colon-separated list of file names; Exim uses the first of them that exists.
1822
1823 There are a few other parameters that can be specified either at build time or
1824 at run time, to enable the same binary to be used on a number of different
1825 machines. However, if the locations of Exim's spool directory and log file
1826 directory (if not within the spool directory) are fixed, it is recommended that
1827 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1828 detected early in Exim's execution (such as a malformed configuration file) can
1829 be logged.
1830
1831 .cindex "content scanning" "specifying at build time"
1832 Exim's interfaces for calling virus and spam scanning software directly from
1833 access control lists are not compiled by default. If you want to include these
1834 facilities, you need to set
1835 .code
1836 WITH_CONTENT_SCAN=yes
1837 .endd
1838 in your &_Local/Makefile_&. For details of the facilities themselves, see
1839 chapter &<<CHAPexiscan>>&.
1840
1841
1842 .cindex "&_Local/eximon.conf_&"
1843 .cindex "&_exim_monitor/EDITME_&"
1844 If you are going to build the Exim monitor, a similar configuration process is
1845 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1846 your installation and saved under the name &_Local/eximon.conf_&. If you are
1847 happy with the default settings described in &_exim_monitor/EDITME_&,
1848 &_Local/eximon.conf_& can be empty, but it must exist.
1849
1850 This is all the configuration that is needed in straightforward cases for known
1851 operating systems. However, the building process is set up so that it is easy
1852 to override options that are set by default or by operating-system-specific
1853 configuration files, for example to change the name of the C compiler, which
1854 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1855 do this.
1856
1857
1858
1859 .section "Support for iconv()" "SECID26"
1860 .cindex "&[iconv()]& support"
1861 .cindex "RFC 2047"
1862 The contents of header lines in messages may be encoded according to the rules
1863 described RFC 2047. This makes it possible to transmit characters that are not
1864 in the ASCII character set, and to label them as being in a particular
1865 character set. When Exim is inspecting header lines by means of the &%$h_%&
1866 mechanism, it decodes them, and translates them into a specified character set
1867 (default ISO-8859-1). The translation is possible only if the operating system
1868 supports the &[iconv()]& function.
1869
1870 However, some of the operating systems that supply &[iconv()]& do not support
1871 very many conversions. The GNU &%libiconv%& library (available from
1872 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1873 systems to remedy this deficiency, as well as on systems that do not supply
1874 &[iconv()]& at all. After installing &%libiconv%&, you should add
1875 .code
1876 HAVE_ICONV=yes
1877 .endd
1878 to your &_Local/Makefile_& and rebuild Exim.
1879
1880
1881
1882 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1883 .cindex "TLS" "including support for TLS"
1884 .cindex "encryption" "including support for"
1885 .cindex "SUPPORT_TLS"
1886 .cindex "OpenSSL" "building Exim with"
1887 .cindex "GnuTLS" "building Exim with"
1888 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1889 command as per RFC 2487. It can also support legacy clients that expect to
1890 start a TLS session immediately on connection to a non-standard port (see the
1891 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1892 line option).
1893
1894 If you want to build Exim with TLS support, you must first install either the
1895 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1896 implementing SSL.
1897
1898 If OpenSSL is installed, you should set
1899 .code
1900 SUPPORT_TLS=yes
1901 TLS_LIBS=-lssl -lcrypto
1902 .endd
1903 in &_Local/Makefile_&. You may also need to specify the locations of the
1904 OpenSSL library and include files. For example:
1905 .code
1906 SUPPORT_TLS=yes
1907 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1908 TLS_INCLUDE=-I/usr/local/openssl/include/
1909 .endd
1910 .cindex "pkg-config" "OpenSSL"
1911 If you have &'pkg-config'& available, then instead you can just use:
1912 .code
1913 SUPPORT_TLS=yes
1914 USE_OPENSSL_PC=openssl
1915 .endd
1916 .cindex "USE_GNUTLS"
1917 If GnuTLS is installed, you should set
1918 .code
1919 SUPPORT_TLS=yes
1920 USE_GNUTLS=yes
1921 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1922 .endd
1923 in &_Local/Makefile_&, and again you may need to specify the locations of the
1924 library and include files. For example:
1925 .code
1926 SUPPORT_TLS=yes
1927 USE_GNUTLS=yes
1928 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1929 TLS_INCLUDE=-I/usr/gnu/include
1930 .endd
1931 .cindex "pkg-config" "GnuTLS"
1932 If you have &'pkg-config'& available, then instead you can just use:
1933 .code
1934 SUPPORT_TLS=yes
1935 USE_GNUTLS=yes
1936 USE_GNUTLS_PC=gnutls
1937 .endd
1938
1939 You do not need to set TLS_INCLUDE if the relevant directory is already
1940 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1941 given in chapter &<<CHAPTLS>>&.
1942
1943
1944
1945
1946 .section "Use of tcpwrappers" "SECID27"
1947
1948 .cindex "tcpwrappers, building Exim to support"
1949 .cindex "USE_TCP_WRAPPERS"
1950 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1951 .cindex "tcp_wrappers_daemon_name"
1952 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1953 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1954 alternative to Exim's own checking facilities for installations that are
1955 already making use of &'tcpwrappers'& for other purposes. To do this, you
1956 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1957 &_tcpd.h_& to be available at compile time, and also ensure that the library
1958 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1959 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1960 you might have
1961 .code
1962 USE_TCP_WRAPPERS=yes
1963 CFLAGS=-O -I/usr/local/include
1964 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1965 .endd
1966 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1967 files is &"exim"&. For example, the line
1968 .code
1969 exim : LOCAL  192.168.1.  .friendly.domain.example
1970 .endd
1971 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1972 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1973 All other connections are denied. The daemon name used by &'tcpwrappers'&
1974 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1975 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1976 configure file. Consult the &'tcpwrappers'& documentation for
1977 further details.
1978
1979
1980 .section "Including support for IPv6" "SECID28"
1981 .cindex "IPv6" "including support for"
1982 Exim contains code for use on systems that have IPv6 support. Setting
1983 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1984 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1985 where the IPv6 support is not fully integrated into the normal include and
1986 library files.
1987
1988 Two different types of DNS record for handling IPv6 addresses have been
1989 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1990 currently seen as the mainstream. Another record type called A6 was proposed
1991 as better than AAAA because it had more flexibility. However, it was felt to be
1992 over-complex, and its status was reduced to &"experimental"&. It is not known
1993 if anyone is actually using A6 records. Exim has support for A6 records, but
1994 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1995 support has not been tested for some time.
1996
1997
1998
1999 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2000 .cindex "lookup modules"
2001 .cindex "dynamic modules"
2002 .cindex ".so building"
2003 On some platforms, Exim supports not compiling all lookup types directly into
2004 the main binary, instead putting some into external modules which can be loaded
2005 on demand.
2006 This permits packagers to build Exim with support for lookups with extensive
2007 library dependencies without requiring all users to install all of those
2008 dependencies.
2009 Most, but not all, lookup types can be built this way.
2010
2011 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2012 installed; Exim will only load modules from that directory, as a security
2013 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2014 for your OS; see &_OS/Makefile-Linux_& for an example.
2015 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2016 see &_src/EDITME_& for details.
2017
2018 Then, for each module to be loaded dynamically, define the relevant
2019 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2020 For example, this will build in lsearch but load sqlite and mysql support
2021 on demand:
2022 .code
2023 LOOKUP_LSEARCH=yes
2024 LOOKUP_SQLITE=2
2025 LOOKUP_MYSQL=2
2026 .endd
2027
2028
2029 .section "The building process" "SECID29"
2030 .cindex "build directory"
2031 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2032 created, run &'make'& at the top level. It determines the architecture and
2033 operating system types, and creates a build directory if one does not exist.
2034 For example, on a Sun system running Solaris 8, the directory
2035 &_build-SunOS5-5.8-sparc_& is created.
2036 .cindex "symbolic link" "to source files"
2037 Symbolic links to relevant source files are installed in the build directory.
2038
2039 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2040 building process fails if it is set.
2041
2042 If this is the first time &'make'& has been run, it calls a script that builds
2043 a make file inside the build directory, using the configuration files from the
2044 &_Local_& directory. The new make file is then passed to another instance of
2045 &'make'&. This does the real work, building a number of utility scripts, and
2046 then compiling and linking the binaries for the Exim monitor (if configured), a
2047 number of utility programs, and finally Exim itself. The command &`make
2048 makefile`& can be used to force a rebuild of the make file in the build
2049 directory, should this ever be necessary.
2050
2051 If you have problems building Exim, check for any comments there may be in the
2052 &_README_& file concerning your operating system, and also take a look at the
2053 FAQ, where some common problems are covered.
2054
2055
2056
2057 .section 'Output from &"make"&' "SECID283"
2058 The output produced by the &'make'& process for compile lines is often very
2059 unreadable, because these lines can be very long. For this reason, the normal
2060 output is suppressed by default, and instead output similar to that which
2061 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2062 each module that is being compiled or linked. However, it is still possible to
2063 get the full output, by calling &'make'& like this:
2064 .code
2065 FULLECHO='' make -e
2066 .endd
2067 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2068 command reflection in &'make'&. When you ask for the full output, it is
2069 given in addition to the short output.
2070
2071
2072
2073 .section "Overriding build-time options for Exim" "SECToverride"
2074 .cindex "build-time options, overriding"
2075 The main make file that is created at the beginning of the building process
2076 consists of the concatenation of a number of files which set configuration
2077 values, followed by a fixed set of &'make'& instructions. If a value is set
2078 more than once, the last setting overrides any previous ones. This provides a
2079 convenient way of overriding defaults. The files that are concatenated are, in
2080 order:
2081 .display
2082 &_OS/Makefile-Default_&
2083 &_OS/Makefile-_&<&'ostype'&>
2084 &_Local/Makefile_&
2085 &_Local/Makefile-_&<&'ostype'&>
2086 &_Local/Makefile-_&<&'archtype'&>
2087 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2088 &_OS/Makefile-Base_&
2089 .endd
2090 .cindex "&_Local/Makefile_&"
2091 .cindex "building Exim" "operating system type"
2092 .cindex "building Exim" "architecture type"
2093 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2094 architecture type. &_Local/Makefile_& is required to exist, and the building
2095 process fails if it is absent. The other three &_Local_& files are optional,
2096 and are often not needed.
2097
2098 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2099 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2100 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2101 values are used, thereby providing a means of forcing particular settings.
2102 Otherwise, the scripts try to get values from the &%uname%& command. If this
2103 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2104 of &'ad hoc'& transformations are then applied, to produce the standard names
2105 that Exim expects. You can run these scripts directly from the shell in order
2106 to find out what values are being used on your system.
2107
2108
2109 &_OS/Makefile-Default_& contains comments about the variables that are set
2110 therein. Some (but not all) are mentioned below. If there is something that
2111 needs changing, review the contents of this file and the contents of the make
2112 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2113 default values are.
2114
2115
2116 .cindex "building Exim" "overriding default settings"
2117 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2118 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2119 need to change the original files. Instead, you should make the changes by
2120 putting the new values in an appropriate &_Local_& file. For example,
2121 .cindex "Tru64-Unix build-time settings"
2122 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2123 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2124 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2125 called with the option &%-std1%&, to make it recognize some of the features of
2126 Standard C that Exim uses. (Most other compilers recognize Standard C by
2127 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2128 containing the lines
2129 .code
2130 CC=cc
2131 CFLAGS=-std1
2132 .endd
2133 If you are compiling for just one operating system, it may be easier to put
2134 these lines directly into &_Local/Makefile_&.
2135
2136 Keeping all your local configuration settings separate from the distributed
2137 files makes it easy to transfer them to new versions of Exim simply by copying
2138 the contents of the &_Local_& directory.
2139
2140
2141 .cindex "NIS lookup type" "including support for"
2142 .cindex "NIS+ lookup type" "including support for"
2143 .cindex "LDAP" "including support for"
2144 .cindex "lookup" "inclusion in binary"
2145 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2146 lookup, but not all systems have these components installed, so the default is
2147 not to include the relevant code in the binary. All the different kinds of file
2148 and database lookup that Exim supports are implemented as separate code modules
2149 which are included only if the relevant compile-time options are set. In the
2150 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2151 .code
2152 LOOKUP_LDAP=yes
2153 LOOKUP_NIS=yes
2154 LOOKUP_NISPLUS=yes
2155 .endd
2156 and similar settings apply to the other lookup types. They are all listed in
2157 &_src/EDITME_&. In many cases the relevant include files and interface
2158 libraries need to be installed before compiling Exim.
2159 .cindex "cdb" "including support for"
2160 However, there are some optional lookup types (such as cdb) for which
2161 the code is entirely contained within Exim, and no external include
2162 files or libraries are required. When a lookup type is not included in the
2163 binary, attempts to configure Exim to use it cause run time configuration
2164 errors.
2165
2166 .cindex "pkg-config" "lookups"
2167 .cindex "pkg-config" "authenticators"
2168 Many systems now use a tool called &'pkg-config'& to encapsulate information
2169 about how to compile against a library; Exim has some initial support for
2170 being able to use pkg-config for lookups and authenticators.  For any given
2171 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2172 variable with the &`_PC`& suffix in the name and assign as the value the
2173 name of the package to be queried.  The results of querying via the
2174 &'pkg-config'& command will be added to the appropriate Makefile variables
2175 with &`+=`& directives, so your version of &'make'& will need to support that
2176 syntax.  For instance:
2177 .code
2178 LOOKUP_SQLITE=yes
2179 LOOKUP_SQLITE_PC=sqlite3
2180 AUTH_GSASL=yes
2181 AUTH_GSASL_PC=libgsasl
2182 AUTH_HEIMDAL_GSSAPI=yes
2183 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2184 .endd
2185
2186 .cindex "Perl" "including support for"
2187 Exim can be linked with an embedded Perl interpreter, allowing Perl
2188 subroutines to be called during string expansion. To enable this facility,
2189 .code
2190 EXIM_PERL=perl.o
2191 .endd
2192 must be defined in &_Local/Makefile_&. Details of this facility are given in
2193 chapter &<<CHAPperl>>&.
2194
2195 .cindex "X11 libraries, location of"
2196 The location of the X11 libraries is something that varies a lot between
2197 operating systems, and there may be different versions of X11 to cope
2198 with. Exim itself makes no use of X11, but if you are compiling the Exim
2199 monitor, the X11 libraries must be available.
2200 The following three variables are set in &_OS/Makefile-Default_&:
2201 .code
2202 X11=/usr/X11R6
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib
2205 .endd
2206 These are overridden in some of the operating-system configuration files. For
2207 example, in &_OS/Makefile-SunOS5_& there is
2208 .code
2209 X11=/usr/openwin
2210 XINCLUDE=-I$(X11)/include
2211 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2212 .endd
2213 If you need to override the default setting for your operating system, place a
2214 definition of all three of these variables into your
2215 &_Local/Makefile-<ostype>_& file.
2216
2217 .cindex "EXTRALIBS"
2218 If you need to add any extra libraries to the link steps, these can be put in a
2219 variable called EXTRALIBS, which appears in all the link commands, but by
2220 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2221 command for linking the main Exim binary, and not for any associated utilities.
2222
2223 .cindex "DBM libraries" "configuration for building"
2224 There is also DBMLIB, which appears in the link commands for binaries that
2225 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2226 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2227 binary, and which can be used, for example, to include additional X11
2228 libraries.
2229
2230 .cindex "configuration file" "editing"
2231 The make file copes with rebuilding Exim correctly if any of the configuration
2232 files are edited. However, if an optional configuration file is deleted, it is
2233 necessary to touch the associated non-optional file (that is,
2234 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2235
2236
2237 .section "OS-specific header files" "SECID30"
2238 .cindex "&_os.h_&"
2239 .cindex "building Exim" "OS-specific C header files"
2240 The &_OS_& directory contains a number of files with names of the form
2241 &_os.h-<ostype>_&. These are system-specific C header files that should not
2242 normally need to be changed. There is a list of macro settings that are
2243 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2244 are porting Exim to a new operating system.
2245
2246
2247
2248 .section "Overriding build-time options for the monitor" "SECID31"
2249 .cindex "building Eximon"
2250 A similar process is used for overriding things when building the Exim monitor,
2251 where the files that are involved are
2252 .display
2253 &_OS/eximon.conf-Default_&
2254 &_OS/eximon.conf-_&<&'ostype'&>
2255 &_Local/eximon.conf_&
2256 &_Local/eximon.conf-_&<&'ostype'&>
2257 &_Local/eximon.conf-_&<&'archtype'&>
2258 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2259 .endd
2260 .cindex "&_Local/eximon.conf_&"
2261 As with Exim itself, the final three files need not exist, and in this case the
2262 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2263 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2264 variables of the same name, preceded by EXIMON_. For example, setting
2265 EXIMON_LOG_DEPTH in the environment overrides the value of
2266 LOG_DEPTH at run time.
2267 .ecindex IIDbuex
2268
2269
2270 .section "Installing Exim binaries and scripts" "SECID32"
2271 .cindex "installing Exim"
2272 .cindex "BIN_DIRECTORY"
2273 The command &`make install`& runs the &(exim_install)& script with no
2274 arguments. The script copies binaries and utility scripts into the directory
2275 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2276 .cindex "setuid" "installing Exim with"
2277 The install script copies files only if they are newer than the files they are
2278 going to replace. The Exim binary is required to be owned by root and have the
2279 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2280 install`& as root so that it can set up the Exim binary in this way. However, in
2281 some special situations (for example, if a host is doing no local deliveries)
2282 it may be possible to run Exim without making the binary setuid root (see
2283 chapter &<<CHAPsecurity>>& for details).
2284
2285 .cindex "CONFIGURE_FILE"
2286 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2287 in &_Local/Makefile_&. If this names a single file, and the file does not
2288 exist, the default configuration file &_src/configure.default_& is copied there
2289 by the installation script. If a run time configuration file already exists, it
2290 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2291 alternative files, no default is installed.
2292
2293 .cindex "system aliases file"
2294 .cindex "&_/etc/aliases_&"
2295 One change is made to the default configuration file when it is installed: the
2296 default configuration contains a router that references a system aliases file.
2297 The path to this file is set to the value specified by
2298 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2299 If the system aliases file does not exist, the installation script creates it,
2300 and outputs a comment to the user.
2301
2302 The created file contains no aliases, but it does contain comments about the
2303 aliases a site should normally have. Mail aliases have traditionally been
2304 kept in &_/etc/aliases_&. However, some operating systems are now using
2305 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2306 Exim's configuration if necessary.
2307
2308 The default configuration uses the local host's name as the only local domain,
2309 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2310 running as the local user. System aliases and &_.forward_& files in users' home
2311 directories are supported, but no NIS or NIS+ support is configured. Domains
2312 other than the name of the local host are routed using the DNS, with delivery
2313 over SMTP.
2314
2315 It is possible to install Exim for special purposes (such as building a binary
2316 distribution) in a private part of the file system. You can do this by a
2317 command such as
2318 .code
2319 make DESTDIR=/some/directory/ install
2320 .endd
2321 This has the effect of pre-pending the specified directory to all the file
2322 paths, except the name of the system aliases file that appears in the default
2323 configuration. (If a default alias file is created, its name &'is'& modified.)
2324 For backwards compatibility, ROOT is used if DESTDIR is not set,
2325 but this usage is deprecated.
2326
2327 .cindex "installing Exim" "what is not installed"
2328 Running &'make install'& does not copy the Exim 4 conversion script
2329 &'convert4r4'&. You will probably run this only once if you are
2330 upgrading from Exim 3. None of the documentation files in the &_doc_&
2331 directory are copied, except for the info files when you have set
2332 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2333
2334 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2335 to their names. The Exim binary itself, however, is handled differently. It is
2336 installed under a name that includes the version number and the compile number,
2337 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2338 called &_exim_& to point to the binary. If you are updating a previous version
2339 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2340 from the directory (as seen by other processes).
2341
2342 .cindex "installing Exim" "testing the script"
2343 If you want to see what the &'make install'& will do before running it for
2344 real, you can pass the &%-n%& option to the installation script by this
2345 command:
2346 .code
2347 make INSTALL_ARG=-n install
2348 .endd
2349 The contents of the variable INSTALL_ARG are passed to the installation
2350 script. You do not need to be root to run this test. Alternatively, you can run
2351 the installation script directly, but this must be from within the build
2352 directory. For example, from the top-level Exim directory you could use this
2353 command:
2354 .code
2355 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2356 .endd
2357 .cindex "installing Exim" "install script options"
2358 There are two other options that can be supplied to the installation script.
2359
2360 .ilist
2361 &%-no_chown%& bypasses the call to change the owner of the installed binary
2362 to root, and the call to make it a setuid binary.
2363 .next
2364 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2365 installed binary.
2366 .endlist
2367
2368 INSTALL_ARG can be used to pass these options to the script. For example:
2369 .code
2370 make INSTALL_ARG=-no_symlink install
2371 .endd
2372 The installation script can also be given arguments specifying which files are
2373 to be copied. For example, to install just the Exim binary, and nothing else,
2374 without creating the symbolic link, you could use:
2375 .code
2376 make INSTALL_ARG='-no_symlink exim' install
2377 .endd
2378
2379
2380
2381 .section "Installing info documentation" "SECTinsinfdoc"
2382 .cindex "installing Exim" "&'info'& documentation"
2383 Not all systems use the GNU &'info'& system for documentation, and for this
2384 reason, the Texinfo source of Exim's documentation is not included in the main
2385 distribution. Instead it is available separately from the ftp site (see section
2386 &<<SECTavail>>&).
2387
2388 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2389 source of the documentation is found in the source tree, running &`make
2390 install`& automatically builds the info files and installs them.
2391
2392
2393
2394 .section "Setting up the spool directory" "SECID33"
2395 .cindex "spool directory" "creating"
2396 When it starts up, Exim tries to create its spool directory if it does not
2397 exist. The Exim uid and gid are used for the owner and group of the spool
2398 directory. Sub-directories are automatically created in the spool directory as
2399 necessary.
2400
2401
2402
2403
2404 .section "Testing" "SECID34"
2405 .cindex "testing" "installation"
2406 Having installed Exim, you can check that the run time configuration file is
2407 syntactically valid by running the following command, which assumes that the
2408 Exim binary directory is within your PATH environment variable:
2409 .code
2410 exim -bV
2411 .endd
2412 If there are any errors in the configuration file, Exim outputs error messages.
2413 Otherwise it outputs the version number and build date,
2414 the DBM library that is being used, and information about which drivers and
2415 other optional code modules are included in the binary.
2416 Some simple routing tests can be done by using the address testing option. For
2417 example,
2418 .display
2419 &`exim -bt`& <&'local username'&>
2420 .endd
2421 should verify that it recognizes a local mailbox, and
2422 .display
2423 &`exim -bt`& <&'remote address'&>
2424 .endd
2425 a remote one. Then try getting it to deliver mail, both locally and remotely.
2426 This can be done by passing messages directly to Exim, without going through a
2427 user agent. For example:
2428 .code
2429 exim -v postmaster@your.domain.example
2430 From: user@your.domain.example
2431 To: postmaster@your.domain.example
2432 Subject: Testing Exim
2433
2434 This is a test message.
2435 ^D
2436 .endd
2437 The &%-v%& option causes Exim to output some verification of what it is doing.
2438 In this case you should see copies of three log lines, one for the message's
2439 arrival, one for its delivery, and one containing &"Completed"&.
2440
2441 .cindex "delivery" "problems with"
2442 If you encounter problems, look at Exim's log files (&'mainlog'& and
2443 &'paniclog'&) to see if there is any relevant information there. Another source
2444 of information is running Exim with debugging turned on, by specifying the
2445 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2446 with debugging turned on by a command of the form
2447 .display
2448 &`exim -d -M`& <&'exim-message-id'&>
2449 .endd
2450 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2451 produces rather a lot of output, but you can cut this down to specific areas.
2452 For example, if you use &%-d-all+route%& only the debugging information
2453 relevant to routing is included. (See the &%-d%& option in chapter
2454 &<<CHAPcommandline>>& for more details.)
2455
2456 .cindex '&"sticky"& bit'
2457 .cindex "lock files"
2458 One specific problem that has shown up on some sites is the inability to do
2459 local deliveries into a shared mailbox directory, because it does not have the
2460 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2461 writing to a mailbox file, and if it cannot create the lock file, the delivery
2462 is deferred. You can get round this either by setting the &"sticky bit"& on the
2463 directory, or by setting a specific group for local deliveries and allowing
2464 that group to create files in the directory (see the comments above the
2465 &(local_delivery)& transport in the default configuration file). Another
2466 approach is to configure Exim not to use lock files, but just to rely on
2467 &[fcntl()]& locking instead. However, you should do this only if all user
2468 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2469 see chapter &<<CHAPappendfile>>&.
2470
2471 One thing that cannot be tested on a system that is already running an MTA is
2472 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2473 &%-oX%& option can be used to run an Exim daemon that listens on some other
2474 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2475 &'exim_checkaccess'& utility can be used to check out policy controls on
2476 incoming SMTP mail.
2477
2478 Testing a new version on a system that is already running Exim can most easily
2479 be done by building a binary with a different CONFIGURE_FILE setting. From
2480 within the run time configuration, all other file and directory names
2481 that Exim uses can be altered, in order to keep it entirely clear of the
2482 production version.
2483
2484
2485 .section "Replacing another MTA with Exim" "SECID35"
2486 .cindex "replacing another MTA"
2487 Building and installing Exim for the first time does not of itself put it in
2488 general use. The name by which the system's MTA is called by mail user agents
2489 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2490 operating system), and it is necessary to make this name point to the &'exim'&
2491 binary in order to get the user agents to pass messages to Exim. This is
2492 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2493 or &_/usr/lib/sendmail_&
2494 .cindex "symbolic link" "to &'exim'& binary"
2495 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2496 privilege and executable status from the old MTA. It is then necessary to stop
2497 and restart the mailer daemon, if one is running.
2498
2499 .cindex "FreeBSD, MTA indirection"
2500 .cindex "&_/etc/mail/mailer.conf_&"
2501 Some operating systems have introduced alternative ways of switching MTAs. For
2502 example, if you are running FreeBSD, you need to edit the file
2503 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2504 described. A typical example of the contents of this file for running Exim is
2505 as follows:
2506 .code
2507 sendmail            /usr/exim/bin/exim
2508 send-mail           /usr/exim/bin/exim
2509 mailq               /usr/exim/bin/exim -bp
2510 newaliases          /usr/bin/true
2511 .endd
2512 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2513 your Exim installation is &"live"&. Check it by sending a message from your
2514 favourite user agent.
2515
2516 You should consider what to tell your users about the change of MTA. Exim may
2517 have different capabilities to what was previously running, and there are
2518 various operational differences such as the text of messages produced by
2519 command line options and in bounce messages. If you allow your users to make
2520 use of Exim's filtering capabilities, you should make the document entitled
2521 &'Exim's interface to mail filtering'& available to them.
2522
2523
2524
2525 .section "Upgrading Exim" "SECID36"
2526 .cindex "upgrading Exim"
2527 If you are already running Exim on your host, building and installing a new
2528 version automatically makes it available to MUAs, or any other programs that
2529 call the MTA directly. However, if you are running an Exim daemon, you do need
2530 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2531 new binary. You do not need to stop processing mail in order to install a new
2532 version of Exim. The install script does not modify an existing runtime
2533 configuration file.
2534
2535
2536
2537
2538 .section "Stopping the Exim daemon on Solaris" "SECID37"
2539 .cindex "Solaris" "stopping Exim on"
2540 The standard command for stopping the mailer daemon on Solaris is
2541 .code
2542 /etc/init.d/sendmail stop
2543 .endd
2544 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2545 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2546 for the text &"sendmail"&; this is not present because the actual program name
2547 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2548 solution is to replace the line that finds the process id with something like
2549 .code
2550 pid=`cat /var/spool/exim/exim-daemon.pid`
2551 .endd
2552 to obtain the daemon's pid directly from the file that Exim saves it in.
2553
2554 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2555 still be received from local processes, and if automatic delivery is configured
2556 (the normal case), deliveries will still occur.
2557
2558
2559
2560
2561 . ////////////////////////////////////////////////////////////////////////////
2562 . ////////////////////////////////////////////////////////////////////////////
2563
2564 .chapter "The Exim command line" "CHAPcommandline"
2565 .scindex IIDclo1 "command line" "options"
2566 .scindex IIDclo2 "options" "command line"
2567 Exim's command line takes the standard Unix form of a sequence of options,
2568 each starting with a hyphen character, followed by a number of arguments. The
2569 options are compatible with the main options of Sendmail, and there are also
2570 some additional options, some of which are compatible with Smail 3. Certain
2571 combinations of options do not make sense, and provoke an error if used.
2572 The form of the arguments depends on which options are set.
2573
2574
2575 .section "Setting options by program name" "SECID38"
2576 .cindex "&'mailq'&"
2577 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2578 were present before any other options.
2579 The &%-bp%& option requests a listing of the contents of the mail queue on the
2580 standard output.
2581 This feature is for compatibility with some systems that contain a command of
2582 that name in one of the standard libraries, symbolically linked to
2583 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2584
2585 .cindex "&'rsmtp'&"
2586 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2587 were present before any other options, for compatibility with Smail. The
2588 &%-bS%& option is used for reading in a number of messages in batched SMTP
2589 format.
2590
2591 .cindex "&'rmail'&"
2592 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2593 &%-oee%& options were present before any other options, for compatibility with
2594 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2595
2596 .cindex "&'runq'&"
2597 .cindex "queue runner"
2598 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2599 were present before any other options, for compatibility with Smail. The &%-q%&
2600 option causes a single queue runner process to be started.
2601
2602 .cindex "&'newaliases'&"
2603 .cindex "alias file" "building"
2604 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2605 If Exim is called under the name &'newaliases'& it behaves as if the option
2606 &%-bi%& were present before any other options, for compatibility with Sendmail.
2607 This option is used for rebuilding Sendmail's alias file. Exim does not have
2608 the concept of a single alias file, but can be configured to run a given
2609 command if called with the &%-bi%& option.
2610
2611
2612 .section "Trusted and admin users" "SECTtrustedadmin"
2613 Some Exim options are available only to &'trusted users'& and others are
2614 available only to &'admin users'&. In the description below, the phrases &"Exim
2615 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2616 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2617 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2618
2619 .ilist
2620 .cindex "trusted users" "definition of"
2621 .cindex "user" "trusted definition of"
2622 The trusted users are root, the Exim user, any user listed in the
2623 &%trusted_users%& configuration option, and any user whose current group or any
2624 supplementary group is one of those listed in the &%trusted_groups%&
2625 configuration option. Note that the Exim group is not automatically trusted.
2626
2627 .cindex '&"From"& line'
2628 .cindex "envelope sender"
2629 Trusted users are always permitted to use the &%-f%& option or a leading
2630 &"From&~"& line to specify the envelope sender of a message that is passed to
2631 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2632 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2633 users to set envelope senders.
2634
2635 .cindex "&'From:'& header line"
2636 .cindex "&'Sender:'& header line"
2637 For a trusted user, there is never any check on the contents of the &'From:'&
2638 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2639 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2640
2641 Trusted users may also specify a host name, host address, interface address,
2642 protocol name, ident value, and authentication data when submitting a message
2643 locally. Thus, they are able to insert messages into Exim's queue locally that
2644 have the characteristics of messages received from a remote host. Untrusted
2645 users may in some circumstances use &%-f%&, but can never set the other values
2646 that are available to trusted users.
2647 .next
2648 .cindex "user" "admin definition of"
2649 .cindex "admin user" "definition of"
2650 The admin users are root, the Exim user, and any user that is a member of the
2651 Exim group or of any group listed in the &%admin_groups%& configuration option.
2652 The current group does not have to be one of these groups.
2653
2654 Admin users are permitted to list the queue, and to carry out certain
2655 operations on messages, for example, to force delivery failures. It is also
2656 necessary to be an admin user in order to see the full information provided by
2657 the Exim monitor, and full debugging output.
2658
2659 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2660 Exim to attempt delivery of messages on its queue is restricted to admin users.
2661 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2662 option false (that is, specifying &%no_prod_requires_admin%&).
2663
2664 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2665 is restricted to admin users unless &%queue_list_requires_admin%& is set
2666 false.
2667 .endlist
2668
2669
2670 &*Warning*&: If you configure your system so that admin users are able to
2671 edit Exim's configuration file, you are giving those users an easy way of
2672 getting root. There is further discussion of this issue at the start of chapter
2673 &<<CHAPconf>>&.
2674
2675
2676
2677
2678 .section "Command line options" "SECID39"
2679 Exim's command line options are described in alphabetical order below. If none
2680 of the options that specifies a specific action (such as starting the daemon or
2681 a queue runner, or testing an address, or receiving a message in a specific
2682 format, or listing the queue) are present, and there is at least one argument
2683 on the command line, &%-bm%& (accept a local message on the standard input,
2684 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2685 outputs a brief message about itself and exits.
2686
2687 . ////////////////////////////////////////////////////////////////////////////
2688 . Insert a stylized XML comment here, to identify the start of the command line
2689 . options. This is for the benefit of the Perl script that automatically
2690 . creates a man page for the options.
2691 . ////////////////////////////////////////////////////////////////////////////
2692
2693 .literal xml
2694 <!-- === Start of command line options === -->
2695 .literal off
2696
2697
2698 .vlist
2699 .vitem &%--%&
2700 .oindex "--"
2701 .cindex "options" "command line; terminating"
2702 This is a pseudo-option whose only purpose is to terminate the options and
2703 therefore to cause subsequent command line items to be treated as arguments
2704 rather than options, even if they begin with hyphens.
2705
2706 .vitem &%--help%&
2707 .oindex "&%--help%&"
2708 This option causes Exim to output a few sentences stating what it is.
2709 The same output is generated if the Exim binary is called with no options and
2710 no arguments.
2711
2712 .vitem &%--version%&
2713 .oindex "&%--version%&"
2714 This option is an alias for &%-bV%& and causes version information to be
2715 displayed.
2716
2717 .new
2718 .vitem &%-Ac%& &&&
2719        &%-Am%&
2720 .oindex "&%-Ac%&"
2721 .oindex "&%-Am%&"
2722 These options are used by Sendmail for selecting configuration files and are
2723 ignored by Exim.
2724 .wen
2725
2726 .vitem &%-B%&<&'type'&>
2727 .oindex "&%-B%&"
2728 .cindex "8-bit characters"
2729 .cindex "Sendmail compatibility" "8-bit characters"
2730 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2731 clean; it ignores this option.
2732
2733 .vitem &%-bd%&
2734 .oindex "&%-bd%&"
2735 .cindex "daemon"
2736 .cindex "SMTP" "listener"
2737 .cindex "queue runner"
2738 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2739 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2740 that the daemon should also initiate periodic queue runs.
2741
2742 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2743 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2744 disconnect from the controlling terminal. When running this way, it can be
2745 stopped by pressing ctrl-C.
2746
2747 By default, Exim listens for incoming connections to the standard SMTP port on
2748 all the host's running interfaces. However, it is possible to listen on other
2749 ports, on multiple ports, and only on specific interfaces. Chapter
2750 &<<CHAPinterfaces>>& contains a description of the options that control this.
2751
2752 When a listening daemon
2753 .cindex "daemon" "process id (pid)"
2754 .cindex "pid (process id)" "of daemon"
2755 is started without the use of &%-oX%& (that is, without overriding the normal
2756 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2757 in Exim's spool directory. This location can be overridden by setting
2758 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2759 running as root.
2760
2761 When &%-oX%& is used on the command line to start a listening daemon, the
2762 process id is not written to the normal pid file path. However, &%-oP%& can be
2763 used to specify a path on the command line if a pid file is required.
2764
2765 The SIGHUP signal
2766 .cindex "SIGHUP"
2767 .cindex "daemon" "restarting"
2768 can be used to cause the daemon to re-execute itself. This should be done
2769 whenever Exim's configuration file, or any file that is incorporated into it by
2770 means of the &%.include%& facility, is changed, and also whenever a new version
2771 of Exim is installed. It is not necessary to do this when other files that are
2772 referenced from the configuration (for example, alias files) are changed,
2773 because these are reread each time they are used.
2774
2775 .vitem &%-bdf%&
2776 .oindex "&%-bdf%&"
2777 This option has the same effect as &%-bd%& except that it never disconnects
2778 from the controlling terminal, even when no debugging is specified.
2779
2780 .vitem &%-be%&
2781 .oindex "&%-be%&"
2782 .cindex "testing" "string expansion"
2783 .cindex "expansion" "testing"
2784 Run Exim in expansion testing mode. Exim discards its root privilege, to
2785 prevent ordinary users from using this mode to read otherwise inaccessible
2786 files. If no arguments are given, Exim runs interactively, prompting for lines
2787 of data. Otherwise, it processes each argument in turn.
2788
2789 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2790 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2791 used without command line arguments. If successful, it uses the &[readline()]&
2792 function, which provides extensive line-editing facilities, for reading the
2793 test data. A line history is supported.
2794
2795 Long expansion expressions can be split over several lines by using backslash
2796 continuations. As in Exim's run time configuration, white space at the start of
2797 continuation lines is ignored. Each argument or data line is passed through the
2798 string expansion mechanism, and the result is output. Variable values from the
2799 configuration file (for example, &$qualify_domain$&) are available, but no
2800 message-specific values (such as &$sender_domain$&) are set, because no message
2801 is being processed (but see &%-bem%& and &%-Mset%&).
2802
2803 &*Note*&: If you use this mechanism to test lookups, and you change the data
2804 files or databases you are using, you must exit and restart Exim before trying
2805 the same lookup again. Otherwise, because each Exim process caches the results
2806 of lookups, you will just get the same result as before.
2807
2808 .vitem &%-bem%&&~<&'filename'&>
2809 .oindex "&%-bem%&"
2810 .cindex "testing" "string expansion"
2811 .cindex "expansion" "testing"
2812 This option operates like &%-be%& except that it must be followed by the name
2813 of a file. For example:
2814 .code
2815 exim -bem /tmp/testmessage
2816 .endd
2817 The file is read as a message (as if receiving a locally-submitted non-SMTP
2818 message) before any of the test expansions are done. Thus, message-specific
2819 variables such as &$message_size$& and &$header_from:$& are available. However,
2820 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2821 recipients are read from the headers in the normal way, and are shown in the
2822 &$recipients$& variable. Note that recipients cannot be given on the command
2823 line, because further arguments are taken as strings to expand (just like
2824 &%-be%&).
2825
2826 .vitem &%-bF%&&~<&'filename'&>
2827 .oindex "&%-bF%&"
2828 .cindex "system filter" "testing"
2829 .cindex "testing" "system filter"
2830 This option is the same as &%-bf%& except that it assumes that the filter being
2831 tested is a system filter. The additional commands that are available only in
2832 system filters are recognized.
2833
2834 .vitem &%-bf%&&~<&'filename'&>
2835 .oindex "&%-bf%&"
2836 .cindex "filter" "testing"
2837 .cindex "testing" "filter file"
2838 .cindex "forward file" "testing"
2839 .cindex "testing" "forward file"
2840 .cindex "Sieve filter" "testing"
2841 This option runs Exim in user filter testing mode; the file is the filter file
2842 to be tested, and a test message must be supplied on the standard input. If
2843 there are no message-dependent tests in the filter, an empty file can be
2844 supplied.
2845
2846 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2847 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2848 filter and a user filter in the same run. For example:
2849 .code
2850 exim -bF /system/filter -bf /user/filter </test/message
2851 .endd
2852 This is helpful when the system filter adds header lines or sets filter
2853 variables that are used by the user filter.
2854
2855 If the test filter file does not begin with one of the special lines
2856 .code
2857 # Exim filter
2858 # Sieve filter
2859 .endd
2860 it is taken to be a normal &_.forward_& file, and is tested for validity under
2861 that interpretation. See sections &<<SECTitenonfilred>>& to
2862 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2863 redirection lists.
2864
2865 The result of an Exim command that uses &%-bf%&, provided no errors are
2866 detected, is a list of the actions that Exim would try to take if presented
2867 with the message for real. More details of filter testing are given in the
2868 separate document entitled &'Exim's interfaces to mail filtering'&.
2869
2870 When testing a filter file,
2871 .cindex "&""From""& line"
2872 .cindex "envelope sender"
2873 .oindex "&%-f%&" "for filter testing"
2874 the envelope sender can be set by the &%-f%& option,
2875 or by a &"From&~"& line at the start of the test message. Various parameters
2876 that would normally be taken from the envelope recipient address of the message
2877 can be set by means of additional command line options (see the next four
2878 options).
2879
2880 .vitem &%-bfd%&&~<&'domain'&>
2881 .oindex "&%-bfd%&"
2882 .vindex "&$qualify_domain$&"
2883 This sets the domain of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the value of
2885 &$qualify_domain$&.
2886
2887 .vitem &%-bfl%&&~<&'local&~part'&>
2888 .oindex "&%-bfl%&"
2889 This sets the local part of the recipient address when a filter file is being
2890 tested by means of the &%-bf%& option. The default is the username of the
2891 process that calls Exim. A local part should be specified with any prefix or
2892 suffix stripped, because that is how it appears to the filter when a message is
2893 actually being delivered.
2894
2895 .vitem &%-bfp%&&~<&'prefix'&>
2896 .oindex "&%-bfp%&"
2897 This sets the prefix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 prefix.
2900
2901 .vitem &%-bfs%&&~<&'suffix'&>
2902 .oindex "&%-bfs%&"
2903 This sets the suffix of the local part of the recipient address when a filter
2904 file is being tested by means of the &%-bf%& option. The default is an empty
2905 suffix.
2906
2907 .vitem &%-bh%&&~<&'IP&~address'&>
2908 .oindex "&%-bh%&"
2909 .cindex "testing" "incoming SMTP"
2910 .cindex "SMTP" "testing incoming"
2911 .cindex "testing" "relay control"
2912 .cindex "relaying" "testing configuration"
2913 .cindex "policy control" "testing"
2914 .cindex "debugging" "&%-bh%& option"
2915 This option runs a fake SMTP session as if from the given IP address, using the
2916 standard input and output. The IP address may include a port number at the end,
2917 after a full stop. For example:
2918 .code
2919 exim -bh 10.9.8.7.1234
2920 exim -bh fe80::a00:20ff:fe86:a061.5678
2921 .endd
2922 When an IPv6 address is given, it is converted into canonical form. In the case
2923 of the second example above, the value of &$sender_host_address$& after
2924 conversion to the canonical form is
2925 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2926
2927 Comments as to what is going on are written to the standard error file. These
2928 include lines beginning with &"LOG"& for anything that would have been logged.
2929 This facility is provided for testing configuration options for incoming
2930 messages, to make sure they implement the required policy. For example, you can
2931 test your relay controls using &%-bh%&.
2932
2933 &*Warning 1*&:
2934 .cindex "RFC 1413"
2935 You can test features of the configuration that rely on ident (RFC 1413)
2936 information by using the &%-oMt%& option. However, Exim cannot actually perform
2937 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2938 connection.
2939
2940 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2941 are also skipped when testing using &%-bh%&. If you want these callouts to
2942 occur, use &%-bhc%& instead.
2943
2944 Messages supplied during the testing session are discarded, and nothing is
2945 written to any of the real log files. There may be pauses when DNS (and other)
2946 lookups are taking place, and of course these may time out. The &%-oMi%& option
2947 can be used to specify a specific IP interface and port if this is important,
2948 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2949 session were authenticated.
2950
2951 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2952 output just states whether a given recipient address from a given host is
2953 acceptable or not. See section &<<SECTcheckaccess>>&.
2954
2955 Features such as authentication and encryption, where the client input is not
2956 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2957 specialized SMTP test program such as
2958 &url(http://jetmore.org/john/code/#swaks,swaks).
2959
2960 .vitem &%-bhc%&&~<&'IP&~address'&>
2961 .oindex "&%-bhc%&"
2962 This option operates in the same way as &%-bh%&, except that address
2963 verification callouts are performed if required. This includes consulting and
2964 updating the callout cache database.
2965
2966 .vitem &%-bi%&
2967 .oindex "&%-bi%&"
2968 .cindex "alias file" "building"
2969 .cindex "building alias file"
2970 .cindex "Sendmail compatibility" "&%-bi%& option"
2971 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2972 Exim does not have the concept of a single alias file, and so it cannot mimic
2973 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2974 tend to appear in various scripts such as NIS make files, so the option must be
2975 recognized.
2976
2977 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2978 configuration option is run, under the uid and gid of the caller of Exim. If
2979 the &%-oA%& option is used, its value is passed to the command as an argument.
2980 The command set by &%bi_command%& may not contain arguments. The command can
2981 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2982 if this is required. If the &%bi_command%& option is not set, calling Exim with
2983 &%-bi%& is a no-op.
2984
2985 .new
2986 . // Keep :help first, then the rest in alphabetical order
2987 .vitem &%-bI:help%&
2988 .oindex "&%-bI:help%&"
2989 .cindex "querying exim information"
2990 We shall provide various options starting &`-bI:`& for querying Exim for
2991 information.  The output of many of these will be intended for machine
2992 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2993 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2994 options shall cause Exim to exit after producing the requested output.
2995
2996 .vitem &%-bI:dscp%&
2997 .oindex "&%-bI:dscp%&"
2998 .cindex "DSCP" "values"
2999 This option causes Exim to emit an alphabetically sorted list of all
3000 recognised DSCP names.
3001
3002 .vitem &%-bI:sieve%&
3003 .oindex "&%-bI:sieve%&"
3004 .cindex "Sieve filter" "capabilities"
3005 This option causes Exim to emit an alphabetically sorted list of all supported
3006 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3007 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3008 &`SIEVE`& capability response line.  As the precise list may depend upon
3009 compile-time build options, which this option will adapt to, this is the only
3010 way to guarantee a correct response.
3011 .wen
3012
3013 .vitem &%-bm%&
3014 .oindex "&%-bm%&"
3015 .cindex "local message reception"
3016 This option runs an Exim receiving process that accepts an incoming,
3017 locally-generated message on the standard input. The recipients are given as the
3018 command arguments (except when &%-t%& is also present &-- see below). Each
3019 argument can be a comma-separated list of RFC 2822 addresses. This is the
3020 default option for selecting the overall action of an Exim call; it is assumed
3021 if no other conflicting option is present.
3022
3023 If any addresses in the message are unqualified (have no domain), they are
3024 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3025 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3026 suppressing this for special cases.
3027
3028 Policy checks on the contents of local messages can be enforced by means of
3029 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3030
3031 .cindex "return code" "for &%-bm%&"
3032 The return code is zero if the message is successfully accepted. Otherwise, the
3033 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3034
3035 The format
3036 .cindex "message" "format"
3037 .cindex "format" "message"
3038 .cindex "&""From""& line"
3039 .cindex "UUCP" "&""From""& line"
3040 .cindex "Sendmail compatibility" "&""From""& line"
3041 of the message must be as defined in RFC 2822, except that, for
3042 compatibility with Sendmail and Smail, a line in one of the forms
3043 .code
3044 From sender Fri Jan  5 12:55 GMT 1997
3045 From sender Fri, 5 Jan 97 12:55:01
3046 .endd
3047 (with the weekday optional, and possibly with additional text after the date)
3048 is permitted to appear at the start of the message. There appears to be no
3049 authoritative specification of the format of this line. Exim recognizes it by
3050 matching against the regular expression defined by the &%uucp_from_pattern%&
3051 option, which can be changed if necessary.
3052
3053 .oindex "&%-f%&" "overriding &""From""& line"
3054 The specified sender is treated as if it were given as the argument to the
3055 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3056 preference to the address taken from the message. The caller of Exim must be a
3057 trusted user for the sender of a message to be set in this way.
3058
3059 .vitem &%-bmalware%&&~<&'filename'&>
3060 .oindex "&%-bmalware%&"
3061 .cindex "testing", "malware"
3062 .cindex "malware scan test"
3063 This debugging option causes Exim to scan the given file,
3064 using the malware scanning framework.  The option of &%av_scanner%& influences
3065 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3066 the expansion should have defaults which apply to this invocation.  ACLs are
3067 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3068 will never be populated and &%-bmalware%& will fail.
3069
3070 Exim will have changed working directory before resolving the filename, so
3071 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3072 user when it tries to open the file, rather than as the invoking user.
3073 This option requires admin privileges.
3074
3075 The &%-bmalware%& option will not be extended to be more generally useful,
3076 there are better tools for file-scanning.  This option exists to help
3077 administrators verify their Exim and AV scanner configuration.
3078
3079 .vitem &%-bnq%&
3080 .oindex "&%-bnq%&"
3081 .cindex "address qualification, suppressing"
3082 By default, Exim automatically qualifies unqualified addresses (those
3083 without domains) that appear in messages that are submitted locally (that
3084 is, not over TCP/IP). This qualification applies both to addresses in
3085 envelopes, and addresses in header lines. Sender addresses are qualified using
3086 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3087 defaults to the value of &%qualify_domain%&).
3088
3089 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3090 being used to re-submit messages that originally came from remote hosts after
3091 content scanning, you probably do not want to qualify unqualified addresses in
3092 header lines. (Such lines will be present only if you have not enabled a header
3093 syntax check in the appropriate ACL.)
3094
3095 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3096 messages that originate on the local host. When this is used, unqualified
3097 addresses in the envelope provoke errors (causing message rejection) and
3098 unqualified addresses in header lines are left alone.
3099
3100
3101 .vitem &%-bP%&
3102 .oindex "&%-bP%&"
3103 .cindex "configuration options" "extracting"
3104 .cindex "options" "configuration &-- extracting"
3105 If this option is given with no arguments, it causes the values of all Exim's
3106 main configuration options to be written to the standard output. The values
3107 of one or more specific options can be requested by giving their names as
3108 arguments, for example:
3109 .code
3110 exim -bP qualify_domain hold_domains
3111 .endd
3112 .cindex "hiding configuration option values"
3113 .cindex "configuration options" "hiding value of"
3114 .cindex "options" "hiding value of"
3115 However, any option setting that is preceded by the word &"hide"& in the
3116 configuration file is not shown in full, except to an admin user. For other
3117 users, the output is as in this example:
3118 .code
3119 mysql_servers = <value not displayable>
3120 .endd
3121 If &%configure_file%& is given as an argument, the name of the run time
3122 configuration file is output.
3123 If a list of configuration files was supplied, the value that is output here
3124 is the name of the file that was actually used.
3125
3126 .new
3127 .cindex "options" "hiding name of"
3128 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3129 name will not be output.
3130 .wen
3131
3132 .cindex "daemon" "process id (pid)"
3133 .cindex "pid (process id)" "of daemon"
3134 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3135 directories where log files and daemon pid files are written are output,
3136 respectively. If these values are unset, log files are written in a
3137 sub-directory of the spool directory called &%log%&, and the pid file is
3138 written directly into the spool directory.
3139
3140 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3141 .code
3142 exim -bP +local_domains
3143 .endd
3144 it searches for a matching named list of any type (domain, host, address, or
3145 local part) and outputs what it finds.
3146
3147 .cindex "options" "router &-- extracting"
3148 .cindex "options" "transport &-- extracting"
3149 .cindex "options" "authenticator &-- extracting"
3150 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3151 followed by the name of an appropriate driver instance, the option settings for
3152 that driver are output. For example:
3153 .code
3154 exim -bP transport local_delivery
3155 .endd
3156 The generic driver options are output first, followed by the driver's private
3157 options. A list of the names of drivers of a particular type can be obtained by
3158 using one of the words &%router_list%&, &%transport_list%&, or
3159 &%authenticator_list%&, and a complete list of all drivers with their option
3160 settings can be obtained by using &%routers%&, &%transports%&, or
3161 &%authenticators%&.
3162
3163 .cindex "environment"
3164 If &%environment%& is given as an argument, the set of environment
3165 variables is output, line by line. Using the &%-n%& flag supresses the value of the
3166 variables.
3167
3168 .cindex "options" "macro &-- extracting"
3169 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3170 are available, similarly to the drivers.  Because macros are sometimes used
3171 for storing passwords, this option is restricted.
3172 The output format is one item per line.
3173
3174 .vitem &%-bp%&
3175 .oindex "&%-bp%&"
3176 .cindex "queue" "listing messages on"
3177 .cindex "listing" "messages on the queue"
3178 This option requests a listing of the contents of the mail queue on the
3179 standard output. If the &%-bp%& option is followed by a list of message ids,
3180 just those messages are listed. By default, this option can be used only by an
3181 admin user. However, the &%queue_list_requires_admin%& option can be set false
3182 to allow any user to see the queue.
3183
3184 Each message on the queue is displayed as in the following example:
3185 .code
3186 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3187           red.king@looking-glass.fict.example
3188           <other addresses>
3189 .endd
3190 .cindex "message" "size in queue listing"
3191 .cindex "size" "of message"
3192 The first line contains the length of time the message has been on the queue
3193 (in this case 25 minutes), the size of the message (2.9K), the unique local
3194 identifier for the message, and the message sender, as contained in the
3195 envelope. For bounce messages, the sender address is empty, and appears as
3196 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3197 the default sender address, the user's login name is shown in parentheses
3198 before the sender address.
3199
3200 .cindex "frozen messages" "in queue listing"
3201 If the message is frozen (attempts to deliver it are suspended) then the text
3202 &"*** frozen ***"& is displayed at the end of this line.
3203
3204 The recipients of the message (taken from the envelope, not the headers) are
3205 displayed on subsequent lines. Those addresses to which the message has already
3206 been delivered are marked with the letter D. If an original address gets
3207 expanded into several addresses via an alias or forward file, the original is
3208 displayed with a D only when deliveries for all of its child addresses are
3209 complete.
3210
3211
3212 .vitem &%-bpa%&
3213 .oindex "&%-bpa%&"
3214 This option operates like &%-bp%&, but in addition it shows delivered addresses
3215 that were generated from the original top level address(es) in each message by
3216 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3217 of just &"D"&.
3218
3219
3220 .vitem &%-bpc%&
3221 .oindex "&%-bpc%&"
3222 .cindex "queue" "count of messages on"
3223 This option counts the number of messages on the queue, and writes the total
3224 to the standard output. It is restricted to admin users, unless
3225 &%queue_list_requires_admin%& is set false.
3226
3227
3228 .vitem &%-bpr%&
3229 .oindex "&%-bpr%&"
3230 This option operates like &%-bp%&, but the output is not sorted into
3231 chronological order of message arrival. This can speed it up when there are
3232 lots of messages on the queue, and is particularly useful if the output is
3233 going to be post-processed in a way that doesn't need the sorting.
3234
3235 .vitem &%-bpra%&
3236 .oindex "&%-bpra%&"
3237 This option is a combination of &%-bpr%& and &%-bpa%&.
3238
3239 .vitem &%-bpru%&
3240 .oindex "&%-bpru%&"
3241 This option is a combination of &%-bpr%& and &%-bpu%&.
3242
3243
3244 .vitem &%-bpu%&
3245 .oindex "&%-bpu%&"
3246 This option operates like &%-bp%& but shows only undelivered top-level
3247 addresses for each message displayed. Addresses generated by aliasing or
3248 forwarding are not shown, unless the message was deferred after processing by a
3249 router with the &%one_time%& option set.
3250
3251
3252 .vitem &%-brt%&
3253 .oindex "&%-brt%&"
3254 .cindex "testing" "retry configuration"
3255 .cindex "retry" "configuration testing"
3256 This option is for testing retry rules, and it must be followed by up to three
3257 arguments. It causes Exim to look for a retry rule that matches the values
3258 and to write it to the standard output. For example:
3259 .code
3260 exim -brt bach.comp.mus.example
3261 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3262 .endd
3263 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3264 argument, which is required, can be a complete address in the form
3265 &'local_part@domain'&, or it can be just a domain name. If the second argument
3266 contains a dot, it is interpreted as an optional second domain name; if no
3267 retry rule is found for the first argument, the second is tried. This ties in
3268 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3269 rule is found that matches the host, one that matches the mail domain is
3270 sought. Finally, an argument that is the name of a specific delivery error, as
3271 used in setting up retry rules, can be given. For example:
3272 .code
3273 exim -brt haydn.comp.mus.example quota_3d
3274 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3275 .endd
3276
3277 .vitem &%-brw%&
3278 .oindex "&%-brw%&"
3279 .cindex "testing" "rewriting"
3280 .cindex "rewriting" "testing"
3281 This option is for testing address rewriting rules, and it must be followed by
3282 a single argument, consisting of either a local part without a domain, or a
3283 complete address with a fully qualified domain. Exim outputs how this address
3284 would be rewritten for each possible place it might appear. See chapter
3285 &<<CHAPrewrite>>& for further details.
3286
3287 .vitem &%-bS%&
3288 .oindex "&%-bS%&"
3289 .cindex "SMTP" "batched incoming"
3290 .cindex "batched SMTP input"
3291 This option is used for batched SMTP input, which is an alternative interface
3292 for non-interactive local message submission. A number of messages can be
3293 submitted in a single run. However, despite its name, this is not really SMTP
3294 input. Exim reads each message's envelope from SMTP commands on the standard
3295 input, but generates no responses. If the caller is trusted, or
3296 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3297 believed; otherwise the sender is always the caller of Exim.
3298
3299 The message itself is read from the standard input, in SMTP format (leading
3300 dots doubled), terminated by a line containing just a single dot. An error is
3301 provoked if the terminating dot is missing. A further message may then follow.
3302
3303 As for other local message submissions, the contents of incoming batch SMTP
3304 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3305 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3306 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3307
3308 Some other SMTP commands are recognized in the input. HELO and EHLO act
3309 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3310 QUIT quits, ignoring the rest of the standard input.
3311
3312 .cindex "return code" "for &%-bS%&"
3313 If any error is encountered, reports are written to the standard output and
3314 error streams, and Exim gives up immediately. The return code is 0 if no error
3315 was detected; it is 1 if one or more messages were accepted before the error
3316 was detected; otherwise it is 2.
3317
3318 More details of input using batched SMTP are given in section
3319 &<<SECTincomingbatchedSMTP>>&.
3320
3321 .vitem &%-bs%&
3322 .oindex "&%-bs%&"
3323 .cindex "SMTP" "local input"
3324 .cindex "local SMTP input"
3325 This option causes Exim to accept one or more messages by reading SMTP commands
3326 on the standard input, and producing SMTP replies on the standard output. SMTP
3327 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3328 Some user agents use this interface as a way of passing locally-generated
3329 messages to the MTA.
3330
3331 In
3332 .cindex "sender" "source of"
3333 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3334 set, the senders of messages are taken from the SMTP MAIL commands.
3335 Otherwise the content of these commands is ignored and the sender is set up as
3336 the calling user. Unqualified addresses are automatically qualified using
3337 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3338 &%-bnq%& option is used.
3339
3340 .cindex "inetd"
3341 The
3342 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3343 using a listening daemon. Exim can distinguish the two cases by checking
3344 whether the standard input is a TCP/IP socket. When Exim is called from
3345 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3346 above concerning senders and qualification do not apply. In this situation,
3347 Exim behaves in exactly the same way as it does when receiving a message via
3348 the listening daemon.
3349
3350 .vitem &%-bt%&
3351 .oindex "&%-bt%&"
3352 .cindex "testing" "addresses"
3353 .cindex "address" "testing"
3354 This option runs Exim in address testing mode, in which each argument is taken
3355 as a recipient address to be tested for deliverability. The results are
3356 written to the standard output. If a test fails, and the caller is not an admin
3357 user, no details of the failure are output, because these might contain
3358 sensitive information such as usernames and passwords for database lookups.
3359
3360 If no arguments are given, Exim runs in an interactive manner, prompting with a
3361 right angle bracket for addresses to be tested.
3362
3363 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3364 &[readline()]& function, because it is running as &'root'& and there are
3365 security issues.
3366
3367 Each address is handled as if it were the recipient address of a message
3368 (compare the &%-bv%& option). It is passed to the routers and the result is
3369 written to the standard output. However, any router that has
3370 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3371 genuine routing tests if your first router passes everything to a scanner
3372 program.
3373
3374 .cindex "return code" "for &%-bt%&"
3375 The return code is 2 if any address failed outright; it is 1 if no address
3376 failed outright but at least one could not be resolved for some reason. Return
3377 code 0 is given only when all addresses succeed.
3378
3379 .cindex "duplicate addresses"
3380 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3381 addresses after routing is complete, so that only one delivery takes place.
3382 This does not happen when testing with &%-bt%&; the full results of routing are
3383 always shown.
3384
3385 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3386 routers in the configuration makes any tests on the sender address of a
3387 message,
3388 .oindex "&%-f%&" "for address testing"
3389 you can use the &%-f%& option to set an appropriate sender when running
3390 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3391 default qualifying domain. However, if you have set up (for example) routers
3392 whose behaviour depends on the contents of an incoming message, you cannot test
3393 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3394 doing such tests.
3395
3396 .vitem &%-bV%&
3397 .oindex "&%-bV%&"
3398 .cindex "version number of Exim"
3399 This option causes Exim to write the current version number, compilation
3400 number, and compilation date of the &'exim'& binary to the standard output.
3401 It also lists the DBM library that is being used, the optional modules (such as
3402 specific lookup types), the drivers that are included in the binary, and the
3403 name of the run time configuration file that is in use.
3404
3405 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3406 configuration file. However, this is a static check only. It cannot check
3407 values that are to be expanded. For example, although a misspelt ACL verb is
3408 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3409 alone to discover (for example) all the typos in the configuration; some
3410 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3411 dynamic testing facilities.
3412
3413 .vitem &%-bv%&
3414 .oindex "&%-bv%&"
3415 .cindex "verifying address" "using &%-bv%&"
3416 .cindex "address" "verification"
3417 This option runs Exim in address verification mode, in which each argument is
3418 taken as a recipient address to be verified by the routers. (This does
3419 not involve any verification callouts). During normal operation, verification
3420 happens mostly as a consequence processing a &%verify%& condition in an ACL
3421 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3422 including callouts, see the &%-bh%& and &%-bhc%& options.
3423
3424 If verification fails, and the caller is not an admin user, no details of the
3425 failure are output, because these might contain sensitive information such as
3426 usernames and passwords for database lookups.
3427
3428 If no arguments are given, Exim runs in an interactive manner, prompting with a
3429 right angle bracket for addresses to be verified.
3430
3431 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3432 &[readline()]& function, because it is running as &'exim'& and there are
3433 security issues.
3434
3435 Verification differs from address testing (the &%-bt%& option) in that routers
3436 that have &%no_verify%& set are skipped, and if the address is accepted by a
3437 router that has &%fail_verify%& set, verification fails. The address is
3438 verified as a recipient if &%-bv%& is used; to test verification for a sender
3439 address, &%-bvs%& should be used.
3440
3441 If the &%-v%& option is not set, the output consists of a single line for each
3442 address, stating whether it was verified or not, and giving a reason in the
3443 latter case. Without &%-v%&, generating more than one address by redirection
3444 causes verification to end successfully, without considering the generated
3445 addresses. However, if just one address is generated, processing continues,
3446 and the generated address must verify successfully for the overall verification
3447 to succeed.
3448
3449 When &%-v%& is set, more details are given of how the address has been handled,
3450 and in the case of address redirection, all the generated addresses are also
3451 considered. Verification may succeed for some and fail for others.
3452
3453 The
3454 .cindex "return code" "for &%-bv%&"
3455 return code is 2 if any address failed outright; it is 1 if no address
3456 failed outright but at least one could not be resolved for some reason. Return
3457 code 0 is given only when all addresses succeed.
3458
3459 If any of the routers in the configuration makes any tests on the sender
3460 address of a message, you should use the &%-f%& option to set an appropriate
3461 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3462 calling user at the default qualifying domain.
3463
3464 .vitem &%-bvs%&
3465 .oindex "&%-bvs%&"
3466 This option acts like &%-bv%&, but verifies the address as a sender rather
3467 than a recipient address. This affects any rewriting and qualification that
3468 might happen.
3469
3470 .vitem &%-bw%&
3471 .oindex "&%-bw%&"
3472 .cindex "daemon"
3473 .cindex "inetd"
3474 .cindex "inetd" "wait mode"
3475 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3476 similarly to the &%-bd%& option.  All port specifications on the command-line
3477 and in the configuration file are ignored.  Queue-running may not be specified.
3478
3479 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3480 listening for connections.  This permits the system to start up and have
3481 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3482 each port only when the first connection is received.
3483
3484 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3485 which the daemon will exit, which should cause inetd to listen once more.
3486
3487 .vitem &%-C%&&~<&'filelist'&>
3488 .oindex "&%-C%&"
3489 .cindex "configuration file" "alternate"
3490 .cindex "CONFIGURE_FILE"
3491 .cindex "alternate configuration file"
3492 This option causes Exim to find the run time configuration file from the given
3493 list instead of from the list specified by the CONFIGURE_FILE
3494 compile-time setting. Usually, the list will consist of just a single file
3495 name, but it can be a colon-separated list of names. In this case, the first
3496 file that exists is used. Failure to open an existing file stops Exim from
3497 proceeding any further along the list, and an error is generated.
3498
3499 The file names need to be absolute names.
3500
3501 When this option is used by a caller other than root, and the list is different
3502 from the compiled-in list, Exim gives up its root privilege immediately, and
3503 runs with the real and effective uid and gid set to those of the caller.
3504 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3505 file contains a list of full pathnames, one per line, for configuration files
3506 which are trusted. Root privilege is retained for any configuration file so
3507 listed, as long as the caller is the Exim user (or the user specified in the
3508 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3509 not writeable by inappropriate users or groups.
3510
3511 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3512 configuration using &%-C%& right through message reception and delivery,
3513 even if the caller is root. The reception works, but by that time, Exim is
3514 running as the Exim user, so when it re-executes to regain privilege for the
3515 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3516 test reception and delivery using two separate commands (one to put a message
3517 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3518
3519 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3520 prefix string with which any file named in a &%-C%& command line option
3521 must start. In addition, the file name must not contain the sequence &`/../`&.
3522 However, if the value of the &%-C%& option is identical to the value of
3523 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3524 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3525 unset, any file name can be used with &%-C%&.
3526
3527 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3528 to a directory to which only root has access. This prevents someone who has
3529 broken into the Exim account from running a privileged Exim with an arbitrary
3530 configuration file.
3531
3532 The &%-C%& facility is useful for ensuring that configuration files are
3533 syntactically correct, but cannot be used for test deliveries, unless the
3534 caller is privileged, or unless it is an exotic configuration that does not
3535 require privilege. No check is made on the owner or group of the files
3536 specified by this option.
3537
3538
3539 .vitem &%-D%&<&'macro'&>=<&'value'&>
3540 .oindex "&%-D%&"
3541 .cindex "macro" "setting on command line"
3542 This option can be used to override macro definitions in the configuration file
3543 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3544 unprivileged caller, it causes Exim to give up its root privilege.
3545 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3546 completely disabled, and its use causes an immediate error exit.
3547
3548 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3549 colon-separated list of macros which are considered safe and, if &%-D%& only
3550 supplies macros from this list, and the values are acceptable, then Exim will
3551 not give up root privilege if the caller is root, the Exim run-time user, or
3552 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3553 to be removed in the future.  Acceptable values for the macros satisfy the
3554 regexp: &`^[A-Za-z0-9_/.-]*$`&
3555
3556 The entire option (including equals sign if present) must all be within one
3557 command line item. &%-D%& can be used to set the value of a macro to the empty
3558 string, in which case the equals sign is optional. These two commands are
3559 synonymous:
3560 .code
3561 exim -DABC  ...
3562 exim -DABC= ...
3563 .endd
3564 To include spaces in a macro definition item, quotes must be used. If you use
3565 quotes, spaces are permitted around the macro name and the equals sign. For
3566 example:
3567 .code
3568 exim '-D ABC = something' ...
3569 .endd
3570 &%-D%& may be repeated up to 10 times on a command line.
3571
3572
3573 .vitem &%-d%&<&'debug&~options'&>
3574 .oindex "&%-d%&"
3575 .cindex "debugging" "list of selectors"
3576 .cindex "debugging" "&%-d%& option"
3577 This option causes debugging information to be written to the standard
3578 error stream. It is restricted to admin users because debugging output may show
3579 database queries that contain password information. Also, the details of users'
3580 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3581 writes an error message to the standard error stream and exits with a non-zero
3582 return code.
3583
3584 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3585 standard debugging data is output. This can be reduced, or increased to include
3586 some more rarely needed information, by directly following &%-d%& with a string
3587 made up of names preceded by plus or minus characters. These add or remove sets
3588 of debugging data, respectively. For example, &%-d+filter%& adds filter
3589 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3590 no spaces are allowed in the debug setting. The available debugging categories
3591 are:
3592 .display
3593 &`acl            `& ACL interpretation
3594 &`auth           `& authenticators
3595 &`deliver        `& general delivery logic
3596 &`dns            `& DNS lookups (see also resolver)
3597 &`dnsbl          `& DNS black list (aka RBL) code
3598 &`exec           `& arguments for &[execv()]& calls
3599 &`expand         `& detailed debugging for string expansions
3600 &`filter         `& filter handling
3601 &`hints_lookup   `& hints data lookups
3602 &`host_lookup    `& all types of name-to-IP address handling
3603 &`ident          `& ident lookup
3604 &`interface      `& lists of local interfaces
3605 &`lists          `& matching things in lists
3606 &`load           `& system load checks
3607 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3608                     &<<CHAPlocalscan>>&)
3609 &`lookup         `& general lookup code and all lookups
3610 &`memory         `& memory handling
3611 &`pid            `& add pid to debug output lines
3612 &`process_info   `& setting info for the process log
3613 &`queue_run      `& queue runs
3614 &`receive        `& general message reception logic
3615 &`resolver       `& turn on the DNS resolver's debugging output
3616 &`retry          `& retry handling
3617 &`rewrite        `& address rewriting
3618 &`route          `& address routing
3619 &`timestamp      `& add timestamp to debug output lines
3620 &`tls            `& TLS logic
3621 &`transport      `& transports
3622 &`uid            `& changes of uid/gid and looking up uid/gid
3623 &`verify         `& address verification logic
3624 &`all            `& almost all of the above (see below), and also &%-v%&
3625 .endd
3626 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3627 for &`-all`&. The reason for this is that &`+all`& is something that people
3628 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3629 is included, an awful lot of output that is very rarely of interest is
3630 generated, so it now has to be explicitly requested. However, &`-all`& does
3631 turn everything off.
3632
3633 .cindex "resolver, debugging output"
3634 .cindex "DNS resolver, debugging output"
3635 The &`resolver`& option produces output only if the DNS resolver was compiled
3636 with DEBUG enabled. This is not the case in some operating systems. Also,
3637 unfortunately, debugging output from the DNS resolver is written to stdout
3638 rather than stderr.
3639
3640 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3641 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3642 However, the &`pid`& selector is forced when debugging is turned on for a
3643 daemon, which then passes it on to any re-executed Exims. Exim also
3644 automatically adds the pid to debug lines when several remote deliveries are
3645 run in parallel.
3646
3647 The &`timestamp`& selector causes the current time to be inserted at the start
3648 of all debug output lines. This can be useful when trying to track down delays
3649 in processing.
3650
3651 If the &%debug_print%& option is set in any driver, it produces output whenever
3652 any debugging is selected, or if &%-v%& is used.
3653
3654 .vitem &%-dd%&<&'debug&~options'&>
3655 .oindex "&%-dd%&"
3656 This option behaves exactly like &%-d%& except when used on a command that
3657 starts a daemon process. In that case, debugging is turned off for the
3658 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3659 behaviour of the daemon without creating as much output as full debugging does.
3660
3661 .vitem &%-dropcr%&
3662 .oindex "&%-dropcr%&"
3663 This is an obsolete option that is now a no-op. It used to affect the way Exim
3664 handled CR and LF characters in incoming messages. What happens now is
3665 described in section &<<SECTlineendings>>&.
3666
3667 .vitem &%-E%&
3668 .oindex "&%-E%&"
3669 .cindex "bounce message" "generating"
3670 This option specifies that an incoming message is a locally-generated delivery
3671 failure report. It is used internally by Exim when handling delivery failures
3672 and is not intended for external use. Its only effect is to stop Exim
3673 generating certain messages to the postmaster, as otherwise message cascades
3674 could occur in some situations. As part of the same option, a message id may
3675 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3676 new message contains the id, following &"R="&, as a cross-reference.
3677
3678 .vitem &%-e%&&'x'&
3679 .oindex "&%-e%&&'x'&"
3680 There are a number of Sendmail options starting with &%-oe%& which seem to be
3681 called by various programs without the leading &%o%& in the option. For
3682 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3683 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3684
3685 .vitem &%-F%&&~<&'string'&>
3686 .oindex "&%-F%&"
3687 .cindex "sender" "name"
3688 .cindex "name" "of sender"
3689 This option sets the sender's full name for use when a locally-generated
3690 message is being accepted. In the absence of this option, the user's &'gecos'&
3691 entry from the password data is used. As users are generally permitted to alter
3692 their &'gecos'& entries, no security considerations are involved. White space
3693 between &%-F%& and the <&'string'&> is optional.
3694
3695 .vitem &%-f%&&~<&'address'&>
3696 .oindex "&%-f%&"
3697 .cindex "sender" "address"
3698 .cindex "address" "sender"
3699 .cindex "trusted users"
3700 .cindex "envelope sender"
3701 .cindex "user" "trusted"
3702 This option sets the address of the envelope sender of a locally-generated
3703 message (also known as the return path). The option can normally be used only
3704 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3705 users to use it.
3706
3707 Processes running as root or the Exim user are always trusted. Other
3708 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3709 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3710 of a local message is set to the caller's login name at the default qualify
3711 domain.
3712
3713 There is one exception to the restriction on the use of &%-f%&: an empty sender
3714 can be specified by any user, trusted or not, to create a message that can
3715 never provoke a bounce. An empty sender can be specified either as an empty
3716 string, or as a pair of angle brackets with nothing between them, as in these
3717 examples of shell commands:
3718 .code
3719 exim -f '<>' user@domain
3720 exim -f "" user@domain
3721 .endd
3722 In addition, the use of &%-f%& is not restricted when testing a filter file
3723 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3724 &%-bv%& options.
3725
3726 Allowing untrusted users to change the sender address does not of itself make
3727 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3728 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3729 though this can be overridden by setting &%no_local_from_check%&.
3730
3731 White
3732 .cindex "&""From""& line"
3733 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3734 given as two arguments or one combined argument). The sender of a
3735 locally-generated message can also be set (when permitted) by an initial
3736 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3737 if &%-f%& is also present, it overrides &"From&~"&.
3738
3739 .vitem &%-G%&
3740 .oindex "&%-G%&"
3741 .cindex "submission fixups, suppressing (command-line)"
3742 .new
3743 This option is equivalent to an ACL applying:
3744 .code
3745 control = suppress_local_fixups
3746 .endd
3747 for every message received.  Note that Sendmail will complain about such
3748 bad formatting, where Exim silently just does not fix it up.  This may change
3749 in future.
3750
3751 As this affects audit information, the caller must be a trusted user to use
3752 this option.
3753 .wen
3754
3755 .vitem &%-h%&&~<&'number'&>
3756 .oindex "&%-h%&"
3757 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3758 This option is accepted for compatibility with Sendmail, but has no effect. (In
3759 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3760 headers.)
3761
3762 .vitem &%-i%&
3763 .oindex "&%-i%&"
3764 .cindex "Solaris" "&'mail'& command"
3765 .cindex "dot" "in incoming non-SMTP message"
3766 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3767 line by itself should not terminate an incoming, non-SMTP message. I can find
3768 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3769 command in Solaris 2.4 uses it. See also &%-ti%&.
3770
3771 .new
3772 .vitem &%-L%&&~<&'tag'&>
3773 .oindex "&%-L%&"
3774 .cindex "syslog" "process name; set with flag"
3775 This option is equivalent to setting &%syslog_processname%& in the config
3776 file and setting &%log_file_path%& to &`syslog`&.
3777 Its use is restricted to administrators.  The configuration file has to be
3778 read and parsed, to determine access rights, before this is set and takes
3779 effect, so early configuration file errors will not honour this flag.
3780
3781 The tag should not be longer than 32 characters.
3782 .wen
3783
3784 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3785 .oindex "&%-M%&"
3786 .cindex "forcing delivery"
3787 .cindex "delivery" "forcing attempt"
3788 .cindex "frozen messages" "forcing delivery"
3789 This option requests Exim to run a delivery attempt on each message in turn. If
3790 any of the messages are frozen, they are automatically thawed before the
3791 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3792 and &%hold_domains%& are ignored.
3793
3794 Retry
3795 .cindex "hints database" "overriding retry hints"
3796 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3797 the normal retry time has not yet been reached. This option requires the caller
3798 to be an admin user. However, there is an option called &%prod_requires_admin%&
3799 which can be set false to relax this restriction (and also the same requirement
3800 for the &%-q%&, &%-R%&, and &%-S%& options).
3801
3802 The deliveries happen synchronously, that is, the original Exim process does
3803 not terminate until all the delivery attempts have finished. No output is
3804 produced unless there is a serious error. If you want to see what is happening,
3805 use the &%-v%& option as well, or inspect Exim's main log.
3806
3807 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3808 .oindex "&%-Mar%&"
3809 .cindex "message" "adding recipients"
3810 .cindex "recipient" "adding"
3811 This option requests Exim to add the addresses to the list of recipients of the
3812 message (&"ar"& for &"add recipients"&). The first argument must be a message
3813 id, and the remaining ones must be email addresses. However, if the message is
3814 active (in the middle of a delivery attempt), it is not altered. This option
3815 can be used only by an admin user.
3816
3817 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3818         &~<&'message&~id'&>"
3819 .oindex "&%-MC%&"
3820 .cindex "SMTP" "passed connection"
3821 .cindex "SMTP" "multiple deliveries"
3822 .cindex "multiple SMTP deliveries"
3823 This option is not intended for use by external callers. It is used internally
3824 by Exim to invoke another instance of itself to deliver a waiting message using
3825 an existing SMTP connection, which is passed as the standard input. Details are
3826 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3827 must be root or the Exim user in order to use it.
3828
3829 .vitem &%-MCA%&
3830 .oindex "&%-MCA%&"
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 the
3833 connection to the remote host has been authenticated.
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 .new
4023 .vitem &%-n%&
4024 .oindex "&%-n%&"
4025 This option is interpreted by Sendmail to mean &"no aliasing"&.
4026 For normal modes of operation, it is ignored by Exim.
4027 When combined with &%-bP%& it suppresses the name of an option from being output.
4028 .wen
4029
4030 .vitem &%-O%&&~<&'data'&>
4031 .oindex "&%-O%&"
4032 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4033 Exim.
4034
4035 .vitem &%-oA%&&~<&'file&~name'&>
4036 .oindex "&%-oA%&"
4037 .cindex "Sendmail compatibility" "&%-oA%& option"
4038 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4039 alternative alias file name. Exim handles &%-bi%& differently; see the
4040 description above.
4041
4042 .vitem &%-oB%&&~<&'n'&>
4043 .oindex "&%-oB%&"
4044 .cindex "SMTP" "passed connection"
4045 .cindex "SMTP" "multiple deliveries"
4046 .cindex "multiple SMTP deliveries"
4047 This is a debugging option which limits the maximum number of messages that can
4048 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4049 transport. If <&'n'&> is omitted, the limit is set to 1.
4050
4051 .vitem &%-odb%&
4052 .oindex "&%-odb%&"
4053 .cindex "background delivery"
4054 .cindex "delivery" "in the background"
4055 This option applies to all modes in which Exim accepts incoming messages,
4056 including the listening daemon. It requests &"background"& delivery of such
4057 messages, which means that the accepting process automatically starts a
4058 delivery process for each message received, but does not wait for the delivery
4059 processes to finish.
4060
4061 When all the messages have been received, the reception process exits,
4062 leaving the delivery processes to finish in their own time. The standard output
4063 and error streams are closed at the start of each delivery process.
4064 This is the default action if none of the &%-od%& options are present.
4065
4066 If one of the queueing options in the configuration file
4067 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4068 overrides it if &%queue_only_override%& is set true, which is the default
4069 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4070
4071 .vitem &%-odf%&
4072 .oindex "&%-odf%&"
4073 .cindex "foreground delivery"
4074 .cindex "delivery" "in the foreground"
4075 This option requests &"foreground"& (synchronous) delivery when Exim has
4076 accepted a locally-generated message. (For the daemon it is exactly the same as
4077 &%-odb%&.) A delivery process is automatically started to deliver the message,
4078 and Exim waits for it to complete before proceeding.
4079
4080 The original Exim reception process does not finish until the delivery
4081 process for the final message has ended. The standard error stream is left open
4082 during deliveries.
4083
4084 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4085 false and one of the queueing options in the configuration file is in effect.
4086
4087 If there is a temporary delivery error during foreground delivery, the
4088 message is left on the queue for later delivery, and the original reception
4089 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4090 restricted configuration that never queues messages.
4091
4092
4093 .vitem &%-odi%&
4094 .oindex "&%-odi%&"
4095 This option is synonymous with &%-odf%&. It is provided for compatibility with
4096 Sendmail.
4097
4098 .vitem &%-odq%&
4099 .oindex "&%-odq%&"
4100 .cindex "non-immediate delivery"
4101 .cindex "delivery" "suppressing immediate"
4102 .cindex "queueing incoming messages"
4103 This option applies to all modes in which Exim accepts incoming messages,
4104 including the listening daemon. It specifies that the accepting process should
4105 not automatically start a delivery process for each message received. Messages
4106 are placed on the queue, and remain there until a subsequent queue runner
4107 process encounters them. There are several configuration options (such as
4108 &%queue_only%&) that can be used to queue incoming messages under certain
4109 conditions. This option overrides all of them and also &%-odqs%&. It always
4110 forces queueing.
4111
4112 .vitem &%-odqs%&
4113 .oindex "&%-odqs%&"
4114 .cindex "SMTP" "delaying delivery"
4115 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4116 However, like &%-odb%& and &%-odi%&, this option has no effect if
4117 &%queue_only_override%& is false and one of the queueing options in the
4118 configuration file is in effect.
4119
4120 When &%-odqs%& does operate, a delivery process is started for each incoming
4121 message, in the background by default, but in the foreground if &%-odi%& is
4122 also present. The recipient addresses are routed, and local deliveries are done
4123 in the normal way. However, if any SMTP deliveries are required, they are not
4124 done at this time, so the message remains on the queue until a subsequent queue
4125 runner process encounters it. Because routing was done, Exim knows which
4126 messages are waiting for which hosts, and so a number of messages for the same
4127 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4128 configuration option has the same effect for specific domains. See also the
4129 &%-qq%& option.
4130
4131 .vitem &%-oee%&
4132 .oindex "&%-oee%&"
4133 .cindex "error" "reporting"
4134 If an error is detected while a non-SMTP message is being received (for
4135 example, a malformed address), the error is reported to the sender in a mail
4136 message.
4137
4138 .cindex "return code" "for &%-oee%&"
4139 Provided
4140 this error message is successfully sent, the Exim receiving process
4141 exits with a return code of zero. If not, the return code is 2 if the problem
4142 is that the original message has no recipients, or 1 for any other error.
4143 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4144
4145 .vitem &%-oem%&
4146 .oindex "&%-oem%&"
4147 .cindex "error" "reporting"
4148 .cindex "return code" "for &%-oem%&"
4149 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4150 return code, whether or not the error message was successfully sent.
4151 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4152
4153 .vitem &%-oep%&
4154 .oindex "&%-oep%&"
4155 .cindex "error" "reporting"
4156 If an error is detected while a non-SMTP message is being received, the
4157 error is reported by writing a message to the standard error file (stderr).
4158 .cindex "return code" "for &%-oep%&"
4159 The return code is 1 for all errors.
4160
4161 .vitem &%-oeq%&
4162 .oindex "&%-oeq%&"
4163 .cindex "error" "reporting"
4164 This option is supported for compatibility with Sendmail, but has the same
4165 effect as &%-oep%&.
4166
4167 .vitem &%-oew%&
4168 .oindex "&%-oew%&"
4169 .cindex "error" "reporting"
4170 This option is supported for compatibility with Sendmail, but has the same
4171 effect as &%-oem%&.
4172
4173 .vitem &%-oi%&
4174 .oindex "&%-oi%&"
4175 .cindex "dot" "in incoming non-SMTP message"
4176 This option, which has the same effect as &%-i%&, specifies that a dot on a
4177 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4178 single dot does terminate, though Exim does no special processing for other
4179 lines that start with a dot. This option is set by default if Exim is called as
4180 &'rmail'&. See also &%-ti%&.
4181
4182 .vitem &%-oitrue%&
4183 .oindex "&%-oitrue%&"
4184 This option is treated as synonymous with &%-oi%&.
4185
4186 .vitem &%-oMa%&&~<&'host&~address'&>
4187 .oindex "&%-oMa%&"
4188 .cindex "sender" "host address, specifying for local message"
4189 A number of options starting with &%-oM%& can be used to set values associated
4190 with remote hosts on locally-submitted messages (that is, messages not received
4191 over TCP/IP). These options can be used by any caller in conjunction with the
4192 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4193 other circumstances, they are ignored unless the caller is trusted.
4194
4195 The &%-oMa%& option sets the sender host address. This may include a port
4196 number at the end, after a full stop (period). For example:
4197 .code
4198 exim -bs -oMa 10.9.8.7.1234
4199 .endd
4200 An alternative syntax is to enclose the IP address in square brackets,
4201 followed by a colon and the port number:
4202 .code
4203 exim -bs -oMa [10.9.8.7]:1234
4204 .endd
4205 The IP address is placed in the &$sender_host_address$& variable, and the
4206 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4207 are present on the command line, the sender host IP address is taken from
4208 whichever one is last.
4209
4210 .vitem &%-oMaa%&&~<&'name'&>
4211 .oindex "&%-oMaa%&"
4212 .cindex "authentication" "name, specifying for local message"
4213 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4214 option sets the value of &$sender_host_authenticated$& (the authenticator
4215 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4216 This option can be used with &%-bh%& and &%-bs%& to set up an
4217 authenticated SMTP session without actually using the SMTP AUTH command.
4218
4219 .vitem &%-oMai%&&~<&'string'&>
4220 .oindex "&%-oMai%&"
4221 .cindex "authentication" "id, specifying for local message"
4222 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4223 option sets the value of &$authenticated_id$& (the id that was authenticated).
4224 This overrides the default value (the caller's login id, except with &%-bh%&,
4225 where there is no default) for messages from local sources. See chapter
4226 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4227
4228 .vitem &%-oMas%&&~<&'address'&>
4229 .oindex "&%-oMas%&"
4230 .cindex "authentication" "sender, specifying for local message"
4231 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4232 option sets the authenticated sender value in &$authenticated_sender$&. It
4233 overrides the sender address that is created from the caller's login id for
4234 messages from local sources, except when &%-bh%& is used, when there is no
4235 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4236 specified on a MAIL command overrides this value. See chapter
4237 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4238
4239 .vitem &%-oMi%&&~<&'interface&~address'&>
4240 .oindex "&%-oMi%&"
4241 .cindex "interface" "address, specifying for local message"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4243 option sets the IP interface address value. A port number may be included,
4244 using the same syntax as for &%-oMa%&. The interface address is placed in
4245 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4246
4247 .vitem &%-oMr%&&~<&'protocol&~name'&>
4248 .oindex "&%-oMr%&"
4249 .cindex "protocol, specifying for local message"
4250 .vindex "&$received_protocol$&"
4251 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4252 option sets the received protocol value that is stored in
4253 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4254 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4255 SMTP protocol names (see the description of &$received_protocol$& in section
4256 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4257 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4258 be set by &%-oMr%&.
4259
4260 .vitem &%-oMs%&&~<&'host&~name'&>
4261 .oindex "&%-oMs%&"
4262 .cindex "sender" "host name, specifying for local message"
4263 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4264 option sets the sender host name in &$sender_host_name$&. When this option is
4265 present, Exim does not attempt to look up a host name from an IP address; it
4266 uses the name it is given.
4267
4268 .vitem &%-oMt%&&~<&'ident&~string'&>
4269 .oindex "&%-oMt%&"
4270 .cindex "sender" "ident string, specifying for local message"
4271 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4272 option sets the sender ident value in &$sender_ident$&. The default setting for
4273 local callers is the login id of the calling process, except when &%-bh%& is
4274 used, when there is no default.
4275
4276 .vitem &%-om%&
4277 .oindex "&%-om%&"
4278 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4279 In Sendmail, this option means &"me too"&, indicating that the sender of a
4280 message should receive a copy of the message if the sender appears in an alias
4281 expansion. Exim always does this, so the option does nothing.
4282
4283 .vitem &%-oo%&
4284 .oindex "&%-oo%&"
4285 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4286 This option is ignored. In Sendmail it specifies &"old style headers"&,
4287 whatever that means.
4288
4289 .vitem &%-oP%&&~<&'path'&>
4290 .oindex "&%-oP%&"
4291 .cindex "pid (process id)" "of daemon"
4292 .cindex "daemon" "process id (pid)"
4293 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4294 value. The option specifies the file to which the process id of the daemon is
4295 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4296 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4297 because in those cases, the normal pid file is not used.
4298
4299 .vitem &%-or%&&~<&'time'&>
4300 .oindex "&%-or%&"
4301 .cindex "timeout" "for non-SMTP input"
4302 This option sets a timeout value for incoming non-SMTP messages. If it is not
4303 set, Exim will wait forever for the standard input. The value can also be set
4304 by the &%receive_timeout%& option. The format used for specifying times is
4305 described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-os%&&~<&'time'&>
4308 .oindex "&%-os%&"
4309 .cindex "timeout" "for SMTP input"
4310 .cindex "SMTP" "input timeout"
4311 This option sets a timeout value for incoming SMTP messages. The timeout
4312 applies to each SMTP command and block of data. The value can also be set by
4313 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4314 for specifying times is described in section &<<SECTtimeformat>>&.
4315
4316 .vitem &%-ov%&
4317 .oindex "&%-ov%&"
4318 This option has exactly the same effect as &%-v%&.
4319
4320 .vitem &%-oX%&&~<&'number&~or&~string'&>
4321 .oindex "&%-oX%&"
4322 .cindex "TCP/IP" "setting listening ports"
4323 .cindex "TCP/IP" "setting listening interfaces"
4324 .cindex "port" "receiving TCP/IP"
4325 This option is relevant only when the &%-bd%& (start listening daemon) option
4326 is also given. It controls which ports and interfaces the daemon uses. Details
4327 of the syntax, and how it interacts with configuration file options, are given
4328 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4329 file is written unless &%-oP%& is also present to specify a pid file name.
4330
4331 .vitem &%-pd%&
4332 .oindex "&%-pd%&"
4333 .cindex "Perl" "starting the interpreter"
4334 This option applies when an embedded Perl interpreter is linked with Exim (see
4335 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4336 option, forcing the starting of the interpreter to be delayed until it is
4337 needed.
4338
4339 .vitem &%-ps%&
4340 .oindex "&%-ps%&"
4341 .cindex "Perl" "starting the interpreter"
4342 This option applies when an embedded Perl interpreter is linked with Exim (see
4343 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4344 option, forcing the starting of the interpreter to occur as soon as Exim is
4345 started.
4346
4347 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4348 .oindex "&%-p%&"
4349 For compatibility with Sendmail, this option is equivalent to
4350 .display
4351 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4352 .endd
4353 It sets the incoming protocol and host name (for trusted callers). The
4354 host name and its colon can be omitted when only the protocol is to be set.
4355 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4356 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4357 or &`s`& using this option (but that does not seem a real limitation).
4358
4359 .vitem &%-q%&
4360 .oindex "&%-q%&"
4361 .cindex "queue runner" "starting manually"
4362 This option is normally restricted to admin users. However, there is a
4363 configuration option called &%prod_requires_admin%& which can be set false to
4364 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4365 and &%-S%& options).
4366
4367 .cindex "queue runner" "description of operation"
4368 The &%-q%& option starts one queue runner process. This scans the queue of
4369 waiting messages, and runs a delivery process for each one in turn. It waits
4370 for each delivery process to finish before starting the next one. A delivery
4371 process may not actually do any deliveries if the retry times for the addresses
4372 have not been reached. Use &%-qf%& (see below) if you want to override this.
4373
4374 If
4375 .cindex "SMTP" "passed connection"
4376 .cindex "SMTP" "multiple deliveries"
4377 .cindex "multiple SMTP deliveries"
4378 the delivery process spawns other processes to deliver other messages down
4379 passed SMTP connections, the queue runner waits for these to finish before
4380 proceeding.
4381
4382 When all the queued messages have been considered, the original queue runner
4383 process terminates. In other words, a single pass is made over the waiting
4384 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4385 this to be repeated periodically.
4386
4387 Exim processes the waiting messages in an unpredictable order. It isn't very
4388 random, but it is likely to be different each time, which is all that matters.
4389 If one particular message screws up a remote MTA, other messages to the same
4390 MTA have a chance of getting through if they get tried first.
4391
4392 It is possible to cause the messages to be processed in lexical message id
4393 order, which is essentially the order in which they arrived, by setting the
4394 &%queue_run_in_order%& option, but this is not recommended for normal use.
4395
4396 .vitem &%-q%&<&'qflags'&>
4397 The &%-q%& option may be followed by one or more flag letters that change its
4398 behaviour. They are all optional, but if more than one is present, they must
4399 appear in the correct order. Each flag is described in a separate item below.
4400
4401 .vitem &%-qq...%&
4402 .oindex "&%-qq%&"
4403 .cindex "queue" "double scanning"
4404 .cindex "queue" "routing"
4405 .cindex "routing" "whole queue before delivery"
4406 An option starting with &%-qq%& requests a two-stage queue run. In the first
4407 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4408 every domain. Addresses are routed, local deliveries happen, but no remote
4409 transports are run.
4410
4411 .cindex "hints database" "remembering routing"
4412 The hints database that remembers which messages are waiting for specific hosts
4413 is updated, as if delivery to those hosts had been deferred. After this is
4414 complete, a second, normal queue scan happens, with routing and delivery taking
4415 place as normal. Messages that are routed to the same host should mostly be
4416 delivered down a single SMTP
4417 .cindex "SMTP" "passed connection"
4418 .cindex "SMTP" "multiple deliveries"
4419 .cindex "multiple SMTP deliveries"
4420 connection because of the hints that were set up during the first queue scan.
4421 This option may be useful for hosts that are connected to the Internet
4422 intermittently.
4423
4424 .vitem &%-q[q]i...%&
4425 .oindex "&%-qi%&"
4426 .cindex "queue" "initial delivery"
4427 If the &'i'& flag is present, the queue runner runs delivery processes only for
4428 those messages that haven't previously been tried. (&'i'& stands for &"initial
4429 delivery"&.) This can be helpful if you are putting messages on the queue using
4430 &%-odq%& and want a queue runner just to process the new messages.
4431
4432 .vitem &%-q[q][i]f...%&
4433 .oindex "&%-qf%&"
4434 .cindex "queue" "forcing delivery"
4435 .cindex "delivery" "forcing in queue run"
4436 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4437 message, whereas without &'f'& only those non-frozen addresses that have passed
4438 their retry times are tried.
4439
4440 .vitem &%-q[q][i]ff...%&
4441 .oindex "&%-qff%&"
4442 .cindex "frozen messages" "forcing delivery"
4443 If &'ff'& is present, a delivery attempt is forced for every message, whether
4444 frozen or not.
4445
4446 .vitem &%-q[q][i][f[f]]l%&
4447 .oindex "&%-ql%&"
4448 .cindex "queue" "local deliveries only"
4449 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4450 be done. If a message requires any remote deliveries, it remains on the queue
4451 for later delivery.
4452
4453 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4454 .cindex "queue" "delivering specific messages"
4455 When scanning the queue, Exim can be made to skip over messages whose ids are
4456 lexically less than a given value by following the &%-q%& option with a
4457 starting message id. For example:
4458 .code
4459 exim -q 0t5C6f-0000c8-00
4460 .endd
4461 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4462 second message id is given, messages whose ids are lexically greater than it
4463 are also skipped. If the same id is given twice, for example,
4464 .code
4465 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4466 .endd
4467 just one delivery process is started, for that message. This differs from
4468 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4469 that it counts as a delivery from a queue run. Note that the selection
4470 mechanism does not affect the order in which the messages are scanned. There
4471 are also other ways of selecting specific sets of messages for delivery in a
4472 queue run &-- see &%-R%& and &%-S%&.
4473
4474 .vitem &%-q%&<&'qflags'&><&'time'&>
4475 .cindex "queue runner" "starting periodically"
4476 .cindex "periodic queue running"
4477 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4478 starting a queue runner process at intervals specified by the given time value
4479 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4480 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4481 single daemon process handles both functions. A common way of starting up a
4482 combined daemon at system boot time is to use a command such as
4483 .code
4484 /usr/exim/bin/exim -bd -q30m
4485 .endd
4486 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4487 process every 30 minutes.
4488
4489 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4490 pid file is written unless one is explicitly requested by the &%-oP%& option.
4491
4492 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-qR%&"
4494 This option is synonymous with &%-R%&. It is provided for Sendmail
4495 compatibility.
4496
4497 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4498 .oindex "&%-qS%&"
4499 This option is synonymous with &%-S%&.
4500
4501 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4502 .oindex "&%-R%&"
4503 .cindex "queue runner" "for specific recipients"
4504 .cindex "delivery" "to given domain"
4505 .cindex "domain" "delivery to"
4506 The <&'rsflags'&> may be empty, in which case the white space before the string
4507 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4508 which are the possible values for <&'rsflags'&>. White space is required if
4509 <&'rsflags'&> is not empty.
4510
4511 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4512 perform a single queue run, except that, when scanning the messages on the
4513 queue, Exim processes only those that have at least one undelivered recipient
4514 address containing the given string, which is checked in a case-independent
4515 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4516 regular expression; otherwise it is a literal string.
4517
4518 If you want to do periodic queue runs for messages with specific recipients,
4519 you can combine &%-R%& with &%-q%& and a time value. For example:
4520 .code
4521 exim -q25m -R @special.domain.example
4522 .endd
4523 This example does a queue run for messages with recipients in the given domain
4524 every 25 minutes. Any additional flags that are specified with &%-q%& are
4525 applied to each queue run.
4526
4527 Once a message is selected for delivery by this mechanism, all its addresses
4528 are processed. For the first selected message, Exim overrides any retry
4529 information and forces a delivery attempt for each undelivered address. This
4530 means that if delivery of any address in the first message is successful, any
4531 existing retry information is deleted, and so delivery attempts for that
4532 address in subsequently selected messages (which are processed without forcing)
4533 will run. However, if delivery of any address does not succeed, the retry
4534 information is updated, and in subsequently selected messages, the failing
4535 address will be skipped.
4536
4537 .cindex "frozen messages" "forcing delivery"
4538 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4539 all selected messages, not just the first; frozen messages are included when
4540 &'ff'& is present.
4541
4542 The &%-R%& option makes it straightforward to initiate delivery of all messages
4543 to a given domain after a host has been down for some time. When the SMTP
4544 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4545 effect is to run Exim with the &%-R%& option, but it can be configured to run
4546 an arbitrary command instead.
4547
4548 .vitem &%-r%&
4549 .oindex "&%-r%&"
4550 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4551
4552 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4553 .oindex "&%-S%&"
4554 .cindex "delivery" "from given sender"
4555 .cindex "queue runner" "for specific senders"
4556 This option acts like &%-R%& except that it checks the string against each
4557 message's sender instead of against the recipients. If &%-R%& is also set, both
4558 conditions must be met for a message to be selected. If either of the options
4559 has &'f'& or &'ff'& in its flags, the associated action is taken.
4560
4561 .vitem &%-Tqt%&&~<&'times'&>
4562 .oindex "&%-Tqt%&"
4563 This is an option that is exclusively for use by the Exim testing suite. It is not
4564 recognized when Exim is run normally. It allows for the setting up of explicit
4565 &"queue times"& so that various warning/retry features can be tested.
4566
4567 .vitem &%-t%&
4568 .oindex "&%-t%&"
4569 .cindex "recipient" "extracting from header lines"
4570 .cindex "&'Bcc:'& header line"
4571 .cindex "&'Cc:'& header line"
4572 .cindex "&'To:'& header line"
4573 When Exim is receiving a locally-generated, non-SMTP message on its standard
4574 input, the &%-t%& option causes the recipients of the message to be obtained
4575 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4576 from the command arguments. The addresses are extracted before any rewriting
4577 takes place and the &'Bcc:'& header line, if present, is then removed.
4578
4579 .cindex "Sendmail compatibility" "&%-t%& option"
4580 If the command has any arguments, they specify addresses to which the message
4581 is &'not'& to be delivered. That is, the argument addresses are removed from
4582 the recipients list obtained from the headers. This is compatible with Smail 3
4583 and in accordance with the documented behaviour of several versions of
4584 Sendmail, as described in man pages on a number of operating systems (e.g.
4585 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4586 argument addresses to those obtained from the headers, and the O'Reilly
4587 Sendmail book documents it that way. Exim can be made to add argument addresses
4588 instead of subtracting them by setting the option
4589 &%extract_addresses_remove_arguments%& false.
4590
4591 .cindex "&%Resent-%& header lines" "with &%-t%&"
4592 If there are any &%Resent-%& header lines in the message, Exim extracts
4593 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4594 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4595 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4596 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4597
4598 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4599 message is resent several times). The RFC also specifies that they should be
4600 added at the front of the message, and separated by &'Received:'& lines. It is
4601 not at all clear how &%-t%& should operate in the present of multiple sets,
4602 nor indeed exactly what constitutes a &"set"&.
4603 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4604 are often added at the end of the header, and if a message is resent more than
4605 once, it is common for the original set of &%Resent-%& headers to be renamed as
4606 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4607
4608 .vitem &%-ti%&
4609 .oindex "&%-ti%&"
4610 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4611 compatibility with Sendmail.
4612
4613 .vitem &%-tls-on-connect%&
4614 .oindex "&%-tls-on-connect%&"
4615 .cindex "TLS" "use without STARTTLS"
4616 .cindex "TLS" "automatic start"
4617 This option is available when Exim is compiled with TLS support. It forces all
4618 incoming SMTP connections to behave as if the incoming port is listed in the
4619 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4620 &<<CHAPTLS>>& for further details.
4621
4622
4623 .vitem &%-U%&
4624 .oindex "&%-U%&"
4625 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4626 Sendmail uses this option for &"initial message submission"&, and its
4627 documentation states that in future releases, it may complain about
4628 syntactically invalid messages rather than fixing them when this flag is not
4629 set. Exim ignores this option.
4630
4631 .vitem &%-v%&
4632 .oindex "&%-v%&"
4633 This option causes Exim to write information to the standard error stream,
4634 describing what it is doing. In particular, it shows the log lines for
4635 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4636 dialogue is shown. Some of the log lines shown may not actually be written to
4637 the log if the setting of &%log_selector%& discards them. Any relevant
4638 selectors are shown with each log line. If none are shown, the logging is
4639 unconditional.
4640
4641 .vitem &%-x%&
4642 .oindex "&%-x%&"
4643 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4644 National Language Support extended characters in the body of the mail item"&).
4645 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4646 this option.
4647
4648 .new
4649 .vitem &%-X%&&~<&'logfile'&>
4650 .oindex "&%-X%&"
4651 This option is interpreted by Sendmail to cause debug information to be sent
4652 to the named file.  It is ignored by Exim.
4653 .wen
4654 .endlist
4655
4656 .ecindex IIDclo1
4657 .ecindex IIDclo2
4658
4659
4660 . ////////////////////////////////////////////////////////////////////////////
4661 . Insert a stylized DocBook comment here, to identify the end of the command
4662 . line options. This is for the benefit of the Perl script that automatically
4663 . creates a man page for the options.
4664 . ////////////////////////////////////////////////////////////////////////////
4665
4666 .literal xml
4667 <!-- === End of command line options === -->
4668 .literal off
4669
4670
4671
4672
4673
4674 . ////////////////////////////////////////////////////////////////////////////
4675 . ////////////////////////////////////////////////////////////////////////////
4676
4677
4678 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4679          "The runtime configuration file"
4680
4681 .cindex "run time configuration"
4682 .cindex "configuration file" "general description"
4683 .cindex "CONFIGURE_FILE"
4684 .cindex "configuration file" "errors in"
4685 .cindex "error" "in configuration file"
4686 .cindex "return code" "for bad configuration"
4687 Exim uses a single run time configuration file that is read whenever an Exim
4688 binary is executed. Note that in normal operation, this happens frequently,
4689 because Exim is designed to operate in a distributed manner, without central
4690 control.
4691
4692 If a syntax error is detected while reading the configuration file, Exim
4693 writes a message on the standard error, and exits with a non-zero return code.
4694 The message is also written to the panic log. &*Note*&: Only simple syntax
4695 errors can be detected at this time. The values of any expanded options are
4696 not checked until the expansion happens, even when the expansion does not
4697 actually alter the string.
4698
4699 The name of the configuration file is compiled into the binary for security
4700 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4701 most configurations, this specifies a single file. However, it is permitted to
4702 give a colon-separated list of file names, in which case Exim uses the first
4703 existing file in the list.
4704
4705 .cindex "EXIM_USER"
4706 .cindex "EXIM_GROUP"
4707 .cindex "CONFIGURE_OWNER"
4708 .cindex "CONFIGURE_GROUP"
4709 .cindex "configuration file" "ownership"
4710 .cindex "ownership" "configuration file"
4711 The run time configuration file must be owned by root or by the user that is
4712 specified at compile time by the CONFIGURE_OWNER option (if set). The
4713 configuration file must not be world-writeable, or group-writeable unless its
4714 group is the root group or the one specified at compile time by the
4715 CONFIGURE_GROUP option.
4716
4717 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4718 to root, anybody who is able to edit the run time configuration file has an
4719 easy way to run commands as root. If you specify a user or group in the
4720 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4721 who are members of that group will trivially be able to obtain root privileges.
4722
4723 Up to Exim version 4.72, the run time configuration file was also permitted to
4724 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4725 since it offered a simple privilege escalation for any attacker who managed to
4726 compromise the Exim user account.
4727
4728 A default configuration file, which will work correctly in simple situations,
4729 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4730 defines just one file name, the installation process copies the default
4731 configuration to a new file of that name if it did not previously exist. If
4732 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4733 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4734 configuration.
4735
4736
4737
4738 .section "Using a different configuration file" "SECID40"
4739 .cindex "configuration file" "alternate"
4740 A one-off alternate configuration can be specified by the &%-C%& command line
4741 option, which may specify a single file or a list of files. However, when
4742 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4743 unless the argument for &%-C%& is identical to the built-in value from
4744 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4745 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4746 is useful mainly for checking the syntax of configuration files before
4747 installing them. No owner or group checks are done on a configuration file
4748 specified by &%-C%&, if root privilege has been dropped.
4749
4750 Even the Exim user is not trusted to specify an arbitrary configuration file
4751 with the &%-C%& option to be used with root privileges, unless that file is
4752 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4753 testing a configuration using &%-C%& right through message reception and
4754 delivery, even if the caller is root. The reception works, but by that time,
4755 Exim is running as the Exim user, so when it re-execs to regain privilege for
4756 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4757 can test reception and delivery using two separate commands (one to put a
4758 message on the queue, using &%-odq%&, and another to do the delivery, using
4759 &%-M%&).
4760
4761 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4762 prefix string with which any file named in a &%-C%& command line option must
4763 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4764 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4765 name can be used with &%-C%&.
4766
4767 One-off changes to a configuration can be specified by the &%-D%& command line
4768 option, which defines and overrides values for macros used inside the
4769 configuration file. However, like &%-C%&, the use of this option by a
4770 non-privileged user causes Exim to discard its root privilege.
4771 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4772 completely disabled, and its use causes an immediate error exit.
4773
4774 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4775 to declare certain macro names trusted, such that root privilege will not
4776 necessarily be discarded.
4777 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4778 considered safe and, if &%-D%& only supplies macros from this list, and the
4779 values are acceptable, then Exim will not give up root privilege if the caller
4780 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4781 transition mechanism and is expected to be removed in the future.  Acceptable
4782 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4783
4784 Some sites may wish to use the same Exim binary on different machines that
4785 share a file system, but to use different configuration files on each machine.
4786 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4787 looks for a file whose name is the configuration file name followed by a dot
4788 and the machine's node name, as obtained from the &[uname()]& function. If this
4789 file does not exist, the standard name is tried. This processing occurs for
4790 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4791
4792 In some esoteric situations different versions of Exim may be run under
4793 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4794 help with this. See the comments in &_src/EDITME_& for details.
4795
4796
4797
4798 .section "Configuration file format" "SECTconffilfor"
4799 .cindex "configuration file" "format of"
4800 .cindex "format" "configuration file"
4801 Exim's configuration file is divided into a number of different parts. General
4802 option settings must always appear at the start of the file. The other parts
4803 are all optional, and may appear in any order. Each part other than the first
4804 is introduced by the word &"begin"& followed by the name of the part. The
4805 optional parts are:
4806
4807 .ilist
4808 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4809 &<<CHAPACL>>&).
4810 .next
4811 .cindex "AUTH" "configuration"
4812 &'authenticators'&: Configuration settings for the authenticator drivers. These
4813 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4814 .next
4815 &'routers'&: Configuration settings for the router drivers. Routers process
4816 addresses and determine how the message is to be delivered (see chapters
4817 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4818 .next
4819 &'transports'&: Configuration settings for the transport drivers. Transports
4820 define mechanisms for copying messages to destinations (see chapters
4821 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4822 .next
4823 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4824 If there is no retry section, or if it is empty (that is, no retry rules are
4825 defined), Exim will not retry deliveries. In this situation, temporary errors
4826 are treated the same as permanent errors. Retry rules are discussed in chapter
4827 &<<CHAPretry>>&.
4828 .next
4829 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4830 when new addresses are generated during delivery. Rewriting is discussed in
4831 chapter &<<CHAPrewrite>>&.
4832 .next
4833 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4834 want to use this feature, you must set
4835 .code
4836 LOCAL_SCAN_HAS_OPTIONS=yes
4837 .endd
4838 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4839 facility are given in chapter &<<CHAPlocalscan>>&.
4840 .endlist
4841
4842 .cindex "configuration file" "leading white space in"
4843 .cindex "configuration file" "trailing white space in"
4844 .cindex "white space" "in configuration file"
4845 Leading and trailing white space in configuration lines is always ignored.
4846
4847 Blank lines in the file, and lines starting with a # character (ignoring
4848 leading white space) are treated as comments and are ignored. &*Note*&: A
4849 # character other than at the beginning of a line is not treated specially,
4850 and does not introduce a comment.
4851
4852 Any non-comment line can be continued by ending it with a backslash. Note that
4853 the general rule for white space means that trailing white space after the
4854 backslash and leading white space at the start of continuation
4855 lines is ignored. Comment lines beginning with # (but not empty lines) may
4856 appear in the middle of a sequence of continuation lines.
4857
4858 A convenient way to create a configuration file is to start from the
4859 default, which is supplied in &_src/configure.default_&, and add, delete, or
4860 change settings as required.
4861
4862 The ACLs, retry rules, and rewriting rules have their own syntax which is
4863 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4864 respectively. The other parts of the configuration file have some syntactic
4865 items in common, and these are described below, from section &<<SECTcos>>&
4866 onwards. Before that, the inclusion, macro, and conditional facilities are
4867 described.
4868
4869
4870
4871 .section "File inclusions in the configuration file" "SECID41"
4872 .cindex "inclusions in configuration file"
4873 .cindex "configuration file" "including other files"
4874 .cindex "&`.include`& in configuration file"
4875 .cindex "&`.include_if_exists`& in configuration file"
4876 You can include other files inside Exim's run time configuration file by
4877 using this syntax:
4878 .display
4879 &`.include`& <&'file name'&>
4880 &`.include_if_exists`& <&'file name'&>
4881 .endd
4882 on a line by itself. Double quotes round the file name are optional. If you use
4883 the first form, a configuration error occurs if the file does not exist; the
4884 second form does nothing for non-existent files. In all cases, an absolute file
4885 name is required.
4886
4887 Includes may be nested to any depth, but remember that Exim reads its
4888 configuration file often, so it is a good idea to keep them to a minimum.
4889 If you change the contents of an included file, you must HUP the daemon,
4890 because an included file is read only when the configuration itself is read.
4891
4892 The processing of inclusions happens early, at a physical line level, so, like
4893 comment lines, an inclusion can be used in the middle of an option setting,
4894 for example:
4895 .code
4896 hosts_lookup = a.b.c \
4897                .include /some/file
4898 .endd
4899 Include processing happens after macro processing (see below). Its effect is to
4900 process the lines of the included file as if they occurred inline where the
4901 inclusion appears.
4902
4903
4904
4905 .section "Macros in the configuration file" "SECTmacrodefs"
4906 .cindex "macro" "description of"
4907 .cindex "configuration file" "macros"
4908 If a line in the main part of the configuration (that is, before the first
4909 &"begin"& line) begins with an upper case letter, it is taken as a macro
4910 definition, and must be of the form
4911 .display
4912 <&'name'&> = <&'rest of line'&>
4913 .endd
4914 The name must consist of letters, digits, and underscores, and need not all be
4915 in upper case, though that is recommended. The rest of the line, including any
4916 continuations, is the replacement text, and has leading and trailing white
4917 space removed. Quotes are not removed. The replacement text can never end with
4918 a backslash character, but this doesn't seem to be a serious limitation.
4919
4920 Macros may also be defined between router, transport, authenticator, or ACL
4921 definitions. They may not, however, be defined within an individual driver or
4922 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4923
4924 .section "Macro substitution" "SECID42"
4925 Once a macro is defined, all subsequent lines in the file (and any included
4926 files) are scanned for the macro name; if there are several macros, the line is
4927 scanned for each in turn, in the order in which the macros are defined. The
4928 replacement text is not re-scanned for the current macro, though it is scanned
4929 for subsequently defined macros. For this reason, a macro name may not contain
4930 the name of a previously defined macro as a substring. You could, for example,
4931 define
4932 .display
4933 &`ABCD_XYZ = `&<&'something'&>
4934 &`ABCD = `&<&'something else'&>
4935 .endd
4936 but putting the definitions in the opposite order would provoke a configuration
4937 error. Macro expansion is applied to individual physical lines from the file,
4938 before checking for line continuation or file inclusion (see above). If a line
4939 consists solely of a macro name, and the expansion of the macro is empty, the
4940 line is ignored. A macro at the start of a line may turn the line into a
4941 comment line or a &`.include`& line.
4942
4943
4944 .section "Redefining macros" "SECID43"
4945 Once defined, the value of a macro can be redefined later in the configuration
4946 (or in an included file). Redefinition is specified by using &'=='& instead of
4947 &'='&. For example:
4948 .code
4949 MAC =  initial value
4950 ...
4951 MAC == updated value
4952 .endd
4953 Redefinition does not alter the order in which the macros are applied to the
4954 subsequent lines of the configuration file. It is still the same order in which
4955 the macros were originally defined. All that changes is the macro's value.
4956 Redefinition makes it possible to accumulate values. For example:
4957 .code
4958 MAC =  initial value
4959 ...
4960 MAC == MAC and something added
4961 .endd
4962 This can be helpful in situations where the configuration file is built
4963 from a number of other files.
4964
4965 .section "Overriding macro values" "SECID44"
4966 The values set for macros in the configuration file can be overridden by the
4967 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4968 used, unless called by root or the Exim user. A definition on the command line
4969 using the &%-D%& option causes all definitions and redefinitions within the
4970 file to be ignored.
4971
4972
4973
4974 .section "Example of macro usage" "SECID45"
4975 As an example of macro usage, consider a configuration where aliases are looked
4976 up in a MySQL database. It helps to keep the file less cluttered if long
4977 strings such as SQL statements are defined separately as macros, for example:
4978 .code
4979 ALIAS_QUERY = select mailbox from user where \
4980               login='${quote_mysql:$local_part}';
4981 .endd
4982 This can then be used in a &(redirect)& router setting like this:
4983 .code
4984 data = ${lookup mysql{ALIAS_QUERY}}
4985 .endd
4986 In earlier versions of Exim macros were sometimes used for domain, host, or
4987 address lists. In Exim 4 these are handled better by named lists &-- see
4988 section &<<SECTnamedlists>>&.
4989
4990
4991 .section "Conditional skips in the configuration file" "SECID46"
4992 .cindex "configuration file" "conditional skips"
4993 .cindex "&`.ifdef`&"
4994 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4995 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4996 portions of the configuration file. The processing happens whenever the file is
4997 read (that is, when an Exim binary starts to run).
4998
4999 The implementation is very simple. Instances of the first four directives must
5000 be followed by text that includes the names of one or macros. The condition
5001 that is tested is whether or not any macro substitution has taken place in the
5002 line. Thus:
5003 .code
5004 .ifdef AAA
5005 message_size_limit = 50M
5006 .else
5007 message_size_limit = 100M
5008 .endif
5009 .endd
5010 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5011 otherwise. If there is more than one macro named on the line, the condition
5012 is true if any of them are defined. That is, it is an &"or"& condition. To
5013 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5014
5015 Although you can use a macro expansion to generate one of these directives,
5016 it is not very useful, because the condition &"there was a macro substitution
5017 in this line"& will always be true.
5018
5019 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5020 to clarify complicated nestings.
5021
5022
5023
5024 .section "Common option syntax" "SECTcos"
5025 .cindex "common option syntax"
5026 .cindex "syntax of common options"
5027 .cindex "configuration file" "common option syntax"
5028 For the main set of options, driver options, and &[local_scan()]& options,
5029 each setting is on a line by itself, and starts with a name consisting of
5030 lower-case letters and underscores. Many options require a data value, and in
5031 these cases the name must be followed by an equals sign (with optional white
5032 space) and then the value. For example:
5033 .code
5034 qualify_domain = mydomain.example.com
5035 .endd
5036 .cindex "hiding configuration option values"
5037 .cindex "configuration options" "hiding value of"
5038 .cindex "options" "hiding value of"
5039 Some option settings may contain sensitive data, for example, passwords for
5040 accessing databases. To stop non-admin users from using the &%-bP%& command
5041 line option to read these values, you can precede the option settings with the
5042 word &"hide"&. For example:
5043 .code
5044 hide mysql_servers = localhost/users/admin/secret-password
5045 .endd
5046 For non-admin users, such options are displayed like this:
5047 .code
5048 mysql_servers = <value not displayable>
5049 .endd
5050 If &"hide"& is used on a driver option, it hides the value of that option on
5051 all instances of the same driver.
5052
5053 The following sections describe the syntax used for the different data types
5054 that are found in option settings.
5055
5056
5057 .section "Boolean options" "SECID47"
5058 .cindex "format" "boolean"
5059 .cindex "boolean configuration values"
5060 .oindex "&%no_%&&'xxx'&"
5061 .oindex "&%not_%&&'xxx'&"
5062 Options whose type is given as boolean are on/off switches. There are two
5063 different ways of specifying such options: with and without a data value. If
5064 the option name is specified on its own without data, the switch is turned on;
5065 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5066 boolean options may be followed by an equals sign and one of the words
5067 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5068 the following two settings have exactly the same effect:
5069 .code
5070 queue_only
5071 queue_only = true
5072 .endd
5073 The following two lines also have the same (opposite) effect:
5074 .code
5075 no_queue_only
5076 queue_only = false
5077 .endd
5078 You can use whichever syntax you prefer.
5079
5080
5081
5082
5083 .section "Integer values" "SECID48"
5084 .cindex "integer configuration values"
5085 .cindex "format" "integer"
5086 If an option's type is given as &"integer"&, the value can be given in decimal,
5087 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5088 number is assumed. Otherwise, it is treated as an octal number unless it starts
5089 with the characters &"0x"&, in which case the remainder is interpreted as a
5090 hexadecimal number.
5091
5092 If an integer value is followed by the letter K, it is multiplied by 1024; if
5093 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5094 of integer option settings are output, values which are an exact multiple of
5095 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5096 and M. The printing style is independent of the actual input format that was
5097 used.
5098
5099
5100 .section "Octal integer values" "SECID49"
5101 .cindex "integer format"
5102 .cindex "format" "octal integer"
5103 If an option's type is given as &"octal integer"&, its value is always
5104 interpreted as an octal number, whether or not it starts with the digit zero.
5105 Such options are always output in octal.
5106
5107
5108 .section "Fixed point numbers" "SECID50"
5109 .cindex "fixed point configuration values"
5110 .cindex "format" "fixed point"
5111 If an option's type is given as &"fixed-point"&, its value must be a decimal
5112 integer, optionally followed by a decimal point and up to three further digits.
5113
5114
5115
5116 .section "Time intervals" "SECTtimeformat"
5117 .cindex "time interval" "specifying in configuration"
5118 .cindex "format" "time interval"
5119 A time interval is specified as a sequence of numbers, each followed by one of
5120 the following letters, with no intervening white space:
5121
5122 .table2 30pt
5123 .irow &%s%& seconds
5124 .irow &%m%& minutes
5125 .irow &%h%& hours
5126 .irow &%d%& days
5127 .irow &%w%& weeks
5128 .endtable
5129
5130 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5131 intervals are output in the same format. Exim does not restrict the values; it
5132 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5133
5134
5135
5136 .section "String values" "SECTstrings"
5137 .cindex "string" "format of configuration values"
5138 .cindex "format" "string"
5139 If an option's type is specified as &"string"&, the value can be specified with
5140 or without double-quotes. If it does not start with a double-quote, the value
5141 consists of the remainder of the line plus any continuation lines, starting at
5142 the first character after any leading white space, with trailing white space
5143 removed, and with no interpretation of the characters in the string. Because
5144 Exim removes comment lines (those beginning with #) at an early stage, they can
5145 appear in the middle of a multi-line string. The following two settings are
5146 therefore equivalent:
5147 .code
5148 trusted_users = uucp:mail
5149 trusted_users = uucp:\
5150                 # This comment line is ignored
5151                 mail
5152 .endd
5153 .cindex "string" "quoted"
5154 .cindex "escape characters in quoted strings"
5155 If a string does start with a double-quote, it must end with a closing
5156 double-quote, and any backslash characters other than those used for line
5157 continuation are interpreted as escape characters, as follows:
5158
5159 .table2 100pt
5160 .irow &`\\`&                     "single backslash"
5161 .irow &`\n`&                     "newline"
5162 .irow &`\r`&                     "carriage return"
5163 .irow &`\t`&                     "tab"
5164 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5165 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5166                                    character"
5167 .endtable
5168
5169 If a backslash is followed by some other character, including a double-quote
5170 character, that character replaces the pair.
5171
5172 Quoting is necessary only if you want to make use of the backslash escapes to
5173 insert special characters, or if you need to specify a value with leading or
5174 trailing spaces. These cases are rare, so quoting is almost never needed in
5175 current versions of Exim. In versions of Exim before 3.14, quoting was required
5176 in order to continue lines, so you may come across older configuration files
5177 and examples that apparently quote unnecessarily.
5178
5179
5180 .section "Expanded strings" "SECID51"
5181 .cindex "expansion" "definition of"
5182 Some strings in the configuration file are subjected to &'string expansion'&,
5183 by which means various parts of the string may be changed according to the
5184 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5185 is as just described; in particular, the handling of backslashes in quoted
5186 strings is done as part of the input process, before expansion takes place.
5187 However, backslash is also an escape character for the expander, so any
5188 backslashes that are required for that reason must be doubled if they are
5189 within a quoted configuration string.
5190
5191
5192 .section "User and group names" "SECID52"
5193 .cindex "user name" "format of"
5194 .cindex "format" "user name"
5195 .cindex "groups" "name format"
5196 .cindex "format" "group name"
5197 User and group names are specified as strings, using the syntax described
5198 above, but the strings are interpreted specially. A user or group name must
5199 either consist entirely of digits, or be a name that can be looked up using the
5200 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5201
5202
5203 .section "List construction" "SECTlistconstruct"
5204 .cindex "list" "syntax of in configuration"
5205 .cindex "format" "list item in configuration"
5206 .cindex "string" "list, definition of"
5207 The data for some configuration options is a list of items, with colon as the
5208 default separator. Many of these options are shown with type &"string list"& in
5209 the descriptions later in this document. Others are listed as &"domain list"&,
5210 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5211 are all the same; however, those other than &"string list"& are subject to
5212 particular kinds of interpretation, as described in chapter
5213 &<<CHAPdomhosaddlists>>&.
5214
5215 In all these cases, the entire list is treated as a single string as far as the
5216 input syntax is concerned. The &%trusted_users%& setting in section
5217 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5218 in a list, it must be entered as two colons. Leading and trailing white space
5219 on each item in a list is ignored. This makes it possible to include items that
5220 start with a colon, and in particular, certain forms of IPv6 address. For
5221 example, the list
5222 .code
5223 local_interfaces = 127.0.0.1 : ::::1
5224 .endd
5225 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5226
5227 &*Note*&: Although leading and trailing white space is ignored in individual
5228 list items, it is not ignored when parsing the list. The space after the first
5229 colon in the example above is necessary. If it were not there, the list would
5230 be interpreted as the two items 127.0.0.1:: and 1.
5231
5232 .section "Changing list separators" "SECID53"
5233 .cindex "list separator" "changing"
5234 .cindex "IPv6" "addresses in lists"
5235 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5236 introduced to allow the separator character to be changed. If a list begins
5237 with a left angle bracket, followed by any punctuation character, that
5238 character is used instead of colon as the list separator. For example, the list
5239 above can be rewritten to use a semicolon separator like this:
5240 .code
5241 local_interfaces = <; 127.0.0.1 ; ::1
5242 .endd
5243 This facility applies to all lists, with the exception of the list in
5244 &%log_file_path%&. It is recommended that the use of non-colon separators be
5245 confined to circumstances where they really are needed.
5246
5247 .cindex "list separator" "newline as"
5248 .cindex "newline" "as list separator"
5249 It is also possible to use newline and other control characters (those with
5250 code values less than 32, plus DEL) as separators in lists. Such separators
5251 must be provided literally at the time the list is processed. For options that
5252 are string-expanded, you can write the separator using a normal escape
5253 sequence. This will be processed by the expander before the string is
5254 interpreted as a list. For example, if a newline-separated list of domains is
5255 generated by a lookup, you can process it directly by a line such as this:
5256 .code
5257 domains = <\n ${lookup mysql{.....}}
5258 .endd
5259 This avoids having to change the list separator in such data. You are unlikely
5260 to want to use a control character as a separator in an option that is not
5261 expanded, because the value is literal text. However, it can be done by giving
5262 the value in quotes. For example:
5263 .code
5264 local_interfaces = "<\n 127.0.0.1 \n ::1"
5265 .endd
5266 Unlike printing character separators, which can be included in list items by
5267 doubling, it is not possible to include a control character as data when it is
5268 set as the separator. Two such characters in succession are interpreted as
5269 enclosing an empty list item.
5270
5271
5272
5273 .section "Empty items in lists" "SECTempitelis"
5274 .cindex "list" "empty item in"
5275 An empty item at the end of a list is always ignored. In other words, trailing
5276 separator characters are ignored. Thus, the list in
5277 .code
5278 senders = user@domain :
5279 .endd
5280 contains only a single item. If you want to include an empty string as one item
5281 in a list, it must not be the last item. For example, this list contains three
5282 items, the second of which is empty:
5283 .code
5284 senders = user1@domain : : user2@domain
5285 .endd
5286 &*Note*&: There must be white space between the two colons, as otherwise they
5287 are interpreted as representing a single colon data character (and the list
5288 would then contain just one item). If you want to specify a list that contains
5289 just one, empty item, you can do it as in this example:
5290 .code
5291 senders = :
5292 .endd
5293 In this case, the first item is empty, and the second is discarded because it
5294 is at the end of the list.
5295
5296
5297
5298
5299 .section "Format of driver configurations" "SECTfordricon"
5300 .cindex "drivers" "configuration format"
5301 There are separate parts in the configuration for defining routers, transports,
5302 and authenticators. In each part, you are defining a number of driver
5303 instances, each with its own set of options. Each driver instance is defined by
5304 a sequence of lines like this:
5305 .display
5306 <&'instance name'&>:
5307   <&'option'&>
5308   ...
5309   <&'option'&>
5310 .endd
5311 In the following example, the instance name is &(localuser)&, and it is
5312 followed by three options settings:
5313 .code
5314 localuser:
5315   driver = accept
5316   check_local_user
5317   transport = local_delivery
5318 .endd
5319 For each driver instance, you specify which Exim code module it uses &-- by the
5320 setting of the &%driver%& option &-- and (optionally) some configuration
5321 settings. For example, in the case of transports, if you want a transport to
5322 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5323 a local file you would use the &(appendfile)& driver. Each of the drivers is
5324 described in detail in its own separate chapter later in this manual.
5325
5326 You can have several routers, transports, or authenticators that are based on
5327 the same underlying driver (each must have a different instance name).
5328
5329 The order in which routers are defined is important, because addresses are
5330 passed to individual routers one by one, in order. The order in which
5331 transports are defined does not matter at all. The order in which
5332 authenticators are defined is used only when Exim, as a client, is searching
5333 them to find one that matches an authentication mechanism offered by the
5334 server.
5335
5336 .cindex "generic options"
5337 .cindex "options" "generic &-- definition of"
5338 Within a driver instance definition, there are two kinds of option: &'generic'&
5339 and &'private'&. The generic options are those that apply to all drivers of the
5340 same type (that is, all routers, all transports or all authenticators). The
5341 &%driver%& option is a generic option that must appear in every definition.
5342 .cindex "private options"
5343 The private options are special for each driver, and none need appear, because
5344 they all have default values.
5345
5346 The options may appear in any order, except that the &%driver%& option must
5347 precede any private options, since these depend on the particular driver. For
5348 this reason, it is recommended that &%driver%& always be the first option.
5349
5350 Driver instance names, which are used for reference in log entries and
5351 elsewhere, can be any sequence of letters, digits, and underscores (starting
5352 with a letter) and must be unique among drivers of the same type. A router and
5353 a transport (for example) can each have the same name, but no two router
5354 instances can have the same name. The name of a driver instance should not be
5355 confused with the name of the underlying driver module. For example, the
5356 configuration lines:
5357 .code
5358 remote_smtp:
5359   driver = smtp
5360 .endd
5361 create an instance of the &(smtp)& transport driver whose name is
5362 &(remote_smtp)&. The same driver code can be used more than once, with
5363 different instance names and different option settings each time. A second
5364 instance of the &(smtp)& transport, with different options, might be defined
5365 thus:
5366 .code
5367 special_smtp:
5368   driver = smtp
5369   port = 1234
5370   command_timeout = 10s
5371 .endd
5372 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5373 these transport instances from routers, and these names would appear in log
5374 lines.
5375
5376 Comment lines may be present in the middle of driver specifications. The full
5377 list of option settings for any particular driver instance, including all the
5378 defaulted values, can be extracted by making use of the &%-bP%& command line
5379 option.
5380
5381
5382
5383
5384
5385
5386 . ////////////////////////////////////////////////////////////////////////////
5387 . ////////////////////////////////////////////////////////////////////////////
5388
5389 .chapter "The default configuration file" "CHAPdefconfil"
5390 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5391 .cindex "default" "configuration file &""walk through""&"
5392 The default configuration file supplied with Exim as &_src/configure.default_&
5393 is sufficient for a host with simple mail requirements. As an introduction to
5394 the way Exim is configured, this chapter &"walks through"& the default
5395 configuration, giving brief explanations of the settings. Detailed descriptions
5396 of the options are given in subsequent chapters. The default configuration file
5397 itself contains extensive comments about ways you might want to modify the
5398 initial settings. However, note that there are many options that are not
5399 mentioned at all in the default configuration.
5400
5401
5402
5403 .section "Main configuration settings" "SECTdefconfmain"
5404 The main (global) configuration option settings must always come first in the
5405 file. The first thing you'll see in the file, after some initial comments, is
5406 the line
5407 .code
5408 # primary_hostname =
5409 .endd
5410 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5411 to know the official, fully qualified name of your host, and this is where you
5412 can specify it. However, in most cases you do not need to set this option. When
5413 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5414
5415 The first three non-comment configuration lines are as follows:
5416 .code
5417 domainlist local_domains    = @
5418 domainlist relay_to_domains =
5419 hostlist   relay_from_hosts = 127.0.0.1
5420 .endd
5421 These are not, in fact, option settings. They are definitions of two named
5422 domain lists and one named host list. Exim allows you to give names to lists of
5423 domains, hosts, and email addresses, in order to make it easier to manage the
5424 configuration file (see section &<<SECTnamedlists>>&).
5425
5426 The first line defines a domain list called &'local_domains'&; this is used
5427 later in the configuration to identify domains that are to be delivered
5428 on the local host.
5429
5430 .cindex "@ in a domain list"
5431 There is just one item in this list, the string &"@"&. This is a special form
5432 of entry which means &"the name of the local host"&. Thus, if the local host is
5433 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5434 be delivered locally. Because the local host's name is referenced indirectly,
5435 the same configuration file can be used on different hosts.
5436
5437 The second line defines a domain list called &'relay_to_domains'&, but the
5438 list itself is empty. Later in the configuration we will come to the part that
5439 controls mail relaying through the local host; it allows relaying to any
5440 domains in this list. By default, therefore, no relaying on the basis of a mail
5441 domain is permitted.
5442
5443 The third line defines a host list called &'relay_from_hosts'&. This list is
5444 used later in the configuration to permit relaying from any host or IP address
5445 that matches the list. The default contains just the IP address of the IPv4
5446 loopback interface, which means that processes on the local host are able to
5447 submit mail for relaying by sending it over TCP/IP to that interface. No other
5448 hosts are permitted to submit messages for relaying.
5449
5450 Just to be sure there's no misunderstanding: at this point in the configuration
5451 we aren't actually setting up any controls. We are just defining some domains
5452 and hosts that will be used in the controls that are specified later.
5453
5454 The next two configuration lines are genuine option settings:
5455 .code
5456 acl_smtp_rcpt = acl_check_rcpt
5457 acl_smtp_data = acl_check_data
5458 .endd
5459 These options specify &'Access Control Lists'& (ACLs) that are to be used
5460 during an incoming SMTP session for every recipient of a message (every RCPT
5461 command), and after the contents of the message have been received,
5462 respectively. The names of the lists are &'acl_check_rcpt'& and
5463 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5464 section of the configuration. The RCPT ACL controls which recipients are
5465 accepted for an incoming message &-- if a configuration does not provide an ACL
5466 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5467 contents of a message to be checked.
5468
5469 Two commented-out option settings are next:
5470 .code
5471 # av_scanner = clamd:/tmp/clamd
5472 # spamd_address = 127.0.0.1 783
5473 .endd
5474 These are example settings that can be used when Exim is compiled with the
5475 content-scanning extension. The first specifies the interface to the virus
5476 scanner, and the second specifies the interface to SpamAssassin. Further
5477 details are given in chapter &<<CHAPexiscan>>&.
5478
5479 Three more commented-out option settings follow:
5480 .code
5481 # tls_advertise_hosts = *
5482 # tls_certificate = /etc/ssl/exim.crt
5483 # tls_privatekey = /etc/ssl/exim.pem
5484 .endd
5485 These are example settings that can be used when Exim is compiled with
5486 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5487 first one specifies the list of clients that are allowed to use TLS when
5488 connecting to this server; in this case the wildcard means all clients. The
5489 other options specify where Exim should find its TLS certificate and private
5490 key, which together prove the server's identity to any clients that connect.
5491 More details are given in chapter &<<CHAPTLS>>&.
5492
5493 Another two commented-out option settings follow:
5494 .code
5495 # daemon_smtp_ports = 25 : 465 : 587
5496 # tls_on_connect_ports = 465
5497 .endd
5498 .cindex "port" "465 and 587"
5499 .cindex "port" "for message submission"
5500 .cindex "message" "submission, ports for"
5501 .cindex "ssmtp protocol"
5502 .cindex "smtps protocol"
5503 .cindex "SMTP" "ssmtp protocol"
5504 .cindex "SMTP" "smtps protocol"
5505 These options provide better support for roaming users who wish to use this
5506 server for message submission. They are not much use unless you have turned on
5507 TLS (as described in the previous paragraph) and authentication (about which
5508 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5509 on end-user networks, so RFC 4409 specifies that message submission should use
5510 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5511 configured to use port 587 correctly, so these settings also enable the
5512 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5513 &<<SECTsupobssmt>>&).
5514
5515 Two more commented-out options settings follow:
5516 .code
5517 # qualify_domain =
5518 # qualify_recipient =
5519 .endd
5520 The first of these specifies a domain that Exim uses when it constructs a
5521 complete email address from a local login name. This is often needed when Exim
5522 receives a message from a local process. If you do not set &%qualify_domain%&,
5523 the value of &%primary_hostname%& is used. If you set both of these options,
5524 you can have different qualification domains for sender and recipient
5525 addresses. If you set only the first one, its value is used in both cases.
5526
5527 .cindex "domain literal" "recognizing format"
5528 The following line must be uncommented if you want Exim to recognize
5529 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5530 (an IP address within square brackets) instead of a named domain.
5531 .code
5532 # allow_domain_literals
5533 .endd
5534 The RFCs still require this form, but many people think that in the modern
5535 Internet it makes little sense to permit mail to be sent to specific hosts by
5536 quoting their IP addresses. This ancient format has been used by people who
5537 try to abuse hosts by using them for unwanted relaying. However, some
5538 people believe there are circumstances (for example, messages addressed to
5539 &'postmaster'&) where domain literals are still useful.
5540
5541 The next configuration line is a kind of trigger guard:
5542 .code
5543 never_users = root
5544 .endd
5545 It specifies that no delivery must ever be run as the root user. The normal
5546 convention is to set up &'root'& as an alias for the system administrator. This
5547 setting is a guard against slips in the configuration.
5548 The list of users specified by &%never_users%& is not, however, the complete
5549 list; the build-time configuration in &_Local/Makefile_& has an option called
5550 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5551 contents of &%never_users%& are added to this list. By default
5552 FIXED_NEVER_USERS also specifies root.
5553
5554 When a remote host connects to Exim in order to send mail, the only information
5555 Exim has about the host's identity is its IP address. The next configuration
5556 line,
5557 .code
5558 host_lookup = *
5559 .endd
5560 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5561 in order to get a host name. This improves the quality of the logging
5562 information, but if you feel it is too expensive, you can remove it entirely,
5563 or restrict the lookup to hosts on &"nearby"& networks.
5564 Note that it is not always possible to find a host name from an IP address,
5565 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5566 unreachable.
5567
5568 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5569 1413 (hence their names):
5570 .code
5571 rfc1413_hosts = *
5572 rfc1413_query_timeout = 5s
5573 .endd
5574 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5575 You can limit the hosts to which these calls are made, or change the timeout
5576 that is used. If you set the timeout to zero, all ident calls are disabled.
5577 Although they are cheap and can provide useful information for tracing problem
5578 messages, some hosts and firewalls have problems with ident calls. This can
5579 result in a timeout instead of an immediate refused connection, leading to
5580 delays on starting up an incoming SMTP session.
5581
5582 When Exim receives messages over SMTP connections, it expects all addresses to
5583 be fully qualified with a domain, as required by the SMTP definition. However,
5584 if you are running a server to which simple clients submit messages, you may
5585 find that they send unqualified addresses. The two commented-out options:
5586 .code
5587 # sender_unqualified_hosts =
5588 # recipient_unqualified_hosts =
5589 .endd
5590 show how you can specify hosts that are permitted to send unqualified sender
5591 and recipient addresses, respectively.
5592
5593 The &%percent_hack_domains%& option is also commented out:
5594 .code
5595 # percent_hack_domains =
5596 .endd
5597 It provides a list of domains for which the &"percent hack"& is to operate.
5598 This is an almost obsolete form of explicit email routing. If you do not know
5599 anything about it, you can safely ignore this topic.
5600
5601 The last two settings in the main part of the default configuration are
5602 concerned with messages that have been &"frozen"& on Exim's queue. When a
5603 message is frozen, Exim no longer continues to try to deliver it. Freezing
5604 occurs when a bounce message encounters a permanent failure because the sender
5605 address of the original message that caused the bounce is invalid, so the
5606 bounce cannot be delivered. This is probably the most common case, but there
5607 are also other conditions that cause freezing, and frozen messages are not
5608 always bounce messages.
5609 .code
5610 ignore_bounce_errors_after = 2d
5611 timeout_frozen_after = 7d
5612 .endd
5613 The first of these options specifies that failing bounce messages are to be
5614 discarded after 2 days on the queue. The second specifies that any frozen
5615 message (whether a bounce message or not) is to be timed out (and discarded)
5616 after a week. In this configuration, the first setting ensures that no failing
5617 bounce message ever lasts a week.
5618
5619
5620
5621 .section "ACL configuration" "SECID54"
5622 .cindex "default" "ACLs"
5623 .cindex "&ACL;" "default configuration"
5624 In the default configuration, the ACL section follows the main configuration.
5625 It starts with the line
5626 .code
5627 begin acl
5628 .endd
5629 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5630 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5631 and &%acl_smtp_data%& above.
5632
5633 .cindex "RCPT" "ACL for"
5634 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5635 RCPT command specifies one of the message's recipients. The ACL statements
5636 are considered in order, until the recipient address is either accepted or
5637 rejected. The RCPT command is then accepted or rejected, according to the
5638 result of the ACL processing.
5639 .code
5640 acl_check_rcpt:
5641 .endd
5642 This line, consisting of a name terminated by a colon, marks the start of the
5643 ACL, and names it.
5644 .code
5645 accept  hosts = :
5646 .endd
5647 This ACL statement accepts the recipient if the sending host matches the list.
5648 But what does that strange list mean? It doesn't actually contain any host
5649 names or IP addresses. The presence of the colon puts an empty item in the
5650 list; Exim matches this only if the incoming message did not come from a remote
5651 host, because in that case, the remote hostname is empty. The colon is
5652 important. Without it, the list itself is empty, and can never match anything.
5653
5654 What this statement is doing is to accept unconditionally all recipients in
5655 messages that are submitted by SMTP from local processes using the standard
5656 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5657 manner.
5658 .code
5659 deny    message       = Restricted characters in address
5660         domains       = +local_domains
5661         local_parts   = ^[.] : ^.*[@%!/|]
5662
5663 deny    message       = Restricted characters in address
5664         domains       = !+local_domains
5665         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5666 .endd
5667 These statements are concerned with local parts that contain any of the
5668 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5669 Although these characters are entirely legal in local parts (in the case of
5670 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5671 in Internet mail addresses.
5672
5673 The first three have in the past been associated with explicitly routed
5674 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5675 option). Addresses containing these characters are regularly tried by spammers
5676 in an attempt to bypass relaying restrictions, and also by open relay testing
5677 programs. Unless you really need them it is safest to reject these characters
5678 at this early stage. This configuration is heavy-handed in rejecting these
5679 characters for all messages it accepts from remote hosts. This is a deliberate
5680 policy of being as safe as possible.
5681
5682 The first rule above is stricter, and is applied to messages that are addressed
5683 to one of the local domains handled by this host. This is implemented by the
5684 first condition, which restricts it to domains that are listed in the
5685 &'local_domains'& domain list. The &"+"& character is used to indicate a
5686 reference to a named list. In this configuration, there is just one domain in
5687 &'local_domains'&, but in general there may be many.
5688
5689 The second condition on the first statement uses two regular expressions to
5690 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5691 or &"|"&. If you have local accounts that include these characters, you will
5692 have to modify this rule.
5693
5694 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5695 allows them because they have been encountered in practice. (Consider the
5696 common convention of local parts constructed as
5697 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5698 the author of Exim, who has no second initial.) However, a local part starting
5699 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5700 file name (for example, for a mailing list). This is also true for local parts
5701 that contain slashes. A pipe symbol can also be troublesome if the local part
5702 is incorporated unthinkingly into a shell command line.
5703
5704 The second rule above applies to all other domains, and is less strict. This
5705 allows your own users to send outgoing messages to sites that use slashes
5706 and vertical bars in their local parts. It blocks local parts that begin
5707 with a dot, slash, or vertical bar, but allows these characters within the
5708 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5709 and &"!"& is blocked, as before. The motivation here is to prevent your users
5710 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5711 .code
5712 accept  local_parts   = postmaster
5713         domains       = +local_domains
5714 .endd
5715 This statement, which has two conditions, accepts an incoming address if the
5716 local part is &'postmaster'& and the domain is one of those listed in the
5717 &'local_domains'& domain list. The &"+"& character is used to indicate a
5718 reference to a named list. In this configuration, there is just one domain in
5719 &'local_domains'&, but in general there may be many.
5720
5721 The presence of this statement means that mail to postmaster is never blocked
5722 by any of the subsequent tests. This can be helpful while sorting out problems
5723 in cases where the subsequent tests are incorrectly denying access.
5724 .code
5725 require verify        = sender
5726 .endd
5727 This statement requires the sender address to be verified before any subsequent
5728 ACL statement can be used. If verification fails, the incoming recipient
5729 address is refused. Verification consists of trying to route the address, to
5730 see if a bounce message could be delivered to it. In the case of remote
5731 addresses, basic verification checks only the domain, but &'callouts'& can be
5732 used for more verification if required. Section &<<SECTaddressverification>>&
5733 discusses the details of address verification.
5734 .code
5735 accept  hosts         = +relay_from_hosts
5736         control       = submission
5737 .endd
5738 This statement accepts the address if the message is coming from one of the
5739 hosts that are defined as being allowed to relay through this host. Recipient
5740 verification is omitted here, because in many cases the clients are dumb MUAs
5741 that do not cope well with SMTP error responses. For the same reason, the
5742 second line specifies &"submission mode"& for messages that are accepted. This
5743 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5744 messages that are deficient in some way, for example, because they lack a
5745 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5746 probably add recipient verification here, and disable submission mode.
5747 .code
5748 accept  authenticated = *
5749         control       = submission
5750 .endd
5751 This statement accepts the address if the client host has authenticated itself.
5752 Submission mode is again specified, on the grounds that such messages are most
5753 likely to come from MUAs. The default configuration does not define any
5754 authenticators, though it does include some nearly complete commented-out
5755 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5756 fact authenticate until you complete the authenticator definitions.
5757 .code
5758 require message = relay not permitted
5759         domains = +local_domains : +relay_to_domains
5760 .endd
5761 This statement rejects the address if its domain is neither a local domain nor
5762 one of the domains for which this host is a relay.
5763 .code
5764 require verify = recipient
5765 .endd
5766 This statement requires the recipient address to be verified; if verification
5767 fails, the address is rejected.
5768 .code
5769 # deny    message     = rejected because $sender_host_address \
5770 #                       is in a black list at $dnslist_domain\n\
5771 #                       $dnslist_text
5772 #         dnslists    = black.list.example
5773 #
5774 # warn    dnslists    = black.list.example
5775 #         add_header  = X-Warning: $sender_host_address is in \
5776 #                       a black list at $dnslist_domain
5777 #         log_message = found in $dnslist_domain
5778 .endd
5779 These commented-out lines are examples of how you could configure Exim to check
5780 sending hosts against a DNS black list. The first statement rejects messages
5781 from blacklisted hosts, whereas the second just inserts a warning header
5782 line.
5783 .code
5784 # require verify = csa
5785 .endd
5786 This commented-out line is an example of how you could turn on client SMTP
5787 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5788 records.
5789 .code
5790 accept
5791 .endd
5792 The final statement in the first ACL unconditionally accepts any recipient
5793 address that has successfully passed all the previous tests.
5794 .code
5795 acl_check_data:
5796 .endd
5797 This line marks the start of the second ACL, and names it. Most of the contents
5798 of this ACL are commented out:
5799 .code
5800 # deny    malware   = *
5801 #         message   = This message contains a virus \
5802 #                     ($malware_name).
5803 .endd
5804 These lines are examples of how to arrange for messages to be scanned for
5805 viruses when Exim has been compiled with the content-scanning extension, and a
5806 suitable virus scanner is installed. If the message is found to contain a
5807 virus, it is rejected with the given custom error message.
5808 .code
5809 # warn    spam      = nobody
5810 #         message   = X-Spam_score: $spam_score\n\
5811 #                     X-Spam_score_int: $spam_score_int\n\
5812 #                     X-Spam_bar: $spam_bar\n\
5813 #                     X-Spam_report: $spam_report
5814 .endd
5815 These lines are an example of how to arrange for messages to be scanned by
5816 SpamAssassin when Exim has been compiled with the content-scanning extension,
5817 and SpamAssassin has been installed. The SpamAssassin check is run with
5818 &`nobody`& as its user parameter, and the results are added to the message as a
5819 series of extra header line. In this case, the message is not rejected,
5820 whatever the spam score.
5821 .code
5822 accept
5823 .endd
5824 This final line in the DATA ACL accepts the message unconditionally.
5825
5826
5827 .section "Router configuration" "SECID55"
5828 .cindex "default" "routers"
5829 .cindex "routers" "default"
5830 The router configuration comes next in the default configuration, introduced
5831 by the line
5832 .code
5833 begin routers
5834 .endd
5835 Routers are the modules in Exim that make decisions about where to send
5836 messages. An address is passed to each router in turn, until it is either
5837 accepted, or failed. This means that the order in which you define the routers
5838 matters. Each router is fully described in its own chapter later in this
5839 manual. Here we give only brief overviews.
5840 .code
5841 # domain_literal:
5842 #   driver = ipliteral
5843 #   domains = !+local_domains
5844 #   transport = remote_smtp
5845 .endd
5846 .cindex "domain literal" "default router"
5847 This router is commented out because the majority of sites do not want to
5848 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5849 you uncomment this router, you also need to uncomment the setting of
5850 &%allow_domain_literals%& in the main part of the configuration.
5851 .code
5852 dnslookup:
5853   driver = dnslookup
5854   domains = ! +local_domains
5855   transport = remote_smtp
5856   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5857   no_more
5858 .endd
5859 The first uncommented router handles addresses that do not involve any local
5860 domains. This is specified by the line
5861 .code
5862 domains = ! +local_domains
5863 .endd
5864 The &%domains%& option lists the domains to which this router applies, but the
5865 exclamation mark is a negation sign, so the router is used only for domains
5866 that are not in the domain list called &'local_domains'& (which was defined at
5867 the start of the configuration). The plus sign before &'local_domains'&
5868 indicates that it is referring to a named list. Addresses in other domains are
5869 passed on to the following routers.
5870
5871 The name of the router driver is &(dnslookup)&,
5872 and is specified by the &%driver%& option. Do not be confused by the fact that
5873 the name of this router instance is the same as the name of the driver. The
5874 instance name is arbitrary, but the name set in the &%driver%& option must be
5875 one of the driver modules that is in the Exim binary.
5876
5877 The &(dnslookup)& router routes addresses by looking up their domains in the
5878 DNS in order to obtain a list of hosts to which the address is routed. If the
5879 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5880 specified by the &%transport%& option. If the router does not find the domain
5881 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5882 the address fails and is bounced.
5883
5884 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5885 be entirely ignored. This option is present because a number of cases have been
5886 encountered where MX records in the DNS point to host names
5887 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5888 Completely ignoring these IP addresses causes Exim to fail to route the
5889 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5890 continue to try to deliver the message periodically until the address timed
5891 out.
5892 .code
5893 system_aliases:
5894   driver = redirect
5895   allow_fail
5896   allow_defer
5897   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5898 # user = exim
5899   file_transport = address_file
5900   pipe_transport = address_pipe
5901 .endd
5902 Control reaches this and subsequent routers only for addresses in the local
5903 domains. This router checks to see whether the local part is defined as an
5904 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5905 data that it looks up from that file. If no data is found for the local part,
5906 the value of the &%data%& option is empty, causing the address to be passed to
5907 the next router.
5908
5909 &_/etc/aliases_& is a conventional name for the system aliases file that is
5910 often used. That is why it is referenced by from the default configuration
5911 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5912 &_Local/Makefile_& before building Exim.
5913 .code
5914 userforward:
5915   driver = redirect
5916   check_local_user
5917 # local_part_suffix = +* : -*
5918 # local_part_suffix_optional
5919   file = $home/.forward
5920 # allow_filter
5921   no_verify
5922   no_expn
5923   check_ancestor
5924   file_transport = address_file
5925   pipe_transport = address_pipe
5926   reply_transport = address_reply
5927 .endd
5928 This is the most complicated router in the default configuration. It is another
5929 redirection router, but this time it is looking for forwarding data set up by
5930 individual users. The &%check_local_user%& setting specifies a check that the
5931 local part of the address is the login name of a local user. If it is not, the
5932 router is skipped. The two commented options that follow &%check_local_user%&,
5933 namely:
5934 .code
5935 # local_part_suffix = +* : -*
5936 # local_part_suffix_optional
5937 .endd
5938 .vindex "&$local_part_suffix$&"
5939 show how you can specify the recognition of local part suffixes. If the first
5940 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5941 by any sequence of characters, is removed from the local part and placed in the
5942 variable &$local_part_suffix$&. The second suffix option specifies that the
5943 presence of a suffix in the local part is optional. When a suffix is present,
5944 the check for a local login uses the local part with the suffix removed.
5945
5946 When a local user account is found, the file called &_.forward_& in the user's
5947 home directory is consulted. If it does not exist, or is empty, the router
5948 declines. Otherwise, the contents of &_.forward_& are interpreted as
5949 redirection data (see chapter &<<CHAPredirect>>& for more details).
5950
5951 .cindex "Sieve filter" "enabling in default router"
5952 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5953 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5954 is commented out by default), the contents of the file are interpreted as a set
5955 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5956 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5957 separate document entitled &'Exim's interfaces to mail filtering'&.
5958
5959 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5960 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5961 There are two reasons for doing this:
5962
5963 .olist
5964 Whether or not a local user has a &_.forward_& file is not really relevant when
5965 checking an address for validity; it makes sense not to waste resources doing
5966 unnecessary work.
5967 .next
5968 More importantly, when Exim is verifying addresses or handling an EXPN
5969 command during an SMTP session, it is running as the Exim user, not as root.
5970 The group is the Exim group, and no additional groups are set up.
5971 It may therefore not be possible for Exim to read users' &_.forward_& files at
5972 this time.
5973 .endlist
5974
5975 The setting of &%check_ancestor%& prevents the router from generating a new
5976 address that is the same as any previous address that was redirected. (This
5977 works round a problem concerning a bad interaction between aliasing and
5978 forwarding &-- see section &<<SECTredlocmai>>&).
5979
5980 The final three option settings specify the transports that are to be used when
5981 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5982 auto-reply, respectively. For example, if a &_.forward_& file contains
5983 .code
5984 a.nother@elsewhere.example, /home/spqr/archive
5985 .endd
5986 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5987 transport.
5988 .code
5989 localuser:
5990   driver = accept
5991   check_local_user
5992 # local_part_suffix = +* : -*
5993 # local_part_suffix_optional
5994   transport = local_delivery
5995 .endd
5996 The final router sets up delivery into local mailboxes, provided that the local
5997 part is the name of a local login, by accepting the address and assigning it to
5998 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5999 routers, so the address is bounced. The commented suffix settings fulfil the
6000 same purpose as they do for the &(userforward)& router.
6001
6002
6003 .section "Transport configuration" "SECID56"
6004 .cindex "default" "transports"
6005 .cindex "transports" "default"
6006 Transports define mechanisms for actually delivering messages. They operate
6007 only when referenced from routers, so the order in which they are defined does
6008 not matter. The transports section of the configuration starts with
6009 .code
6010 begin transports
6011 .endd
6012 One remote transport and four local transports are defined.
6013 .code
6014 remote_smtp:
6015   driver = smtp
6016 .endd
6017 This transport is used for delivering messages over SMTP connections. All its
6018 options are defaulted. The list of remote hosts comes from the router.
6019 .code
6020 local_delivery:
6021   driver = appendfile
6022   file = /var/mail/$local_part
6023   delivery_date_add
6024   envelope_to_add
6025   return_path_add
6026 # group = mail
6027 # mode = 0660
6028 .endd
6029 This &(appendfile)& transport is used for local delivery to user mailboxes in
6030 traditional BSD mailbox format. By default it runs under the uid and gid of the
6031 local user, which requires the sticky bit to be set on the &_/var/mail_&
6032 directory. Some systems use the alternative approach of running mail deliveries
6033 under a particular group instead of using the sticky bit. The commented options
6034 show how this can be done.
6035
6036 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6037 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6038 similarly-named options above.
6039 .code
6040 address_pipe:
6041   driver = pipe
6042   return_output
6043 .endd
6044 This transport is used for handling deliveries to pipes that are generated by
6045 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6046 option specifies that any output generated by the pipe is to be returned to the
6047 sender.
6048 .code
6049 address_file:
6050   driver = appendfile
6051   delivery_date_add
6052   envelope_to_add
6053   return_path_add
6054 .endd
6055 This transport is used for handling deliveries to files that are generated by
6056 redirection. The name of the file is not specified in this instance of
6057 &(appendfile)&, because it comes from the &(redirect)& router.
6058 .code
6059 address_reply:
6060   driver = autoreply
6061 .endd
6062 This transport is used for handling automatic replies generated by users'
6063 filter files.
6064
6065
6066
6067 .section "Default retry rule" "SECID57"
6068 .cindex "retry" "default rule"
6069 .cindex "default" "retry rule"
6070 The retry section of the configuration file contains rules which affect the way
6071 Exim retries deliveries that cannot be completed at the first attempt. It is
6072 introduced by the line
6073 .code
6074 begin retry
6075 .endd
6076 In the default configuration, there is just one rule, which applies to all
6077 errors:
6078 .code
6079 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6080 .endd
6081 This causes any temporarily failing address to be retried every 15 minutes for
6082 2 hours, then at intervals starting at one hour and increasing by a factor of
6083 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6084 is not delivered after 4 days of temporary failure, it is bounced.
6085
6086 If the retry section is removed from the configuration, or is empty (that is,
6087 if no retry rules are defined), Exim will not retry deliveries. This turns
6088 temporary errors into permanent errors.
6089
6090
6091 .section "Rewriting configuration" "SECID58"
6092 The rewriting section of the configuration, introduced by
6093 .code
6094 begin rewrite
6095 .endd
6096 contains rules for rewriting addresses in messages as they arrive. There are no
6097 rewriting rules in the default configuration file.
6098
6099
6100
6101 .section "Authenticators configuration" "SECTdefconfauth"
6102 .cindex "AUTH" "configuration"
6103 The authenticators section of the configuration, introduced by
6104 .code
6105 begin authenticators
6106 .endd
6107 defines mechanisms for the use of the SMTP AUTH command. The default
6108 configuration file contains two commented-out example authenticators
6109 which support plaintext username/password authentication using the
6110 standard PLAIN mechanism and the traditional but non-standard LOGIN
6111 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6112 to support most MUA software.
6113
6114 The example PLAIN authenticator looks like this:
6115 .code
6116 #PLAIN:
6117 #  driver                  = plaintext
6118 #  server_set_id           = $auth2
6119 #  server_prompts          = :
6120 #  server_condition        = Authentication is not yet configured
6121 #  server_advertise_condition = ${if def:tls_in_cipher }
6122 .endd
6123 And the example LOGIN authenticator looks like this:
6124 .code
6125 #LOGIN:
6126 #  driver                  = plaintext
6127 #  server_set_id           = $auth1
6128 #  server_prompts          = <| Username: | Password:
6129 #  server_condition        = Authentication is not yet configured
6130 #  server_advertise_condition = ${if def:tls_in_cipher }
6131 .endd
6132
6133 The &%server_set_id%& option makes Exim remember the authenticated username
6134 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6135 &%server_prompts%& option configures the &(plaintext)& authenticator so
6136 that it implements the details of the specific authentication mechanism,
6137 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6138 when Exim offers authentication to clients; in the examples, this is only
6139 when TLS or SSL has been started, so to enable the authenticators you also
6140 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6141
6142 The &%server_condition%& setting defines how to verify that the username and
6143 password are correct. In the examples it just produces an error message.
6144 To make the authenticators work, you can use a string expansion
6145 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6146
6147 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6148 usercode and password are in different positions.
6149 Chapter &<<CHAPplaintext>>& covers both.
6150
6151 .ecindex IIDconfiwal
6152
6153
6154
6155 . ////////////////////////////////////////////////////////////////////////////
6156 . ////////////////////////////////////////////////////////////////////////////
6157
6158 .chapter "Regular expressions" "CHAPregexp"
6159
6160 .cindex "regular expressions" "library"
6161 .cindex "PCRE"
6162 Exim supports the use of regular expressions in many of its options. It
6163 uses the PCRE regular expression library; this provides regular expression
6164 matching that is compatible with Perl 5. The syntax and semantics of
6165 regular expressions is discussed in many Perl reference books, and also in
6166 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6167 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6168
6169 The documentation for the syntax and semantics of the regular expressions that
6170 are supported by PCRE is included in the PCRE distribution, and no further
6171 description is included here. The PCRE functions are called from Exim using
6172 the default option settings (that is, with no PCRE options set), except that
6173 the PCRE_CASELESS option is set when the matching is required to be
6174 case-insensitive.
6175
6176 In most cases, when a regular expression is required in an Exim configuration,
6177 it has to start with a circumflex, in order to distinguish it from plain text
6178 or an &"ends with"& wildcard. In this example of a configuration setting, the
6179 second item in the colon-separated list is a regular expression.
6180 .code
6181 domains = a.b.c : ^\\d{3} : *.y.z : ...
6182 .endd
6183 The doubling of the backslash is required because of string expansion that
6184 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6185 of this issue, and a way of avoiding the need for doubling backslashes. The
6186 regular expression that is eventually used in this example contains just one
6187 backslash. The circumflex is included in the regular expression, and has the
6188 normal effect of &"anchoring"& it to the start of the string that is being
6189 matched.
6190
6191 There are, however, two cases where a circumflex is not required for the
6192 recognition of a regular expression: these are the &%match%& condition in a
6193 string expansion, and the &%matches%& condition in an Exim filter file. In
6194 these cases, the relevant string is always treated as a regular expression; if
6195 it does not start with a circumflex, the expression is not anchored, and can
6196 match anywhere in the subject string.
6197
6198 In all cases, if you want a regular expression to match at the end of a string,
6199 you must code the $ metacharacter to indicate this. For example:
6200 .code
6201 domains = ^\\d{3}\\.example
6202 .endd
6203 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6204 You need to use:
6205 .code
6206 domains = ^\\d{3}\\.example\$
6207 .endd
6208 if you want &'example'& to be the top-level domain. The backslash before the
6209 $ is needed because string expansion also interprets dollar characters.
6210
6211
6212
6213 . ////////////////////////////////////////////////////////////////////////////
6214 . ////////////////////////////////////////////////////////////////////////////
6215
6216 .chapter "File and database lookups" "CHAPfdlookup"
6217 .scindex IIDfidalo1 "file" "lookups"
6218 .scindex IIDfidalo2 "database" "lookups"
6219 .cindex "lookup" "description of"
6220 Exim can be configured to look up data in files or databases as it processes
6221 messages. Two different kinds of syntax are used:
6222
6223 .olist
6224 A string that is to be expanded may contain explicit lookup requests. These
6225 cause parts of the string to be replaced by data that is obtained from the
6226 lookup. Lookups of this type are conditional expansion items. Different results
6227 can be defined for the cases of lookup success and failure. See chapter
6228 &<<CHAPexpand>>&, where string expansions are described in detail.
6229 .next
6230 Lists of domains, hosts, and email addresses can contain lookup requests as a
6231 way of avoiding excessively long linear lists. In this case, the data that is
6232 returned by the lookup is often (but not always) discarded; whether the lookup
6233 succeeds or fails is what really counts. These kinds of list are described in
6234 chapter &<<CHAPdomhosaddlists>>&.
6235 .endlist
6236
6237 String expansions, lists, and lookups interact with each other in such a way
6238 that there is no order in which to describe any one of them that does not
6239 involve references to the others. Each of these three chapters makes more sense
6240 if you have read the other two first. If you are reading this for the first
6241 time, be aware that some of it will make a lot more sense after you have read
6242 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6243
6244 .section "Examples of different lookup syntax" "SECID60"
6245 It is easy to confuse the two different kinds of lookup, especially as the
6246 lists that may contain the second kind are always expanded before being
6247 processed as lists. Therefore, they may also contain lookups of the first kind.
6248 Be careful to distinguish between the following two examples:
6249 .code
6250 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6251 domains = lsearch;/some/file
6252 .endd
6253 The first uses a string expansion, the result of which must be a domain list.
6254 No strings have been specified for a successful or a failing lookup; the
6255 defaults in this case are the looked-up data and an empty string, respectively.
6256 The expansion takes place before the string is processed as a list, and the
6257 file that is searched could contain lines like this:
6258 .code
6259 192.168.3.4: domain1:domain2:...
6260 192.168.1.9: domain3:domain4:...
6261 .endd
6262 When the lookup succeeds, the result of the expansion is a list of domains (and
6263 possibly other types of item that are allowed in domain lists).
6264
6265 In the second example, the lookup is a single item in a domain list. It causes
6266 Exim to use a lookup to see if the domain that is being processed can be found
6267 in the file. The file could contains lines like this:
6268 .code
6269 domain1:
6270 domain2:
6271 .endd
6272 Any data that follows the keys is not relevant when checking that the domain
6273 matches the list item.
6274
6275 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6276 Consider a file containing lines like this:
6277 .code
6278 192.168.5.6: lsearch;/another/file
6279 .endd
6280 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6281 first &%domains%& setting above generates the second setting, which therefore
6282 causes a second lookup to occur.
6283
6284 The rest of this chapter describes the different lookup types that are
6285 available. Any of them can be used in any part of the configuration where a
6286 lookup is permitted.
6287
6288
6289 .section "Lookup types" "SECID61"
6290 .cindex "lookup" "types of"
6291 .cindex "single-key lookup" "definition of"
6292 Two different types of data lookup are implemented:
6293
6294 .ilist
6295 The &'single-key'& type requires the specification of a file in which to look,
6296 and a single key to search for. The key must be a non-empty string for the
6297 lookup to succeed. The lookup type determines how the file is searched.
6298 .next
6299 .cindex "query-style lookup" "definition of"
6300 The &'query-style'& type accepts a generalized database query. No particular
6301 key value is assumed by Exim for query-style lookups. You can use whichever
6302 Exim variables you need to construct the database query.
6303 .endlist
6304
6305 The code for each lookup type is in a separate source file that is included in
6306 the binary of Exim only if the corresponding compile-time option is set. The
6307 default settings in &_src/EDITME_& are:
6308 .code
6309 LOOKUP_DBM=yes
6310 LOOKUP_LSEARCH=yes
6311 .endd
6312 which means that only linear searching and DBM lookups are included by default.
6313 For some types of lookup (e.g. SQL databases), you need to install appropriate
6314 libraries and header files before building Exim.
6315
6316
6317
6318
6319 .section "Single-key lookup types" "SECTsinglekeylookups"
6320 .cindex "lookup" "single-key types"
6321 .cindex "single-key lookup" "list of types"
6322 The following single-key lookup types are implemented:
6323
6324 .ilist
6325 .cindex "cdb" "description of"
6326 .cindex "lookup" "cdb"
6327 .cindex "binary zero" "in lookup key"
6328 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6329 string without a terminating binary zero. The cdb format is designed for
6330 indexed files that are read frequently and never updated, except by total
6331 re-creation. As such, it is particularly suitable for large files containing
6332 aliases or other indexed data referenced by an MTA. Information about cdb can
6333 be found in several places:
6334 .display
6335 &url(http://www.pobox.com/~djb/cdb.html)
6336 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6337 &url(http://packages.debian.org/stable/utils/freecdb.html)
6338 .endd
6339 A cdb distribution is not needed in order to build Exim with cdb support,
6340 because the code for reading cdb files is included directly in Exim itself.
6341 However, no means of building or testing cdb files is provided with Exim, so
6342 you need to obtain a cdb distribution in order to do this.
6343 .next
6344 .cindex "DBM" "lookup type"
6345 .cindex "lookup" "dbm"
6346 .cindex "binary zero" "in lookup key"
6347 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6348 DBM file by looking up the record with the given key. A terminating binary
6349 zero is included in the key that is passed to the DBM library. See section
6350 &<<SECTdb>>& for a discussion of DBM libraries.
6351
6352 .cindex "Berkeley DB library" "file format"
6353 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6354 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6355 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6356 the DB_UNKNOWN option. This enables it to handle any of the types of database
6357 that the library supports, and can be useful for accessing DBM files created by
6358 other applications. (For earlier DB versions, DB_HASH is always used.)
6359 .next
6360 .cindex "lookup" "dbmjz"
6361 .cindex "lookup" "dbm &-- embedded NULs"
6362 .cindex "sasldb2"
6363 .cindex "dbmjz lookup type"
6364 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6365 interpreted as an Exim list; the elements of the list are joined together with
6366 ASCII NUL characters to form the lookup key.  An example usage would be to
6367 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6368 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6369 &(cram_md5)& authenticator.
6370 .next
6371 .cindex "lookup" "dbmnz"
6372 .cindex "lookup" "dbm &-- terminating zero"
6373 .cindex "binary zero" "in lookup key"
6374 .cindex "Courier"
6375 .cindex "&_/etc/userdbshadow.dat_&"
6376 .cindex "dbmnz lookup type"
6377 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6378 is not included in the key that is passed to the DBM library. You may need this
6379 if you want to look up data in files that are created by or shared with some
6380 other application that does not use terminating zeros. For example, you need to
6381 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6382 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6383 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6384 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6385 .next
6386 .cindex "lookup" "dsearch"
6387 .cindex "dsearch lookup type"
6388 &(dsearch)&: The given file must be a directory; this is searched for an entry
6389 whose name is the key by calling the &[lstat()]& function. The key may not
6390 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6391 the lookup is the name of the entry, which may be a file, directory,
6392 symbolic link, or any other kind of directory entry. An example of how this
6393 lookup can be used to support virtual domains is given in section
6394 &<<SECTvirtualdomains>>&.
6395 .next
6396 .cindex "lookup" "iplsearch"
6397 .cindex "iplsearch lookup type"
6398 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6399 terminated by a colon or white space or the end of the line. The keys in the
6400 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6401 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6402 being interpreted as a key terminator. For example:
6403 .code
6404 1.2.3.4:           data for 1.2.3.4
6405 192.168.0.0/16:    data for 192.168.0.0/16
6406 "abcd::cdab":      data for abcd::cdab
6407 "abcd:abcd::/32"   data for abcd:abcd::/32
6408 .endd
6409 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6410 file is searched linearly, using the CIDR masks where present, until a matching
6411 key is found. The first key that matches is used; there is no attempt to find a
6412 &"best"& match. Apart from the way the keys are matched, the processing for
6413 &(iplsearch)& is the same as for &(lsearch)&.
6414
6415 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6416 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6417 lookup types support only literal keys.
6418
6419 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6420 the implicit key is the host's IP address rather than its name (see section
6421 &<<SECThoslispatsikey>>&).
6422 .next
6423 .cindex "linear search"
6424 .cindex "lookup" "lsearch"
6425 .cindex "lsearch lookup type"
6426 .cindex "case sensitivity" "in lsearch lookup"
6427 &(lsearch)&: The given file is a text file that is searched linearly for a
6428 line beginning with the search key, terminated by a colon or white space or the
6429 end of the line. The search is case-insensitive; that is, upper and lower case
6430 letters are treated as the same. The first occurrence of the key that is found
6431 in the file is used.
6432
6433 White space between the key and the colon is permitted. The remainder of the
6434 line, with leading and trailing white space removed, is the data. This can be
6435 continued onto subsequent lines by starting them with any amount of white
6436 space, but only a single space character is included in the data at such a
6437 junction. If the data begins with a colon, the key must be terminated by a
6438 colon, for example:
6439 .code
6440 baduser:  :fail:
6441 .endd
6442 Empty lines and lines beginning with # are ignored, even if they occur in the
6443 middle of an item. This is the traditional textual format of alias files. Note
6444 that the keys in an &(lsearch)& file are literal strings. There is no
6445 wildcarding of any kind.
6446
6447 .cindex "lookup" "lsearch &-- colons in keys"
6448 .cindex "white space" "in lsearch key"
6449 In most &(lsearch)& files, keys are not required to contain colons or #
6450 characters, or white space. However, if you need this feature, it is available.
6451 If a key begins with a doublequote character, it is terminated only by a
6452 matching quote (or end of line), and the normal escaping rules apply to its
6453 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6454 quoted keys (exactly as for unquoted keys). There is no special handling of
6455 quotes for the data part of an &(lsearch)& line.
6456
6457 .next
6458 .cindex "NIS lookup type"
6459 .cindex "lookup" "NIS"
6460 .cindex "binary zero" "in lookup key"
6461 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6462 the given key, without a terminating binary zero. There is a variant called
6463 &(nis0)& which does include the terminating binary zero in the key. This is
6464 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6465 aliases; the full map names must be used.
6466
6467 .next
6468 .cindex "wildlsearch lookup type"
6469 .cindex "lookup" "wildlsearch"
6470 .cindex "nwildlsearch lookup type"
6471 .cindex "lookup" "nwildlsearch"
6472 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6473 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6474 the file may be wildcarded. The difference between these two lookup types is
6475 that for &(wildlsearch)&, each key in the file is string-expanded before being
6476 used, whereas for &(nwildlsearch)&, no expansion takes place.
6477
6478 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6479 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6480 file that are regular expressions can be made case-sensitive by the use of
6481 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6482
6483 . ==== As this is a nested list, any displays it contains must be indented
6484 . ==== as otherwise they are too far to the left.
6485
6486 .olist
6487 The string may begin with an asterisk to mean &"ends with"&. For example:
6488 .code
6489     *.a.b.c       data for anything.a.b.c
6490     *fish         data for anythingfish
6491 .endd
6492 .next
6493 The string may begin with a circumflex to indicate a regular expression. For
6494 example, for &(wildlsearch)&:
6495 .code
6496     ^\N\d+\.a\.b\N    data for <digits>.a.b
6497 .endd
6498 Note the use of &`\N`& to disable expansion of the contents of the regular
6499 expression. If you are using &(nwildlsearch)&, where the keys are not
6500 string-expanded, the equivalent entry is:
6501 .code
6502     ^\d+\.a\.b        data for <digits>.a.b
6503 .endd
6504 The case-insensitive flag is set at the start of compiling the regular
6505 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6506 For example, to make the entire pattern case-sensitive:
6507 .code
6508     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6509 .endd
6510
6511 If the regular expression contains white space or colon characters, you must
6512 either quote it (see &(lsearch)& above), or represent these characters in other
6513 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6514 colon. This may be easier than quoting, because if you quote, you have to
6515 escape all the backslashes inside the quotes.
6516
6517 &*Note*&: It is not possible to capture substrings in a regular expression
6518 match for later use, because the results of all lookups are cached. If a lookup
6519 is repeated, the result is taken from the cache, and no actual pattern matching
6520 takes place. The values of all the numeric variables are unset after a
6521 &((n)wildlsearch)& match.
6522
6523 .next
6524 Although I cannot see it being of much use, the general matching function that
6525 is used to implement &((n)wildlsearch)& means that the string may begin with a
6526 lookup name terminated by a semicolon, and followed by lookup data. For
6527 example:
6528 .code
6529     cdb;/some/file  data for keys that match the file
6530 .endd
6531 The data that is obtained from the nested lookup is discarded.
6532 .endlist olist
6533
6534 Keys that do not match any of these patterns are interpreted literally. The
6535 continuation rules for the data are the same as for &(lsearch)&, and keys may
6536 be followed by optional colons.
6537
6538 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6539 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6540 lookup types support only literal keys.
6541 .endlist ilist
6542
6543
6544 .section "Query-style lookup types" "SECID62"
6545 .cindex "lookup" "query-style types"
6546 .cindex "query-style lookup" "list of types"
6547 The supported query-style lookup types are listed below. Further details about
6548 many of them are given in later sections.
6549
6550 .ilist
6551 .cindex "DNS" "as a lookup type"
6552 .cindex "lookup" "DNS"
6553 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6554 are given in the supplied query. The resulting data is the contents of the
6555 records. See section &<<SECTdnsdb>>&.
6556 .next
6557 .cindex "InterBase lookup type"
6558 .cindex "lookup" "InterBase"
6559 &(ibase)&: This does a lookup in an InterBase database.
6560 .next
6561 .cindex "LDAP" "lookup type"
6562 .cindex "lookup" "LDAP"
6563 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6564 returns attributes from a single entry. There is a variant called &(ldapm)&
6565 that permits values from multiple entries to be returned. A third variant
6566 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6567 any attribute values. See section &<<SECTldap>>&.
6568 .next
6569 .cindex "MySQL" "lookup type"
6570 .cindex "lookup" "MySQL"
6571 &(mysql)&: The format of the query is an SQL statement that is passed to a
6572 MySQL database. See section &<<SECTsql>>&.
6573 .next
6574 .cindex "NIS+ lookup type"
6575 .cindex "lookup" "NIS+"
6576 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6577 the field to be returned. See section &<<SECTnisplus>>&.
6578 .next
6579 .cindex "Oracle" "lookup type"
6580 .cindex "lookup" "Oracle"
6581 &(oracle)&: The format of the query is an SQL statement that is passed to an
6582 Oracle database. See section &<<SECTsql>>&.
6583 .next
6584 .cindex "lookup" "passwd"
6585 .cindex "passwd lookup type"
6586 .cindex "&_/etc/passwd_&"
6587 &(passwd)& is a query-style lookup with queries that are just user names. The
6588 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6589 success, the result string is the same as you would get from an &(lsearch)&
6590 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6591 password value. For example:
6592 .code
6593 *:42:42:King Rat:/home/kr:/bin/bash
6594 .endd
6595 .next
6596 .cindex "PostgreSQL lookup type"
6597 .cindex "lookup" "PostgreSQL"
6598 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6599 PostgreSQL database. See section &<<SECTsql>>&.
6600
6601 .next
6602 .cindex "sqlite lookup type"
6603 .cindex "lookup" "sqlite"
6604 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6605 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6606
6607 .next
6608 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6609 not likely to be useful in normal operation.
6610 .next
6611 .cindex "whoson lookup type"
6612 .cindex "lookup" "whoson"
6613 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6614 allows a server to check whether a particular (dynamically allocated) IP
6615 address is currently allocated to a known (trusted) user and, optionally, to
6616 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6617 at one time for &"POP before SMTP"& authentication, but that approach has been
6618 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6619 &"POP before SMTP"& checking using ACL statements such as
6620 .code
6621 require condition = \
6622   ${lookup whoson {$sender_host_address}{yes}{no}}
6623 .endd
6624 The query consists of a single IP address. The value returned is the name of
6625 the authenticated user, which is stored in the variable &$value$&. However, in
6626 this example, the data in &$value$& is not used; the result of the lookup is
6627 one of the fixed strings &"yes"& or &"no"&.
6628 .endlist
6629
6630
6631
6632 .section "Temporary errors in lookups" "SECID63"
6633 .cindex "lookup" "temporary error in"
6634 Lookup functions can return temporary error codes if the lookup cannot be
6635 completed. For example, an SQL or LDAP database might be unavailable. For this
6636 reason, it is not advisable to use a lookup that might do this for critical
6637 options such as a list of local domains.
6638
6639 When a lookup cannot be completed in a router or transport, delivery
6640 of the message (to the relevant address) is deferred, as for any other
6641 temporary error. In other circumstances Exim may assume the lookup has failed,
6642 or may give up altogether.
6643
6644
6645
6646 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6647 .cindex "wildcard lookups"
6648 .cindex "lookup" "default values"
6649 .cindex "lookup" "wildcard"
6650 .cindex "lookup" "* added to type"
6651 .cindex "default" "in single-key lookups"
6652 In this context, a &"default value"& is a value specified by the administrator
6653 that is to be used if a lookup fails.
6654
6655 &*Note:*& This section applies only to single-key lookups. For query-style
6656 lookups, the facilities of the query language must be used. An attempt to
6657 specify a default for a query-style lookup provokes an error.
6658
6659 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6660 and the initial lookup fails, the key &"*"& is looked up in the file to
6661 provide a default value. See also the section on partial matching below.
6662
6663 .cindex "*@ with single-key lookup"
6664 .cindex "lookup" "*@ added to type"
6665 .cindex "alias file" "per-domain default"
6666 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6667 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6668 character, a second lookup is done with everything before the last @ replaced
6669 by *. This makes it possible to provide per-domain defaults in alias files
6670 that include the domains in the keys. If the second lookup fails (or doesn't
6671 take place because there is no @ in the key), &"*"& is looked up.
6672 For example, a &(redirect)& router might contain:
6673 .code
6674 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6675 .endd
6676 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6677 looks up these keys, in this order:
6678 .code
6679 jane@eyre.example
6680 *@eyre.example
6681 *
6682 .endd
6683 The data is taken from whichever key it finds first. &*Note*&: In an
6684 &(lsearch)& file, this does not mean the first of these keys in the file. A
6685 complete scan is done for each key, and only if it is not found at all does
6686 Exim move on to try the next key.
6687
6688
6689
6690 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6691 .cindex "partial matching"
6692 .cindex "wildcard lookups"
6693 .cindex "lookup" "partial matching"
6694 .cindex "lookup" "wildcard"
6695 .cindex "asterisk" "in search type"
6696 The normal operation of a single-key lookup is to search the file for an exact
6697 match with the given key. However, in a number of situations where domains are
6698 being looked up, it is useful to be able to do partial matching. In this case,
6699 information in the file that has a key starting with &"*."& is matched by any
6700 domain that ends with the components that follow the full stop. For example, if
6701 a key in a DBM file is
6702 .code
6703 *.dates.fict.example
6704 .endd
6705 then when partial matching is enabled this is matched by (amongst others)
6706 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6707 by &'dates.fict.example'&, if that does not appear as a separate key in the
6708 file.
6709
6710 &*Note*&: Partial matching is not available for query-style lookups. It is
6711 also not available for any lookup items in address lists (see section
6712 &<<SECTaddresslist>>&).
6713
6714 Partial matching is implemented by doing a series of separate lookups using
6715 keys constructed by modifying the original subject key. This means that it can
6716 be used with any of the single-key lookup types, provided that
6717 partial matching keys
6718 beginning with a special prefix (default &"*."&) are included in the data file.
6719 Keys in the file that do not begin with the prefix are matched only by
6720 unmodified subject keys when partial matching is in use.
6721
6722 Partial matching is requested by adding the string &"partial-"& to the front of
6723 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6724 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6725 is added at the start of the subject key, and it is looked up again. If that
6726 fails, further lookups are tried with dot-separated components removed from the
6727 start of the subject key, one-by-one, and &"*."& added on the front of what
6728 remains.
6729
6730 A minimum number of two non-* components are required. This can be adjusted
6731 by including a number before the hyphen in the search type. For example,
6732 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6733 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6734 subject key is &'2250.dates.fict.example'& then the following keys are looked
6735 up when the minimum number of non-* components is two:
6736 .code
6737 2250.dates.fict.example
6738 *.2250.dates.fict.example
6739 *.dates.fict.example
6740 *.fict.example
6741 .endd
6742 As soon as one key in the sequence is successfully looked up, the lookup
6743 finishes.
6744
6745 .cindex "lookup" "partial matching &-- changing prefix"
6746 .cindex "prefix" "for partial matching"
6747 The use of &"*."& as the partial matching prefix is a default that can be
6748 changed. The motivation for this feature is to allow Exim to operate with file
6749 formats that are used by other MTAs. A different prefix can be supplied in
6750 parentheses instead of the hyphen after &"partial"&. For example:
6751 .code
6752 domains = partial(.)lsearch;/some/file
6753 .endd
6754 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6755 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6756 components is unchanged). The prefix may consist of any punctuation characters
6757 other than a closing parenthesis. It may be empty, for example:
6758 .code
6759 domains = partial1()cdb;/some/file
6760 .endd
6761 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6762 &`a.b.c`&, &`b.c`&, and &`c`&.
6763
6764 If &"partial0"& is specified, what happens at the end (when the lookup with
6765 just one non-wild component has failed, and the original key is shortened right
6766 down to the null string) depends on the prefix:
6767
6768 .ilist
6769 If the prefix has zero length, the whole lookup fails.
6770 .next
6771 If the prefix has length 1, a lookup for just the prefix is done. For
6772 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6773 .next
6774 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6775 remainder is looked up. With the default prefix, therefore, the final lookup is
6776 for &"*"& on its own.
6777 .next
6778 Otherwise, the whole prefix is looked up.
6779 .endlist
6780
6781
6782 If the search type ends in &"*"& or &"*@"& (see section
6783 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6784 this implies happens after all partial lookups have failed. If &"partial0"& is
6785 specified, adding &"*"& to the search type has no effect with the default
6786 prefix, because the &"*"& key is already included in the sequence of partial
6787 lookups. However, there might be a use for lookup types such as
6788 &"partial0(.)lsearch*"&.
6789
6790 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6791 in domain lists and the like. Partial matching works only in terms of
6792 dot-separated components; a key such as &`*fict.example`&
6793 in a database file is useless, because the asterisk in a partial matching
6794 subject key is always followed by a dot.
6795
6796
6797
6798
6799 .section "Lookup caching" "SECID64"
6800 .cindex "lookup" "caching"
6801 .cindex "caching" "lookup data"
6802 Exim caches all lookup results in order to avoid needless repetition of
6803 lookups. However, because (apart from the daemon) Exim operates as a collection
6804 of independent, short-lived processes, this caching applies only within a
6805 single Exim process. There is no inter-process lookup caching facility.
6806
6807 For single-key lookups, Exim keeps the relevant files open in case there is
6808 another lookup that needs them. In some types of configuration this can lead to
6809 many files being kept open for messages with many recipients. To avoid hitting
6810 the operating system limit on the number of simultaneously open files, Exim
6811 closes the least recently used file when it needs to open more files than its
6812 own internal limit, which can be changed via the &%lookup_open_max%& option.
6813
6814 The single-key lookup files are closed and the lookup caches are flushed at
6815 strategic points during delivery &-- for example, after all routing is
6816 complete.
6817
6818
6819
6820
6821 .section "Quoting lookup data" "SECID65"
6822 .cindex "lookup" "quoting"
6823 .cindex "quoting" "in lookups"
6824 When data from an incoming message is included in a query-style lookup, there
6825 is the possibility of special characters in the data messing up the syntax of
6826 the query. For example, a NIS+ query that contains
6827 .code
6828 [name=$local_part]
6829 .endd
6830 will be broken if the local part happens to contain a closing square bracket.
6831 For NIS+, data can be enclosed in double quotes like this:
6832 .code
6833 [name="$local_part"]
6834 .endd
6835 but this still leaves the problem of a double quote in the data. The rule for
6836 NIS+ is that double quotes must be doubled. Other lookup types have different
6837 rules, and to cope with the differing requirements, an expansion operator
6838 of the following form is provided:
6839 .code
6840 ${quote_<lookup-type>:<string>}
6841 .endd
6842 For example, the safest way to write the NIS+ query is
6843 .code
6844 [name="${quote_nisplus:$local_part}"]
6845 .endd
6846 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6847 operator can be used for all lookup types, but has no effect for single-key
6848 lookups, since no quoting is ever needed in their key strings.
6849
6850
6851
6852
6853 .section "More about dnsdb" "SECTdnsdb"
6854 .cindex "dnsdb lookup"
6855 .cindex "lookup" "dnsdb"
6856 .cindex "DNS" "as a lookup type"
6857 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6858 of a record type and a domain name, separated by an equals sign. For example,
6859 an expansion string could contain:
6860 .code
6861 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6862 .endd
6863 If the lookup succeeds, the result is placed in &$value$&, which in this case
6864 is used on its own as the result. If the lookup does not succeed, the
6865 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6866 &<<SECTforexpfai>>& for an explanation of what this means.
6867
6868 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6869 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6870 configured). If no type is given, TXT is assumed. When the type is PTR,
6871 the data can be an IP address, written as normal; inversion and the addition of
6872 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6873 .code
6874 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6875 .endd
6876 If the data for a PTR record is not a syntactically valid IP address, it is not
6877 altered and nothing is added.
6878
6879 .cindex "MX record" "in &(dnsdb)& lookup"
6880 .cindex "SRV record" "in &(dnsdb)& lookup"
6881 For an MX lookup, both the preference value and the host name are returned for
6882 each record, separated by a space. For an SRV lookup, the priority, weight,
6883 port, and host name are returned for each record, separated by spaces.
6884
6885 For any record type, if multiple records are found (or, for A6 lookups, if a
6886 single record leads to multiple addresses), the data is returned as a
6887 concatenation, with newline as the default separator. The order, of course,
6888 depends on the DNS resolver. You can specify a different separator character
6889 between multiple records by putting a right angle-bracket followed immediately
6890 by the new separator at the start of the query. For example:
6891 .code
6892 ${lookup dnsdb{>: a=host1.example}}
6893 .endd
6894 It is permitted to specify a space as the separator character. Further
6895 white space is ignored.
6896
6897 .cindex "TXT record" "in &(dnsdb)& lookup"
6898 .cindex "SPF record" "in &(dnsdb)& lookup"
6899 For TXT records with multiple items of data, only the first item is returned,
6900 unless a separator for them is specified using a comma after the separator
6901 character followed immediately by the TXT record item separator. To concatenate
6902 items without a separator, use a semicolon instead. For SPF records the
6903 default behaviour is to concatenate multiple items without using a separator.
6904 .code
6905 ${lookup dnsdb{>\n,: txt=a.b.example}}
6906 ${lookup dnsdb{>\n; txt=a.b.example}}
6907 ${lookup dnsdb{spf=example.org}}
6908 .endd
6909 It is permitted to specify a space as the separator character. Further
6910 white space is ignored.
6911
6912 .section "Pseudo dnsdb record types" "SECID66"
6913 .cindex "MX record" "in &(dnsdb)& lookup"
6914 By default, both the preference value and the host name are returned for
6915 each MX record, separated by a space. If you want only host names, you can use
6916 the pseudo-type MXH:
6917 .code
6918 ${lookup dnsdb{mxh=a.b.example}}
6919 .endd
6920 In this case, the preference values are omitted, and just the host names are
6921 returned.
6922
6923 .cindex "name server for enclosing domain"
6924 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6925 records on the given domain, but if none are found, it removes the first
6926 component of the domain name, and tries again. This process continues until NS
6927 records are found or there are no more components left (or there is a DNS
6928 error). In other words, it may return the name servers for a top-level domain,
6929 but it never returns the root name servers. If there are no NS records for the
6930 top-level domain, the lookup fails. Consider these examples:
6931 .code
6932 ${lookup dnsdb{zns=xxx.quercite.com}}
6933 ${lookup dnsdb{zns=xxx.edu}}
6934 .endd
6935 Assuming that in each case there are no NS records for the full domain name,
6936 the first returns the name servers for &%quercite.com%&, and the second returns
6937 the name servers for &%edu%&.
6938
6939 You should be careful about how you use this lookup because, unless the
6940 top-level domain does not exist, the lookup always returns some host names. The
6941 sort of use to which this might be put is for seeing if the name servers for a
6942 given domain are on a blacklist. You can probably assume that the name servers
6943 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6944 such a list.
6945
6946 .cindex "CSA" "in &(dnsdb)& lookup"
6947 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6948 records according to the CSA rules, which are described in section
6949 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6950 not sufficient because of the extra parent domain search behaviour of CSA. The
6951 result of a successful lookup such as:
6952 .code
6953 ${lookup dnsdb {csa=$sender_helo_name}}
6954 .endd
6955 has two space-separated fields: an authorization code and a target host name.
6956 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6957 authorization required but absent, or &"?"& for unknown.
6958
6959 .new
6960 .cindex "A+" "in &(dnsdb)& lookup"
6961 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6962 and then an A lookup.  All results are returned; defer processing
6963 (see below) is handled separately for each lookup.  Example:
6964 .code
6965 ${lookup dnsdb {>; a+=$sender_helo_name}}
6966 .endd
6967 .wen
6968
6969
6970 .section "Multiple dnsdb lookups" "SECID67"
6971 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6972 However, you can specify a list of domains or IP addresses in a single
6973 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6974 the default separator, but with the ability to change this. For example:
6975 .code
6976 ${lookup dnsdb{one.domain.com:two.domain.com}}
6977 ${lookup dnsdb{a=one.host.com:two.host.com}}
6978 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6979 .endd
6980 In order to retain backwards compatibility, there is one special case: if
6981 the lookup type is PTR and no change of separator is specified, Exim looks
6982 to see if the rest of the string is precisely one IPv6 address. In this
6983 case, it does not treat it as a list.
6984
6985 The data from each lookup is concatenated, with newline separators by default,
6986 in the same way that multiple DNS records for a single item are handled. A
6987 different separator can be specified, as described above.
6988
6989 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6990 temporary DNS error for any of them, the behaviour is controlled by
6991 an optional keyword followed by a comma that may appear before the record
6992 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6993 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6994 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6995 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6996 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6997 error causes the whole lookup to defer only if none of the other lookups
6998 succeed. The default is &"lax"&, so the following lookups are equivalent:
6999 .code
7000 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7001 ${lookup dnsdb{a=one.host.com:two.host.com}}
7002 .endd
7003 Thus, in the default case, as long as at least one of the DNS lookups
7004 yields some data, the lookup succeeds.
7005
7006
7007
7008
7009 .section "More about LDAP" "SECTldap"
7010 .cindex "LDAP" "lookup, more about"
7011 .cindex "lookup" "LDAP"
7012 .cindex "Solaris" "LDAP"
7013 The original LDAP implementation came from the University of Michigan; this has
7014 become &"Open LDAP"&, and there are now two different releases. Another
7015 implementation comes from Netscape, and Solaris 7 and subsequent releases
7016 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7017 the lookup function level, their error handling is different. For this reason
7018 it is necessary to set a compile-time variable when building Exim with LDAP, to
7019 indicate which LDAP library is in use. One of the following should appear in
7020 your &_Local/Makefile_&:
7021 .code
7022 LDAP_LIB_TYPE=UMICHIGAN
7023 LDAP_LIB_TYPE=OPENLDAP1
7024 LDAP_LIB_TYPE=OPENLDAP2
7025 LDAP_LIB_TYPE=NETSCAPE
7026 LDAP_LIB_TYPE=SOLARIS
7027 .endd
7028 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7029 same interface as the University of Michigan version.
7030
7031 There are three LDAP lookup types in Exim. These behave slightly differently in
7032 the way they handle the results of a query:
7033
7034 .ilist
7035 &(ldap)& requires the result to contain just one entry; if there are more, it
7036 gives an error.
7037 .next
7038 &(ldapdn)& also requires the result to contain just one entry, but it is the
7039 Distinguished Name that is returned rather than any attribute values.
7040 .next
7041 &(ldapm)& permits the result to contain more than one entry; the attributes
7042 from all of them are returned.
7043 .endlist
7044
7045
7046 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7047 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7048 the data returned by a successful lookup is described in the next section.
7049 First we explain how LDAP queries are coded.
7050
7051
7052 .section "Format of LDAP queries" "SECTforldaque"
7053 .cindex "LDAP" "query format"
7054 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7055 the configuration of a &(redirect)& router one might have this setting:
7056 .code
7057 data = ${lookup ldap \
7058   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7059   c=UK?mailbox?base?}}
7060 .endd
7061 .cindex "LDAP" "with TLS"
7062 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7063 secure (encrypted) LDAP connections. The second of these ensures that an
7064 encrypted TLS connection is used.
7065
7066 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7067 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7068 See the &%ldap_start_tls%& option.
7069
7070
7071 .section "LDAP quoting" "SECID68"
7072 .cindex "LDAP" "quoting"
7073 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7074 and the second because the LDAP query is represented as a URL. Furthermore,
7075 within an LDAP query, two different kinds of quoting are required. For this
7076 reason, there are two different LDAP-specific quoting operators.
7077
7078 The &%quote_ldap%& operator is designed for use on strings that are part of
7079 filter specifications. Conceptually, it first does the following conversions on
7080 the string:
7081 .code
7082 *   =>   \2A
7083 (   =>   \28
7084 )   =>   \29
7085 \   =>   \5C
7086 .endd
7087 in accordance with RFC 2254. The resulting string is then quoted according
7088 to the rules for URLs, that is, all non-alphanumeric characters except
7089 .code
7090 ! $ ' - . _ ( ) * +
7091 .endd
7092 are converted to their hex values, preceded by a percent sign. For example:
7093 .code
7094 ${quote_ldap: a(bc)*, a<yz>; }
7095 .endd
7096 yields
7097 .code
7098 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7099 .endd
7100 Removing the URL quoting, this is (with a leading and a trailing space):
7101 .code
7102 a\28bc\29\2A, a<yz>;
7103 .endd
7104 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7105 base DN specifications in queries. Conceptually, it first converts the string
7106 by inserting a backslash in front of any of the following characters:
7107 .code
7108 , + " \ < > ;
7109 .endd
7110 It also inserts a backslash before any leading spaces or # characters, and
7111 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7112 is then quoted according to the rules for URLs. For example:
7113 .code
7114 ${quote_ldap_dn: a(bc)*, a<yz>; }
7115 .endd
7116 yields
7117 .code
7118 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7119 .endd
7120 Removing the URL quoting, this is (with a trailing space):
7121 .code
7122 \ a(bc)*\, a\<yz\>\;\
7123 .endd
7124 There are some further comments about quoting in the section on LDAP
7125 authentication below.
7126
7127
7128 .section "LDAP connections" "SECID69"
7129 .cindex "LDAP" "connections"
7130 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7131 is in use, via a Unix domain socket. The example given above does not specify
7132 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7133 by starting it with
7134 .code
7135 ldap://<hostname>:<port>/...
7136 .endd
7137 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7138 used. When no server is specified in a query, a list of default servers is
7139 taken from the &%ldap_default_servers%& configuration option. This supplies a
7140 colon-separated list of servers which are tried in turn until one successfully
7141 handles a query, or there is a serious error. Successful handling either
7142 returns the requested data, or indicates that it does not exist. Serious errors
7143 are syntactical, or multiple values when only a single value is expected.
7144 Errors which cause the next server to be tried are connection failures, bind
7145 failures, and timeouts.
7146
7147 For each server name in the list, a port number can be given. The standard way
7148 of specifying a host and port is to use a colon separator (RFC 1738). Because
7149 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7150 doubled. For example
7151 .code
7152 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7153 .endd
7154 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7155 to the LDAP library with no server name, and the library's default (normally
7156 the local host) is used.
7157
7158 If you are using the OpenLDAP library, you can connect to an LDAP server using
7159 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7160 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7161 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7162 not available.
7163
7164 For this type of connection, instead of a host name for the server, a pathname
7165 for the socket is required, and the port number is not relevant. The pathname
7166 can be specified either as an item in &%ldap_default_servers%&, or inline in
7167 the query. In the former case, you can have settings such as
7168 .code
7169 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7170 .endd
7171 When the pathname is given in the query, you have to escape the slashes as
7172 &`%2F`& to fit in with the LDAP URL syntax. For example:
7173 .code
7174 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7175 .endd
7176 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7177 a pathname, it uses the Unix domain socket code, even if the query actually
7178 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7179 socket connection. This behaviour means that you can use a setting of
7180 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7181 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7182 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7183 backup host.
7184
7185 If an explicit &`ldapi`& type is given in a query when a host name is
7186 specified, an error is diagnosed. However, if there are more items in
7187 &%ldap_default_servers%&, they are tried. In other words:
7188
7189 .ilist
7190 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7191 interface.
7192 .next
7193 Using &`ldapi`& with a host name causes an error.
7194 .endlist
7195
7196
7197 Using &`ldapi`& with no host or path in the query, and no setting of
7198 &%ldap_default_servers%&, does whatever the library does by default.
7199
7200
7201
7202 .section "LDAP authentication and control information" "SECID70"
7203 .cindex "LDAP" "authentication"
7204 The LDAP URL syntax provides no way of passing authentication and other control
7205 information to the server. To make this possible, the URL in an LDAP query may
7206 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7207 spaces. If a value contains spaces it must be enclosed in double quotes, and
7208 when double quotes are used, backslash is interpreted in the usual way inside
7209 them. The following names are recognized:
7210 .display
7211 &`DEREFERENCE`&  set the dereferencing parameter
7212 &`NETTIME    `&  set a timeout for a network operation
7213 &`USER       `&  set the DN, for authenticating the LDAP bind
7214 &`PASS       `&  set the password, likewise
7215 &`REFERRALS  `&  set the referrals parameter
7216 &`SIZE       `&  set the limit for the number of entries returned
7217 &`TIME       `&  set the maximum waiting time for a query
7218 .endd
7219 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7220 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7221 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7222 library from trying to follow referrals issued by the LDAP server.
7223
7224 The name CONNECT is an obsolete name for NETTIME, retained for
7225 backwards compatibility. This timeout (specified as a number of seconds) is
7226 enforced from the client end for operations that can be carried out over a
7227 network. Specifically, it applies to network connections and calls to the
7228 &'ldap_result()'& function. If the value is greater than zero, it is used if
7229 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7230 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7231 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7232 Netscape SDK; for OpenLDAP no action is taken.
7233
7234 The TIME parameter (also a number of seconds) is passed to the server to
7235 set a server-side limit on the time taken to complete a search.
7236
7237
7238 Here is an example of an LDAP query in an Exim lookup that uses some of these
7239 values. This is a single line, folded to fit on the page:
7240 .code
7241 ${lookup ldap
7242   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7243   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7244   {$value}fail}
7245 .endd
7246 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7247 any of the auxiliary data. Exim configuration settings that include lookups
7248 which contain password information should be preceded by &"hide"& to prevent
7249 non-admin users from using the &%-bP%& option to see their values.
7250
7251 The auxiliary data items may be given in any order. The default is no
7252 connection timeout (the system timeout is used), no user or password, no limit
7253 on the number of entries returned, and no time limit on queries.
7254
7255 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7256 removes any URL quoting that it may contain before passing it LDAP. Apparently
7257 some libraries do this for themselves, but some do not. Removing the URL
7258 quoting has two advantages:
7259
7260 .ilist
7261 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7262 DNs as with DNs inside actual queries.
7263 .next
7264 It permits spaces inside USER= DNs.
7265 .endlist
7266
7267 For example, a setting such as
7268 .code
7269 USER=cn=${quote_ldap_dn:$1}
7270 .endd
7271 should work even if &$1$& contains spaces.
7272
7273 Expanded data for the PASS= value should be quoted using the &%quote%&
7274 expansion operator, rather than the LDAP quote operators. The only reason this
7275 field needs quoting is to ensure that it conforms to the Exim syntax, which
7276 does not allow unquoted spaces. For example:
7277 .code
7278 PASS=${quote:$3}
7279 .endd
7280 The LDAP authentication mechanism can be used to check passwords as part of
7281 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7282 &<<CHAPexpand>>&.
7283
7284
7285
7286 .section "Format of data returned by LDAP" "SECID71"
7287 .cindex "LDAP" "returned data formats"
7288 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7289 as a sequence of values, for example
7290 .code
7291 cn=manager, o=University of Cambridge, c=UK
7292 .endd
7293 The &(ldap)& lookup type generates an error if more than one entry matches the
7294 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7295 the result between the data from different entries. It is possible for multiple
7296 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7297 you know that whatever values are returned all came from a single entry in the
7298 directory.
7299
7300 In the common case where you specify a single attribute in your LDAP query, the
7301 result is not quoted, and does not contain the attribute name. If the attribute
7302 has multiple values, they are separated by commas.
7303
7304 If you specify multiple attributes, the result contains space-separated, quoted
7305 strings, each preceded by the attribute name and an equals sign. Within the
7306 quotes, the quote character, backslash, and newline are escaped with
7307 backslashes, and commas are used to separate multiple values for the attribute.
7308 Apart from the escaping, the string within quotes takes the same form as the
7309 output when a single attribute is requested. Specifying no attributes is the
7310 same as specifying all of an entry's attributes.
7311
7312 Here are some examples of the output format. The first line of each pair is an
7313 LDAP query, and the second is the data that is returned. The attribute called
7314 &%attr1%& has two values, whereas &%attr2%& has only one value:
7315 .code
7316 ldap:///o=base?attr1?sub?(uid=fred)
7317 value1.1, value1.2
7318
7319 ldap:///o=base?attr2?sub?(uid=fred)
7320 value two
7321
7322 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7323 attr1="value1.1, value1.2" attr2="value two"
7324
7325 ldap:///o=base??sub?(uid=fred)
7326 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7327 .endd
7328 The &%extract%& operator in string expansions can be used to pick out
7329 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7330 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7331 results of LDAP lookups.
7332
7333
7334
7335
7336 .section "More about NIS+" "SECTnisplus"
7337 .cindex "NIS+ lookup type"
7338 .cindex "lookup" "NIS+"
7339 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7340 and field name. If this is given, the result of a successful query is the
7341 contents of the named field; otherwise the result consists of a concatenation
7342 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7343 values containing spaces are quoted. For example, the query
7344 .code
7345 [name=mg1456],passwd.org_dir
7346 .endd
7347 might return the string
7348 .code
7349 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7350 home=/home/mg1456 shell=/bin/bash shadow=""
7351 .endd
7352 (split over two lines here to fit on the page), whereas
7353 .code
7354 [name=mg1456],passwd.org_dir:gcos
7355 .endd
7356 would just return
7357 .code
7358 Martin Guerre
7359 .endd
7360 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7361 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7362 operator is to double any quote characters within the text.
7363
7364
7365
7366 .section "SQL lookups" "SECTsql"
7367 .cindex "SQL lookup types"
7368 .cindex "MySQL" "lookup type"
7369 .cindex "PostgreSQL lookup type"
7370 .cindex "lookup" "MySQL"
7371 .cindex "lookup" "PostgreSQL"
7372 .cindex "Oracle" "lookup type"
7373 .cindex "lookup" "Oracle"
7374 .cindex "InterBase lookup type"
7375 .cindex "lookup" "InterBase"
7376 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7377 databases. Queries for these databases contain SQL statements, so an example
7378 might be
7379 .code
7380 ${lookup mysql{select mailbox from users where id='userx'}\
7381   {$value}fail}
7382 .endd
7383 If the result of the query contains more than one field, the data for each
7384 field in the row is returned, preceded by its name, so the result of
7385 .code
7386 ${lookup pgsql{select home,name from users where id='userx'}\
7387   {$value}}
7388 .endd
7389 might be
7390 .code
7391 home=/home/userx name="Mister X"
7392 .endd
7393 Empty values and values containing spaces are double quoted, with embedded
7394 quotes escaped by a backslash. If the result of the query contains just one
7395 field, the value is passed back verbatim, without a field name, for example:
7396 .code
7397 Mister X
7398 .endd
7399 If the result of the query yields more than one row, it is all concatenated,
7400 with a newline between the data for each row.
7401
7402
7403 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7404 .cindex "MySQL" "lookup type"
7405 .cindex "PostgreSQL lookup type"
7406 .cindex "lookup" "MySQL"
7407 .cindex "lookup" "PostgreSQL"
7408 .cindex "Oracle" "lookup type"
7409 .cindex "lookup" "Oracle"
7410 .cindex "InterBase lookup type"
7411 .cindex "lookup" "InterBase"
7412 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7413 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7414 option (as appropriate) must be set to a colon-separated list of server
7415 information.
7416 (For MySQL and PostgreSQL only, the global option need not be set if all
7417 queries contain their own server information &-- see section
7418 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7419 items: host name, database name, user name, and password. In the case of
7420 Oracle, the host name field is used for the &"service name"&, and the database
7421 name field is not used and should be empty. For example:
7422 .code
7423 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7424 .endd
7425 Because password data is sensitive, you should always precede the setting with
7426 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7427 option. Here is an example where two MySQL servers are listed:
7428 .code
7429 hide mysql_servers = localhost/users/root/secret:\
7430                      otherhost/users/root/othersecret
7431 .endd
7432 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7433 because this is a colon-separated list, the colon has to be doubled. For each
7434 query, these parameter groups are tried in order until a connection is made and
7435 a query is successfully processed. The result of a query may be that no data is
7436 found, but that is still a successful query. In other words, the list of
7437 servers provides a backup facility, not a list of different places to look.
7438
7439 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7440 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7441 respectively, and the characters single-quote, double-quote, and backslash
7442 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7443 addition, escapes the percent and underscore characters. This cannot be done
7444 for MySQL because these escapes are not recognized in contexts where these
7445 characters are not special.
7446
7447 .section "Specifying the server in the query" "SECTspeserque"
7448 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7449 it is possible to specify a list of servers with an individual query. This is
7450 done by starting the query with
7451 .display
7452 &`servers=`&&'server1:server2:server3:...'&&`;`&
7453 .endd
7454 Each item in the list may take one of two forms:
7455 .olist
7456 If it contains no slashes it is assumed to be just a host name. The appropriate
7457 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7458 of the same name, and the remaining parameters (database, user, password) are
7459 taken from there.
7460 .next
7461 If it contains any slashes, it is taken as a complete parameter set.
7462 .endlist
7463 The list of servers is used in exactly the same way as the global list.
7464 Once a connection to a server has happened and a query has been
7465 successfully executed, processing of the lookup ceases.
7466
7467 This feature is intended for use in master/slave situations where updates
7468 are occurring and you want to update the master rather than a slave. If the
7469 master is in the list as a backup for reading, you might have a global setting
7470 like this:
7471 .code
7472 mysql_servers = slave1/db/name/pw:\
7473                 slave2/db/name/pw:\
7474                 master/db/name/pw
7475 .endd
7476 In an updating lookup, you could then write:
7477 .code
7478 ${lookup mysql{servers=master; UPDATE ...} }
7479 .endd
7480 That query would then be sent only to the master server. If, on the other hand,
7481 the master is not to be used for reading, and so is not present in the global
7482 option, you can still update it by a query of this form:
7483 .code
7484 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7485 .endd
7486
7487
7488 .section "Special MySQL features" "SECID73"
7489 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7490 causes a connection to the server on the local host by means of a Unix domain
7491 socket. An alternate socket can be specified in parentheses. The full syntax of
7492 each item in &%mysql_servers%& is:
7493 .display
7494 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7495   <&'user'&>/<&'password'&>
7496 .endd
7497 Any of the three sub-parts of the first field can be omitted. For normal use on
7498 the local host it can be left blank or set to just &"localhost"&.
7499
7500 No database need be supplied &-- but if it is absent here, it must be given in
7501 the queries.
7502
7503 If a MySQL query is issued that does not request any data (an insert, update,
7504 or delete command), the result of the lookup is the number of rows affected.
7505
7506 &*Warning*&: This can be misleading. If an update does not actually change
7507 anything (for example, setting a field to the value it already has), the result
7508 is zero because no rows are affected.
7509
7510
7511 .section "Special PostgreSQL features" "SECID74"
7512 PostgreSQL lookups can also use Unix domain socket connections to the database.
7513 This is usually faster and costs less CPU time than a TCP/IP connection.
7514 However it can be used only if the mail server runs on the same machine as the
7515 database server. A configuration line for PostgreSQL via Unix domain sockets
7516 looks like this:
7517 .code
7518 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7519 .endd
7520 In other words, instead of supplying a host name, a path to the socket is
7521 given. The path name is enclosed in parentheses so that its slashes aren't
7522 visually confused with the delimiters for the other server parameters.
7523
7524 If a PostgreSQL query is issued that does not request any data (an insert,
7525 update, or delete command), the result of the lookup is the number of rows
7526 affected.
7527
7528 .section "More about SQLite" "SECTsqlite"
7529 .cindex "lookup" "SQLite"
7530 .cindex "sqlite lookup type"
7531 SQLite is different to the other SQL lookups because a file name is required in
7532 addition to the SQL query. An SQLite database is a single file, and there is no
7533 daemon as in the other SQL databases. The interface to Exim requires the name
7534 of the file, as an absolute path, to be given at the start of the query. It is
7535 separated from the query by white space. This means that the path name cannot
7536 contain white space. Here is a lookup expansion example:
7537 .code
7538 ${lookup sqlite {/some/thing/sqlitedb \
7539   select name from aliases where id='userx';}}
7540 .endd
7541 In a list, the syntax is similar. For example:
7542 .code
7543 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7544    select * from relays where ip='$sender_host_address';
7545 .endd
7546 The only character affected by the &%quote_sqlite%& operator is a single
7547 quote, which it doubles.
7548
7549 The SQLite library handles multiple simultaneous accesses to the database
7550 internally. Multiple readers are permitted, but only one process can
7551 update at once. Attempts to access the database while it is being updated
7552 are rejected after a timeout period, during which the SQLite library
7553 waits for the lock to be released. In Exim, the default timeout is set
7554 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7555 option.
7556 .ecindex IIDfidalo1
7557 .ecindex IIDfidalo2
7558
7559
7560 . ////////////////////////////////////////////////////////////////////////////
7561 . ////////////////////////////////////////////////////////////////////////////
7562
7563 .chapter "Domain, host, address, and local part lists" &&&
7564          "CHAPdomhosaddlists" &&&
7565          "Domain, host, and address lists"
7566 .scindex IIDdohoadli "lists of domains; hosts; etc."
7567 A number of Exim configuration options contain lists of domains, hosts,
7568 email addresses, or local parts. For example, the &%hold_domains%& option
7569 contains a list of domains whose delivery is currently suspended. These lists
7570 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7571 arguments to expansion conditions such as &%match_domain%&.
7572
7573 Each item in one of these lists is a pattern to be matched against a domain,
7574 host, email address, or local part, respectively. In the sections below, the
7575 different types of pattern for each case are described, but first we cover some
7576 general facilities that apply to all four kinds of list.
7577
7578
7579
7580 .section "Expansion of lists" "SECTlistexpand"
7581 .cindex "expansion" "of lists"
7582 Each list is expanded as a single string before it is used. The result of
7583 expansion must be a list, possibly containing empty items, which is split up
7584 into separate items for matching. By default, colon is the separator character,
7585 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7586 &<<SECTempitelis>>& for details of the list syntax; the second of these
7587 discusses the way to specify empty list items.
7588
7589
7590 If the string expansion is forced to fail, Exim behaves as if the item it is
7591 testing (domain, host, address, or local part) is not in the list. Other
7592 expansion failures cause temporary errors.
7593
7594 If an item in a list is a regular expression, backslashes, dollars and possibly
7595 other special characters in the expression must be protected against
7596 misinterpretation by the string expander. The easiest way to do this is to use
7597 the &`\N`& expansion feature to indicate that the contents of the regular
7598 expression should not be expanded. For example, in an ACL you might have:
7599 .code
7600 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7601                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7602 .endd
7603 The first item is a regular expression that is protected from expansion by
7604 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7605 senders based on the receiving domain.
7606
7607
7608
7609
7610 .section "Negated items in lists" "SECID76"
7611 .cindex "list" "negation"
7612 .cindex "negation" "in lists"
7613 Items in a list may be positive or negative. Negative items are indicated by a
7614 leading exclamation mark, which may be followed by optional white space. A list
7615 defines a set of items (domains, etc). When Exim processes one of these lists,
7616 it is trying to find out whether a domain, host, address, or local part
7617 (respectively) is in the set that is defined by the list. It works like this:
7618
7619 The list is scanned from left to right. If a positive item is matched, the
7620 subject that is being checked is in the set; if a negative item is matched, the
7621 subject is not in the set. If the end of the list is reached without the
7622 subject having matched any of the patterns, it is in the set if the last item
7623 was a negative one, but not if it was a positive one. For example, the list in
7624 .code
7625 domainlist relay_to_domains = !a.b.c : *.b.c
7626 .endd
7627 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7628 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7629 list is positive. However, if the setting were
7630 .code
7631 domainlist relay_to_domains = !a.b.c
7632 .endd
7633 then all domains other than &'a.b.c'& would match because the last item in the
7634 list is negative. In other words, a list that ends with a negative item behaves
7635 as if it had an extra item &`:*`& on the end.
7636
7637 Another way of thinking about positive and negative items in lists is to read
7638 the connector as &"or"& after a positive item and as &"and"& after a negative
7639 item.
7640
7641
7642
7643 .section "File names in lists" "SECTfilnamlis"
7644 .cindex "list" "file name in"
7645 If an item in a domain, host, address, or local part list is an absolute file
7646 name (beginning with a slash character), each line of the file is read and
7647 processed as if it were an independent item in the list, except that further
7648 file names are not allowed,
7649 and no expansion of the data from the file takes place.
7650 Empty lines in the file are ignored, and the file may also contain comment
7651 lines:
7652
7653 .ilist
7654 For domain and host lists, if a # character appears anywhere in a line of the
7655 file, it and all following characters are ignored.
7656 .next
7657 Because local parts may legitimately contain # characters, a comment in an
7658 address list or local part list file is recognized only if # is preceded by
7659 white space or the start of the line. For example:
7660 .code
7661 not#comment@x.y.z   # but this is a comment
7662 .endd
7663 .endlist
7664
7665 Putting a file name in a list has the same effect as inserting each line of the
7666 file as an item in the list (blank lines and comments excepted). However, there
7667 is one important difference: the file is read each time the list is processed,
7668 so if its contents vary over time, Exim's behaviour changes.
7669
7670 If a file name is preceded by an exclamation mark, the sense of any match
7671 within the file is inverted. For example, if
7672 .code
7673 hold_domains = !/etc/nohold-domains
7674 .endd
7675 and the file contains the lines
7676 .code
7677 !a.b.c
7678 *.b.c
7679 .endd
7680 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7681 any domain matching &`*.b.c`& is not.
7682
7683
7684
7685 .section "An lsearch file is not an out-of-line list" "SECID77"
7686 As will be described in the sections that follow, lookups can be used in lists
7687 to provide indexed methods of checking list membership. There has been some
7688 confusion about the way &(lsearch)& lookups work in lists. Because
7689 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7690 sometimes thought that it is allowed to contain wild cards and other kinds of
7691 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7692 always fixed strings, just as for any other single-key lookup type.
7693
7694 If you want to use a file to contain wild-card patterns that form part of a
7695 list, just give the file name on its own, without a search type, as described
7696 in the previous section. You could also use the &(wildlsearch)& or
7697 &(nwildlsearch)&, but there is no advantage in doing this.
7698
7699
7700
7701
7702 .section "Named lists" "SECTnamedlists"
7703 .cindex "named lists"
7704 .cindex "list" "named"
7705 A list of domains, hosts, email addresses, or local parts can be given a name
7706 which is then used to refer to the list elsewhere in the configuration. This is
7707 particularly convenient if the same list is required in several different
7708 places. It also allows lists to be given meaningful names, which can improve
7709 the readability of the configuration. For example, it is conventional to define
7710 a domain list called &'local_domains'& for all the domains that are handled
7711 locally on a host, using a configuration line such as
7712 .code
7713 domainlist local_domains = localhost:my.dom.example
7714 .endd
7715 Named lists are referenced by giving their name preceded by a plus sign, so,
7716 for example, a router that is intended to handle local domains would be
7717 configured with the line
7718 .code
7719 domains = +local_domains
7720 .endd
7721 The first router in a configuration is often one that handles all domains
7722 except the local ones, using a configuration with a negated item like this:
7723 .code
7724 dnslookup:
7725   driver = dnslookup
7726   domains = ! +local_domains
7727   transport = remote_smtp
7728   no_more
7729 .endd
7730 The four kinds of named list are created by configuration lines starting with
7731 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7732 respectively. Then there follows the name that you are defining, followed by an
7733 equals sign and the list itself. For example:
7734 .code
7735 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7736 addresslist bad_senders = cdb;/etc/badsenders
7737 .endd
7738 A named list may refer to other named lists:
7739 .code
7740 domainlist  dom1 = first.example : second.example
7741 domainlist  dom2 = +dom1 : third.example
7742 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7743 .endd
7744 &*Warning*&: If the last item in a referenced list is a negative one, the
7745 effect may not be what you intended, because the negation does not propagate
7746 out to the higher level. For example, consider:
7747 .code
7748 domainlist  dom1 = !a.b
7749 domainlist  dom2 = +dom1 : *.b
7750 .endd
7751 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7752 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7753 means it matches the second list as well. The effect is not the same as
7754 .code
7755 domainlist  dom2 = !a.b : *.b
7756 .endd
7757 where &'x.y'& does not match. It's best to avoid negation altogether in
7758 referenced lists if you can.
7759
7760 Named lists may have a performance advantage. When Exim is routing an
7761 address or checking an incoming message, it caches the result of tests on named
7762 lists. So, if you have a setting such as
7763 .code
7764 domains = +local_domains
7765 .endd
7766 on several of your routers
7767 or in several ACL statements,
7768 the actual test is done only for the first one. However, the caching works only
7769 if there are no expansions within the list itself or any sublists that it
7770 references. In other words, caching happens only for lists that are known to be
7771 the same each time they are referenced.
7772
7773 By default, there may be up to 16 named lists of each type. This limit can be
7774 extended by changing a compile-time variable. The use of domain and host lists
7775 is recommended for concepts such as local domains, relay domains, and relay
7776 hosts. The default configuration is set up like this.
7777
7778
7779
7780 .section "Named lists compared with macros" "SECID78"
7781 .cindex "list" "named compared with macro"
7782 .cindex "macro" "compared with named list"
7783 At first sight, named lists might seem to be no different from macros in the
7784 configuration file. However, macros are just textual substitutions. If you
7785 write
7786 .code
7787 ALIST = host1 : host2
7788 auth_advertise_hosts = !ALIST
7789 .endd
7790 it probably won't do what you want, because that is exactly the same as
7791 .code
7792 auth_advertise_hosts = !host1 : host2
7793 .endd
7794 Notice that the second host name is not negated. However, if you use a host
7795 list, and write
7796 .code
7797 hostlist alist = host1 : host2
7798 auth_advertise_hosts = ! +alist
7799 .endd
7800 the negation applies to the whole list, and so that is equivalent to
7801 .code
7802 auth_advertise_hosts = !host1 : !host2
7803 .endd
7804
7805
7806 .section "Named list caching" "SECID79"
7807 .cindex "list" "caching of named"
7808 .cindex "caching" "named lists"
7809 While processing a message, Exim caches the result of checking a named list if
7810 it is sure that the list is the same each time. In practice, this means that
7811 the cache operates only if the list contains no $ characters, which guarantees
7812 that it will not change when it is expanded. Sometimes, however, you may have
7813 an expanded list that you know will be the same each time within a given
7814 message. For example:
7815 .code
7816 domainlist special_domains = \
7817            ${lookup{$sender_host_address}cdb{/some/file}}
7818 .endd
7819 This provides a list of domains that depends only on the sending host's IP
7820 address. If this domain list is referenced a number of times (for example,
7821 in several ACL lines, or in several routers) the result of the check is not
7822 cached by default, because Exim does not know that it is going to be the
7823 same list each time.
7824
7825 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7826 cache the result anyway. For example:
7827 .code
7828 domainlist_cache special_domains = ${lookup{...
7829 .endd
7830 If you do this, you should be absolutely sure that caching is going to do
7831 the right thing in all cases. When in doubt, leave it out.
7832
7833
7834
7835 .section "Domain lists" "SECTdomainlist"
7836 .cindex "domain list" "patterns for"
7837 .cindex "list" "domain list"
7838 Domain lists contain patterns that are to be matched against a mail domain.
7839 The following types of item may appear in domain lists:
7840
7841 .ilist
7842 .cindex "primary host name"
7843 .cindex "host name" "matched in domain list"
7844 .oindex "&%primary_hostname%&"
7845 .cindex "domain list" "matching primary host name"
7846 .cindex "@ in a domain list"
7847 If a pattern consists of a single @ character, it matches the local host name,
7848 as set by the &%primary_hostname%& option (or defaulted). This makes it
7849 possible to use the same configuration file on several different hosts that
7850 differ only in their names.
7851 .next
7852 .cindex "@[] in a domain list"
7853 .cindex "domain list" "matching local IP interfaces"
7854 .cindex "domain literal"
7855 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7856 in square brackets (as in an email address that contains a domain literal), but
7857 only if that IP address is recognized as local for email routing purposes. The
7858 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7859 control which of a host's several IP addresses are treated as local.
7860 In today's Internet, the use of domain literals is controversial.
7861 .next
7862 .cindex "@mx_any"
7863 .cindex "@mx_primary"
7864 .cindex "@mx_secondary"
7865 .cindex "domain list" "matching MX pointers to local host"
7866 If a pattern consists of the string &`@mx_any`& it matches any domain that
7867 has an MX record pointing to the local host or to any host that is listed in
7868 .oindex "&%hosts_treat_as_local%&"
7869 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7870 are similar, except that the first matches only when a primary MX target is the
7871 local host, and the second only when no primary MX target is the local host,
7872 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7873 preference value &-- there may of course be more than one of them.
7874
7875 The MX lookup that takes place when matching a pattern of this type is
7876 performed with the resolver options for widening names turned off. Thus, for
7877 example, a single-component domain will &'not'& be expanded by adding the
7878 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7879 options of the &(dnslookup)& router for a discussion of domain widening.
7880
7881 Sometimes you may want to ignore certain IP addresses when using one of these
7882 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7883 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7884 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7885 on a router). For example:
7886 .code
7887 domains = @mx_any/ignore=127.0.0.1
7888 .endd
7889 This example matches any domain that has an MX record pointing to one of
7890 the local host's IP addresses other than 127.0.0.1.
7891
7892 The list of IP addresses is in fact processed by the same code that processes
7893 host lists, so it may contain CIDR-coded network specifications and it may also
7894 contain negative items.
7895
7896 Because the list of IP addresses is a sublist within a domain list, you have to
7897 be careful about delimiters if there is more than one address. Like any other
7898 list, the default delimiter can be changed. Thus, you might have:
7899 .code
7900 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7901           an.other.domain : ...
7902 .endd
7903 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7904 involved, it is easiest to change the delimiter for the main list as well:
7905 .code
7906 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7907           an.other.domain ? ...
7908 .endd
7909 .next
7910 .cindex "asterisk" "in domain list"
7911 .cindex "domain list" "asterisk in"
7912 .cindex "domain list" "matching &""ends with""&"
7913 If a pattern starts with an asterisk, the remaining characters of the pattern
7914 are compared with the terminating characters of the domain. The use of &"*"& in
7915 domain lists differs from its use in partial matching lookups. In a domain
7916 list, the character following the asterisk need not be a dot, whereas partial
7917 matching works only in terms of dot-separated components. For example, a domain
7918 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7919 &'cipher.key.ex'&.
7920
7921 .next
7922 .cindex "regular expressions" "in domain list"
7923 .cindex "domain list" "matching regular expression"
7924 If a pattern starts with a circumflex character, it is treated as a regular
7925 expression, and matched against the domain using a regular expression matching
7926 function. The circumflex is treated as part of the regular expression.
7927 Email domains are case-independent, so this regular expression match is by
7928 default case-independent, but you can make it case-dependent by starting it
7929 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7930 are given in chapter &<<CHAPregexp>>&.
7931
7932 &*Warning*&: Because domain lists are expanded before being processed, you
7933 must escape any backslash and dollar characters in the regular expression, or
7934 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7935 it is not to be expanded (unless you really do want to build a regular
7936 expression by expansion, of course).
7937 .next
7938 .cindex "lookup" "in domain list"
7939 .cindex "domain list" "matching by lookup"
7940 If a pattern starts with the name of a single-key lookup type followed by a
7941 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7942 must be a file name in a suitable format for the lookup type. For example, for
7943 &"cdb;"& it must be an absolute path:
7944 .code
7945 domains = cdb;/etc/mail/local_domains.cdb
7946 .endd
7947 The appropriate type of lookup is done on the file using the domain name as the
7948 key. In most cases, the data that is looked up is not used; Exim is interested
7949 only in whether or not the key is present in the file. However, when a lookup
7950 is used for the &%domains%& option on a router
7951 or a &%domains%& condition in an ACL statement, the data is preserved in the
7952 &$domain_data$& variable and can be referred to in other router options or
7953 other statements in the same ACL.
7954
7955 .next
7956 Any of the single-key lookup type names may be preceded by
7957 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7958 .code
7959 domains = partial-dbm;/partial/domains
7960 .endd
7961 This causes partial matching logic to be invoked; a description of how this
7962 works is given in section &<<SECTpartiallookup>>&.
7963
7964 .next
7965 .cindex "asterisk" "in lookup type"
7966 Any of the single-key lookup types may be followed by an asterisk. This causes
7967 a default lookup for a key consisting of a single asterisk to be done if the
7968 original lookup fails. This is not a useful feature when using a domain list to
7969 select particular domains (because any domain would match), but it might have
7970 value if the result of the lookup is being used via the &$domain_data$&
7971 expansion variable.
7972 .next
7973 If the pattern starts with the name of a query-style lookup type followed by a
7974 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7975 pattern must be an appropriate query for the lookup type, as described in
7976 chapter &<<CHAPfdlookup>>&. For example:
7977 .code
7978 hold_domains = mysql;select domain from holdlist \
7979   where domain = '${quote_mysql:$domain}';
7980 .endd
7981 In most cases, the data that is looked up is not used (so for an SQL query, for
7982 example, it doesn't matter what field you select). Exim is interested only in
7983 whether or not the query succeeds. However, when a lookup is used for the
7984 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7985 variable and can be referred to in other options.
7986 .next
7987 .cindex "domain list" "matching literal domain name"
7988 If none of the above cases apply, a caseless textual comparison is made
7989 between the pattern and the domain.
7990 .endlist
7991
7992 Here is an example that uses several different kinds of pattern:
7993 .code
7994 domainlist funny_domains = \
7995   @ : \
7996   lib.unseen.edu : \
7997   *.foundation.fict.example : \
7998   \N^[1-2]\d{3}\.fict\.example$\N : \
7999   partial-dbm;/opt/data/penguin/book : \
8000   nis;domains.byname : \
8001   nisplus;[name=$domain,status=local],domains.org_dir
8002 .endd
8003 There are obvious processing trade-offs among the various matching modes. Using
8004 an asterisk is faster than a regular expression, and listing a few names
8005 explicitly probably is too. The use of a file or database lookup is expensive,
8006 but may be the only option if hundreds of names are required. Because the
8007 patterns are tested in order, it makes sense to put the most commonly matched
8008 patterns earlier.
8009
8010
8011
8012 .section "Host lists" "SECThostlist"
8013 .cindex "host list" "patterns in"
8014 .cindex "list" "host list"
8015 Host lists are used to control what remote hosts are allowed to do. For
8016 example, some hosts may be allowed to use the local host as a relay, and some
8017 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8018 two different ways, by name or by IP address. In a host list, some types of
8019 pattern are matched to a host name, and some are matched to an IP address.
8020 You need to be particularly careful with this when single-key lookups are
8021 involved, to ensure that the right value is being used as the key.
8022
8023
8024 .section "Special host list patterns" "SECID80"
8025 .cindex "empty item in hosts list"
8026 .cindex "host list" "empty string in"
8027 If a host list item is the empty string, it matches only when no remote host is
8028 involved. This is the case when a message is being received from a local
8029 process using SMTP on the standard input, that is, when a TCP/IP connection is
8030 not used.
8031
8032 .cindex "asterisk" "in host list"
8033 The special pattern &"*"& in a host list matches any host or no host. Neither
8034 the IP address nor the name is actually inspected.
8035
8036
8037
8038 .section "Host list patterns that match by IP address" "SECThoslispatip"
8039 .cindex "host list" "matching IP addresses"
8040 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8041 the incoming address actually appears in the IPv6 host as
8042 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8043 list, it is converted into a traditional IPv4 address first. (Not all operating
8044 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8045 concerns.)
8046
8047 The following types of pattern in a host list check the remote host by
8048 inspecting its IP address:
8049
8050 .ilist
8051 If the pattern is a plain domain name (not a regular expression, not starting
8052 with *, not a lookup of any kind), Exim calls the operating system function
8053 to find the associated IP address(es). Exim uses the newer
8054 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8055 This typically causes a forward DNS lookup of the name. The result is compared
8056 with the IP address of the subject host.
8057
8058 If there is a temporary problem (such as a DNS timeout) with the host name
8059 lookup, a temporary error occurs. For example, if the list is being used in an
8060 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8061 temporary SMTP error code. If no IP address can be found for the host name,
8062 what happens is described in section &<<SECTbehipnot>>& below.
8063
8064 .next
8065 .cindex "@ in a host list"
8066 If the pattern is &"@"&, the primary host name is substituted and used as a
8067 domain name, as just described.
8068
8069 .next
8070 If the pattern is an IP address, it is matched against the IP address of the
8071 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8072 IPv6 addresses can be given in colon-separated format, but the colons have to
8073 be doubled so as not to be taken as item separators when the default list
8074 separator is used. IPv6 addresses are recognized even when Exim is compiled
8075 without IPv6 support. This means that if they appear in a host list on an
8076 IPv4-only host, Exim will not treat them as host names. They are just addresses
8077 that can never match a client host.
8078
8079 .next
8080 .cindex "@[] in a host list"
8081 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8082 the local host. For example, if the local host is an IPv4 host with one
8083 interface address 10.45.23.56, these two ACL statements have the same effect:
8084 .code
8085 accept hosts = 127.0.0.1 : 10.45.23.56
8086 accept hosts = @[]
8087 .endd
8088 .next
8089 .cindex "CIDR notation"
8090 If the pattern is an IP address followed by a slash and a mask length (for
8091 example 10.11.42.0/24), it is matched against the IP address of the subject
8092 host under the given mask. This allows, an entire network of hosts to be
8093 included (or excluded) by a single item. The mask uses CIDR notation; it
8094 specifies the number of address bits that must match, starting from the most
8095 significant end of the address.
8096
8097 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8098 of a range of addresses. It is the number of bits in the network portion of the
8099 address. The above example specifies a 24-bit netmask, so it matches all 256
8100 addresses in the 10.11.42.0 network. An item such as
8101 .code
8102 192.168.23.236/31
8103 .endd
8104 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8105 32 for an IPv4 address is the same as no mask at all; just a single address
8106 matches.
8107
8108 Here is another example which shows an IPv4 and an IPv6 network:
8109 .code
8110 recipient_unqualified_hosts = 192.168.0.0/16: \
8111                               3ffe::ffff::836f::::/48
8112 .endd
8113 The doubling of list separator characters applies only when these items
8114 appear inline in a host list. It is not required when indirecting via a file.
8115 For example:
8116 .code
8117 recipient_unqualified_hosts = /opt/exim/unqualnets
8118 .endd
8119 could make use of a file containing
8120 .code
8121 172.16.0.0/12
8122 3ffe:ffff:836f::/48
8123 .endd
8124 to have exactly the same effect as the previous example. When listing IPv6
8125 addresses inline, it is usually more convenient to use the facility for
8126 changing separator characters. This list contains the same two networks:
8127 .code
8128 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8129                                  3ffe:ffff:836f::/48
8130 .endd
8131 The separator is changed to semicolon by the leading &"<;"& at the start of the
8132 list.
8133 .endlist
8134
8135
8136
8137 .section "Host list patterns for single-key lookups by host address" &&&
8138          "SECThoslispatsikey"
8139 .cindex "host list" "lookup of IP address"
8140 When a host is to be identified by a single-key lookup of its complete IP
8141 address, the pattern takes this form:
8142 .display
8143 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8144 .endd
8145 For example:
8146 .code
8147 hosts_lookup = net-cdb;/hosts-by-ip.db
8148 .endd
8149 The text form of the IP address of the subject host is used as the lookup key.
8150 IPv6 addresses are converted to an unabbreviated form, using lower case
8151 letters, with dots as separators because colon is the key terminator in
8152 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8153 quoting the keys, but this is a facility that was added later.] The data
8154 returned by the lookup is not used.
8155
8156 .cindex "IP address" "masking"
8157 .cindex "host list" "masked IP address"
8158 Single-key lookups can also be performed using masked IP addresses, using
8159 patterns of this form:
8160 .display
8161 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8162 .endd
8163 For example:
8164 .code
8165 net24-dbm;/networks.db
8166 .endd
8167 The IP address of the subject host is masked using <&'number'&> as the mask
8168 length. A textual string is constructed from the masked value, followed by the
8169 mask, and this is used as the lookup key. For example, if the host's IP address
8170 is 192.168.34.6, the key that is looked up for the above example is
8171 &"192.168.34.0/24"&.
8172
8173 When an IPv6 address is converted to a string, dots are normally used instead
8174 of colons, so that keys in &(lsearch)& files need not contain colons (which
8175 terminate &(lsearch)& keys). This was implemented some time before the ability
8176 to quote keys was made available in &(lsearch)& files. However, the more
8177 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8178 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8179 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8180 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8181 addresses are always used.
8182
8183 Ideally, it would be nice to tidy up this anomalous situation by changing to
8184 colons in all cases, given that quoting is now available for &(lsearch)&.
8185 However, this would be an incompatible change that might break some existing
8186 configurations.
8187
8188 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8189 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8190 the former case the key strings include the mask value, whereas in the latter
8191 case the IP address is used on its own.
8192
8193
8194
8195 .section "Host list patterns that match by host name" "SECThoslispatnam"
8196 .cindex "host" "lookup failures"
8197 .cindex "unknown host name"
8198 .cindex "host list" "matching host name"
8199 There are several types of pattern that require Exim to know the name of the
8200 remote host. These are either wildcard patterns or lookups by name. (If a
8201 complete hostname is given without any wildcarding, it is used to find an IP
8202 address to match against, as described in section &<<SECThoslispatip>>&
8203 above.)
8204
8205 If the remote host name is not already known when Exim encounters one of these
8206 patterns, it has to be found from the IP address.
8207 Although many sites on the Internet are conscientious about maintaining reverse
8208 DNS data for their hosts, there are also many that do not do this.
8209 Consequently, a name cannot always be found, and this may lead to unwanted
8210 effects. Take care when configuring host lists with wildcarded name patterns.
8211 Consider what will happen if a name cannot be found.
8212
8213 Because of the problems of determining host names from IP addresses, matching
8214 against host names is not as common as matching against IP addresses.
8215
8216 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8217 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8218 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8219 are done can be changed by setting the &%host_lookup_order%& option. For
8220 security, once Exim has found one or more names, it looks up the IP addresses
8221 for these names and compares them with the IP address that it started with.
8222 Only those names whose IP addresses match are accepted. Any other names are
8223 discarded. If no names are left, Exim behaves as if the host name cannot be
8224 found. In the most common case there is only one name and one IP address.
8225
8226 There are some options that control what happens if a host name cannot be
8227 found. These are described in section &<<SECTbehipnot>>& below.
8228
8229 .cindex "host" "alias for"
8230 .cindex "alias for host"
8231 As a result of aliasing, hosts may have more than one name. When processing any
8232 of the following types of pattern, all the host's names are checked:
8233
8234 .ilist
8235 .cindex "asterisk" "in host list"
8236 If a pattern starts with &"*"& the remainder of the item must match the end of
8237 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8238 &'.b.c'&. This special simple form is provided because this is a very common
8239 requirement. Other kinds of wildcarding require the use of a regular
8240 expression.
8241 .next
8242 .cindex "regular expressions" "in host list"
8243 .cindex "host list" "regular expression in"
8244 If the item starts with &"^"& it is taken to be a regular expression which is
8245 matched against the host name. Host names are case-independent, so this regular
8246 expression match is by default case-independent, but you can make it
8247 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8248 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8249 example,
8250 .code
8251 ^(a|b)\.c\.d$
8252 .endd
8253 is a regular expression that matches either of the two hosts &'a.c.d'& or
8254 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8255 that backslash and dollar characters are not misinterpreted as part of the
8256 string expansion. The simplest way to do this is to use &`\N`& to mark that
8257 part of the string as non-expandable. For example:
8258 .code
8259 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8260 .endd
8261 &*Warning*&: If you want to match a complete host name, you must include the
8262 &`$`& terminating metacharacter in the regular expression, as in the above
8263 example. Without it, a match at the start of the host name is all that is
8264 required.
8265 .endlist
8266
8267
8268
8269
8270 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8271 .cindex "host" "lookup failures, permanent"
8272 While processing a host list, Exim may need to look up an IP address from a
8273 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8274 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8275 behaviour when it fails to find the information it is seeking is the same.
8276
8277 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8278 apply to temporary DNS errors, whose handling is described in the next section.
8279
8280 .cindex "&`+include_unknown`&"
8281 .cindex "&`+ignore_unknown`&"
8282 Exim parses a host list from left to right. If it encounters a permanent
8283 lookup failure in any item in the host list before it has found a match,
8284 Exim treats it as a failure and the default behavior is as if the host
8285 does not match the list. This may not always be what you want to happen.
8286 To change Exim's behaviour, the special items &`+include_unknown`& or
8287 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8288 not recognized in an indirected file).
8289
8290 .ilist
8291 If any item that follows &`+include_unknown`& requires information that
8292 cannot found, Exim behaves as if the host does match the list. For example,
8293 .code
8294 host_reject_connection = +include_unknown:*.enemy.ex
8295 .endd
8296 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8297 any hosts whose name it cannot find.
8298
8299 .next
8300 If any item that follows &`+ignore_unknown`& requires information that cannot
8301 be found, Exim ignores that item and proceeds to the rest of the list. For
8302 example:
8303 .code
8304 accept hosts = +ignore_unknown : friend.example : \
8305                192.168.4.5
8306 .endd
8307 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8308 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8309 name can be found for 192.168.4.5, it is rejected.
8310 .endlist
8311
8312 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8313 list. The effect of each one lasts until the next, or until the end of the
8314 list.
8315
8316 .new
8317 To explain the host/ip processing logic a different way for the same ACL:
8318
8319 .ilist
8320 If you have name lookups or wildcarded host names and
8321 IP addresses in the same host list, you should normally put the IP
8322 addresses first. For example, in an ACL you could have:
8323 .code
8324 accept hosts = 10.9.8.7 : *.friend.example
8325 .endd
8326 The reason you normally would order it this way lies in the
8327 left-to-right way that Exim processes lists.  It can test IP addresses
8328 without doing any DNS lookups, but when it reaches an item that requires
8329 a host name, it fails if it cannot find a host name to compare with the
8330 pattern. If the above list is given in the opposite order, the
8331 &%accept%& statement fails for a host whose name cannot be found, even
8332 if its IP address is 10.9.8.7.
8333
8334 .next
8335 If you really do want to do the name check first, and still recognize the IP
8336 address, you can rewrite the ACL like this:
8337 .code
8338 accept hosts = *.friend.example
8339 accept hosts = 10.9.8.7
8340 .endd
8341 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8342 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8343 &`+ignore_unknown`&, which was discussed in depth in the first example in
8344 this section.
8345 .endlist
8346 .wen
8347
8348
8349
8350 .section "Temporary DNS errors when looking up host information" &&&
8351          "SECTtemdnserr"
8352 .cindex "host" "lookup failures, temporary"
8353 .cindex "&`+include_defer`&"
8354 .cindex "&`+ignore_defer`&"
8355 A temporary DNS lookup failure normally causes a defer action (except when
8356 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8357 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8358 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8359 section. These options should be used with care, probably only in non-critical
8360 host lists such as whitelists.
8361
8362
8363
8364 .section "Host list patterns for single-key lookups by host name" &&&
8365          "SECThoslispatnamsk"
8366 .cindex "unknown host name"
8367 .cindex "host list" "matching host name"
8368 If a pattern is of the form
8369 .display
8370 <&'single-key-search-type'&>;<&'search-data'&>
8371 .endd
8372 for example
8373 .code
8374 dbm;/host/accept/list
8375 .endd
8376 a single-key lookup is performed, using the host name as its key. If the
8377 lookup succeeds, the host matches the item. The actual data that is looked up
8378 is not used.
8379
8380 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8381 keys in the file, not IP addresses. If you want to do lookups based on IP
8382 addresses, you must precede the search type with &"net-"& (see section
8383 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8384 two items in the same list, one doing an address lookup and one doing a name
8385 lookup, both using the same file.
8386
8387
8388
8389 .section "Host list patterns for query-style lookups" "SECID81"
8390 If a pattern is of the form
8391 .display
8392 <&'query-style-search-type'&>;<&'query'&>
8393 .endd
8394 the query is obeyed, and if it succeeds, the host matches the item. The actual
8395 data that is looked up is not used. The variables &$sender_host_address$& and
8396 &$sender_host_name$& can be used in the query. For example:
8397 .code
8398 hosts_lookup = pgsql;\
8399   select ip from hostlist where ip='$sender_host_address'
8400 .endd
8401 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8402 can use the &%sg%& expansion item to change this if you need to. If you want to
8403 use masked IP addresses in database queries, you can use the &%mask%& expansion
8404 operator.
8405
8406 If the query contains a reference to &$sender_host_name$&, Exim automatically
8407 looks up the host name if it has not already done so. (See section
8408 &<<SECThoslispatnam>>& for comments on finding host names.)
8409
8410 Historical note: prior to release 4.30, Exim would always attempt to find a
8411 host name before running the query, unless the search type was preceded by
8412 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8413 still recognized for query-style lookups, but its presence or absence has no
8414 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8415 See section &<<SECThoslispatsikey>>&.)
8416
8417
8418
8419 .section "Mixing wildcarded host names and addresses in host lists" &&&
8420          "SECTmixwilhos"
8421 .cindex "host list" "mixing names and addresses in"
8422 If you have name lookups or wildcarded host names and IP addresses in the same
8423 host list, you should normally put the IP addresses first. For example, in an
8424 ACL you could have:
8425 .code
8426 accept hosts = 10.9.8.7 : *.friend.example
8427 .endd
8428 The reason for this lies in the left-to-right way that Exim processes lists.
8429 It can test IP addresses without doing any DNS lookups, but when it reaches an
8430 item that requires a host name, it fails if it cannot find a host name to
8431 compare with the pattern. If the above list is given in the opposite order, the
8432 &%accept%& statement fails for a host whose name cannot be found, even if its
8433 IP address is 10.9.8.7.
8434
8435 If you really do want to do the name check first, and still recognize the IP
8436 address, you can rewrite the ACL like this:
8437 .code
8438 accept hosts = *.friend.example
8439 accept hosts = 10.9.8.7
8440 .endd
8441 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8442 &<<CHAPACL>>& for details of ACLs.
8443
8444
8445
8446
8447
8448 .section "Address lists" "SECTaddresslist"
8449 .cindex "list" "address list"
8450 .cindex "address list" "empty item"
8451 .cindex "address list" "patterns"
8452 Address lists contain patterns that are matched against mail addresses. There
8453 is one special case to be considered: the sender address of a bounce message is
8454 always empty. You can test for this by providing an empty item in an address
8455 list. For example, you can set up a router to process bounce messages by
8456 using this option setting:
8457 .code
8458 senders = :
8459 .endd
8460 The presence of the colon creates an empty item. If you do not provide any
8461 data, the list is empty and matches nothing. The empty sender can also be
8462 detected by a regular expression that matches an empty string,
8463 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8464
8465 Non-empty items in an address list can be straightforward email addresses. For
8466 example:
8467 .code
8468 senders = jbc@askone.example : hs@anacreon.example
8469 .endd
8470 A certain amount of wildcarding is permitted. If a pattern contains an @
8471 character, but is not a regular expression and does not begin with a
8472 semicolon-terminated lookup type (described below), the local part of the
8473 subject address is compared with the local part of the pattern, which may start
8474 with an asterisk. If the local parts match, the domain is checked in exactly
8475 the same way as for a pattern in a domain list. For example, the domain can be
8476 wildcarded, refer to a named list, or be a lookup:
8477 .code
8478 deny senders = *@*.spamming.site:\
8479                *@+hostile_domains:\
8480                bozo@partial-lsearch;/list/of/dodgy/sites:\
8481                *@dbm;/bad/domains.db
8482 .endd
8483 .cindex "local part" "starting with !"
8484 .cindex "address list" "local part starting with !"
8485 If a local part that begins with an exclamation mark is required, it has to be
8486 specified using a regular expression, because otherwise the exclamation mark is
8487 treated as a sign of negation, as is standard in lists.
8488
8489 If a non-empty pattern that is not a regular expression or a lookup does not
8490 contain an @ character, it is matched against the domain part of the subject
8491 address. The only two formats that are recognized this way are a literal
8492 domain, or a domain pattern that starts with *. In both these cases, the effect
8493 is the same as if &`*@`& preceded the pattern. For example:
8494 .code
8495 deny senders = enemy.domain : *.enemy.domain
8496 .endd
8497
8498 The following kinds of more complicated address list pattern can match any
8499 address, including the empty address that is characteristic of bounce message
8500 senders:
8501
8502 .ilist
8503 .cindex "regular expressions" "in address list"
8504 .cindex "address list" "regular expression in"
8505 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8506 done against the complete address, with the pattern as the regular expression.
8507 You must take care that backslash and dollar characters are not misinterpreted
8508 as part of the string expansion. The simplest way to do this is to use &`\N`&
8509 to mark that part of the string as non-expandable. For example:
8510 .code
8511 deny senders = \N^.*this.*@example\.com$\N : \
8512                \N^\d{8}.+@spamhaus.example$\N : ...
8513 .endd
8514 The &`\N`& sequences are removed by the expansion, so these items do indeed
8515 start with &"^"& by the time they are being interpreted as address patterns.
8516
8517 .next
8518 .cindex "address list" "lookup for complete address"
8519 Complete addresses can be looked up by using a pattern that starts with a
8520 lookup type terminated by a semicolon, followed by the data for the lookup. For
8521 example:
8522 .code
8523 deny senders = cdb;/etc/blocked.senders : \
8524   mysql;select address from blocked where \
8525   address='${quote_mysql:$sender_address}'
8526 .endd
8527 Both query-style and single-key lookup types can be used. For a single-key
8528 lookup type, Exim uses the complete address as the key. However, empty keys are
8529 not supported for single-key lookups, so a match against the empty address
8530 always fails. This restriction does not apply to query-style lookups.
8531
8532 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8533 cannot be used, and is ignored if specified, with an entry being written to the
8534 panic log.
8535 .cindex "*@ with single-key lookup"
8536 However, you can configure lookup defaults, as described in section
8537 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8538 default. For example, with this lookup:
8539 .code
8540 accept senders = lsearch*@;/some/file
8541 .endd
8542 the file could contains lines like this:
8543 .code
8544 user1@domain1.example
8545 *@domain2.example
8546 .endd
8547 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8548 that are tried is:
8549 .code
8550 nimrod@jaeger.example
8551 *@jaeger.example
8552 *
8553 .endd
8554 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8555 would mean that every address matches, thus rendering the test useless.
8556
8557 &*Warning 2*&: Do not confuse these two kinds of item:
8558 .code
8559 deny recipients = dbm*@;/some/file
8560 deny recipients = *@dbm;/some/file
8561 .endd
8562 The first does a whole address lookup, with defaulting, as just described,
8563 because it starts with a lookup type. The second matches the local part and
8564 domain independently, as described in a bullet point below.
8565 .endlist
8566
8567
8568 The following kinds of address list pattern can match only non-empty addresses.
8569 If the subject address is empty, a match against any of these pattern types
8570 always fails.
8571
8572
8573 .ilist
8574 .cindex "@@ with single-key lookup"
8575 .cindex "address list" "@@ lookup type"
8576 .cindex "address list" "split local part and domain"
8577 If a pattern starts with &"@@"& followed by a single-key lookup item
8578 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8579 split into a local part and a domain. The domain is looked up in the file. If
8580 it is not found, there is no match. If it is found, the data that is looked up
8581 from the file is treated as a colon-separated list of local part patterns, each
8582 of which is matched against the subject local part in turn.
8583
8584 .cindex "asterisk" "in address list"
8585 The lookup may be a partial one, and/or one involving a search for a default
8586 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8587 patterns that are looked up can be regular expressions or begin with &"*"&, or
8588 even be further lookups. They may also be independently negated. For example,
8589 with
8590 .code
8591 deny senders = @@dbm;/etc/reject-by-domain
8592 .endd
8593 the data from which the DBM file is built could contain lines like
8594 .code
8595 baddomain.com:  !postmaster : *
8596 .endd
8597 to reject all senders except &%postmaster%& from that domain.
8598
8599 .cindex "local part" "starting with !"
8600 If a local part that actually begins with an exclamation mark is required, it
8601 has to be specified using a regular expression. In &(lsearch)& files, an entry
8602 may be split over several lines by indenting the second and subsequent lines,
8603 but the separating colon must still be included at line breaks. White space
8604 surrounding the colons is ignored. For example:
8605 .code
8606 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8607   spammer3 : spammer4
8608 .endd
8609 As in all colon-separated lists in Exim, a colon can be included in an item by
8610 doubling.
8611
8612 If the last item in the list starts with a right angle-bracket, the remainder
8613 of the item is taken as a new key to look up in order to obtain a continuation
8614 list of local parts. The new key can be any sequence of characters. Thus one
8615 might have entries like
8616 .code
8617 aol.com: spammer1 : spammer 2 : >*
8618 xyz.com: spammer3 : >*
8619 *:       ^\d{8}$
8620 .endd
8621 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8622 local parts for all domains, in addition to the specific local parts listed for
8623 each domain. Of course, using this feature costs another lookup each time a
8624 chain is followed, but the effort needed to maintain the data is reduced.
8625
8626 .cindex "loop" "in lookups"
8627 It is possible to construct loops using this facility, and in order to catch
8628 them, the chains may be no more than fifty items long.
8629
8630 .next
8631 The @@<&'lookup'&> style of item can also be used with a query-style
8632 lookup, but in this case, the chaining facility is not available. The lookup
8633 can only return a single list of local parts.
8634 .endlist
8635
8636 &*Warning*&: There is an important difference between the address list items
8637 in these two examples:
8638 .code
8639 senders = +my_list
8640 senders = *@+my_list
8641 .endd
8642 In the first one, &`my_list`& is a named address list, whereas in the second
8643 example it is a named domain list.
8644
8645
8646
8647
8648 .section "Case of letters in address lists" "SECTcasletadd"
8649 .cindex "case of local parts"
8650 .cindex "address list" "case forcing"
8651 .cindex "case forcing in address lists"
8652 Domains in email addresses are always handled caselessly, but for local parts
8653 case may be significant on some systems (see &%caseful_local_part%& for how
8654 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8655 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8656 blocking lists should be done in a case-independent manner. Since most address
8657 lists in Exim are used for this kind of control, Exim attempts to do this by
8658 default.
8659
8660 The domain portion of an address is always lowercased before matching it to an
8661 address list. The local part is lowercased by default, and any string
8662 comparisons that take place are done caselessly. This means that the data in
8663 the address list itself, in files included as plain file names, and in any file
8664 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8665 keys in files that are looked up by a search type other than &(lsearch)& (which
8666 works caselessly) must be in lower case, because these lookups are not
8667 case-independent.
8668
8669 .cindex "&`+caseful`&"
8670 To allow for the possibility of caseful address list matching, if an item in
8671 an address list is the string &"+caseful"&, the original case of the local
8672 part is restored for any comparisons that follow, and string comparisons are no
8673 longer case-independent. This does not affect the domain, which remains in
8674 lower case. However, although independent matches on the domain alone are still
8675 performed caselessly, regular expressions that match against an entire address
8676 become case-sensitive after &"+caseful"& has been seen.
8677
8678
8679
8680 .section "Local part lists" "SECTlocparlis"
8681 .cindex "list" "local part list"
8682 .cindex "local part" "list"
8683 Case-sensitivity in local part lists is handled in the same way as for address
8684 lists, as just described. The &"+caseful"& item can be used if required. In a
8685 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8686 set false, the subject is lowercased and the matching is initially
8687 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8688 matching in the local part list, but not elsewhere in the router. If
8689 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8690 option is case-sensitive from the start.
8691
8692 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8693 comments are handled in the same way as address lists &-- they are recognized
8694 only if the # is preceded by white space or the start of the line.
8695 Otherwise, local part lists are matched in the same way as domain lists, except
8696 that the special items that refer to the local host (&`@`&, &`@[]`&,
8697 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8698 Refer to section &<<SECTdomainlist>>& for details of the other available item
8699 types.
8700 .ecindex IIDdohoadli
8701
8702
8703
8704
8705 . ////////////////////////////////////////////////////////////////////////////
8706 . ////////////////////////////////////////////////////////////////////////////
8707
8708 .chapter "String expansions" "CHAPexpand"
8709 .scindex IIDstrexp "expansion" "of strings"
8710 Many strings in Exim's run time configuration are expanded before use. Some of
8711 them are expanded every time they are used; others are expanded only once.
8712
8713 When a string is being expanded it is copied verbatim from left to right except
8714 when a dollar or backslash character is encountered. A dollar specifies the
8715 start of a portion of the string that is interpreted and replaced as described
8716 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8717 escape character, as described in the following section.
8718
8719 Whether a string is expanded depends upon the context.  Usually this is solely
8720 dependent upon the option for which a value is sought; in this documentation,
8721 options for which string expansion is performed are marked with &dagger; after
8722 the data type.  ACL rules always expand strings.  A couple of expansion
8723 conditions do not expand some of the brace-delimited branches, for security
8724 reasons.
8725
8726
8727
8728 .section "Literal text in expanded strings" "SECTlittext"
8729 .cindex "expansion" "including literal text"
8730 An uninterpreted dollar can be included in an expanded string by putting a
8731 backslash in front of it. A backslash can be used to prevent any special
8732 character being treated specially in an expansion, including backslash itself.
8733 If the string appears in quotes in the configuration file, two backslashes are
8734 required because the quotes themselves cause interpretation of backslashes when
8735 the string is read in (see section &<<SECTstrings>>&).
8736
8737 .cindex "expansion" "non-expandable substrings"
8738 A portion of the string can specified as non-expandable by placing it between
8739 two occurrences of &`\N`&. This is particularly useful for protecting regular
8740 expressions, which often contain backslashes and dollar signs. For example:
8741 .code
8742 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8743 .endd
8744 On encountering the first &`\N`&, the expander copies subsequent characters
8745 without interpretation until it reaches the next &`\N`& or the end of the
8746 string.
8747
8748
8749
8750 .section "Character escape sequences in expanded strings" "SECID82"
8751 .cindex "expansion" "escape sequences"
8752 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8753 expanded string is recognized as an escape sequence for the character newline,
8754 carriage return, or tab, respectively. A backslash followed by up to three
8755 octal digits is recognized as an octal encoding for a single character, and a
8756 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8757 encoding.
8758
8759 These escape sequences are also recognized in quoted strings when they are read
8760 in. Their interpretation in expansions as well is useful for unquoted strings,
8761 and for other cases such as looked-up strings that are then expanded.
8762
8763
8764 .section "Testing string expansions" "SECID83"
8765 .cindex "expansion" "testing"
8766 .cindex "testing" "string expansion"
8767 .oindex "&%-be%&"
8768 Many expansions can be tested by calling Exim with the &%-be%& option. This
8769 takes the command arguments, or lines from the standard input if there are no
8770 arguments, runs them through the string expansion code, and writes the results
8771 to the standard output. Variables based on configuration values are set up, but
8772 since no message is being processed, variables such as &$local_part$& have no
8773 value. Nevertheless the &%-be%& option can be useful for checking out file and
8774 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8775 and &%nhash%&.
8776
8777 Exim gives up its root privilege when it is called with the &%-be%& option, and
8778 instead runs under the uid and gid it was called with, to prevent users from
8779 using &%-be%& for reading files to which they do not have access.
8780
8781 .oindex "&%-bem%&"
8782 If you want to test expansions that include variables whose values are taken
8783 from a message, there are two other options that can be used. The &%-bem%&
8784 option is like &%-be%& except that it is followed by a file name. The file is
8785 read as a message before doing the test expansions. For example:
8786 .code
8787 exim -bem /tmp/test.message '$h_subject:'
8788 .endd
8789 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8790 Exim message identifier. For example:
8791 .code
8792 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8793 .endd
8794 This loads the message from Exim's spool before doing the test expansions, and
8795 is therefore restricted to admin users.
8796
8797
8798 .section "Forced expansion failure" "SECTforexpfai"
8799 .cindex "expansion" "forced failure"
8800 A number of expansions that are described in the following section have
8801 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8802 (which are sometimes called &"curly brackets"&). Which of the two strings is
8803 used depends on some condition that is evaluated as part of the expansion. If,
8804 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8805 the entire string expansion fails in a way that can be detected by the code
8806 that requested the expansion. This is called &"forced expansion failure"&, and
8807 its consequences depend on the circumstances. In some cases it is no different
8808 from any other expansion failure, but in others a different action may be
8809 taken. Such variations are mentioned in the documentation of the option that is
8810 being expanded.
8811
8812
8813
8814
8815 .section "Expansion items" "SECTexpansionitems"
8816 The following items are recognized in expanded strings. White space may be used
8817 between sub-items that are keywords or substrings enclosed in braces inside an
8818 outer set of braces, to improve readability. &*Warning*&: Within braces,
8819 white space is significant.
8820
8821 .vlist
8822 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8823 .cindex "expansion" "variables"
8824 Substitute the contents of the named variable, for example:
8825 .code
8826 $local_part
8827 ${domain}
8828 .endd
8829 The second form can be used to separate the name from subsequent alphanumeric
8830 characters. This form (using braces) is available only for variables; it does
8831 &'not'& apply to message headers. The names of the variables are given in
8832 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8833 given, the expansion fails.
8834
8835 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8836 .cindex "expansion" "operators"
8837 The string is first itself expanded, and then the operation specified by
8838 <&'op'&> is applied to it. For example:
8839 .code
8840 ${lc:$local_part}
8841 .endd
8842 The string starts with the first character after the colon, which may be
8843 leading white space. A list of operators is given in section &<<SECTexpop>>&
8844 below. The operator notation is used for simple expansion items that have just
8845 one argument, because it reduces the number of braces and therefore makes the
8846 string easier to understand.
8847
8848 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8849 This item inserts &"basic"& header lines. It is described with the &%header%&
8850 expansion item below.
8851
8852
8853 .new
8854 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8855 .cindex "expansion" "calling an acl"
8856 .cindex "&%acl%&" "call from expansion"
8857 The name and zero to nine argument strings are first expanded separately.  The expanded
8858 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8859 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8860 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8861 and may use the variables; if another acl expansion is used the values
8862 are restored after it returns.  If the ACL sets
8863 a value using a "message =" modifier and returns accept or deny, the value becomes
8864 the result of the expansion.
8865 If no message is set and the ACL returns accept or deny
8866 the expansion result is an empty string.
8867 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8868 .wen
8869
8870
8871 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8872        {*&<&'arg'&>&*}...}*&"
8873 .cindex &%dlfunc%&
8874 This expansion dynamically loads and then calls a locally-written C function.
8875 This functionality is available only if Exim is compiled with
8876 .code
8877 EXPAND_DLFUNC=yes
8878 .endd
8879 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8880 object so that it doesn't reload the same object file in the same Exim process
8881 (but of course Exim does start new processes frequently).
8882
8883 There may be from zero to eight arguments to the function. When compiling
8884 a local function that is to be called in this way, &_local_scan.h_& should be
8885 included. The Exim variables and functions that are defined by that API
8886 are also available for dynamically loaded functions. The function itself
8887 must have the following type:
8888 .code
8889 int dlfunction(uschar **yield, int argc, uschar *argv[])
8890 .endd
8891 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8892 function should return one of the following values:
8893
8894 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8895 into the expanded string that is being built.
8896
8897 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8898 from &'yield'&, if it is set.
8899
8900 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8901 taken from &'yield'& if it is set.
8902
8903 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8904
8905 When compiling a function that is to be used in this way with gcc,
8906 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8907 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8908
8909 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8910        {*&<&'string3'&>&*}}*&"
8911 .cindex "expansion" "extracting substrings by key"
8912 .cindex "&%extract%&" "substrings by key"
8913 The key and <&'string1'&> are first expanded separately. Leading and trailing
8914 white space is removed from the key (but not from any of the strings). The key
8915 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8916 form:
8917 .display
8918 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8919 .endd
8920 .vindex "&$value$&"
8921 where the equals signs and spaces (but not both) are optional. If any of the
8922 values contain white space, they must be enclosed in double quotes, and any
8923 values that are enclosed in double quotes are subject to escape processing as
8924 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8925 for the value that corresponds to the key. The search is case-insensitive. If
8926 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8927 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8928 variable &$value$& contains the value that has been extracted. Afterwards, it
8929 is restored to any previous value it might have had.
8930
8931 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8932 key is not found. If {<&'string2'&>} is also omitted, the value that was
8933 extracted is used. Thus, for example, these two expansions are identical, and
8934 yield &"2001"&:
8935 .code
8936 ${extract{gid}{uid=1984 gid=2001}}
8937 ${extract{gid}{uid=1984 gid=2001}{$value}}
8938 .endd
8939 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8940 appear, for example:
8941 .code
8942 ${extract{Z}{A=... B=...}{$value} fail }
8943 .endd
8944 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8945 {<&'string2'&>} must be present for &"fail"& to be recognized.
8946
8947
8948 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8949         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8950 .cindex "expansion" "extracting substrings by number"
8951 .cindex "&%extract%&" "substrings by number"
8952 The <&'number'&> argument must consist entirely of decimal digits,
8953 apart from leading and trailing white space, which is ignored.
8954 This is what distinguishes this form of &%extract%& from the previous kind. It
8955 behaves in the same way, except that, instead of extracting a named field, it
8956 extracts from <&'string1'&> the field whose number is given as the first
8957 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8958 <&'string3'&> as before.
8959
8960 The fields in the string are separated by any one of the characters in the
8961 separator string. These may include space or tab characters.
8962 The first field is numbered one. If the number is negative, the fields are
8963 counted from the end of the string, with the rightmost one numbered -1. If the
8964 number given is zero, the entire string is returned. If the modulus of the
8965 number is greater than the number of fields in the string, the result is the
8966 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8967 provided. For example:
8968 .code
8969 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8970 .endd
8971 yields &"42"&, and
8972 .code
8973 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8974 .endd
8975 yields &"99"&. Two successive separators mean that the field between them is
8976 empty (for example, the fifth field above).
8977
8978
8979 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8980 .cindex "list" "selecting by condition"
8981 .cindex "expansion" "selecting from list by condition"
8982 .vindex "&$item$&"
8983 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8984 default, but the separator can be changed in the usual way. For each item
8985 in this list, its value is place in &$item$&, and then the condition is
8986 evaluated. If the condition is true, &$item$& is added to the output as an
8987 item in a new list; if the condition is false, the item is discarded. The
8988 separator used for the output list is the same as the one used for the
8989 input, but a separator setting is not included in the output. For example:
8990 .code
8991 ${filter{a:b:c}{!eq{$item}{b}}
8992 .endd
8993 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8994 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8995
8996
8997 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8998 .cindex "hash function" "textual"
8999 .cindex "expansion" "textual hash"
9000 This is a textual hashing function, and was the first to be implemented in
9001 early versions of Exim. In current releases, there are other hashing functions
9002 (numeric, MD5, and SHA-1), which are described below.
9003
9004 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9005 <&'n'&>. If you are using fixed values for these numbers, that is, if
9006 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9007 use the simpler operator notation that avoids some of the braces:
9008 .code
9009 ${hash_<n>_<m>:<string>}
9010 .endd
9011 The second number is optional (in both notations). If <&'n'&> is greater than
9012 or equal to the length of the string, the expansion item returns the string.
9013 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9014 function to the string. The new string consists of characters taken from the
9015 first <&'m'&> characters of the string
9016 .code
9017 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9018 .endd
9019 If <&'m'&> is not present the value 26 is used, so that only lower case
9020 letters appear. For example:
9021 .display
9022 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9023 &`$hash{5}{monty}}           `&   yields  &`monty`&
9024 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9025 .endd
9026
9027 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9028         &*$h_*&<&'header&~name'&>&*:*&" &&&
9029        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9030         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9031        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9032         &*$rh_*&<&'header&~name'&>&*:*&"
9033 .cindex "expansion" "header insertion"
9034 .vindex "&$header_$&"
9035 .vindex "&$bheader_$&"
9036 .vindex "&$rheader_$&"
9037 .cindex "header lines" "in expansion strings"
9038 .cindex "header lines" "character sets"
9039 .cindex "header lines" "decoding"
9040 Substitute the contents of the named message header line, for example
9041 .code
9042 $header_reply-to:
9043 .endd
9044 The newline that terminates a header line is not included in the expansion, but
9045 internal newlines (caused by splitting the header line over several physical
9046 lines) may be present.
9047
9048 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9049 the data in the header line is interpreted.
9050
9051 .ilist
9052 .cindex "white space" "in header lines"
9053 &%rheader%& gives the original &"raw"& content of the header line, with no
9054 processing at all, and without the removal of leading and trailing white space.
9055
9056 .next
9057 .cindex "base64 encoding" "in header lines"
9058 &%bheader%& removes leading and trailing white space, and then decodes base64
9059 or quoted-printable MIME &"words"& within the header text, but does no
9060 character set translation. If decoding of what looks superficially like a MIME
9061 &"word"& fails, the raw string is returned. If decoding
9062 .cindex "binary zero" "in header line"
9063 produces a binary zero character, it is replaced by a question mark &-- this is
9064 what Exim does for binary zeros that are actually received in header lines.
9065
9066 .next
9067 &%header%& tries to translate the string as decoded by &%bheader%& to a
9068 standard character set. This is an attempt to produce the same string as would
9069 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9070 returned. Translation is attempted only on operating systems that support the
9071 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9072 a system Makefile or in &_Local/Makefile_&.
9073 .endlist ilist
9074
9075 In a filter file, the target character set for &%header%& can be specified by a
9076 command of the following form:
9077 .code
9078 headers charset "UTF-8"
9079 .endd
9080 This command affects all references to &$h_$& (or &$header_$&) expansions in
9081 subsequently obeyed filter commands. In the absence of this command, the target
9082 character set in a filter is taken from the setting of the &%headers_charset%&
9083 option in the runtime configuration. The value of this option defaults to the
9084 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9085 ISO-8859-1.
9086
9087 Header names follow the syntax of RFC 2822, which states that they may contain
9088 any printing characters except space and colon. Consequently, curly brackets
9089 &'do not'& terminate header names, and should not be used to enclose them as
9090 if they were variables. Attempting to do so causes a syntax error.
9091
9092 Only header lines that are common to all copies of a message are visible to
9093 this mechanism. These are the original header lines that are received with the
9094 message, and any that are added by an ACL statement or by a system
9095 filter. Header lines that are added to a particular copy of a message by a
9096 router or transport are not accessible.
9097
9098 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9099 before the DATA ACL, because the header structure is not set up until the
9100 message is received. Header lines that are added in a RCPT ACL (for example)
9101 are saved until the message's incoming header lines are available, at which
9102 point they are added. When a DATA ACL is running, however, header lines added
9103 by earlier ACLs are visible.
9104
9105 Upper case and lower case letters are synonymous in header names. If the
9106 following character is white space, the terminating colon may be omitted, but
9107 this is not recommended, because you may then forget it when it is needed. When
9108 white space terminates the header name, it is included in the expanded string.
9109 If the message does not contain the given header, the expansion item is
9110 replaced by an empty string. (See the &%def%& condition in section
9111 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9112
9113 If there is more than one header with the same name, they are all concatenated
9114 to form the substitution string, up to a maximum length of 64K. Unless
9115 &%rheader%& is being used, leading and trailing white space is removed from
9116 each header before concatenation, and a completely empty header is ignored. A
9117 newline character is then inserted between non-empty headers, but there is no
9118 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9119 those headers that contain lists of addresses, a comma is also inserted at the
9120 junctions between headers. This does not happen for the &%rheader%& expansion.
9121
9122
9123 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9124 .cindex "expansion" "hmac hashing"
9125 .cindex &%hmac%&
9126 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9127 shared secret and some text into a message authentication code, as specified in
9128 RFC 2104. This differs from &`${md5:secret_text...}`& or
9129 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9130 cryptographic hash, allowing for authentication that is not possible with MD5
9131 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9132 present. For example:
9133 .code
9134 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9135 .endd
9136 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9137 produces:
9138 .code
9139 dd97e3ba5d1a61b5006108f8c8252953
9140 .endd
9141 As an example of how this might be used, you might put in the main part of
9142 an Exim configuration:
9143 .code
9144 SPAMSCAN_SECRET=cohgheeLei2thahw
9145 .endd
9146 In a router or a transport you could then have:
9147 .code
9148 headers_add = \
9149   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9150   ${hmac{md5}{SPAMSCAN_SECRET}\
9151   {${primary_hostname},${message_exim_id},$h_message-id:}}
9152 .endd
9153 Then given a message, you can check where it was scanned by looking at the
9154 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9155 this header line is authentic by recomputing the authentication code from the
9156 host name, message ID and the &'Message-id:'& header line. This can be done
9157 using Exim's &%-be%& option, or by other means, for example by using the
9158 &'hmac_md5_hex()'& function in Perl.
9159
9160
9161 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9162 .cindex "expansion" "conditional"
9163 .cindex "&%if%&, expansion item"
9164 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9165 item; otherwise <&'string2'&> is used. The available conditions are described
9166 in section &<<SECTexpcond>>& below. For example:
9167 .code
9168 ${if eq {$local_part}{postmaster} {yes}{no} }
9169 .endd
9170 The second string need not be present; if it is not and the condition is not
9171 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9172 be present instead of the second string (without any curly brackets). In this
9173 case, the expansion is forced to fail if the condition is not true (see section
9174 &<<SECTforexpfai>>&).
9175
9176 If both strings are omitted, the result is the string &`true`& if the condition
9177 is true, and the empty string if the condition is false. This makes it less
9178 cumbersome to write custom ACL and router conditions. For example, instead of
9179 .code
9180 condition = ${if >{$acl_m4}{3}{true}{false}}
9181 .endd
9182 you can use
9183 .code
9184 condition = ${if >{$acl_m4}{3}}
9185 .endd
9186
9187 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9188 .cindex "expansion" "string truncation"
9189 .cindex "&%length%& expansion item"
9190 The &%length%& item is used to extract the initial portion of a string. Both
9191 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9192 you are using a fixed value for the number, that is, if <&'string1'&> does not
9193 change when expanded, you can use the simpler operator notation that avoids
9194 some of the braces:
9195 .code
9196 ${length_<n>:<string>}
9197 .endd
9198 The result of this item is either the first <&'n'&> characters or the whole
9199 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9200 &%strlen%&, which gives the length of a string.
9201
9202
9203 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9204         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9205 This is the first of one of two different types of lookup item, which are both
9206 described in the next item.
9207
9208 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9209         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9210 .cindex "expansion" "lookup in"
9211 .cindex "file" "lookups"
9212 .cindex "lookup" "in expanded string"
9213 The two forms of lookup item specify data lookups in files and databases, as
9214 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9215 lookups, and the second is used for query-style lookups. The <&'key'&>,
9216 <&'file'&>, and <&'query'&> strings are expanded before use.
9217
9218 If there is any white space in a lookup item which is part of a filter command,
9219 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9220 other place where white space is significant, the lookup item must be enclosed
9221 in double quotes. The use of data lookups in users' filter files may be locked
9222 out by the system administrator.
9223
9224 .vindex "&$value$&"
9225 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9226 During its expansion, the variable &$value$& contains the data returned by the
9227 lookup. Afterwards it reverts to the value it had previously (at the outer
9228 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9229 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9230 string on failure. If <&'string2'&> is provided, it can itself be a nested
9231 lookup, thus providing a mechanism for looking up a default value when the
9232 original lookup fails.
9233
9234 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9235 data for the outer lookup while the parameters of the second lookup are
9236 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9237 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9238 appear, and in this case, if the lookup fails, the entire expansion is forced
9239 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9240 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9241 successful lookup, and nothing in the case of failure.
9242
9243 For single-key lookups, the string &"partial"& is permitted to precede the
9244 search type in order to do partial matching, and * or *@ may follow a search
9245 type to request default lookups if the key does not match (see sections
9246 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9247
9248 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9249 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9250 and non-wild parts of the key during the expansion of the replacement text.
9251 They return to their previous values at the end of the lookup item.
9252
9253 This example looks up the postmaster alias in the conventional alias file:
9254 .code
9255 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9256 .endd
9257 This example uses NIS+ to look up the full name of the user corresponding to
9258 the local part of an address, forcing the expansion to fail if it is not found:
9259 .code
9260 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9261   {$value}fail}
9262 .endd
9263
9264
9265 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9266 .cindex "expansion" "list creation"
9267 .vindex "&$item$&"
9268 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9269 default, but the separator can be changed in the usual way. For each item
9270 in this list, its value is place in &$item$&, and then <&'string2'&> is
9271 expanded and added to the output as an item in a new list. The separator used
9272 for the output list is the same as the one used for the input, but a separator
9273 setting is not included in the output. For example:
9274 .code
9275 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9276 .endd
9277 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9278 value of &$item$& is restored to what it was before. See also the &*filter*&
9279 and &*reduce*& expansion items.
9280
9281 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9282 .cindex "expansion" "numeric hash"
9283 .cindex "hash function" "numeric"
9284 The three strings are expanded; the first two must yield numbers. Call them
9285 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9286 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9287 can use the simpler operator notation that avoids some of the braces:
9288 .code
9289 ${nhash_<n>_<m>:<string>}
9290 .endd
9291 The second number is optional (in both notations). If there is only one number,
9292 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9293 processed by a div/mod hash function that returns two numbers, separated by a
9294 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9295 example,
9296 .code
9297 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9298 .endd
9299 returns the string &"6/33"&.
9300
9301
9302
9303 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9304 .cindex "Perl" "use in expanded string"
9305 .cindex "expansion" "calling Perl from"
9306 This item is available only if Exim has been built to include an embedded Perl
9307 interpreter. The subroutine name and the arguments are first separately
9308 expanded, and then the Perl subroutine is called with those arguments. No
9309 additional arguments need be given; the maximum number permitted, including the
9310 name of the subroutine, is nine.
9311
9312 The return value of the subroutine is inserted into the expanded string, unless
9313 the return value is &%undef%&. In that case, the expansion fails in the same
9314 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9315 Whatever you return is evaluated in a scalar context. For example, if you
9316 return the name of a Perl vector, the return value is the size of the vector,
9317 not its contents.
9318
9319 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9320 with the error message that was passed to &%die%&. More details of the embedded
9321 Perl facility are given in chapter &<<CHAPperl>>&.
9322
9323 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9324 out the use of this expansion item in filter files.
9325
9326
9327 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9328 .cindex "&%prvs%& expansion item"
9329 The first argument is a complete email address and the second is secret
9330 keystring. The third argument, specifying a key number, is optional. If absent,
9331 it defaults to 0. The result of the expansion is a prvs-signed email address,
9332 to be typically used with the &%return_path%& option on an &(smtp)& transport
9333 as part of a bounce address tag validation (BATV) scheme. For more discussion
9334 and an example, see section &<<SECTverifyPRVS>>&.
9335
9336 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9337         {*&<&'string'&>&*}}*&"
9338 .cindex "&%prvscheck%& expansion item"
9339 This expansion item is the complement of the &%prvs%& item. It is used for
9340 checking prvs-signed addresses. If the expansion of the first argument does not
9341 yield a syntactically valid prvs-signed address, the whole item expands to the
9342 empty string. When the first argument does expand to a syntactically valid
9343 prvs-signed address, the second argument is expanded, with the prvs-decoded
9344 version of the address and the key number extracted from the address in the
9345 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9346
9347 These two variables can be used in the expansion of the second argument to
9348 retrieve the secret. The validity of the prvs-signed address is then checked
9349 against the secret. The result is stored in the variable &$prvscheck_result$&,
9350 which is empty for failure or &"1"& for success.
9351
9352 The third argument is optional; if it is missing, it defaults to an empty
9353 string. This argument is now expanded. If the result is an empty string, the
9354 result of the expansion is the decoded version of the address. This is the case
9355 whether or not the signature was valid. Otherwise, the result of the expansion
9356 is the expansion of the third argument.
9357
9358 All three variables can be used in the expansion of the third argument.
9359 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9360 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9361
9362 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9363 .cindex "expansion" "inserting an entire file"
9364 .cindex "file" "inserting into expansion"
9365 .cindex "&%readfile%& expansion item"
9366 The file name and end-of-line string are first expanded separately. The file is
9367 then read, and its contents replace the entire item. All newline characters in
9368 the file are replaced by the end-of-line string if it is present. Otherwise,
9369 newlines are left in the string.
9370 String expansion is not applied to the contents of the file. If you want this,
9371 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9372 the string expansion fails.
9373
9374 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9375 locks out the use of this expansion item in filter files.
9376
9377
9378
9379 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9380         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9381 .cindex "expansion" "inserting from a socket"
9382 .cindex "socket, use of in expansion"
9383 .cindex "&%readsocket%& expansion item"
9384 This item inserts data from a Unix domain or Internet socket into the expanded
9385 string. The minimal way of using it uses just two arguments, as in these
9386 examples:
9387 .code
9388 ${readsocket{/socket/name}{request string}}
9389 ${readsocket{inet:some.host:1234}{request string}}
9390 .endd
9391 For a Unix domain socket, the first substring must be the path to the socket.
9392 For an Internet socket, the first substring must contain &`inet:`& followed by
9393 a host name or IP address, followed by a colon and a port, which can be a
9394 number or the name of a TCP port in &_/etc/services_&. An IP address may
9395 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9396 example:
9397 .code
9398 ${readsocket{inet:[::1]:1234}{request string}}
9399 .endd
9400 Only a single host name may be given, but if looking it up yields more than
9401 one IP address, they are each tried in turn until a connection is made. For
9402 both kinds of socket, Exim makes a connection, writes the request string
9403 (unless it is an empty string) and reads from the socket until an end-of-file
9404 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9405 extend what can be done. Firstly, you can vary the timeout. For example:
9406 .code
9407 ${readsocket{/socket/name}{request string}{3s}}
9408 .endd
9409 A fourth argument allows you to change any newlines that are in the data
9410 that is read, in the same way as for &%readfile%& (see above). This example
9411 turns them into spaces:
9412 .code
9413 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9414 .endd
9415 As with all expansions, the substrings are expanded before the processing
9416 happens. Errors in these sub-expansions cause the expansion to fail. In
9417 addition, the following errors can occur:
9418
9419 .ilist
9420 Failure to create a socket file descriptor;
9421 .next
9422 Failure to connect the socket;
9423 .next
9424 Failure to write the request string;
9425 .next
9426 Timeout on reading from the socket.
9427 .endlist
9428
9429 By default, any of these errors causes the expansion to fail. However, if
9430 you supply a fifth substring, it is expanded and used when any of the above
9431 errors occurs. For example:
9432 .code
9433 ${readsocket{/socket/name}{request string}{3s}{\n}\
9434   {socket failure}}
9435 .endd
9436 You can test for the existence of a Unix domain socket by wrapping this
9437 expansion in &`${if exists`&, but there is a race condition between that test
9438 and the actual opening of the socket, so it is safer to use the fifth argument
9439 if you want to be absolutely sure of avoiding an expansion error for a
9440 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9441
9442 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9443 locks out the use of this expansion item in filter files.
9444
9445
9446 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9447 .cindex "expansion" "reducing a list to a scalar"
9448 .cindex "list" "reducing to a scalar"
9449 .vindex "&$value$&"
9450 .vindex "&$item$&"
9451 This operation reduces a list to a single, scalar string. After expansion,
9452 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9453 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9454 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9455 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9456 them. The result of that expansion is assigned to &$value$& before the next
9457 iteration. When the end of the list is reached, the final value of &$value$& is
9458 added to the expansion output. The &*reduce*& expansion item can be used in a
9459 number of ways. For example, to add up a list of numbers:
9460 .code
9461 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9462 .endd
9463 The result of that expansion would be &`6`&. The maximum of a list of numbers
9464 can be found:
9465 .code
9466 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9467 .endd
9468 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9469 restored to what they were before. See also the &*filter*& and &*map*&
9470 expansion items.
9471
9472 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9473 This item inserts &"raw"& header lines. It is described with the &%header%&
9474 expansion item above.
9475
9476 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9477         {*&<&'string2'&>&*}}*&"
9478 .cindex "expansion" "running a command"
9479 .cindex "&%run%& expansion item"
9480 The command and its arguments are first expanded separately, and then the
9481 command is run in a separate process, but under the same uid and gid. As in
9482 other command executions from Exim, a shell is not used by default. If you want
9483 a shell, you must explicitly code it.
9484
9485 The standard input for the command exists, but is empty. The standard output
9486 and standard error are set to the same file descriptor.
9487 .cindex "return code" "from &%run%& expansion"
9488 .vindex "&$value$&"
9489 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9490 and replaces the entire item; during this expansion, the standard output/error
9491 from the command is in the variable &$value$&. If the command fails,
9492 <&'string2'&>, if present, is expanded and used. Once again, during the
9493 expansion, the standard output/error from the command is in the variable
9494 &$value$&.
9495
9496 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9497 can be the word &"fail"& (not in braces) to force expansion failure if the
9498 command does not succeed. If both strings are omitted, the result is contents
9499 of the standard output/error on success, and nothing on failure.
9500
9501 .new
9502 .vindex "&$run_in_acl$&"
9503 The standard output/error of the command is put in the variable &$value$&.
9504 In this ACL example, the output of a command is logged for the admin to
9505 troubleshoot:
9506 .code
9507 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9508       log_message  = Output of id: $value
9509 .endd
9510 If the command requires shell idioms, such as the > redirect operator, the
9511 shell must be invoked directly, such as with:
9512 .code
9513 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9514 .endd
9515 .wen
9516
9517 .vindex "&$runrc$&"
9518 The return code from the command is put in the variable &$runrc$&, and this
9519 remains set afterwards, so in a filter file you can do things like this:
9520 .code
9521 if "${run{x y z}{}}$runrc" is 1 then ...
9522   elif $runrc is 2 then ...
9523   ...
9524 endif
9525 .endd
9526 If execution of the command fails (for example, the command does not exist),
9527 the return code is 127 &-- the same code that shells use for non-existent
9528 commands.
9529
9530 &*Warning*&: In a router or transport, you cannot assume the order in which
9531 option values are expanded, except for those preconditions whose order of
9532 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9533 by the expansion of one option, and use it in another.
9534
9535 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9536 out the use of this expansion item in filter files.
9537
9538
9539 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9540 .cindex "expansion" "string substitution"
9541 .cindex "&%sg%& expansion item"
9542 This item works like Perl's substitution operator (s) with the global (/g)
9543 option; hence its name. However, unlike the Perl equivalent, Exim does not
9544 modify the subject string; instead it returns the modified string for insertion
9545 into the overall expansion. The item takes three arguments: the subject string,
9546 a regular expression, and a substitution string. For example:
9547 .code
9548 ${sg{abcdefabcdef}{abc}{xyz}}
9549 .endd
9550 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9551 if any $ or \ characters are required in the regular expression or in the
9552 substitution string, they have to be escaped. For example:
9553 .code
9554 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9555 .endd
9556 yields &"defabc"&, and
9557 .code
9558 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9559 .endd
9560 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9561 the regular expression from string expansion.
9562
9563
9564
9565 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9566 .cindex "&%substr%& expansion item"
9567 .cindex "substring extraction"
9568 .cindex "expansion" "substring extraction"
9569 The three strings are expanded; the first two must yield numbers. Call them
9570 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9571 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9572 can use the simpler operator notation that avoids some of the braces:
9573 .code
9574 ${substr_<n>_<m>:<string>}
9575 .endd
9576 The second number is optional (in both notations).
9577 If it is absent in the simpler format, the preceding underscore must also be
9578 omitted.
9579
9580 The &%substr%& item can be used to extract more general substrings than
9581 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9582 length required. For example
9583 .code
9584 ${substr{3}{2}{$local_part}}
9585 .endd
9586 If the starting offset is greater than the string length the result is the
9587 null string; if the length plus starting offset is greater than the string
9588 length, the result is the right-hand part of the string, starting from the
9589 given offset. The first character in the string has offset zero.
9590
9591 The &%substr%& expansion item can take negative offset values to count
9592 from the right-hand end of its operand. The last character is offset -1, the
9593 second-last is offset -2, and so on. Thus, for example,
9594 .code
9595 ${substr{-5}{2}{1234567}}
9596 .endd
9597 yields &"34"&. If the absolute value of a negative offset is greater than the
9598 length of the string, the substring starts at the beginning of the string, and
9599 the length is reduced by the amount of overshoot. Thus, for example,
9600 .code
9601 ${substr{-5}{2}{12}}
9602 .endd
9603 yields an empty string, but
9604 .code
9605 ${substr{-3}{2}{12}}
9606 .endd
9607 yields &"1"&.
9608
9609 When the second number is omitted from &%substr%&, the remainder of the string
9610 is taken if the offset is positive. If it is negative, all characters in the
9611 string preceding the offset point are taken. For example, an offset of -1 and
9612 no length, as in these semantically identical examples:
9613 .code
9614 ${substr_-1:abcde}
9615 ${substr{-1}{abcde}}
9616 .endd
9617 yields all but the last character of the string, that is, &"abcd"&.
9618
9619
9620
9621 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9622         {*&<&'replacements'&>&*}}*&"
9623 .cindex "expansion" "character translation"
9624 .cindex "&%tr%& expansion item"
9625 This item does single-character translation on its subject string. The second
9626 argument is a list of characters to be translated in the subject string. Each
9627 matching character is replaced by the corresponding character from the
9628 replacement list. For example
9629 .code
9630 ${tr{abcdea}{ac}{13}}
9631 .endd
9632 yields &`1b3de1`&. If there are duplicates in the second character string, the
9633 last occurrence is used. If the third string is shorter than the second, its
9634 last character is replicated. However, if it is empty, no translation takes
9635 place.
9636 .endlist
9637
9638
9639
9640 .section "Expansion operators" "SECTexpop"
9641 .cindex "expansion" "operators"
9642 For expansion items that perform transformations on a single argument string,
9643 the &"operator"& notation is used because it is simpler and uses fewer braces.
9644 The substring is first expanded before the operation is applied to it. The
9645 following operations can be performed:
9646
9647 .vlist
9648 .vitem &*${address:*&<&'string'&>&*}*&
9649 .cindex "expansion" "RFC 2822 address handling"
9650 .cindex "&%address%& expansion item"
9651 The string is interpreted as an RFC 2822 address, as it might appear in a
9652 header line, and the effective address is extracted from it. If the string does
9653 not parse successfully, the result is empty.
9654
9655
9656 .vitem &*${addresses:*&<&'string'&>&*}*&
9657 .cindex "expansion" "RFC 2822 address handling"
9658 .cindex "&%addresses%& expansion item"
9659 The string (after expansion) is interpreted as a list of addresses in RFC
9660 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9661 operative address (&'local-part@domain'&) is extracted from each item, and the
9662 result of the expansion is a colon-separated list, with appropriate
9663 doubling of colons should any happen to be present in the email addresses.
9664 Syntactically invalid RFC2822 address items are omitted from the output.
9665
9666 It is possible to specify a character other than colon for the output
9667 separator by starting the string with > followed by the new separator
9668 character. For example:
9669 .code
9670 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9671 .endd
9672 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9673 expansion item, which extracts the working address from a single RFC2822
9674 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9675 processing lists.
9676
9677 .new
9678 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9679 a strict interpretation of header line formatting.  Exim parses the bare,
9680 unquoted portion of an email address and if it finds a comma, treats it as an
9681 email address seperator. For the example header line:
9682 .code
9683 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9684 .endd
9685 The first example below demonstrates that Q-encoded email addresses are parsed
9686 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9687 It does not see the comma because it's still encoded as "=2C".  The second
9688 example below is passed the contents of &`$header_from:`&, meaning it gets
9689 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9690 The third example shows that the presence of a comma is skipped when it is
9691 quoted.
9692 .code
9693 # exim -be '${addresses:From: \
9694 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9695 user@example.com
9696 # exim -be '${addresses:From: Last, First <user@example.com>}'
9697 Last:user@example.com
9698 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9699 user@example.com
9700 .endd
9701 .wen
9702
9703 .vitem &*${base62:*&<&'digits'&>&*}*&
9704 .cindex "&%base62%& expansion item"
9705 .cindex "expansion" "conversion to base 62"
9706 The string must consist entirely of decimal digits. The number is converted to
9707 base 62 and output as a string of six characters, including leading zeros. In
9708 the few operating environments where Exim uses base 36 instead of base 62 for
9709 its message identifiers (because those systems do not have case-sensitive file
9710 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9711 be absolutely clear: this is &'not'& base64 encoding.
9712
9713 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9714 .cindex "&%base62d%& expansion item"
9715 .cindex "expansion" "conversion to base 62"
9716 The string must consist entirely of base-62 digits, or, in operating
9717 environments where Exim uses base 36 instead of base 62 for its message
9718 identifiers, base-36 digits. The number is converted to decimal and output as a
9719 string.
9720
9721
9722 .vitem &*${domain:*&<&'string'&>&*}*&
9723 .cindex "domain" "extraction"
9724 .cindex "expansion" "domain extraction"
9725 The string is interpreted as an RFC 2822 address and the domain is extracted
9726 from it. If the string does not parse successfully, the result is empty.
9727
9728
9729 .vitem &*${escape:*&<&'string'&>&*}*&
9730 .cindex "expansion" "escaping non-printing characters"
9731 .cindex "&%escape%& expansion item"
9732 If the string contains any non-printing characters, they are converted to
9733 escape sequences starting with a backslash. Whether characters with the most
9734 significant bit set (so-called &"8-bit characters"&) count as printing or not
9735 is controlled by the &%print_topbitchars%& option.
9736
9737
9738 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9739 .cindex "expansion" "expression evaluation"
9740 .cindex "expansion" "arithmetic expression"
9741 .cindex "&%eval%& expansion item"
9742 These items supports simple arithmetic and bitwise logical operations in
9743 expansion strings. The string (after expansion) must be a conventional
9744 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9745 logical operators, and parentheses. All operations are carried out using
9746 integer arithmetic. The operator priorities are as follows (the same as in the
9747 C programming language):
9748 .table2 70pt 300pt
9749 .irow &'highest:'& "not (~), negate (-)"
9750 .irow ""   "multiply (*), divide (/), remainder (%)"
9751 .irow ""   "plus (+), minus (-)"
9752 .irow ""   "shift-left (<<), shift-right (>>)"
9753 .irow ""   "and (&&)"
9754 .irow ""   "xor (^)"
9755 .irow &'lowest:'&  "or (|)"
9756 .endtable
9757 Binary operators with the same priority are evaluated from left to right. White
9758 space is permitted before or after operators.
9759
9760 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9761 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9762 decimal, even if they start with a leading zero; hexadecimal numbers are not
9763 permitted. This can be useful when processing numbers extracted from dates or
9764 times, which often do have leading zeros.
9765
9766 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9767 or 1024*1024*1024,
9768 respectively. Negative numbers are supported. The result of the computation is
9769 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9770
9771 .display
9772 &`${eval:1+1}            `&  yields 2
9773 &`${eval:1+2*3}          `&  yields 7
9774 &`${eval:(1+2)*3}        `&  yields 9
9775 &`${eval:2+42%5}         `&  yields 4
9776 &`${eval:0xc&amp;5}          `&  yields 4
9777 &`${eval:0xc|5}          `&  yields 13
9778 &`${eval:0xc^5}          `&  yields 9
9779 &`${eval:0xc>>1}         `&  yields 6
9780 &`${eval:0xc<<1}         `&  yields 24
9781 &`${eval:~255&amp;0x1234}    `&  yields 4608
9782 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9783 .endd
9784
9785 As a more realistic example, in an ACL you might have
9786 .code
9787 deny   message = Too many bad recipients
9788        condition =                    \
9789          ${if and {                   \
9790            {>{$rcpt_count}{10}}       \
9791            {                          \
9792            <                          \
9793              {$recipients_count}      \
9794              {${eval:$rcpt_count/2}}  \
9795            }                          \
9796          }{yes}{no}}
9797 .endd
9798 The condition is true if there have been more than 10 RCPT commands and
9799 fewer than half of them have resulted in a valid recipient.
9800
9801
9802 .vitem &*${expand:*&<&'string'&>&*}*&
9803 .cindex "expansion" "re-expansion of substring"
9804 The &%expand%& operator causes a string to be expanded for a second time. For
9805 example,
9806 .code
9807 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9808 .endd
9809 first looks up a string in a file while expanding the operand for &%expand%&,
9810 and then re-expands what it has found.
9811
9812
9813 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9814 .cindex "Unicode"
9815 .cindex "UTF-8" "conversion from"
9816 .cindex "expansion" "UTF-8 conversion"
9817 .cindex "&%from_utf8%& expansion item"
9818 The world is slowly moving towards Unicode, although there are no standards for
9819 email yet. However, other applications (including some databases) are starting
9820 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9821 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9822 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9823 the result is an undefined sequence of bytes.
9824
9825 Unicode code points with values less than 256 are compatible with ASCII and
9826 ISO-8859-1 (also known as Latin-1).
9827 For example, character 169 is the copyright symbol in both cases, though the
9828 way it is encoded is different. In UTF-8, more than one byte is needed for
9829 characters with code values greater than 127, whereas ISO-8859-1 is a
9830 single-byte encoding (but thereby limited to 256 characters). This makes
9831 translation from UTF-8 to ISO-8859-1 straightforward.
9832
9833
9834 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9835 .cindex "hash function" "textual"
9836 .cindex "expansion" "textual hash"
9837 The &%hash%& operator is a simpler interface to the hashing function that can
9838 be used when the two parameters are fixed numbers (as opposed to strings that
9839 change when expanded). The effect is the same as
9840 .code
9841 ${hash{<n>}{<m>}{<string>}}
9842 .endd
9843 See the description of the general &%hash%& item above for details. The
9844 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9845
9846
9847
9848 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9849 .cindex "base64 encoding" "conversion from hex"
9850 .cindex "expansion" "hex to base64"
9851 .cindex "&%hex2b64%& expansion item"
9852 This operator converts a hex string into one that is base64 encoded. This can
9853 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9854
9855
9856
9857 .new
9858 .vitem &*${hexquote:*&<&'string'&>&*}*&
9859 .cindex "quoting" "hex-encoded unprintable characters"
9860 .cindex "&%hexquote%& expansion item"
9861 This operator converts non-printable characters in a string into a hex
9862 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9863 as is, and other byte values are converted to &`\xNN`&, for example a
9864 byte value 127 is converted to &`\x7f`&.
9865 .wen
9866
9867
9868 .vitem &*${lc:*&<&'string'&>&*}*&
9869 .cindex "case forcing in strings"
9870 .cindex "string" "case forcing"
9871 .cindex "lower casing"
9872 .cindex "expansion" "case forcing"
9873 .cindex "&%lc%& expansion item"
9874 This forces the letters in the string into lower-case, for example:
9875 .code
9876 ${lc:$local_part}
9877 .endd
9878
9879 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9880 .cindex "expansion" "string truncation"
9881 .cindex "&%length%& expansion item"
9882 The &%length%& operator is a simpler interface to the &%length%& function that
9883 can be used when the parameter is a fixed number (as opposed to a string that
9884 changes when expanded). The effect is the same as
9885 .code
9886 ${length{<number>}{<string>}}
9887 .endd
9888 See the description of the general &%length%& item above for details. Note that
9889 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9890 when &%length%& is used as an operator.
9891
9892
9893 .new
9894 .vitem &*${listcount:*&<&'string'&>&*}*&
9895 .cindex "expansion" "list item count"
9896 .cindex "list" "item count"
9897 .cindex "list" "count of items"
9898 .cindex "&%listcount%& expansion item"
9899 The string is interpreted as a list and the number of items is returned.
9900
9901
9902 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
9903 .cindex "expansion" "named list"
9904 .cindex "&%listnamed%& expansion item"
9905 The name is interpreted as a named list and the content of the list is returned,
9906 expanding any referenced lists, re-quoting as needed for colon-separation.
9907 If the optional type is given it must be one of "a", "d", "h" or "l"
9908 and selects address-, domain-, host- or localpart- lists to search among respectively.
9909 Otherwise all types are searched in an undefined order and the first
9910 matching list is returned.
9911 .wen
9912
9913
9914 .vitem &*${local_part:*&<&'string'&>&*}*&
9915 .cindex "expansion" "local part extraction"
9916 .cindex "&%local_part%& expansion item"
9917 The string is interpreted as an RFC 2822 address and the local part is
9918 extracted from it. If the string does not parse successfully, the result is
9919 empty.
9920
9921
9922 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9923 .cindex "masked IP address"
9924 .cindex "IP address" "masking"
9925 .cindex "CIDR notation"
9926 .cindex "expansion" "IP address masking"
9927 .cindex "&%mask%& expansion item"
9928 If the form of the string to be operated on is not an IP address followed by a
9929 slash and an integer (that is, a network address in CIDR notation), the
9930 expansion fails. Otherwise, this operator converts the IP address to binary,
9931 masks off the least significant bits according to the bit count, and converts
9932 the result back to text, with mask appended. For example,
9933 .code
9934 ${mask:10.111.131.206/28}
9935 .endd
9936 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9937 be mostly used for looking up masked addresses in files, the result for an IPv6
9938 address uses dots to separate components instead of colons, because colon
9939 terminates a key string in lsearch files. So, for example,
9940 .code
9941 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9942 .endd
9943 returns the string
9944 .code
9945 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9946 .endd
9947 Letters in IPv6 addresses are always output in lower case.
9948
9949
9950 .vitem &*${md5:*&<&'string'&>&*}*&
9951 .cindex "MD5 hash"
9952 .cindex "expansion" "MD5 hash"
9953 .cindex "&%md5%& expansion item"
9954 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9955 as a 32-digit hexadecimal number, in which any letters are in lower case.
9956
9957
9958 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9959 .cindex "expansion" "numeric hash"
9960 .cindex "hash function" "numeric"
9961 The &%nhash%& operator is a simpler interface to the numeric hashing function
9962 that can be used when the two parameters are fixed numbers (as opposed to
9963 strings that change when expanded). The effect is the same as
9964 .code
9965 ${nhash{<n>}{<m>}{<string>}}
9966 .endd
9967 See the description of the general &%nhash%& item above for details.
9968
9969
9970 .vitem &*${quote:*&<&'string'&>&*}*&
9971 .cindex "quoting" "in string expansions"
9972 .cindex "expansion" "quoting"
9973 .cindex "&%quote%& expansion item"
9974 The &%quote%& operator puts its argument into double quotes if it
9975 is an empty string or
9976 contains anything other than letters, digits, underscores, dots, and hyphens.
9977 Any occurrences of double quotes and backslashes are escaped with a backslash.
9978 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9979 respectively For example,
9980 .code
9981 ${quote:ab"*"cd}
9982 .endd
9983 becomes
9984 .code
9985 "ab\"*\"cd"
9986 .endd
9987 The place where this is useful is when the argument is a substitution from a
9988 variable or a message header.
9989
9990 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9991 .cindex "&%quote_local_part%& expansion item"
9992 This operator is like &%quote%&, except that it quotes the string only if
9993 required to do so by the rules of RFC 2822 for quoting local parts. For
9994 example, a plus sign would not cause quoting (but it would for &%quote%&).
9995 If you are creating a new email address from the contents of &$local_part$&
9996 (or any other unknown data), you should always use this operator.
9997
9998
9999 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10000 .cindex "quoting" "lookup-specific"
10001 This operator applies lookup-specific quoting rules to the string. Each
10002 query-style lookup type has its own quoting rules which are described with
10003 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10004 .code
10005 ${quote_ldap:two * two}
10006 .endd
10007 returns
10008 .code
10009 two%20%5C2A%20two
10010 .endd
10011 For single-key lookup types, no quoting is ever necessary and this operator
10012 yields an unchanged string.
10013
10014
10015 .vitem &*${randint:*&<&'n'&>&*}*&
10016 .cindex "random number"
10017 This operator returns a somewhat random number which is less than the
10018 supplied number and is at least 0.  The quality of this randomness depends
10019 on how Exim was built; the values are not suitable for keying material.
10020 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10021 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10022 for versions of GnuTLS with that function.
10023 Otherwise, the implementation may be arc4random(), random() seeded by
10024 srandomdev() or srandom(), or a custom implementation even weaker than
10025 random().
10026
10027
10028 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10029 .cindex "expansion" "IP address"
10030 This operator reverses an IP address; for IPv4 addresses, the result is in
10031 dotted-quad decimal form, while for IPv6 addreses the result is in
10032 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10033 for DNS.  For example,
10034 .code
10035 ${reverse_ip:192.0.2.4}
10036 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10037 .endd
10038 returns
10039 .code
10040 4.2.0.192
10041 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
10042 .endd
10043
10044
10045 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10046 .cindex "expansion" "RFC 2047"
10047 .cindex "RFC 2047" "expansion operator"
10048 .cindex "&%rfc2047%& expansion item"
10049 This operator encodes text according to the rules of RFC 2047. This is an
10050 encoding that is used in header lines to encode non-ASCII characters. It is
10051 assumed that the input string is in the encoding specified by the
10052 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10053 contains only characters in the range 33&--126, and no instances of the
10054 characters
10055 .code
10056 ? = ( ) < > @ , ; : \ " . [ ] _
10057 .endd
10058 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10059 string, using as many &"encoded words"& as necessary to encode all the
10060 characters.
10061
10062
10063 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10064 .cindex "expansion" "RFC 2047"
10065 .cindex "RFC 2047" "decoding"
10066 .cindex "&%rfc2047d%& expansion item"
10067 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10068 bytes are replaced by question marks. Characters are converted into the
10069 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10070 not recognized unless &%check_rfc2047_length%& is set false.
10071
10072 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10073 access a header line, RFC 2047 decoding is done automatically. You do not need
10074 to use this operator as well.
10075
10076
10077
10078 .vitem &*${rxquote:*&<&'string'&>&*}*&
10079 .cindex "quoting" "in regular expressions"
10080 .cindex "regular expressions" "quoting"
10081 .cindex "&%rxquote%& expansion item"
10082 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10083 characters in its argument. This is useful when substituting the values of
10084 variables or headers inside regular expressions.
10085
10086
10087 .vitem &*${sha1:*&<&'string'&>&*}*&
10088 .cindex "SHA-1 hash"
10089 .cindex "expansion" "SHA-1 hashing"
10090 .cindex "&%sha2%& expansion item"
10091 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10092 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10093
10094
10095 .vitem &*${stat:*&<&'string'&>&*}*&
10096 .cindex "expansion" "statting a file"
10097 .cindex "file" "extracting characteristics"
10098 .cindex "&%stat%& expansion item"
10099 The string, after expansion, must be a file path. A call to the &[stat()]&
10100 function is made for this path. If &[stat()]& fails, an error occurs and the
10101 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10102 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10103 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10104 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10105 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10106 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10107 can extract individual fields using the &%extract%& expansion item.
10108
10109 The use of the &%stat%& expansion in users' filter files can be locked out by
10110 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10111 systems for files larger than 2GB.
10112
10113 .vitem &*${str2b64:*&<&'string'&>&*}*&
10114 .cindex "expansion" "base64 encoding"
10115 .cindex "base64 encoding" "in string expansion"
10116 .cindex "&%str2b64%& expansion item"
10117 This operator converts a string into one that is base64 encoded.
10118
10119
10120
10121 .vitem &*${strlen:*&<&'string'&>&*}*&
10122 .cindex "expansion" "string length"
10123 .cindex "string" "length in expansion"
10124 .cindex "&%strlen%& expansion item"
10125 The item is replace by the length of the expanded string, expressed as a
10126 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10127
10128
10129 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10130 .cindex "&%substr%& expansion item"
10131 .cindex "substring extraction"
10132 .cindex "expansion" "substring expansion"
10133 The &%substr%& operator is a simpler interface to the &%substr%& function that
10134 can be used when the two parameters are fixed numbers (as opposed to strings
10135 that change when expanded). The effect is the same as
10136 .code
10137 ${substr{<start>}{<length>}{<string>}}
10138 .endd
10139 See the description of the general &%substr%& item above for details. The
10140 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10141
10142 .vitem &*${time_eval:*&<&'string'&>&*}*&
10143 .cindex "&%time_eval%& expansion item"
10144 .cindex "time interval" "decoding"
10145 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10146 seconds.
10147
10148 .vitem &*${time_interval:*&<&'string'&>&*}*&
10149 .cindex "&%time_interval%& expansion item"
10150 .cindex "time interval" "formatting"
10151 The argument (after sub-expansion) must be a sequence of decimal digits that
10152 represents an interval of time as a number of seconds. It is converted into a
10153 number of larger units and output in Exim's normal time format, for example,
10154 &`1w3d4h2m6s`&.
10155
10156 .vitem &*${uc:*&<&'string'&>&*}*&
10157 .cindex "case forcing in strings"
10158 .cindex "string" "case forcing"
10159 .cindex "upper casing"
10160 .cindex "expansion" "case forcing"
10161 .cindex "&%uc%& expansion item"
10162 This forces the letters in the string into upper-case.
10163 .endlist
10164
10165
10166
10167
10168
10169
10170 .section "Expansion conditions" "SECTexpcond"
10171 .scindex IIDexpcond "expansion" "conditions"
10172 The following conditions are available for testing by the &%${if%& construct
10173 while expanding strings:
10174
10175 .vlist
10176 .vitem &*!*&<&'condition'&>
10177 .cindex "expansion" "negating a condition"
10178 .cindex "negation" "in expansion condition"
10179 Preceding any condition with an exclamation mark negates the result of the
10180 condition.
10181
10182 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10183 .cindex "numeric comparison"
10184 .cindex "expansion" "numeric comparison"
10185 There are a number of symbolic operators for doing numeric comparisons. They
10186 are:
10187 .display
10188 &`=   `&   equal
10189 &`==  `&   equal
10190 &`>   `&   greater
10191 &`>=  `&   greater or equal
10192 &`<   `&   less
10193 &`<=  `&   less or equal
10194 .endd
10195 For example:
10196 .code
10197 ${if >{$message_size}{10M} ...
10198 .endd
10199 Note that the general negation operator provides for inequality testing. The
10200 two strings must take the form of optionally signed decimal integers,
10201 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10202 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10203 As a special case, the numerical value of an empty string is taken as
10204 zero.
10205
10206 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10207 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10208 10M, not if 10M is larger than &$message_size$&.
10209
10210
10211 .new
10212 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10213         {*&<&'arg2'&>&*}...}*&
10214 .cindex "expansion" "calling an acl"
10215 .cindex "&%acl%&" "expansion condition"
10216 The name and zero to nine argument strings are first expanded separately.  The expanded
10217 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10218 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10219 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10220 and may use the variables; if another acl expansion is used the values
10221 are restored after it returns.  If the ACL sets
10222 a value using a "message =" modifier the variable $value becomes
10223 the result of the expansion, otherwise it is empty.
10224 If the ACL returns accept the condition is true; if deny, false.
10225 If the ACL returns defer the result is a forced-fail.
10226 .wen
10227
10228 .vitem &*bool&~{*&<&'string'&>&*}*&
10229 .cindex "expansion" "boolean parsing"
10230 .cindex "&%bool%& expansion condition"
10231 This condition turns a string holding a true or false representation into
10232 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10233 (case-insensitively); also positive integer numbers map to true if non-zero,
10234 false if zero.
10235 An empty string is treated as false.
10236 Leading and trailing whitespace is ignored;
10237 thus a string consisting only of whitespace is false.
10238 All other string values will result in expansion failure.
10239
10240 When combined with ACL variables, this expansion condition will let you
10241 make decisions in one place and act on those decisions in another place.
10242 For example:
10243 .code
10244 ${if bool{$acl_m_privileged_sender} ...
10245 .endd
10246
10247
10248 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10249 .cindex "expansion" "boolean parsing"
10250 .cindex "&%bool_lax%& expansion condition"
10251 Like &%bool%&, this condition turns a string into a boolean state.  But
10252 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10253 loose definition that the Router &%condition%& option uses.  The empty string
10254 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10255 true.  Leading and trailing whitespace is ignored.
10256
10257 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10258
10259 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10260 .cindex "expansion" "encrypted comparison"
10261 .cindex "encrypted strings, comparing"
10262 .cindex "&%crypteq%& expansion condition"
10263 This condition is included in the Exim binary if it is built to support any
10264 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10265 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10266 included in the binary.
10267
10268 The &%crypteq%& condition has two arguments. The first is encrypted and
10269 compared against the second, which is already encrypted. The second string may
10270 be in the LDAP form for storing encrypted strings, which starts with the
10271 encryption type in curly brackets, followed by the data. If the second string
10272 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10273 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10274 Typically this will be a field from a password file. An example of an encrypted
10275 string in LDAP form is:
10276 .code
10277 {md5}CY9rzUYh03PK3k6DJie09g==
10278 .endd
10279 If such a string appears directly in an expansion, the curly brackets have to
10280 be quoted, because they are part of the expansion syntax. For example:
10281 .code
10282 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10283 .endd
10284 The following encryption types (whose names are matched case-independently) are
10285 supported:
10286
10287 .ilist
10288 .cindex "MD5 hash"
10289 .cindex "base64 encoding" "in encrypted password"
10290 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10291 printable characters to compare with the remainder of the second string. If the
10292 length of the comparison string is 24, Exim assumes that it is base64 encoded
10293 (as in the above example). If the length is 32, Exim assumes that it is a
10294 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10295 comparison fails.
10296
10297 .next
10298 .cindex "SHA-1 hash"
10299 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10300 printable characters to compare with the remainder of the second string. If the
10301 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10302 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10303 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10304
10305 .next
10306 .cindex "&[crypt()]&"
10307 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10308 only the first eight characters of the password. However, in modern operating
10309 systems this is no longer true, and in many cases the entire password is used,
10310 whatever its length.
10311
10312 .next
10313 .cindex "&[crypt16()]&"
10314 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10315 use up to 16 characters of the password in some operating systems. Again, in
10316 modern operating systems, more characters may be used.
10317 .endlist
10318 Exim has its own version of &[crypt16()]&, which is just a double call to
10319 &[crypt()]&. For operating systems that have their own version, setting
10320 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10321 operating system version instead of its own. This option is set by default in
10322 the OS-dependent &_Makefile_& for those operating systems that are known to
10323 support &[crypt16()]&.
10324
10325 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10326 it was not using the same algorithm as some operating systems' versions. It
10327 turns out that as well as &[crypt16()]& there is a function called
10328 &[bigcrypt()]& in some operating systems. This may or may not use the same
10329 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10330
10331 However, since there is now a move away from the traditional &[crypt()]&
10332 functions towards using SHA1 and other algorithms, tidying up this area of
10333 Exim is seen as very low priority.
10334
10335 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10336 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10337 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10338 default is &`{crypt}`&. Whatever the default, you can always use either
10339 function by specifying it explicitly in curly brackets.
10340
10341 .vitem &*def:*&<&'variable&~name'&>
10342 .cindex "expansion" "checking for empty variable"
10343 .cindex "&%def%& expansion condition"
10344 The &%def%& condition must be followed by the name of one of the expansion
10345 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10346 variable does not contain the empty string. For example:
10347 .code
10348 ${if def:sender_ident {from $sender_ident}}
10349 .endd
10350 Note that the variable name is given without a leading &%$%& character. If the
10351 variable does not exist, the expansion fails.
10352
10353 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10354         &~&*def:h_*&<&'header&~name'&>&*:*&"
10355 .cindex "expansion" "checking header line existence"
10356 This condition is true if a message is being processed and the named header
10357 exists in the message. For example,
10358 .code
10359 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10360 .endd
10361 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10362 the header name must be terminated by a colon if white space does not follow.
10363
10364 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10365        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10366 .cindex "string" "comparison"
10367 .cindex "expansion" "string comparison"
10368 .cindex "&%eq%& expansion condition"
10369 .cindex "&%eqi%& expansion condition"
10370 The two substrings are first expanded. The condition is true if the two
10371 resulting strings are identical. For &%eq%& the comparison includes the case of
10372 letters, whereas for &%eqi%& the comparison is case-independent.
10373
10374 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10375 .cindex "expansion" "file existence test"
10376 .cindex "file" "existence test"
10377 .cindex "&%exists%&, expansion condition"
10378 The substring is first expanded and then interpreted as an absolute path. The
10379 condition is true if the named file (or directory) exists. The existence test
10380 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10381 users' filter files may be locked out by the system administrator.
10382
10383 .vitem &*first_delivery*&
10384 .cindex "delivery" "first"
10385 .cindex "first delivery"
10386 .cindex "expansion" "first delivery test"
10387 .cindex "&%first_delivery%& expansion condition"
10388 This condition, which has no data, is true during a message's first delivery
10389 attempt. It is false during any subsequent delivery attempts.
10390
10391
10392 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10393        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10394 .cindex "list" "iterative conditions"
10395 .cindex "expansion" "&*forall*& condition"
10396 .cindex "expansion" "&*forany*& condition"
10397 .vindex "&$item$&"
10398 These conditions iterate over a list. The first argument is expanded to form
10399 the list. By default, the list separator is a colon, but it can be changed by
10400 the normal method. The second argument is interpreted as a condition that is to
10401 be applied to each item in the list in turn. During the interpretation of the
10402 condition, the current list item is placed in a variable called &$item$&.
10403 .ilist
10404 For &*forany*&, interpretation stops if the condition is true for any item, and
10405 the result of the whole condition is true. If the condition is false for all
10406 items in the list, the overall condition is false.
10407 .next
10408 For &*forall*&, interpretation stops if the condition is false for any item,
10409 and the result of the whole condition is false. If the condition is true for
10410 all items in the list, the overall condition is true.
10411 .endlist
10412 Note that negation of &*forany*& means that the condition must be false for all
10413 items for the overall condition to succeed, and negation of &*forall*& means
10414 that the condition must be false for at least one item. In this example, the
10415 list separator is changed to a comma:
10416 .code
10417 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10418 .endd
10419 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10420 being processed, to enable these expansion items to be nested.
10421
10422 .new "To scan a named list, expand it with the &*listnamed*& operator."
10423
10424
10425 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10426        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10427 .cindex "string" "comparison"
10428 .cindex "expansion" "string comparison"
10429 .cindex "&%ge%& expansion condition"
10430 .cindex "&%gei%& expansion condition"
10431 The two substrings are first expanded. The condition is true if the first
10432 string is lexically greater than or equal to the second string. For &%ge%& the
10433 comparison includes the case of letters, whereas for &%gei%& the comparison is
10434 case-independent.
10435
10436 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10437        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10438 .cindex "string" "comparison"
10439 .cindex "expansion" "string comparison"
10440 .cindex "&%gt%& expansion condition"
10441 .cindex "&%gti%& expansion condition"
10442 The two substrings are first expanded. The condition is true if the first
10443 string is lexically greater than the second string. For &%gt%& the comparison
10444 includes the case of letters, whereas for &%gti%& the comparison is
10445 case-independent.
10446
10447 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10448        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10449 .cindex "string" "comparison"
10450 .cindex "list" "iterative conditions"
10451 Both strings are expanded; the second string is treated as a list of simple
10452 strings; if the first string is a member of the second, then the condition
10453 is true.
10454
10455 These are simpler to use versions of the more powerful &*forany*& condition.
10456 Examples, and the &*forany*& equivalents:
10457 .code
10458 ${if inlist{needle}{foo:needle:bar}}
10459   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10460 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10461   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10462 .endd
10463
10464 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10465        &*isip4&~{*&<&'string'&>&*}*& &&&
10466        &*isip6&~{*&<&'string'&>&*}*&
10467 .cindex "IP address" "testing string format"
10468 .cindex "string" "testing for IP address"
10469 .cindex "&%isip%& expansion condition"
10470 .cindex "&%isip4%& expansion condition"
10471 .cindex "&%isip6%& expansion condition"
10472 The substring is first expanded, and then tested to see if it has the form of
10473 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10474 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10475
10476 For an IPv4 address, the test is for four dot-separated components, each of
10477 which consists of from one to three digits. For an IPv6 address, up to eight
10478 colon-separated components are permitted, each containing from one to four
10479 hexadecimal digits. There may be fewer than eight components if an empty
10480 component (adjacent colons) is present. Only one empty component is permitted.
10481
10482 &*Note*&: The checks are just on the form of the address; actual numerical
10483 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10484 check. The main use of these tests is to distinguish between IP addresses and
10485 host names, or between IPv4 and IPv6 addresses. For example, you could use
10486 .code
10487 ${if isip4{$sender_host_address}...
10488 .endd
10489 to test which IP version an incoming SMTP connection is using.
10490
10491 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10492 .cindex "LDAP" "use for authentication"
10493 .cindex "expansion" "LDAP authentication test"
10494 .cindex "&%ldapauth%& expansion condition"
10495 This condition supports user authentication using LDAP. See section
10496 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10497 queries. For this use, the query must contain a user name and password. The
10498 query itself is not used, and can be empty. The condition is true if the
10499 password is not empty, and the user name and password are accepted by the LDAP
10500 server. An empty password is rejected without calling LDAP because LDAP binds
10501 with an empty password are considered anonymous regardless of the username, and
10502 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10503 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10504 this can be used.
10505
10506
10507 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10508        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10509 .cindex "string" "comparison"
10510 .cindex "expansion" "string comparison"
10511 .cindex "&%le%& expansion condition"
10512 .cindex "&%lei%& expansion condition"
10513 The two substrings are first expanded. The condition is true if the first
10514 string is lexically less than or equal to the second string. For &%le%& the
10515 comparison includes the case of letters, whereas for &%lei%& the comparison is
10516 case-independent.
10517
10518 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10519        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10520 .cindex "string" "comparison"
10521 .cindex "expansion" "string comparison"
10522 .cindex "&%lt%& expansion condition"
10523 .cindex "&%lti%& expansion condition"
10524 The two substrings are first expanded. The condition is true if the first
10525 string is lexically less than the second string. For &%lt%& the comparison
10526 includes the case of letters, whereas for &%lti%& the comparison is
10527 case-independent.
10528
10529
10530 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10531 .cindex "expansion" "regular expression comparison"
10532 .cindex "regular expressions" "match in expanded string"
10533 .cindex "&%match%& expansion condition"
10534 The two substrings are first expanded. The second is then treated as a regular
10535 expression and applied to the first. Because of the pre-expansion, if the
10536 regular expression contains dollar, or backslash characters, they must be
10537 escaped. Care must also be taken if the regular expression contains braces
10538 (curly brackets). A closing brace must be escaped so that it is not taken as a
10539 premature termination of <&'string2'&>. The easiest approach is to use the
10540 &`\N`& feature to disable expansion of the regular expression.
10541 For example,
10542 .code
10543 ${if match {$local_part}{\N^\d{3}\N} ...
10544 .endd
10545 If the whole expansion string is in double quotes, further escaping of
10546 backslashes is also required.
10547
10548 The condition is true if the regular expression match succeeds.
10549 The regular expression is not required to begin with a circumflex
10550 metacharacter, but if there is no circumflex, the expression is not anchored,
10551 and it may match anywhere in the subject, not just at the start. If you want
10552 the pattern to match at the end of the subject, you must include the &`$`&
10553 metacharacter at an appropriate point.
10554
10555 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10556 At the start of an &%if%& expansion the values of the numeric variable
10557 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10558 succeeds causes them to be reset to the substrings of that condition and they
10559 will have these values during the expansion of the success string. At the end
10560 of the &%if%& expansion, the previous values are restored. After testing a
10561 combination of conditions using &%or%&, the subsequent values of the numeric
10562 variables are those of the condition that succeeded.
10563
10564 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10565 .cindex "&%match_address%& expansion condition"
10566 See &*match_local_part*&.
10567
10568 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10569 .cindex "&%match_domain%& expansion condition"
10570 See &*match_local_part*&.
10571
10572 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10573 .cindex "&%match_ip%& expansion condition"
10574 This condition matches an IP address to a list of IP address patterns. It must
10575 be followed by two argument strings. The first (after expansion) must be an IP
10576 address or an empty string. The second (not expanded) is a restricted host
10577 list that can match only an IP address, not a host name. For example:
10578 .code
10579 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10580 .endd
10581 The specific types of host list item that are permitted in the list are:
10582
10583 .ilist
10584 An IP address, optionally with a CIDR mask.
10585 .next
10586 A single asterisk, which matches any IP address.
10587 .next
10588 An empty item, which matches only if the IP address is empty. This could be
10589 useful for testing for a locally submitted message or one from specific hosts
10590 in a single test such as
10591 . ==== As this is a nested list, any displays it contains must be indented
10592 . ==== as otherwise they are too far to the left. This comment applies to
10593 . ==== the use of xmlto plus fop. There's no problem when formatting with
10594 . ==== sdop, with or without the extra indent.
10595 .code
10596   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10597 .endd
10598 where the first item in the list is the empty string.
10599 .next
10600 The item @[] matches any of the local host's interface addresses.
10601 .next
10602 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10603 even if &`net-`& is not specified. There is never any attempt to turn the IP
10604 address into a host name. The most common type of linear search for
10605 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10606 masks. For example:
10607 .code
10608   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10609 .endd
10610 It is of course possible to use other kinds of lookup, and in such a case, you
10611 do need to specify the &`net-`& prefix if you want to specify a specific
10612 address mask, for example:
10613 .code
10614   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10615 .endd
10616 However, unless you are combining a &%match_ip%& condition with others, it is
10617 just as easy to use the fact that a lookup is itself a condition, and write:
10618 .code
10619   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10620 .endd
10621 .endlist ilist
10622
10623 Note that <&'string2'&> is not itself subject to string expansion, unless
10624 Exim was built with the EXPAND_LISTMATCH_RHS option.
10625
10626 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10627
10628 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10629 .cindex "domain list" "in expansion condition"
10630 .cindex "address list" "in expansion condition"
10631 .cindex "local part" "list, in expansion condition"
10632 .cindex "&%match_local_part%& expansion condition"
10633 This condition, together with &%match_address%& and &%match_domain%&, make it
10634 possible to test domain, address, and local part lists within expansions. Each
10635 condition requires two arguments: an item and a list to match. A trivial
10636 example is:
10637 .code
10638 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10639 .endd
10640 In each case, the second argument may contain any of the allowable items for a
10641 list of the appropriate type. Also, because the second argument (after
10642 expansion) is a standard form of list, it is possible to refer to a named list.
10643 Thus, you can use conditions like this:
10644 .code
10645 ${if match_domain{$domain}{+local_domains}{...
10646 .endd
10647 .cindex "&`+caseful`&"
10648 For address lists, the matching starts off caselessly, but the &`+caseful`&
10649 item can be used, as in all address lists, to cause subsequent items to
10650 have their local parts matched casefully. Domains are always matched
10651 caselessly.
10652
10653 Note that <&'string2'&> is not itself subject to string expansion, unless
10654 Exim was built with the EXPAND_LISTMATCH_RHS option.
10655
10656 &*Note*&: Host lists are &'not'& supported in this way. This is because
10657 hosts have two identities: a name and an IP address, and it is not clear
10658 how to specify cleanly how such a test would work. However, IP addresses can be
10659 matched using &%match_ip%&.
10660
10661 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10662 .cindex "PAM authentication"
10663 .cindex "AUTH" "with PAM"
10664 .cindex "Solaris" "PAM support"
10665 .cindex "expansion" "PAM authentication test"
10666 .cindex "&%pam%& expansion condition"
10667 &'Pluggable Authentication Modules'&
10668 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10669 available in the latest releases of Solaris and in some GNU/Linux
10670 distributions. The Exim support, which is intended for use in conjunction with
10671 the SMTP AUTH command, is available only if Exim is compiled with
10672 .code
10673 SUPPORT_PAM=yes
10674 .endd
10675 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10676 in some releases of GNU/Linux &%-ldl%& is also needed.
10677
10678 The argument string is first expanded, and the result must be a
10679 colon-separated list of strings. Leading and trailing white space is ignored.
10680 The PAM module is initialized with the service name &"exim"& and the user name
10681 taken from the first item in the colon-separated data string (<&'string1'&>).
10682 The remaining items in the data string are passed over in response to requests
10683 from the authentication function. In the simple case there will only be one
10684 request, for a password, so the data consists of just two strings.
10685
10686 There can be problems if any of the strings are permitted to contain colon
10687 characters. In the usual way, these have to be doubled to avoid being taken as
10688 separators. If the data is being inserted from a variable, the &%sg%& expansion
10689 item can be used to double any existing colons. For example, the configuration
10690 of a LOGIN authenticator might contain this setting:
10691 .code
10692 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10693 .endd
10694 For a PLAIN authenticator you could use:
10695 .code
10696 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10697 .endd
10698 In some operating systems, PAM authentication can be done only from a process
10699 running as root. Since Exim is running as the Exim user when receiving
10700 messages, this means that PAM cannot be used directly in those systems.
10701 A patched version of the &'pam_unix'& module that comes with the
10702 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10703 The patched module allows one special uid/gid combination, in addition to root,
10704 to authenticate. If you build the patched module to allow the Exim user and
10705 group, PAM can then be used from an Exim authenticator.
10706
10707
10708 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10709 .cindex "&'pwcheck'& daemon"
10710 .cindex "Cyrus"
10711 .cindex "expansion" "&'pwcheck'& authentication test"
10712 .cindex "&%pwcheck%& expansion condition"
10713 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10714 This is one way of making it possible for passwords to be checked by a process
10715 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10716 deprecated. Its replacement is &'saslauthd'& (see below).
10717
10718 The pwcheck support is not included in Exim by default. You need to specify
10719 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10720 building Exim. For example:
10721 .code
10722 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10723 .endd
10724 You do not need to install the full Cyrus software suite in order to use
10725 the pwcheck daemon. You can compile and install just the daemon alone
10726 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10727 access to the &_/var/pwcheck_& directory.
10728
10729 The &%pwcheck%& condition takes one argument, which must be the user name and
10730 password, separated by a colon. For example, in a LOGIN authenticator
10731 configuration, you might have this:
10732 .code
10733 server_condition = ${if pwcheck{$auth1:$auth2}}
10734 .endd
10735 Again, for a PLAIN authenticator configuration, this would be:
10736 .code
10737 server_condition = ${if pwcheck{$auth2:$auth3}}
10738 .endd
10739 .vitem &*queue_running*&
10740 .cindex "queue runner" "detecting when delivering from"
10741 .cindex "expansion" "queue runner test"
10742 .cindex "&%queue_running%& expansion condition"
10743 This condition, which has no data, is true during delivery attempts that are
10744 initiated by queue runner processes, and false otherwise.
10745
10746
10747 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10748 .cindex "Radius"
10749 .cindex "expansion" "Radius authentication"
10750 .cindex "&%radius%& expansion condition"
10751 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10752 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10753 the Radius client configuration file in order to build Exim with Radius
10754 support.
10755
10756 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10757 library, using the original API. If you are using release 0.4.0 or later of
10758 this library, you need to set
10759 .code
10760 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10761 .endd
10762 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10763 &%libradius%& library that comes with FreeBSD. To do this, set
10764 .code
10765 RADIUS_LIB_TYPE=RADLIB
10766 .endd
10767 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10768 You may also have to supply a suitable setting in EXTRALIBS so that the
10769 Radius library can be found when Exim is linked.
10770
10771 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10772 Radius client library, which calls the Radius server. The condition is true if
10773 the authentication is successful. For example:
10774 .code
10775 server_condition = ${if radius{<arguments>}}
10776 .endd
10777
10778
10779 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10780         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10781 .cindex "&'saslauthd'& daemon"
10782 .cindex "Cyrus"
10783 .cindex "expansion" "&'saslauthd'& authentication test"
10784 .cindex "&%saslauthd%& expansion condition"
10785 This condition supports user authentication using the Cyrus &'saslauthd'&
10786 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10787 Using this daemon is one way of making it possible for passwords to be checked
10788 by a process that is not running as root.
10789
10790 The saslauthd support is not included in Exim by default. You need to specify
10791 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10792 building Exim. For example:
10793 .code
10794 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10795 .endd
10796 You do not need to install the full Cyrus software suite in order to use
10797 the saslauthd daemon. You can compile and install just the daemon alone
10798 from the Cyrus SASL library.
10799
10800 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10801 two are mandatory. For example:
10802 .code
10803 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10804 .endd
10805 The service and the realm are optional (which is why the arguments are enclosed
10806 in their own set of braces). For details of the meaning of the service and
10807 realm, and how to run the daemon, consult the Cyrus documentation.
10808 .endlist vlist
10809
10810
10811
10812 .section "Combining expansion conditions" "SECID84"
10813 .cindex "expansion" "combining conditions"
10814 Several conditions can be tested at once by combining them using the &%and%&
10815 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10816 conditions on their own, and precede their lists of sub-conditions. Each
10817 sub-condition must be enclosed in braces within the overall braces that contain
10818 the list. No repetition of &%if%& is used.
10819
10820
10821 .vlist
10822 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10823 .cindex "&""or""& expansion condition"
10824 .cindex "expansion" "&""or""& of conditions"
10825 The sub-conditions are evaluated from left to right. The condition is true if
10826 any one of the sub-conditions is true.
10827 For example,
10828 .code
10829 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10830 .endd
10831 When a true sub-condition is found, the following ones are parsed but not
10832 evaluated. If there are several &"match"& sub-conditions the values of the
10833 numeric variables afterwards are taken from the first one that succeeds.
10834
10835 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10836 .cindex "&""and""& expansion condition"
10837 .cindex "expansion" "&""and""& of conditions"
10838 The sub-conditions are evaluated from left to right. The condition is true if
10839 all of the sub-conditions are true. If there are several &"match"&
10840 sub-conditions, the values of the numeric variables afterwards are taken from
10841 the last one. When a false sub-condition is found, the following ones are
10842 parsed but not evaluated.
10843 .endlist
10844 .ecindex IIDexpcond
10845
10846
10847
10848
10849 .section "Expansion variables" "SECTexpvar"
10850 .cindex "expansion" "variables, list of"
10851 This section contains an alphabetical list of all the expansion variables. Some
10852 of them are available only when Exim is compiled with specific options such as
10853 support for TLS or the content scanning extension.
10854
10855 .vlist
10856 .vitem "&$0$&, &$1$&, etc"
10857 .cindex "numerical variables (&$1$& &$2$& etc)"
10858 When a &%match%& expansion condition succeeds, these variables contain the
10859 captured substrings identified by the regular expression during subsequent
10860 processing of the success string of the containing &%if%& expansion item.
10861 However, they do not retain their values afterwards; in fact, their previous
10862 values are restored at the end of processing an &%if%& item. The numerical
10863 variables may also be set externally by some other matching process which
10864 precedes the expansion of the string. For example, the commands available in
10865 Exim filter files include an &%if%& command with its own regular expression
10866 matching condition.
10867
10868 .vitem "&$acl_c...$&"
10869 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10870 can be given any name that starts with &$acl_c$& and is at least six characters
10871 long, but the sixth character must be either a digit or an underscore. For
10872 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10873 variables persist throughout the lifetime of an SMTP connection. They can be
10874 used to pass information between ACLs and between different invocations of the
10875 same ACL. When a message is received, the values of these variables are saved
10876 with the message, and can be accessed by filters, routers, and transports
10877 during subsequent delivery.
10878
10879 .vitem "&$acl_m...$&"
10880 These variables are like the &$acl_c...$& variables, except that their values
10881 are reset after a message has been received. Thus, if several messages are
10882 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10883 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10884 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10885 message is received, the values of these variables are saved with the message,
10886 and can be accessed by filters, routers, and transports during subsequent
10887 delivery.
10888
10889 .vitem &$acl_verify_message$&
10890 .vindex "&$acl_verify_message$&"
10891 After an address verification has failed, this variable contains the failure
10892 message. It retains its value for use in subsequent modifiers. The message can
10893 be preserved by coding like this:
10894 .code
10895 warn !verify = sender
10896      set acl_m0 = $acl_verify_message
10897 .endd
10898 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10899 &%log_message%& modifiers, to include information about the verification
10900 failure.
10901
10902 .vitem &$address_data$&
10903 .vindex "&$address_data$&"
10904 This variable is set by means of the &%address_data%& option in routers. The
10905 value then remains with the address while it is processed by subsequent routers
10906 and eventually a transport. If the transport is handling multiple addresses,
10907 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10908 for more details. &*Note*&: The contents of &$address_data$& are visible in
10909 user filter files.
10910
10911 If &$address_data$& is set when the routers are called from an ACL to verify
10912 a recipient address, the final value is still in the variable for subsequent
10913 conditions and modifiers of the ACL statement. If routing the address caused it
10914 to be redirected to just one address, the child address is also routed as part
10915 of the verification, and in this case the final value of &$address_data$& is
10916 from the child's routing.
10917
10918 If &$address_data$& is set when the routers are called from an ACL to verify a
10919 sender address, the final value is also preserved, but this time in
10920 &$sender_address_data$&, to distinguish it from data from a recipient
10921 address.
10922
10923 In both cases (recipient and sender verification), the value does not persist
10924 after the end of the current ACL statement. If you want to preserve
10925 these values for longer, you can save them in ACL variables.
10926
10927 .vitem &$address_file$&
10928 .vindex "&$address_file$&"
10929 When, as a result of aliasing, forwarding, or filtering, a message is directed
10930 to a specific file, this variable holds the name of the file when the transport
10931 is running. At other times, the variable is empty. For example, using the
10932 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10933 .code
10934 /home/r2d2/savemail
10935 .endd
10936 then when the &(address_file)& transport is running, &$address_file$&
10937 contains the text string &`/home/r2d2/savemail`&.
10938 .cindex "Sieve filter" "value of &$address_file$&"
10939 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10940 then up to the transport configuration to generate an appropriate absolute path
10941 to the relevant file.
10942
10943 .vitem &$address_pipe$&
10944 .vindex "&$address_pipe$&"
10945 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10946 this variable holds the pipe command when the transport is running.
10947
10948 .vitem "&$auth1$& &-- &$auth3$&"
10949 .vindex "&$auth1$&, &$auth2$&, etc"
10950 These variables are used in SMTP authenticators (see chapters
10951 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10952
10953 .vitem &$authenticated_id$&
10954 .cindex "authentication" "id"
10955 .vindex "&$authenticated_id$&"
10956 When a server successfully authenticates a client it may be configured to
10957 preserve some of the authentication information in the variable
10958 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10959 user/password authenticator configuration might preserve the user name for use
10960 in the routers. Note that this is not the same information that is saved in
10961 &$sender_host_authenticated$&.
10962 When a message is submitted locally (that is, not over a TCP connection)
10963 the value of &$authenticated_id$& is normally the login name of the calling
10964 process. However, a trusted user can override this by means of the &%-oMai%&
10965 command line option.
10966
10967 .new
10968 .vitem &$authenticated_fail_id$&
10969 .cindex "authentication" "fail" "id"
10970 .vindex "&$authenticated_fail_id$&"
10971 When an authentication attempt fails, the variable &$authenticated_fail_id$&
10972 will contain the failed authentication id. If more than one authentication
10973 id is attempted, it will contain only the last one. The variable is
10974 available for processing in the ACL's, generally the quit or notquit ACL.
10975 A message to a local recipient could still be accepted without requiring
10976 authentication, which means this variable could also be visible in all of
10977 the ACL's as well.
10978 .wen
10979
10980
10981 .vitem &$authenticated_sender$&
10982 .cindex "sender" "authenticated"
10983 .cindex "authentication" "sender"
10984 .cindex "AUTH" "on MAIL command"
10985 .vindex "&$authenticated_sender$&"
10986 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10987 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10988 described in section &<<SECTauthparamail>>&. Unless the data is the string
10989 &"<>"&, it is set as the authenticated sender of the message, and the value is
10990 available during delivery in the &$authenticated_sender$& variable. If the
10991 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10992
10993 .vindex "&$qualify_domain$&"
10994 When a message is submitted locally (that is, not over a TCP connection), the
10995 value of &$authenticated_sender$& is an address constructed from the login
10996 name of the calling process and &$qualify_domain$&, except that a trusted user
10997 can override this by means of the &%-oMas%& command line option.
10998
10999
11000 .vitem &$authentication_failed$&
11001 .cindex "authentication" "failure"
11002 .vindex "&$authentication_failed$&"
11003 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11004 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11005 possible to distinguish between &"did not try to authenticate"&
11006 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11007 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11008 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11009 negative response to an AUTH command, including (for example) an attempt to use
11010 an undefined mechanism.
11011
11012 .vitem &$av_failed$&
11013 .cindex "content scanning" "AV scanner failure"
11014 This variable is available when Exim is compiled with the content-scanning
11015 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11016 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11017 the ACL malware condition.
11018
11019 .vitem &$body_linecount$&
11020 .cindex "message body" "line count"
11021 .cindex "body of message" "line count"
11022 .vindex "&$body_linecount$&"
11023 When a message is being received or delivered, this variable contains the
11024 number of lines in the message's body. See also &$message_linecount$&.
11025
11026 .vitem &$body_zerocount$&
11027 .cindex "message body" "binary zero count"
11028 .cindex "body of message" "binary zero count"
11029 .cindex "binary zero" "in message body"
11030 .vindex "&$body_zerocount$&"
11031 When a message is being received or delivered, this variable contains the
11032 number of binary zero bytes (ASCII NULs) in the message's body.
11033
11034 .vitem &$bounce_recipient$&
11035 .vindex "&$bounce_recipient$&"
11036 This is set to the recipient address of a bounce message while Exim is creating
11037 it. It is useful if a customized bounce message text file is in use (see
11038 chapter &<<CHAPemsgcust>>&).
11039
11040 .vitem &$bounce_return_size_limit$&
11041 .vindex "&$bounce_return_size_limit$&"
11042 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11043 up to a multiple of 1000. It is useful when a customized error message text
11044 file is in use (see chapter &<<CHAPemsgcust>>&).
11045
11046 .vitem &$caller_gid$&
11047 .cindex "gid (group id)" "caller"
11048 .vindex "&$caller_gid$&"
11049 The real group id under which the process that called Exim was running. This is
11050 not the same as the group id of the originator of a message (see
11051 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11052 incarnation normally contains the Exim gid.
11053
11054 .vitem &$caller_uid$&
11055 .cindex "uid (user id)" "caller"
11056 .vindex "&$caller_uid$&"
11057 The real user id under which the process that called Exim was running. This is
11058 not the same as the user id of the originator of a message (see
11059 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11060 incarnation normally contains the Exim uid.
11061
11062 .vitem &$compile_date$&
11063 .vindex "&$compile_date$&"
11064 The date on which the Exim binary was compiled.
11065
11066 .vitem &$compile_number$&
11067 .vindex "&$compile_number$&"
11068 The building process for Exim keeps a count of the number
11069 of times it has been compiled. This serves to distinguish different
11070 compilations of the same version of the program.
11071
11072 .vitem &$demime_errorlevel$&
11073 .vindex "&$demime_errorlevel$&"
11074 This variable is available when Exim is compiled with
11075 the content-scanning extension and the obsolete &%demime%& condition. For
11076 details, see section &<<SECTdemimecond>>&.
11077
11078 .vitem &$demime_reason$&
11079 .vindex "&$demime_reason$&"
11080 This variable is available when Exim is compiled with the
11081 content-scanning extension and the obsolete &%demime%& condition. For details,
11082 see section &<<SECTdemimecond>>&.
11083
11084 .vitem &$dnslist_domain$& &&&
11085        &$dnslist_matched$& &&&
11086        &$dnslist_text$& &&&
11087        &$dnslist_value$&
11088 .vindex "&$dnslist_domain$&"
11089 .vindex "&$dnslist_matched$&"
11090 .vindex "&$dnslist_text$&"
11091 .vindex "&$dnslist_value$&"
11092 .cindex "black list (DNS)"
11093 When a DNS (black) list lookup succeeds, these variables are set to contain
11094 the following data from the lookup: the list's domain name, the key that was
11095 looked up, the contents of any associated TXT record, and the value from the
11096 main A record. See section &<<SECID204>>& for more details.
11097
11098 .vitem &$domain$&
11099 .vindex "&$domain$&"
11100 When an address is being routed, or delivered on its own, this variable
11101 contains the domain. Uppercase letters in the domain are converted into lower
11102 case for &$domain$&.
11103
11104 Global address rewriting happens when a message is received, so the value of
11105 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11106 is set during user filtering, but not during system filtering, because a
11107 message may have many recipients and the system filter is called just once.
11108
11109 When more than one address is being delivered at once (for example, several
11110 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11111 have the same domain. Transports can be restricted to handling only one domain
11112 at a time if the value of &$domain$& is required at transport time &-- this is
11113 the default for local transports. For further details of the environment in
11114 which local transports are run, see chapter &<<CHAPenvironment>>&.
11115
11116 .oindex "&%delay_warning_condition%&"
11117 At the end of a delivery, if all deferred addresses have the same domain, it is
11118 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11119
11120 The &$domain$& variable is also used in some other circumstances:
11121
11122 .ilist
11123 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11124 the recipient address. The domain of the &'sender'& address is in
11125 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11126 normally set during the running of the MAIL ACL. However, if the sender address
11127 is verified with a callout during the MAIL ACL, the sender domain is placed in
11128 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11129 the &(smtp)& transport.
11130
11131 .next
11132 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11133 &$domain$& contains the domain portion of the address that is being rewritten;
11134 it can be used in the expansion of the replacement address, for example, to
11135 rewrite domains by file lookup.
11136
11137 .next
11138 With one important exception, whenever a domain list is being scanned,
11139 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11140 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11141 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11142 that, in a RCPT ACL, the sender domain list can be dependent on the
11143 recipient domain (which is what is in &$domain$& at this time).
11144
11145 .next
11146 .cindex "ETRN" "value of &$domain$&"
11147 .oindex "&%smtp_etrn_command%&"
11148 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11149 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11150 .endlist
11151
11152
11153 .vitem &$domain_data$&
11154 .vindex "&$domain_data$&"
11155 When the &%domains%& option on a router matches a domain by
11156 means of a lookup, the data read by the lookup is available during the running
11157 of the router as &$domain_data$&. In addition, if the driver routes the
11158 address to a transport, the value is available in that transport. If the
11159 transport is handling multiple addresses, the value from the first address is
11160 used.
11161
11162 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11163 domain by means of a lookup. The data read by the lookup is available during
11164 the rest of the ACL statement. In all other situations, this variable expands
11165 to nothing.
11166
11167 .vitem &$exim_gid$&
11168 .vindex "&$exim_gid$&"
11169 This variable contains the numerical value of the Exim group id.
11170
11171 .vitem &$exim_path$&
11172 .vindex "&$exim_path$&"
11173 This variable contains the path to the Exim binary.
11174
11175 .vitem &$exim_uid$&
11176 .vindex "&$exim_uid$&"
11177 This variable contains the numerical value of the Exim user id.
11178
11179 .vitem &$found_extension$&
11180 .vindex "&$found_extension$&"
11181 This variable is available when Exim is compiled with the
11182 content-scanning extension and the obsolete &%demime%& condition. For details,
11183 see section &<<SECTdemimecond>>&.
11184
11185 .vitem &$header_$&<&'name'&>
11186 This is not strictly an expansion variable. It is expansion syntax for
11187 inserting the message header line with the given name. Note that the name must
11188 be terminated by colon or white space, because it may contain a wide variety of
11189 characters. Note also that braces must &'not'& be used.
11190
11191 .new
11192 .vitem &$headers_added$&
11193 .vindex "&$headers_added$&"
11194 Within an ACL this variable contains the headers added so far by
11195 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11196 The headers are a newline-separated list.
11197 .wen
11198
11199 .vitem &$home$&
11200 .vindex "&$home$&"
11201 When the &%check_local_user%& option is set for a router, the user's home
11202 directory is placed in &$home$& when the check succeeds. In particular, this
11203 means it is set during the running of users' filter files. A router may also
11204 explicitly set a home directory for use by a transport; this can be overridden
11205 by a setting on the transport itself.
11206
11207 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11208 of the environment variable HOME.
11209
11210 .vitem &$host$&
11211 .vindex "&$host$&"
11212 If a router assigns an address to a transport (any transport), and passes a
11213 list of hosts with the address, the value of &$host$& when the transport starts
11214 to run is the name of the first host on the list. Note that this applies both
11215 to local and remote transports.
11216
11217 .cindex "transport" "filter"
11218 .cindex "filter" "transport filter"
11219 For the &(smtp)& transport, if there is more than one host, the value of
11220 &$host$& changes as the transport works its way through the list. In
11221 particular, when the &(smtp)& transport is expanding its options for encryption
11222 using TLS, or for specifying a transport filter (see chapter
11223 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11224 is connected.
11225
11226 When used in the client part of an authenticator configuration (see chapter
11227 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11228 client is connected.
11229
11230
11231 .vitem &$host_address$&
11232 .vindex "&$host_address$&"
11233 This variable is set to the remote host's IP address whenever &$host$& is set
11234 for a remote connection. It is also set to the IP address that is being checked
11235 when the &%ignore_target_hosts%& option is being processed.
11236
11237 .vitem &$host_data$&
11238 .vindex "&$host_data$&"
11239 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11240 result of the lookup is made available in the &$host_data$& variable. This
11241 allows you, for example, to do things like this:
11242 .code
11243 deny  hosts = net-lsearch;/some/file
11244 message = $host_data
11245 .endd
11246 .vitem &$host_lookup_deferred$&
11247 .cindex "host name" "lookup, failure of"
11248 .vindex "&$host_lookup_deferred$&"
11249 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11250 message comes from a remote host and there is an attempt to look up the host's
11251 name from its IP address, and the attempt is not successful, one of these
11252 variables is set to &"1"&.
11253
11254 .ilist
11255 If the lookup receives a definite negative response (for example, a DNS lookup
11256 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11257
11258 .next
11259 If there is any kind of problem during the lookup, such that Exim cannot
11260 tell whether or not the host name is defined (for example, a timeout for a DNS
11261 lookup), &$host_lookup_deferred$& is set to &"1"&.
11262 .endlist ilist
11263
11264 Looking up a host's name from its IP address consists of more than just a
11265 single reverse lookup. Exim checks that a forward lookup of at least one of the
11266 names it receives from a reverse lookup yields the original IP address. If this
11267 is not the case, Exim does not accept the looked up name(s), and
11268 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11269 IP address (for example, the existence of a PTR record in the DNS) is not
11270 sufficient on its own for the success of a host name lookup. If the reverse
11271 lookup succeeds, but there is a lookup problem such as a timeout when checking
11272 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11273 &"1"&. See also &$sender_host_name$&.
11274
11275 .vitem &$host_lookup_failed$&
11276 .vindex "&$host_lookup_failed$&"
11277 See &$host_lookup_deferred$&.
11278
11279
11280 .vitem &$inode$&
11281 .vindex "&$inode$&"
11282 The only time this variable is set is while expanding the &%directory_file%&
11283 option in the &(appendfile)& transport. The variable contains the inode number
11284 of the temporary file which is about to be renamed. It can be used to construct
11285 a unique name for the file.
11286
11287 .vitem &$interface_address$&
11288 .vindex "&$interface_address$&"
11289 This is an obsolete name for &$received_ip_address$&.
11290
11291 .vitem &$interface_port$&
11292 .vindex "&$interface_port$&"
11293 This is an obsolete name for &$received_port$&.
11294
11295 .vitem &$item$&
11296 .vindex "&$item$&"
11297 This variable is used during the expansion of &*forall*& and &*forany*&
11298 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11299 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11300 empty.
11301
11302 .vitem &$ldap_dn$&
11303 .vindex "&$ldap_dn$&"
11304 This variable, which is available only when Exim is compiled with LDAP support,
11305 contains the DN from the last entry in the most recently successful LDAP
11306 lookup.
11307
11308 .vitem &$load_average$&
11309 .vindex "&$load_average$&"
11310 This variable contains the system load average, multiplied by 1000 so that it
11311 is an integer. For example, if the load average is 0.21, the value of the
11312 variable is 210. The value is recomputed every time the variable is referenced.
11313
11314 .vitem &$local_part$&
11315 .vindex "&$local_part$&"
11316 When an address is being routed, or delivered on its own, this
11317 variable contains the local part. When a number of addresses are being
11318 delivered together (for example, multiple RCPT commands in an SMTP
11319 session), &$local_part$& is not set.
11320
11321 Global address rewriting happens when a message is received, so the value of
11322 &$local_part$& during routing and delivery is the value after rewriting.
11323 &$local_part$& is set during user filtering, but not during system filtering,
11324 because a message may have many recipients and the system filter is called just
11325 once.
11326
11327 .vindex "&$local_part_prefix$&"
11328 .vindex "&$local_part_suffix$&"
11329 If a local part prefix or suffix has been recognized, it is not included in the
11330 value of &$local_part$& during routing and subsequent delivery. The values of
11331 any prefix or suffix are in &$local_part_prefix$& and
11332 &$local_part_suffix$&, respectively.
11333
11334 When a message is being delivered to a file, pipe, or autoreply transport as a
11335 result of aliasing or forwarding, &$local_part$& is set to the local part of
11336 the parent address, not to the file name or command (see &$address_file$& and
11337 &$address_pipe$&).
11338
11339 When an ACL is running for a RCPT command, &$local_part$& contains the
11340 local part of the recipient address.
11341
11342 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11343 &$local_part$& contains the local part of the address that is being rewritten;
11344 it can be used in the expansion of the replacement address, for example.
11345
11346 In all cases, all quoting is removed from the local part. For example, for both
11347 the addresses
11348 .code
11349 "abc:xyz"@test.example
11350 abc\:xyz@test.example
11351 .endd
11352 the value of &$local_part$& is
11353 .code
11354 abc:xyz
11355 .endd
11356 If you use &$local_part$& to create another address, you should always wrap it
11357 inside a quoting operator. For example, in a &(redirect)& router you could
11358 have:
11359 .code
11360 data = ${quote_local_part:$local_part}@new.domain.example
11361 .endd
11362 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11363 to process local parts in a case-dependent manner in a router, you can set the
11364 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11365
11366 .vitem &$local_part_data$&
11367 .vindex "&$local_part_data$&"
11368 When the &%local_parts%& option on a router matches a local part by means of a
11369 lookup, the data read by the lookup is available during the running of the
11370 router as &$local_part_data$&. In addition, if the driver routes the address
11371 to a transport, the value is available in that transport. If the transport is
11372 handling multiple addresses, the value from the first address is used.
11373
11374 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11375 matches a local part by means of a lookup. The data read by the lookup is
11376 available during the rest of the ACL statement. In all other situations, this
11377 variable expands to nothing.
11378
11379 .vitem &$local_part_prefix$&
11380 .vindex "&$local_part_prefix$&"
11381 When an address is being routed or delivered, and a
11382 specific prefix for the local part was recognized, it is available in this
11383 variable, having been removed from &$local_part$&.
11384
11385 .vitem &$local_part_suffix$&
11386 .vindex "&$local_part_suffix$&"
11387 When an address is being routed or delivered, and a
11388 specific suffix for the local part was recognized, it is available in this
11389 variable, having been removed from &$local_part$&.
11390
11391 .vitem &$local_scan_data$&
11392 .vindex "&$local_scan_data$&"
11393 This variable contains the text returned by the &[local_scan()]& function when
11394 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11395
11396 .vitem &$local_user_gid$&
11397 .vindex "&$local_user_gid$&"
11398 See &$local_user_uid$&.
11399
11400 .vitem &$local_user_uid$&
11401 .vindex "&$local_user_uid$&"
11402 This variable and &$local_user_gid$& are set to the uid and gid after the
11403 &%check_local_user%& router precondition succeeds. This means that their values
11404 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11405 and &%condition%&), for the &%address_data%& expansion, and for any
11406 router-specific expansions. At all other times, the values in these variables
11407 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11408
11409 .vitem &$localhost_number$&
11410 .vindex "&$localhost_number$&"
11411 This contains the expanded value of the
11412 &%localhost_number%& option. The expansion happens after the main options have
11413 been read.
11414
11415 .vitem &$log_inodes$&
11416 .vindex "&$log_inodes$&"
11417 The number of free inodes in the disk partition where Exim's
11418 log files are being written. The value is recalculated whenever the variable is
11419 referenced. If the relevant file system does not have the concept of inodes,
11420 the value of is -1. See also the &%check_log_inodes%& option.
11421
11422 .vitem &$log_space$&
11423 .vindex "&$log_space$&"
11424 The amount of free space (as a number of kilobytes) in the disk
11425 partition where Exim's log files are being written. The value is recalculated
11426 whenever the variable is referenced. If the operating system does not have the
11427 ability to find the amount of free space (only true for experimental systems),
11428 the space value is -1. See also the &%check_log_space%& option.
11429
11430
11431 .vitem &$mailstore_basename$&
11432 .vindex "&$mailstore_basename$&"
11433 This variable is set only when doing deliveries in &"mailstore"& format in the
11434 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11435 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11436 contains the basename of the files that are being written, that is, the name
11437 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11438 variable is empty.
11439
11440 .vitem &$malware_name$&
11441 .vindex "&$malware_name$&"
11442 This variable is available when Exim is compiled with the
11443 content-scanning extension. It is set to the name of the virus that was found
11444 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11445
11446 .vitem &$max_received_linelength$&
11447 .vindex "&$max_received_linelength$&"
11448 .cindex "maximum" "line length"
11449 .cindex "line length" "maximum"
11450 This variable contains the number of bytes in the longest line that was
11451 received as part of the message, not counting the line termination
11452 character(s).
11453
11454 .vitem &$message_age$&
11455 .cindex "message" "age of"
11456 .vindex "&$message_age$&"
11457 This variable is set at the start of a delivery attempt to contain the number
11458 of seconds since the message was received. It does not change during a single
11459 delivery attempt.
11460
11461 .vitem &$message_body$&
11462 .cindex "body of message" "expansion variable"
11463 .cindex "message body" "in expansion"
11464 .cindex "binary zero" "in message body"
11465 .vindex "&$message_body$&"
11466 .oindex "&%message_body_visible%&"
11467 This variable contains the initial portion of a message's body while it is
11468 being delivered, and is intended mainly for use in filter files. The maximum
11469 number of characters of the body that are put into the variable is set by the
11470 &%message_body_visible%& configuration option; the default is 500.
11471
11472 .oindex "&%message_body_newlines%&"
11473 By default, newlines are converted into spaces in &$message_body$&, to make it
11474 easier to search for phrases that might be split over a line break. However,
11475 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11476 zeros are always converted into spaces.
11477
11478 .vitem &$message_body_end$&
11479 .cindex "body of message" "expansion variable"
11480 .cindex "message body" "in expansion"
11481 .vindex "&$message_body_end$&"
11482 This variable contains the final portion of a message's
11483 body while it is being delivered. The format and maximum size are as for
11484 &$message_body$&.
11485
11486 .vitem &$message_body_size$&
11487 .cindex "body of message" "size"
11488 .cindex "message body" "size"
11489 .vindex "&$message_body_size$&"
11490 When a message is being delivered, this variable contains the size of the body
11491 in bytes. The count starts from the character after the blank line that
11492 separates the body from the header. Newlines are included in the count. See
11493 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11494
11495 .vitem &$message_exim_id$&
11496 .vindex "&$message_exim_id$&"
11497 When a message is being received or delivered, this variable contains the
11498 unique message id that is generated and used by Exim to identify the message.
11499 An id is not created for a message until after its header has been successfully
11500 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11501 line; it is the local id that Exim assigns to the message, for example:
11502 &`1BXTIK-0001yO-VA`&.
11503
11504 .vitem &$message_headers$&
11505 .vindex &$message_headers$&
11506 This variable contains a concatenation of all the header lines when a message
11507 is being processed, except for lines added by routers or transports. The header
11508 lines are separated by newline characters. Their contents are decoded in the
11509 same way as a header line that is inserted by &%bheader%&.
11510
11511 .vitem &$message_headers_raw$&
11512 .vindex &$message_headers_raw$&
11513 This variable is like &$message_headers$& except that no processing of the
11514 contents of header lines is done.
11515
11516 .vitem &$message_id$&
11517 This is an old name for &$message_exim_id$&, which is now deprecated.
11518
11519 .vitem &$message_linecount$&
11520 .vindex "&$message_linecount$&"
11521 This variable contains the total number of lines in the header and body of the
11522 message. Compare &$body_linecount$&, which is the count for the body only.
11523 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11524 number of lines received. Before delivery happens (that is, before filters,
11525 routers, and transports run) the count is increased to include the
11526 &'Received:'& header line that Exim standardly adds, and also any other header
11527 lines that are added by ACLs. The blank line that separates the message header
11528 from the body is not counted.
11529
11530 As with the special case of &$message_size$&, during the expansion of the
11531 appendfile transport's maildir_tag option in maildir format, the value of
11532 &$message_linecount$& is the precise size of the number of newlines in the
11533 file that has been written (minus one for the blank line between the
11534 header and the body).
11535
11536 Here is an example of the use of this variable in a DATA ACL:
11537 .code
11538 deny message   = Too many lines in message header
11539      condition = \
11540       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11541 .endd
11542 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11543 message has not yet been received.
11544
11545 .vitem &$message_size$&
11546 .cindex "size" "of message"
11547 .cindex "message" "size"
11548 .vindex "&$message_size$&"
11549 When a message is being processed, this variable contains its size in bytes. In
11550 most cases, the size includes those headers that were received with the
11551 message, but not those (such as &'Envelope-to:'&) that are added to individual
11552 deliveries as they are written. However, there is one special case: during the
11553 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11554 doing a delivery in maildir format, the value of &$message_size$& is the
11555 precise size of the file that has been written. See also
11556 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11557
11558 .cindex "RCPT" "value of &$message_size$&"
11559 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11560 contains the size supplied on the MAIL command, or -1 if no size was given. The
11561 value may not, of course, be truthful.
11562
11563 .vitem &$mime_$&&'xxx'&
11564 A number of variables whose names start with &$mime$& are
11565 available when Exim is compiled with the content-scanning extension. For
11566 details, see section &<<SECTscanmimepart>>&.
11567
11568 .vitem "&$n0$& &-- &$n9$&"
11569 These variables are counters that can be incremented by means
11570 of the &%add%& command in filter files.
11571
11572 .vitem &$original_domain$&
11573 .vindex "&$domain$&"
11574 .vindex "&$original_domain$&"
11575 When a top-level address is being processed for delivery, this contains the
11576 same value as &$domain$&. However, if a &"child"& address (for example,
11577 generated by an alias, forward, or filter file) is being processed, this
11578 variable contains the domain of the original address (lower cased). This
11579 differs from &$parent_domain$& only when there is more than one level of
11580 aliasing or forwarding. When more than one address is being delivered in a
11581 single transport run, &$original_domain$& is not set.
11582
11583 If a new address is created by means of a &%deliver%& command in a system
11584 filter, it is set up with an artificial &"parent"& address. This has the local
11585 part &'system-filter'& and the default qualify domain.
11586
11587 .vitem &$original_local_part$&
11588 .vindex "&$local_part$&"
11589 .vindex "&$original_local_part$&"
11590 When a top-level address is being processed for delivery, this contains the
11591 same value as &$local_part$&, unless a prefix or suffix was removed from the
11592 local part, because &$original_local_part$& always contains the full local
11593 part. When a &"child"& address (for example, generated by an alias, forward, or
11594 filter file) is being processed, this variable contains the full local part of
11595 the original address.
11596
11597 If the router that did the redirection processed the local part
11598 case-insensitively, the value in &$original_local_part$& is in lower case.
11599 This variable differs from &$parent_local_part$& only when there is more than
11600 one level of aliasing or forwarding. When more than one address is being
11601 delivered in a single transport run, &$original_local_part$& is not set.
11602
11603 If a new address is created by means of a &%deliver%& command in a system
11604 filter, it is set up with an artificial &"parent"& address. This has the local
11605 part &'system-filter'& and the default qualify domain.
11606
11607 .vitem &$originator_gid$&
11608 .cindex "gid (group id)" "of originating user"
11609 .cindex "sender" "gid"
11610 .vindex "&$caller_gid$&"
11611 .vindex "&$originator_gid$&"
11612 This variable contains the value of &$caller_gid$& that was set when the
11613 message was received. For messages received via the command line, this is the
11614 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11615 normally the gid of the Exim user.
11616
11617 .vitem &$originator_uid$&
11618 .cindex "uid (user id)" "of originating user"
11619 .cindex "sender" "uid"
11620 .vindex "&$caller_uid$&"
11621 .vindex "&$originaltor_uid$&"
11622 The value of &$caller_uid$& that was set when the message was received. For
11623 messages received via the command line, this is the uid of the sending user.
11624 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11625 user.
11626
11627 .vitem &$parent_domain$&
11628 .vindex "&$parent_domain$&"
11629 This variable is similar to &$original_domain$& (see
11630 above), except that it refers to the immediately preceding parent address.
11631
11632 .vitem &$parent_local_part$&
11633 .vindex "&$parent_local_part$&"
11634 This variable is similar to &$original_local_part$&
11635 (see above), except that it refers to the immediately preceding parent address.
11636
11637 .vitem &$pid$&
11638 .cindex "pid (process id)" "of current process"
11639 .vindex "&$pid$&"
11640 This variable contains the current process id.
11641
11642 .vitem &$pipe_addresses$&
11643 .cindex "filter" "transport filter"
11644 .cindex "transport" "filter"
11645 .vindex "&$pipe_addresses$&"
11646 This is not an expansion variable, but is mentioned here because the string
11647 &`$pipe_addresses`& is handled specially in the command specification for the
11648 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11649 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11650 It cannot be used in general expansion strings, and provokes an &"unknown
11651 variable"& error if encountered.
11652
11653 .vitem &$primary_hostname$&
11654 .vindex "&$primary_hostname$&"
11655 This variable contains the value set by &%primary_hostname%& in the
11656 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11657 a single-component name, Exim calls &[gethostbyname()]& (or
11658 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11659 qualified host name. See also &$smtp_active_hostname$&.
11660
11661
11662 .vitem &$prvscheck_address$&
11663 This variable is used in conjunction with the &%prvscheck%& expansion item,
11664 which is described in sections &<<SECTexpansionitems>>& and
11665 &<<SECTverifyPRVS>>&.
11666
11667 .vitem &$prvscheck_keynum$&
11668 This variable is used in conjunction with the &%prvscheck%& expansion item,
11669 which is described in sections &<<SECTexpansionitems>>& and
11670 &<<SECTverifyPRVS>>&.
11671
11672 .vitem &$prvscheck_result$&
11673 This variable is used in conjunction with the &%prvscheck%& expansion item,
11674 which is described in sections &<<SECTexpansionitems>>& and
11675 &<<SECTverifyPRVS>>&.
11676
11677 .vitem &$qualify_domain$&
11678 .vindex "&$qualify_domain$&"
11679 The value set for the &%qualify_domain%& option in the configuration file.
11680
11681 .vitem &$qualify_recipient$&
11682 .vindex "&$qualify_recipient$&"
11683 The value set for the &%qualify_recipient%& option in the configuration file,
11684 or if not set, the value of &$qualify_domain$&.
11685
11686 .vitem &$rcpt_count$&
11687 .vindex "&$rcpt_count$&"
11688 When a message is being received by SMTP, this variable contains the number of
11689 RCPT commands received for the current message. If this variable is used in a
11690 RCPT ACL, its value includes the current command.
11691
11692 .vitem &$rcpt_defer_count$&
11693 .vindex "&$rcpt_defer_count$&"
11694 .cindex "4&'xx'& responses" "count of"
11695 When a message is being received by SMTP, this variable contains the number of
11696 RCPT commands in the current message that have previously been rejected with a
11697 temporary (4&'xx'&) response.
11698
11699 .vitem &$rcpt_fail_count$&
11700 .vindex "&$rcpt_fail_count$&"
11701 When a message is being received by SMTP, this variable contains the number of
11702 RCPT commands in the current message that have previously been rejected with a
11703 permanent (5&'xx'&) response.
11704
11705 .vitem &$received_count$&
11706 .vindex "&$received_count$&"
11707 This variable contains the number of &'Received:'& header lines in the message,
11708 including the one added by Exim (so its value is always greater than zero). It
11709 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11710 delivering.
11711
11712 .vitem &$received_for$&
11713 .vindex "&$received_for$&"
11714 If there is only a single recipient address in an incoming message, this
11715 variable contains that address when the &'Received:'& header line is being
11716 built. The value is copied after recipient rewriting has happened, but before
11717 the &[local_scan()]& function is run.
11718
11719 .vitem &$received_ip_address$&
11720 .vindex "&$received_ip_address$&"
11721 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11722 variable is set to the address of the local IP interface, and &$received_port$&
11723 is set to the local port number. (The remote IP address and port are in
11724 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11725 the port value is -1 unless it has been set using the &%-oMi%& command line
11726 option.
11727
11728 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11729 could be used, for example, to make the file name for a TLS certificate depend
11730 on which interface and/or port is being used for the incoming connection. The
11731 values of &$received_ip_address$& and &$received_port$& are saved with any
11732 messages that are received, thus making these variables available at delivery
11733 time.
11734
11735 &*Note:*& There are no equivalent variables for outgoing connections, because
11736 the values are unknown (unless they are explicitly set by options of the
11737 &(smtp)& transport).
11738
11739 .vitem &$received_port$&
11740 .vindex "&$received_port$&"
11741 See &$received_ip_address$&.
11742
11743 .vitem &$received_protocol$&
11744 .vindex "&$received_protocol$&"
11745 When a message is being processed, this variable contains the name of the
11746 protocol by which it was received. Most of the names used by Exim are defined
11747 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11748 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11749 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11750 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11751 connection and the client was successfully authenticated.
11752
11753 Exim uses the protocol name &"smtps"& for the case when encryption is
11754 automatically set up on connection without the use of STARTTLS (see
11755 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11756 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11757 where the client initially uses EHLO, sets up an encrypted connection using
11758 STARTTLS, and then uses HELO afterwards.
11759
11760 The &%-oMr%& option provides a way of specifying a custom protocol name for
11761 messages that are injected locally by trusted callers. This is commonly used to
11762 identify messages that are being re-injected after some kind of scanning.
11763
11764 .vitem &$received_time$&
11765 .vindex "&$received_time$&"
11766 This variable contains the date and time when the current message was received,
11767 as a number of seconds since the start of the Unix epoch.
11768
11769 .vitem &$recipient_data$&
11770 .vindex "&$recipient_data$&"
11771 This variable is set after an indexing lookup success in an ACL &%recipients%&
11772 condition. It contains the data from the lookup, and the value remains set
11773 until the next &%recipients%& test. Thus, you can do things like this:
11774 .display
11775 &`require recipients  = cdb*@;/some/file`&
11776 &`deny    `&&'some further test involving'& &`$recipient_data`&
11777 .endd
11778 &*Warning*&: This variable is set only when a lookup is used as an indexing
11779 method in the address list, using the semicolon syntax as in the example above.
11780 The variable is not set for a lookup that is used as part of the string
11781 expansion that all such lists undergo before being interpreted.
11782
11783 .vitem &$recipient_verify_failure$&
11784 .vindex "&$recipient_verify_failure$&"
11785 In an ACL, when a recipient verification fails, this variable contains
11786 information about the failure. It is set to one of the following words:
11787
11788 .ilist
11789 &"qualify"&: The address was unqualified (no domain), and the message
11790 was neither local nor came from an exempted host.
11791
11792 .next
11793 &"route"&: Routing failed.
11794
11795 .next
11796 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11797 or before the MAIL command (that is, on initial connection, HELO, or
11798 MAIL).
11799
11800 .next
11801 &"recipient"&: The RCPT command in a callout was rejected.
11802 .next
11803
11804 &"postmaster"&: The postmaster check in a callout was rejected.
11805 .endlist
11806
11807 The main use of this variable is expected to be to distinguish between
11808 rejections of MAIL and rejections of RCPT.
11809
11810 .vitem &$recipients$&
11811 .vindex "&$recipients$&"
11812 This variable contains a list of envelope recipients for a message. A comma and
11813 a space separate the addresses in the replacement text. However, the variable
11814 is not generally available, to prevent exposure of Bcc recipients in
11815 unprivileged users' filter files. You can use &$recipients$& only in these
11816 cases:
11817
11818 .olist
11819 In a system filter file.
11820 .next
11821 In the ACLs associated with the DATA command and with non-SMTP messages, that
11822 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11823 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11824 &%acl_not_smtp_mime%&.
11825 .next
11826 From within a &[local_scan()]& function.
11827 .endlist
11828
11829
11830 .vitem &$recipients_count$&
11831 .vindex "&$recipients_count$&"
11832 When a message is being processed, this variable contains the number of
11833 envelope recipients that came with the message. Duplicates are not excluded
11834 from the count. While a message is being received over SMTP, the number
11835 increases for each accepted recipient. It can be referenced in an ACL.
11836
11837
11838 .vitem &$regex_match_string$&
11839 .vindex "&$regex_match_string$&"
11840 This variable is set to contain the matching regular expression after a
11841 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11842
11843
11844 .vitem &$reply_address$&
11845 .vindex "&$reply_address$&"
11846 When a message is being processed, this variable contains the contents of the
11847 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11848 contents of the &'From:'& header line. Apart from the removal of leading
11849 white space, the value is not processed in any way. In particular, no RFC 2047
11850 decoding or character code translation takes place.
11851
11852 .vitem &$return_path$&
11853 .vindex "&$return_path$&"
11854 When a message is being delivered, this variable contains the return path &--
11855 the sender field that will be sent as part of the envelope. It is not enclosed
11856 in <> characters. At the start of routing an address, &$return_path$& has the
11857 same value as &$sender_address$&, but if, for example, an incoming message to a
11858 mailing list has been expanded by a router which specifies a different address
11859 for bounce messages, &$return_path$& subsequently contains the new bounce
11860 address, whereas &$sender_address$& always contains the original sender address
11861 that was received with the message. In other words, &$sender_address$& contains
11862 the incoming envelope sender, and &$return_path$& contains the outgoing
11863 envelope sender.
11864
11865 .vitem &$return_size_limit$&
11866 .vindex "&$return_size_limit$&"
11867 This is an obsolete name for &$bounce_return_size_limit$&.
11868
11869 .new
11870 .vitem &$router_name$&
11871 .cindex "router" "name"
11872 .cindex "name" "of router"
11873 .vindex "&$router_name$&"
11874 During the running of a router this variable contains its name.
11875 .wen
11876
11877 .vitem &$runrc$&
11878 .cindex "return code" "from &%run%& expansion"
11879 .vindex "&$runrc$&"
11880 This variable contains the return code from a command that is run by the
11881 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11882 assume the order in which option values are expanded, except for those
11883 preconditions whose order of testing is documented. Therefore, you cannot
11884 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11885 another.
11886
11887 .vitem &$self_hostname$&
11888 .oindex "&%self%&" "value of host name"
11889 .vindex "&$self_hostname$&"
11890 When an address is routed to a supposedly remote host that turns out to be the
11891 local host, what happens is controlled by the &%self%& generic router option.
11892 One of its values causes the address to be passed to another router. When this
11893 happens, &$self_hostname$& is set to the name of the local host that the
11894 original router encountered. In other circumstances its contents are null.
11895
11896 .vitem &$sender_address$&
11897 .vindex "&$sender_address$&"
11898 When a message is being processed, this variable contains the sender's address
11899 that was received in the message's envelope. The case of letters in the address
11900 is retained, in both the local part and the domain. For bounce messages, the
11901 value of this variable is the empty string. See also &$return_path$&.
11902
11903 .vitem &$sender_address_data$&
11904 .vindex "&$address_data$&"
11905 .vindex "&$sender_address_data$&"
11906 If &$address_data$& is set when the routers are called from an ACL to verify a
11907 sender address, the final value is preserved in &$sender_address_data$&, to
11908 distinguish it from data from a recipient address. The value does not persist
11909 after the end of the current ACL statement. If you want to preserve it for
11910 longer, you can save it in an ACL variable.
11911
11912 .vitem &$sender_address_domain$&
11913 .vindex "&$sender_address_domain$&"
11914 The domain portion of &$sender_address$&.
11915
11916 .vitem &$sender_address_local_part$&
11917 .vindex "&$sender_address_local_part$&"
11918 The local part portion of &$sender_address$&.
11919
11920 .vitem &$sender_data$&
11921 .vindex "&$sender_data$&"
11922 This variable is set after a lookup success in an ACL &%senders%& condition or
11923 in a router &%senders%& option. It contains the data from the lookup, and the
11924 value remains set until the next &%senders%& test. Thus, you can do things like
11925 this:
11926 .display
11927 &`require senders      = cdb*@;/some/file`&
11928 &`deny    `&&'some further test involving'& &`$sender_data`&
11929 .endd
11930 &*Warning*&: This variable is set only when a lookup is used as an indexing
11931 method in the address list, using the semicolon syntax as in the example above.
11932 The variable is not set for a lookup that is used as part of the string
11933 expansion that all such lists undergo before being interpreted.
11934
11935 .vitem &$sender_fullhost$&
11936 .vindex "&$sender_fullhost$&"
11937 When a message is received from a remote host, this variable contains the host
11938 name and IP address in a single string. It ends with the IP address in square
11939 brackets, followed by a colon and a port number if the logging of ports is
11940 enabled. The format of the rest of the string depends on whether the host
11941 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11942 looking up its IP address. (Looking up the IP address can be forced by the
11943 &%host_lookup%& option, independent of verification.) A plain host name at the
11944 start of the string is a verified host name; if this is not present,
11945 verification either failed or was not requested. A host name in parentheses is
11946 the argument of a HELO or EHLO command. This is omitted if it is identical to
11947 the verified host name or to the host's IP address in square brackets.
11948
11949 .vitem &$sender_helo_name$&
11950 .vindex "&$sender_helo_name$&"
11951 When a message is received from a remote host that has issued a HELO or EHLO
11952 command, the argument of that command is placed in this variable. It is also
11953 set if HELO or EHLO is used when a message is received using SMTP locally via
11954 the &%-bs%& or &%-bS%& options.
11955
11956 .vitem &$sender_host_address$&
11957 .vindex "&$sender_host_address$&"
11958 When a message is received from a remote host, this variable contains that
11959 host's IP address. For locally submitted messages, it is empty.
11960
11961 .vitem &$sender_host_authenticated$&
11962 .vindex "&$sender_host_authenticated$&"
11963 This variable contains the name (not the public name) of the authenticator
11964 driver that successfully authenticated the client from which the message was
11965 received. It is empty if there was no successful authentication. See also
11966 &$authenticated_id$&.
11967
11968 .new
11969 .vitem &$sender_host_dnssec$&
11970 .vindex "&$sender_host_dnssec$&"
11971 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11972 otherwise) then this boolean will have been set true if, and only if, the
11973 resolver library states that the reverse DNS was authenticated data.  At all
11974 other times, this variable is false.
11975
11976 It is likely that you will need to coerce DNSSEC support on in the resolver
11977 library, by setting:
11978 .code
11979 dns_use_dnssec = 1
11980 .endd
11981
11982 Exim does not perform DNSSEC validation itself, instead leaving that to a
11983 validating resolver (eg, unbound, or bind with suitable configuration).
11984
11985 Exim does not (currently) check to see if the forward DNS was also secured
11986 with DNSSEC, only the reverse DNS.
11987
11988 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11989 mechanism in the list, then this variable will be false.
11990 .wen
11991
11992
11993 .vitem &$sender_host_name$&
11994 .vindex "&$sender_host_name$&"
11995 When a message is received from a remote host, this variable contains the
11996 host's name as obtained by looking up its IP address. For messages received by
11997 other means, this variable is empty.
11998
11999 .vindex "&$host_lookup_failed$&"
12000 If the host name has not previously been looked up, a reference to
12001 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12002 A looked up name is accepted only if it leads back to the original IP address
12003 via a forward lookup. If either the reverse or the forward lookup fails to find
12004 any data, or if the forward lookup does not yield the original IP address,
12005 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12006
12007 .vindex "&$host_lookup_deferred$&"
12008 However, if either of the lookups cannot be completed (for example, there is a
12009 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12010 &$host_lookup_failed$& remains set to &"0"&.
12011
12012 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12013 host name again if there is a subsequent reference to &$sender_host_name$&
12014 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12015 is set to &"1"&.
12016
12017 Exim does not automatically look up every calling host's name. If you want
12018 maximum efficiency, you should arrange your configuration so that it avoids
12019 these lookups altogether. The lookup happens only if one or more of the
12020 following are true:
12021
12022 .ilist
12023 A string containing &$sender_host_name$& is expanded.
12024 .next
12025 The calling host matches the list in &%host_lookup%&. In the default
12026 configuration, this option is set to *, so it must be changed if lookups are
12027 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12028 .next
12029 Exim needs the host name in order to test an item in a host list. The items
12030 that require this are described in sections &<<SECThoslispatnam>>& and
12031 &<<SECThoslispatnamsk>>&.
12032 .next
12033 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12034 In this case, the host name is required to compare with the name quoted in any
12035 EHLO or HELO commands that the client issues.
12036 .next
12037 The remote host issues a EHLO or HELO command that quotes one of the
12038 domains in &%helo_lookup_domains%&. The default value of this option is
12039 . ==== As this is a nested list, any displays it contains must be indented
12040 . ==== as otherwise they are too far to the left.
12041 .code
12042   helo_lookup_domains = @ : @[]
12043 .endd
12044 which causes a lookup if a remote host (incorrectly) gives the server's name or
12045 IP address in an EHLO or HELO command.
12046 .endlist
12047
12048
12049 .vitem &$sender_host_port$&
12050 .vindex "&$sender_host_port$&"
12051 When a message is received from a remote host, this variable contains the port
12052 number that was used on the remote host.
12053
12054 .vitem &$sender_ident$&
12055 .vindex "&$sender_ident$&"
12056 When a message is received from a remote host, this variable contains the
12057 identification received in response to an RFC 1413 request. When a message has
12058 been received locally, this variable contains the login name of the user that
12059 called Exim.
12060
12061 .vitem &$sender_rate_$&&'xxx'&
12062 A number of variables whose names begin &$sender_rate_$& are set as part of the
12063 &%ratelimit%& ACL condition. Details are given in section
12064 &<<SECTratelimiting>>&.
12065
12066 .vitem &$sender_rcvhost$&
12067 .cindex "DNS" "reverse lookup"
12068 .cindex "reverse DNS lookup"
12069 .vindex "&$sender_rcvhost$&"
12070 This is provided specifically for use in &'Received:'& headers. It starts with
12071 either the verified host name (as obtained from a reverse DNS lookup) or, if
12072 there is no verified host name, the IP address in square brackets. After that
12073 there may be text in parentheses. When the first item is a verified host name,
12074 the first thing in the parentheses is the IP address in square brackets,
12075 followed by a colon and a port number if port logging is enabled. When the
12076 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12077 the parentheses.
12078
12079 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12080 was used and its argument was not identical to the real host name or IP
12081 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12082 all three items are present in the parentheses, a newline and tab are inserted
12083 into the string, to improve the formatting of the &'Received:'& header.
12084
12085 .vitem &$sender_verify_failure$&
12086 .vindex "&$sender_verify_failure$&"
12087 In an ACL, when a sender verification fails, this variable contains information
12088 about the failure. The details are the same as for
12089 &$recipient_verify_failure$&.
12090
12091 .vitem &$sending_ip_address$&
12092 .vindex "&$sending_ip_address$&"
12093 This variable is set whenever an outgoing SMTP connection to another host has
12094 been set up. It contains the IP address of the local interface that is being
12095 used. This is useful if a host that has more than one IP address wants to take
12096 on different personalities depending on which one is being used. For incoming
12097 connections, see &$received_ip_address$&.
12098
12099 .vitem &$sending_port$&
12100 .vindex "&$sending_port$&"
12101 This variable is set whenever an outgoing SMTP connection to another host has
12102 been set up. It contains the local port that is being used. For incoming
12103 connections, see &$received_port$&.
12104
12105 .vitem &$smtp_active_hostname$&
12106 .vindex "&$smtp_active_hostname$&"
12107 During an incoming SMTP session, this variable contains the value of the active
12108 host name, as specified by the &%smtp_active_hostname%& option. The value of
12109 &$smtp_active_hostname$& is saved with any message that is received, so its
12110 value can be consulted during routing and delivery.
12111
12112 .vitem &$smtp_command$&
12113 .vindex "&$smtp_command$&"
12114 During the processing of an incoming SMTP command, this variable contains the
12115 entire command. This makes it possible to distinguish between HELO and EHLO in
12116 the HELO ACL, and also to distinguish between commands such as these:
12117 .code
12118 MAIL FROM:<>
12119 MAIL FROM: <>
12120 .endd
12121 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12122 command, the address in &$smtp_command$& is the original address before any
12123 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12124 the address after SMTP-time rewriting.
12125
12126 .vitem &$smtp_command_argument$&
12127 .cindex "SMTP" "command, argument for"
12128 .vindex "&$smtp_command_argument$&"
12129 While an ACL is running to check an SMTP command, this variable contains the
12130 argument, that is, the text that follows the command name, with leading white
12131 space removed. Following the introduction of &$smtp_command$&, this variable is
12132 somewhat redundant, but is retained for backwards compatibility.
12133
12134 .vitem &$smtp_count_at_connection_start$&
12135 .vindex "&$smtp_count_at_connection_start$&"
12136 This variable is set greater than zero only in processes spawned by the Exim
12137 daemon for handling incoming SMTP connections. The name is deliberately long,
12138 in order to emphasize what the contents are. When the daemon accepts a new
12139 connection, it increments this variable. A copy of the variable is passed to
12140 the child process that handles the connection, but its value is fixed, and
12141 never changes. It is only an approximation of how many incoming connections
12142 there actually are, because many other connections may come and go while a
12143 single connection is being processed. When a child process terminates, the
12144 daemon decrements its copy of the variable.
12145
12146 .vitem "&$sn0$& &-- &$sn9$&"
12147 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12148 that were current at the end of the system filter file. This allows a system
12149 filter file to set values that can be tested in users' filter files. For
12150 example, a system filter could set a value indicating how likely it is that a
12151 message is junk mail.
12152
12153 .vitem &$spam_$&&'xxx'&
12154 A number of variables whose names start with &$spam$& are available when Exim
12155 is compiled with the content-scanning extension. For details, see section
12156 &<<SECTscanspamass>>&.
12157
12158
12159 .vitem &$spool_directory$&
12160 .vindex "&$spool_directory$&"
12161 The name of Exim's spool directory.
12162
12163 .vitem &$spool_inodes$&
12164 .vindex "&$spool_inodes$&"
12165 The number of free inodes in the disk partition where Exim's spool files are
12166 being written. The value is recalculated whenever the variable is referenced.
12167 If the relevant file system does not have the concept of inodes, the value of
12168 is -1. See also the &%check_spool_inodes%& option.
12169
12170 .vitem &$spool_space$&
12171 .vindex "&$spool_space$&"
12172 The amount of free space (as a number of kilobytes) in the disk partition where
12173 Exim's spool files are being written. The value is recalculated whenever the
12174 variable is referenced. If the operating system does not have the ability to
12175 find the amount of free space (only true for experimental systems), the space
12176 value is -1. For example, to check in an ACL that there is at least 50
12177 megabytes free on the spool, you could write:
12178 .code
12179 condition = ${if > {$spool_space}{50000}}
12180 .endd
12181 See also the &%check_spool_space%& option.
12182
12183
12184 .vitem &$thisaddress$&
12185 .vindex "&$thisaddress$&"
12186 This variable is set only during the processing of the &%foranyaddress%&
12187 command in a filter file. Its use is explained in the description of that
12188 command, which can be found in the separate document entitled &'Exim's
12189 interfaces to mail filtering'&.
12190
12191 .new
12192 .vitem &$tls_in_bits$&
12193 .vindex "&$tls_in_bits$&"
12194 Contains an approximation of the TLS cipher's bit-strength
12195 on the inbound connection; the meaning of
12196 this depends upon the TLS implementation used.
12197 If TLS has not been negotiated, the value will be 0.
12198 The value of this is automatically fed into the Cyrus SASL authenticator
12199 when acting as a server, to specify the "external SSF" (a SASL term).
12200
12201 The deprecated &$tls_bits$& variable refers to the inbound side
12202 except when used in the context of an outbound SMTP delivery, when it refers to
12203 the outbound.
12204
12205 .vitem &$tls_out_bits$&
12206 .vindex "&$tls_out_bits$&"
12207 Contains an approximation of the TLS cipher's bit-strength
12208 on an outbound SMTP connection; the meaning of
12209 this depends upon the TLS implementation used.
12210 If TLS has not been negotiated, the value will be 0.
12211
12212 .vitem &$tls_in_certificate_verified$&
12213 .vindex "&$tls_in_certificate_verified$&"
12214 This variable is set to &"1"& if a TLS certificate was verified when the
12215 message was received, and &"0"& otherwise.
12216
12217 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12218 except when used in the context of an outbound SMTP delivery, when it refers to
12219 the outbound.
12220
12221 .vitem &$tls_out_certificate_verified$&
12222 .vindex "&$tls_out_certificate_verified$&"
12223 This variable is set to &"1"& if a TLS certificate was verified when an
12224 outbound SMTP connection was made,
12225 and &"0"& otherwise.
12226
12227 .vitem &$tls_in_cipher$&
12228 .vindex "&$tls_in_cipher$&"
12229 .vindex "&$tls_cipher$&"
12230 When a message is received from a remote host over an encrypted SMTP
12231 connection, this variable is set to the cipher suite that was negotiated, for
12232 example DES-CBC3-SHA. In other circumstances, in particular, for message
12233 received over unencrypted connections, the variable is empty. Testing
12234 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12235 non-encrypted connections during ACL processing.
12236
12237 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12238 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12239 becomes the same as &$tls_out_cipher$&.
12240
12241 .vitem &$tls_out_cipher$&
12242 .vindex "&$tls_out_cipher$&"
12243 This variable is
12244 cleared before any outgoing SMTP connection is made,
12245 and then set to the outgoing cipher suite if one is negotiated. See chapter
12246 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12247 details of the &(smtp)& transport.
12248
12249 .vitem &$tls_in_peerdn$&
12250 .vindex "&$tls_in_peerdn$&"
12251 .vindex "&$tls_peerdn$&"
12252 When a message is received from a remote host over an encrypted SMTP
12253 connection, and Exim is configured to request a certificate from the client,
12254 the value of the Distinguished Name of the certificate is made available in the
12255 &$tls_in_peerdn$& during subsequent processing.
12256
12257 The deprecated &$tls_peerdn$& variable refers to the inbound side
12258 except when used in the context of an outbound SMTP delivery, when it refers to
12259 the outbound.
12260
12261 .vitem &$tls_out_peerdn$&
12262 .vindex "&$tls_out_peerdn$&"
12263 When a message is being delivered to a remote host over an encrypted SMTP
12264 connection, and Exim is configured to request a certificate from the server,
12265 the value of the Distinguished Name of the certificate is made available in the
12266 &$tls_out_peerdn$& during subsequent processing.
12267
12268 .vitem &$tls_in_sni$&
12269 .vindex "&$tls_in_sni$&"
12270 .vindex "&$tls_sni$&"
12271 .cindex "TLS" "Server Name Indication"
12272 When a TLS session is being established, if the client sends the Server
12273 Name Indication extension, the value will be placed in this variable.
12274 If the variable appears in &%tls_certificate%& then this option and
12275 some others, described in &<<SECTtlssni>>&,
12276 will be re-expanded early in the TLS session, to permit
12277 a different certificate to be presented (and optionally a different key to be
12278 used) to the client, based upon the value of the SNI extension.
12279
12280 The deprecated &$tls_sni$& variable refers to the inbound side
12281 except when used in the context of an outbound SMTP delivery, when it refers to
12282 the outbound.
12283
12284 .vitem &$tls_out_sni$&
12285 .vindex "&$tls_out_sni$&"
12286 .cindex "TLS" "Server Name Indication"
12287 During outbound
12288 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12289 the transport.
12290 .wen
12291
12292 .vitem &$tod_bsdinbox$&
12293 .vindex "&$tod_bsdinbox$&"
12294 The time of day and the date, in the format required for BSD-style mailbox
12295 files, for example: Thu Oct 17 17:14:09 1995.
12296
12297 .vitem &$tod_epoch$&
12298 .vindex "&$tod_epoch$&"
12299 The time and date as a number of seconds since the start of the Unix epoch.
12300
12301 .vitem &$tod_epoch_l$&
12302 .vindex "&$tod_epoch_l$&"
12303 The time and date as a number of microseconds since the start of the Unix epoch.
12304
12305 .vitem &$tod_full$&
12306 .vindex "&$tod_full$&"
12307 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12308 +0100. The timezone is always given as a numerical offset from UTC, with
12309 positive values used for timezones that are ahead (east) of UTC, and negative
12310 values for those that are behind (west).
12311
12312 .vitem &$tod_log$&
12313 .vindex "&$tod_log$&"
12314 The time and date in the format used for writing Exim's log files, for example:
12315 1995-10-12 15:32:29, but without a timezone.
12316
12317 .vitem &$tod_logfile$&
12318 .vindex "&$tod_logfile$&"
12319 This variable contains the date in the format yyyymmdd. This is the format that
12320 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12321 flag.
12322
12323 .vitem &$tod_zone$&
12324 .vindex "&$tod_zone$&"
12325 This variable contains the numerical value of the local timezone, for example:
12326 -0500.
12327
12328 .vitem &$tod_zulu$&
12329 .vindex "&$tod_zulu$&"
12330 This variable contains the UTC date and time in &"Zulu"& format, as specified
12331 by ISO 8601, for example: 20030221154023Z.
12332
12333 .new
12334 .vitem &$transport_name$&
12335 .cindex "transport" "name"
12336 .cindex "name" "of transport"
12337 .vindex "&$transport_name$&"
12338 During the running of a transport, this variable contains its name.
12339 .wen
12340
12341 .vitem &$value$&
12342 .vindex "&$value$&"
12343 This variable contains the result of an expansion lookup, extraction operation,
12344 or external command, as described above. It is also used during a
12345 &*reduce*& expansion.
12346
12347 .vitem &$version_number$&
12348 .vindex "&$version_number$&"
12349 The version number of Exim.
12350
12351 .vitem &$warn_message_delay$&
12352 .vindex "&$warn_message_delay$&"
12353 This variable is set only during the creation of a message warning about a
12354 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12355
12356 .vitem &$warn_message_recipients$&
12357 .vindex "&$warn_message_recipients$&"
12358 This variable is set only during the creation of a message warning about a
12359 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12360 .endlist
12361 .ecindex IIDstrexp
12362
12363
12364
12365 . ////////////////////////////////////////////////////////////////////////////
12366 . ////////////////////////////////////////////////////////////////////////////
12367
12368 .chapter "Embedded Perl" "CHAPperl"
12369 .scindex IIDperl "Perl" "calling from Exim"
12370 Exim can be built to include an embedded Perl interpreter. When this is done,
12371 Perl subroutines can be called as part of the string expansion process. To make
12372 use of the Perl support, you need version 5.004 or later of Perl installed on
12373 your system. To include the embedded interpreter in the Exim binary, include
12374 the line
12375 .code
12376 EXIM_PERL = perl.o
12377 .endd
12378 in your &_Local/Makefile_& and then build Exim in the normal way.
12379
12380
12381 .section "Setting up so Perl can be used" "SECID85"
12382 .oindex "&%perl_startup%&"
12383 Access to Perl subroutines is via a global configuration option called
12384 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12385 no &%perl_startup%& option in the Exim configuration file then no Perl
12386 interpreter is started and there is almost no overhead for Exim (since none of
12387 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12388 option then the associated value is taken to be Perl code which is executed in
12389 a newly created Perl interpreter.
12390
12391 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12392 need backslashes before any characters to escape special meanings. The option
12393 should usually be something like
12394 .code
12395 perl_startup = do '/etc/exim.pl'
12396 .endd
12397 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12398 use from Exim. Exim can be configured either to start up a Perl interpreter as
12399 soon as it is entered, or to wait until the first time it is needed. Starting
12400 the interpreter at the beginning ensures that it is done while Exim still has
12401 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12402 fact used in a particular run. Also, note that this does not mean that Exim is
12403 necessarily running as root when Perl is called at a later time. By default,
12404 the interpreter is started only when it is needed, but this can be changed in
12405 two ways:
12406
12407 .ilist
12408 .oindex "&%perl_at_start%&"
12409 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12410 a startup when Exim is entered.
12411 .next
12412 The command line option &%-ps%& also requests a startup when Exim is entered,
12413 overriding the setting of &%perl_at_start%&.
12414 .endlist
12415
12416 There is also a command line option &%-pd%& (for delay) which suppresses the
12417 initial startup, even if &%perl_at_start%& is set.
12418
12419
12420 .section "Calling Perl subroutines" "SECID86"
12421 When the configuration file includes a &%perl_startup%& option you can make use
12422 of the string expansion item to call the Perl subroutines that are defined
12423 by the &%perl_startup%& code. The operator is used in any of the following
12424 forms:
12425 .code
12426 ${perl{foo}}
12427 ${perl{foo}{argument}}
12428 ${perl{foo}{argument1}{argument2} ... }
12429 .endd
12430 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12431 arguments may be passed. Passing more than this results in an expansion failure
12432 with an error message of the form
12433 .code
12434 Too many arguments passed to Perl subroutine "foo" (max is 8)
12435 .endd
12436 The return value of the Perl subroutine is evaluated in a scalar context before
12437 it is passed back to Exim to be inserted into the expanded string. If the
12438 return value is &'undef'&, the expansion is forced to fail in the same way as
12439 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12440 by obeying Perl's &%die%& function, the expansion fails with the error message
12441 that was passed to &%die%&.
12442
12443
12444 .section "Calling Exim functions from Perl" "SECID87"
12445 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12446 is available to call back into Exim's string expansion function. For example,
12447 the Perl code
12448 .code
12449 my $lp = Exim::expand_string('$local_part');
12450 .endd
12451 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12452 Note those are single quotes and not double quotes to protect against
12453 &$local_part$& being interpolated as a Perl variable.
12454
12455 If the string expansion is forced to fail by a &"fail"& item, the result of
12456 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12457 expansion string, the Perl call from the original expansion string fails with
12458 an appropriate error message, in the same way as if &%die%& were used.
12459
12460 .cindex "debugging" "from embedded Perl"
12461 .cindex "log" "writing from embedded Perl"
12462 Two other Exim functions are available for use from within Perl code.
12463 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12464 debugging is enabled. If you want a newline at the end, you must supply it.
12465 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12466 timestamp. In this case, you should not supply a terminating newline.
12467
12468
12469 .section "Use of standard output and error by Perl" "SECID88"
12470 .cindex "Perl" "standard output and error"
12471 You should not write to the standard error or output streams from within your
12472 Perl code, as it is not defined how these are set up. In versions of Exim
12473 before 4.50, it is possible for the standard output or error to refer to the
12474 SMTP connection during message reception via the daemon. Writing to this stream
12475 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12476 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12477 avoided, but the output is lost.
12478
12479 .cindex "Perl" "use of &%warn%&"
12480 The Perl &%warn%& statement writes to the standard error stream by default.
12481 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12482 you have no control. When Exim starts up the Perl interpreter, it arranges for
12483 output from the &%warn%& statement to be written to the Exim main log. You can
12484 change this by including appropriate Perl magic somewhere in your Perl code.
12485 For example, to discard &%warn%& output completely, you need this:
12486 .code
12487 $SIG{__WARN__} = sub { };
12488 .endd
12489 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12490 example, the code for the subroutine is empty, so it does nothing, but you can
12491 include any Perl code that you like. The text of the &%warn%& message is passed
12492 as the first subroutine argument.
12493 .ecindex IIDperl
12494
12495
12496 . ////////////////////////////////////////////////////////////////////////////
12497 . ////////////////////////////////////////////////////////////////////////////
12498
12499 .chapter "Starting the daemon and the use of network interfaces" &&&
12500          "CHAPinterfaces" &&&
12501          "Starting the daemon"
12502 .cindex "daemon" "starting"
12503 .cindex "interface" "listening"
12504 .cindex "network interface"
12505 .cindex "interface" "network"
12506 .cindex "IP address" "for listening"
12507 .cindex "daemon" "listening IP addresses"
12508 .cindex "TCP/IP" "setting listening interfaces"
12509 .cindex "TCP/IP" "setting listening ports"
12510 A host that is connected to a TCP/IP network may have one or more physical
12511 hardware network interfaces. Each of these interfaces may be configured as one
12512 or more &"logical"& interfaces, which are the entities that a program actually
12513 works with. Each of these logical interfaces is associated with an IP address.
12514 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12515 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12516 knowledge about the host's interfaces for use in three different circumstances:
12517
12518 .olist
12519 When a listening daemon is started, Exim needs to know which interfaces
12520 and ports to listen on.
12521 .next
12522 When Exim is routing an address, it needs to know which IP addresses
12523 are associated with local interfaces. This is required for the correct
12524 processing of MX lists by removing the local host and others with the
12525 same or higher priority values. Also, Exim needs to detect cases
12526 when an address is routed to an IP address that in fact belongs to the
12527 local host. Unless the &%self%& router option or the &%allow_localhost%&
12528 option of the smtp transport is set (as appropriate), this is treated
12529 as an error situation.
12530 .next
12531 When Exim connects to a remote host, it may need to know which interface to use
12532 for the outgoing connection.
12533 .endlist
12534
12535
12536 Exim's default behaviour is likely to be appropriate in the vast majority
12537 of cases. If your host has only one interface, and you want all its IP
12538 addresses to be treated in the same way, and you are using only the
12539 standard SMTP port, you should not need to take any special action. The
12540 rest of this chapter does not apply to you.
12541
12542 In a more complicated situation you may want to listen only on certain
12543 interfaces, or on different ports, and for this reason there are a number of
12544 options that can be used to influence Exim's behaviour. The rest of this
12545 chapter describes how they operate.
12546
12547 When a message is received over TCP/IP, the interface and port that were
12548 actually used are set in &$received_ip_address$& and &$received_port$&.
12549
12550
12551
12552 .section "Starting a listening daemon" "SECID89"
12553 When a listening daemon is started (by means of the &%-bd%& command line
12554 option), the interfaces and ports on which it listens are controlled by the
12555 following options:
12556
12557 .ilist
12558 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12559 compatibility, this option can also be specified in the singular.)
12560 .next
12561 &%local_interfaces%& contains list of interface IP addresses on which to
12562 listen. Each item may optionally also specify a port.
12563 .endlist
12564
12565 The default list separator in both cases is a colon, but this can be changed as
12566 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12567 it is usually best to change the separator to avoid having to double all the
12568 colons. For example:
12569 .code
12570 local_interfaces = <; 127.0.0.1 ; \
12571                       192.168.23.65 ; \
12572                       ::1 ; \
12573                       3ffe:ffff:836f::fe86:a061
12574 .endd
12575 There are two different formats for specifying a port along with an IP address
12576 in &%local_interfaces%&:
12577
12578 .olist
12579 The port is added onto the address with a dot separator. For example, to listen
12580 on port 1234 on two different IP addresses:
12581 .code
12582 local_interfaces = <; 192.168.23.65.1234 ; \
12583                       3ffe:ffff:836f::fe86:a061.1234
12584 .endd
12585 .next
12586 The IP address is enclosed in square brackets, and the port is added
12587 with a colon separator, for example:
12588 .code
12589 local_interfaces = <; [192.168.23.65]:1234 ; \
12590                       [3ffe:ffff:836f::fe86:a061]:1234
12591 .endd
12592 .endlist
12593
12594 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12595 default setting contains just one port:
12596 .code
12597 daemon_smtp_ports = smtp
12598 .endd
12599 If more than one port is listed, each interface that does not have its own port
12600 specified listens on all of them. Ports that are listed in
12601 &%daemon_smtp_ports%& can be identified either by name (defined in
12602 &_/etc/services_&) or by number. However, when ports are given with individual
12603 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12604
12605
12606
12607 .section "Special IP listening addresses" "SECID90"
12608 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12609 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12610 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12611 instead of setting up separate listening sockets for each interface. The
12612 default value of &%local_interfaces%& is
12613 .code
12614 local_interfaces = 0.0.0.0
12615 .endd
12616 when Exim is built without IPv6 support; otherwise it is:
12617 .code
12618 local_interfaces = <; ::0 ; 0.0.0.0
12619 .endd
12620 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12621
12622
12623
12624 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12625 The &%-oX%& command line option can be used to override the values of
12626 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12627 instance. Another way of doing this would be to use macros and the &%-D%&
12628 option. However, &%-oX%& can be used by any admin user, whereas modification of
12629 the runtime configuration by &%-D%& is allowed only when the caller is root or
12630 exim.
12631
12632 The value of &%-oX%& is a list of items. The default colon separator can be
12633 changed in the usual way if required. If there are any items that do not
12634 contain dots or colons (that is, are not IP addresses), the value of
12635 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12636 items that do contain dots or colons, the value of &%local_interfaces%& is
12637 replaced by those items. Thus, for example,
12638 .code
12639 -oX 1225
12640 .endd
12641 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12642 whereas
12643 .code
12644 -oX 192.168.34.5.1125
12645 .endd
12646 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12647 (However, since &%local_interfaces%& now contains no items without ports, the
12648 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12649
12650
12651
12652 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12653 .cindex "ssmtp protocol"
12654 .cindex "smtps protocol"
12655 .cindex "SMTP" "ssmtp protocol"
12656 .cindex "SMTP" "smtps protocol"
12657 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12658 before the STARTTLS command was standardized for SMTP. Some legacy clients
12659 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12660 list of port numbers, connections to those ports must use SSMTP. The most
12661 common use of this option is expected to be
12662 .code
12663 tls_on_connect_ports = 465
12664 .endd
12665 because 465 is the usual port number used by the legacy clients. There is also
12666 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12667 this way when a daemon is started.
12668
12669 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12670 daemon to listen on those ports. You must still specify them in
12671 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12672 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12673 connections via the daemon.)
12674
12675
12676
12677
12678 .section "IPv6 address scopes" "SECID92"
12679 .cindex "IPv6" "address scopes"
12680 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12681 can, in principle, have the same link-local IPv6 address on different
12682 interfaces. Thus, additional information is needed, over and above the IP
12683 address, to distinguish individual interfaces. A convention of using a
12684 percent sign followed by something (often the interface name) has been
12685 adopted in some cases, leading to addresses like this:
12686 .code
12687 fe80::202:b3ff:fe03:45c1%eth0
12688 .endd
12689 To accommodate this usage, a percent sign followed by an arbitrary string is
12690 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12691 to convert a textual IPv6 address for actual use. This function recognizes the
12692 percent convention in operating systems that support it, and it processes the
12693 address appropriately. Unfortunately, some older libraries have problems with
12694 &[getaddrinfo()]&. If
12695 .code
12696 IPV6_USE_INET_PTON=yes
12697 .endd
12698 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12699 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12700 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12701 function.) Of course, this means that the additional functionality of
12702 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12703
12704 .section "Disabling IPv6" "SECID93"
12705 .cindex "IPv6" "disabling"
12706 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12707 run on a host whose kernel does not support IPv6. The binary will fall back to
12708 using IPv4, but it may waste resources looking up AAAA records, and trying to
12709 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12710 .oindex "&%disable_ipv6%&"
12711 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12712 activities take place. AAAA records are never looked up, and any IPv6 addresses
12713 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12714 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12715 to handle IPv6 literal addresses.
12716
12717 On the other hand, when IPv6 is in use, there may be times when you want to
12718 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12719 option to globally suppress the lookup of AAAA records for specified domains,
12720 and you can use the &%ignore_target_hosts%& generic router option to ignore
12721 IPv6 addresses in an individual router.
12722
12723
12724
12725 .section "Examples of starting a listening daemon" "SECID94"
12726 The default case in an IPv6 environment is
12727 .code
12728 daemon_smtp_ports = smtp
12729 local_interfaces = <; ::0 ; 0.0.0.0
12730 .endd
12731 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12732 Either one or two sockets may be used, depending on the characteristics of
12733 the TCP/IP stack. (This is complicated and messy; for more information,
12734 read the comments in the &_daemon.c_& source file.)
12735
12736 To specify listening on ports 25 and 26 on all interfaces:
12737 .code
12738 daemon_smtp_ports = 25 : 26
12739 .endd
12740 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12741 .code
12742 local_interfaces = <; ::0.25     ; ::0.26 \
12743                       0.0.0.0.25 ; 0.0.0.0.26
12744 .endd
12745 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12746 IPv4 loopback address only:
12747 .code
12748 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12749 .endd
12750 To specify listening on the default port on specific interfaces only:
12751 .code
12752 local_interfaces = 10.0.0.67 : 192.168.34.67
12753 .endd
12754 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12755
12756
12757
12758 .section "Recognizing the local host" "SECTreclocipadd"
12759 The &%local_interfaces%& option is also used when Exim needs to determine
12760 whether or not an IP address refers to the local host. That is, the IP
12761 addresses of all the interfaces on which a daemon is listening are always
12762 treated as local.
12763
12764 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12765 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12766 available interfaces from the operating system, and extracts the relevant
12767 (that is, IPv4 or IPv6) addresses to use for checking.
12768
12769 Some systems set up large numbers of virtual interfaces in order to provide
12770 many virtual web servers. In this situation, you may want to listen for
12771 email on only a few of the available interfaces, but nevertheless treat all
12772 interfaces as local when routing. You can do this by setting
12773 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12774 &"all"& wildcard values. These addresses are recognized as local, but are not
12775 used for listening. Consider this example:
12776 .code
12777 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12778                       192.168.53.235 ; \
12779                       3ffe:2101:12:1:a00:20ff:fe86:a061
12780
12781 extra_local_interfaces = <; ::0 ; 0.0.0.0
12782 .endd
12783 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12784 address, but all available interface addresses are treated as local when
12785 Exim is routing.
12786
12787 In some environments the local host name may be in an MX list, but with an IP
12788 address that is not assigned to any local interface. In other cases it may be
12789 desirable to treat other host names as if they referred to the local host. Both
12790 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12791 This contains host names rather than IP addresses. When a host is referenced
12792 during routing, either via an MX record or directly, it is treated as the local
12793 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12794 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12795
12796
12797
12798 .section "Delivering to a remote host" "SECID95"
12799 Delivery to a remote host is handled by the smtp transport. By default, it
12800 allows the system's TCP/IP functions to choose which interface to use (if
12801 there is more than one) when connecting to a remote host. However, the
12802 &%interface%& option can be set to specify which interface is used. See the
12803 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12804 details.
12805
12806
12807
12808
12809 . ////////////////////////////////////////////////////////////////////////////
12810 . ////////////////////////////////////////////////////////////////////////////
12811
12812 .chapter "Main configuration" "CHAPmainconfig"
12813 .scindex IIDconfima "configuration file" "main section"
12814 .scindex IIDmaiconf "main configuration"
12815 The first part of the run time configuration file contains three types of item:
12816
12817 .ilist
12818 Macro definitions: These lines start with an upper case letter. See section
12819 &<<SECTmacrodefs>>& for details of macro processing.
12820 .next
12821 Named list definitions: These lines start with one of the words &"domainlist"&,
12822 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12823 section &<<SECTnamedlists>>&.
12824 .next
12825 Main configuration settings: Each setting occupies one line of the file
12826 (with possible continuations). If any setting is preceded by the word
12827 &"hide"&, the &%-bP%& command line option displays its value to admin users
12828 only. See section &<<SECTcos>>& for a description of the syntax of these option
12829 settings.
12830 .endlist
12831
12832 This chapter specifies all the main configuration options, along with their
12833 types and default values. For ease of finding a particular option, they appear
12834 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12835 are now so many options, they are first listed briefly in functional groups, as
12836 an aid to finding the name of the option you are looking for. Some options are
12837 listed in more than one group.
12838
12839 .section "Miscellaneous" "SECID96"
12840 .table2
12841 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12842 .row &%disable_ipv6%&                "do no IPv6 processing"
12843 .row &%keep_malformed%&              "for broken files &-- should not happen"
12844 .row &%localhost_number%&            "for unique message ids in clusters"
12845 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12846 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12847 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12848 .row &%print_topbitchars%&           "top-bit characters are printing"
12849 .row &%timezone%&                    "force time zone"
12850 .endtable
12851
12852
12853 .section "Exim parameters" "SECID97"
12854 .table2
12855 .row &%exim_group%&                  "override compiled-in value"
12856 .row &%exim_path%&                   "override compiled-in value"
12857 .row &%exim_user%&                   "override compiled-in value"
12858 .row &%primary_hostname%&            "default from &[uname()]&"
12859 .row &%split_spool_directory%&       "use multiple directories"
12860 .row &%spool_directory%&             "override compiled-in value"
12861 .endtable
12862
12863
12864
12865 .section "Privilege controls" "SECID98"
12866 .table2
12867 .row &%admin_groups%&                "groups that are Exim admin users"
12868 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12869 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12870 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12871 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12872 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12873 .row &%never_users%&                 "do not run deliveries as these"
12874 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12875 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12876 .row &%trusted_groups%&              "groups that are trusted"
12877 .row &%trusted_users%&               "users that are trusted"
12878 .endtable
12879
12880
12881
12882 .section "Logging" "SECID99"
12883 .table2
12884 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12885 .row &%log_file_path%&               "override compiled-in value"
12886 .row &%log_selector%&                "set/unset optional logging"
12887 .row &%log_timezone%&                "add timezone to log lines"
12888 .row &%message_logs%&                "create per-message logs"
12889 .row &%preserve_message_logs%&       "after message completion"
12890 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12891 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12892 .row &%syslog_facility%&             "set syslog &""facility""& field"
12893 .row &%syslog_processname%&          "set syslog &""ident""& field"
12894 .row &%syslog_timestamp%&            "timestamp syslog lines"
12895 .row &%write_rejectlog%&             "control use of message log"
12896 .endtable
12897
12898
12899
12900 .section "Frozen messages" "SECID100"
12901 .table2
12902 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12903 .row &%freeze_tell%&                 "send message when freezing"
12904 .row &%move_frozen_messages%&        "to another directory"
12905 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12906 .endtable
12907
12908
12909
12910 .section "Data lookups" "SECID101"
12911 .table2
12912 .row &%ibase_servers%&               "InterBase servers"
12913 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12914 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12915 .row &%ldap_cert_file%&              "client cert file for LDAP"
12916 .row &%ldap_cert_key%&               "client key file for LDAP"
12917 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12918 .row &%ldap_default_servers%&        "used if no server in query"
12919 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12920 .row &%ldap_start_tls%&              "require TLS within LDAP"
12921 .row &%ldap_version%&                "set protocol version"
12922 .row &%lookup_open_max%&             "lookup files held open"
12923 .row &%mysql_servers%&               "default MySQL servers"
12924 .row &%oracle_servers%&              "Oracle servers"
12925 .row &%pgsql_servers%&               "default PostgreSQL servers"
12926 .row &%sqlite_lock_timeout%&         "as it says"
12927 .endtable
12928
12929
12930
12931 .section "Message ids" "SECID102"
12932 .table2
12933 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12934 .row &%message_id_header_text%&      "ditto"
12935 .endtable
12936
12937
12938
12939 .section "Embedded Perl Startup" "SECID103"
12940 .table2
12941 .row &%perl_at_start%&               "always start the interpreter"
12942 .row &%perl_startup%&                "code to obey when starting Perl"
12943 .endtable
12944
12945
12946
12947 .section "Daemon" "SECID104"
12948 .table2
12949 .row &%daemon_smtp_ports%&           "default ports"
12950 .row &%daemon_startup_retries%&      "number of times to retry"
12951 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12952 .row &%extra_local_interfaces%&      "not necessarily listened on"
12953 .row &%local_interfaces%&            "on which to listen, with optional ports"
12954 .row &%pid_file_path%&               "override compiled-in value"
12955 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12956 .endtable
12957
12958
12959
12960 .section "Resource control" "SECID105"
12961 .table2
12962 .row &%check_log_inodes%&            "before accepting a message"
12963 .row &%check_log_space%&             "before accepting a message"
12964 .row &%check_spool_inodes%&          "before accepting a message"
12965 .row &%check_spool_space%&           "before accepting a message"
12966 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12967 .row &%queue_only_load%&             "queue incoming if load high"
12968 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12969 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12970 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12971 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12972 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12973 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12974 .row &%smtp_accept_max_per_connection%& "messages per connection"
12975 .row &%smtp_accept_max_per_host%&    "connections from one host"
12976 .row &%smtp_accept_queue%&           "queue mail if more connections"
12977 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12978                                            connection"
12979 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12980 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12981 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12982 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12983 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12984 .endtable
12985
12986
12987
12988 .section "Policy controls" "SECID106"
12989 .table2
12990 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12991 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12992 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12993 .row &%acl_smtp_auth%&               "ACL for AUTH"
12994 .row &%acl_smtp_connect%&            "ACL for connection"
12995 .row &%acl_smtp_data%&               "ACL for DATA"
12996 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12997 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12998 .row &%acl_smtp_expn%&               "ACL for EXPN"
12999 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13000 .row &%acl_smtp_mail%&               "ACL for MAIL"
13001 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13002 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13003 .row &%acl_smtp_predata%&            "ACL for start of data"
13004 .row &%acl_smtp_quit%&               "ACL for QUIT"
13005 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13006 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13007 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13008 .row &%av_scanner%&                  "specify virus scanner"
13009 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13010                                       words""&"
13011 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13012 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13013 .row &%header_maxsize%&              "total size of message header"
13014 .row &%header_line_maxsize%&         "individual header line limit"
13015 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13016 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13017 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13018 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13019 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13020 .row &%host_lookup%&                 "host name looked up for these hosts"
13021 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13022 .row &%host_reject_connection%&      "reject connection from these hosts"
13023 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13024 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13025 .row &%message_size_limit%&          "for all messages"
13026 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13027 .row &%spamd_address%&               "set interface to SpamAssassin"
13028 .row &%strict_acl_vars%&             "object to unset ACL variables"
13029 .endtable
13030
13031
13032
13033 .section "Callout cache" "SECID107"
13034 .table2
13035 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13036                                          item"
13037 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13038                                          item"
13039 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13040 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13041 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13042 .endtable
13043
13044
13045
13046 .section "TLS" "SECID108"
13047 .table2
13048 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13049 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13050 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13051 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13052 .row &%tls_certificate%&             "location of server certificate"
13053 .row &%tls_crl%&                     "certificate revocation list"
13054 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13055 .row &%tls_dhparam%&                 "DH parameters for server"
13056 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13057 .row &%tls_privatekey%&              "location of server private key"
13058 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13059 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13060 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13061 .row &%tls_verify_certificates%&     "expected client certificates"
13062 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13063 .endtable
13064
13065
13066
13067 .section "Local user handling" "SECID109"
13068 .table2
13069 .row &%finduser_retries%&            "useful in NIS environments"
13070 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13071 .row &%gecos_pattern%&               "ditto"
13072 .row &%max_username_length%&         "for systems that truncate"
13073 .row &%unknown_login%&               "used when no login name found"
13074 .row &%unknown_username%&            "ditto"
13075 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13076 .row &%uucp_from_sender%&            "ditto"
13077 .endtable
13078
13079
13080
13081 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13082 .table2
13083 .row &%header_maxsize%&              "total size of message header"
13084 .row &%header_line_maxsize%&         "individual header line limit"
13085 .row &%message_size_limit%&          "applies to all messages"
13086 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13087 .row &%received_header_text%&        "expanded to make &'Received:'&"
13088 .row &%received_headers_max%&        "for mail loop detection"
13089 .row &%recipients_max%&              "limit per message"
13090 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13091 .endtable
13092
13093
13094
13095
13096 .section "Non-SMTP incoming messages" "SECID111"
13097 .table2
13098 .row &%receive_timeout%&             "for non-SMTP messages"
13099 .endtable
13100
13101
13102
13103
13104
13105 .section "Incoming SMTP messages" "SECID112"
13106 See also the &'Policy controls'& section above.
13107
13108 .table2
13109 .row &%host_lookup%&                 "host name looked up for these hosts"
13110 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13111 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13112 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13113 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13114 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13115 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13116 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13117 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13118 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13119 .row &%smtp_accept_max_per_connection%& "messages per connection"
13120 .row &%smtp_accept_max_per_host%&    "connections from one host"
13121 .row &%smtp_accept_queue%&           "queue mail if more connections"
13122 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13123                                            connection"
13124 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13125 .row &%smtp_active_hostname%&        "host name to use in messages"
13126 .row &%smtp_banner%&                 "text for welcome banner"
13127 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13128 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13129 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13130 .row &%smtp_etrn_command%&           "what to run for ETRN"
13131 .row &%smtp_etrn_serialize%&         "only one at once"
13132 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13133 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13134 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13135 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13136 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13137 .row &%smtp_receive_timeout%&        "per command or data line"
13138 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13139 .row &%smtp_return_error_details%&   "give detail on rejections"
13140 .endtable
13141
13142
13143
13144 .section "SMTP extensions" "SECID113"
13145 .table2
13146 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13147 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13148 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13149 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13150 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13151 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13152 .endtable
13153
13154
13155
13156 .section "Processing messages" "SECID114"
13157 .table2
13158 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13159 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13160 .row &%allow_utf8_domains%&          "in addresses"
13161 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13162                                       words""&"
13163 .row &%delivery_date_remove%&        "from incoming messages"
13164 .row &%envelope_to_remove%&          "from incoming messages"
13165 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13166 .row &%headers_charset%&             "default for translations"
13167 .row &%qualify_domain%&              "default for senders"
13168 .row &%qualify_recipient%&           "default for recipients"
13169 .row &%return_path_remove%&          "from incoming messages"
13170 .row &%strip_excess_angle_brackets%& "in addresses"
13171 .row &%strip_trailing_dot%&          "at end of addresses"
13172 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13173 .endtable
13174
13175
13176
13177 .section "System filter" "SECID115"
13178 .table2
13179 .row &%system_filter%&               "locate system filter"
13180 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13181                                             directory"
13182 .row &%system_filter_file_transport%& "transport for delivery to a file"
13183 .row &%system_filter_group%&         "group for filter running"
13184 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13185 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13186 .row &%system_filter_user%&          "user for filter running"
13187 .endtable
13188
13189
13190
13191 .section "Routing and delivery" "SECID116"
13192 .table2
13193 .row &%disable_ipv6%&                "do no IPv6 processing"
13194 .row &%dns_again_means_nonexist%&    "for broken domains"
13195 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13196 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13197 .row &%dns_retrans%&                 "parameter for resolver"
13198 .row &%dns_retry%&                   "parameter for resolver"
13199 .row &%dns_use_dnssec%&              "parameter for resolver"
13200 .row &%dns_use_edns0%&               "parameter for resolver"
13201 .row &%hold_domains%&                "hold delivery for these domains"
13202 .row &%local_interfaces%&            "for routing checks"
13203 .row &%queue_domains%&               "no immediate delivery for these"
13204 .row &%queue_only%&                  "no immediate delivery at all"
13205 .row &%queue_only_file%&             "no immediate delivery if file exists"
13206 .row &%queue_only_load%&             "no immediate delivery if load is high"
13207 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13208 .row &%queue_only_override%&         "allow command line to override"
13209 .row &%queue_run_in_order%&          "order of arrival"
13210 .row &%queue_run_max%&               "of simultaneous queue runners"
13211 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13212 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13213 .row &%remote_sort_domains%&         "order of remote deliveries"
13214 .row &%retry_data_expire%&           "timeout for retry data"
13215 .row &%retry_interval_max%&          "safety net for retry rules"
13216 .endtable
13217
13218
13219
13220 .section "Bounce and warning messages" "SECID117"
13221 .table2
13222 .row &%bounce_message_file%&         "content of bounce"
13223 .row &%bounce_message_text%&         "content of bounce"
13224 .row &%bounce_return_body%&          "include body if returning message"
13225 .row &%bounce_return_message%&       "include original message in bounce"
13226 .row &%bounce_return_size_limit%&    "limit on returned message"
13227 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13228 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13229 .row &%errors_copy%&                 "copy bounce messages"
13230 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13231 .row &%delay_warning%&               "time schedule"
13232 .row &%delay_warning_condition%&     "condition for warning messages"
13233 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13234 .row &%smtp_return_error_details%&   "give detail on rejections"
13235 .row &%warn_message_file%&           "content of warning message"
13236 .endtable
13237
13238
13239
13240 .section "Alphabetical list of main options" "SECTalomo"
13241 Those options that undergo string expansion before use are marked with
13242 &dagger;.
13243
13244 .option accept_8bitmime main boolean true
13245 .cindex "8BITMIME"
13246 .cindex "8-bit characters"
13247 .cindex "log" "selectors"
13248 .cindex "log" "8BITMIME"
13249 This option causes Exim to send 8BITMIME in its response to an SMTP
13250 EHLO command, and to accept the BODY= parameter on MAIL commands.
13251 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13252 takes no steps to do anything special with messages received by this route.
13253
13254 Historically Exim kept this option off by default, but the maintainers
13255 feel that in today's Internet, this causes more problems than it solves.
13256 It now defaults to true.
13257 A more detailed analysis of the issues is provided by Dan Bernstein:
13258 .display
13259 &url(http://cr.yp.to/smtp/8bitmime.html)
13260 .endd
13261
13262 .new
13263 To log received 8BITMIME status use
13264 .code
13265 log_selector = +8bitmime
13266 .endd
13267 .wen
13268
13269 .option acl_not_smtp main string&!! unset
13270 .cindex "&ACL;" "for non-SMTP messages"
13271 .cindex "non-SMTP messages" "ACLs for"
13272 This option defines the ACL that is run when a non-SMTP message has been
13273 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13274 further details.
13275
13276 .option acl_not_smtp_mime main string&!! unset
13277 This option defines the ACL that is run for individual MIME parts of non-SMTP
13278 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13279 SMTP messages.
13280
13281 .option acl_not_smtp_start main string&!! unset
13282 .cindex "&ACL;" "at start of non-SMTP message"
13283 .cindex "non-SMTP messages" "ACLs for"
13284 This option defines the ACL that is run before Exim starts reading a
13285 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13286
13287 .option acl_smtp_auth main string&!! unset
13288 .cindex "&ACL;" "setting up for SMTP commands"
13289 .cindex "AUTH" "ACL for"
13290 This option defines the ACL that is run when an SMTP AUTH command is
13291 received. See chapter &<<CHAPACL>>& for further details.
13292
13293 .option acl_smtp_connect main string&!! unset
13294 .cindex "&ACL;" "on SMTP connection"
13295 This option defines the ACL that is run when an SMTP connection is received.
13296 See chapter &<<CHAPACL>>& for further details.
13297
13298 .option acl_smtp_data main string&!! unset
13299 .cindex "DATA" "ACL for"
13300 This option defines the ACL that is run after an SMTP DATA command has been
13301 processed and the message itself has been received, but before the final
13302 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13303
13304 .option acl_smtp_etrn main string&!! unset
13305 .cindex "ETRN" "ACL for"
13306 This option defines the ACL that is run when an SMTP ETRN command is
13307 received. See chapter &<<CHAPACL>>& for further details.
13308
13309 .option acl_smtp_expn main string&!! unset
13310 .cindex "EXPN" "ACL for"
13311 This option defines the ACL that is run when an SMTP EXPN command is
13312 received. See chapter &<<CHAPACL>>& for further details.
13313
13314 .option acl_smtp_helo main string&!! unset
13315 .cindex "EHLO" "ACL for"
13316 .cindex "HELO" "ACL for"
13317 This option defines the ACL that is run when an SMTP EHLO or HELO
13318 command is received. See chapter &<<CHAPACL>>& for further details.
13319
13320
13321 .option acl_smtp_mail main string&!! unset
13322 .cindex "MAIL" "ACL for"
13323 This option defines the ACL that is run when an SMTP MAIL command is
13324 received. See chapter &<<CHAPACL>>& for further details.
13325
13326 .option acl_smtp_mailauth main string&!! unset
13327 .cindex "AUTH" "on MAIL command"
13328 This option defines the ACL that is run when there is an AUTH parameter on
13329 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13330 &<<CHAPSMTPAUTH>>& for details of authentication.
13331
13332 .option acl_smtp_mime main string&!! unset
13333 .cindex "MIME content scanning" "ACL for"
13334 This option is available when Exim is built with the content-scanning
13335 extension. It defines the ACL that is run for each MIME part in a message. See
13336 section &<<SECTscanmimepart>>& for details.
13337
13338 .option acl_smtp_predata main string&!! unset
13339 This option defines the ACL that is run when an SMTP DATA command is
13340 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13341 further details.
13342
13343 .option acl_smtp_quit main string&!! unset
13344 .cindex "QUIT, ACL for"
13345 This option defines the ACL that is run when an SMTP QUIT command is
13346 received. See chapter &<<CHAPACL>>& for further details.
13347
13348 .option acl_smtp_rcpt main string&!! unset
13349 .cindex "RCPT" "ACL for"
13350 This option defines the ACL that is run when an SMTP RCPT command is
13351 received. See chapter &<<CHAPACL>>& for further details.
13352
13353 .option acl_smtp_starttls main string&!! unset
13354 .cindex "STARTTLS, ACL for"
13355 This option defines the ACL that is run when an SMTP STARTTLS command is
13356 received. See chapter &<<CHAPACL>>& for further details.
13357
13358 .option acl_smtp_vrfy main string&!! unset
13359 .cindex "VRFY" "ACL for"
13360 This option defines the ACL that is run when an SMTP VRFY command is
13361 received. See chapter &<<CHAPACL>>& for further details.
13362
13363 .new
13364 .option add_environment main "string list" empty
13365 .cindex "environment" "inherited"
13366 This option allows to set individual environment variables that the
13367 currently linked libraries and programs in child processes use. The
13368 default list is empty,
13369 .wen
13370
13371 .option admin_groups main "string list&!!" unset
13372 .cindex "admin user"
13373 This option is expanded just once, at the start of Exim's processing. If the
13374 current group or any of the supplementary groups of an Exim caller is in this
13375 colon-separated list, the caller has admin privileges. If all your system
13376 programmers are in a specific group, for example, you can give them all Exim
13377 admin privileges by putting that group in &%admin_groups%&. However, this does
13378 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13379 To permit this, you have to add individuals to the Exim group.
13380
13381 .option allow_domain_literals main boolean false
13382 .cindex "domain literal"
13383 If this option is set, the RFC 2822 domain literal format is permitted in
13384 email addresses. The option is not set by default, because the domain literal
13385 format is not normally required these days, and few people know about it. It
13386 has, however, been exploited by mail abusers.
13387
13388 Unfortunately, it seems that some DNS black list maintainers are using this
13389 format to report black listing to postmasters. If you want to accept messages
13390 addressed to your hosts by IP address, you need to set
13391 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13392 domains (defined in the named domain list &%local_domains%& in the default
13393 configuration). This &"magic string"& matches the domain literal form of all
13394 the local host's IP addresses.
13395
13396
13397 .option allow_mx_to_ip main boolean false
13398 .cindex "MX record" "pointing to IP address"
13399 It appears that more and more DNS zone administrators are breaking the rules
13400 and putting domain names that look like IP addresses on the right hand side of
13401 MX records. Exim follows the rules and rejects this, giving an error message
13402 that explains the mis-configuration. However, some other MTAs support this
13403 practice, so to avoid &"Why can't Exim do this?"& complaints,
13404 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13405 recommended, except when you have no other choice.
13406
13407 .option allow_utf8_domains main boolean false
13408 .cindex "domain" "UTF-8 characters in"
13409 .cindex "UTF-8" "in domain name"
13410 Lots of discussion is going on about internationalized domain names. One
13411 camp is strongly in favour of just using UTF-8 characters, and it seems
13412 that at least two other MTAs permit this. This option allows Exim users to
13413 experiment if they wish.
13414
13415 If it is set true, Exim's domain parsing function allows valid
13416 UTF-8 multicharacters to appear in domain name components, in addition to
13417 letters, digits, and hyphens. However, just setting this option is not
13418 enough; if you want to look up these domain names in the DNS, you must also
13419 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13420 suitable setting is:
13421 .code
13422 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13423   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13424 .endd
13425 Alternatively, you can just disable this feature by setting
13426 .code
13427 dns_check_names_pattern =
13428 .endd
13429 That is, set the option to an empty string so that no check is done.
13430
13431
13432 .option auth_advertise_hosts main "host list&!!" *
13433 .cindex "authentication" "advertising"
13434 .cindex "AUTH" "advertising"
13435 If any server authentication mechanisms are configured, Exim advertises them in
13436 response to an EHLO command only if the calling host matches this list.
13437 Otherwise, Exim does not advertise AUTH.
13438 Exim does not accept AUTH commands from clients to which it has not
13439 advertised the availability of AUTH. The advertising of individual
13440 authentication mechanisms can be controlled by the use of the
13441 &%server_advertise_condition%& generic authenticator option on the individual
13442 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13443
13444 Certain mail clients (for example, Netscape) require the user to provide a name
13445 and password for authentication if AUTH is advertised, even though it may
13446 not be needed (the host may accept messages from hosts on its local LAN without
13447 authentication, for example). The &%auth_advertise_hosts%& option can be used
13448 to make these clients more friendly by excluding them from the set of hosts to
13449 which Exim advertises AUTH.
13450
13451 .cindex "AUTH" "advertising when encrypted"
13452 If you want to advertise the availability of AUTH only when the connection
13453 is encrypted using TLS, you can make use of the fact that the value of this
13454 option is expanded, with a setting like this:
13455 .code
13456 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13457 .endd
13458 .vindex "&$tls_in_cipher$&"
13459 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13460 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13461 expansion is *, which matches all hosts.
13462
13463
13464 .option auto_thaw main time 0s
13465 .cindex "thawing messages"
13466 .cindex "unfreezing messages"
13467 If this option is set to a time greater than zero, a queue runner will try a
13468 new delivery attempt on any frozen message, other than a bounce message, if
13469 this much time has passed since it was frozen. This may result in the message
13470 being re-frozen if nothing has changed since the last attempt. It is a way of
13471 saying &"keep on trying, even though there are big problems"&.
13472
13473 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13474 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13475 thought to be very useful any more, and its use should probably be avoided.
13476
13477
13478 .option av_scanner main string "see below"
13479 This option is available if Exim is built with the content-scanning extension.
13480 It specifies which anti-virus scanner to use. The default value is:
13481 .code
13482 sophie:/var/run/sophie
13483 .endd
13484 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13485 before use. See section &<<SECTscanvirus>>& for further details.
13486
13487
13488 .option bi_command main string unset
13489 .oindex "&%-bi%&"
13490 This option supplies the name of a command that is run when Exim is called with
13491 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13492 just the command name, it is not a complete command line. If an argument is
13493 required, it must come from the &%-oA%& command line option.
13494
13495
13496 .option bounce_message_file main string unset
13497 .cindex "bounce message" "customizing"
13498 .cindex "customizing" "bounce message"
13499 This option defines a template file containing paragraphs of text to be used
13500 for constructing bounce messages.  Details of the file's contents are given in
13501 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13502
13503
13504 .option bounce_message_text main string unset
13505 When this option is set, its contents are included in the default bounce
13506 message immediately after &"This message was created automatically by mail
13507 delivery software."& It is not used if &%bounce_message_file%& is set.
13508
13509 .option bounce_return_body main boolean true
13510 .cindex "bounce message" "including body"
13511 This option controls whether the body of an incoming message is included in a
13512 bounce message when &%bounce_return_message%& is true. The default setting
13513 causes the entire message, both header and body, to be returned (subject to the
13514 value of &%bounce_return_size_limit%&). If this option is false, only the
13515 message header is included. In the case of a non-SMTP message containing an
13516 error that is detected during reception, only those header lines preceding the
13517 point at which the error was detected are returned.
13518 .cindex "bounce message" "including original"
13519
13520 .option bounce_return_message main boolean true
13521 If this option is set false, none of the original message is included in
13522 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13523 &%bounce_return_body%&.
13524
13525
13526 .option bounce_return_size_limit main integer 100K
13527 .cindex "size" "of bounce, limit"
13528 .cindex "bounce message" "size limit"
13529 .cindex "limit" "bounce message size"
13530 This option sets a limit in bytes on the size of messages that are returned to
13531 senders as part of bounce messages when &%bounce_return_message%& is true. The
13532 limit should be less than the value of the global &%message_size_limit%& and of
13533 any &%message_size_limit%& settings on transports, to allow for the bounce text
13534 that Exim generates. If this option is set to zero there is no limit.
13535
13536 When the body of any message that is to be included in a bounce message is
13537 greater than the limit, it is truncated, and a comment pointing this out is
13538 added at the top. The actual cutoff may be greater than the value given, owing
13539 to the use of buffering for transferring the message in chunks (typically 8K in
13540 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13541 messages.
13542
13543 .option bounce_sender_authentication main string unset
13544 .cindex "bounce message" "sender authentication"
13545 .cindex "authentication" "bounce message"
13546 .cindex "AUTH" "on bounce message"
13547 This option provides an authenticated sender address that is sent with any
13548 bounce messages generated by Exim that are sent over an authenticated SMTP
13549 connection. A typical setting might be:
13550 .code
13551 bounce_sender_authentication = mailer-daemon@my.domain.example
13552 .endd
13553 which would cause bounce messages to be sent using the SMTP command:
13554 .code
13555 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13556 .endd
13557 The value of &%bounce_sender_authentication%& must always be a complete email
13558 address.
13559
13560 .option callout_domain_negative_expire main time 3h
13561 .cindex "caching" "callout timeouts"
13562 .cindex "callout" "caching timeouts"
13563 This option specifies the expiry time for negative callout cache data for a
13564 domain. See section &<<SECTcallver>>& for details of callout verification, and
13565 section &<<SECTcallvercache>>& for details of the caching.
13566
13567
13568 .option callout_domain_positive_expire main time 7d
13569 This option specifies the expiry time for positive callout cache data for a
13570 domain. See section &<<SECTcallver>>& for details of callout verification, and
13571 section &<<SECTcallvercache>>& for details of the caching.
13572
13573
13574 .option callout_negative_expire main time 2h
13575 This option specifies the expiry time for negative callout cache data for an
13576 address. See section &<<SECTcallver>>& for details of callout verification, and
13577 section &<<SECTcallvercache>>& for details of the caching.
13578
13579
13580 .option callout_positive_expire main time 24h
13581 This option specifies the expiry time for positive callout cache data for an
13582 address. See section &<<SECTcallver>>& for details of callout verification, and
13583 section &<<SECTcallvercache>>& for details of the caching.
13584
13585
13586 .option callout_random_local_part main string&!! "see below"
13587 This option defines the &"random"& local part that can be used as part of
13588 callout verification. The default value is
13589 .code
13590 $primary_hostname-$tod_epoch-testing
13591 .endd
13592 See section &<<CALLaddparcall>>& for details of how this value is used.
13593
13594
13595 .option check_log_inodes main integer 0
13596 See &%check_spool_space%& below.
13597
13598
13599 .option check_log_space main integer 0
13600 See &%check_spool_space%& below.
13601
13602 .oindex "&%check_rfc2047_length%&"
13603 .cindex "RFC 2047" "disabling length check"
13604 .option check_rfc2047_length main boolean true
13605 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13606 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13607 word; strings to be encoded that exceed this length are supposed to use
13608 multiple encoded words. By default, Exim does not recognize encoded words that
13609 exceed the maximum length. However, it seems that some software, in violation
13610 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13611 set false, Exim recognizes encoded words of any length.
13612
13613
13614 .option check_spool_inodes main integer 0
13615 See &%check_spool_space%& below.
13616
13617
13618 .option check_spool_space main integer 0
13619 .cindex "checking disk space"
13620 .cindex "disk space, checking"
13621 .cindex "spool directory" "checking space"
13622 The four &%check_...%& options allow for checking of disk resources before a
13623 message is accepted.
13624
13625 .vindex "&$log_inodes$&"
13626 .vindex "&$log_space$&"
13627 .vindex "&$spool_inodes$&"
13628 .vindex "&$spool_space$&"
13629 When any of these options are set, they apply to all incoming messages. If you
13630 want to apply different checks to different kinds of message, you can do so by
13631 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13632 &$spool_space$& in an ACL with appropriate additional conditions.
13633
13634
13635 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13636 either value is greater than zero, for example:
13637 .code
13638 check_spool_space = 10M
13639 check_spool_inodes = 100
13640 .endd
13641 The spool partition is the one that contains the directory defined by
13642 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13643 transit.
13644
13645 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13646 files are written if either is greater than zero. These should be set only if
13647 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13648
13649 If there is less space or fewer inodes than requested, Exim refuses to accept
13650 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13651 error response to the MAIL command. If ESMTP is in use and there was a
13652 SIZE parameter on the MAIL command, its value is added to the
13653 &%check_spool_space%& value, and the check is performed even if
13654 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13655
13656 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13657 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13658
13659 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13660 failure a message is written to stderr and Exim exits with a non-zero code, as
13661 it obviously cannot send an error message of any kind.
13662
13663 .option daemon_smtp_ports main string &`smtp`&
13664 .cindex "port" "for daemon"
13665 .cindex "TCP/IP" "setting listening ports"
13666 This option specifies one or more default SMTP ports on which the Exim daemon
13667 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13668 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13669
13670 .option daemon_startup_retries main integer 9
13671 .cindex "daemon startup, retrying"
13672 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13673 the daemon at startup when it cannot immediately bind a listening socket
13674 (typically because the socket is already in use): &%daemon_startup_retries%&
13675 defines the number of retries after the first failure, and
13676 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13677
13678 .option daemon_startup_sleep main time 30s
13679 See &%daemon_startup_retries%&.
13680
13681 .option delay_warning main "time list" 24h
13682 .cindex "warning of delay"
13683 .cindex "delay warning, specifying"
13684 When a message is delayed, Exim sends a warning message to the sender at
13685 intervals specified by this option. The data is a colon-separated list of times
13686 after which to send warning messages. If the value of the option is an empty
13687 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13688 message has been on the queue for longer than the last time, the last interval
13689 between the times is used to compute subsequent warning times. For example,
13690 with
13691 .code
13692 delay_warning = 4h:8h:24h
13693 .endd
13694 the first message is sent after 4 hours, the second after 8 hours, and
13695 the third one after 24 hours. After that, messages are sent every 16 hours,
13696 because that is the interval between the last two times on the list. If you set
13697 just one time, it specifies the repeat interval. For example, with:
13698 .code
13699 delay_warning = 6h
13700 .endd
13701 messages are repeated every six hours. To stop warnings after a given time, set
13702 a very large time at the end of the list. For example:
13703 .code
13704 delay_warning = 2h:12h:99d
13705 .endd
13706
13707 .option delay_warning_condition main string&!! "see below"
13708 .vindex "&$domain$&"
13709 The string is expanded at the time a warning message might be sent. If all the
13710 deferred addresses have the same domain, it is set in &$domain$& during the
13711 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13712 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13713 &"false"& (the comparison being done caselessly) then the warning message is
13714 not sent. The default is:
13715 .code
13716 delay_warning_condition = ${if or {\
13717   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13718   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13719   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13720   } {no}{yes}}
13721 .endd
13722 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13723 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13724 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13725 &"auto-replied"& in an &'Auto-Submitted:'& header.
13726
13727 .option deliver_drop_privilege main boolean false
13728 .cindex "unprivileged delivery"
13729 .cindex "delivery" "unprivileged"
13730 If this option is set true, Exim drops its root privilege at the start of a
13731 delivery process, and runs as the Exim user throughout. This severely restricts
13732 the kinds of local delivery that are possible, but is viable in certain types
13733 of configuration. There is a discussion about the use of root privilege in
13734 chapter &<<CHAPsecurity>>&.
13735
13736 .option deliver_queue_load_max main fixed-point unset
13737 .cindex "load average"
13738 .cindex "queue runner" "abandoning"
13739 When this option is set, a queue run is abandoned if the system load average
13740 becomes greater than the value of the option. The option has no effect on
13741 ancient operating systems on which Exim cannot determine the load average.
13742 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13743
13744
13745 .option delivery_date_remove main boolean true
13746 .cindex "&'Delivery-date:'& header line"
13747 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13748 message when it is delivered, in exactly the same way as &'Return-path:'& is
13749 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13750 should not be present in incoming messages, and this option causes them to be
13751 removed at the time the message is received, to avoid any problems that might
13752 occur when a delivered message is subsequently sent on to some other recipient.
13753
13754 .option disable_fsync main boolean false
13755 .cindex "&[fsync()]&, disabling"
13756 This option is available only if Exim was built with the compile-time option
13757 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13758 a runtime configuration generates an &"unknown option"& error. You should not
13759 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13760 really, really, really understand what you are doing. &'No pre-compiled
13761 distributions of Exim should ever make this option available.'&
13762
13763 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13764 updated files' data to be written to disc before continuing. Unexpected events
13765 such as crashes and power outages may cause data to be lost or scrambled.
13766 Here be Dragons. &*Beware.*&
13767
13768
13769 .option disable_ipv6 main boolean false
13770 .cindex "IPv6" "disabling"
13771 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13772 activities take place. AAAA records are never looked up, and any IPv6 addresses
13773 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13774 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13775 to handle IPv6 literal addresses.
13776
13777
13778 .option dns_again_means_nonexist main "domain list&!!" unset
13779 .cindex "DNS" "&""try again""& response; overriding"
13780 DNS lookups give a &"try again"& response for the DNS errors
13781 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13782 keep trying to deliver a message, or to give repeated temporary errors to
13783 incoming mail. Sometimes the effect is caused by a badly set up name server and
13784 may persist for a long time. If a domain which exhibits this problem matches
13785 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13786 This option should be used with care. You can make it apply to reverse lookups
13787 by a setting such as this:
13788 .code
13789 dns_again_means_nonexist = *.in-addr.arpa
13790 .endd
13791 This option applies to all DNS lookups that Exim does. It also applies when the
13792 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13793 since these are most likely to be caused by DNS lookup problems. The
13794 &(dnslookup)& router has some options of its own for controlling what happens
13795 when lookups for MX or SRV records give temporary errors. These more specific
13796 options are applied after this global option.
13797
13798 .option dns_check_names_pattern main string "see below"
13799 .cindex "DNS" "pre-check of name syntax"
13800 When this option is set to a non-empty string, it causes Exim to check domain
13801 names for characters that are not allowed in host names before handing them to
13802 the DNS resolver, because some resolvers give temporary errors for names that
13803 contain unusual characters. If a domain name contains any unwanted characters,
13804 a &"not found"& result is forced, and the resolver is not called. The check is
13805 done by matching the domain name against a regular expression, which is the
13806 value of this option. The default pattern is
13807 .code
13808 dns_check_names_pattern = \
13809   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13810 .endd
13811 which permits only letters, digits, slashes, and hyphens in components, but
13812 they must start and end with a letter or digit. Slashes are not, in fact,
13813 permitted in host names, but they are found in certain NS records (which can be
13814 accessed in Exim by using a &%dnsdb%& lookup). If you set
13815 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13816 empty string.
13817
13818 .option dns_csa_search_limit main integer 5
13819 This option controls the depth of parental searching for CSA SRV records in the
13820 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13821
13822 .option dns_csa_use_reverse main boolean true
13823 This option controls whether or not an IP address, given as a CSA domain, is
13824 reversed and looked up in the reverse DNS, as described in more detail in
13825 section &<<SECTverifyCSA>>&.
13826
13827 .option dns_ipv4_lookup main "domain list&!!" unset
13828 .cindex "IPv6" "DNS lookup for AAAA records"
13829 .cindex "DNS" "IPv6 lookup for AAAA records"
13830 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13831 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13832 (A records) when trying to find IP addresses for hosts, unless the host's
13833 domain matches this list.
13834
13835 This is a fudge to help with name servers that give big delays or otherwise do
13836 not work for the AAAA record type. In due course, when the world's name
13837 servers have all been upgraded, there should be no need for this option.
13838
13839
13840 .option dns_retrans main time 0s
13841 .cindex "DNS" "resolver options"
13842 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13843 retransmission and retry parameters for DNS lookups. Values of zero (the
13844 defaults) leave the system default settings unchanged. The first value is the
13845 time between retries, and the second is the number of retries. It isn't
13846 totally clear exactly how these settings affect the total time a DNS lookup may
13847 take. I haven't found any documentation about timeouts on DNS lookups; these
13848 parameter values are available in the external resolver interface structure,
13849 but nowhere does it seem to describe how they are used or what you might want
13850 to set in them.
13851
13852
13853 .option dns_retry main integer 0
13854 See &%dns_retrans%& above.
13855
13856
13857 .new
13858 .option dns_use_dnssec main integer -1
13859 .cindex "DNS" "resolver options"
13860 .cindex "DNS" "DNSSEC"
13861 If this option is set to a non-negative number then Exim will initialise the
13862 DNS resolver library to either use or not use DNSSEC, overriding the system
13863 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13864
13865 If the resolver library does not support DNSSEC then this option has no effect.
13866 .wen
13867
13868
13869 .option dns_use_edns0 main integer -1
13870 .cindex "DNS" "resolver options"
13871 .cindex "DNS" "EDNS0"
13872 If this option is set to a non-negative number then Exim will initialise the
13873 DNS resolver library to either use or not use EDNS0 extensions, overriding
13874 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13875 on.
13876
13877 If the resolver library does not support EDNS0 then this option has no effect.
13878
13879
13880 .option drop_cr main boolean false
13881 This is an obsolete option that is now a no-op. It used to affect the way Exim
13882 handled CR and LF characters in incoming messages. What happens now is
13883 described in section &<<SECTlineendings>>&.
13884
13885 .option dsn_from main "string&!!" "see below"
13886 .cindex "&'From:'& header line" "in bounces"
13887 .cindex "bounce messages" "&'From:'& line, specifying"
13888 This option can be used to vary the contents of &'From:'& header lines in
13889 bounces and other automatically generated messages (&"Delivery Status
13890 Notifications"& &-- hence the name of the option). The default setting is:
13891 .code
13892 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13893 .endd
13894 The value is expanded every time it is needed. If the expansion fails, a
13895 panic is logged, and the default value is used.
13896
13897 .option envelope_to_remove main boolean true
13898 .cindex "&'Envelope-to:'& header line"
13899 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13900 message when it is delivered, in exactly the same way as &'Return-path:'& is
13901 handled. &'Envelope-to:'& records the original recipient address from the
13902 messages's envelope that caused the delivery to happen. Such headers should not
13903 be present in incoming messages, and this option causes them to be removed at
13904 the time the message is received, to avoid any problems that might occur when a
13905 delivered message is subsequently sent on to some other recipient.
13906
13907
13908 .option errors_copy main "string list&!!" unset
13909 .cindex "bounce message" "copy to other address"
13910 .cindex "copy of bounce message"
13911 Setting this option causes Exim to send bcc copies of bounce messages that it
13912 generates to other addresses. &*Note*&: This does not apply to bounce messages
13913 coming from elsewhere. The value of the option is a colon-separated list of
13914 items. Each item consists of a pattern, terminated by white space, followed by
13915 a comma-separated list of email addresses. If a pattern contains spaces, it
13916 must be enclosed in double quotes.
13917
13918 Each pattern is processed in the same way as a single item in an address list
13919 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13920 the bounce message, the message is copied to the addresses on the list. The
13921 items are scanned in order, and once a matching one is found, no further items
13922 are examined. For example:
13923 .code
13924 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13925               rqps@mydomain   hostmaster@mydomain.example,\
13926                               postmaster@mydomain.example
13927 .endd
13928 .vindex "&$domain$&"
13929 .vindex "&$local_part$&"
13930 The address list is expanded before use. The expansion variables &$local_part$&
13931 and &$domain$& are set from the original recipient of the error message, and if
13932 there was any wildcard matching in the pattern, the expansion
13933 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13934 variables &$0$&, &$1$&, etc. are set in the normal way.
13935
13936
13937 .option errors_reply_to main string unset
13938 .cindex "bounce message" "&'Reply-to:'& in"
13939 By default, Exim's bounce and delivery warning messages contain the header line
13940 .display
13941 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13942 .endd
13943 .oindex &%quota_warn_message%&
13944 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13945 A warning message that is generated by the &%quota_warn_message%& option in an
13946 &(appendfile)& transport may contain its own &'From:'& header line that
13947 overrides the default.
13948
13949 Experience shows that people reply to bounce messages. If the
13950 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13951 and warning messages. For example:
13952 .code
13953 errors_reply_to = postmaster@my.domain.example
13954 .endd
13955 The value of the option is not expanded. It must specify a valid RFC 2822
13956 address. However, if a warning message that is generated by the
13957 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13958 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13959 not used.
13960
13961
13962 .option exim_group main string "compile-time configured"
13963 .cindex "gid (group id)" "Exim's own"
13964 .cindex "Exim group"
13965 This option changes the gid under which Exim runs when it gives up root
13966 privilege. The default value is compiled into the binary. The value of this
13967 option is used only when &%exim_user%& is also set. Unless it consists entirely
13968 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13969 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13970 security issues.
13971
13972
13973 .option exim_path main string "see below"
13974 .cindex "Exim binary, path name"
13975 This option specifies the path name of the Exim binary, which is used when Exim
13976 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13977 the directory configured at compile time by the BIN_DIRECTORY setting. It
13978 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13979 other place.
13980 &*Warning*&: Do not use a macro to define the value of this option, because
13981 you will break those Exim utilities that scan the configuration file to find
13982 where the binary is. (They then use the &%-bP%& option to extract option
13983 settings such as the value of &%spool_directory%&.)
13984
13985
13986 .option exim_user main string "compile-time configured"
13987 .cindex "uid (user id)" "Exim's own"
13988 .cindex "Exim user"
13989 This option changes the uid under which Exim runs when it gives up root
13990 privilege. The default value is compiled into the binary. Ownership of the run
13991 time configuration file and the use of the &%-C%& and &%-D%& command line
13992 options is checked against the values in the binary, not what is set here.
13993
13994 Unless it consists entirely of digits, the string is looked up using
13995 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13996 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13997 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13998
13999
14000 .option extra_local_interfaces main "string list" unset
14001 This option defines network interfaces that are to be considered local when
14002 routing, but which are not used for listening by the daemon. See section
14003 &<<SECTreclocipadd>>& for details.
14004
14005
14006 . Allow this long option name to split; give it unsplit as a fifth argument
14007 . for the automatic .oindex that is generated by .option.
14008
14009 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14010          extract_addresses_remove_arguments
14011 .oindex "&%-t%&"
14012 .cindex "command line" "addresses with &%-t%&"
14013 .cindex "Sendmail compatibility" "&%-t%& option"
14014 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14015 are present on the command line when the &%-t%& option is used to build an
14016 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14017 line addresses are removed from the recipients list. This is also how Smail
14018 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14019 command line addresses are added to those obtained from the header lines. When
14020 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14021 argument headers. If it is set false, Exim adds rather than removes argument
14022 addresses.
14023
14024
14025 .option finduser_retries main integer 0
14026 .cindex "NIS, retrying user lookups"
14027 On systems running NIS or other schemes in which user and group information is
14028 distributed from a remote system, there can be times when &[getpwnam()]& and
14029 related functions fail, even when given valid data, because things time out.
14030 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14031 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14032 many extra times to find a user or a group, waiting for one second between
14033 retries.
14034
14035 .cindex "&_/etc/passwd_&" "multiple reading of"
14036 You should not set this option greater than zero if your user information is in
14037 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14038 search the file multiple times for non-existent users, and also cause delay.
14039
14040
14041
14042 .option freeze_tell main "string list, comma separated" unset
14043 .cindex "freezing messages" "sending a message when freezing"
14044 On encountering certain errors, or when configured to do so in a system filter,
14045 ACL, or special router, Exim freezes a message. This means that no further
14046 delivery attempts take place until an administrator thaws the message, or the
14047 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14048 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14049 warning message whenever it freezes something, unless the message it is
14050 freezing is a locally-generated bounce message. (Without this exception there
14051 is the possibility of looping.) The warning message is sent to the addresses
14052 supplied as the comma-separated value of this option. If several of the
14053 message's addresses cause freezing, only a single message is sent. If the
14054 freezing was automatic, the reason(s) for freezing can be found in the message
14055 log. If you configure freezing in a filter or ACL, you must arrange for any
14056 logging that you require.
14057
14058
14059 .option gecos_name main string&!! unset
14060 .cindex "HP-UX"
14061 .cindex "&""gecos""& field, parsing"
14062 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14063 password file to hold other information in addition to users' real names. Exim
14064 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14065 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14066 of the field are used unchanged, except that, if an ampersand is encountered,
14067 it is replaced by the user's login name with the first character forced to
14068 upper case, since this is a convention that is observed on many systems.
14069
14070 When these options are set, &%gecos_pattern%& is treated as a regular
14071 expression that is to be applied to the field (again with && replaced by the
14072 login name), and if it matches, &%gecos_name%& is expanded and used as the
14073 user's name.
14074
14075 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14076 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14077 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14078 name terminates at the first comma, the following can be used:
14079 .code
14080 gecos_pattern = ([^,]*)
14081 gecos_name = $1
14082 .endd
14083
14084 .option gecos_pattern main string unset
14085 See &%gecos_name%& above.
14086
14087
14088 .option gnutls_compat_mode main boolean unset
14089 This option controls whether GnuTLS is used in compatibility mode in an Exim
14090 server. This reduces security slightly, but improves interworking with older
14091 implementations of TLS.
14092
14093
14094 .new
14095 option gnutls_allow_auto_pkcs11 main boolean unset
14096 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14097 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14098
14099 See
14100 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14101 for documentation.
14102 .wen
14103
14104
14105
14106 .option headers_charset main string "see below"
14107 This option sets a default character set for translating from encoded MIME
14108 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14109 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14110 ultimate default is ISO-8859-1. For more details see the description of header
14111 insertions in section &<<SECTexpansionitems>>&.
14112
14113
14114
14115 .option header_maxsize main integer "see below"
14116 .cindex "header section" "maximum size of"
14117 .cindex "limit" "size of message header section"
14118 This option controls the overall maximum size of a message's header
14119 section. The default is the value of HEADER_MAXSIZE in
14120 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14121 sections are rejected.
14122
14123
14124 .option header_line_maxsize main integer 0
14125 .cindex "header lines" "maximum size of"
14126 .cindex "limit" "size of one header line"
14127 This option limits the length of any individual header line in a message, after
14128 all the continuations have been joined together. Messages with individual
14129 header lines that are longer than the limit are rejected. The default value of
14130 zero means &"no limit"&.
14131
14132
14133
14134
14135 .option helo_accept_junk_hosts main "host list&!!" unset
14136 .cindex "HELO" "accepting junk data"
14137 .cindex "EHLO" "accepting junk data"
14138 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14139 mail, and gives an error response for invalid data. Unfortunately, there are
14140 some SMTP clients that send syntactic junk. They can be accommodated by setting
14141 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14142 if you want to do semantic checking.
14143 See also &%helo_allow_chars%& for a way of extending the permitted character
14144 set.
14145
14146
14147 .option helo_allow_chars main string unset
14148 .cindex "HELO" "underscores in"
14149 .cindex "EHLO" "underscores in"
14150 .cindex "underscore in EHLO/HELO"
14151 This option can be set to a string of rogue characters that are permitted in
14152 all EHLO and HELO names in addition to the standard letters, digits,
14153 hyphens, and dots. If you really must allow underscores, you can set
14154 .code
14155 helo_allow_chars = _
14156 .endd
14157 Note that the value is one string, not a list.
14158
14159
14160 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14161 .cindex "HELO" "forcing reverse lookup"
14162 .cindex "EHLO" "forcing reverse lookup"
14163 If the domain given by a client in a HELO or EHLO command matches this
14164 list, a reverse lookup is done in order to establish the host's true name. The
14165 default forces a lookup if the client host gives the server's name or any of
14166 its IP addresses (in brackets), something that broken clients have been seen to
14167 do.
14168
14169
14170 .option helo_try_verify_hosts main "host list&!!" unset
14171 .cindex "HELO verifying" "optional"
14172 .cindex "EHLO" "verifying, optional"
14173 By default, Exim just checks the syntax of HELO and EHLO commands (see
14174 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14175 to do more extensive checking of the data supplied by these commands. The ACL
14176 condition &`verify = helo`& is provided to make this possible.
14177 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14178 to force the check to occur. From release 4.53 onwards, this is no longer
14179 necessary. If the check has not been done before &`verify = helo`& is
14180 encountered, it is done at that time. Consequently, this option is obsolete.
14181 Its specification is retained here for backwards compatibility.
14182
14183 When an EHLO or HELO command is received, if the calling host matches
14184 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14185 EHLO command either:
14186
14187 .ilist
14188 is an IP literal matching the calling address of the host, or
14189 .next
14190 .cindex "DNS" "reverse lookup"
14191 .cindex "reverse DNS lookup"
14192 matches the host name that Exim obtains by doing a reverse lookup of the
14193 calling host address, or
14194 .next
14195 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14196 available) yields the calling host address.
14197 .endlist
14198
14199 However, the EHLO or HELO command is not rejected if any of the checks
14200 fail. Processing continues, but the result of the check is remembered, and can
14201 be detected later in an ACL by the &`verify = helo`& condition.
14202
14203 .option helo_verify_hosts main "host list&!!" unset
14204 .cindex "HELO verifying" "mandatory"
14205 .cindex "EHLO" "verifying, mandatory"
14206 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14207 backwards compatibility. For hosts that match this option, Exim checks the host
14208 name given in the HELO or EHLO in the same way as for
14209 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14210 rejected with a 550 error, and entries are written to the main and reject logs.
14211 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14212 error.
14213
14214 .option hold_domains main "domain list&!!" unset
14215 .cindex "domain" "delaying delivery"
14216 .cindex "delivery" "delaying certain domains"
14217 This option allows mail for particular domains to be held on the queue
14218 manually. The option is overridden if a message delivery is forced with the
14219 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14220 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14221 item in &%hold_domains%&, no routing or delivery for that address is done, and
14222 it is deferred every time the message is looked at.
14223
14224 This option is intended as a temporary operational measure for delaying the
14225 delivery of mail while some problem is being sorted out, or some new
14226 configuration tested. If you just want to delay the processing of some
14227 domains until a queue run occurs, you should use &%queue_domains%& or
14228 &%queue_smtp_domains%&, not &%hold_domains%&.
14229
14230 A setting of &%hold_domains%& does not override Exim's code for removing
14231 messages from the queue if they have been there longer than the longest retry
14232 time in any retry rule. If you want to hold messages for longer than the normal
14233 retry times, insert a dummy retry rule with a long retry time.
14234
14235
14236 .option host_lookup main "host list&!!" unset
14237 .cindex "host name" "lookup, forcing"
14238 Exim does not look up the name of a calling host from its IP address unless it
14239 is required to compare against some host list, or the host matches
14240 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14241 option (which normally contains IP addresses rather than host names). The
14242 default configuration file contains
14243 .code
14244 host_lookup = *
14245 .endd
14246 which causes a lookup to happen for all hosts. If the expense of these lookups
14247 is felt to be too great, the setting can be changed or removed.
14248
14249 After a successful reverse lookup, Exim does a forward lookup on the name it
14250 has obtained, to verify that it yields the IP address that it started with. If
14251 this check fails, Exim behaves as if the name lookup failed.
14252
14253 .vindex "&$host_lookup_failed$&"
14254 .vindex "&$sender_host_name$&"
14255 After any kind of failure, the host name (in &$sender_host_name$&) remains
14256 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14257 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14258 &`verify = reverse_host_lookup`& in ACLs.
14259
14260
14261 .option host_lookup_order main "string list" &`bydns:byaddr`&
14262 This option specifies the order of different lookup methods when Exim is trying
14263 to find a host name from an IP address. The default is to do a DNS lookup
14264 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14265 if that fails. You can change the order of these lookups, or omit one entirely,
14266 if you want.
14267
14268 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14269 multiple PTR records in the DNS and the IP address is not listed in
14270 &_/etc/hosts_&. Different operating systems give different results in this
14271 case. That is why the default tries a DNS lookup first.
14272
14273
14274
14275 .option host_reject_connection main "host list&!!" unset
14276 .cindex "host" "rejecting connections from"
14277 If this option is set, incoming SMTP calls from the hosts listed are rejected
14278 as soon as the connection is made.
14279 This option is obsolete, and retained only for backward compatibility, because
14280 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14281 connections immediately.
14282
14283 The ability to give an immediate rejection (either by this option or using an
14284 ACL) is provided for use in unusual cases. Many hosts will just try again,
14285 sometimes without much delay. Normally, it is better to use an ACL to reject
14286 incoming messages at a later stage, such as after RCPT commands. See
14287 chapter &<<CHAPACL>>&.
14288
14289
14290 .option hosts_connection_nolog main "host list&!!" unset
14291 .cindex "host" "not logging connections from"
14292 This option defines a list of hosts for which connection logging does not
14293 happen, even though the &%smtp_connection%& log selector is set. For example,
14294 you might want not to log SMTP connections from local processes, or from
14295 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14296 the daemon; you should therefore strive to restrict its value to a short inline
14297 list of IP addresses and networks. To disable logging SMTP connections from
14298 local processes, you must create a host list with an empty item. For example:
14299 .code
14300 hosts_connection_nolog = :
14301 .endd
14302 If the &%smtp_connection%& log selector is not set, this option has no effect.
14303
14304
14305
14306 .option hosts_treat_as_local main "domain list&!!" unset
14307 .cindex "local host" "domains treated as"
14308 .cindex "host" "treated as local"
14309 If this option is set, any host names that match the domain list are treated as
14310 if they were the local host when Exim is scanning host lists obtained from MX
14311 records
14312 or other sources. Note that the value of this option is a domain list, not a
14313 host list, because it is always used to check host names, not IP addresses.
14314
14315 This option also applies when Exim is matching the special items
14316 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14317 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14318 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14319 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14320 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14321 interfaces and recognizing the local host.
14322
14323
14324 .option ibase_servers main "string list" unset
14325 .cindex "InterBase" "server list"
14326 This option provides a list of InterBase servers and associated connection data,
14327 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14328 The option is available only if Exim has been built with InterBase support.
14329
14330
14331
14332 .option ignore_bounce_errors_after main time 10w
14333 .cindex "bounce message" "discarding"
14334 .cindex "discarding bounce message"
14335 This option affects the processing of bounce messages that cannot be delivered,
14336 that is, those that suffer a permanent delivery failure. (Bounce messages that
14337 suffer temporary delivery failures are of course retried in the usual way.)
14338
14339 After a permanent delivery failure, bounce messages are frozen,
14340 because there is no sender to whom they can be returned. When a frozen bounce
14341 message has been on the queue for more than the given time, it is unfrozen at
14342 the next queue run, and a further delivery is attempted. If delivery fails
14343 again, the bounce message is discarded. This makes it possible to keep failed
14344 bounce messages around for a shorter time than the normal maximum retry time
14345 for frozen messages. For example,
14346 .code
14347 ignore_bounce_errors_after = 12h
14348 .endd
14349 retries failed bounce message deliveries after 12 hours, discarding any further
14350 failures. If the value of this option is set to a zero time period, bounce
14351 failures are discarded immediately. Setting a very long time (as in the default
14352 value) has the effect of disabling this option. For ways of automatically
14353 dealing with other kinds of frozen message, see &%auto_thaw%& and
14354 &%timeout_frozen_after%&.
14355
14356
14357 .option ignore_fromline_hosts main "host list&!!" unset
14358 .cindex "&""From""& line"
14359 .cindex "UUCP" "&""From""& line"
14360 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14361 the headers of a message. By default this is treated as the start of the
14362 message's body, which means that any following headers are not recognized as
14363 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14364 match those hosts that insist on sending it. If the sender is actually a local
14365 process rather than a remote host, and is using &%-bs%& to inject the messages,
14366 &%ignore_fromline_local%& must be set to achieve this effect.
14367
14368
14369 .option ignore_fromline_local main boolean false
14370 See &%ignore_fromline_hosts%& above.
14371
14372 .new
14373 .option keep_environment main "string list" unset
14374 .cindex "environment" "inherited"
14375 This option contains a string list of environment variables to keep.
14376 You have to trust these variables or you have to be sure that
14377 these variables do not impose any security risk. Keep in mind that
14378 during the startup phase Exim is running with an effective UID 0 in most
14379 installations. As the default value is an empty list, the default
14380 environment for using libraries, running embedded Perl code, or running
14381 external binaries is empty, and does not not even contain PATH or HOME.
14382
14383 Actually the list is interpreted as a list of patterns
14384 (&<<SECTlistexpand>>&), except that it is not expanded first.
14385
14386 WARNING: Macro substitution is still done first, so having a macro
14387 FOO and having FOO_HOME in your &%keep_environment%& option may have
14388 unexpected results. You may work around this using a regular expression
14389 that does not match the macro name: ^[F]OO_HOME$.
14390
14391 Current versions of Exim issue a warning during startupif you do not mention
14392 &%keep_environment%& or &%add_environment%& in your runtime configuration
14393 file.
14394 .wen
14395
14396
14397 .option keep_malformed main time 4d
14398 This option specifies the length of time to keep messages whose spool files
14399 have been corrupted in some way. This should, of course, never happen. At the
14400 next attempt to deliver such a message, it gets removed. The incident is
14401 logged.
14402
14403
14404 .option ldap_ca_cert_dir main string unset
14405 .cindex "LDAP", "TLS CA certificate directory"
14406 This option indicates which directory contains CA certificates for verifying
14407 a TLS certificate presented by an LDAP server.
14408 While Exim does not provide a default value, your SSL library may.
14409 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14410 and constrained to be a directory.
14411
14412
14413 .option ldap_ca_cert_file main string unset
14414 .cindex "LDAP", "TLS CA certificate file"
14415 This option indicates which file contains CA certificates for verifying
14416 a TLS certificate presented by an LDAP server.
14417 While Exim does not provide a default value, your SSL library may.
14418 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14419 and constrained to be a file.
14420
14421
14422 .option ldap_cert_file main string unset
14423 .cindex "LDAP" "TLS client certificate file"
14424 This option indicates which file contains an TLS client certificate which
14425 Exim should present to the LDAP server during TLS negotiation.
14426 Should be used together with &%ldap_cert_key%&.
14427
14428
14429 .option ldap_cert_key main string unset
14430 .cindex "LDAP" "TLS client key file"
14431 This option indicates which file contains the secret/private key to use
14432 to prove identity to the LDAP server during TLS negotiation.
14433 Should be used together with &%ldap_cert_file%&, which contains the
14434 identity to be proven.
14435
14436
14437 .option ldap_cipher_suite main string unset
14438 .cindex "LDAP" "TLS cipher suite"
14439 This controls the TLS cipher-suite negotiation during TLS negotiation with
14440 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14441 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14442
14443
14444 .option ldap_default_servers main "string list" unset
14445 .cindex "LDAP" "default servers"
14446 This option provides a list of LDAP servers which are tried in turn when an
14447 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14448 details of LDAP queries. This option is available only when Exim has been built
14449 with LDAP support.
14450
14451
14452 .option ldap_require_cert main string unset.
14453 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14454 This should be one of the values "hard", "demand", "allow", "try" or "never".
14455 A value other than one of these is interpreted as "never".
14456 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14457 Although Exim does not set a default, the LDAP library probably defaults
14458 to hard/demand.
14459
14460
14461 .option ldap_start_tls main boolean false
14462 .cindex "LDAP" "whether or not to negotiate TLS"
14463 If set, Exim will attempt to negotiate TLS with the LDAP server when
14464 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14465 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14466 of SSL-on-connect.
14467 In the event of failure to negotiate TLS, the action taken is controlled
14468 by &%ldap_require_cert%&.
14469
14470
14471 .option ldap_version main integer unset
14472 .cindex "LDAP" "protocol version, forcing"
14473 This option can be used to force Exim to set a specific protocol version for
14474 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14475 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14476 the LDAP headers; otherwise it is 2. This option is available only when Exim
14477 has been built with LDAP support.
14478
14479
14480
14481 .option local_from_check main boolean true
14482 .cindex "&'Sender:'& header line" "disabling addition of"
14483 .cindex "&'From:'& header line" "disabling checking of"
14484 When a message is submitted locally (that is, not over a TCP/IP connection) by
14485 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14486 checks that the &'From:'& header line matches the login of the calling user and
14487 the domain specified by &%qualify_domain%&.
14488
14489 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14490 locally submitted message is automatically qualified by Exim, unless the
14491 &%-bnq%& command line option is used.
14492
14493 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14494 on the local part. If the &'From:'& header line does not match, Exim adds a
14495 &'Sender:'& header with an address constructed from the calling user's login
14496 and the default qualify domain.
14497
14498 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14499 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14500 &'Sender:'& header lines supplied by untrusted users, you must also set
14501 &%local_sender_retain%& to be true.
14502
14503 .cindex "envelope sender"
14504 These options affect only the header lines in the message. The envelope sender
14505 is still forced to be the login id at the qualify domain unless
14506 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14507
14508 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14509 request similar header line checking. See section &<<SECTthesenhea>>&, which
14510 has more details about &'Sender:'& processing.
14511
14512
14513
14514
14515 .option local_from_prefix main string unset
14516 When Exim checks the &'From:'& header line of locally submitted messages for
14517 matching the login id (see &%local_from_check%& above), it can be configured to
14518 ignore certain prefixes and suffixes in the local part of the address. This is
14519 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14520 appropriate lists, in the same form as the &%local_part_prefix%& and
14521 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14522 example, if
14523 .code
14524 local_from_prefix = *-
14525 .endd
14526 is set, a &'From:'& line containing
14527 .code
14528 From: anything-user@your.domain.example
14529 .endd
14530 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14531 matches the actual sender address that is constructed from the login name and
14532 qualify domain.
14533
14534
14535 .option local_from_suffix main string unset
14536 See &%local_from_prefix%& above.
14537
14538
14539 .option local_interfaces main "string list" "see below"
14540 This option controls which network interfaces are used by the daemon for
14541 listening; they are also used to identify the local host when routing. Chapter
14542 &<<CHAPinterfaces>>& contains a full description of this option and the related
14543 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14544 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14545 &%local_interfaces%& is
14546 .code
14547 local_interfaces = 0.0.0.0
14548 .endd
14549 when Exim is built without IPv6 support; otherwise it is
14550 .code
14551 local_interfaces = <; ::0 ; 0.0.0.0
14552 .endd
14553
14554 .option local_scan_timeout main time 5m
14555 .cindex "timeout" "for &[local_scan()]& function"
14556 .cindex "&[local_scan()]& function" "timeout"
14557 This timeout applies to the &[local_scan()]& function (see chapter
14558 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14559 the incoming message is rejected with a temporary error if it is an SMTP
14560 message. For a non-SMTP message, the message is dropped and Exim ends with a
14561 non-zero code. The incident is logged on the main and reject logs.
14562
14563
14564
14565 .option local_sender_retain main boolean false
14566 .cindex "&'Sender:'& header line" "retaining from local submission"
14567 When a message is submitted locally (that is, not over a TCP/IP connection) by
14568 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14569 do not want this to happen, you must set &%local_sender_retain%&, and you must
14570 also set &%local_from_check%& to be false (Exim will complain if you do not).
14571 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14572 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14573
14574
14575
14576
14577 .option localhost_number main string&!! unset
14578 .cindex "host" "locally unique number for"
14579 .cindex "message ids" "with multiple hosts"
14580 .vindex "&$localhost_number$&"
14581 Exim's message ids are normally unique only within the local host. If
14582 uniqueness among a set of hosts is required, each host must set a different
14583 value for the &%localhost_number%& option. The string is expanded immediately
14584 after reading the configuration file (so that a number can be computed from the
14585 host name, for example) and the result of the expansion must be a number in the
14586 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14587 systems). This is available in subsequent string expansions via the variable
14588 &$localhost_number$&. When &%localhost_number is set%&, the final two
14589 characters of the message id, instead of just being a fractional part of the
14590 time, are computed from the time and the local host number as described in
14591 section &<<SECTmessiden>>&.
14592
14593
14594
14595 .option log_file_path main "string list&!!" "set at compile time"
14596 .cindex "log" "file path for"
14597 This option sets the path which is used to determine the names of Exim's log
14598 files, or indicates that logging is to be to syslog, or both. It is expanded
14599 when Exim is entered, so it can, for example, contain a reference to the host
14600 name. If no specific path is set for the log files at compile or run time, they
14601 are written in a sub-directory called &_log_& in Exim's spool directory.
14602 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14603 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14604 used. If this string is fixed at your installation (contains no expansion
14605 variables) it is recommended that you do not set this option in the
14606 configuration file, but instead supply the path using LOG_FILE_PATH in
14607 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14608 early on &-- in particular, failure to read the configuration file.
14609
14610
14611 .option log_selector main string unset
14612 .cindex "log" "selectors"
14613 This option can be used to reduce or increase the number of things that Exim
14614 writes to its log files. Its argument is made up of names preceded by plus or
14615 minus characters. For example:
14616 .code
14617 log_selector = +arguments -retry_defer
14618 .endd
14619 A list of possible names and what they control is given in the chapter on
14620 logging, in section &<<SECTlogselector>>&.
14621
14622
14623 .option log_timezone main boolean false
14624 .cindex "log" "timezone for entries"
14625 .vindex "&$tod_log$&"
14626 .vindex "&$tod_zone$&"
14627 By default, the timestamps on log lines are in local time without the
14628 timezone. This means that if your timezone changes twice a year, the timestamps
14629 in log lines are ambiguous for an hour when the clocks go back. One way of
14630 avoiding this problem is to set the timezone to UTC. An alternative is to set
14631 &%log_timezone%& true. This turns on the addition of the timezone offset to
14632 timestamps in log lines. Turning on this option can add quite a lot to the size
14633 of log files because each line is extended by 6 characters. Note that the
14634 &$tod_log$& variable contains the log timestamp without the zone, but there is
14635 another variable called &$tod_zone$& that contains just the timezone offset.
14636
14637
14638 .option lookup_open_max main integer 25
14639 .cindex "too many open files"
14640 .cindex "open files, too many"
14641 .cindex "file" "too many open"
14642 .cindex "lookup" "maximum open files"
14643 .cindex "limit" "open files for lookups"
14644 This option limits the number of simultaneously open files for single-key
14645 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14646 Exim normally keeps these files open during routing, because often the same
14647 file is required several times. If the limit is reached, Exim closes the least
14648 recently used file. Note that if you are using the &'ndbm'& library, it
14649 actually opens two files for each logical DBM database, though it still counts
14650 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14651 open files"& errors with NDBM, you need to reduce the value of
14652 &%lookup_open_max%&.
14653
14654
14655 .option max_username_length main integer 0
14656 .cindex "length of login name"
14657 .cindex "user name" "maximum length"
14658 .cindex "limit" "user name length"
14659 Some operating systems are broken in that they truncate long arguments to
14660 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14661 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14662 an argument that is longer behaves as if &[getpwnam()]& failed.
14663
14664
14665 .option message_body_newlines main bool false
14666 .cindex "message body" "newlines in variables"
14667 .cindex "newline" "in message body variables"
14668 .vindex "&$message_body$&"
14669 .vindex "&$message_body_end$&"
14670 By default, newlines in the message body are replaced by spaces when setting
14671 the &$message_body$& and &$message_body_end$& expansion variables. If this
14672 option is set true, this no longer happens.
14673
14674
14675 .option message_body_visible main integer 500
14676 .cindex "body of message" "visible size"
14677 .cindex "message body" "visible size"
14678 .vindex "&$message_body$&"
14679 .vindex "&$message_body_end$&"
14680 This option specifies how much of a message's body is to be included in the
14681 &$message_body$& and &$message_body_end$& expansion variables.
14682
14683
14684 .option message_id_header_domain main string&!! unset
14685 .cindex "&'Message-ID:'& header line"
14686 If this option is set, the string is expanded and used as the right hand side
14687 (domain) of the &'Message-ID:'& header that Exim creates if a
14688 locally-originated incoming message does not have one. &"Locally-originated"&
14689 means &"not received over TCP/IP."&
14690 Otherwise, the primary host name is used.
14691 Only letters, digits, dot and hyphen are accepted; any other characters are
14692 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14693 empty string, the option is ignored.
14694
14695
14696 .option message_id_header_text main string&!! unset
14697 If this variable is set, the string is expanded and used to augment the text of
14698 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14699 message does not have one. The text of this header is required by RFC 2822 to
14700 take the form of an address. By default, Exim uses its internal message id as
14701 the local part, and the primary host name as the domain. If this option is set,
14702 it is expanded, and provided the expansion is not forced to fail, and does not
14703 yield an empty string, the result is inserted into the header immediately
14704 before the @, separated from the internal message id by a dot. Any characters
14705 that are illegal in an address are automatically converted into hyphens. This
14706 means that variables such as &$tod_log$& can be used, because the spaces and
14707 colons will become hyphens.
14708
14709
14710 .option message_logs main boolean true
14711 .cindex "message logs" "disabling"
14712 .cindex "log" "message log; disabling"
14713 If this option is turned off, per-message log files are not created in the
14714 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14715 Exim, by reducing the number of files involved in handling a message from a
14716 minimum of four (header spool file, body spool file, delivery journal, and
14717 per-message log) to three. The other major I/O activity is Exim's main log,
14718 which is not affected by this option.
14719
14720
14721 .option message_size_limit main string&!! 50M
14722 .cindex "message" "size limit"
14723 .cindex "limit" "message size"
14724 .cindex "size" "of message, limit"
14725 This option limits the maximum size of message that Exim will process. The
14726 value is expanded for each incoming connection so, for example, it can be made
14727 to depend on the IP address of the remote host for messages arriving via
14728 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14729 optionally followed by K or M.
14730
14731 &*Note*&: This limit cannot be made to depend on a message's sender or any
14732 other properties of an individual message, because it has to be advertised in
14733 the server's response to EHLO. String expansion failure causes a temporary
14734 error. A value of zero means no limit, but its use is not recommended. See also
14735 &%bounce_return_size_limit%&.
14736
14737 Incoming SMTP messages are failed with a 552 error if the limit is
14738 exceeded; locally-generated messages either get a stderr message or a delivery
14739 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14740 an oversized message is logged in both the main and the reject logs. See also
14741 the generic transport option &%message_size_limit%&, which limits the size of
14742 message that an individual transport can process.
14743
14744 If you use a virus-scanner and set this option to to a value larger than the
14745 maximum size that your virus-scanner is configured to support, you may get
14746 failures triggered by large mails.  The right size to configure for the
14747 virus-scanner depends upon what data is passed and the options in use but it's
14748 probably safest to just set it to a little larger than this value.  Eg, with a
14749 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14750 some problems may result.
14751
14752 A value of 0 will disable size limit checking; Exim will still advertise the
14753 SIZE extension in an EHLO response, but without a limit, so as to permit
14754 SMTP clients to still indicate the message size along with the MAIL verb.
14755
14756
14757 .option move_frozen_messages main boolean false
14758 .cindex "frozen messages" "moving"
14759 This option, which is available only if Exim has been built with the setting
14760 .code
14761 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14762 .endd
14763 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14764 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14765 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14766 standard utilities for handling such moved messages, and they do not show up in
14767 lists generated by &%-bp%& or by the Exim monitor.
14768
14769
14770 .option mua_wrapper main boolean false
14771 Setting this option true causes Exim to run in a very restrictive mode in which
14772 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14773 contains a full description of this facility.
14774
14775
14776
14777 .option mysql_servers main "string list" unset
14778 .cindex "MySQL" "server list"
14779 This option provides a list of MySQL servers and associated connection data, to
14780 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14781 option is available only if Exim has been built with MySQL support.
14782
14783
14784 .option never_users main "string list&!!" unset
14785 This option is expanded just once, at the start of Exim's processing. Local
14786 message deliveries are normally run in processes that are setuid to the
14787 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14788 It is usually desirable to prevent any deliveries from running as root, as a
14789 safety precaution.
14790
14791 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14792 list of users that must not be used for local deliveries. This list is fixed in
14793 the binary and cannot be overridden by the configuration file. By default, it
14794 contains just the single user name &"root"&. The &%never_users%& runtime option
14795 can be used to add more users to the fixed list.
14796
14797 If a message is to be delivered as one of the users on the fixed list or the
14798 &%never_users%& list, an error occurs, and delivery is deferred. A common
14799 example is
14800 .code
14801 never_users = root:daemon:bin
14802 .endd
14803 Including root is redundant if it is also on the fixed list, but it does no
14804 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14805 transport driver.
14806
14807
14808 .option openssl_options main "string list" "+no_sslv2"
14809 .cindex "OpenSSL "compatibility options"
14810 This option allows an administrator to adjust the SSL options applied
14811 by OpenSSL to connections.  It is given as a space-separated list of items,
14812 each one to be +added or -subtracted from the current value.
14813
14814 This option is only available if Exim is built against OpenSSL.  The values
14815 available for this option vary according to the age of your OpenSSL install.
14816 The &"all"& value controls a subset of flags which are available, typically
14817 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14818 list the values known on your system and Exim should support all the
14819 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14820 names lose the leading &"SSL_OP_"& and are lower-cased.
14821
14822 Note that adjusting the options can have severe impact upon the security of
14823 SSL as used by Exim.  It is possible to disable safety checks and shoot
14824 yourself in the foot in various unpleasant ways.  This option should not be
14825 adjusted lightly.  An unrecognised item will be detected at startup, by
14826 invoking Exim with the &%-bV%& flag.
14827
14828 Historical note: prior to release 4.80, Exim defaulted this value to
14829 "+dont_insert_empty_fragments", which may still be needed for compatibility
14830 with some clients, but which lowers security by increasing exposure to
14831 some now infamous attacks.
14832
14833 An example:
14834 .code
14835 # Make both old MS and old Eudora happy:
14836 openssl_options = -all +microsoft_big_sslv3_buffer \
14837                        +dont_insert_empty_fragments
14838 .endd
14839
14840 Possible options may include:
14841 .ilist
14842 &`all`&
14843 .next
14844 &`allow_unsafe_legacy_renegotiation`&
14845 .next
14846 &`cipher_server_preference`&
14847 .next
14848 &`dont_insert_empty_fragments`&
14849 .next
14850 &`ephemeral_rsa`&
14851 .next
14852 &`legacy_server_connect`&
14853 .next
14854 &`microsoft_big_sslv3_buffer`&
14855 .next
14856 &`microsoft_sess_id_bug`&
14857 .next
14858 &`msie_sslv2_rsa_padding`&
14859 .next
14860 &`netscape_challenge_bug`&
14861 .next
14862 &`netscape_reuse_cipher_change_bug`&
14863 .next
14864 &`no_compression`&
14865 .next
14866 &`no_session_resumption_on_renegotiation`&
14867 .next
14868 &`no_sslv2`&
14869 .next
14870 &`no_sslv3`&
14871 .next
14872 &`no_ticket`&
14873 .next
14874 &`no_tlsv1`&
14875 .next
14876 &`no_tlsv1_1`&
14877 .next
14878 &`no_tlsv1_2`&
14879 .next
14880 .new
14881 &`safari_ecdhe_ecdsa_bug`&
14882 .wen
14883 .next
14884 &`single_dh_use`&
14885 .next
14886 &`single_ecdh_use`&
14887 .next
14888 &`ssleay_080_client_dh_bug`&
14889 .next
14890 &`sslref2_reuse_cert_type_bug`&
14891 .next
14892 &`tls_block_padding_bug`&
14893 .next
14894 &`tls_d5_bug`&
14895 .next
14896 &`tls_rollback_bug`&
14897 .endlist
14898
14899 .new
14900 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
14901 all clients connecting using the MacOS SecureTransport TLS facility prior
14902 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
14903 to negotiate TLS then this option value might help, provided that your OpenSSL
14904 release is new enough to contain this work-around.  This may be a situation
14905 where you have to upgrade OpenSSL to get buggy clients working.
14906 .wen
14907
14908
14909 .option oracle_servers main "string list" unset
14910 .cindex "Oracle" "server list"
14911 This option provides a list of Oracle servers and associated connection data,
14912 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14913 The option is available only if Exim has been built with Oracle support.
14914
14915
14916 .option percent_hack_domains main "domain list&!!" unset
14917 .cindex "&""percent hack""&"
14918 .cindex "source routing" "in email address"
14919 .cindex "address" "source-routed"
14920 The &"percent hack"& is the convention whereby a local part containing a
14921 percent sign is re-interpreted as a new email address, with the percent
14922 replaced by @. This is sometimes called &"source routing"&, though that term is
14923 also applied to RFC 2822 addresses that begin with an @ character. If this
14924 option is set, Exim implements the percent facility for those domains listed,
14925 but no others. This happens before an incoming SMTP address is tested against
14926 an ACL.
14927
14928 &*Warning*&: The &"percent hack"& has often been abused by people who are
14929 trying to get round relaying restrictions. For this reason, it is best avoided
14930 if at all possible. Unfortunately, a number of less security-conscious MTAs
14931 implement it unconditionally. If you are running Exim on a gateway host, and
14932 routing mail through to internal MTAs without processing the local parts, it is
14933 a good idea to reject recipient addresses with percent characters in their
14934 local parts. Exim's default configuration does this.
14935
14936
14937 .option perl_at_start main boolean false
14938 This option is available only when Exim is built with an embedded Perl
14939 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14940
14941
14942 .option perl_startup main string unset
14943 This option is available only when Exim is built with an embedded Perl
14944 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14945
14946
14947 .option pgsql_servers main "string list" unset
14948 .cindex "PostgreSQL lookup type" "server list"
14949 This option provides a list of PostgreSQL servers and associated connection
14950 data, to be used in conjunction with &(pgsql)& lookups (see section
14951 &<<SECID72>>&). The option is available only if Exim has been built with
14952 PostgreSQL support.
14953
14954
14955 .option pid_file_path main string&!! "set at compile time"
14956 .cindex "daemon" "pid file path"
14957 .cindex "pid file, path for"
14958 This option sets the name of the file to which the Exim daemon writes its
14959 process id. The string is expanded, so it can contain, for example, references
14960 to the host name:
14961 .code
14962 pid_file_path = /var/log/$primary_hostname/exim.pid
14963 .endd
14964 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14965 spool directory.
14966 The value set by the option can be overridden by the &%-oP%& command line
14967 option. A pid file is not written if a &"non-standard"& daemon is run by means
14968 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14969
14970
14971 .option pipelining_advertise_hosts main "host list&!!" *
14972 .cindex "PIPELINING" "suppressing advertising"
14973 This option can be used to suppress the advertisement of the SMTP
14974 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14975 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14976 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14977 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14978 that clients will use it; &"out of order"& commands that are &"expected"& do
14979 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14980
14981
14982 .option preserve_message_logs main boolean false
14983 .cindex "message logs" "preserving"
14984 If this option is set, message log files are not deleted when messages are
14985 completed. Instead, they are moved to a sub-directory of the spool directory
14986 called &_msglog.OLD_&, where they remain available for statistical or debugging
14987 purposes. This is a dangerous option to set on systems with any appreciable
14988 volume of mail. Use with care!
14989
14990
14991 .option primary_hostname main string "see below"
14992 .cindex "name" "of local host"
14993 .cindex "host" "name of local"
14994 .cindex "local host" "name of"
14995 .vindex "&$primary_hostname$&"
14996 This specifies the name of the current host. It is used in the default EHLO or
14997 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14998 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14999 The value is also used by default in some SMTP response messages from an Exim
15000 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15001
15002 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15003 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15004 contains only one component, Exim passes it to &[gethostbyname()]& (or
15005 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15006 version. The variable &$primary_hostname$& contains the host name, whether set
15007 explicitly by this option, or defaulted.
15008
15009
15010 .option print_topbitchars main boolean false
15011 .cindex "printing characters"
15012 .cindex "8-bit characters"
15013 By default, Exim considers only those characters whose codes lie in the range
15014 32&--126 to be printing characters. In a number of circumstances (for example,
15015 when writing log entries) non-printing characters are converted into escape
15016 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15017 is set, code values of 128 and above are also considered to be printing
15018 characters.
15019
15020 This option also affects the header syntax checks performed by the
15021 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15022 the user's full name when constructing From: and Sender: addresses (as
15023 described in section &<<SECTconstr>>&). Setting this option can cause
15024 Exim to generate eight bit message headers that do not conform to the
15025 standards.
15026
15027
15028 .option process_log_path main string unset
15029 .cindex "process log path"
15030 .cindex "log" "process log"
15031 .cindex "&'exiwhat'&"
15032 This option sets the name of the file to which an Exim process writes its
15033 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15034 utility script. If this option is unset, the file called &_exim-process.info_&
15035 in Exim's spool directory is used. The ability to specify the name explicitly
15036 can be useful in environments where two different Exims are running, using
15037 different spool directories.
15038
15039
15040 .option prod_requires_admin main boolean true
15041 .oindex "&%-M%&"
15042 .oindex "&%-R%&"
15043 .oindex "&%-q%&"
15044 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15045 admin user unless &%prod_requires_admin%& is set false. See also
15046 &%queue_list_requires_admin%&.
15047
15048
15049 .option qualify_domain main string "see below"
15050 .cindex "domain" "for qualifying addresses"
15051 .cindex "address" "qualification"
15052 This option specifies the domain name that is added to any envelope sender
15053 addresses that do not have a domain qualification. It also applies to
15054 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15055 are accepted by default only for locally-generated messages. Qualification is
15056 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15057 locally-generated messages, unless the &%-bnq%& command line option is used.
15058
15059 Messages from external sources must always contain fully qualified addresses,
15060 unless the sending host matches &%sender_unqualified_hosts%& or
15061 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15062 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15063 necessary. Internally, Exim always works with fully qualified envelope
15064 addresses. If &%qualify_domain%& is not set, it defaults to the
15065 &%primary_hostname%& value.
15066
15067
15068 .option qualify_recipient main string "see below"
15069 This option allows you to specify a different domain for qualifying recipient
15070 addresses to the one that is used for senders. See &%qualify_domain%& above.
15071
15072
15073
15074 .option queue_domains main "domain list&!!" unset
15075 .cindex "domain" "specifying non-immediate delivery"
15076 .cindex "queueing incoming messages"
15077 .cindex "message" "queueing certain domains"
15078 This option lists domains for which immediate delivery is not required.
15079 A delivery process is started whenever a message is received, but only those
15080 domains that do not match are processed. All other deliveries wait until the
15081 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15082
15083
15084 .option queue_list_requires_admin main boolean true
15085 .oindex "&%-bp%&"
15086 The &%-bp%& command-line option, which lists the messages that are on the
15087 queue, requires the caller to be an admin user unless
15088 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15089
15090
15091 .option queue_only main boolean false
15092 .cindex "queueing incoming messages"
15093 .cindex "message" "queueing unconditionally"
15094 If &%queue_only%& is set, a delivery process is not automatically started
15095 whenever a message is received. Instead, the message waits on the queue for the
15096 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15097 delivered immediately when certain conditions (such as heavy load) occur.
15098
15099 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15100 and &%-odi%& command line options override &%queue_only%& unless
15101 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15102 &%queue_only_load%&, and &%smtp_accept_queue%&.
15103
15104
15105 .option queue_only_file main string unset
15106 .cindex "queueing incoming messages"
15107 .cindex "message" "queueing by file existence"
15108 This option can be set to a colon-separated list of absolute path names, each
15109 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15110 it tests for the existence of each listed path using a call to &[stat()]&. For
15111 each path that exists, the corresponding queueing option is set.
15112 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15113 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15114 .code
15115 queue_only_file = smtp/some/file
15116 .endd
15117 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15118 &_/some/file_& exists.
15119
15120
15121 .option queue_only_load main fixed-point unset
15122 .cindex "load average"
15123 .cindex "queueing incoming messages"
15124 .cindex "message" "queueing by load"
15125 If the system load average is higher than this value, incoming messages from
15126 all sources are queued, and no automatic deliveries are started. If this
15127 happens during local or remote SMTP input, all subsequent messages received on
15128 the same SMTP connection are queued by default, whatever happens to the load in
15129 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15130 false.
15131
15132 Deliveries will subsequently be performed by queue runner processes. This
15133 option has no effect on ancient operating systems on which Exim cannot
15134 determine the load average. See also &%deliver_queue_load_max%& and
15135 &%smtp_load_reserve%&.
15136
15137
15138 .option queue_only_load_latch main boolean true
15139 .cindex "load average" "re-evaluating per message"
15140 When this option is true (the default), once one message has been queued
15141 because the load average is higher than the value set by &%queue_only_load%&,
15142 all subsequent messages received on the same SMTP connection are also queued.
15143 This is a deliberate choice; even though the load average may fall below the
15144 threshold, it doesn't seem right to deliver later messages on the same
15145 connection when not delivering earlier ones. However, there are special
15146 circumstances such as very long-lived connections from scanning appliances
15147 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15148 should be set false. This causes the value of the load average to be
15149 re-evaluated for each message.
15150
15151
15152 .option queue_only_override main boolean true
15153 .cindex "queueing incoming messages"
15154 When this option is true, the &%-od%&&'x'& command line options override the
15155 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15156 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15157 to override; they are accepted, but ignored.
15158
15159
15160 .option queue_run_in_order main boolean false
15161 .cindex "queue runner" "processing messages in order"
15162 If this option is set, queue runs happen in order of message arrival instead of
15163 in an arbitrary order. For this to happen, a complete list of the entire queue
15164 must be set up before the deliveries start. When the queue is all held in a
15165 single directory (the default), a single list is created for both the ordered
15166 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15167 single list is not created when &%queue_run_in_order%& is false. In this case,
15168 the sub-directories are processed one at a time (in a random order), and this
15169 avoids setting up one huge list for the whole queue. Thus, setting
15170 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15171 when the queue is large, because of the extra work in setting up the single,
15172 large list. In most situations, &%queue_run_in_order%& should not be set.
15173
15174
15175
15176 .option queue_run_max main integer 5
15177 .cindex "queue runner" "maximum number of"
15178 This controls the maximum number of queue runner processes that an Exim daemon
15179 can run simultaneously. This does not mean that it starts them all at once,
15180 but rather that if the maximum number are still running when the time comes to
15181 start another one, it refrains from starting another one. This can happen with
15182 very large queues and/or very sluggish deliveries. This option does not,
15183 however, interlock with other processes, so additional queue runners can be
15184 started by other means, or by killing and restarting the daemon.
15185
15186 Setting this option to zero does not suppress queue runs; rather, it disables
15187 the limit, allowing any number of simultaneous queue runner processes to be
15188 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15189 the daemon's command line.
15190
15191 .option queue_smtp_domains main "domain list&!!" unset
15192 .cindex "queueing incoming messages"
15193 .cindex "message" "queueing remote deliveries"
15194 When this option is set, a delivery process is started whenever a message is
15195 received, routing is performed, and local deliveries take place.
15196 However, if any SMTP deliveries are required for domains that match
15197 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15198 message waits on the queue for the next queue run. Since routing of the message
15199 has taken place, Exim knows to which remote hosts it must be delivered, and so
15200 when the queue run happens, multiple messages for the same host are delivered
15201 over a single SMTP connection. The &%-odqs%& command line option causes all
15202 SMTP deliveries to be queued in this way, and is equivalent to setting
15203 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15204 &%queue_domains%&.
15205
15206
15207 .option receive_timeout main time 0s
15208 .cindex "timeout" "for non-SMTP input"
15209 This option sets the timeout for accepting a non-SMTP message, that is, the
15210 maximum time that Exim waits when reading a message on the standard input. If
15211 the value is zero, it will wait for ever. This setting is overridden by the
15212 &%-or%& command line option. The timeout for incoming SMTP messages is
15213 controlled by &%smtp_receive_timeout%&.
15214
15215 .option received_header_text main string&!! "see below"
15216 .cindex "customizing" "&'Received:'& header"
15217 .cindex "&'Received:'& header line" "customizing"
15218 This string defines the contents of the &'Received:'& message header that is
15219 added to each message, except for the timestamp, which is automatically added
15220 on at the end (preceded by a semicolon). The string is expanded each time it is
15221 used. If the expansion yields an empty string, no &'Received:'& header line is
15222 added to the message. Otherwise, the string should start with the text
15223 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15224 header lines. The default setting is:
15225
15226 .code
15227 received_header_text = Received: \
15228   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15229   {${if def:sender_ident \
15230   {from ${quote_local_part:$sender_ident} }}\
15231   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15232   by $primary_hostname \
15233   ${if def:received_protocol {with $received_protocol}} \
15234   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15235   (Exim $version_number)\n\t\
15236   ${if def:sender_address \
15237   {(envelope-from <$sender_address>)\n\t}}\
15238   id $message_exim_id\
15239   ${if def:received_for {\n\tfor $received_for}}
15240 .endd
15241
15242 The reference to the TLS cipher is omitted when Exim is built without TLS
15243 support. The use of conditional expansions ensures that this works for both
15244 locally generated messages and messages received from remote hosts, giving
15245 header lines such as the following:
15246 .code
15247 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15248 by marley.carol.example with esmtp (Exim 4.00)
15249 (envelope-from <bob@carol.example>)
15250 id 16IOWa-00019l-00
15251 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15252 Received: by scrooge.carol.example with local (Exim 4.00)
15253 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15254 .endd
15255 Until the body of the message has been received, the timestamp is the time when
15256 the message started to be received. Once the body has arrived, and all policy
15257 checks have taken place, the timestamp is updated to the time at which the
15258 message was accepted.
15259
15260
15261 .option received_headers_max main integer 30
15262 .cindex "loop" "prevention"
15263 .cindex "mail loop prevention"
15264 .cindex "&'Received:'& header line" "counting"
15265 When a message is to be delivered, the number of &'Received:'& headers is
15266 counted, and if it is greater than this parameter, a mail loop is assumed to
15267 have occurred, the delivery is abandoned, and an error message is generated.
15268 This applies to both local and remote deliveries.
15269
15270
15271 .option recipient_unqualified_hosts main "host list&!!" unset
15272 .cindex "unqualified addresses"
15273 .cindex "host" "unqualified addresses from"
15274 This option lists those hosts from which Exim is prepared to accept unqualified
15275 recipient addresses in message envelopes. The addresses are made fully
15276 qualified by the addition of the &%qualify_recipient%& value. This option also
15277 affects message header lines. Exim does not reject unqualified recipient
15278 addresses in headers, but it qualifies them only if the message came from a
15279 host that matches &%recipient_unqualified_hosts%&,
15280 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15281 option was not set.
15282
15283
15284 .option recipients_max main integer 0
15285 .cindex "limit" "number of recipients"
15286 .cindex "recipient" "maximum number"
15287 If this option is set greater than zero, it specifies the maximum number of
15288 original recipients for any message. Additional recipients that are generated
15289 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15290 all recipients over the limit; earlier recipients are delivered as normal.
15291 Non-SMTP messages with too many recipients are failed, and no deliveries are
15292 done.
15293
15294 .cindex "RCPT" "maximum number of incoming"
15295 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15296 RCPT commands in a single message.
15297
15298
15299 .option recipients_max_reject main boolean false
15300 If this option is set true, Exim rejects SMTP messages containing too many
15301 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15302 error to the eventual DATA command. Otherwise (the default) it gives a 452
15303 error to the surplus RCPT commands and accepts the message on behalf of the
15304 initial set of recipients. The remote server should then re-send the message
15305 for the remaining recipients at a later time.
15306
15307
15308 .option remote_max_parallel main integer 2
15309 .cindex "delivery" "parallelism for remote"
15310 This option controls parallel delivery of one message to a number of remote
15311 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15312 does all the remote deliveries for a message one by one. Otherwise, if a single
15313 message has to be delivered to more than one remote host, or if several copies
15314 have to be sent to the same remote host, up to &%remote_max_parallel%&
15315 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15316 deliveries are required, the maximum number of processes are started, and as
15317 each one finishes, another is begun. The order of starting processes is the
15318 same as if sequential delivery were being done, and can be controlled by the
15319 &%remote_sort_domains%& option. If parallel delivery takes place while running
15320 with debugging turned on, the debugging output from each delivery process is
15321 tagged with its process id.
15322
15323 This option controls only the maximum number of parallel deliveries for one
15324 message in one Exim delivery process. Because Exim has no central queue
15325 manager, there is no way of controlling the total number of simultaneous
15326 deliveries if the configuration allows a delivery attempt as soon as a message
15327 is received.
15328
15329 .cindex "number of deliveries"
15330 .cindex "delivery" "maximum number of"
15331 If you want to control the total number of deliveries on the system, you
15332 need to set the &%queue_only%& option. This ensures that all incoming messages
15333 are added to the queue without starting a delivery process. Then set up an Exim
15334 daemon to start queue runner processes at appropriate intervals (probably
15335 fairly often, for example, every minute), and limit the total number of queue
15336 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15337 delivers only one message at a time, the maximum number of deliveries that can
15338 then take place at once is &%queue_run_max%& multiplied by
15339 &%remote_max_parallel%&.
15340
15341 If it is purely remote deliveries you want to control, use
15342 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15343 doing the SMTP routing before queueing, so that several messages for the same
15344 host will eventually get delivered down the same connection.
15345
15346
15347 .option remote_sort_domains main "domain list&!!" unset
15348 .cindex "sorting remote deliveries"
15349 .cindex "delivery" "sorting remote"
15350 When there are a number of remote deliveries for a message, they are sorted by
15351 domain into the order given by this list. For example,
15352 .code
15353 remote_sort_domains = *.cam.ac.uk:*.uk
15354 .endd
15355 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15356 then to those in the &%uk%& domain, then to any others.
15357
15358
15359 .option retry_data_expire main time 7d
15360 .cindex "hints database" "data expiry"
15361 This option sets a &"use before"& time on retry information in Exim's hints
15362 database. Any older retry data is ignored. This means that, for example, once a
15363 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15364 past failures.
15365
15366
15367 .option retry_interval_max main time 24h
15368 .cindex "retry" "limit on interval"
15369 .cindex "limit" "on retry interval"
15370 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15371 intervals between delivery attempts for messages that cannot be delivered
15372 straight away. This option sets an overall limit to the length of time between
15373 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15374 the default value.
15375
15376
15377 .option return_path_remove main boolean true
15378 .cindex "&'Return-path:'& header line" "removing"
15379 RFC 2821, section 4.4, states that an SMTP server must insert a
15380 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15381 The &'Return-path:'& header preserves the sender address as received in the
15382 MAIL command. This description implies that this header should not be present
15383 in an incoming message. If &%return_path_remove%& is true, any existing
15384 &'Return-path:'& headers are removed from messages at the time they are
15385 received. Exim's transports have options for adding &'Return-path:'& headers at
15386 the time of delivery. They are normally used only for final local deliveries.
15387
15388
15389 .option return_size_limit main integer 100K
15390 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15391
15392
15393 .option rfc1413_hosts main "host list&!!" *
15394 .cindex "RFC 1413"
15395 .cindex "host" "for RFC 1413 calls"
15396 RFC 1413 identification calls are made to any client host which matches an item
15397 in the list.
15398
15399 .option rfc1413_query_timeout main time 5s
15400 .cindex "RFC 1413" "query timeout"
15401 .cindex "timeout" "for RFC 1413 call"
15402 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15403 no RFC 1413 calls are ever made.
15404
15405
15406 .option sender_unqualified_hosts main "host list&!!" unset
15407 .cindex "unqualified addresses"
15408 .cindex "host" "unqualified addresses from"
15409 This option lists those hosts from which Exim is prepared to accept unqualified
15410 sender addresses. The addresses are made fully qualified by the addition of
15411 &%qualify_domain%&. This option also affects message header lines. Exim does
15412 not reject unqualified addresses in headers that contain sender addresses, but
15413 it qualifies them only if the message came from a host that matches
15414 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15415 using TCP/IP), and the &%-bnq%& option was not set.
15416
15417 .option set_environment main "string list" empty
15418 .cindex "environment"
15419 This option allows to set individual environment variables that the
15420 currently linked libraries and programs in child processes use. The
15421 default list is empty,
15422
15423
15424 .option smtp_accept_keepalive main boolean true
15425 .cindex "keepalive" "on incoming connection"
15426 This option controls the setting of the SO_KEEPALIVE option on incoming
15427 TCP/IP socket connections. When set, it causes the kernel to probe idle
15428 connections periodically, by sending packets with &"old"& sequence numbers. The
15429 other end of the connection should send an acknowledgment if the connection is
15430 still okay or a reset if the connection has been aborted. The reason for doing
15431 this is that it has the beneficial effect of freeing up certain types of
15432 connection that can get stuck when the remote host is disconnected without
15433 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15434 hours to detect unreachable hosts.
15435
15436
15437
15438 .option smtp_accept_max main integer 20
15439 .cindex "limit" "incoming SMTP connections"
15440 .cindex "SMTP" "incoming connection count"
15441 .cindex "inetd"
15442 This option specifies the maximum number of simultaneous incoming SMTP calls
15443 that Exim will accept. It applies only to the listening daemon; there is no
15444 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15445 value is set to zero, no limit is applied. However, it is required to be
15446 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15447 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15448
15449 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15450 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15451 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15452 and &%smtp_load_reserve%& are then checked before accepting the connection.
15453
15454
15455 .option smtp_accept_max_nonmail main integer 10
15456 .cindex "limit" "non-mail SMTP commands"
15457 .cindex "SMTP" "limiting non-mail commands"
15458 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15459 the connection if there are too many. This option defines &"too many"&. The
15460 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15461 client looping sending EHLO, for example. The check is applied only if the
15462 client host matches &%smtp_accept_max_nonmail_hosts%&.
15463
15464 When a new message is expected, one occurrence of RSET is not counted. This
15465 allows a client to send one RSET between messages (this is not necessary,
15466 but some clients do it). Exim also allows one uncounted occurrence of HELO
15467 or EHLO, and one occurrence of STARTTLS between messages. After
15468 starting up a TLS session, another EHLO is expected, and so it too is not
15469 counted. The first occurrence of AUTH in a connection, or immediately
15470 following STARTTLS is not counted. Otherwise, all commands other than
15471 MAIL, RCPT, DATA, and QUIT are counted.
15472
15473
15474 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15475 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15476 check by setting this option. The default value makes it apply to all hosts. By
15477 changing the value, you can exclude any badly-behaved hosts that you have to
15478 live with.
15479
15480
15481 . Allow this long option name to split; give it unsplit as a fifth argument
15482 . for the automatic .oindex that is generated by .option.
15483 . We insert " &~&~" which is both pretty nasty visually and results in
15484 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15485 . zero-width-space, which would be nicer visually and results in (at least)
15486 . html that Firefox will split on when it's forced to reflow (rather than
15487 . inserting a horizontal scrollbar).  However, the text is still not
15488 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15489 . the option name to split.
15490
15491 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15492          smtp_accept_max_per_connection
15493 .cindex "SMTP" "limiting incoming message count"
15494 .cindex "limit" "messages per SMTP connection"
15495 The value of this option limits the number of MAIL commands that Exim is
15496 prepared to accept over a single SMTP connection, whether or not each command
15497 results in the transfer of a message. After the limit is reached, a 421
15498 response is given to subsequent MAIL commands. This limit is a safety
15499 precaution against a client that goes mad (incidents of this type have been
15500 seen).
15501
15502
15503 .option smtp_accept_max_per_host main string&!! unset
15504 .cindex "limit" "SMTP connections from one host"
15505 .cindex "host" "limiting SMTP connections from"
15506 This option restricts the number of simultaneous IP connections from a single
15507 host (strictly, from a single IP address) to the Exim daemon. The option is
15508 expanded, to enable different limits to be applied to different hosts by
15509 reference to &$sender_host_address$&. Once the limit is reached, additional
15510 connection attempts from the same host are rejected with error code 421. This
15511 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15512 of zero imposes no limit. If this option is set greater than zero, it is
15513 required that &%smtp_accept_max%& be non-zero.
15514
15515 &*Warning*&: When setting this option you should not use any expansion
15516 constructions that take an appreciable amount of time. The expansion and test
15517 happen in the main daemon loop, in order to reject additional connections
15518 without forking additional processes (otherwise a denial-of-service attack
15519 could cause a vast number or processes to be created). While the daemon is
15520 doing this processing, it cannot accept any other incoming connections.
15521
15522
15523
15524 .option smtp_accept_queue main integer 0
15525 .cindex "SMTP" "incoming connection count"
15526 .cindex "queueing incoming messages"
15527 .cindex "message" "queueing by SMTP connection count"
15528 If the number of simultaneous incoming SMTP connections being handled via the
15529 listening daemon exceeds this value, messages received by SMTP are just placed
15530 on the queue; no delivery processes are started automatically. The count is
15531 fixed at the start of an SMTP connection. It cannot be updated in the
15532 subprocess that receives messages, and so the queueing or not queueing applies
15533 to all messages received in the same connection.
15534
15535 A value of zero implies no limit, and clearly any non-zero value is useful only
15536 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15537 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15538 various &%-od%&&'x'& command line options.
15539
15540
15541 . See the comment on smtp_accept_max_per_connection
15542
15543 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15544          smtp_accept_queue_per_connection
15545 .cindex "queueing incoming messages"
15546 .cindex "message" "queueing by message count"
15547 This option limits the number of delivery processes that Exim starts
15548 automatically when receiving messages via SMTP, whether via the daemon or by
15549 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15550 and the number of messages received in a single SMTP session exceeds this
15551 number, subsequent messages are placed on the queue, but no delivery processes
15552 are started. This helps to limit the number of Exim processes when a server
15553 restarts after downtime and there is a lot of mail waiting for it on other
15554 systems. On large systems, the default should probably be increased, and on
15555 dial-in client systems it should probably be set to zero (that is, disabled).
15556
15557
15558 .option smtp_accept_reserve main integer 0
15559 .cindex "SMTP" "incoming call count"
15560 .cindex "host" "reserved"
15561 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15562 number of SMTP connections that are reserved for connections from the hosts
15563 that are specified in &%smtp_reserve_hosts%&. The value set in
15564 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15565 restricted to this number of connections; the option specifies a minimum number
15566 of connection slots for them, not a maximum. It is a guarantee that this group
15567 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15568 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15569 individual host.
15570
15571 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15572 set to 5, once there are 45 active connections (from any hosts), new
15573 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15574 provided the other criteria for acceptance are met.
15575
15576
15577 .option smtp_active_hostname main string&!! unset
15578 .cindex "host" "name in SMTP responses"
15579 .cindex "SMTP" "host name in responses"
15580 .vindex "&$primary_hostname$&"
15581 This option is provided for multi-homed servers that want to masquerade as
15582 several different hosts. At the start of an incoming SMTP connection, its value
15583 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15584 responses. For example, it is used as domain name in the response to an
15585 incoming HELO or EHLO command.
15586
15587 .vindex "&$smtp_active_hostname$&"
15588 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15589 is saved with any messages that are received. It is therefore available for use
15590 in routers and transports when the message is later delivered.
15591
15592 If this option is unset, or if its expansion is forced to fail, or if the
15593 expansion results in an empty string, the value of &$primary_hostname$& is
15594 used. Other expansion failures cause a message to be written to the main and
15595 panic logs, and the SMTP command receives a temporary error. Typically, the
15596 value of &%smtp_active_hostname%& depends on the incoming interface address.
15597 For example:
15598 .code
15599 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15600   {cox.mydomain}{box.mydomain}}
15601 .endd
15602
15603 Although &$smtp_active_hostname$& is primarily concerned with incoming
15604 messages, it is also used as the default for HELO commands in callout
15605 verification if there is no remote transport from which to obtain a
15606 &%helo_data%& value.
15607
15608 .option smtp_banner main string&!! "see below"
15609 .cindex "SMTP" "welcome banner"
15610 .cindex "banner for SMTP"
15611 .cindex "welcome banner for SMTP"
15612 .cindex "customizing" "SMTP banner"
15613 This string, which is expanded every time it is used, is output as the initial
15614 positive response to an SMTP connection. The default setting is:
15615 .code
15616 smtp_banner = $smtp_active_hostname ESMTP Exim \
15617   $version_number $tod_full
15618 .endd
15619 Failure to expand the string causes a panic error. If you want to create a
15620 multiline response to the initial SMTP connection, use &"\n"& in the string at
15621 appropriate points, but not at the end. Note that the 220 code is not included
15622 in this string. Exim adds it automatically (several times in the case of a
15623 multiline response).
15624
15625
15626 .option smtp_check_spool_space main boolean true
15627 .cindex "checking disk space"
15628 .cindex "disk space, checking"
15629 .cindex "spool directory" "checking space"
15630 When this option is set, if an incoming SMTP session encounters the SIZE
15631 option on a MAIL command, it checks that there is enough space in the
15632 spool directory's partition to accept a message of that size, while still
15633 leaving free the amount specified by &%check_spool_space%& (even if that value
15634 is zero). If there isn't enough space, a temporary error code is returned.
15635
15636
15637 .option smtp_connect_backlog main integer 20
15638 .cindex "connection backlog"
15639 .cindex "SMTP" "connection backlog"
15640 .cindex "backlog of connections"
15641 This option specifies a maximum number of waiting SMTP connections. Exim passes
15642 this value to the TCP/IP system when it sets up its listener. Once this number
15643 of connections are waiting for the daemon's attention, subsequent connection
15644 attempts are refused at the TCP/IP level. At least, that is what the manuals
15645 say; in some circumstances such connection attempts have been observed to time
15646 out instead. For large systems it is probably a good idea to increase the
15647 value (to 50, say). It also gives some protection against denial-of-service
15648 attacks by SYN flooding.
15649
15650
15651 .option smtp_enforce_sync main boolean true
15652 .cindex "SMTP" "synchronization checking"
15653 .cindex "synchronization checking in SMTP"
15654 The SMTP protocol specification requires the client to wait for a response from
15655 the server at certain points in the dialogue. Without PIPELINING these
15656 synchronization points are after every command; with PIPELINING they are
15657 fewer, but they still exist.
15658
15659 Some spamming sites send out a complete set of SMTP commands without waiting
15660 for any response. Exim protects against this by rejecting a message if the
15661 client has sent further input when it should not have. The error response &"554
15662 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15663 for this error cannot be perfect because of transmission delays (unexpected
15664 input may be on its way but not yet received when Exim checks). However, it
15665 does detect many instances.
15666
15667 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15668 If you want to disable the check selectively (for example, only for certain
15669 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15670 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15671
15672
15673
15674 .option smtp_etrn_command main string&!! unset
15675 .cindex "ETRN" "command to be run"
15676 .vindex "&$domain$&"
15677 If this option is set, the given command is run whenever an SMTP ETRN
15678 command is received from a host that is permitted to issue such commands (see
15679 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15680 are independently expanded. The expansion variable &$domain$& is set to the
15681 argument of the ETRN command, and no syntax checking is done on it. For
15682 example:
15683 .code
15684 smtp_etrn_command = /etc/etrn_command $domain \
15685                     $sender_host_address
15686 .endd
15687 A new process is created to run the command, but Exim does not wait for it to
15688 complete. Consequently, its status cannot be checked. If the command cannot be
15689 run, a line is written to the panic log, but the ETRN caller still receives
15690 a 250 success response. Exim is normally running under its own uid when
15691 receiving SMTP, so it is not possible for it to change the uid before running
15692 the command.
15693
15694
15695 .option smtp_etrn_serialize main boolean true
15696 .cindex "ETRN" "serializing"
15697 When this option is set, it prevents the simultaneous execution of more than
15698 one identical command as a result of ETRN in an SMTP connection. See
15699 section &<<SECTETRN>>& for details.
15700
15701
15702 .option smtp_load_reserve main fixed-point unset
15703 .cindex "load average"
15704 If the system load average ever gets higher than this, incoming SMTP calls are
15705 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15706 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15707 the load is over the limit. The option has no effect on ancient operating
15708 systems on which Exim cannot determine the load average. See also
15709 &%deliver_queue_load_max%& and &%queue_only_load%&.
15710
15711
15712
15713 .option smtp_max_synprot_errors main integer 3
15714 .cindex "SMTP" "limiting syntax and protocol errors"
15715 .cindex "limit" "SMTP syntax and protocol errors"
15716 Exim rejects SMTP commands that contain syntax or protocol errors. In
15717 particular, a syntactically invalid email address, as in this command:
15718 .code
15719 RCPT TO:<abc xyz@a.b.c>
15720 .endd
15721 causes immediate rejection of the command, before any other tests are done.
15722 (The ACL cannot be run if there is no valid address to set up for it.) An
15723 example of a protocol error is receiving RCPT before MAIL. If there are
15724 too many syntax or protocol errors in one SMTP session, the connection is
15725 dropped. The limit is set by this option.
15726
15727 .cindex "PIPELINING" "expected errors"
15728 When the PIPELINING extension to SMTP is in use, some protocol errors are
15729 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15730 Exim assumes that PIPELINING will be used if it advertises it (see
15731 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15732 not count towards the limit.
15733
15734
15735
15736 .option smtp_max_unknown_commands main integer 3
15737 .cindex "SMTP" "limiting unknown commands"
15738 .cindex "limit" "unknown SMTP commands"
15739 If there are too many unrecognized commands in an incoming SMTP session, an
15740 Exim server drops the connection. This is a defence against some kinds of abuse
15741 that subvert web
15742 clients
15743 into making connections to SMTP ports; in these circumstances, a number of
15744 non-SMTP command lines are sent first.
15745
15746
15747
15748 .option smtp_ratelimit_hosts main "host list&!!" unset
15749 .cindex "SMTP" "rate limiting"
15750 .cindex "limit" "rate of message arrival"
15751 .cindex "RCPT" "rate limiting"
15752 Some sites find it helpful to be able to limit the rate at which certain hosts
15753 can send them messages, and the rate at which an individual message can specify
15754 recipients.
15755
15756 Exim has two rate-limiting facilities. This section describes the older
15757 facility, which can limit rates within a single connection. The newer
15758 &%ratelimit%& ACL condition can limit rates across all connections. See section
15759 &<<SECTratelimiting>>& for details of the newer facility.
15760
15761 When a host matches &%smtp_ratelimit_hosts%&, the values of
15762 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15763 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15764 respectively. Each option, if set, must contain a set of four comma-separated
15765 values:
15766
15767 .ilist
15768 A threshold, before which there is no rate limiting.
15769 .next
15770 An initial time delay. Unlike other times in Exim, numbers with decimal
15771 fractional parts are allowed here.
15772 .next
15773 A factor by which to increase the delay each time.
15774 .next
15775 A maximum value for the delay. This should normally be less than 5 minutes,
15776 because after that time, the client is liable to timeout the SMTP command.
15777 .endlist
15778
15779 For example, these settings have been used successfully at the site which
15780 first suggested this feature, for controlling mail from their customers:
15781 .code
15782 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15783 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15784 .endd
15785 The first setting specifies delays that are applied to MAIL commands after
15786 two have been received over a single connection. The initial delay is 0.5
15787 seconds, increasing by a factor of 1.05 each time. The second setting applies
15788 delays to RCPT commands when more than four occur in a single message.
15789
15790
15791 .option smtp_ratelimit_mail main string unset
15792 See &%smtp_ratelimit_hosts%& above.
15793
15794
15795 .option smtp_ratelimit_rcpt main string unset
15796 See &%smtp_ratelimit_hosts%& above.
15797
15798
15799 .option smtp_receive_timeout main time 5m
15800 .cindex "timeout" "for SMTP input"
15801 .cindex "SMTP" "input timeout"
15802 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15803 input, including batch SMTP. If a line of input (either an SMTP command or a
15804 data line) is not received within this time, the SMTP connection is dropped and
15805 the message is abandoned.
15806 A line is written to the log containing one of the following messages:
15807 .code
15808 SMTP command timeout on connection from...
15809 SMTP data timeout on connection from...
15810 .endd
15811 The former means that Exim was expecting to read an SMTP command; the latter
15812 means that it was in the DATA phase, reading the contents of a message.
15813
15814
15815 .oindex "&%-os%&"
15816 The value set by this option can be overridden by the
15817 &%-os%& command-line option. A setting of zero time disables the timeout, but
15818 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15819 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15820 timeout is controlled by &%receive_timeout%& and &%-or%&.
15821
15822
15823 .option smtp_reserve_hosts main "host list&!!" unset
15824 This option defines hosts for which SMTP connections are reserved; see
15825 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15826
15827
15828 .option smtp_return_error_details main boolean false
15829 .cindex "SMTP" "details policy failures"
15830 .cindex "policy control" "rejection, returning details"
15831 In the default state, Exim uses bland messages such as
15832 &"Administrative prohibition"& when it rejects SMTP commands for policy
15833 reasons. Many sysadmins like this because it gives away little information
15834 to spammers. However, some other sysadmins who are applying strict checking
15835 policies want to give out much fuller information about failures. Setting
15836 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15837 example, instead of &"Administrative prohibition"&, it might give:
15838 .code
15839 550-Rejected after DATA: '>' missing at end of address:
15840 550 failing address in "From" header is: <user@dom.ain
15841 .endd
15842
15843 .option spamd_address main string "see below"
15844 This option is available when Exim is compiled with the content-scanning
15845 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15846 The default value is
15847 .code
15848 127.0.0.1 783
15849 .endd
15850 See section &<<SECTscanspamass>>& for more details.
15851
15852
15853
15854 .option split_spool_directory main boolean false
15855 .cindex "multiple spool directories"
15856 .cindex "spool directory" "split"
15857 .cindex "directories, multiple"
15858 If this option is set, it causes Exim to split its input directory into 62
15859 subdirectories, each with a single alphanumeric character as its name. The
15860 sixth character of the message id is used to allocate messages to
15861 subdirectories; this is the least significant base-62 digit of the time of
15862 arrival of the message.
15863
15864 Splitting up the spool in this way may provide better performance on systems
15865 where there are long mail queues, by reducing the number of files in any one
15866 directory. The msglog directory is also split up in a similar way to the input
15867 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15868 are still placed in the single directory &_msglog.OLD_&.
15869
15870 It is not necessary to take any special action for existing messages when
15871 changing &%split_spool_directory%&. Exim notices messages that are in the
15872 &"wrong"& place, and continues to process them. If the option is turned off
15873 after a period of being on, the subdirectories will eventually empty and be
15874 automatically deleted.
15875
15876 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15877 changes. Instead of creating a list of all messages in the queue, and then
15878 trying to deliver each one in turn, it constructs a list of those in one
15879 sub-directory and tries to deliver them, before moving on to the next
15880 sub-directory. The sub-directories are processed in a random order. This
15881 spreads out the scanning of the input directories, and uses less memory. It is
15882 particularly beneficial when there are lots of messages on the queue. However,
15883 if &%queue_run_in_order%& is set, none of this new processing happens. The
15884 entire queue has to be scanned and sorted before any deliveries can start.
15885
15886
15887 .option spool_directory main string&!! "set at compile time"
15888 .cindex "spool directory" "path to"
15889 This defines the directory in which Exim keeps its spool, that is, the messages
15890 it is waiting to deliver. The default value is taken from the compile-time
15891 configuration setting, if there is one. If not, this option must be set. The
15892 string is expanded, so it can contain, for example, a reference to
15893 &$primary_hostname$&.
15894
15895 If the spool directory name is fixed on your installation, it is recommended
15896 that you set it at build time rather than from this option, particularly if the
15897 log files are being written to the spool directory (see &%log_file_path%&).
15898 Otherwise log files cannot be used for errors that are detected early on, such
15899 as failures in the configuration file.
15900
15901 By using this option to override the compiled-in path, it is possible to run
15902 tests of Exim without using the standard spool.
15903
15904 .option sqlite_lock_timeout main time 5s
15905 .cindex "sqlite lookup type" "lock timeout"
15906 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15907 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15908
15909 .option strict_acl_vars main boolean false
15910 .cindex "&ACL;" "variables, handling unset"
15911 This option controls what happens if a syntactically valid but undefined ACL
15912 variable is referenced. If it is false (the default), an empty string
15913 is substituted; if it is true, an error is generated. See section
15914 &<<SECTaclvariables>>& for details of ACL variables.
15915
15916 .option strip_excess_angle_brackets main boolean false
15917 .cindex "angle brackets, excess"
15918 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15919 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15920 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15921 passed on to another MTA, the excess angle brackets are not passed on. If this
15922 option is not set, multiple pairs of angle brackets cause a syntax error.
15923
15924
15925 .option strip_trailing_dot main boolean false
15926 .cindex "trailing dot on domain"
15927 .cindex "dot" "trailing on domain"
15928 If this option is set, a trailing dot at the end of a domain in an address is
15929 ignored. If this is in the envelope and the message is passed on to another
15930 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15931 domain causes a syntax error.
15932 However, addresses in header lines are checked only when an ACL requests header
15933 syntax checking.
15934
15935
15936 .option syslog_duplication main boolean true
15937 .cindex "syslog" "duplicate log lines; suppressing"
15938 When Exim is logging to syslog, it writes the log lines for its three
15939 separate logs at different syslog priorities so that they can in principle
15940 be separated on the logging hosts. Some installations do not require this
15941 separation, and in those cases, the duplication of certain log lines is a
15942 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15943 particular log line is written to syslog. For lines that normally go to
15944 both the main log and the reject log, the reject log version (possibly
15945 containing message header lines) is written, at LOG_NOTICE priority.
15946 Lines that normally go to both the main and the panic log are written at
15947 the LOG_ALERT priority.
15948
15949
15950 .option syslog_facility main string unset
15951 .cindex "syslog" "facility; setting"
15952 This option sets the syslog &"facility"& name, used when Exim is logging to
15953 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15954 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15955 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15956 details of Exim's logging.
15957
15958
15959
15960 .option syslog_processname main string &`exim`&
15961 .cindex "syslog" "process name; setting"
15962 This option sets the syslog &"ident"& name, used when Exim is logging to
15963 syslog. The value must be no longer than 32 characters. See chapter
15964 &<<CHAPlog>>& for details of Exim's logging.
15965
15966
15967
15968 .option syslog_timestamp main boolean true
15969 .cindex "syslog" "timestamps"
15970 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15971 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15972 details of Exim's logging.
15973
15974
15975 .option system_filter main string&!! unset
15976 .cindex "filter" "system filter"
15977 .cindex "system filter" "specifying"
15978 .cindex "Sieve filter" "not available for system filter"
15979 This option specifies an Exim filter file that is applied to all messages at
15980 the start of each delivery attempt, before any routing is done. System filters
15981 must be Exim filters; they cannot be Sieve filters. If the system filter
15982 generates any deliveries to files or pipes, or any new mail messages, the
15983 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15984 which transports are to be used. Details of this facility are given in chapter
15985 &<<CHAPsystemfilter>>&.
15986
15987
15988 .option system_filter_directory_transport main string&!! unset
15989 .vindex "&$address_file$&"
15990 This sets the name of the transport driver that is to be used when the
15991 &%save%& command in a system message filter specifies a path ending in &"/"&,
15992 implying delivery of each message into a separate file in some directory.
15993 During the delivery, the variable &$address_file$& contains the path name.
15994
15995
15996 .option system_filter_file_transport main string&!! unset
15997 .cindex "file" "transport for system filter"
15998 This sets the name of the transport driver that is to be used when the &%save%&
15999 command in a system message filter specifies a path not ending in &"/"&. During
16000 the delivery, the variable &$address_file$& contains the path name.
16001
16002 .option system_filter_group main string unset
16003 .cindex "gid (group id)" "system filter"
16004 This option is used only when &%system_filter_user%& is also set. It sets the
16005 gid under which the system filter is run, overriding any gid that is associated
16006 with the user. The value may be numerical or symbolic.
16007
16008 .option system_filter_pipe_transport main string&!! unset
16009 .cindex "&(pipe)& transport" "for system filter"
16010 .vindex "&$address_pipe$&"
16011 This specifies the transport driver that is to be used when a &%pipe%& command
16012 is used in a system filter. During the delivery, the variable &$address_pipe$&
16013 contains the pipe command.
16014
16015
16016 .option system_filter_reply_transport main string&!! unset
16017 .cindex "&(autoreply)& transport" "for system filter"
16018 This specifies the transport driver that is to be used when a &%mail%& command
16019 is used in a system filter.
16020
16021
16022 .option system_filter_user main string unset
16023 .cindex "uid (user id)" "system filter"
16024 If this option is set to root, the system filter is run in the main Exim
16025 delivery process, as root.  Otherwise, the system filter runs in a separate
16026 process, as the given user, defaulting to the Exim run-time user.
16027 Unless the string consists entirely of digits, it
16028 is looked up in the password data. Failure to find the named user causes a
16029 configuration error. The gid is either taken from the password data, or
16030 specified by &%system_filter_group%&. When the uid is specified numerically,
16031 &%system_filter_group%& is required to be set.
16032
16033 If the system filter generates any pipe, file, or reply deliveries, the uid
16034 under which the filter is run is used when transporting them, unless a
16035 transport option overrides.
16036
16037
16038 .option tcp_nodelay main boolean true
16039 .cindex "daemon" "TCP_NODELAY on sockets"
16040 .cindex "Nagle algorithm"
16041 .cindex "TCP_NODELAY on listening sockets"
16042 If this option is set false, it stops the Exim daemon setting the
16043 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16044 turns off the &"Nagle algorithm"&, which is a way of improving network
16045 performance in interactive (character-by-character) situations. Turning it off
16046 should improve Exim's performance a bit, so that is what happens by default.
16047 However, it appears that some broken clients cannot cope, and time out. Hence
16048 this option. It affects only those sockets that are set up for listening by the
16049 daemon. Sockets created by the smtp transport for delivering mail always set
16050 TCP_NODELAY.
16051
16052
16053 .option timeout_frozen_after main time 0s
16054 .cindex "frozen messages" "timing out"
16055 .cindex "timeout" "frozen messages"
16056 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16057 message of any kind that has been on the queue for longer than the given time
16058 is automatically cancelled at the next queue run. If the frozen message is a
16059 bounce message, it is just discarded; otherwise, a bounce is sent to the
16060 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16061 If you want to timeout frozen bounce messages earlier than other kinds of
16062 frozen message, see &%ignore_bounce_errors_after%&.
16063
16064 &*Note:*& the default value of zero means no timeouts; with this setting,
16065 frozen messages remain on the queue forever (except for any frozen bounce
16066 messages that are released by &%ignore_bounce_errors_after%&).
16067
16068
16069 .option timezone main string unset
16070 .cindex "timezone, setting"
16071 The value of &%timezone%& is used to set the environment variable TZ while
16072 running Exim (if it is different on entry). This ensures that all timestamps
16073 created by Exim are in the required timezone. If you want all your timestamps
16074 to be in UTC (aka GMT) you should set
16075 .code
16076 timezone = UTC
16077 .endd
16078 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16079 or, if that is not set, from the value of the TZ environment variable when Exim
16080 is built. If &%timezone%& is set to the empty string, either at build or run
16081 time, any existing TZ variable is removed from the environment when Exim
16082 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16083 unfortunately not all, operating systems.
16084
16085
16086 .option tls_advertise_hosts main "host list&!!" unset
16087 .cindex "TLS" "advertising"
16088 .cindex "encryption" "on SMTP connection"
16089 .cindex "SMTP" "encrypted connection"
16090 When Exim is built with support for TLS encrypted connections, the availability
16091 of the STARTTLS command to set up an encrypted session is advertised in
16092 response to EHLO only to those client hosts that match this option. See
16093 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16094
16095
16096 .option tls_certificate main string&!! unset
16097 .cindex "TLS" "server certificate; location of"
16098 .cindex "certificate" "server, location of"
16099 The value of this option is expanded, and must then be the absolute path to a
16100 file which contains the server's certificates. The server's private key is also
16101 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16102 &<<CHAPTLS>>& for further details.
16103
16104 &*Note*&: The certificates defined by this option are used only when Exim is
16105 receiving incoming messages as a server. If you want to supply certificates for
16106 use when sending messages as a client, you must set the &%tls_certificate%&
16107 option in the relevant &(smtp)& transport.
16108
16109 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16110 if the OpenSSL build supports TLS extensions and the TLS client sends the
16111 Server Name Indication extension, then this option and others documented in
16112 &<<SECTtlssni>>& will be re-expanded.
16113
16114 .option tls_crl main string&!! unset
16115 .cindex "TLS" "server certificate revocation list"
16116 .cindex "certificate" "revocation list for server"
16117 This option specifies a certificate revocation list. The expanded value must
16118 be the name of a file that contains a CRL in PEM format.
16119
16120 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16121
16122
16123 .option tls_dh_max_bits main integer 2236
16124 .cindex "TLS" "D-H bit count"
16125 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16126 the chosen TLS library.  That value might prove to be too high for
16127 interoperability.  This option provides a maximum clamp on the value
16128 suggested, trading off security for interoperability.
16129
16130 The value must be at least 1024.
16131
16132 The value 2236 was chosen because, at time of adding the option, it was the
16133 hard-coded maximum value supported by the NSS cryptographic library, as used
16134 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16135
16136 If you prefer more security and are willing to break some clients, raise this
16137 number.
16138
16139 Note that the value passed to GnuTLS for *generating* a new prime may be a
16140 little less than this figure, because GnuTLS is inexact and may produce a
16141 larger prime than requested.
16142
16143
16144 .option tls_dhparam main string&!! unset
16145 .cindex "TLS" "D-H parameters for server"
16146 The value of this option is expanded and indicates the source of DH parameters
16147 to be used by Exim.
16148
16149 If it is a filename starting with a &`/`&, then it names a file from which DH
16150 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16151 PKCS#3 representation of the DH prime.  If the file does not exist, for
16152 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16153 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16154 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16155 and treated as though the &%tls_dhparam%& were set to "none".
16156
16157 If this option expands to the string "none", then no DH parameters will be
16158 loaded by Exim.
16159
16160 If this option expands to the string "historic" and Exim is using GnuTLS, then
16161 Exim will attempt to load a file from inside the spool directory.  If the file
16162 does not exist, Exim will attempt to create it.
16163 See section &<<SECTgnutlsparam>>& for further details.
16164
16165 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16166 a default DH prime; the default is the 2048 bit prime described in section
16167 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16168 in IKE is assigned number 23.
16169
16170 Otherwise, the option must expand to the name used by Exim for any of a number
16171 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16172 "ike" followed by the number used by IKE, of "default" which corresponds to
16173 "ike23".
16174
16175 The available primes are:
16176 &`ike1`&, &`ike2`&, &`ike5`&,
16177 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16178 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16179
16180 Some of these will be too small to be accepted by clients.
16181 Some may be too large to be accepted by clients.
16182
16183 .new
16184 The TLS protocol does not negotiate an acceptable size for this; clients tend
16185 to hard-drop connections if what is offered by the server is unacceptable,
16186 whether too large or too small, and there's no provision for the client to
16187 tell the server what these constraints are.  Thus, as a server operator, you
16188 need to make an educated guess as to what is most likely to work for your
16189 userbase.
16190
16191 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16192 is most likely to maximise interoperability.  The upper bound comes from
16193 applications using the Mozilla Network Security Services (NSS) library, which
16194 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16195 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16196 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16197 acceptable bound from 1024 to 2048.
16198 .wen
16199
16200
16201 .option tls_on_connect_ports main "string list" unset
16202 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16203 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16204 set up without waiting for the client to issue a STARTTLS command. For
16205 further details, see section &<<SECTsupobssmt>>&.
16206
16207
16208
16209 .option tls_privatekey main string&!! unset
16210 .cindex "TLS" "server private key; location of"
16211 The value of this option is expanded, and must then be the absolute path to a
16212 file which contains the server's private key. If this option is unset, or if
16213 the expansion is forced to fail, or the result is an empty string, the private
16214 key is assumed to be in the same file as the server's certificates. See chapter
16215 &<<CHAPTLS>>& for further details.
16216
16217 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16218
16219
16220 .option tls_remember_esmtp main boolean false
16221 .cindex "TLS" "esmtp state; remembering"
16222 .cindex "TLS" "broken clients"
16223 If this option is set true, Exim violates the RFCs by remembering that it is in
16224 &"esmtp"& state after successfully negotiating a TLS session. This provides
16225 support for broken clients that fail to send a new EHLO after starting a
16226 TLS session.
16227
16228
16229 .option tls_require_ciphers main string&!! unset
16230 .cindex "TLS" "requiring specific ciphers"
16231 .cindex "cipher" "requiring specific"
16232 This option controls which ciphers can be used for incoming TLS connections.
16233 The &(smtp)& transport has an option of the same name for controlling outgoing
16234 connections. This option is expanded for each connection, so can be varied for
16235 different clients if required. The value of this option must be a list of
16236 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16237 in somewhat different ways. If GnuTLS is being used, the client controls the
16238 preference order of the available ciphers. Details are given in sections
16239 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16240
16241
16242 .option tls_try_verify_hosts main "host list&!!" unset
16243 .cindex "TLS" "client certificate verification"
16244 .cindex "certificate" "verification of client"
16245 See &%tls_verify_hosts%& below.
16246
16247
16248 .option tls_verify_certificates main string&!! unset
16249 .cindex "TLS" "client certificate verification"
16250 .cindex "certificate" "verification of client"
16251 The value of this option is expanded, and must then be the absolute path to
16252 a file containing permitted certificates for clients that
16253 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16254 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16255 directory containing certificate files. This does not work with GnuTLS; the
16256 option must be set to the name of a single file if you are using GnuTLS.
16257
16258 These certificates should be for the certificate authorities trusted, rather
16259 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16260 the value is a file then the certificates are sent by Exim as a server to
16261 connecting clients, defining the list of accepted certificate authorities.
16262 Thus the values defined should be considered public data.  To avoid this,
16263 use OpenSSL with a directory.
16264
16265 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16266
16267 .new
16268 A forced expansion failure or setting to an empty string is equivalent to
16269 being unset.
16270 .wen
16271
16272
16273 .option tls_verify_hosts main "host list&!!" unset
16274 .cindex "TLS" "client certificate verification"
16275 .cindex "certificate" "verification of client"
16276 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16277 certificates from clients. The expected certificates are defined by
16278 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16279 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16280 &%tls_verify_certificates%& is not set.
16281
16282 Any client that matches &%tls_verify_hosts%& is constrained by
16283 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16284 present one of the listed certificates. If it does not, the connection is
16285 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16286 the host to use TLS. It can still send SMTP commands through unencrypted
16287 connections. Forcing a client to use TLS has to be done separately using an
16288 ACL to reject inappropriate commands when the connection is not encrypted.
16289
16290 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16291 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16292 certificate and checks it against &%tls_verify_certificates%&, but does not
16293 abort the connection if there is no certificate or if it does not match. This
16294 state can be detected in an ACL, which makes it possible to implement policies
16295 such as &"accept for relay only if a verified certificate has been received,
16296 but accept for local delivery if encrypted, even without a verified
16297 certificate"&.
16298
16299 Client hosts that match neither of these lists are not asked to present
16300 certificates.
16301
16302
16303 .option trusted_groups main "string list&!!" unset
16304 .cindex "trusted groups"
16305 .cindex "groups" "trusted"
16306 This option is expanded just once, at the start of Exim's processing. If this
16307 option is set, any process that is running in one of the listed groups, or
16308 which has one of them as a supplementary group, is trusted. The groups can be
16309 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16310 details of what trusted callers are permitted to do. If neither
16311 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16312 are trusted.
16313
16314 .option trusted_users main "string list&!!" unset
16315 .cindex "trusted users"
16316 .cindex "user" "trusted"
16317 This option is expanded just once, at the start of Exim's processing. If this
16318 option is set, any process that is running as one of the listed users is
16319 trusted. The users can be specified numerically or by name. See section
16320 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16321 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16322 Exim user are trusted.
16323
16324 .option unknown_login main string&!! unset
16325 .cindex "uid (user id)" "unknown caller"
16326 .vindex "&$caller_uid$&"
16327 This is a specialized feature for use in unusual configurations. By default, if
16328 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16329 gives up. The &%unknown_login%& option can be used to set a login name to be
16330 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16331 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16332 is used for the user's real name (gecos field), unless this has been set by the
16333 &%-F%& option.
16334
16335 .option unknown_username main string unset
16336 See &%unknown_login%&.
16337
16338 .option untrusted_set_sender main "address list&!!" unset
16339 .cindex "trusted users"
16340 .cindex "sender" "setting by untrusted user"
16341 .cindex "untrusted user setting sender"
16342 .cindex "user" "untrusted setting sender"
16343 .cindex "envelope sender"
16344 When an untrusted user submits a message to Exim using the standard input, Exim
16345 normally creates an envelope sender address from the user's login and the
16346 default qualification domain. Data from the &%-f%& option (for setting envelope
16347 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16348 is used) is ignored.
16349
16350 However, untrusted users are permitted to set an empty envelope sender address,
16351 to declare that a message should never generate any bounces. For example:
16352 .code
16353 exim -f '<>' user@domain.example
16354 .endd
16355 .vindex "&$sender_ident$&"
16356 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16357 other envelope sender addresses in a controlled way. When it is set, untrusted
16358 users are allowed to set envelope sender addresses that match any of the
16359 patterns in the list. Like all address lists, the string is expanded. The
16360 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16361 users to setting senders that start with their login ids
16362 followed by a hyphen
16363 by a setting like this:
16364 .code
16365 untrusted_set_sender = ^$sender_ident-
16366 .endd
16367 If you want to allow untrusted users to set envelope sender addresses without
16368 restriction, you can use
16369 .code
16370 untrusted_set_sender = *
16371 .endd
16372 The &%untrusted_set_sender%& option applies to all forms of local input, but
16373 only to the setting of the envelope sender. It does not permit untrusted users
16374 to use the other options which trusted user can use to override message
16375 parameters. Furthermore, it does not stop Exim from removing an existing
16376 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16377 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16378 overriding these actions. The handling of the &'Sender:'& header is also
16379 described in section &<<SECTthesenhea>>&.
16380
16381 The log line for a message's arrival shows the envelope sender following
16382 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16383 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16384 envelope sender address, the user's login is shown in parentheses after the
16385 sender address.
16386
16387
16388 .option uucp_from_pattern main string "see below"
16389 .cindex "&""From""& line"
16390 .cindex "UUCP" "&""From""& line"
16391 Some applications that pass messages to an MTA via a command line interface use
16392 an initial line starting with &"From&~"& to pass the envelope sender. In
16393 particular, this is used by UUCP software. Exim recognizes such a line by means
16394 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16395 matches, the sender address is constructed by expanding the contents of
16396 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16397 default pattern recognizes lines in the following two forms:
16398 .code
16399 From ph10 Fri Jan  5 12:35 GMT 1996
16400 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16401 .endd
16402 The pattern can be seen by running
16403 .code
16404 exim -bP uucp_from_pattern
16405 .endd
16406 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16407 year in the second case. The first word after &"From&~"& is matched in the
16408 regular expression by a parenthesized subpattern. The default value for
16409 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16410 (&"ph10"& in the example above) as the message's sender. See also
16411 &%ignore_fromline_hosts%&.
16412
16413
16414 .option uucp_from_sender main string&!! &`$1`&
16415 See &%uucp_from_pattern%& above.
16416
16417
16418 .option warn_message_file main string unset
16419 .cindex "warning of delay" "customizing the message"
16420 .cindex "customizing" "warning message"
16421 This option defines a template file containing paragraphs of text to be used
16422 for constructing the warning message which is sent by Exim when a message has
16423 been on the queue for a specified amount of time, as specified by
16424 &%delay_warning%&. Details of the file's contents are given in chapter
16425 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16426
16427
16428 .option write_rejectlog main boolean true
16429 .cindex "reject log" "disabling"
16430 If this option is set false, Exim no longer writes anything to the reject log.
16431 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16432 .ecindex IIDconfima
16433 .ecindex IIDmaiconf
16434
16435
16436
16437
16438 . ////////////////////////////////////////////////////////////////////////////
16439 . ////////////////////////////////////////////////////////////////////////////
16440
16441 .chapter "Generic options for routers" "CHAProutergeneric"
16442 .scindex IIDgenoprou1 "options" "generic; for routers"
16443 .scindex IIDgenoprou2 "generic options" "router"
16444 This chapter describes the generic options that apply to all routers.
16445 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16446
16447 For a general description of how a router operates, see sections
16448 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16449 which the preconditions are tested. The order of expansion of the options that
16450 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16451 &%headers_remove%&, &%transport%&.
16452
16453
16454
16455 .option address_data routers string&!! unset
16456 .cindex "router" "data attached to address"
16457 The string is expanded just before the router is run, that is, after all the
16458 precondition tests have succeeded. If the expansion is forced to fail, the
16459 router declines, the value of &%address_data%& remains unchanged, and the
16460 &%more%& option controls what happens next. Other expansion failures cause
16461 delivery of the address to be deferred.
16462
16463 .vindex "&$address_data$&"
16464 When the expansion succeeds, the value is retained with the address, and can be
16465 accessed using the variable &$address_data$& in the current router, subsequent
16466 routers, and the eventual transport.
16467
16468 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16469 that runs a user's filter file, the contents of &$address_data$& are accessible
16470 in the filter. This is not normally a problem, because such data is usually
16471 either not confidential or it &"belongs"& to the current user, but if you do
16472 put confidential data into &$address_data$& you need to remember this point.
16473
16474 Even if the router declines or passes, the value of &$address_data$& remains
16475 with the address, though it can be changed by another &%address_data%& setting
16476 on a subsequent router. If a router generates child addresses, the value of
16477 &$address_data$& propagates to them. This also applies to the special kind of
16478 &"child"& that is generated by a router with the &%unseen%& option.
16479
16480 The idea of &%address_data%& is that you can use it to look up a lot of data
16481 for the address once, and then pick out parts of the data later. For example,
16482 you could use a single LDAP lookup to return a string of the form
16483 .code
16484 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16485 .endd
16486 In the transport you could pick out the mailbox by a setting such as
16487 .code
16488 file = ${extract{mailbox}{$address_data}}
16489 .endd
16490 This makes the configuration file less messy, and also reduces the number of
16491 lookups (though Exim does cache lookups).
16492
16493 .vindex "&$sender_address_data$&"
16494 .vindex "&$address_data$&"
16495 The &%address_data%& facility is also useful as a means of passing information
16496 from one router to another, and from a router to a transport. In addition, if
16497 &$address_data$& is set by a router when verifying a recipient address from an
16498 ACL, it remains available for use in the rest of the ACL statement. After
16499 verifying a sender, the value is transferred to &$sender_address_data$&.
16500
16501
16502
16503 .option address_test routers&!? boolean true
16504 .oindex "&%-bt%&"
16505 .cindex "router" "skipping when address testing"
16506 If this option is set false, the router is skipped when routing is being tested
16507 by means of the &%-bt%& command line option. This can be a convenience when
16508 your first router sends messages to an external scanner, because it saves you
16509 having to set the &"already scanned"& indicator when testing real address
16510 routing.
16511
16512
16513
16514 .option cannot_route_message routers string&!! unset
16515 .cindex "router" "customizing &""cannot route""& message"
16516 .cindex "customizing" "&""cannot route""& message"
16517 This option specifies a text message that is used when an address cannot be
16518 routed because Exim has run out of routers. The default message is
16519 &"Unrouteable address"&. This option is useful only on routers that have
16520 &%more%& set false, or on the very last router in a configuration, because the
16521 value that is used is taken from the last router that is considered. This
16522 includes a router that is skipped because its preconditions are not met, as
16523 well as a router that declines. For example, using the default configuration,
16524 you could put:
16525 .code
16526 cannot_route_message = Remote domain not found in DNS
16527 .endd
16528 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16529 and
16530 .code
16531 cannot_route_message = Unknown local user
16532 .endd
16533 on the final router that checks for local users. If string expansion fails for
16534 this option, the default message is used. Unless the expansion failure was
16535 explicitly forced, a message about the failure is written to the main and panic
16536 logs, in addition to the normal message about the routing failure.
16537
16538
16539 .option caseful_local_part routers boolean false
16540 .cindex "case of local parts"
16541 .cindex "router" "case of local parts"
16542 By default, routers handle the local parts of addresses in a case-insensitive
16543 manner, though the actual case is preserved for transmission with the message.
16544 If you want the case of letters to be significant in a router, you must set
16545 this option true. For individual router options that contain address or local
16546 part lists (for example, &%local_parts%&), case-sensitive matching can be
16547 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16548 more details.
16549
16550 .vindex "&$local_part$&"
16551 .vindex "&$original_local_part$&"
16552 .vindex "&$parent_local_part$&"
16553 The value of the &$local_part$& variable is forced to lower case while a
16554 router is running unless &%caseful_local_part%& is set. When a router assigns
16555 an address to a transport, the value of &$local_part$& when the transport runs
16556 is the same as it was in the router. Similarly, when a router generates child
16557 addresses by aliasing or forwarding, the values of &$original_local_part$&
16558 and &$parent_local_part$& are those that were used by the redirecting router.
16559
16560 This option applies to the processing of an address by a router. When a
16561 recipient address is being processed in an ACL, there is a separate &%control%&
16562 modifier that can be used to specify case-sensitive processing within the ACL
16563 (see section &<<SECTcontrols>>&).
16564
16565
16566
16567 .option check_local_user routers&!? boolean false
16568 .cindex "local user, checking in router"
16569 .cindex "router" "checking for local user"
16570 .cindex "&_/etc/passwd_&"
16571 .vindex "&$home$&"
16572 When this option is true, Exim checks that the local part of the recipient
16573 address (with affixes removed if relevant) is the name of an account on the
16574 local system. The check is done by calling the &[getpwnam()]& function rather
16575 than trying to read &_/etc/passwd_& directly. This means that other methods of
16576 holding password data (such as NIS) are supported. If the local part is a local
16577 user, &$home$& is set from the password data, and can be tested in other
16578 preconditions that are evaluated after this one (the order of evaluation is
16579 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16580 overridden by &%router_home_directory%&. If the local part is not a local user,
16581 the router is skipped.
16582
16583 If you want to check that the local part is either the name of a local user
16584 or matches something else, you cannot combine &%check_local_user%& with a
16585 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16586 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16587 setting to achieve this. For example:
16588 .code
16589 local_parts = passwd;$local_part : lsearch;/etc/other/users
16590 .endd
16591 Note, however, that the side effects of &%check_local_user%& (such as setting
16592 up a home directory) do not occur when a &(passwd)& lookup is used in a
16593 &%local_parts%& (or any other) precondition.
16594
16595
16596
16597 .option condition routers&!? string&!! unset
16598 .cindex "router" "customized precondition"
16599 This option specifies a general precondition test that has to succeed for the
16600 router to be called. The &%condition%& option is the last precondition to be
16601 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16602 result is a forced failure, or an empty string, or one of the strings &"0"& or
16603 &"no"& or &"false"& (checked without regard to the case of the letters), the
16604 router is skipped, and the address is offered to the next one.
16605
16606 If the result is any other value, the router is run (as this is the last
16607 precondition to be evaluated, all the other preconditions must be true).
16608
16609 This option is unusual in that multiple &%condition%& options may be present.
16610 All &%condition%& options must succeed.
16611
16612 The &%condition%& option provides a means of applying custom conditions to the
16613 running of routers. Note that in the case of a simple conditional expansion,
16614 the default expansion values are exactly what is wanted. For example:
16615 .code
16616 condition = ${if >{$message_age}{600}}
16617 .endd
16618 Because of the default behaviour of the string expansion, this is equivalent to
16619 .code
16620 condition = ${if >{$message_age}{600}{true}{}}
16621 .endd
16622
16623 A multiple condition example, which succeeds:
16624 .code
16625 condition = ${if >{$message_age}{600}}
16626 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16627 condition = foobar
16628 .endd
16629
16630 If the expansion fails (other than forced failure) delivery is deferred. Some
16631 of the other precondition options are common special cases that could in fact
16632 be specified using &%condition%&.
16633
16634
16635 .option debug_print routers string&!! unset
16636 .cindex "testing" "variables in drivers"
16637 If this option is set and debugging is enabled (see the &%-d%& command line
16638 option) or in address-testing mode (see the &%-bt%& command line option),
16639 the string is expanded and included in the debugging output.
16640 If expansion of the string fails, the error message is written to the debugging
16641 output, and Exim carries on processing.
16642 This option is provided to help with checking out the values of variables and
16643 so on when debugging router configurations. For example, if a &%condition%&
16644 option appears not to be working, &%debug_print%& can be used to output the
16645 variables it references. The output happens after checks for &%domains%&,
16646 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16647 are tested. A newline is added to the text if it does not end with one.
16648 The variable &$router_name$& contains the name of the router.
16649
16650
16651
16652 .option disable_logging routers boolean false
16653 If this option is set true, nothing is logged for any routing errors
16654 or for any deliveries caused by this router. You should not set this option
16655 unless you really, really know what you are doing. See also the generic
16656 transport option of the same name.
16657
16658
16659 .option domains routers&!? "domain list&!!" unset
16660 .cindex "router" "restricting to specific domains"
16661 .vindex "&$domain_data$&"
16662 If this option is set, the router is skipped unless the current domain matches
16663 the list. If the match is achieved by means of a file lookup, the data that the
16664 lookup returned for the domain is placed in &$domain_data$& for use in string
16665 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16666 a list of the order in which preconditions are evaluated.
16667
16668
16669
16670 .option driver routers string unset
16671 This option must always be set. It specifies which of the available routers is
16672 to be used.
16673
16674
16675
16676 .option errors_to routers string&!! unset
16677 .cindex "envelope sender"
16678 .cindex "router" "changing address for errors"
16679 If a router successfully handles an address, it may assign the address to a
16680 transport for delivery or it may generate child addresses. In both cases, if
16681 there is a delivery problem during later processing, the resulting bounce
16682 message is sent to the address that results from expanding this string,
16683 provided that the address verifies successfully. The &%errors_to%& option is
16684 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16685
16686 The &%errors_to%& setting associated with an address can be overridden if it
16687 subsequently passes through other routers that have their own &%errors_to%&
16688 settings, or if the message is delivered by a transport with a &%return_path%&
16689 setting.
16690
16691 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16692 the expansion fails to verify, the errors address associated with the incoming
16693 address is used. At top level, this is the envelope sender. A non-forced
16694 expansion failure causes delivery to be deferred.
16695
16696 If an address for which &%errors_to%& has been set ends up being delivered over
16697 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16698 any bounces that are generated by other MTAs on the delivery route are also
16699 sent there. You can set &%errors_to%& to the empty string by either of these
16700 settings:
16701 .code
16702 errors_to =
16703 errors_to = ""
16704 .endd
16705 An expansion item that yields an empty string has the same effect. If you do
16706 this, a locally detected delivery error for addresses processed by this router
16707 no longer gives rise to a bounce message; the error is discarded. If the
16708 address is delivered to a remote host, the return path is set to &`<>`&, unless
16709 overridden by the &%return_path%& option on the transport.
16710
16711 .vindex "&$address_data$&"
16712 If for some reason you want to discard local errors, but use a non-empty
16713 MAIL command for remote delivery, you can preserve the original return
16714 path in &$address_data$& in the router, and reinstate it in the transport by
16715 setting &%return_path%&.
16716
16717 The most common use of &%errors_to%& is to direct mailing list bounces to the
16718 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16719 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16720
16721
16722
16723 .option expn routers&!? boolean true
16724 .cindex "address" "testing"
16725 .cindex "testing" "addresses"
16726 .cindex "EXPN" "router skipping"
16727 .cindex "router" "skipping for EXPN"
16728 If this option is turned off, the router is skipped when testing an address
16729 as a result of processing an SMTP EXPN command. You might, for example,
16730 want to turn it off on a router for users' &_.forward_& files, while leaving it
16731 on for the system alias file.
16732 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16733 are evaluated.
16734
16735 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16736 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16737 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16738
16739
16740
16741 .option fail_verify routers boolean false
16742 .cindex "router" "forcing verification failure"
16743 Setting this option has the effect of setting both &%fail_verify_sender%& and
16744 &%fail_verify_recipient%& to the same value.
16745
16746
16747
16748 .option fail_verify_recipient routers boolean false
16749 If this option is true and an address is accepted by this router when
16750 verifying a recipient, verification fails.
16751
16752
16753
16754 .option fail_verify_sender routers boolean false
16755 If this option is true and an address is accepted by this router when
16756 verifying a sender, verification fails.
16757
16758
16759
16760 .option fallback_hosts routers "string list" unset
16761 .cindex "router" "fallback hosts"
16762 .cindex "fallback" "hosts specified on router"
16763 String expansion is not applied to this option. The argument must be a
16764 colon-separated list of host names or IP addresses. The list separator can be
16765 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16766 each name or address. In fact, the format of each item is exactly the same as
16767 defined for the list of hosts in a &(manualroute)& router (see section
16768 &<<SECTformatonehostitem>>&).
16769
16770 If a router queues an address for a remote transport, this host list is
16771 associated with the address, and used instead of the transport's fallback host
16772 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16773 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16774 transport for further details.
16775
16776
16777 .option group routers string&!! "see below"
16778 .cindex "gid (group id)" "local delivery"
16779 .cindex "local transports" "uid and gid"
16780 .cindex "transport" "local"
16781 .cindex "router" "setting group"
16782 When a router queues an address for a transport, and the transport does not
16783 specify a group, the group given here is used when running the delivery
16784 process.
16785 The group may be specified numerically or by name. If expansion fails, the
16786 error is logged and delivery is deferred.
16787 The default is unset, unless &%check_local_user%& is set, when the default
16788 is taken from the password information. See also &%initgroups%& and &%user%&
16789 and the discussion in chapter &<<CHAPenvironment>>&.
16790
16791
16792
16793 .option headers_add routers string&!! unset
16794 .cindex "header lines" "adding"
16795 .cindex "router" "adding header lines"
16796 This option specifies a string of text that is expanded at routing time, and
16797 associated with any addresses that are accepted by the router. However, this
16798 option has no effect when an address is just being verified. The way in which
16799 the text is used to add header lines at transport time is described in section
16800 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16801 message is in the process of being transported. This means that references to
16802 header lines in string expansions in the transport's configuration do not
16803 &"see"& the added header lines.
16804
16805 The &%headers_add%& option is expanded after &%errors_to%&, but before
16806 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16807 the expansion is forced to fail, the option has no effect. Other expansion
16808 failures are treated as configuration errors.
16809
16810 .new
16811 Unlike most options, &%headers_add%& can be specified multiple times
16812 for a router; all listed headers are added.
16813 .wen
16814
16815 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16816 router that has the &%one_time%& option set.
16817
16818 .cindex "duplicate addresses"
16819 .oindex "&%unseen%&"
16820 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16821 additions are deleted when the address is passed on to subsequent routers.
16822 For a &%redirect%& router, if a generated address is the same as the incoming
16823 address, this can lead to duplicate addresses with different header
16824 modifications. Exim does not do duplicate deliveries (except, in certain
16825 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16826 which of the duplicates is discarded, so this ambiguous situation should be
16827 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16828
16829
16830
16831 .option headers_remove routers string&!! unset
16832 .cindex "header lines" "removing"
16833 .cindex "router" "removing header lines"
16834 This option specifies a string of text that is expanded at routing time, and
16835 associated with any addresses that are accepted by the router. However, this
16836 option has no effect when an address is just being verified. The way in which
16837 the text is used to remove header lines at transport time is described in
16838 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16839 the message is in the process of being transported. This means that references
16840 to header lines in string expansions in the transport's configuration still
16841 &"see"& the original header lines.
16842
16843 The &%headers_remove%& option is expanded after &%errors_to%& and
16844 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16845 the option has no effect. Other expansion failures are treated as configuration
16846 errors.
16847
16848 Unlike most options, &%headers_remove%& can be specified multiple times
16849 for a router; all listed headers are removed.
16850
16851 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16852 router that has the &%one_time%& option set.
16853
16854 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16855 removal requests are deleted when the address is passed on to subsequent
16856 routers, and this can lead to problems with duplicates -- see the similar
16857 warning for &%headers_add%& above.
16858
16859
16860 .option ignore_target_hosts routers "host list&!!" unset
16861 .cindex "IP address" "discarding"
16862 .cindex "router" "discarding IP addresses"
16863 Although this option is a host list, it should normally contain IP address
16864 entries rather than names. If any host that is looked up by the router has an
16865 IP address that matches an item in this list, Exim behaves as if that IP
16866 address did not exist. This option allows you to cope with rogue DNS entries
16867 like
16868 .code
16869 remote.domain.example.  A  127.0.0.1
16870 .endd
16871 by setting
16872 .code
16873 ignore_target_hosts = 127.0.0.1
16874 .endd
16875 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16876 discarded in this way, the router declines. In a conventional configuration, an
16877 attempt to mail to such a domain would normally provoke the &"unrouteable
16878 domain"& error, and an attempt to verify an address in the domain would fail.
16879 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16880 router declines if presented with one of the listed addresses.
16881
16882 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16883 means of the first or the second of the following settings, respectively:
16884 .code
16885 ignore_target_hosts = 0.0.0.0/0
16886 ignore_target_hosts = <; 0::0/0
16887 .endd
16888 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16889 in the second line matches all IPv6 addresses.
16890
16891 This option may also be useful for ignoring link-local and site-local IPv6
16892 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16893 is expanded before use as a list, it is possible to make it dependent on the
16894 domain that is being routed.
16895
16896 .vindex "&$host_address$&"
16897 During its expansion, &$host_address$& is set to the IP address that is being
16898 checked.
16899
16900 .option initgroups routers boolean false
16901 .cindex "additional groups"
16902 .cindex "groups" "additional"
16903 .cindex "local transports" "uid and gid"
16904 .cindex "transport" "local"
16905 If the router queues an address for a transport, and this option is true, and
16906 the uid supplied by the router is not overridden by the transport, the
16907 &[initgroups()]& function is called when running the transport to ensure that
16908 any additional groups associated with the uid are set up. See also &%group%&
16909 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16910
16911
16912
16913 .option local_part_prefix routers&!? "string list" unset
16914 .cindex "router" "prefix for local part"
16915 .cindex "prefix" "for local part, used in router"
16916 If this option is set, the router is skipped unless the local part starts with
16917 one of the given strings, or &%local_part_prefix_optional%& is true. See
16918 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16919 evaluated.
16920
16921 The list is scanned from left to right, and the first prefix that matches is
16922 used. A limited form of wildcard is available; if the prefix begins with an
16923 asterisk, it matches the longest possible sequence of arbitrary characters at
16924 the start of the local part. An asterisk should therefore always be followed by
16925 some character that does not occur in normal local parts.
16926 .cindex "multiple mailboxes"
16927 .cindex "mailbox" "multiple"
16928 Wildcarding can be used to set up multiple user mailboxes, as described in
16929 section &<<SECTmulbox>>&.
16930
16931 .vindex "&$local_part$&"
16932 .vindex "&$local_part_prefix$&"
16933 During the testing of the &%local_parts%& option, and while the router is
16934 running, the prefix is removed from the local part, and is available in the
16935 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16936 the router accepts the address, this remains true during subsequent delivery by
16937 a transport. In particular, the local part that is transmitted in the RCPT
16938 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16939 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16940 the relevant transport.
16941
16942 When an address is being verified, &%local_part_prefix%& affects only the
16943 behaviour of the router. If the callout feature of verification is in use, this
16944 means that the full address, including the prefix, will be used during the
16945 callout.
16946
16947 The prefix facility is commonly used to handle local parts of the form
16948 &%owner-something%&. Another common use is to support local parts of the form
16949 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16950 to tell a user their forwarding is broken &-- by placing a router like this one
16951 immediately before the router that handles &_.forward_& files:
16952 .code
16953 real_localuser:
16954   driver = accept
16955   local_part_prefix = real-
16956   check_local_user
16957   transport = local_delivery
16958 .endd
16959 For security, it would probably be a good idea to restrict the use of this
16960 router to locally-generated messages, using a condition such as this:
16961 .code
16962   condition = ${if match {$sender_host_address}\
16963                          {\N^(|127\.0\.0\.1)$\N}}
16964 .endd
16965
16966 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16967 both conditions must be met if not optional. Care must be taken if wildcards
16968 are used in both a prefix and a suffix on the same router. Different
16969 separator characters must be used to avoid ambiguity.
16970
16971
16972 .option local_part_prefix_optional routers boolean false
16973 See &%local_part_prefix%& above.
16974
16975
16976
16977 .option local_part_suffix routers&!? "string list" unset
16978 .cindex "router" "suffix for local part"
16979 .cindex "suffix for local part" "used in router"
16980 This option operates in the same way as &%local_part_prefix%&, except that the
16981 local part must end (rather than start) with the given string, the
16982 &%local_part_suffix_optional%& option determines whether the suffix is
16983 mandatory, and the wildcard * character, if present, must be the last
16984 character of the suffix. This option facility is commonly used to handle local
16985 parts of the form &%something-request%& and multiple user mailboxes of the form
16986 &%username-foo%&.
16987
16988
16989 .option local_part_suffix_optional routers boolean false
16990 See &%local_part_suffix%& above.
16991
16992
16993
16994 .option local_parts routers&!? "local part list&!!" unset
16995 .cindex "router" "restricting to specific local parts"
16996 .cindex "local part" "checking in router"
16997 The router is run only if the local part of the address matches the list.
16998 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16999 are evaluated, and
17000 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17001 string is expanded, it is possible to make it depend on the domain, for
17002 example:
17003 .code
17004 local_parts = dbm;/usr/local/specials/$domain
17005 .endd
17006 .vindex "&$local_part_data$&"
17007 If the match is achieved by a lookup, the data that the lookup returned
17008 for the local part is placed in the variable &$local_part_data$& for use in
17009 expansions of the router's private options. You might use this option, for
17010 example, if you have a large number of local virtual domains, and you want to
17011 send all postmaster mail to the same place without having to set up an alias in
17012 each virtual domain:
17013 .code
17014 postmaster:
17015   driver = redirect
17016   local_parts = postmaster
17017   data = postmaster@real.domain.example
17018 .endd
17019
17020
17021 .option log_as_local routers boolean "see below"
17022 .cindex "log" "delivery line"
17023 .cindex "delivery" "log line format"
17024 Exim has two logging styles for delivery, the idea being to make local
17025 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17026 recipient address is given just as the local part, without a domain. The use of
17027 this style is controlled by this option. It defaults to true for the &(accept)&
17028 router, and false for all the others. This option applies only when a
17029 router assigns an address to a transport. It has no effect on routers that
17030 redirect addresses.
17031
17032
17033
17034 .option more routers boolean&!! true
17035 The result of string expansion for this option must be a valid boolean value,
17036 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17037 result causes an error, and delivery is deferred. If the expansion is forced to
17038 fail, the default value for the option (true) is used. Other failures cause
17039 delivery to be deferred.
17040
17041 If this option is set false, and the router declines to handle the address, no
17042 further routers are tried, routing fails, and the address is bounced.
17043 .oindex "&%self%&"
17044 However, if the router explicitly passes an address to the following router by
17045 means of the setting
17046 .code
17047 self = pass
17048 .endd
17049 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17050 does not affect the behaviour if one of the precondition tests fails. In that
17051 case, the address is always passed to the next router.
17052
17053 Note that &%address_data%& is not considered to be a precondition. If its
17054 expansion is forced to fail, the router declines, and the value of &%more%&
17055 controls what happens next.
17056
17057
17058 .option pass_on_timeout routers boolean false
17059 .cindex "timeout" "of router"
17060 .cindex "router" "timeout"
17061 If a router times out during a host lookup, it normally causes deferral of the
17062 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17063 router, overriding &%no_more%&. This may be helpful for systems that are
17064 intermittently connected to the Internet, or those that want to pass to a smart
17065 host any messages that cannot immediately be delivered.
17066
17067 There are occasional other temporary errors that can occur while doing DNS
17068 lookups. They are treated in the same way as a timeout, and this option
17069 applies to all of them.
17070
17071
17072
17073 .option pass_router routers string unset
17074 .cindex "router" "go to after &""pass""&"
17075 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17076 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17077 routing to continue, and overriding a false setting of &%more%&. When one of
17078 these routers returns &"pass"&, the address is normally handed on to the next
17079 router in sequence. This can be changed by setting &%pass_router%& to the name
17080 of another router. However (unlike &%redirect_router%&) the named router must
17081 be below the current router, to avoid loops. Note that this option applies only
17082 to the special case of &"pass"&. It does not apply when a router returns
17083 &"decline"& because it cannot handle an address.
17084
17085
17086
17087 .option redirect_router routers string unset
17088 .cindex "router" "start at after redirection"
17089 Sometimes an administrator knows that it is pointless to reprocess addresses
17090 generated from alias or forward files with the same router again. For
17091 example, if an alias file translates real names into login ids there is no
17092 point searching the alias file a second time, especially if it is a large file.
17093
17094 The &%redirect_router%& option can be set to the name of any router instance.
17095 It causes the routing of any generated addresses to start at the named router
17096 instead of at the first router. This option has no effect if the router in
17097 which it is set does not generate new addresses.
17098
17099
17100
17101 .option require_files routers&!? "string list&!!" unset
17102 .cindex "file" "requiring for router"
17103 .cindex "router" "requiring file existence"
17104 This option provides a general mechanism for predicating the running of a
17105 router on the existence or non-existence of certain files or directories.
17106 Before running a router, as one of its precondition tests, Exim works its way
17107 through the &%require_files%& list, expanding each item separately.
17108
17109 Because the list is split before expansion, any colons in expansion items must
17110 be doubled, or the facility for using a different list separator must be used.
17111 If any expansion is forced to fail, the item is ignored. Other expansion
17112 failures cause routing of the address to be deferred.
17113
17114 If any expanded string is empty, it is ignored. Otherwise, except as described
17115 below, each string must be a fully qualified file path, optionally preceded by
17116 &"!"&. The paths are passed to the &[stat()]& function to test for the
17117 existence of the files or directories. The router is skipped if any paths not
17118 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17119
17120 .cindex "NFS"
17121 If &[stat()]& cannot determine whether a file exists or not, delivery of
17122 the message is deferred. This can happen when NFS-mounted filesystems are
17123 unavailable.
17124
17125 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17126 options, so you cannot use it to check for the existence of a file in which to
17127 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17128 full list of the order in which preconditions are evaluated.) However, as
17129 these options are all expanded, you can use the &%exists%& expansion condition
17130 to make such tests. The &%require_files%& option is intended for checking files
17131 that the router may be going to use internally, or which are needed by a
17132 transport (for example &_.procmailrc_&).
17133
17134 During delivery, the &[stat()]& function is run as root, but there is a
17135 facility for some checking of the accessibility of a file by another user.
17136 This is not a proper permissions check, but just a &"rough"& check that
17137 operates as follows:
17138
17139 If an item in a &%require_files%& list does not contain any forward slash
17140 characters, it is taken to be the user (and optional group, separated by a
17141 comma) to be checked for subsequent files in the list. If no group is specified
17142 but the user is specified symbolically, the gid associated with the uid is
17143 used. For example:
17144 .code
17145 require_files = mail:/some/file
17146 require_files = $local_part:$home/.procmailrc
17147 .endd
17148 If a user or group name in a &%require_files%& list does not exist, the
17149 &%require_files%& condition fails.
17150
17151 Exim performs the check by scanning along the components of the file path, and
17152 checking the access for the given uid and gid. It checks for &"x"& access on
17153 directories, and &"r"& access on the final file. Note that this means that file
17154 access control lists, if the operating system has them, are ignored.
17155
17156 &*Warning 1*&: When the router is being run to verify addresses for an
17157 incoming SMTP message, Exim is not running as root, but under its own uid. This
17158 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17159 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17160 user is not permitted to read one of the directories on the file's path.
17161
17162 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17163 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17164 without root access. In this case, if a check for access by a particular user
17165 is requested, Exim creates a subprocess that runs as that user, and tries the
17166 check again in that process.
17167
17168 The default action for handling an unresolved EACCES is to consider it to
17169 be caused by a configuration error, and routing is deferred because the
17170 existence or non-existence of the file cannot be determined. However, in some
17171 circumstances it may be desirable to treat this condition as if the file did
17172 not exist. If the file name (or the exclamation mark that precedes the file
17173 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17174 as if the file did not exist. For example:
17175 .code
17176 require_files = +/some/file
17177 .endd
17178 If the router is not an essential part of verification (for example, it
17179 handles users' &_.forward_& files), another solution is to set the &%verify%&
17180 option false so that the router is skipped when verifying.
17181
17182
17183
17184 .option retry_use_local_part routers boolean "see below"
17185 .cindex "hints database" "retry keys"
17186 .cindex "local part" "in retry keys"
17187 When a delivery suffers a temporary routing failure, a retry record is created
17188 in Exim's hints database. For addresses whose routing depends only on the
17189 domain, the key for the retry record should not involve the local part, but for
17190 other addresses, both the domain and the local part should be included.
17191 Usually, remote routing is of the former kind, and local routing is of the
17192 latter kind.
17193
17194 This option controls whether the local part is used to form the key for retry
17195 hints for addresses that suffer temporary errors while being handled by this
17196 router. The default value is true for any router that has &%check_local_user%&
17197 set, and false otherwise. Note that this option does not apply to hints keys
17198 for transport delays; they are controlled by a generic transport option of the
17199 same name.
17200
17201 The setting of &%retry_use_local_part%& applies only to the router on which it
17202 appears. If the router generates child addresses, they are routed
17203 independently; this setting does not become attached to them.
17204
17205
17206
17207 .option router_home_directory routers string&!! unset
17208 .cindex "router" "home directory for"
17209 .cindex "home directory" "for router"
17210 .vindex "&$home$&"
17211 This option sets a home directory for use while the router is running. (Compare
17212 &%transport_home_directory%&, which sets a home directory for later
17213 transporting.) In particular, if used on a &(redirect)& router, this option
17214 sets a value for &$home$& while a filter is running. The value is expanded;
17215 forced expansion failure causes the option to be ignored &-- other failures
17216 cause the router to defer.
17217
17218 Expansion of &%router_home_directory%& happens immediately after the
17219 &%check_local_user%& test (if configured), before any further expansions take
17220 place.
17221 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17222 are evaluated.)
17223 While the router is running, &%router_home_directory%& overrides the value of
17224 &$home$& that came from &%check_local_user%&.
17225
17226 When a router accepts an address and assigns it to a local transport (including
17227 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17228 delivery), the home directory setting for the transport is taken from the first
17229 of these values that is set:
17230
17231 .ilist
17232 The &%home_directory%& option on the transport;
17233 .next
17234 The &%transport_home_directory%& option on the router;
17235 .next
17236 The password data if &%check_local_user%& is set on the router;
17237 .next
17238 The &%router_home_directory%& option on the router.
17239 .endlist
17240
17241 In other words, &%router_home_directory%& overrides the password data for the
17242 router, but not for the transport.
17243
17244
17245
17246 .option self routers string freeze
17247 .cindex "MX record" "pointing to local host"
17248 .cindex "local host" "MX pointing to"
17249 This option applies to those routers that use a recipient address to find a
17250 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17251 and &(manualroute)& routers.
17252 Certain configurations of the &(queryprogram)& router can also specify a list
17253 of remote hosts.
17254 Usually such routers are configured to send the message to a remote host via an
17255 &(smtp)& transport. The &%self%& option specifies what happens when the first
17256 host on the list turns out to be the local host.
17257 The way in which Exim checks for the local host is described in section
17258 &<<SECTreclocipadd>>&.
17259
17260 Normally this situation indicates either an error in Exim's configuration (for
17261 example, the router should be configured not to process this domain), or an
17262 error in the DNS (for example, the MX should not point to this host). For this
17263 reason, the default action is to log the incident, defer the address, and
17264 freeze the message. The following alternatives are provided for use in special
17265 cases:
17266
17267 .vlist
17268 .vitem &%defer%&
17269 Delivery of the message is tried again later, but the message is not frozen.
17270
17271 .vitem "&%reroute%&: <&'domain'&>"
17272 The domain is changed to the given domain, and the address is passed back to
17273 be reprocessed by the routers. No rewriting of headers takes place. This
17274 behaviour is essentially a redirection.
17275
17276 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17277 The domain is changed to the given domain, and the address is passed back to be
17278 reprocessed by the routers. Any headers that contain the original domain are
17279 rewritten.
17280
17281 .vitem &%pass%&
17282 .oindex "&%more%&"
17283 .vindex "&$self_hostname$&"
17284 The router passes the address to the next router, or to the router named in the
17285 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17286 subsequent routing and delivery, the variable &$self_hostname$& contains the
17287 name of the local host that the router encountered. This can be used to
17288 distinguish between different cases for hosts with multiple names. The
17289 combination
17290 .code
17291 self = pass
17292 no_more
17293 .endd
17294 ensures that only those addresses that routed to the local host are passed on.
17295 Without &%no_more%&, addresses that were declined for other reasons would also
17296 be passed to the next router.
17297
17298 .vitem &%fail%&
17299 Delivery fails and an error report is generated.
17300
17301 .vitem &%send%&
17302 .cindex "local host" "sending to"
17303 The anomaly is ignored and the address is queued for the transport. This
17304 setting should be used with extreme caution. For an &(smtp)& transport, it
17305 makes sense only in cases where the program that is listening on the SMTP port
17306 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17307 different configuration file that handles the domain in another way.
17308 .endlist
17309
17310
17311
17312 .option senders routers&!? "address list&!!" unset
17313 .cindex "router" "checking senders"
17314 If this option is set, the router is skipped unless the message's sender
17315 address matches something on the list.
17316 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17317 are evaluated.
17318
17319 There are issues concerning verification when the running of routers is
17320 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17321 setting, it sets the sender to the null string. When using the &%-bt%& option
17322 to check a configuration file, it is necessary also to use the &%-f%& option to
17323 set an appropriate sender. For incoming mail, the sender is unset when
17324 verifying the sender, but is available when verifying any recipients. If the
17325 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17326 matters.
17327
17328
17329 .option translate_ip_address routers string&!! unset
17330 .cindex "IP address" "translating"
17331 .cindex "packet radio"
17332 .cindex "router" "IP address translation"
17333 There exist some rare networking situations (for example, packet radio) where
17334 it is helpful to be able to translate IP addresses generated by normal routing
17335 mechanisms into other IP addresses, thus performing a kind of manual IP
17336 routing. This should be done only if the normal IP routing of the TCP/IP stack
17337 is inadequate or broken. Because this is an extremely uncommon requirement, the
17338 code to support this option is not included in the Exim binary unless
17339 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17340
17341 .vindex "&$host_address$&"
17342 The &%translate_ip_address%& string is expanded for every IP address generated
17343 by the router, with the generated address set in &$host_address$&. If the
17344 expansion is forced to fail, no action is taken.
17345 For any other expansion error, delivery of the message is deferred.
17346 If the result of the expansion is an IP address, that replaces the original
17347 address; otherwise the result is assumed to be a host name &-- this is looked
17348 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17349 produce one or more replacement IP addresses. For example, to subvert all IP
17350 addresses in some specific networks, this could be added to a router:
17351 .code
17352 translate_ip_address = \
17353   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17354     {$value}fail}}
17355 .endd
17356 The file would contain lines like
17357 .code
17358 10.2.3.128/26    some.host
17359 10.8.4.34/26     10.44.8.15
17360 .endd
17361 You should not make use of this facility unless you really understand what you
17362 are doing.
17363
17364
17365
17366 .option transport routers string&!! unset
17367 This option specifies the transport to be used when a router accepts an address
17368 and sets it up for delivery. A transport is never needed if a router is used
17369 only for verification. The value of the option is expanded at routing time,
17370 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17371 and result must be the name of one of the configured transports. If it is not,
17372 delivery is deferred.
17373
17374 The &%transport%& option is not used by the &(redirect)& router, but it does
17375 have some private options that set up transports for pipe and file deliveries
17376 (see chapter &<<CHAPredirect>>&).
17377
17378
17379
17380 .option transport_current_directory routers string&!! unset
17381 .cindex "current directory for local transport"
17382 This option associates a current directory with any address that is routed
17383 to a local transport. This can happen either because a transport is
17384 explicitly configured for the router, or because it generates a delivery to a
17385 file or a pipe. During the delivery process (that is, at transport time), this
17386 option string is expanded and is set as the current directory, unless
17387 overridden by a setting on the transport.
17388 If the expansion fails for any reason, including forced failure, an error is
17389 logged, and delivery is deferred.
17390 See chapter &<<CHAPenvironment>>& for details of the local delivery
17391 environment.
17392
17393
17394
17395
17396 .option transport_home_directory routers string&!! "see below"
17397 .cindex "home directory" "for local transport"
17398 This option associates a home directory with any address that is routed to a
17399 local transport. This can happen either because a transport is explicitly
17400 configured for the router, or because it generates a delivery to a file or a
17401 pipe. During the delivery process (that is, at transport time), the option
17402 string is expanded and is set as the home directory, unless overridden by a
17403 setting of &%home_directory%& on the transport.
17404 If the expansion fails for any reason, including forced failure, an error is
17405 logged, and delivery is deferred.
17406
17407 If the transport does not specify a home directory, and
17408 &%transport_home_directory%& is not set for the router, the home directory for
17409 the transport is taken from the password data if &%check_local_user%& is set for
17410 the router. Otherwise it is taken from &%router_home_directory%& if that option
17411 is set; if not, no home directory is set for the transport.
17412
17413 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17414 environment.
17415
17416
17417
17418
17419 .option unseen routers boolean&!! false
17420 .cindex "router" "carrying on after success"
17421 The result of string expansion for this option must be a valid boolean value,
17422 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17423 result causes an error, and delivery is deferred. If the expansion is forced to
17424 fail, the default value for the option (false) is used. Other failures cause
17425 delivery to be deferred.
17426
17427 When this option is set true, routing does not cease if the router accepts the
17428 address. Instead, a copy of the incoming address is passed to the next router,
17429 overriding a false setting of &%more%&. There is little point in setting
17430 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17431 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17432 sometimes true and sometimes false).
17433
17434 .cindex "copy of message (&%unseen%& option)"
17435 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17436 qualifier in filter files. It can be used to cause copies of messages to be
17437 delivered to some other destination, while also carrying out a normal delivery.
17438 In effect, the current address is made into a &"parent"& that has two children
17439 &-- one that is delivered as specified by this router, and a clone that goes on
17440 to be routed further. For this reason, &%unseen%& may not be combined with the
17441 &%one_time%& option in a &(redirect)& router.
17442
17443 &*Warning*&: Header lines added to the address (or specified for removal) by
17444 this router or by previous routers affect the &"unseen"& copy of the message
17445 only. The clone that continues to be processed by further routers starts with
17446 no added headers and none specified for removal. For a &%redirect%& router, if
17447 a generated address is the same as the incoming address, this can lead to
17448 duplicate addresses with different header modifications. Exim does not do
17449 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17450 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17451 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17452 &%redirect%& router may be of help.
17453
17454 Unlike the handling of header modifications, any data that was set by the
17455 &%address_data%& option in the current or previous routers &'is'& passed on to
17456 subsequent routers.
17457
17458
17459 .option user routers string&!! "see below"
17460 .cindex "uid (user id)" "local delivery"
17461 .cindex "local transports" "uid and gid"
17462 .cindex "transport" "local"
17463 .cindex "router" "user for filter processing"
17464 .cindex "filter" "user for processing"
17465 When a router queues an address for a transport, and the transport does not
17466 specify a user, the user given here is used when running the delivery process.
17467 The user may be specified numerically or by name. If expansion fails, the
17468 error is logged and delivery is deferred.
17469 This user is also used by the &(redirect)& router when running a filter file.
17470 The default is unset, except when &%check_local_user%& is set. In this case,
17471 the default is taken from the password information. If the user is specified as
17472 a name, and &%group%& is not set, the group associated with the user is used.
17473 See also &%initgroups%& and &%group%& and the discussion in chapter
17474 &<<CHAPenvironment>>&.
17475
17476
17477
17478 .option verify routers&!? boolean true
17479 Setting this option has the effect of setting &%verify_sender%& and
17480 &%verify_recipient%& to the same value.
17481
17482
17483 .option verify_only routers&!? boolean false
17484 .cindex "EXPN" "with &%verify_only%&"
17485 .oindex "&%-bv%&"
17486 .cindex "router" "used only when verifying"
17487 If this option is set, the router is used only when verifying an address,
17488 .new "delivering in cutthrough mode or"
17489 testing with the &%-bv%& option, not when actually doing a delivery, testing
17490 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17491 restricted to verifying only senders or recipients by means of
17492 &%verify_sender%& and &%verify_recipient%&.
17493
17494 &*Warning*&: When the router is being run to verify addresses for an incoming
17495 SMTP message, Exim is not running as root, but under its own uid. If the router
17496 accesses any files, you need to make sure that they are accessible to the Exim
17497 user or group.
17498
17499
17500 .option verify_recipient routers&!? boolean true
17501 If this option is false, the router is skipped when verifying recipient
17502 addresses,
17503 delivering in cutthrough mode
17504 or testing recipient verification using &%-bv%&.
17505 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17506 are evaluated.
17507
17508
17509 .option verify_sender routers&!? boolean true
17510 If this option is false, the router is skipped when verifying sender addresses
17511 or testing sender verification using &%-bvs%&.
17512 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17513 are evaluated.
17514 .ecindex IIDgenoprou1
17515 .ecindex IIDgenoprou2
17516
17517
17518
17519
17520
17521
17522 . ////////////////////////////////////////////////////////////////////////////
17523 . ////////////////////////////////////////////////////////////////////////////
17524
17525 .chapter "The accept router" "CHID4"
17526 .cindex "&(accept)& router"
17527 .cindex "routers" "&(accept)&"
17528 The &(accept)& router has no private options of its own. Unless it is being
17529 used purely for verification (see &%verify_only%&) a transport is required to
17530 be defined by the generic &%transport%& option. If the preconditions that are
17531 specified by generic options are met, the router accepts the address and queues
17532 it for the given transport. The most common use of this router is for setting
17533 up deliveries to local mailboxes. For example:
17534 .code
17535 localusers:
17536   driver = accept
17537   domains = mydomain.example
17538   check_local_user
17539   transport = local_delivery
17540 .endd
17541 The &%domains%& condition in this example checks the domain of the address, and
17542 &%check_local_user%& checks that the local part is the login of a local user.
17543 When both preconditions are met, the &(accept)& router runs, and queues the
17544 address for the &(local_delivery)& transport.
17545
17546
17547
17548
17549
17550
17551 . ////////////////////////////////////////////////////////////////////////////
17552 . ////////////////////////////////////////////////////////////////////////////
17553
17554 .chapter "The dnslookup router" "CHAPdnslookup"
17555 .scindex IIDdnsrou1 "&(dnslookup)& router"
17556 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17557 The &(dnslookup)& router looks up the hosts that handle mail for the
17558 recipient's domain in the DNS. A transport must always be set for this router,
17559 unless &%verify_only%& is set.
17560
17561 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17562 SRV records. If none are found, or if SRV support is not configured,
17563 MX records are looked up. If no MX records exist, address records are sought.
17564 However, &%mx_domains%& can be set to disable the direct use of address
17565 records.
17566
17567 MX records of equal priority are sorted by Exim into a random order. Exim then
17568 looks for address records for the host names obtained from MX or SRV records.
17569 When a host has more than one IP address, they are sorted into a random order,
17570 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17571 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17572 generic option, the router declines.
17573
17574 Unless they have the highest priority (lowest MX value), MX records that point
17575 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17576 are discarded, together with any other MX records of equal or lower priority.
17577
17578 .cindex "MX record" "pointing to local host"
17579 .cindex "local host" "MX pointing to"
17580 .oindex "&%self%&" "in &(dnslookup)& router"
17581 If the host pointed to by the highest priority MX record, or looked up as an
17582 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17583 happens is controlled by the generic &%self%& option.
17584
17585
17586 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17587 There have been problems with DNS servers when SRV records are looked up.
17588 Some mis-behaving servers return a DNS error or timeout when a non-existent
17589 SRV record is sought. Similar problems have in the past been reported for
17590 MX records. The global &%dns_again_means_nonexist%& option can help with this
17591 problem, but it is heavy-handed because it is a global option.
17592
17593 For this reason, there are two options, &%srv_fail_domains%& and
17594 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17595 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17596 an attempt to look up an SRV or MX record causes one of these results, and the
17597 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17598 such record"&. In the case of an SRV lookup, this means that the router
17599 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17600 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17601 case routing fails.
17602
17603
17604 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17605 .cindex "&(dnslookup)& router" "declines"
17606 There are a few cases where a &(dnslookup)& router will decline to accept
17607 an address; if such a router is expected to handle "all remaining non-local
17608 domains", then it is important to set &%no_more%&.
17609
17610 Reasons for a &(dnslookup)& router to decline currently include:
17611 .ilist
17612 The domain does not exist in DNS
17613 .next
17614 The domain exists but the MX record's host part is just "."; this is a common
17615 convention (borrowed from SRV) used to indicate that there is no such service
17616 for this domain and to not fall back to trying A/AAAA records.
17617 .next
17618 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17619 .next
17620 MX record points to a non-existent host.
17621 .next
17622 MX record points to an IP address and the main section option
17623 &%allow_mx_to_ip%& is not set.
17624 .next
17625 MX records exist and point to valid hosts, but all hosts resolve only to
17626 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17627 .next
17628 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17629 &%dns_check_names_pattern%& for handling one variant of this)
17630 .next
17631 &%check_secondary_mx%& is set on this router but the local host can
17632 not be found in the MX records (see below)
17633 .endlist
17634
17635
17636
17637
17638 .section "Private options for dnslookup" "SECID118"
17639 .cindex "options" "&(dnslookup)& router"
17640 The private options for the &(dnslookup)& router are as follows:
17641
17642 .option check_secondary_mx dnslookup boolean false
17643 .cindex "MX record" "checking for secondary"
17644 If this option is set, the router declines unless the local host is found in
17645 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17646 process domains for which the local host is a secondary mail exchanger
17647 differently to other domains. The way in which Exim decides whether a host is
17648 the local host is described in section &<<SECTreclocipadd>>&.
17649
17650
17651 .option check_srv dnslookup string&!! unset
17652 .cindex "SRV record" "enabling use of"
17653 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17654 addition to MX and address records. The support is disabled by default. To
17655 enable SRV support, set the &%check_srv%& option to the name of the service
17656 required. For example,
17657 .code
17658 check_srv = smtp
17659 .endd
17660 looks for SRV records that refer to the normal smtp service. The option is
17661 expanded, so the service name can vary from message to message or address
17662 to address. This might be helpful if SRV records are being used for a
17663 submission service. If the expansion is forced to fail, the &%check_srv%&
17664 option is ignored, and the router proceeds to look for MX records in the
17665 normal way.
17666
17667 When the expansion succeeds, the router searches first for SRV records for
17668 the given service (it assumes TCP protocol). A single SRV record with a
17669 host name that consists of just a single dot indicates &"no such service for
17670 this domain"&; if this is encountered, the router declines. If other kinds of
17671 SRV record are found, they are used to construct a host list for delivery
17672 according to the rules of RFC 2782. MX records are not sought in this case.
17673
17674 When no SRV records are found, MX records (and address records) are sought in
17675 the traditional way. In other words, SRV records take precedence over MX
17676 records, just as MX records take precedence over address records. Note that
17677 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17678 defined it. It is apparently believed that MX records are sufficient for email
17679 and that SRV records should not be used for this purpose. However, SRV records
17680 have an additional &"weight"& feature which some people might find useful when
17681 trying to split an SMTP load between hosts of different power.
17682
17683 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17684 when there is a DNS lookup error.
17685
17686
17687
17688 .option mx_domains dnslookup "domain list&!!" unset
17689 .cindex "MX record" "required to exist"
17690 .cindex "SRV record" "required to exist"
17691 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17692 record in order to be recognized. (The name of this option could be improved.)
17693 For example, if all the mail hosts in &'fict.example'& are known to have MX
17694 records, except for those in &'discworld.fict.example'&, you could use this
17695 setting:
17696 .code
17697 mx_domains = ! *.discworld.fict.example : *.fict.example
17698 .endd
17699 This specifies that messages addressed to a domain that matches the list but
17700 has no MX record should be bounced immediately instead of being routed using
17701 the address record.
17702
17703
17704 .option mx_fail_domains dnslookup "domain list&!!" unset
17705 If the DNS lookup for MX records for one of the domains in this list causes a
17706 DNS lookup error, Exim behaves as if no MX records were found. See section
17707 &<<SECTprowitdnsloo>>& for more discussion.
17708
17709
17710
17711
17712 .option qualify_single dnslookup boolean true
17713 .cindex "DNS" "resolver options"
17714 .cindex "DNS" "qualifying single-component names"
17715 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17716 lookups. Typically, but not standardly, this causes the resolver to qualify
17717 single-component names with the default domain. For example, on a machine
17718 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17719 &'thesaurus.ref.example'& inside the resolver. For details of what your
17720 resolver actually does, consult your man pages for &'resolver'& and
17721 &'resolv.conf'&.
17722
17723
17724
17725 .option rewrite_headers dnslookup boolean true
17726 .cindex "rewriting" "header lines"
17727 .cindex "header lines" "rewriting"
17728 If the domain name in the address that is being processed is not fully
17729 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17730 an address is specified as &'dormouse@teaparty'&, the domain might be
17731 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17732 occur as a result of setting the &%widen_domains%& option. If
17733 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17734 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17735 header lines of the message are rewritten with the full domain name.
17736
17737 This option should be turned off only when it is known that no message is
17738 ever going to be sent outside an environment where the abbreviation makes
17739 sense.
17740
17741 When an MX record is looked up in the DNS and matches a wildcard record, name
17742 servers normally return a record containing the name that has been looked up,
17743 making it impossible to detect whether a wildcard was present or not. However,
17744 some name servers have recently been seen to return the wildcard entry. If the
17745 name returned by a DNS lookup begins with an asterisk, it is not used for
17746 header rewriting.
17747
17748
17749 .option same_domain_copy_routing dnslookup boolean false
17750 .cindex "address" "copying routing"
17751 Addresses with the same domain are normally routed by the &(dnslookup)& router
17752 to the same list of hosts. However, this cannot be presumed, because the router
17753 options and preconditions may refer to the local part of the address. By
17754 default, therefore, Exim routes each address in a message independently. DNS
17755 servers run caches, so repeated DNS lookups are not normally expensive, and in
17756 any case, personal messages rarely have more than a few recipients.
17757
17758 If you are running mailing lists with large numbers of subscribers at the same
17759 domain, and you are using a &(dnslookup)& router which is independent of the
17760 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17761 lookups for identical domains in one message. In this case, when &(dnslookup)&
17762 routes an address to a remote transport, any other unrouted addresses in the
17763 message that have the same domain are automatically given the same routing
17764 without processing them independently,
17765 provided the following conditions are met:
17766
17767 .ilist
17768 No router that processed the address specified &%headers_add%& or
17769 &%headers_remove%&.
17770 .next
17771 The router did not change the address in any way, for example, by &"widening"&
17772 the domain.
17773 .endlist
17774
17775
17776
17777
17778 .option search_parents dnslookup boolean false
17779 .cindex "DNS" "resolver options"
17780 When this option is true, the resolver option RES_DNSRCH is set for DNS
17781 lookups. This is different from the &%qualify_single%& option in that it
17782 applies to domains containing dots. Typically, but not standardly, it causes
17783 the resolver to search for the name in the current domain and in parent
17784 domains. For example, on a machine in the &'fict.example'& domain, if looking
17785 up &'teaparty.wonderland'& failed, the resolver would try
17786 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17787 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17788
17789 Setting this option true can cause problems in domains that have a wildcard MX
17790 record, because any domain that does not have its own MX record matches the
17791 local wildcard.
17792
17793
17794
17795 .option srv_fail_domains dnslookup "domain list&!!" unset
17796 If the DNS lookup for SRV records for one of the domains in this list causes a
17797 DNS lookup error, Exim behaves as if no SRV records were found. See section
17798 &<<SECTprowitdnsloo>>& for more discussion.
17799
17800
17801
17802
17803 .option widen_domains dnslookup "string list" unset
17804 .cindex "domain" "partial; widening"
17805 If a DNS lookup fails and this option is set, each of its strings in turn is
17806 added onto the end of the domain, and the lookup is tried again. For example,
17807 if
17808 .code
17809 widen_domains = fict.example:ref.example
17810 .endd
17811 is set and a lookup of &'klingon.dictionary'& fails,
17812 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17813 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17814 and &%search_parents%& options can cause some widening to be undertaken inside
17815 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17816 when verifying, unless &%rewrite_headers%& is false (not the default).
17817
17818
17819 .section "Effect of qualify_single and search_parents" "SECID119"
17820 When a domain from an envelope recipient is changed by the resolver as a result
17821 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17822 corresponding address in the message's header lines unless &%rewrite_headers%&
17823 is set false. Exim then re-routes the address, using the full domain.
17824
17825 These two options affect only the DNS lookup that takes place inside the router
17826 for the domain of the address that is being routed. They do not affect lookups
17827 such as that implied by
17828 .code
17829 domains = @mx_any
17830 .endd
17831 that may happen while processing a router precondition before the router is
17832 entered. No widening ever takes place for these lookups.
17833 .ecindex IIDdnsrou1
17834 .ecindex IIDdnsrou2
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844 . ////////////////////////////////////////////////////////////////////////////
17845 . ////////////////////////////////////////////////////////////////////////////
17846
17847 .chapter "The ipliteral router" "CHID5"
17848 .cindex "&(ipliteral)& router"
17849 .cindex "domain literal" "routing"
17850 .cindex "routers" "&(ipliteral)&"
17851 This router has no private options. Unless it is being used purely for
17852 verification (see &%verify_only%&) a transport is required to be defined by the
17853 generic &%transport%& option. The router accepts the address if its domain part
17854 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17855 router handles the address
17856 .code
17857 root@[192.168.1.1]
17858 .endd
17859 by setting up delivery to the host with that IP address. IPv4 domain literals
17860 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17861 are similar, but the address is preceded by &`ipv6:`&. For example:
17862 .code
17863 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17864 .endd
17865 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17866 grounds that sooner or later somebody will try it.
17867
17868 .oindex "&%self%&" "in &(ipliteral)& router"
17869 If the IP address matches something in &%ignore_target_hosts%&, the router
17870 declines. If an IP literal turns out to refer to the local host, the generic
17871 &%self%& option determines what happens.
17872
17873 The RFCs require support for domain literals; however, their use is
17874 controversial in today's Internet. If you want to use this router, you must
17875 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17876 Exim will not recognize the domain literal syntax in addresses.
17877
17878
17879
17880 . ////////////////////////////////////////////////////////////////////////////
17881 . ////////////////////////////////////////////////////////////////////////////
17882
17883 .chapter "The iplookup router" "CHID6"
17884 .cindex "&(iplookup)& router"
17885 .cindex "routers" "&(iplookup)&"
17886 The &(iplookup)& router was written to fulfil a specific requirement in
17887 Cambridge University (which in fact no longer exists). For this reason, it is
17888 not included in the binary of Exim by default. If you want to include it, you
17889 must set
17890 .code
17891 ROUTER_IPLOOKUP=yes
17892 .endd
17893 in your &_Local/Makefile_& configuration file.
17894
17895 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17896 connection to one or more specific hosts. The host can then return the same or
17897 a different address &-- in effect rewriting the recipient address in the
17898 message's envelope. The new address is then passed on to subsequent routers. If
17899 this process fails, the address can be passed on to other routers, or delivery
17900 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17901 must not be specified for it.
17902
17903 .cindex "options" "&(iplookup)& router"
17904 .option hosts iplookup string unset
17905 This option must be supplied. Its value is a colon-separated list of host
17906 names. The hosts are looked up using &[gethostbyname()]&
17907 (or &[getipnodebyname()]& when available)
17908 and are tried in order until one responds to the query. If none respond, what
17909 happens is controlled by &%optional%&.
17910
17911
17912 .option optional iplookup boolean false
17913 If &%optional%& is true, if no response is obtained from any host, the address
17914 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17915 delivery to the address is deferred.
17916
17917
17918 .option port iplookup integer 0
17919 .cindex "port" "&(iplookup)& router"
17920 This option must be supplied. It specifies the port number for the TCP or UDP
17921 call.
17922
17923
17924 .option protocol iplookup string udp
17925 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17926 protocols is to be used.
17927
17928
17929 .option query iplookup string&!! "see below"
17930 This defines the content of the query that is sent to the remote hosts. The
17931 default value is:
17932 .code
17933 $local_part@$domain $local_part@$domain
17934 .endd
17935 The repetition serves as a way of checking that a response is to the correct
17936 query in the default case (see &%response_pattern%& below).
17937
17938
17939 .option reroute iplookup string&!! unset
17940 If this option is not set, the rerouted address is precisely the byte string
17941 returned by the remote host, up to the first white space, if any. If set, the
17942 string is expanded to form the rerouted address. It can include parts matched
17943 in the response by &%response_pattern%& by means of numeric variables such as
17944 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17945 whether or not a pattern is in use. In all cases, the rerouted address must end
17946 up in the form &'local_part@domain'&.
17947
17948
17949 .option response_pattern iplookup string unset
17950 This option can be set to a regular expression that is applied to the string
17951 returned from the remote host. If the pattern does not match the response, the
17952 router declines. If &%response_pattern%& is not set, no checking of the
17953 response is done, unless the query was defaulted, in which case there is a
17954 check that the text returned after the first white space is the original
17955 address. This checks that the answer that has been received is in response to
17956 the correct question. For example, if the response is just a new domain, the
17957 following could be used:
17958 .code
17959 response_pattern = ^([^@]+)$
17960 reroute = $local_part@$1
17961 .endd
17962
17963 .option timeout iplookup time 5s
17964 This specifies the amount of time to wait for a response from the remote
17965 machine. The same timeout is used for the &[connect()]& function for a TCP
17966 call. It does not apply to UDP.
17967
17968
17969
17970
17971 . ////////////////////////////////////////////////////////////////////////////
17972 . ////////////////////////////////////////////////////////////////////////////
17973
17974 .chapter "The manualroute router" "CHID7"
17975 .scindex IIDmanrou1 "&(manualroute)& router"
17976 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17977 .cindex "domain" "manually routing"
17978 The &(manualroute)& router is so-called because it provides a way of manually
17979 routing an address according to its domain. It is mainly used when you want to
17980 route addresses to remote hosts according to your own rules, bypassing the
17981 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17982 route to local transports, a facility that may be useful if you want to save
17983 messages for dial-in hosts in local files.
17984
17985 The &(manualroute)& router compares a list of domain patterns with the domain
17986 it is trying to route. If there is no match, the router declines. Each pattern
17987 has associated with it a list of hosts and some other optional data, which may
17988 include a transport. The combination of a pattern and its data is called a
17989 &"routing rule"&. For patterns that do not have an associated transport, the
17990 generic &%transport%& option must specify a transport, unless the router is
17991 being used purely for verification (see &%verify_only%&).
17992
17993 .vindex "&$host$&"
17994 In the case of verification, matching the domain pattern is sufficient for the
17995 router to accept the address. When actually routing an address for delivery,
17996 an address that matches a domain pattern is queued for the associated
17997 transport. If the transport is not a local one, a host list must be associated
17998 with the pattern; IP addresses are looked up for the hosts, and these are
17999 passed to the transport along with the mail address. For local transports, a
18000 host list is optional. If it is present, it is passed in &$host$& as a single
18001 text string.
18002
18003 The list of routing rules can be provided as an inline string in
18004 &%route_list%&, or the data can be obtained by looking up the domain in a file
18005 or database by setting &%route_data%&. Only one of these settings may appear in
18006 any one instance of &(manualroute)&. The format of routing rules is described
18007 below, following the list of private options.
18008
18009
18010 .section "Private options for manualroute" "SECTprioptman"
18011
18012 .cindex "options" "&(manualroute)& router"
18013 The private options for the &(manualroute)& router are as follows:
18014
18015 .option host_all_ignored manualroute string defer
18016 See &%host_find_failed%&.
18017
18018 .option host_find_failed manualroute string freeze
18019 This option controls what happens when &(manualroute)& tries to find an IP
18020 address for a host, and the host does not exist. The option can be set to one
18021 of the following values:
18022 .code
18023 decline
18024 defer
18025 fail
18026 freeze
18027 ignore
18028 pass
18029 .endd
18030 The default (&"freeze"&) assumes that this state is a serious configuration
18031 error. The difference between &"pass"& and &"decline"& is that the former
18032 forces the address to be passed to the next router (or the router defined by
18033 &%pass_router%&),
18034 .oindex "&%more%&"
18035 overriding &%no_more%&, whereas the latter passes the address to the next
18036 router only if &%more%& is true.
18037
18038 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18039 cannot be found. If all the hosts in the list are ignored, the behaviour is
18040 controlled by the &%host_all_ignored%& option. This takes the same values
18041 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18042
18043 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18044 state; if a host lookup gets a temporary error, delivery is deferred unless the
18045 generic &%pass_on_timeout%& option is set.
18046
18047
18048 .option hosts_randomize manualroute boolean false
18049 .cindex "randomized host list"
18050 .cindex "host" "list of; randomized"
18051 If this option is set, the order of the items in a host list in a routing rule
18052 is randomized each time the list is used, unless an option in the routing rule
18053 overrides (see below). Randomizing the order of a host list can be used to do
18054 crude load sharing. However, if more than one mail address is routed by the
18055 same router to the same host list, the host lists are considered to be the same
18056 (even though they may be randomized into different orders) for the purpose of
18057 deciding whether to batch the deliveries into a single SMTP transaction.
18058
18059 When &%hosts_randomize%& is true, a host list may be split
18060 into groups whose order is separately randomized. This makes it possible to
18061 set up MX-like behaviour. The boundaries between groups are indicated by an
18062 item that is just &`+`& in the host list. For example:
18063 .code
18064 route_list = * host1:host2:host3:+:host4:host5
18065 .endd
18066 The order of the first three hosts and the order of the last two hosts is
18067 randomized for each use, but the first three always end up before the last two.
18068 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18069 randomized host list is passed to an &(smtp)& transport that also has
18070 &%hosts_randomize set%&, the list is not re-randomized.
18071
18072
18073 .option route_data manualroute string&!! unset
18074 If this option is set, it must expand to yield the data part of a routing rule.
18075 Typically, the expansion string includes a lookup based on the domain. For
18076 example:
18077 .code
18078 route_data = ${lookup{$domain}dbm{/etc/routes}}
18079 .endd
18080 If the expansion is forced to fail, or the result is an empty string, the
18081 router declines. Other kinds of expansion failure cause delivery to be
18082 deferred.
18083
18084
18085 .option route_list manualroute "string list" unset
18086 This string is a list of routing rules, in the form defined below. Note that,
18087 unlike most string lists, the items are separated by semicolons. This is so
18088 that they may contain colon-separated host lists.
18089
18090
18091 .option same_domain_copy_routing manualroute boolean false
18092 .cindex "address" "copying routing"
18093 Addresses with the same domain are normally routed by the &(manualroute)&
18094 router to the same list of hosts. However, this cannot be presumed, because the
18095 router options and preconditions may refer to the local part of the address. By
18096 default, therefore, Exim routes each address in a message independently. DNS
18097 servers run caches, so repeated DNS lookups are not normally expensive, and in
18098 any case, personal messages rarely have more than a few recipients.
18099
18100 If you are running mailing lists with large numbers of subscribers at the same
18101 domain, and you are using a &(manualroute)& router which is independent of the
18102 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18103 lookups for identical domains in one message. In this case, when
18104 &(manualroute)& routes an address to a remote transport, any other unrouted
18105 addresses in the message that have the same domain are automatically given the
18106 same routing without processing them independently. However, this is only done
18107 if &%headers_add%& and &%headers_remove%& are unset.
18108
18109
18110
18111
18112 .section "Routing rules in route_list" "SECID120"
18113 The value of &%route_list%& is a string consisting of a sequence of routing
18114 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18115 entered as two semicolons. Alternatively, the list separator can be changed as
18116 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18117 Empty rules are ignored. The format of each rule is
18118 .display
18119 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18120 .endd
18121 The following example contains two rules, each with a simple domain pattern and
18122 no options:
18123 .code
18124 route_list = \
18125   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18126   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18127 .endd
18128 The three parts of a rule are separated by white space. The pattern and the
18129 list of hosts can be enclosed in quotes if necessary, and if they are, the
18130 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18131 single domain pattern, which is the only mandatory item in the rule. The
18132 pattern is in the same format as one item in a domain list (see section
18133 &<<SECTdomainlist>>&),
18134 except that it may not be the name of an interpolated file.
18135 That is, it may be wildcarded, or a regular expression, or a file or database
18136 lookup (with semicolons doubled, because of the use of semicolon as a separator
18137 in a &%route_list%&).
18138
18139 The rules in &%route_list%& are searched in order until one of the patterns
18140 matches the domain that is being routed. The list of hosts and then options are
18141 then used as described below. If there is no match, the router declines. When
18142 &%route_list%& is set, &%route_data%& must not be set.
18143
18144
18145
18146 .section "Routing rules in route_data" "SECID121"
18147 The use of &%route_list%& is convenient when there are only a small number of
18148 routing rules. For larger numbers, it is easier to use a file or database to
18149 hold the routing information, and use the &%route_data%& option instead.
18150 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18151 Most commonly, &%route_data%& is set as a string that contains an
18152 expansion lookup. For example, suppose we place two routing rules in a file
18153 like this:
18154 .code
18155 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18156 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18157 .endd
18158 This data can be accessed by setting
18159 .code
18160 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18161 .endd
18162 Failure of the lookup results in an empty string, causing the router to
18163 decline. However, you do not have to use a lookup in &%route_data%&. The only
18164 requirement is that the result of expanding the string is a list of hosts,
18165 possibly followed by options, separated by white space. The list of hosts must
18166 be enclosed in quotes if it contains white space.
18167
18168
18169
18170
18171 .section "Format of the list of hosts" "SECID122"
18172 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18173 always separately expanded before use. If the expansion fails, the router
18174 declines. The result of the expansion must be a colon-separated list of names
18175 and/or IP addresses, optionally also including ports. The format of each item
18176 in the list is described in the next section. The list separator can be changed
18177 as described in section &<<SECTlistconstruct>>&.
18178
18179 If the list of hosts was obtained from a &%route_list%& item, the following
18180 variables are set during its expansion:
18181
18182 .ilist
18183 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18184 If the domain was matched against a regular expression, the numeric variables
18185 &$1$&, &$2$&, etc. may be set. For example:
18186 .code
18187 route_list = ^domain(\d+)   host-$1.text.example
18188 .endd
18189 .next
18190 &$0$& is always set to the entire domain.
18191 .next
18192 &$1$& is also set when partial matching is done in a file lookup.
18193
18194 .next
18195 .vindex "&$value$&"
18196 If the pattern that matched the domain was a lookup item, the data that was
18197 looked up is available in the expansion variable &$value$&. For example:
18198 .code
18199 route_list = lsearch;;/some/file.routes  $value
18200 .endd
18201 .endlist
18202
18203 Note the doubling of the semicolon in the pattern that is necessary because
18204 semicolon is the default route list separator.
18205
18206
18207
18208 .section "Format of one host item" "SECTformatonehostitem"
18209 Each item in the list of hosts is either a host name or an IP address,
18210 optionally with an attached port number. When no port is given, an IP address
18211 is not enclosed in brackets. When a port is specified, it overrides the port
18212 specification on the transport. The port is separated from the name or address
18213 by a colon. This leads to some complications:
18214
18215 .ilist
18216 Because colon is the default separator for the list of hosts, either
18217 the colon that specifies a port must be doubled, or the list separator must
18218 be changed. The following two examples have the same effect:
18219 .code
18220 route_list = * "host1.tld::1225 : host2.tld::1226"
18221 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18222 .endd
18223 .next
18224 When IPv6 addresses are involved, it gets worse, because they contain
18225 colons of their own. To make this case easier, it is permitted to
18226 enclose an IP address (either v4 or v6) in square brackets if a port
18227 number follows. For example:
18228 .code
18229 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18230 .endd
18231 .endlist
18232
18233 .section "How the list of hosts is used" "SECThostshowused"
18234 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18235 the hosts is tried, in the order specified, when carrying out the SMTP
18236 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18237 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18238 transport.
18239
18240 Hosts may be listed by name or by IP address. An unadorned name in the list of
18241 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18242 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18243 records in the DNS. For example:
18244 .code
18245 route_list = *  x.y.z:p.q.r/MX:e.f.g
18246 .endd
18247 If this feature is used with a port specifier, the port must come last. For
18248 example:
18249 .code
18250 route_list = *  dom1.tld/mx::1225
18251 .endd
18252 If the &%hosts_randomize%& option is set, the order of the items in the list is
18253 randomized before any lookups are done. Exim then scans the list; for any name
18254 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18255 be an interface on the local host and the item is not the first in the list,
18256 Exim discards it and any subsequent items. If it is the first item, what
18257 happens is controlled by the
18258 .oindex "&%self%&" "in &(manualroute)& router"
18259 &%self%& option of the router.
18260
18261 A name on the list that is followed by &`/MX`& is replaced with the list of
18262 hosts obtained by looking up MX records for the name. This is always a DNS
18263 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18264 below) are not relevant here. The order of these hosts is determined by the
18265 preference values in the MX records, according to the usual rules. Because
18266 randomizing happens before the MX lookup, it does not affect the order that is
18267 defined by MX preferences.
18268
18269 If the local host is present in the sublist obtained from MX records, but is
18270 not the most preferred host in that list, it and any equally or less
18271 preferred hosts are removed before the sublist is inserted into the main list.
18272
18273 If the local host is the most preferred host in the MX list, what happens
18274 depends on where in the original list of hosts the &`/MX`& item appears. If it
18275 is not the first item (that is, there are previous hosts in the main list),
18276 Exim discards this name and any subsequent items in the main list.
18277
18278 If the MX item is first in the list of hosts, and the local host is the
18279 most preferred host, what happens is controlled by the &%self%& option of the
18280 router.
18281
18282 DNS failures when lookup up the MX records are treated in the same way as DNS
18283 failures when looking up IP addresses: &%pass_on_timeout%& and
18284 &%host_find_failed%& are used when relevant.
18285
18286 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18287 whether obtained from an MX lookup or not.
18288
18289
18290
18291 .section "How the options are used" "SECThowoptused"
18292 The options are a sequence of words; in practice no more than three are ever
18293 present. One of the words can be the name of a transport; this overrides the
18294 &%transport%& option on the router for this particular routing rule only. The
18295 other words (if present) control randomization of the list of hosts on a
18296 per-rule basis, and how the IP addresses of the hosts are to be found when
18297 routing to a remote transport. These options are as follows:
18298
18299 .ilist
18300 &%randomize%&: randomize the order of the hosts in this list, overriding the
18301 setting of &%hosts_randomize%& for this routing rule only.
18302 .next
18303 &%no_randomize%&: do not randomize the order of the hosts in this list,
18304 overriding the setting of &%hosts_randomize%& for this routing rule only.
18305 .next
18306 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18307 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18308 also look in &_/etc/hosts_& or other sources of information.
18309 .next
18310 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18311 no address records are found. If there is a temporary DNS error (such as a
18312 timeout), delivery is deferred.
18313 .endlist
18314
18315 For example:
18316 .code
18317 route_list = domain1  host1:host2:host3  randomize bydns;\
18318              domain2  host4:host5
18319 .endd
18320 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18321 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18322 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18323 or &[gethostbyname()]&, and the result of the lookup is the result of that
18324 call.
18325
18326 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18327 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18328 instead of TRY_AGAIN. That is why the default action is to try a DNS
18329 lookup first. Only if that gives a definite &"no such host"& is the local
18330 function called.
18331
18332
18333
18334 If no IP address for a host can be found, what happens is controlled by the
18335 &%host_find_failed%& option.
18336
18337 .vindex "&$host$&"
18338 When an address is routed to a local transport, IP addresses are not looked up.
18339 The host list is passed to the transport in the &$host$& variable.
18340
18341
18342
18343 .section "Manualroute examples" "SECID123"
18344 In some of the examples that follow, the presence of the &%remote_smtp%&
18345 transport, as defined in the default configuration file, is assumed:
18346
18347 .ilist
18348 .cindex "smart host" "example router"
18349 The &(manualroute)& router can be used to forward all external mail to a
18350 &'smart host'&. If you have set up, in the main part of the configuration, a
18351 named domain list that contains your local domains, for example:
18352 .code
18353 domainlist local_domains = my.domain.example
18354 .endd
18355 You can arrange for all other domains to be routed to a smart host by making
18356 your first router something like this:
18357 .code
18358 smart_route:
18359   driver = manualroute
18360   domains = !+local_domains
18361   transport = remote_smtp
18362   route_list = * smarthost.ref.example
18363 .endd
18364 This causes all non-local addresses to be sent to the single host
18365 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18366 they are tried in order
18367 (but you can use &%hosts_randomize%& to vary the order each time).
18368 Another way of configuring the same thing is this:
18369 .code
18370 smart_route:
18371   driver = manualroute
18372   transport = remote_smtp
18373   route_list = !+local_domains  smarthost.ref.example
18374 .endd
18375 There is no difference in behaviour between these two routers as they stand.
18376 However, they behave differently if &%no_more%& is added to them. In the first
18377 example, the router is skipped if the domain does not match the &%domains%&
18378 precondition; the following router is always tried. If the router runs, it
18379 always matches the domain and so can never decline. Therefore, &%no_more%&
18380 would have no effect. In the second case, the router is never skipped; it
18381 always runs. However, if it doesn't match the domain, it declines. In this case
18382 &%no_more%& would prevent subsequent routers from running.
18383
18384 .next
18385 .cindex "mail hub example"
18386 A &'mail hub'& is a host which receives mail for a number of domains via MX
18387 records in the DNS and delivers it via its own private routing mechanism. Often
18388 the final destinations are behind a firewall, with the mail hub being the one
18389 machine that can connect to machines both inside and outside the firewall. The
18390 &(manualroute)& router is usually used on a mail hub to route incoming messages
18391 to the correct hosts. For a small number of domains, the routing can be inline,
18392 using the &%route_list%& option, but for a larger number a file or database
18393 lookup is easier to manage.
18394
18395 If the domain names are in fact the names of the machines to which the mail is
18396 to be sent by the mail hub, the configuration can be quite simple. For
18397 example:
18398 .code
18399 hub_route:
18400   driver = manualroute
18401   transport = remote_smtp
18402   route_list = *.rhodes.tvs.example  $domain
18403 .endd
18404 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18405 whose names are the same as the mail domains. A similar approach can be taken
18406 if the host name can be obtained from the domain name by a string manipulation
18407 that the expansion facilities can handle. Otherwise, a lookup based on the
18408 domain can be used to find the host:
18409 .code
18410 through_firewall:
18411   driver = manualroute
18412   transport = remote_smtp
18413   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18414 .endd
18415 The result of the lookup must be the name or IP address of the host (or
18416 hosts) to which the address is to be routed. If the lookup fails, the route
18417 data is empty, causing the router to decline. The address then passes to the
18418 next router.
18419
18420 .next
18421 .cindex "batched SMTP output example"
18422 .cindex "SMTP" "batched outgoing; example"
18423 You can use &(manualroute)& to deliver messages to pipes or files in batched
18424 SMTP format for onward transportation by some other means. This is one way of
18425 storing mail for a dial-up host when it is not connected. The route list entry
18426 can be as simple as a single domain name in a configuration like this:
18427 .code
18428 save_in_file:
18429   driver = manualroute
18430   transport = batchsmtp_appendfile
18431   route_list = saved.domain.example
18432 .endd
18433 though often a pattern is used to pick up more than one domain. If there are
18434 several domains or groups of domains with different transport requirements,
18435 different transports can be listed in the routing information:
18436 .code
18437 save_in_file:
18438   driver = manualroute
18439   route_list = \
18440     *.saved.domain1.example  $domain  batch_appendfile; \
18441     *.saved.domain2.example  \
18442       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18443       batch_pipe
18444 .endd
18445 .vindex "&$domain$&"
18446 .vindex "&$host$&"
18447 The first of these just passes the domain in the &$host$& variable, which
18448 doesn't achieve much (since it is also in &$domain$&), but the second does a
18449 file lookup to find a value to pass, causing the router to decline to handle
18450 the address if the lookup fails.
18451
18452 .next
18453 .cindex "UUCP" "example of router for"
18454 Routing mail directly to UUCP software is a specific case of the use of
18455 &(manualroute)& in a gateway to another mail environment. This is an example of
18456 one way it can be done:
18457 .code
18458 # Transport
18459 uucp:
18460   driver = pipe
18461   user = nobody
18462   command = /usr/local/bin/uux -r - \
18463     ${substr_-5:$host}!rmail ${local_part}
18464   return_fail_output = true
18465
18466 # Router
18467 uucphost:
18468   transport = uucp
18469   driver = manualroute
18470   route_data = \
18471     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18472 .endd
18473 The file &_/usr/local/exim/uucphosts_& contains entries like
18474 .code
18475 darksite.ethereal.example:           darksite.UUCP
18476 .endd
18477 It can be set up more simply without adding and removing &".UUCP"& but this way
18478 makes clear the distinction between the domain name
18479 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18480 .endlist
18481 .ecindex IIDmanrou1
18482 .ecindex IIDmanrou2
18483
18484
18485
18486
18487
18488
18489
18490
18491 . ////////////////////////////////////////////////////////////////////////////
18492 . ////////////////////////////////////////////////////////////////////////////
18493
18494 .chapter "The queryprogram router" "CHAPdriverlast"
18495 .scindex IIDquerou1 "&(queryprogram)& router"
18496 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18497 .cindex "routing" "by external program"
18498 The &(queryprogram)& router routes an address by running an external command
18499 and acting on its output. This is an expensive way to route, and is intended
18500 mainly for use in lightly-loaded systems, or for performing experiments.
18501 However, if it is possible to use the precondition options (&%domains%&,
18502 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18503 be used in special cases, even on a busy host. There are the following private
18504 options:
18505 .cindex "options" "&(queryprogram)& router"
18506
18507 .option command queryprogram string&!! unset
18508 This option must be set. It specifies the command that is to be run. The
18509 command is split up into a command name and arguments, and then each is
18510 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18511 &<<CHAPpipetransport>>&).
18512
18513
18514 .option command_group queryprogram string unset
18515 .cindex "gid (group id)" "in &(queryprogram)& router"
18516 This option specifies a gid to be set when running the command while routing an
18517 address for deliver. It must be set if &%command_user%& specifies a numerical
18518 uid. If it begins with a digit, it is interpreted as the numerical value of the
18519 gid. Otherwise it is looked up using &[getgrnam()]&.
18520
18521
18522 .option command_user queryprogram string unset
18523 .cindex "uid (user id)" "for &(queryprogram)&"
18524 This option must be set. It specifies the uid which is set when running the
18525 command while routing an address for delivery. If the value begins with a digit,
18526 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18527 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18528 not set, a value for the gid also.
18529
18530 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18531 root, which it does during a normal delivery in a conventional configuration.
18532 However, when an address is being verified during message reception, Exim is
18533 usually running as the Exim user, not as root. If the &(queryprogram)& router
18534 is called from a non-root process, Exim cannot change uid or gid before running
18535 the command. In this circumstance the command runs under the current uid and
18536 gid.
18537
18538
18539 .option current_directory queryprogram string /
18540 This option specifies an absolute path which is made the current directory
18541 before running the command.
18542
18543
18544 .option timeout queryprogram time 1h
18545 If the command does not complete within the timeout period, its process group
18546 is killed and the message is frozen. A value of zero time specifies no
18547 timeout.
18548
18549
18550 The standard output of the command is connected to a pipe, which is read when
18551 the command terminates. It should consist of a single line of output,
18552 containing up to five fields, separated by white space. The maximum length of
18553 the line is 1023 characters. Longer lines are silently truncated. The first
18554 field is one of the following words (case-insensitive):
18555
18556 .ilist
18557 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18558 below).
18559 .next
18560 &'Decline'&: the router declines; pass the address to the next router, unless
18561 &%no_more%& is set.
18562 .next
18563 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18564 subsequent text on the line is an error message. If the router is run as part
18565 of address verification during an incoming SMTP message, the message is
18566 included in the SMTP response.
18567 .next
18568 &'Defer'&: routing could not be completed at this time; try again later. Any
18569 subsequent text on the line is an error message which is logged. It is not
18570 included in any SMTP response.
18571 .next
18572 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18573 .next
18574 &'Pass'&: pass the address to the next router (or the router specified by
18575 &%pass_router%&), overriding &%no_more%&.
18576 .next
18577 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18578 new addresses, which are routed independently, starting with the first router,
18579 or the router specified by &%redirect_router%&, if set.
18580 .endlist
18581
18582 When the first word is &'accept'&, the remainder of the line consists of a
18583 number of keyed data values, as follows (split into two lines here, to fit on
18584 the page):
18585 .code
18586 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18587 LOOKUP=byname|bydns DATA=<text>
18588 .endd
18589 The data items can be given in any order, and all are optional. If no transport
18590 is included, the transport specified by the generic &%transport%& option is
18591 used. The list of hosts and the lookup type are needed only if the transport is
18592 an &(smtp)& transport that does not itself supply a list of hosts.
18593
18594 The format of the list of hosts is the same as for the &(manualroute)& router.
18595 As well as host names and IP addresses with optional port numbers, as described
18596 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18597 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18598 (see section &<<SECThostshowused>>&).
18599
18600 If the lookup type is not specified, Exim behaves as follows when trying to
18601 find an IP address for each host: First, a DNS lookup is done. If this yields
18602 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18603 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18604 result of the lookup is the result of that call.
18605
18606 .vindex "&$address_data$&"
18607 If the DATA field is set, its value is placed in the &$address_data$&
18608 variable. For example, this return line
18609 .code
18610 accept hosts=x1.y.example:x2.y.example data="rule1"
18611 .endd
18612 routes the address to the default transport, passing a list of two hosts. When
18613 the transport runs, the string &"rule1"& is in &$address_data$&.
18614 .ecindex IIDquerou1
18615 .ecindex IIDquerou2
18616
18617
18618
18619
18620 . ////////////////////////////////////////////////////////////////////////////
18621 . ////////////////////////////////////////////////////////////////////////////
18622
18623 .chapter "The redirect router" "CHAPredirect"
18624 .scindex IIDredrou1 "&(redirect)& router"
18625 .scindex IIDredrou2 "routers" "&(redirect)&"
18626 .cindex "alias file" "in a &(redirect)& router"
18627 .cindex "address redirection" "&(redirect)& router"
18628 The &(redirect)& router handles several kinds of address redirection. Its most
18629 common uses are for resolving local part aliases from a central alias file
18630 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18631 files, but it has many other potential uses. The incoming address can be
18632 redirected in several different ways:
18633
18634 .ilist
18635 It can be replaced by one or more new addresses which are themselves routed
18636 independently.
18637 .next
18638 It can be routed to be delivered to a given file or directory.
18639 .next
18640 It can be routed to be delivered to a specified pipe command.
18641 .next
18642 It can cause an automatic reply to be generated.
18643 .next
18644 It can be forced to fail, optionally with a custom error message.
18645 .next
18646 It can be temporarily deferred, optionally with a custom message.
18647 .next
18648 It can be discarded.
18649 .endlist
18650
18651 The generic &%transport%& option must not be set for &(redirect)& routers.
18652 However, there are some private options which define transports for delivery to
18653 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18654 &%pipe_transport%& and &%reply_transport%& descriptions below.
18655
18656
18657
18658 .section "Redirection data" "SECID124"
18659 The router operates by interpreting a text string which it obtains either by
18660 expanding the contents of the &%data%& option, or by reading the entire
18661 contents of a file whose name is given in the &%file%& option. These two
18662 options are mutually exclusive. The first is commonly used for handling system
18663 aliases, in a configuration like this:
18664 .code
18665 system_aliases:
18666   driver = redirect
18667   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18668 .endd
18669 If the lookup fails, the expanded string in this example is empty. When the
18670 expansion of &%data%& results in an empty string, the router declines. A forced
18671 expansion failure also causes the router to decline; other expansion failures
18672 cause delivery to be deferred.
18673
18674 A configuration using &%file%& is commonly used for handling users'
18675 &_.forward_& files, like this:
18676 .code
18677 userforward:
18678   driver = redirect
18679   check_local_user
18680   file = $home/.forward
18681   no_verify
18682 .endd
18683 If the file does not exist, or causes no action to be taken (for example, it is
18684 empty or consists only of comments), the router declines. &*Warning*&: This
18685 is not the case when the file contains syntactically valid items that happen to
18686 yield empty addresses, for example, items containing only RFC 2822 address
18687 comments.
18688
18689
18690
18691 .section "Forward files and address verification" "SECID125"
18692 .cindex "address redirection" "while verifying"
18693 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18694 &_.forward_& files, as in the example above. There are two reasons for this:
18695
18696 .ilist
18697 When Exim is receiving an incoming SMTP message from a remote host, it is
18698 running under the Exim uid, not as root. Exim is unable to change uid to read
18699 the file as the user, and it may not be able to read it as the Exim user. So in
18700 practice the router may not be able to operate.
18701 .next
18702 However, even when the router can operate, the existence of a &_.forward_& file
18703 is unimportant when verifying an address. What should be checked is whether the
18704 local part is a valid user name or not. Cutting out the redirection processing
18705 saves some resources.
18706 .endlist
18707
18708
18709
18710
18711
18712
18713 .section "Interpreting redirection data" "SECID126"
18714 .cindex "Sieve filter" "specifying in redirection data"
18715 .cindex "filter" "specifying in redirection data"
18716 The contents of the data string, whether obtained from &%data%& or &%file%&,
18717 can be interpreted in two different ways:
18718
18719 .ilist
18720 If the &%allow_filter%& option is set true, and the data begins with the text
18721 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18722 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18723 respectively. Details of the syntax and semantics of filter files are described
18724 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18725 document is intended for use by end users.
18726 .next
18727 Otherwise, the data must be a comma-separated list of redirection items, as
18728 described in the next section.
18729 .endlist
18730
18731 When a message is redirected to a file (a &"mail folder"&), the file name given
18732 in a non-filter redirection list must always be an absolute path. A filter may
18733 generate a relative path &-- how this is handled depends on the transport's
18734 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18735 for the &(appendfile)& transport.
18736
18737
18738
18739 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18740 .cindex "address redirection" "non-filter list items"
18741 When the redirection data is not an Exim or Sieve filter, for example, if it
18742 comes from a conventional alias or forward file, it consists of a list of
18743 addresses, file names, pipe commands, or certain special items (see section
18744 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18745 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18746 depending on their default values. The items in the list are separated by
18747 commas or newlines.
18748 If a comma is required in an item, the entire item must be enclosed in double
18749 quotes.
18750
18751 Lines starting with a # character are comments, and are ignored, and # may
18752 also appear following a comma, in which case everything between the # and the
18753 next newline character is ignored.
18754
18755 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18756 double quotes are retained because some forms of mail address require their use
18757 (but never to enclose the entire address). In the following description,
18758 &"item"& refers to what remains after any surrounding double quotes have been
18759 removed.
18760
18761 .vindex "&$local_part$&"
18762 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18763 and the expansion contains a reference to &$local_part$&, you should make use
18764 of the &%quote_local_part%& expansion operator, in case the local part contains
18765 special characters. For example, to redirect all mail for the domain
18766 &'obsolete.example'&, retaining the existing local part, you could use this
18767 setting:
18768 .code
18769 data = ${quote_local_part:$local_part}@newdomain.example
18770 .endd
18771
18772
18773 .section "Redirecting to a local mailbox" "SECTredlocmai"
18774 .cindex "routing" "loops in"
18775 .cindex "loop" "while routing, avoidance of"
18776 .cindex "address redirection" "to local mailbox"
18777 A redirection item may safely be the same as the address currently under
18778 consideration. This does not cause a routing loop, because a router is
18779 automatically skipped if any ancestor of the address that is being processed
18780 is the same as the current address and was processed by the current router.
18781 Such an address is therefore passed to the following routers, so it is handled
18782 as if there were no redirection. When making this loop-avoidance test, the
18783 complete local part, including any prefix or suffix, is used.
18784
18785 .cindex "address redirection" "local part without domain"
18786 Specifying the same local part without a domain is a common usage in personal
18787 filter files when the user wants to have messages delivered to the local
18788 mailbox and also forwarded elsewhere. For example, the user whose login is
18789 &'cleo'& might have a &_.forward_& file containing this:
18790 .code
18791 cleo, cleopatra@egypt.example
18792 .endd
18793 .cindex "backslash in alias file"
18794 .cindex "alias file" "backslash in"
18795 For compatibility with other MTAs, such unqualified local parts may be
18796 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18797 it does make a difference if more than one domain is being handled
18798 synonymously.
18799
18800 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18801 2822 address that does not include a domain, the item is qualified using the
18802 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18803 addresses are qualified using the value in &%qualify_recipient%&, but you can
18804 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18805
18806 Care must be taken if there are alias names for local users.
18807 Consider an MTA handling a single local domain where the system alias file
18808 contains:
18809 .code
18810 Sam.Reman: spqr
18811 .endd
18812 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18813 messages in the local mailbox, and also forward copies elsewhere. He creates
18814 this forward file:
18815 .code
18816 Sam.Reman, spqr@reme.elsewhere.example
18817 .endd
18818 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18819 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18820 second time round, because it has previously routed it,
18821 and the following routers presumably cannot handle the alias. The forward file
18822 should really contain
18823 .code
18824 spqr, spqr@reme.elsewhere.example
18825 .endd
18826 but because this is such a common error, the &%check_ancestor%& option (see
18827 below) exists to provide a way to get round it. This is normally set on a
18828 &(redirect)& router that is handling users' &_.forward_& files.
18829
18830
18831
18832 .section "Special items in redirection lists" "SECTspecitredli"
18833 In addition to addresses, the following types of item may appear in redirection
18834 lists (that is, in non-filter redirection data):
18835
18836 .ilist
18837 .cindex "pipe" "in redirection list"
18838 .cindex "address redirection" "to pipe"
18839 An item is treated as a pipe command if it begins with &"|"& and does not parse
18840 as a valid RFC 2822 address that includes a domain. A transport for running the
18841 command must be specified by the &%pipe_transport%& option.
18842 Normally, either the router or the transport specifies a user and a group under
18843 which to run the delivery. The default is to use the Exim user and group.
18844
18845 Single or double quotes can be used for enclosing the individual arguments of
18846 the pipe command; no interpretation of escapes is done for single quotes. If
18847 the command contains a comma character, it is necessary to put the whole item
18848 in double quotes, for example:
18849 .code
18850 "|/some/command ready,steady,go"
18851 .endd
18852 since items in redirection lists are terminated by commas. Do not, however,
18853 quote just the command. An item such as
18854 .code
18855 |"/some/command ready,steady,go"
18856 .endd
18857 is interpreted as a pipe with a rather strange command name, and no arguments.
18858
18859 .new
18860 Note that the above example assumes that the text comes from a lookup source
18861 of some sort, so that the quotes are part of the data.  If composing a
18862 redirect router with a &%data%& option directly specifying this command, the
18863 quotes will be used by the configuration parser to define the extent of one
18864 string, but will not be passed down into the redirect router itself.  There
18865 are two main approaches to get around this: escape quotes to be part of the
18866 data itself, or avoid using this mechanism and instead create a custom
18867 transport with the &%command%& option set and reference that transport from
18868 an &%accept%& router.
18869 .wen
18870
18871 .next
18872 .cindex "file" "in redirection list"
18873 .cindex "address redirection" "to file"
18874 An item is interpreted as a path name if it begins with &"/"& and does not
18875 parse as a valid RFC 2822 address that includes a domain. For example,
18876 .code
18877 /home/world/minbari
18878 .endd
18879 is treated as a file name, but
18880 .code
18881 /s=molari/o=babylon/@x400gate.way
18882 .endd
18883 is treated as an address. For a file name, a transport must be specified using
18884 the &%file_transport%& option. However, if the generated path name ends with a
18885 forward slash character, it is interpreted as a directory name rather than a
18886 file name, and &%directory_transport%& is used instead.
18887
18888 Normally, either the router or the transport specifies a user and a group under
18889 which to run the delivery. The default is to use the Exim user and group.
18890
18891 .cindex "&_/dev/null_&"
18892 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18893 bypassed at a high level, and the log entry shows &"**bypassed**"&
18894 instead of a transport name. In this case the user and group are not used.
18895
18896 .next
18897 .cindex "included address list"
18898 .cindex "address redirection" "included external list"
18899 If an item is of the form
18900 .code
18901 :include:<path name>
18902 .endd
18903 a list of further items is taken from the given file and included at that
18904 point. &*Note*&: Such a file can not be a filter file; it is just an
18905 out-of-line addition to the list. The items in the included list are separated
18906 by commas or newlines and are not subject to expansion. If this is the first
18907 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18908 the alias name. This example is incorrect:
18909 .code
18910 list1    :include:/opt/lists/list1
18911 .endd
18912 It must be given as
18913 .code
18914 list1:   :include:/opt/lists/list1
18915 .endd
18916 .next
18917 .cindex "address redirection" "to black hole"
18918 Sometimes you want to throw away mail to a particular local part. Making the
18919 &%data%& option expand to an empty string does not work, because that causes
18920 the router to decline. Instead, the alias item
18921 .cindex "black hole"
18922 .cindex "abandoning mail"
18923 &':blackhole:'& can be used. It does what its name implies. No delivery is
18924 done, and no error message is generated. This has the same effect as specifing
18925 &_/dev/null_& as a destination, but it can be independently disabled.
18926
18927 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18928 delivery is done for the original local part, even if other redirection items
18929 are present. If you are generating a multi-item list (for example, by reading a
18930 database) and need the ability to provide a no-op item, you must use
18931 &_/dev/null_&.
18932
18933 .next
18934 .cindex "delivery" "forcing failure"
18935 .cindex "delivery" "forcing deferral"
18936 .cindex "failing delivery" "forcing"
18937 .cindex "deferred delivery, forcing"
18938 .cindex "customizing" "failure message"
18939 An attempt to deliver a particular address can be deferred or forced to fail by
18940 redirection items of the form
18941 .code
18942 :defer:
18943 :fail:
18944 .endd
18945 respectively. When a redirection list contains such an item, it applies
18946 to the entire redirection; any other items in the list are ignored. Any
18947 text following &':fail:'& or &':defer:'& is placed in the error text
18948 associated with the failure. For example, an alias file might contain:
18949 .code
18950 X.Employee:  :fail: Gone away, no forwarding address
18951 .endd
18952 In the case of an address that is being verified from an ACL or as the subject
18953 of a
18954 .cindex "VRFY" "error text, display of"
18955 VRFY command, the text is included in the SMTP error response by
18956 default.
18957 .cindex "EXPN" "error text, display of"
18958 The text is not included in the response to an EXPN command. In non-SMTP cases
18959 the text is included in the error message that Exim generates.
18960
18961 .cindex "SMTP" "error codes"
18962 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18963 &':fail:'&. However, if the message starts with three digits followed by a
18964 space, optionally followed by an extended code of the form &'n.n.n'&, also
18965 followed by a space, and the very first digit is the same as the default error
18966 code, the code from the message is used instead. If the very first digit is
18967 incorrect, a panic error is logged, and the default code is used. You can
18968 suppress the use of the supplied code in a redirect router by setting the
18969 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18970 ignored.
18971
18972 .vindex "&$acl_verify_message$&"
18973 In an ACL, an explicitly provided message overrides the default, but the
18974 default message is available in the variable &$acl_verify_message$& and can
18975 therefore be included in a custom message if this is desired.
18976
18977 Normally the error text is the rest of the redirection list &-- a comma does
18978 not terminate it &-- but a newline does act as a terminator. Newlines are not
18979 normally present in alias expansions. In &(lsearch)& lookups they are removed
18980 as part of the continuation process, but they may exist in other kinds of
18981 lookup and in &':include:'& files.
18982
18983 During routing for message delivery (as opposed to verification), a redirection
18984 containing &':fail:'& causes an immediate failure of the incoming address,
18985 whereas &':defer:'& causes the message to remain on the queue so that a
18986 subsequent delivery attempt can happen at a later time. If an address is
18987 deferred for too long, it will ultimately fail, because the normal retry
18988 rules still apply.
18989
18990 .next
18991 .cindex "alias file" "exception to default"
18992 Sometimes it is useful to use a single-key search type with a default (see
18993 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18994 for exceptions to the default. These can be handled by aliasing them to
18995 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18996 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18997 results in an empty redirection list has the same effect.
18998 .endlist
18999
19000
19001 .section "Duplicate addresses" "SECTdupaddr"
19002 .cindex "duplicate addresses"
19003 .cindex "address duplicate, discarding"
19004 .cindex "pipe" "duplicated"
19005 Exim removes duplicate addresses from the list to which it is delivering, so as
19006 to deliver just one copy to each address. This does not apply to deliveries
19007 routed to pipes by different immediate parent addresses, but an indirect
19008 aliasing scheme of the type
19009 .code
19010 pipe:       |/some/command $local_part
19011 localpart1: pipe
19012 localpart2: pipe
19013 .endd
19014 does not work with a message that is addressed to both local parts, because
19015 when the second is aliased to the intermediate local part &"pipe"& it gets
19016 discarded as being the same as a previously handled address. However, a scheme
19017 such as
19018 .code
19019 localpart1: |/some/command $local_part
19020 localpart2: |/some/command $local_part
19021 .endd
19022 does result in two different pipe deliveries, because the immediate parents of
19023 the pipes are distinct.
19024
19025
19026
19027 .section "Repeated redirection expansion" "SECID128"
19028 .cindex "repeated redirection expansion"
19029 .cindex "address redirection" "repeated for each delivery attempt"
19030 When a message cannot be delivered to all of its recipients immediately,
19031 leading to two or more delivery attempts, redirection expansion is carried out
19032 afresh each time for those addresses whose children were not all previously
19033 delivered. If redirection is being used as a mailing list, this can lead to new
19034 members of the list receiving copies of old messages. The &%one_time%& option
19035 can be used to avoid this.
19036
19037
19038 .section "Errors in redirection lists" "SECID129"
19039 .cindex "address redirection" "errors"
19040 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19041 error is skipped, and an entry is written to the main log. This may be useful
19042 for mailing lists that are automatically managed. Otherwise, if an error is
19043 detected while generating the list of new addresses, the original address is
19044 deferred. See also &%syntax_errors_to%&.
19045
19046
19047
19048 .section "Private options for the redirect router" "SECID130"
19049
19050 .cindex "options" "&(redirect)& router"
19051 The private options for the &(redirect)& router are as follows:
19052
19053
19054 .option allow_defer redirect boolean false
19055 Setting this option allows the use of &':defer:'& in non-filter redirection
19056 data, or the &%defer%& command in an Exim filter file.
19057
19058
19059 .option allow_fail redirect boolean false
19060 .cindex "failing delivery" "from filter"
19061 If this option is true, the &':fail:'& item can be used in a redirection list,
19062 and the &%fail%& command may be used in an Exim filter file.
19063
19064
19065 .option allow_filter redirect boolean false
19066 .cindex "filter" "enabling use of"
19067 .cindex "Sieve filter" "enabling use of"
19068 Setting this option allows Exim to interpret redirection data that starts with
19069 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19070 are some features of Exim filter files that some administrators may wish to
19071 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19072
19073 It is also possible to lock out Exim filters or Sieve filters while allowing
19074 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19075
19076
19077 The filter is run using the uid and gid set by the generic &%user%& and
19078 &%group%& options. These take their defaults from the password data if
19079 &%check_local_user%& is set, so in the normal case of users' personal filter
19080 files, the filter is run as the relevant user. When &%allow_filter%& is set
19081 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19082
19083
19084
19085 .option allow_freeze redirect boolean false
19086 .cindex "freezing messages" "allowing in filter"
19087 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19088 This command is more normally encountered in system filters, and is disabled by
19089 default for redirection filters because it isn't something you usually want to
19090 let ordinary users do.
19091
19092
19093
19094 .option check_ancestor redirect boolean false
19095 This option is concerned with handling generated addresses that are the same
19096 as some address in the list of redirection ancestors of the current address.
19097 Although it is turned off by default in the code, it is set in the default
19098 configuration file for handling users' &_.forward_& files. It is recommended
19099 for this use of the &(redirect)& router.
19100
19101 When &%check_ancestor%& is set, if a generated address (including the domain)
19102 is the same as any ancestor of the current address, it is replaced by a copy of
19103 the current address. This helps in the case where local part A is aliased to B,
19104 and B has a &_.forward_& file pointing back to A. For example, within a single
19105 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19106 &_&~jb/.forward_& contains:
19107 .code
19108 \Joe.Bloggs, <other item(s)>
19109 .endd
19110 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19111 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19112 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19113 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19114 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19115 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19116 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19117 original address. See also the &%repeat_use%& option below.
19118
19119
19120 .option check_group redirect boolean "see below"
19121 When the &%file%& option is used, the group owner of the file is checked only
19122 when this option is set. The permitted groups are those listed in the
19123 &%owngroups%& option, together with the user's default group if
19124 &%check_local_user%& is set. If the file has the wrong group, routing is
19125 deferred. The default setting for this option is true if &%check_local_user%&
19126 is set and the &%modemask%& option permits the group write bit, or if the
19127 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19128
19129
19130
19131 .option check_owner redirect boolean "see below"
19132 When the &%file%& option is used, the owner of the file is checked only when
19133 this option is set. If &%check_local_user%& is set, the local user is
19134 permitted; otherwise the owner must be one of those listed in the &%owners%&
19135 option. The default value for this option is true if &%check_local_user%& or
19136 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19137
19138
19139 .option data redirect string&!! unset
19140 This option is mutually exclusive with &%file%&. One or other of them must be
19141 set, but not both. The contents of &%data%& are expanded, and then used as the
19142 list of forwarding items, or as a set of filtering instructions. If the
19143 expansion is forced to fail, or the result is an empty string or a string that
19144 has no effect (consists entirely of comments), the router declines.
19145
19146 When filtering instructions are used, the string must begin with &"#Exim
19147 filter"&, and all comments in the string, including this initial one, must be
19148 terminated with newline characters. For example:
19149 .code
19150 data = #Exim filter\n\
19151        if $h_to: contains Exim then save $home/mail/exim endif
19152 .endd
19153 If you are reading the data from a database where newlines cannot be included,
19154 you can use the &${sg}$& expansion item to turn the escape string of your
19155 choice into a newline.
19156
19157
19158 .option directory_transport redirect string&!! unset
19159 A &(redirect)& router sets up a direct delivery to a directory when a path name
19160 ending with a slash is specified as a new &"address"&. The transport used is
19161 specified by this option, which, after expansion, must be the name of a
19162 configured transport. This should normally be an &(appendfile)& transport.
19163
19164
19165 .option file redirect string&!! unset
19166 This option specifies the name of a file that contains the redirection data. It
19167 is mutually exclusive with the &%data%& option. The string is expanded before
19168 use; if the expansion is forced to fail, the router declines. Other expansion
19169 failures cause delivery to be deferred. The result of a successful expansion
19170 must be an absolute path. The entire file is read and used as the redirection
19171 data. If the data is an empty string or a string that has no effect (consists
19172 entirely of comments), the router declines.
19173
19174 .cindex "NFS" "checking for file existence"
19175 If the attempt to open the file fails with a &"does not exist"& error, Exim
19176 runs a check on the containing directory,
19177 unless &%ignore_enotdir%& is true (see below).
19178 If the directory does not appear to exist, delivery is deferred. This can
19179 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19180 is a mount problem. If the containing directory does exist, but the file does
19181 not, the router declines.
19182
19183
19184 .option file_transport redirect string&!! unset
19185 .vindex "&$address_file$&"
19186 A &(redirect)& router sets up a direct delivery to a file when a path name not
19187 ending in a slash is specified as a new &"address"&. The transport used is
19188 specified by this option, which, after expansion, must be the name of a
19189 configured transport. This should normally be an &(appendfile)& transport. When
19190 it is running, the file name is in &$address_file$&.
19191
19192
19193 .option filter_prepend_home redirect boolean true
19194 When this option is true, if a &(save)& command in an Exim filter specifies a
19195 relative path, and &$home$& is defined, it is automatically prepended to the
19196 relative path. If this option is set false, this action does not happen. The
19197 relative path is then passed to the transport unmodified.
19198
19199
19200 .option forbid_blackhole redirect boolean false
19201 If this option is true, the &':blackhole:'& item may not appear in a
19202 redirection list.
19203
19204
19205 .option forbid_exim_filter redirect boolean false
19206 If this option is set true, only Sieve filters are permitted when
19207 &%allow_filter%& is true.
19208
19209
19210
19211
19212 .option forbid_file redirect boolean false
19213 .cindex "delivery" "to file; forbidding"
19214 .cindex "Sieve filter" "forbidding delivery to a file"
19215 .cindex "Sieve filter" "&""keep""& facility; disabling"
19216 If this option is true, this router may not generate a new address that
19217 specifies delivery to a local file or directory, either from a filter or from a
19218 conventional forward file. This option is forced to be true if &%one_time%& is
19219 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19220 locks out the Sieve's &"keep"& facility.
19221
19222
19223 .option forbid_filter_dlfunc redirect boolean false
19224 .cindex "filter" "locking out certain features"
19225 If this option is true, string expansions in Exim filters are not allowed to
19226 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19227 functions.
19228
19229 .option forbid_filter_existstest redirect boolean false
19230 .cindex "expansion" "statting a file"
19231 If this option is true, string expansions in Exim filters are not allowed to
19232 make use of the &%exists%& condition or the &%stat%& expansion item.
19233
19234 .option forbid_filter_logwrite redirect boolean false
19235 If this option is true, use of the logging facility in Exim filters is not
19236 permitted. Logging is in any case available only if the filter is being run
19237 under some unprivileged uid (which is normally the case for ordinary users'
19238 &_.forward_& files).
19239
19240
19241 .option forbid_filter_lookup redirect boolean false
19242 If this option is true, string expansions in Exim filter files are not allowed
19243 to make use of &%lookup%& items.
19244
19245
19246 .option forbid_filter_perl redirect boolean false
19247 This option has an effect only if Exim is built with embedded Perl support. If
19248 it is true, string expansions in Exim filter files are not allowed to make use
19249 of the embedded Perl support.
19250
19251
19252 .option forbid_filter_readfile redirect boolean false
19253 If this option is true, string expansions in Exim filter files are not allowed
19254 to make use of &%readfile%& items.
19255
19256
19257 .option forbid_filter_readsocket redirect boolean false
19258 If this option is true, string expansions in Exim filter files are not allowed
19259 to make use of &%readsocket%& items.
19260
19261
19262 .option forbid_filter_reply redirect boolean false
19263 If this option is true, this router may not generate an automatic reply
19264 message. Automatic replies can be generated only from Exim or Sieve filter
19265 files, not from traditional forward files. This option is forced to be true if
19266 &%one_time%& is set.
19267
19268
19269 .option forbid_filter_run redirect boolean false
19270 If this option is true, string expansions in Exim filter files are not allowed
19271 to make use of &%run%& items.
19272
19273
19274 .option forbid_include redirect boolean false
19275 If this option is true, items of the form
19276 .code
19277 :include:<path name>
19278 .endd
19279 are not permitted in non-filter redirection lists.
19280
19281
19282 .option forbid_pipe redirect boolean false
19283 .cindex "delivery" "to pipe; forbidding"
19284 If this option is true, this router may not generate a new address which
19285 specifies delivery to a pipe, either from an Exim filter or from a conventional
19286 forward file. This option is forced to be true if &%one_time%& is set.
19287
19288
19289 .option forbid_sieve_filter redirect boolean false
19290 If this option is set true, only Exim filters are permitted when
19291 &%allow_filter%& is true.
19292
19293
19294 .cindex "SMTP" "error codes"
19295 .option forbid_smtp_code redirect boolean false
19296 If this option is set true, any SMTP error codes that are present at the start
19297 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19298 the default codes (451 and 550, respectively) are always used.
19299
19300
19301
19302
19303 .option hide_child_in_errmsg redirect boolean false
19304 .cindex "bounce message" "redirection details; suppressing"
19305 If this option is true, it prevents Exim from quoting a child address if it
19306 generates a bounce or delay message for it. Instead it says &"an address
19307 generated from <&'the top level address'&>"&. Of course, this applies only to
19308 bounces generated locally. If a message is forwarded to another host, &'its'&
19309 bounce may well quote the generated address.
19310
19311
19312 .option ignore_eacces redirect boolean false
19313 .cindex "EACCES"
19314 If this option is set and an attempt to open a redirection file yields the
19315 EACCES error (permission denied), the &(redirect)& router behaves as if the
19316 file did not exist.
19317
19318
19319 .option ignore_enotdir redirect boolean false
19320 .cindex "ENOTDIR"
19321 If this option is set and an attempt to open a redirection file yields the
19322 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19323 router behaves as if the file did not exist.
19324
19325 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19326 router that has the &%file%& option set discovers that the file does not exist
19327 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19328 against unmounted NFS directories. If the parent can not be statted, delivery
19329 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19330 is set, because that option tells Exim to ignore &"something on the path is not
19331 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19332 that some operating systems give ENOENT where others give ENOTDIR.
19333
19334
19335
19336 .option include_directory redirect string unset
19337 If this option is set, the path names of any &':include:'& items in a
19338 redirection list must start with this directory.
19339
19340
19341 .option modemask redirect "octal integer" 022
19342 This specifies mode bits which must not be set for a file specified by the
19343 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19344
19345
19346 .option one_time redirect boolean false
19347 .cindex "one-time aliasing/forwarding expansion"
19348 .cindex "alias file" "one-time expansion"
19349 .cindex "forward file" "one-time expansion"
19350 .cindex "mailing lists" "one-time expansion"
19351 .cindex "address redirection" "one-time expansion"
19352 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19353 files each time it tries to deliver a message causes a problem when one or more
19354 of the generated addresses fails be delivered at the first attempt. The problem
19355 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19356 but of what happens when the redirection list changes during the time that the
19357 message is on Exim's queue. This is particularly true in the case of mailing
19358 lists, where new subscribers might receive copies of messages that were posted
19359 before they subscribed.
19360
19361 If &%one_time%& is set and any addresses generated by the router fail to
19362 deliver at the first attempt, the failing addresses are added to the message as
19363 &"top level"& addresses, and the parent address that generated them is marked
19364 &"delivered"&. Thus, redirection does not happen again at the next delivery
19365 attempt.
19366
19367 &*Warning 1*&: Any header line addition or removal that is specified by this
19368 router would be lost if delivery did not succeed at the first attempt. For this
19369 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19370 permitted when &%one_time%& is set.
19371
19372 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19373 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19374 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19375
19376 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19377 &%one_time%&.
19378
19379 The original top-level address is remembered with each of the generated
19380 addresses, and is output in any log messages. However, any intermediate parent
19381 addresses are not recorded. This makes a difference to the log only if
19382 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19383 typically be used for mailing lists, where there is normally just one level of
19384 expansion.
19385
19386
19387 .option owners redirect "string list" unset
19388 .cindex "ownership" "alias file"
19389 .cindex "ownership" "forward file"
19390 .cindex "alias file" "ownership"
19391 .cindex "forward file" "ownership"
19392 This specifies a list of permitted owners for the file specified by &%file%&.
19393 This list is in addition to the local user when &%check_local_user%& is set.
19394 See &%check_owner%& above.
19395
19396
19397 .option owngroups redirect "string list" unset
19398 This specifies a list of permitted groups for the file specified by &%file%&.
19399 The list is in addition to the local user's primary group when
19400 &%check_local_user%& is set. See &%check_group%& above.
19401
19402
19403 .option pipe_transport redirect string&!! unset
19404 .vindex "&$address_pipe$&"
19405 A &(redirect)& router sets up a direct delivery to a pipe when a string
19406 starting with a vertical bar character is specified as a new &"address"&. The
19407 transport used is specified by this option, which, after expansion, must be the
19408 name of a configured transport. This should normally be a &(pipe)& transport.
19409 When the transport is run, the pipe command is in &$address_pipe$&.
19410
19411
19412 .option qualify_domain redirect string&!! unset
19413 .vindex "&$qualify_recipient$&"
19414 If this option is set, and an unqualified address (one without a domain) is
19415 generated, and that address would normally be qualified by the global setting
19416 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19417 expanding this string. If the expansion fails, the router declines. If you want
19418 to revert to the default, you can have the expansion generate
19419 &$qualify_recipient$&.
19420
19421 This option applies to all unqualified addresses generated by Exim filters,
19422 but for traditional &_.forward_& files, it applies only to addresses that are
19423 not preceded by a backslash. Sieve filters cannot generate unqualified
19424 addresses.
19425
19426 .option qualify_preserve_domain redirect boolean false
19427 .cindex "domain" "in redirection; preserving"
19428 .cindex "preserving domain in redirection"
19429 .cindex "address redirection" "domain; preserving"
19430 If this option is set, the router's local &%qualify_domain%& option must not be
19431 set (a configuration error occurs if it is). If an unqualified address (one
19432 without a domain) is generated, it is qualified with the domain of the parent
19433 address (the immediately preceding ancestor) instead of the global
19434 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19435 this applies whether or not the address is preceded by a backslash.
19436
19437
19438 .option repeat_use redirect boolean true
19439 If this option is set false, the router is skipped for a child address that has
19440 any ancestor that was routed by this router. This test happens before any of
19441 the other preconditions are tested. Exim's default anti-looping rules skip
19442 only when the ancestor is the same as the current address. See also
19443 &%check_ancestor%& above and the generic &%redirect_router%& option.
19444
19445
19446 .option reply_transport redirect string&!! unset
19447 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19448 &%vacation%& command is used in a filter file. The transport used is specified
19449 by this option, which, after expansion, must be the name of a configured
19450 transport. This should normally be an &(autoreply)& transport. Other transports
19451 are unlikely to do anything sensible or useful.
19452
19453
19454 .option rewrite redirect boolean true
19455 .cindex "address redirection" "disabling rewriting"
19456 If this option is set false, addresses generated by the router are not
19457 subject to address rewriting. Otherwise, they are treated like new addresses
19458 and are rewritten according to the global rewriting rules.
19459
19460
19461 .option sieve_subaddress redirect string&!! unset
19462 The value of this option is passed to a Sieve filter to specify the
19463 :subaddress part of an address.
19464
19465 .option sieve_useraddress redirect string&!! unset
19466 The value of this option is passed to a Sieve filter to specify the :user part
19467 of an address. However, if it is unset, the entire original local part
19468 (including any prefix or suffix) is used for :user.
19469
19470
19471 .option sieve_vacation_directory redirect string&!! unset
19472 .cindex "Sieve filter" "vacation directory"
19473 To enable the &"vacation"& extension for Sieve filters, you must set
19474 &%sieve_vacation_directory%& to the directory where vacation databases are held
19475 (do not put anything else in that directory), and ensure that the
19476 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19477 needs their own directory; Exim will create it if necessary.
19478
19479
19480
19481 .option skip_syntax_errors redirect boolean false
19482 .cindex "forward file" "broken"
19483 .cindex "address redirection" "broken files"
19484 .cindex "alias file" "broken"
19485 .cindex "broken alias or forward files"
19486 .cindex "ignoring faulty addresses"
19487 .cindex "skipping faulty addresses"
19488 .cindex "error" "skipping bad syntax"
19489 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19490 non-filter redirection data are skipped, and each failing address is logged. If
19491 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19492 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19493 are expanded and placed at the head of the error message generated by
19494 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19495 be the same address as the generic &%errors_to%& option. The
19496 &%skip_syntax_errors%& option is often used when handling mailing lists.
19497
19498 If all the addresses in a redirection list are skipped because of syntax
19499 errors, the router declines to handle the original address, and it is passed to
19500 the following routers.
19501
19502 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19503 error in the filter causes filtering to be abandoned without any action being
19504 taken. The incident is logged, and the router declines to handle the address,
19505 so it is passed to the following routers.
19506
19507 .cindex "Sieve filter" "syntax errors in"
19508 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19509 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19510 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19511
19512 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19513 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19514 option, used with an address that does not get redirected, can be used to
19515 notify users of these errors, by means of a router like this:
19516 .code
19517 userforward:
19518   driver = redirect
19519   allow_filter
19520   check_local_user
19521   file = $home/.forward
19522   file_transport = address_file
19523   pipe_transport = address_pipe
19524   reply_transport = address_reply
19525   no_verify
19526   skip_syntax_errors
19527   syntax_errors_to = real-$local_part@$domain
19528   syntax_errors_text = \
19529    This is an automatically generated message. An error has\n\
19530    been found in your .forward file. Details of the error are\n\
19531    reported below. While this error persists, you will receive\n\
19532    a copy of this message for every message that is addressed\n\
19533    to you. If your .forward file is a filter file, or if it is\n\
19534    a non-filter file containing no valid forwarding addresses,\n\
19535    a copy of each incoming message will be put in your normal\n\
19536    mailbox. If a non-filter file contains at least one valid\n\
19537    forwarding address, forwarding to the valid addresses will\n\
19538    happen, and those will be the only deliveries that occur.
19539 .endd
19540 You also need a router to ensure that local addresses that are prefixed by
19541 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19542 put this immediately before the &(userforward)& router:
19543 .code
19544 real_localuser:
19545   driver = accept
19546   check_local_user
19547   local_part_prefix = real-
19548   transport = local_delivery
19549 .endd
19550 For security, it would probably be a good idea to restrict the use of this
19551 router to locally-generated messages, using a condition such as this:
19552 .code
19553   condition = ${if match {$sender_host_address}\
19554                          {\N^(|127\.0\.0\.1)$\N}}
19555 .endd
19556
19557
19558 .option syntax_errors_text redirect string&!! unset
19559 See &%skip_syntax_errors%& above.
19560
19561
19562 .option syntax_errors_to redirect string unset
19563 See &%skip_syntax_errors%& above.
19564 .ecindex IIDredrou1
19565 .ecindex IIDredrou2
19566
19567
19568
19569
19570
19571
19572 . ////////////////////////////////////////////////////////////////////////////
19573 . ////////////////////////////////////////////////////////////////////////////
19574
19575 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19576          "Environment for local transports"
19577 .scindex IIDenvlotra1 "local transports" "environment for"
19578 .scindex IIDenvlotra2 "environment for local transports"
19579 .scindex IIDenvlotra3 "transport" "local; environment for"
19580 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19581 transport can be thought of as similar to a pipe.) Exim always runs transports
19582 in subprocesses, under specified uids and gids. Typical deliveries to local
19583 mailboxes run under the uid and gid of the local user.
19584
19585 Exim also sets a specific current directory while running the transport; for
19586 some transports a home directory setting is also relevant. The &(pipe)&
19587 transport is the only one that sets up environment variables; see section
19588 &<<SECTpipeenv>>& for details.
19589
19590 The values used for the uid, gid, and the directories may come from several
19591 different places. In many cases, the router that handles the address associates
19592 settings with that address as a result of its &%check_local_user%&, &%group%&,
19593 or &%user%& options. However, values may also be given in the transport's own
19594 configuration, and these override anything that comes from the router.
19595
19596
19597
19598 .section "Concurrent deliveries" "SECID131"
19599 .cindex "concurrent deliveries"
19600 .cindex "simultaneous deliveries"
19601 If two different messages for the same local recipient arrive more or less
19602 simultaneously, the two delivery processes are likely to run concurrently. When
19603 the &(appendfile)& transport is used to write to a file, Exim applies locking
19604 rules to stop concurrent processes from writing to the same file at the same
19605 time.
19606
19607 However, when you use a &(pipe)& transport, it is up to you to arrange any
19608 locking that is needed. Here is a silly example:
19609 .code
19610 my_transport:
19611   driver = pipe
19612   command = /bin/sh -c 'cat >>/some/file'
19613 .endd
19614 This is supposed to write the message at the end of the file. However, if two
19615 messages arrive at the same time, the file will be scrambled. You can use the
19616 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19617 file using the same algorithm that Exim itself uses.
19618
19619
19620
19621
19622 .section "Uids and gids" "SECTenvuidgid"
19623 .cindex "local transports" "uid and gid"
19624 .cindex "transport" "local; uid and gid"
19625 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19626 overrides any group that the router set in the address, even if &%user%& is not
19627 set for the transport. This makes it possible, for example, to run local mail
19628 delivery under the uid of the recipient (set by the router), but in a special
19629 group (set by the transport). For example:
19630 .code
19631 # Routers ...
19632 # User/group are set by check_local_user in this router
19633 local_users:
19634   driver = accept
19635   check_local_user
19636   transport = group_delivery
19637
19638 # Transports ...
19639 # This transport overrides the group
19640 group_delivery:
19641   driver = appendfile
19642   file = /var/spool/mail/$local_part
19643   group = mail
19644 .endd
19645 If &%user%& is set for a transport, its value overrides what is set in the
19646 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19647 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19648 set.
19649
19650 .oindex "&%initgroups%&"
19651 When the uid is taken from the transport's configuration, the &[initgroups()]&
19652 function is called for the groups associated with that uid if the
19653 &%initgroups%& option is set for the transport. When the uid is not specified
19654 by the transport, but is associated with the address by a router, the option
19655 for calling &[initgroups()]& is taken from the router configuration.
19656
19657 .cindex "&(pipe)& transport" "uid for"
19658 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19659 is set and &%user%& is not set, the uid of the process that called Exim to
19660 receive the message is used, and if &%group%& is not set, the corresponding
19661 original gid is also used.
19662
19663 This is the detailed preference order for obtaining a gid; the first of the
19664 following that is set is used:
19665
19666 .ilist
19667 A &%group%& setting of the transport;
19668 .next
19669 A &%group%& setting of the router;
19670 .next
19671 A gid associated with a user setting of the router, either as a result of
19672 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19673 .next
19674 The group associated with a non-numeric &%user%& setting of the transport;
19675 .next
19676 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19677 the uid is the creator's uid;
19678 .next
19679 The Exim gid if the Exim uid is being used as a default.
19680 .endlist
19681
19682 If, for example, the user is specified numerically on the router and there are
19683 no group settings, no gid is available. In this situation, an error occurs.
19684 This is different for the uid, for which there always is an ultimate default.
19685 The first of the following that is set is used:
19686
19687 .ilist
19688 A &%user%& setting of the transport;
19689 .next
19690 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19691 .next
19692 A &%user%& setting of the router;
19693 .next
19694 A &%check_local_user%& setting of the router;
19695 .next
19696 The Exim uid.
19697 .endlist
19698
19699 Of course, an error will still occur if the uid that is chosen is on the
19700 &%never_users%& list.
19701
19702
19703
19704
19705
19706 .section "Current and home directories" "SECID132"
19707 .cindex "current directory for local transport"
19708 .cindex "home directory" "for local transport"
19709 .cindex "transport" "local; home directory for"
19710 .cindex "transport" "local; current directory for"
19711 Routers may set current and home directories for local transports by means of
19712 the &%transport_current_directory%& and &%transport_home_directory%& options.
19713 However, if the transport's &%current_directory%& or &%home_directory%& options
19714 are set, they override the router's values. In detail, the home directory
19715 for a local transport is taken from the first of these values that is set:
19716
19717 .ilist
19718 The &%home_directory%& option on the transport;
19719 .next
19720 The &%transport_home_directory%& option on the router;
19721 .next
19722 The password data if &%check_local_user%& is set on the router;
19723 .next
19724 The &%router_home_directory%& option on the router.
19725 .endlist
19726
19727 The current directory is taken from the first of these values that is set:
19728
19729 .ilist
19730 The &%current_directory%& option on the transport;
19731 .next
19732 The &%transport_current_directory%& option on the router.
19733 .endlist
19734
19735
19736 If neither the router nor the transport sets a current directory, Exim uses the
19737 value of the home directory, if it is set. Otherwise it sets the current
19738 directory to &_/_& before running a local transport.
19739
19740
19741
19742 .section "Expansion variables derived from the address" "SECID133"
19743 .vindex "&$domain$&"
19744 .vindex "&$local_part$&"
19745 .vindex "&$original_domain$&"
19746 Normally a local delivery is handling a single address, and in that case the
19747 variables such as &$domain$& and &$local_part$& are set during local
19748 deliveries. However, in some circumstances more than one address may be handled
19749 at once (for example, while writing batch SMTP for onward transmission by some
19750 other means). In this case, the variables associated with the local part are
19751 never set, &$domain$& is set only if all the addresses have the same domain,
19752 and &$original_domain$& is never set.
19753 .ecindex IIDenvlotra1
19754 .ecindex IIDenvlotra2
19755 .ecindex IIDenvlotra3
19756
19757
19758
19759
19760
19761
19762
19763 . ////////////////////////////////////////////////////////////////////////////
19764 . ////////////////////////////////////////////////////////////////////////////
19765
19766 .chapter "Generic options for transports" "CHAPtransportgeneric"
19767 .scindex IIDgenoptra1 "generic options" "transport"
19768 .scindex IIDgenoptra2 "options" "generic; for transports"
19769 .scindex IIDgenoptra3 "transport" "generic options for"
19770 The following generic options apply to all transports:
19771
19772
19773 .option body_only transports boolean false
19774 .cindex "transport" "body only"
19775 .cindex "message" "transporting body only"
19776 .cindex "body of message" "transporting"
19777 If this option is set, the message's headers are not transported. It is
19778 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19779 or &(pipe)& transports, the settings of &%message_prefix%& and
19780 &%message_suffix%& should be checked, because this option does not
19781 automatically suppress them.
19782
19783
19784 .option current_directory transports string&!! unset
19785 .cindex "transport" "current directory for"
19786 This specifies the current directory that is to be set while running the
19787 transport, overriding any value that may have been set by the router.
19788 If the expansion fails for any reason, including forced failure, an error is
19789 logged, and delivery is deferred.
19790
19791
19792 .option disable_logging transports boolean false
19793 If this option is set true, nothing is logged for any
19794 deliveries by the transport or for any
19795 transport errors. You should not set this option unless you really, really know
19796 what you are doing.
19797
19798
19799 .option debug_print transports string&!! unset
19800 .cindex "testing" "variables in drivers"
19801 If this option is set and debugging is enabled (see the &%-d%& command line
19802 option), the string is expanded and included in the debugging output when the
19803 transport is run.
19804 If expansion of the string fails, the error message is written to the debugging
19805 output, and Exim carries on processing.
19806 This facility is provided to help with checking out the values of variables and
19807 so on when debugging driver configurations. For example, if a &%headers_add%&
19808 option is not working properly, &%debug_print%& could be used to output the
19809 variables it references. A newline is added to the text if it does not end with
19810 one.
19811 .new
19812 The variables &$transport_name$& and &$router_name$& contain the name of the
19813 transport and the router that called it.
19814 .wen
19815
19816 .option delivery_date_add transports boolean false
19817 .cindex "&'Delivery-date:'& header line"
19818 If this option is true, a &'Delivery-date:'& header is added to the message.
19819 This gives the actual time the delivery was made. As this is not a standard
19820 header, Exim has a configuration option (&%delivery_date_remove%&) which
19821 requests its removal from incoming messages, so that delivered messages can
19822 safely be resent to other recipients.
19823
19824
19825 .option driver transports string unset
19826 This specifies which of the available transport drivers is to be used.
19827 There is no default, and this option must be set for every transport.
19828
19829
19830 .option envelope_to_add transports boolean false
19831 .cindex "&'Envelope-to:'& header line"
19832 If this option is true, an &'Envelope-to:'& header is added to the message.
19833 This gives the original address(es) in the incoming envelope that caused this
19834 delivery to happen. More than one address may be present if the transport is
19835 configured to handle several addresses at once, or if more than one original
19836 address was redirected to the same final address. As this is not a standard
19837 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19838 its removal from incoming messages, so that delivered messages can safely be
19839 resent to other recipients.
19840
19841
19842 .option group transports string&!! "Exim group"
19843 .cindex "transport" "group; specifying"
19844 This option specifies a gid for running the transport process, overriding any
19845 value that the router supplies, and also overriding any value associated with
19846 &%user%& (see below).
19847
19848
19849 .option headers_add transports string&!! unset
19850 .cindex "header lines" "adding in transport"
19851 .cindex "transport" "header lines; adding"
19852 This option specifies a string of text that is expanded and added to the header
19853 portion of a message as it is transported, as described in section
19854 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19855 routers. If the result of the expansion is an empty string, or if the expansion
19856 is forced to fail, no action is taken. Other expansion failures are treated as
19857 errors and cause the delivery to be deferred.
19858
19859 .new
19860 Unlike most options, &%headers_add%& can be specified multiple times
19861 for a transport; all listed headers are added.
19862 .wen
19863
19864
19865 .option headers_only transports boolean false
19866 .cindex "transport" "header lines only"
19867 .cindex "message" "transporting headers only"
19868 .cindex "header lines" "transporting"
19869 If this option is set, the message's body is not transported. It is mutually
19870 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19871 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19872 checked, since this option does not automatically suppress them.
19873
19874
19875 .option headers_remove transports string&!! unset
19876 .cindex "header lines" "removing"
19877 .cindex "transport" "header lines; removing"
19878 This option specifies a string that is expanded into a list of header names;
19879 these headers are omitted from the message as it is transported, as described
19880 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19881 routers. If the result of the expansion is an empty string, or if the expansion
19882 is forced to fail, no action is taken. Other expansion failures are treated as
19883 errors and cause the delivery to be deferred.
19884
19885 Unlike most options, &%headers_remove%& can be specified multiple times
19886 for a router; all listed headers are added.
19887
19888
19889
19890 .option headers_rewrite transports string unset
19891 .cindex "transport" "header lines; rewriting"
19892 .cindex "rewriting" "at transport time"
19893 This option allows addresses in header lines to be rewritten at transport time,
19894 that is, as the message is being copied to its destination. The contents of the
19895 option are a colon-separated list of rewriting rules. Each rule is in exactly
19896 the same form as one of the general rewriting rules that are applied when a
19897 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19898 example,
19899 .code
19900 headers_rewrite = a@b c@d f : \
19901                   x@y w@z
19902 .endd
19903 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19904 &'w@z'& in all address-bearing header lines. The rules are applied to the
19905 header lines just before they are written out at transport time, so they affect
19906 only those copies of the message that pass through the transport. However, only
19907 the message's original header lines, and any that were added by a system
19908 filter, are rewritten. If a router or transport adds header lines, they are not
19909 affected by this option. These rewriting rules are &'not'& applied to the
19910 envelope. You can change the return path using &%return_path%&, but you cannot
19911 change envelope recipients at this time.
19912
19913
19914 .option home_directory transports string&!! unset
19915 .cindex "transport" "home directory for"
19916 .vindex "&$home$&"
19917 This option specifies a home directory setting for a local transport,
19918 overriding any value that may be set by the router. The home directory is
19919 placed in &$home$& while expanding the transport's private options. It is also
19920 used as the current directory if no current directory is set by the
19921 &%current_directory%& option on the transport or the
19922 &%transport_current_directory%& option on the router. If the expansion fails
19923 for any reason, including forced failure, an error is logged, and delivery is
19924 deferred.
19925
19926
19927 .option initgroups transports boolean false
19928 .cindex "additional groups"
19929 .cindex "groups" "additional"
19930 .cindex "transport" "group; additional"
19931 If this option is true and the uid for the delivery process is provided by the
19932 transport, the &[initgroups()]& function is called when running the transport
19933 to ensure that any additional groups associated with the uid are set up.
19934
19935
19936 .option message_size_limit transports string&!! 0
19937 .cindex "limit" "message size per transport"
19938 .cindex "size" "of message, limit"
19939 .cindex "transport" "message size; limiting"
19940 This option controls the size of messages passed through the transport. It is
19941 expanded before use; the result of the expansion must be a sequence of decimal
19942 digits, optionally followed by K or M. If the expansion fails for any reason,
19943 including forced failure, or if the result is not of the required form,
19944 delivery is deferred. If the value is greater than zero and the size of a
19945 message exceeds this limit, the address is failed. If there is any chance that
19946 the resulting bounce message could be routed to the same transport, you should
19947 ensure that &%return_size_limit%& is less than the transport's
19948 &%message_size_limit%&, as otherwise the bounce message will fail to get
19949 delivered.
19950
19951
19952
19953 .option rcpt_include_affixes transports boolean false
19954 .cindex "prefix" "for local part, including in envelope"
19955 .cindex "suffix for local part" "including in envelope"
19956 .cindex "local part" "prefix"
19957 .cindex "local part" "suffix"
19958 When this option is false (the default), and an address that has had any
19959 affixes (prefixes or suffixes) removed from the local part is delivered by any
19960 form of SMTP or LMTP, the affixes are not included. For example, if a router
19961 that contains
19962 .code
19963 local_part_prefix = *-
19964 .endd
19965 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19966 is delivered with
19967 .code
19968 RCPT TO:<xyz@some.domain>
19969 .endd
19970 This is also the case when an ACL-time callout is being used to verify a
19971 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19972 whole local part is included in the RCPT command. This option applies to BSMTP
19973 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19974 &(lmtp)& and &(smtp)& transports.
19975
19976
19977 .option retry_use_local_part transports boolean "see below"
19978 .cindex "hints database" "retry keys"
19979 When a delivery suffers a temporary failure, a retry record is created
19980 in Exim's hints database. For remote deliveries, the key for the retry record
19981 is based on the name and/or IP address of the failing remote host. For local
19982 deliveries, the key is normally the entire address, including both the local
19983 part and the domain. This is suitable for most common cases of local delivery
19984 temporary failure &-- for example, exceeding a mailbox quota should delay only
19985 deliveries to that mailbox, not to the whole domain.
19986
19987 However, in some special cases you may want to treat a temporary local delivery
19988 as a failure associated with the domain, and not with a particular local part.
19989 (For example, if you are storing all mail for some domain in files.) You can do
19990 this by setting &%retry_use_local_part%& false.
19991
19992 For all the local transports, its default value is true. For remote transports,
19993 the default value is false for tidiness, but changing the value has no effect
19994 on a remote transport in the current implementation.
19995
19996
19997 .option return_path transports string&!! unset
19998 .cindex "envelope sender"
19999 .cindex "transport" "return path; changing"
20000 .cindex "return path" "changing in transport"
20001 If this option is set, the string is expanded at transport time and replaces
20002 the existing return path (envelope sender) value in the copy of the message
20003 that is being delivered. An empty return path is permitted. This feature is
20004 designed for remote deliveries, where the value of this option is used in the
20005 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20006 only effect is to change the address that is placed in the &'Return-path:'&
20007 header line, if one is added to the message (see the next option).
20008
20009 &*Note:*& A changed return path is not logged unless you add
20010 &%return_path_on_delivery%& to the log selector.
20011
20012 .vindex "&$return_path$&"
20013 The expansion can refer to the existing value via &$return_path$&. This is
20014 either the message's envelope sender, or an address set by the
20015 &%errors_to%& option on a router. If the expansion is forced to fail, no
20016 replacement occurs; if it fails for another reason, delivery is deferred. This
20017 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20018 section &<<SECTverp>>&.
20019
20020 &*Note*&: If a delivery error is detected locally, including the case when a
20021 remote server rejects a message at SMTP time, the bounce message is not sent to
20022 the value of this option. It is sent to the previously set errors address.
20023 This defaults to the incoming sender address, but can be changed by setting
20024 &%errors_to%& in a router.
20025
20026
20027
20028 .option return_path_add transports boolean false
20029 .cindex "&'Return-path:'& header line"
20030 If this option is true, a &'Return-path:'& header is added to the message.
20031 Although the return path is normally available in the prefix line of BSD
20032 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20033 have easy access to it.
20034
20035 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20036 the delivery SMTP server makes the final delivery"&. This implies that this
20037 header should not be present in incoming messages. Exim has a configuration
20038 option, &%return_path_remove%&, which requests removal of this header from
20039 incoming messages, so that delivered messages can safely be resent to other
20040 recipients.
20041
20042
20043 .option shadow_condition transports string&!! unset
20044 See &%shadow_transport%& below.
20045
20046
20047 .option shadow_transport transports string unset
20048 .cindex "shadow transport"
20049 .cindex "transport" "shadow"
20050 A local transport may set the &%shadow_transport%& option to the name of
20051 another local transport. Shadow remote transports are not supported.
20052
20053 Whenever a delivery to the main transport succeeds, and either
20054 &%shadow_condition%& is unset, or its expansion does not result in the empty
20055 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20056 passed to the shadow transport, with the same delivery address or addresses. If
20057 expansion fails, no action is taken except that non-forced expansion failures
20058 cause a log line to be written.
20059
20060 The result of the shadow transport is discarded and does not affect the
20061 subsequent processing of the message. Only a single level of shadowing is
20062 provided; the &%shadow_transport%& option is ignored on any transport when it
20063 is running as a shadow. Options concerned with output from pipes are also
20064 ignored. The log line for the successful delivery has an item added on the end,
20065 of the form
20066 .code
20067 ST=<shadow transport name>
20068 .endd
20069 If the shadow transport did not succeed, the error message is put in
20070 parentheses afterwards. Shadow transports can be used for a number of different
20071 purposes, including keeping more detailed log information than Exim normally
20072 provides, and implementing automatic acknowledgment policies based on message
20073 headers that some sites insist on.
20074
20075
20076 .option transport_filter transports string&!! unset
20077 .cindex "transport" "filter"
20078 .cindex "filter" "transport filter"
20079 This option sets up a filtering (in the Unix shell sense) process for messages
20080 at transport time. It should not be confused with mail filtering as set up by
20081 individual users or via a system filter.
20082
20083 When the message is about to be written out, the command specified by
20084 &%transport_filter%& is started up in a separate, parallel process, and
20085 the entire message, including the header lines, is passed to it on its standard
20086 input (this in fact is done from a third process, to avoid deadlock). The
20087 command must be specified as an absolute path.
20088
20089 The lines of the message that are written to the transport filter are
20090 terminated by newline (&"\n"&). The message is passed to the filter before any
20091 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20092 lines beginning with a dot, and also before any processing implied by the
20093 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20094 &(pipe)& transports.
20095
20096 The standard error for the filter process is set to the same destination as its
20097 standard output; this is read and written to the message's ultimate
20098 destination. The process that writes the message to the filter, the
20099 filter itself, and the original process that reads the result and delivers it
20100 are all run in parallel, like a shell pipeline.
20101
20102 The filter can perform any transformations it likes, but of course should take
20103 care not to break RFC 2822 syntax. Exim does not check the result, except to
20104 test for a final newline when SMTP is in use. All messages transmitted over
20105 SMTP must end with a newline, so Exim supplies one if it is missing.
20106
20107 .cindex "content scanning" "per user"
20108 A transport filter can be used to provide content-scanning on a per-user basis
20109 at delivery time if the only required effect of the scan is to modify the
20110 message. For example, a content scan could insert a new header line containing
20111 a spam score. This could be interpreted by a filter in the user's MUA. It is
20112 not possible to discard a message at this stage.
20113
20114 .cindex "SMTP" "SIZE"
20115 A problem might arise if the filter increases the size of a message that is
20116 being sent down an SMTP connection. If the receiving SMTP server has indicated
20117 support for the SIZE parameter, Exim will have sent the size of the message
20118 at the start of the SMTP session. If what is actually sent is substantially
20119 more, the server might reject the message. This can be worked round by setting
20120 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20121 additions to the message, or to disable the use of SIZE altogether.
20122
20123 .vindex "&$pipe_addresses$&"
20124 The value of the &%transport_filter%& option is the command string for starting
20125 the filter, which is run directly from Exim, not under a shell. The string is
20126 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20127 Exim breaks it up into arguments and then expands each argument separately (see
20128 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20129 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20130 of arguments, one for each address that applies to this delivery. (This isn't
20131 an ideal name for this feature here, but as it was already implemented for the
20132 &(pipe)& transport, it seemed sensible not to change it.)
20133
20134 .vindex "&$host$&"
20135 .vindex "&$host_address$&"
20136 The expansion variables &$host$& and &$host_address$& are available when the
20137 transport is a remote one. They contain the name and IP address of the host to
20138 which the message is being sent. For example:
20139 .code
20140 transport_filter = /some/directory/transport-filter.pl \
20141   $host $host_address $sender_address $pipe_addresses
20142 .endd
20143
20144 Two problems arise if you want to use more complicated expansion items to
20145 generate transport filter commands, both of which due to the fact that the
20146 command is split up &'before'& expansion.
20147 .ilist
20148 If an expansion item contains white space, you must quote it, so that it is all
20149 part of the same command item. If the entire option setting is one such
20150 expansion item, you have to take care what kind of quoting you use. For
20151 example:
20152 .code
20153 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20154 .endd
20155 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20156 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20157 stripped by Exim when it read the option's value. When the value is used, if
20158 the single quotes were missing, the line would be split into two items,
20159 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20160 Exim tried to expand the first one.
20161 .next
20162 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20163 expansion cannot generate multiple arguments, or a command name followed by
20164 arguments. Consider this example:
20165 .code
20166 transport_filter = ${lookup{$host}lsearch{/a/file}\
20167                     {$value}{/bin/cat}}
20168 .endd
20169 The result of the lookup is interpreted as the name of the command, even
20170 if it contains white space. The simplest way round this is to use a shell:
20171 .code
20172 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20173                                {$value}{/bin/cat}}
20174 .endd
20175 .endlist
20176
20177 The filter process is run under the same uid and gid as the normal delivery.
20178 For remote deliveries this is the Exim uid/gid by default. The command should
20179 normally yield a zero return code. Transport filters are not supposed to fail.
20180 A non-zero code is taken to mean that the transport filter encountered some
20181 serious problem. Delivery of the message is deferred; the message remains on
20182 the queue and is tried again later. It is not possible to cause a message to be
20183 bounced from a transport filter.
20184
20185 If a transport filter is set on an autoreply transport, the original message is
20186 passed through the filter as it is being copied into the newly generated
20187 message, which happens if the &%return_message%& option is set.
20188
20189
20190 .option transport_filter_timeout transports time 5m
20191 .cindex "transport" "filter, timeout"
20192 When Exim is reading the output of a transport filter, it applies a timeout
20193 that can be set by this option. Exceeding the timeout is normally treated as a
20194 temporary delivery failure. However, if a transport filter is used with a
20195 &(pipe)& transport, a timeout in the transport filter is treated in the same
20196 way as a timeout in the pipe command itself. By default, a timeout is a hard
20197 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20198 becomes a temporary error.
20199
20200
20201 .option user transports string&!! "Exim user"
20202 .cindex "uid (user id)" "local delivery"
20203 .cindex "transport" "user, specifying"
20204 This option specifies the user under whose uid the delivery process is to be
20205 run, overriding any uid that may have been set by the router. If the user is
20206 given as a name, the uid is looked up from the password data, and the
20207 associated group is taken as the value of the gid to be used if the &%group%&
20208 option is not set.
20209
20210 For deliveries that use local transports, a user and group are normally
20211 specified explicitly or implicitly (for example, as a result of
20212 &%check_local_user%&) by the router or transport.
20213
20214 .cindex "hints database" "access by remote transport"
20215 For remote transports, you should leave this option unset unless you really are
20216 sure you know what you are doing. When a remote transport is running, it needs
20217 to be able to access Exim's hints databases, because each host may have its own
20218 retry data.
20219 .ecindex IIDgenoptra1
20220 .ecindex IIDgenoptra2
20221 .ecindex IIDgenoptra3
20222
20223
20224
20225
20226
20227
20228 . ////////////////////////////////////////////////////////////////////////////
20229 . ////////////////////////////////////////////////////////////////////////////
20230
20231 .chapter "Address batching in local transports" "CHAPbatching" &&&
20232          "Address batching"
20233 .cindex "transport" "local; address batching in"
20234 The only remote transport (&(smtp)&) is normally configured to handle more than
20235 one address at a time, so that when several addresses are routed to the same
20236 remote host, just one copy of the message is sent. Local transports, however,
20237 normally handle one address at a time. That is, a separate instance of the
20238 transport is run for each address that is routed to the transport. A separate
20239 copy of the message is delivered each time.
20240
20241 .cindex "batched local delivery"
20242 .oindex "&%batch_max%&"
20243 .oindex "&%batch_id%&"
20244 In special cases, it may be desirable to handle several addresses at once in a
20245 local transport, for example:
20246
20247 .ilist
20248 In an &(appendfile)& transport, when storing messages in files for later
20249 delivery by some other means, a single copy of the message with multiple
20250 recipients saves space.
20251 .next
20252 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20253 a single copy saves time, and is the normal way LMTP is expected to work.
20254 .next
20255 In a &(pipe)& transport, when passing the message
20256 to a scanner program or
20257 to some other delivery mechanism such as UUCP, multiple recipients may be
20258 acceptable.
20259 .endlist
20260
20261 These three local transports all have the same options for controlling multiple
20262 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20263 repeating the information for each transport, these options are described here.
20264
20265 The &%batch_max%& option specifies the maximum number of addresses that can be
20266 delivered together in a single run of the transport. Its default value is one
20267 (no batching). When more than one address is routed to a transport that has a
20268 &%batch_max%& value greater than one, the addresses are delivered in a batch
20269 (that is, in a single run of the transport with multiple recipients), subject
20270 to certain conditions:
20271
20272 .ilist
20273 .vindex "&$local_part$&"
20274 If any of the transport's options contain a reference to &$local_part$&, no
20275 batching is possible.
20276 .next
20277 .vindex "&$domain$&"
20278 If any of the transport's options contain a reference to &$domain$&, only
20279 addresses with the same domain are batched.
20280 .next
20281 .cindex "customizing" "batching condition"
20282 If &%batch_id%& is set, it is expanded for each address, and only those
20283 addresses with the same expanded value are batched. This allows you to specify
20284 customized batching conditions. Failure of the expansion for any reason,
20285 including forced failure, disables batching, but it does not stop the delivery
20286 from taking place.
20287 .next
20288 Batched addresses must also have the same errors address (where to send
20289 delivery errors), the same header additions and removals, the same user and
20290 group for the transport, and if a host list is present, the first host must
20291 be the same.
20292 .endlist
20293
20294 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20295 both when the file or pipe command is specified in the transport, and when it
20296 is specified by a &(redirect)& router, but all the batched addresses must of
20297 course be routed to the same file or pipe command. These two transports have an
20298 option called &%use_bsmtp%&, which causes them to deliver the message in
20299 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20300 &%check_string%& and &%escape_string%& options are forced to the values
20301 .code
20302 check_string = "."
20303 escape_string = ".."
20304 .endd
20305 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20306 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20307 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20308
20309 .cindex "&'Envelope-to:'& header line"
20310 If the generic &%envelope_to_add%& option is set for a batching transport, the
20311 &'Envelope-to:'& header that is added to the message contains all the addresses
20312 that are being processed together. If you are using a batching &(appendfile)&
20313 transport without &%use_bsmtp%&, the only way to preserve the recipient
20314 addresses is to set the &%envelope_to_add%& option.
20315
20316 .cindex "&(pipe)& transport" "with multiple addresses"
20317 .vindex "&$pipe_addresses$&"
20318 If you are using a &(pipe)& transport without BSMTP, and setting the
20319 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20320 the command. This is not a true variable; it is a bit of magic that causes each
20321 of the recipient addresses to be inserted into the command as a separate
20322 argument. This provides a way of accessing all the addresses that are being
20323 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20324 are specified by a &(redirect)& router.
20325
20326
20327
20328
20329 . ////////////////////////////////////////////////////////////////////////////
20330 . ////////////////////////////////////////////////////////////////////////////
20331
20332 .chapter "The appendfile transport" "CHAPappendfile"
20333 .scindex IIDapptra1 "&(appendfile)& transport"
20334 .scindex IIDapptra2 "transports" "&(appendfile)&"
20335 .cindex "directory creation"
20336 .cindex "creating directories"
20337 The &(appendfile)& transport delivers a message by appending it to an existing
20338 file, or by creating an entirely new file in a specified directory. Single
20339 files to which messages are appended can be in the traditional Unix mailbox
20340 format, or optionally in the MBX format supported by the Pine MUA and
20341 University of Washington IMAP daemon, &'inter alia'&. When each message is
20342 being delivered as a separate file, &"maildir"& format can optionally be used
20343 to give added protection against failures that happen part-way through the
20344 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20345 supported. For all file formats, Exim attempts to create as many levels of
20346 directory as necessary, provided that &%create_directory%& is set.
20347
20348 The code for the optional formats is not included in the Exim binary by
20349 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20350 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20351 included.
20352
20353 .cindex "quota" "system"
20354 Exim recognizes system quota errors, and generates an appropriate message. Exim
20355 also supports its own quota control within the transport, for use when the
20356 system facility is unavailable or cannot be used for some reason.
20357
20358 If there is an error while appending to a file (for example, quota exceeded or
20359 partition filled), Exim attempts to reset the file's length and last
20360 modification time back to what they were before. If there is an error while
20361 creating an entirely new file, the new file is removed.
20362
20363 Before appending to a file, a number of security checks are made, and the
20364 file is locked. A detailed description is given below, after the list of
20365 private options.
20366
20367 The &(appendfile)& transport is most commonly used for local deliveries to
20368 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20369 putting messages into files for remote delivery by some means other than Exim.
20370 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20371 option).
20372
20373
20374
20375 .section "The file and directory options" "SECTfildiropt"
20376 The &%file%& option specifies a single file, to which the message is appended;
20377 the &%directory%& option specifies a directory, in which a new file containing
20378 the message is created. Only one of these two options can be set, and for
20379 normal deliveries to mailboxes, one of them &'must'& be set.
20380
20381 .vindex "&$address_file$&"
20382 .vindex "&$local_part$&"
20383 However, &(appendfile)& is also used for delivering messages to files or
20384 directories whose names (or parts of names) are obtained from alias,
20385 forwarding, or filtering operations (for example, a &%save%& command in a
20386 user's Exim filter). When such a transport is running, &$local_part$& contains
20387 the local part that was aliased or forwarded, and &$address_file$& contains the
20388 name (or partial name) of the file or directory generated by the redirection
20389 operation. There are two cases:
20390
20391 .ilist
20392 If neither &%file%& nor &%directory%& is set, the redirection operation
20393 must specify an absolute path (one that begins with &`/`&). This is the most
20394 common case when users with local accounts use filtering to sort mail into
20395 different folders. See for example, the &(address_file)& transport in the
20396 default configuration. If the path ends with a slash, it is assumed to be the
20397 name of a directory. A delivery to a directory can also be forced by setting
20398 &%maildir_format%& or &%mailstore_format%&.
20399 .next
20400 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20401 used to determine the file or directory name for the delivery. Normally, the
20402 contents of &$address_file$& are used in some way in the string expansion.
20403 .endlist
20404
20405
20406 .cindex "Sieve filter" "configuring &(appendfile)&"
20407 .cindex "Sieve filter" "relative mailbox path handling"
20408 As an example of the second case, consider an environment where users do not
20409 have home directories. They may be permitted to use Exim filter commands of the
20410 form:
20411 .code
20412 save folder23
20413 .endd
20414 or Sieve filter commands of the form:
20415 .code
20416 require "fileinto";
20417 fileinto "folder23";
20418 .endd
20419 In this situation, the expansion of &%file%& or &%directory%& in the transport
20420 must transform the relative path into an appropriate absolute file name. In the
20421 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20422 is used as a result of a &"keep"& action in the filter. This example shows one
20423 way of handling this requirement:
20424 .code
20425 file = ${if eq{$address_file}{inbox} \
20426             {/var/mail/$local_part} \
20427             {${if eq{${substr_0_1:$address_file}}{/} \
20428                   {$address_file} \
20429                   {$home/mail/$address_file} \
20430             }} \
20431        }
20432 .endd
20433 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20434 location, absolute paths are used without change, and other folders are in the
20435 &_mail_& directory within the home directory.
20436
20437 &*Note 1*&: While processing an Exim filter, a relative path such as
20438 &_folder23_& is turned into an absolute path if a home directory is known to
20439 the router. In particular, this is the case if &%check_local_user%& is set. If
20440 you want to prevent this happening at routing time, you can set
20441 &%router_home_directory%& empty. This forces the router to pass the relative
20442 path to the transport.
20443
20444 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20445 the &%file%& or &%directory%& option is still used if it is set.
20446
20447
20448
20449
20450 .section "Private options for appendfile" "SECID134"
20451 .cindex "options" "&(appendfile)& transport"
20452
20453
20454
20455 .option allow_fifo appendfile boolean false
20456 .cindex "fifo (named pipe)"
20457 .cindex "named pipe (fifo)"
20458 .cindex "pipe" "named (fifo)"
20459 Setting this option permits delivery to named pipes (FIFOs) as well as to
20460 regular files. If no process is reading the named pipe at delivery time, the
20461 delivery is deferred.
20462
20463
20464 .option allow_symlink appendfile boolean false
20465 .cindex "symbolic link" "to mailbox"
20466 .cindex "mailbox" "symbolic link"
20467 By default, &(appendfile)& will not deliver if the path name for the file is
20468 that of a symbolic link. Setting this option relaxes that constraint, but there
20469 are security issues involved in the use of symbolic links. Be sure you know
20470 what you are doing if you set this. Details of exactly what this option affects
20471 are included in the discussion which follows this list of options.
20472
20473
20474 .option batch_id appendfile string&!! unset
20475 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20476 However, batching is automatically disabled for &(appendfile)& deliveries that
20477 happen as a result of forwarding or aliasing or other redirection directly to a
20478 file.
20479
20480
20481 .option batch_max appendfile integer 1
20482 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20483
20484
20485 .option check_group appendfile boolean false
20486 When this option is set, the group owner of the file defined by the &%file%&
20487 option is checked to see that it is the same as the group under which the
20488 delivery process is running. The default setting is false because the default
20489 file mode is 0600, which means that the group is irrelevant.
20490
20491
20492 .option check_owner appendfile boolean true
20493 When this option is set, the owner of the file defined by the &%file%& option
20494 is checked to ensure that it is the same as the user under which the delivery
20495 process is running.
20496
20497
20498 .option check_string appendfile string "see below"
20499 .cindex "&""From""& line"
20500 As &(appendfile)& writes the message, the start of each line is tested for
20501 matching &%check_string%&, and if it does, the initial matching characters are
20502 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20503 a literal string, not a regular expression, and the case of any letters it
20504 contains is significant.
20505
20506 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20507 are forced to &"."& and &".."& respectively, and any settings in the
20508 configuration are ignored. Otherwise, they default to &"From&~"& and
20509 &">From&~"& when the &%file%& option is set, and unset when any of the
20510 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20511
20512 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20513 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20514 &"From&~"& indicates the start of a new message. All four options need changing
20515 if another format is used. For example, to deliver to mailboxes in MMDF format:
20516 .cindex "MMDF format mailbox"
20517 .cindex "mailbox" "MMDF format"
20518 .code
20519 check_string = "\1\1\1\1\n"
20520 escape_string = "\1\1\1\1 \n"
20521 message_prefix = "\1\1\1\1\n"
20522 message_suffix = "\1\1\1\1\n"
20523 .endd
20524 .option create_directory appendfile boolean true
20525 .cindex "directory creation"
20526 When this option is true, Exim attempts to create any missing superior
20527 directories for the file that it is about to write. A created directory's mode
20528 is given by the &%directory_mode%& option.
20529
20530 The group ownership of a newly created directory is highly dependent on the
20531 operating system (and possibly the file system) that is being used. For
20532 example, in Solaris, if the parent directory has the setgid bit set, its group
20533 is propagated to the child; if not, the currently set group is used. However,
20534 in FreeBSD, the parent's group is always used.
20535
20536
20537
20538 .option create_file appendfile string anywhere
20539 This option constrains the location of files and directories that are created
20540 by this transport. It applies to files defined by the &%file%& option and
20541 directories defined by the &%directory%& option. In the case of maildir
20542 delivery, it applies to the top level directory, not the maildir directories
20543 beneath.
20544
20545 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20546 &"belowhome"&. In the second and third cases, a home directory must have been
20547 set for the transport. This option is not useful when an explicit file name is
20548 given for normal mailbox deliveries. It is intended for the case when file
20549 names are generated from users' &_.forward_& files. These are usually handled
20550 by an &(appendfile)& transport called &%address_file%&. See also
20551 &%file_must_exist%&.
20552
20553
20554 .option directory appendfile string&!! unset
20555 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20556 or &%directory%& must be set, unless the delivery is the direct result of a
20557 redirection (see section &<<SECTfildiropt>>&).
20558
20559 When &%directory%& is set, the string is expanded, and the message is delivered
20560 into a new file or files in or below the given directory, instead of being
20561 appended to a single mailbox file. A number of different formats are provided
20562 (see &%maildir_format%& and &%mailstore_format%&), and see section
20563 &<<SECTopdir>>& for further details of this form of delivery.
20564
20565
20566 .option directory_file appendfile string&!! "see below"
20567 .cindex "base62"
20568 .vindex "&$inode$&"
20569 When &%directory%& is set, but neither &%maildir_format%& nor
20570 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20571 whose name is obtained by expanding this string. The default value is:
20572 .code
20573 q${base62:$tod_epoch}-$inode
20574 .endd
20575 This generates a unique name from the current time, in base 62 form, and the
20576 inode of the file. The variable &$inode$& is available only when expanding this
20577 option.
20578
20579
20580 .option directory_mode appendfile "octal integer" 0700
20581 If &(appendfile)& creates any directories as a result of the
20582 &%create_directory%& option, their mode is specified by this option.
20583
20584
20585 .option escape_string appendfile string "see description"
20586 See &%check_string%& above.
20587
20588
20589 .option file appendfile string&!! unset
20590 This option is mutually exclusive with the &%directory%& option, but one of
20591 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20592 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20593 specifies a single file, to which the message is appended. One or more of
20594 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20595 &%file%&.
20596
20597 .cindex "NFS" "lock file"
20598 .cindex "locking files"
20599 .cindex "lock files"
20600 If you are using more than one host to deliver over NFS into the same
20601 mailboxes, you should always use lock files.
20602
20603 The string value is expanded for each delivery, and must yield an absolute
20604 path. The most common settings of this option are variations on one of these
20605 examples:
20606 .code
20607 file = /var/spool/mail/$local_part
20608 file = /home/$local_part/inbox
20609 file = $home/inbox
20610 .endd
20611 .cindex "&""sticky""& bit"
20612 In the first example, all deliveries are done into the same directory. If Exim
20613 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20614 create a file in the directory, so the &"sticky"& bit must be turned on for
20615 deliveries to be possible, or alternatively the &%group%& option can be used to
20616 run the delivery under a group id which has write access to the directory.
20617
20618
20619
20620 .option file_format appendfile string unset
20621 .cindex "file" "mailbox; checking existing format"
20622 This option requests the transport to check the format of an existing file
20623 before adding to it. The check consists of matching a specific string at the
20624 start of the file. The value of the option consists of an even number of
20625 colon-separated strings. The first of each pair is the test string, and the
20626 second is the name of a transport. If the transport associated with a matched
20627 string is not the current transport, control is passed over to the other
20628 transport. For example, suppose the standard &(local_delivery)& transport has
20629 this added to it:
20630 .code
20631 file_format = "From       : local_delivery :\
20632                \1\1\1\1\n : local_mmdf_delivery"
20633 .endd
20634 Mailboxes that begin with &"From"& are still handled by this transport, but if
20635 a mailbox begins with four binary ones followed by a newline, control is passed
20636 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20637 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20638 is assumed to match the current transport. If the start of a mailbox doesn't
20639 match any string, or if the transport named for a given string is not defined,
20640 delivery is deferred.
20641
20642
20643 .option file_must_exist appendfile boolean false
20644 If this option is true, the file specified by the &%file%& option must exist.
20645 A temporary error occurs if it does not, causing delivery to be deferred.
20646 If this option is false, the file is created if it does not exist.
20647
20648
20649 .option lock_fcntl_timeout appendfile time 0s
20650 .cindex "timeout" "mailbox locking"
20651 .cindex "mailbox" "locking, blocking and non-blocking"
20652 .cindex "locking files"
20653 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20654 when locking an open mailbox file. If the call fails, the delivery process
20655 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20656 Non-blocking calls are used so that the file is not kept open during the wait
20657 for the lock; the reason for this is to make it as safe as possible for
20658 deliveries over NFS in the case when processes might be accessing an NFS
20659 mailbox without using a lock file. This should not be done, but
20660 misunderstandings and hence misconfigurations are not unknown.
20661
20662 On a busy system, however, the performance of a non-blocking lock approach is
20663 not as good as using a blocking lock with a timeout. In this case, the waiting
20664 is done inside the system call, and Exim's delivery process acquires the lock
20665 and can proceed as soon as the previous lock holder releases it.
20666
20667 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20668 timeout, are used. There may still be some retrying: the maximum number of
20669 retries is
20670 .code
20671 (lock_retries * lock_interval) / lock_fcntl_timeout
20672 .endd
20673 rounded up to the next whole number. In other words, the total time during
20674 which &(appendfile)& is trying to get a lock is roughly the same, unless
20675 &%lock_fcntl_timeout%& is set very large.
20676
20677 You should consider setting this option if you are getting a lot of delayed
20678 local deliveries because of errors of the form
20679 .code
20680 failed to lock mailbox /some/file (fcntl)
20681 .endd
20682
20683 .option lock_flock_timeout appendfile time 0s
20684 This timeout applies to file locking when using &[flock()]& (see
20685 &%use_flock%&); the timeout operates in a similar manner to
20686 &%lock_fcntl_timeout%&.
20687
20688
20689 .option lock_interval appendfile time 3s
20690 This specifies the time to wait between attempts to lock the file. See below
20691 for details of locking.
20692
20693
20694 .option lock_retries appendfile integer 10
20695 This specifies the maximum number of attempts to lock the file. A value of zero
20696 is treated as 1. See below for details of locking.
20697
20698
20699 .option lockfile_mode appendfile "octal integer" 0600
20700 This specifies the mode of the created lock file, when a lock file is being
20701 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20702
20703
20704 .option lockfile_timeout appendfile time 30m
20705 .cindex "timeout" "mailbox locking"
20706 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20707 exists and is older than this value, it is assumed to have been left behind by
20708 accident, and Exim attempts to remove it.
20709
20710
20711 .option mailbox_filecount appendfile string&!! unset
20712 .cindex "mailbox" "specifying size of"
20713 .cindex "size" "of mailbox"
20714 If this option is set, it is expanded, and the result is taken as the current
20715 number of files in the mailbox. It must be a decimal number, optionally
20716 followed by K or M. This provides a way of obtaining this information from an
20717 external source that maintains the data.
20718
20719
20720 .option mailbox_size appendfile string&!! unset
20721 .cindex "mailbox" "specifying size of"
20722 .cindex "size" "of mailbox"
20723 If this option is set, it is expanded, and the result is taken as the current
20724 size the mailbox. It must be a decimal number, optionally followed by K or M.
20725 This provides a way of obtaining this information from an external source that
20726 maintains the data. This is likely to be helpful for maildir deliveries where
20727 it is computationally expensive to compute the size of a mailbox.
20728
20729
20730
20731 .option maildir_format appendfile boolean false
20732 .cindex "maildir format" "specifying"
20733 If this option is set with the &%directory%& option, the delivery is into a new
20734 file, in the &"maildir"& format that is used by other mail software. When the
20735 transport is activated directly from a &(redirect)& router (for example, the
20736 &(address_file)& transport in the default configuration), setting
20737 &%maildir_format%& causes the path received from the router to be treated as a
20738 directory, whether or not it ends with &`/`&. This option is available only if
20739 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20740 &<<SECTmaildirdelivery>>& below for further details.
20741
20742
20743 .option maildir_quota_directory_regex appendfile string "See below"
20744 .cindex "maildir format" "quota; directories included in"
20745 .cindex "quota" "maildir; directories included in"
20746 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20747 a regular expression for specifying directories, relative to the quota
20748 directory (see &%quota_directory%&), that should be included in the quota
20749 calculation. The default value is:
20750 .code
20751 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20752 .endd
20753 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20754 (directories whose names begin with a dot). If you want to exclude the
20755 &_Trash_&
20756 folder from the count (as some sites do), you need to change this setting to
20757 .code
20758 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20759 .endd
20760 This uses a negative lookahead in the regular expression to exclude the
20761 directory whose name is &_.Trash_&. When a directory is excluded from quota
20762 calculations, quota processing is bypassed for any messages that are delivered
20763 directly into that directory.
20764
20765
20766 .option maildir_retries appendfile integer 10
20767 This option specifies the number of times to retry when writing a file in
20768 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20769
20770
20771 .option maildir_tag appendfile string&!! unset
20772 This option applies only to deliveries in maildir format, and is described in
20773 section &<<SECTmaildirdelivery>>& below.
20774
20775
20776 .option maildir_use_size_file appendfile&!! boolean false
20777 .cindex "maildir format" "&_maildirsize_& file"
20778 The result of string expansion for this option must be a valid boolean value.
20779 If it is true, it enables support for &_maildirsize_& files. Exim
20780 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20781 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20782 value is zero. See &%maildir_quota_directory_regex%& above and section
20783 &<<SECTmaildirdelivery>>& below for further details.
20784
20785 .option maildirfolder_create_regex appendfile string unset
20786 .cindex "maildir format" "&_maildirfolder_& file"
20787 .cindex "&_maildirfolder_&, creating"
20788 The value of this option is a regular expression. If it is unset, it has no
20789 effect. Otherwise, before a maildir delivery takes place, the pattern is
20790 matched against the name of the maildir directory, that is, the directory
20791 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20792 delivery. If there is a match, Exim checks for the existence of a file called
20793 &_maildirfolder_& in the directory, and creates it if it does not exist.
20794 See section &<<SECTmaildirdelivery>>& for more details.
20795
20796
20797 .option mailstore_format appendfile boolean false
20798 .cindex "mailstore format" "specifying"
20799 If this option is set with the &%directory%& option, the delivery is into two
20800 new files in  &"mailstore"& format. The option is available only if
20801 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20802 below for further details.
20803
20804
20805 .option mailstore_prefix appendfile string&!! unset
20806 This option applies only to deliveries in mailstore format, and is described in
20807 section &<<SECTopdir>>& below.
20808
20809
20810 .option mailstore_suffix appendfile string&!! unset
20811 This option applies only to deliveries in mailstore format, and is described in
20812 section &<<SECTopdir>>& below.
20813
20814
20815 .option mbx_format appendfile boolean false
20816 .cindex "locking files"
20817 .cindex "file" "locking"
20818 .cindex "file" "MBX format"
20819 .cindex "MBX format, specifying"
20820 This option is available only if Exim has been compiled with SUPPORT_MBX
20821 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20822 the message is appended to the mailbox file in MBX format instead of
20823 traditional Unix format. This format is supported by Pine4 and its associated
20824 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20825
20826 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20827 automatically changed by the use of &%mbx_format%&. They should normally be set
20828 empty when using MBX format, so this option almost always appears in this
20829 combination:
20830 .code
20831 mbx_format = true
20832 message_prefix =
20833 message_suffix =
20834 .endd
20835 If none of the locking options are mentioned in the configuration,
20836 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20837 is possible to specify the other kinds of locking with &%mbx_format%&, but
20838 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20839 interworks with &'c-client'&, providing for shared access to the mailbox. It
20840 should not be used if any program that does not use this form of locking is
20841 going to access the mailbox, nor should it be used if the mailbox file is NFS
20842 mounted, because it works only when the mailbox is accessed from a single host.
20843
20844 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20845 the standard version of &'c-client'&, because as long as it has a mailbox open
20846 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20847 append messages to it.
20848
20849
20850 .option message_prefix appendfile string&!! "see below"
20851 .cindex "&""From""& line"
20852 The string specified here is expanded and output at the start of every message.
20853 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20854 in which case it is:
20855 .code
20856 message_prefix = "From ${if def:return_path{$return_path}\
20857   {MAILER-DAEMON}} $tod_bsdinbox\n"
20858 .endd
20859 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20860 &`\n`& to &`\r\n`& in &%message_prefix%&.
20861
20862 .option message_suffix appendfile string&!! "see below"
20863 The string specified here is expanded and output at the end of every message.
20864 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20865 in which case it is a single newline character. The suffix can be suppressed by
20866 setting
20867 .code
20868 message_suffix =
20869 .endd
20870 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20871 &`\n`& to &`\r\n`& in &%message_suffix%&.
20872
20873 .option mode appendfile "octal integer" 0600
20874 If the output file is created, it is given this mode. If it already exists and
20875 has wider permissions, they are reduced to this mode. If it has narrower
20876 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20877 if the delivery is the result of a &%save%& command in a filter file specifying
20878 a particular mode, the mode of the output file is always forced to take that
20879 value, and this option is ignored.
20880
20881
20882 .option mode_fail_narrower appendfile boolean true
20883 This option applies in the case when an existing mailbox file has a narrower
20884 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20885 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20886 continues with the delivery attempt, using the existing mode of the file.
20887
20888
20889 .option notify_comsat appendfile boolean false
20890 If this option is true, the &'comsat'& daemon is notified after every
20891 successful delivery to a user mailbox. This is the daemon that notifies logged
20892 on users about incoming mail.
20893
20894
20895 .option quota appendfile string&!! unset
20896 .cindex "quota" "imposed by Exim"
20897 This option imposes a limit on the size of the file to which Exim is appending,
20898 or to the total space used in the directory tree when the &%directory%& option
20899 is set. In the latter case, computation of the space used is expensive, because
20900 all the files in the directory (and any sub-directories) have to be
20901 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20902 &%maildir_use_size_file%& for ways to avoid this in environments where users
20903 have no shell access to their mailboxes).
20904
20905 As there is no interlock against two simultaneous deliveries into a
20906 multi-file mailbox, it is possible for the quota to be overrun in this case.
20907 For single-file mailboxes, of course, an interlock is a necessity.
20908
20909 A file's size is taken as its &'used'& value. Because of blocking effects, this
20910 may be a lot less than the actual amount of disk space allocated to the file.
20911 If the sizes of a number of files are being added up, the rounding effect can
20912 become quite noticeable, especially on systems that have large block sizes.
20913 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20914 the obvious value which users understand most easily.
20915
20916 The value of the option is expanded, and must then be a numerical value
20917 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20918 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20919 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20920 be handled.
20921
20922 &*Note*&: A value of zero is interpreted as &"no quota"&.
20923
20924 The expansion happens while Exim is running as root, before it changes uid for
20925 the delivery. This means that files that are inaccessible to the end user can
20926 be used to hold quota values that are looked up in the expansion. When delivery
20927 fails because this quota is exceeded, the handling of the error is as for
20928 system quota failures.
20929
20930 By default, Exim's quota checking mimics system quotas, and restricts the
20931 mailbox to the specified maximum size, though the value is not accurate to the
20932 last byte, owing to separator lines and additional headers that may get added
20933 during message delivery. When a mailbox is nearly full, large messages may get
20934 refused even though small ones are accepted, because the size of the current
20935 message is added to the quota when the check is made. This behaviour can be
20936 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20937 for exceeding the quota does not include the current message. Thus, deliveries
20938 continue until the quota has been exceeded; thereafter, no further messages are
20939 delivered. See also &%quota_warn_threshold%&.
20940
20941
20942 .option quota_directory appendfile string&!! unset
20943 This option defines the directory to check for quota purposes when delivering
20944 into individual files. The default is the delivery directory, or, if a file
20945 called &_maildirfolder_& exists in a maildir directory, the parent of the
20946 delivery directory.
20947
20948
20949 .option quota_filecount appendfile string&!! 0
20950 This option applies when the &%directory%& option is set. It limits the total
20951 number of files in the directory (compare the inode limit in system quotas). It
20952 can only be used if &%quota%& is also set. The value is expanded; an expansion
20953 failure causes delivery to be deferred. A value of zero is interpreted as
20954 &"no quota"&.
20955
20956
20957 .option quota_is_inclusive appendfile boolean true
20958 See &%quota%& above.
20959
20960
20961 .option quota_size_regex appendfile string unset
20962 This option applies when one of the delivery modes that writes a separate file
20963 for each message is being used. When Exim wants to find the size of one of
20964 these files in order to test the quota, it first checks &%quota_size_regex%&.
20965 If this is set to a regular expression that matches the file name, and it
20966 captures one string, that string is interpreted as a representation of the
20967 file's size. The value of &%quota_size_regex%& is not expanded.
20968
20969 This feature is useful only when users have no shell access to their mailboxes
20970 &-- otherwise they could defeat the quota simply by renaming the files. This
20971 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20972 the file length to the file name. For example:
20973 .code
20974 maildir_tag = ,S=$message_size
20975 quota_size_regex = ,S=(\d+)
20976 .endd
20977 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20978 number of lines in the message.
20979
20980 The regular expression should not assume that the length is at the end of the
20981 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20982 sometimes add other information onto the ends of message file names.
20983
20984 Section &<<SECID136>>& contains further information.
20985
20986
20987 .option quota_warn_message appendfile string&!! "see below"
20988 See below for the use of this option. If it is not set when
20989 &%quota_warn_threshold%& is set, it defaults to
20990 .code
20991 quota_warn_message = "\
20992   To: $local_part@$domain\n\
20993   Subject: Your mailbox\n\n\
20994   This message is automatically created \
20995   by mail delivery software.\n\n\
20996   The size of your mailbox has exceeded \
20997   a warning threshold that is\n\
20998   set by the system administrator.\n"
20999 .endd
21000
21001
21002 .option quota_warn_threshold appendfile string&!! 0
21003 .cindex "quota" "warning threshold"
21004 .cindex "mailbox" "size warning"
21005 .cindex "size" "of mailbox"
21006 This option is expanded in the same way as &%quota%& (see above). If the
21007 resulting value is greater than zero, and delivery of the message causes the
21008 size of the file or total space in the directory tree to cross the given
21009 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21010 may be specified as a percentage of it by following the value with a percent
21011 sign. For example:
21012 .code
21013 quota = 10M
21014 quota_warn_threshold = 75%
21015 .endd
21016 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21017 percent sign is ignored.
21018
21019 The warning message itself is specified by the &%quota_warn_message%& option,
21020 and it must start with a &'To:'& header line containing the recipient(s) of the
21021 warning message. These do not necessarily have to include the recipient(s) of
21022 the original message. A &'Subject:'& line should also normally be supplied. You
21023 can include any other header lines that you want. If you do not include a
21024 &'From:'& line, the default is:
21025 .code
21026 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21027 .endd
21028 .oindex &%errors_reply_to%&
21029 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21030 option.
21031
21032 The &%quota%& option does not have to be set in order to use this option; they
21033 are independent of one another except when the threshold is specified as a
21034 percentage.
21035
21036
21037 .option use_bsmtp appendfile boolean false
21038 .cindex "envelope sender"
21039 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21040 format, with the envelope sender and recipient(s) included as SMTP commands. If
21041 you want to include a leading HELO command with such messages, you can do
21042 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21043 for details of batch SMTP.
21044
21045
21046 .option use_crlf appendfile boolean false
21047 .cindex "carriage return"
21048 .cindex "linefeed"
21049 This option causes lines to be terminated with the two-character CRLF sequence
21050 (carriage return, linefeed) instead of just a linefeed character. In the case
21051 of batched SMTP, the byte sequence written to the file is then an exact image
21052 of what would be sent down a real SMTP connection.
21053
21054 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21055 (which are used to supply the traditional &"From&~"& and blank line separators
21056 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21057 carriage return characters if these are needed. In cases where these options
21058 have non-empty defaults, the values end with a single linefeed, so they must be
21059 changed to end with &`\r\n`& if &%use_crlf%& is set.
21060
21061
21062 .option use_fcntl_lock appendfile boolean "see below"
21063 This option controls the use of the &[fcntl()]& function to lock a file for
21064 exclusive use when a message is being appended. It is set by default unless
21065 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21066 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21067 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21068
21069
21070 .option use_flock_lock appendfile boolean false
21071 This option is provided to support the use of &[flock()]& for file locking, for
21072 the few situations where it is needed. Most modern operating systems support
21073 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21074 each other. Exim uses &[fcntl()]& locking by default.
21075
21076 This option is required only if you are using an operating system where
21077 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21078 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21079 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21080
21081 .cindex "Solaris" "&[flock()]& support"
21082 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21083 have it (and some, I think, provide a not quite right version built on top of
21084 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21085 the ability to use it, and any attempt to do so will cause a configuration
21086 error.
21087
21088 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21089 is just being mapped onto &[fcntl()]& by the OS).
21090
21091
21092 .option use_lockfile appendfile boolean "see below"
21093 If this option is turned off, Exim does not attempt to create a lock file when
21094 appending to a mailbox file. In this situation, the only locking is by
21095 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21096 sure that every MUA that is ever going to look at your users' mailboxes uses
21097 &[fcntl()]& rather than a lock file, and even then only when you are not
21098 delivering over NFS from more than one host.
21099
21100 .cindex "NFS" "lock file"
21101 In order to append to an NFS file safely from more than one host, it is
21102 necessary to take out a lock &'before'& opening the file, and the lock file
21103 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21104 file corruption.
21105
21106 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21107 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21108 except when &%mbx_format%& is set.
21109
21110
21111 .option use_mbx_lock appendfile boolean "see below"
21112 This option is available only if Exim has been compiled with SUPPORT_MBX
21113 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21114 locking rules be used. It is set by default if &%mbx_format%& is set and none
21115 of the locking options are mentioned in the configuration. The locking rules
21116 are the same as are used by the &'c-client'& library that underlies Pine and
21117 the IMAP4 and POP daemons that come with it (see the discussion below). The
21118 rules allow for shared access to the mailbox. However, this kind of locking
21119 does not work when the mailbox is NFS mounted.
21120
21121 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21122 &%use_flock_lock%& to control what kind of locking is used in implementing the
21123 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21124 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21125
21126
21127
21128
21129 .section "Operational details for appending" "SECTopappend"
21130 .cindex "appending to a file"
21131 .cindex "file" "appending"
21132 Before appending to a file, the following preparations are made:
21133
21134 .ilist
21135 If the name of the file is &_/dev/null_&, no action is taken, and a success
21136 return is given.
21137
21138 .next
21139 .cindex "directory creation"
21140 If any directories on the file's path are missing, Exim creates them if the
21141 &%create_directory%& option is set. A created directory's mode is given by the
21142 &%directory_mode%& option.
21143
21144 .next
21145 If &%file_format%& is set, the format of an existing file is checked. If this
21146 indicates that a different transport should be used, control is passed to that
21147 transport.
21148
21149 .next
21150 .cindex "file" "locking"
21151 .cindex "locking files"
21152 .cindex "NFS" "lock file"
21153 If &%use_lockfile%& is set, a lock file is built in a way that will work
21154 reliably over NFS, as follows:
21155
21156 .olist
21157 Create a &"hitching post"& file whose name is that of the lock file with the
21158 current time, primary host name, and process id added, by opening for writing
21159 as a new file. If this fails with an access error, delivery is deferred.
21160 .next
21161 Close the hitching post file, and hard link it to the lock file name.
21162 .next
21163 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21164 Unlink the hitching post name.
21165 .next
21166 Otherwise, use &[stat()]& to get information about the hitching post file, and
21167 then unlink hitching post name. If the number of links is exactly two, creation
21168 of the lock file succeeded but something (for example, an NFS server crash and
21169 restart) caused this fact not to be communicated to the &[link()]& call.
21170 .next
21171 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21172 up to &%lock_retries%& times. However, since any program that writes to a
21173 mailbox should complete its task very quickly, it is reasonable to time out old
21174 lock files that are normally the result of user agent and system crashes. If an
21175 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21176 it before trying again.
21177 .endlist olist
21178
21179 .next
21180 A call is made to &[lstat()]& to discover whether the main file exists, and if
21181 so, what its characteristics are. If &[lstat()]& fails for any reason other
21182 than non-existence, delivery is deferred.
21183
21184 .next
21185 .cindex "symbolic link" "to mailbox"
21186 .cindex "mailbox" "symbolic link"
21187 If the file does exist and is a symbolic link, delivery is deferred, unless the
21188 &%allow_symlink%& option is set, in which case the ownership of the link is
21189 checked, and then &[stat()]& is called to find out about the real file, which
21190 is then subjected to the checks below. The check on the top-level link
21191 ownership prevents one user creating a link for another's mailbox in a sticky
21192 directory, though allowing symbolic links in this case is definitely not a good
21193 idea. If there is a chain of symbolic links, the intermediate ones are not
21194 checked.
21195
21196 .next
21197 If the file already exists but is not a regular file, or if the file's owner
21198 and group (if the group is being checked &-- see &%check_group%& above) are
21199 different from the user and group under which the delivery is running,
21200 delivery is deferred.
21201
21202 .next
21203 If the file's permissions are more generous than specified, they are reduced.
21204 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21205 is set false, in which case the delivery is tried using the existing
21206 permissions.
21207
21208 .next
21209 The file's inode number is saved, and the file is then opened for appending.
21210 If this fails because the file has vanished, &(appendfile)& behaves as if it
21211 hadn't existed (see below). For any other failures, delivery is deferred.
21212
21213 .next
21214 If the file is opened successfully, check that the inode number hasn't
21215 changed, that it is still a regular file, and that the owner and permissions
21216 have not changed. If anything is wrong, defer delivery and freeze the message.
21217
21218 .next
21219 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21220 option is set. Otherwise, check that the file is being created in a permitted
21221 directory if the &%create_file%& option is set (deferring on failure), and then
21222 open for writing as a new file, with the O_EXCL and O_CREAT options,
21223 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21224 set). In this case, which can happen if the link points to a non-existent file,
21225 the file is opened for writing using O_CREAT but not O_EXCL, because
21226 that prevents link following.
21227
21228 .next
21229 .cindex "loop" "while file testing"
21230 If opening fails because the file exists, obey the tests given above for
21231 existing files. However, to avoid looping in a situation where the file is
21232 being continuously created and destroyed, the exists/not-exists loop is broken
21233 after 10 repetitions, and the message is then frozen.
21234
21235 .next
21236 If opening fails with any other error, defer delivery.
21237
21238 .next
21239 .cindex "file" "locking"
21240 .cindex "locking files"
21241 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21242 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21243 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21244 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21245 file, and an exclusive lock on the file whose name is
21246 .code
21247 /tmp/.<device-number>.<inode-number>
21248 .endd
21249 using the device and inode numbers of the open mailbox file, in accordance with
21250 the MBX locking rules. This file is created with a mode that is specified by
21251 the &%lockfile_mode%& option.
21252
21253 If Exim fails to lock the file, there are two possible courses of action,
21254 depending on the value of the locking timeout. This is obtained from
21255 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21256
21257 If the timeout value is zero, the file is closed, Exim waits for
21258 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21259 to lock it again. This happens up to &%lock_retries%& times, after which the
21260 delivery is deferred.
21261
21262 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21263 &[flock()]& are used (with the given timeout), so there has already been some
21264 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21265 immediately. It retries up to
21266 .code
21267 (lock_retries * lock_interval) / <timeout>
21268 .endd
21269 times (rounded up).
21270 .endlist
21271
21272 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21273 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21274
21275
21276 .section "Operational details for delivery to a new file" "SECTopdir"
21277 .cindex "delivery" "to single file"
21278 .cindex "&""From""& line"
21279 When the &%directory%& option is set instead of &%file%&, each message is
21280 delivered into a newly-created file or set of files. When &(appendfile)& is
21281 activated directly from a &(redirect)& router, neither &%file%& nor
21282 &%directory%& is normally set, because the path for delivery is supplied by the
21283 router. (See for example, the &(address_file)& transport in the default
21284 configuration.) In this case, delivery is to a new file if either the path name
21285 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21286
21287 No locking is required while writing the message to a new file, so the various
21288 locking options of the transport are ignored. The &"From"& line that by default
21289 separates messages in a single file is not normally needed, nor is the escaping
21290 of message lines that start with &"From"&, and there is no need to ensure a
21291 newline at the end of each message. Consequently, the default values for
21292 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21293 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21294
21295 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21296 the files in the delivery directory by default. However, you can specify a
21297 different directory by setting &%quota_directory%&. Also, for maildir
21298 deliveries (see below) the &_maildirfolder_& convention is honoured.
21299
21300
21301 .cindex "maildir format"
21302 .cindex "mailstore format"
21303 There are three different ways in which delivery to individual files can be
21304 done, controlled by the settings of the &%maildir_format%& and
21305 &%mailstore_format%& options. Note that code to support maildir or mailstore
21306 formats is not included in the binary unless SUPPORT_MAILDIR or
21307 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21308
21309 .cindex "directory creation"
21310 In all three cases an attempt is made to create the directory and any necessary
21311 sub-directories if they do not exist, provided that the &%create_directory%&
21312 option is set (the default). The location of a created directory can be
21313 constrained by setting &%create_file%&. A created directory's mode is given by
21314 the &%directory_mode%& option. If creation fails, or if the
21315 &%create_directory%& option is not set when creation is required, delivery is
21316 deferred.
21317
21318
21319
21320 .section "Maildir delivery" "SECTmaildirdelivery"
21321 .cindex "maildir format" "description of"
21322 If the &%maildir_format%& option is true, Exim delivers each message by writing
21323 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21324 directory that is defined by the &%directory%& option (the &"delivery
21325 directory"&). If the delivery is successful, the file is renamed into the
21326 &_new_& subdirectory.
21327
21328 In the file name, <&'stime'&> is the current time of day in seconds, and
21329 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21330 Exim checks that the time-of-day clock has moved on by at least one microsecond
21331 before terminating the delivery process. This guarantees uniqueness for the
21332 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21333 opening it. If any response other than ENOENT (does not exist) is given,
21334 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21335
21336 Before Exim carries out a maildir delivery, it ensures that subdirectories
21337 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21338 do not exist, Exim tries to create them and any superior directories in their
21339 path, subject to the &%create_directory%& and &%create_file%& options. If the
21340 &%maildirfolder_create_regex%& option is set, and the regular expression it
21341 contains matches the delivery directory, Exim also ensures that a file called
21342 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21343 &_maildirfolder_& file cannot be created, delivery is deferred.
21344
21345 These features make it possible to use Exim to create all the necessary files
21346 and directories in a maildir mailbox, including subdirectories for maildir++
21347 folders. Consider this example:
21348 .code
21349 maildir_format = true
21350 directory = /var/mail/$local_part\
21351            ${if eq{$local_part_suffix}{}{}\
21352            {/.${substr_1:$local_part_suffix}}}
21353 maildirfolder_create_regex = /\.[^/]+$
21354 .endd
21355 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21356 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21357 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21358 not match this name, so Exim will not look for or create the file
21359 &_/var/mail/pimbo/maildirfolder_&, though it will create
21360 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21361
21362 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21363 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21364 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21365 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21366 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21367
21368 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21369 not inadvertently match the toplevel maildir directory, because a
21370 &_maildirfolder_& file at top level would completely break quota calculations.
21371
21372 .cindex "quota" "in maildir delivery"
21373 .cindex "maildir++"
21374 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21375 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21376 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21377 Exim assumes the directory is a maildir++ folder directory, which is one level
21378 down from the user's top level mailbox directory. This causes it to start at
21379 the parent directory instead of the current directory when calculating the
21380 amount of space used.
21381
21382 One problem with delivering into a multi-file mailbox is that it is
21383 computationally expensive to compute the size of the mailbox for quota
21384 checking. Various approaches have been taken to reduce the amount of work
21385 needed. The next two sections describe two of them. A third alternative is to
21386 use some external process for maintaining the size data, and use the expansion
21387 of the &%mailbox_size%& option as a way of importing it into Exim.
21388
21389
21390
21391
21392 .section "Using tags to record message sizes" "SECID135"
21393 If &%maildir_tag%& is set, the string is expanded for each delivery.
21394 When the maildir file is renamed into the &_new_& sub-directory, the
21395 tag is added to its name. However, if adding the tag takes the length of the
21396 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21397 the tag is dropped and the maildir file is created with no tag.
21398
21399
21400 .vindex "&$message_size$&"
21401 Tags can be used to encode the size of files in their names; see
21402 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21403 happens after the message has been written. The value of the &$message_size$&
21404 variable is set to the number of bytes actually written. If the expansion is
21405 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21406 be deferred. The expanded tag may contain any printing characters except &"/"&.
21407 Non-printing characters in the string are ignored; if the resulting string is
21408 empty, it is ignored. If it starts with an alphanumeric character, a leading
21409 colon is inserted; this default has not proven to be the path that popular
21410 maildir implementations have chosen (but changing it in Exim would break
21411 backwards compatibility).
21412
21413 For one common implementation, you might set:
21414 .code
21415 maildir_tag = ,S=${message_size}
21416 .endd
21417 but you should check the documentation of the other software to be sure.
21418
21419 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21420 as this allows Exim to extract the size from your tag, instead of having to
21421 &[stat()]& each message file.
21422
21423
21424 .section "Using a maildirsize file" "SECID136"
21425 .cindex "quota" "in maildir delivery"
21426 .cindex "maildir format" "&_maildirsize_& file"
21427 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21428 storing quota and message size information in a file called &_maildirsize_&
21429 within the toplevel maildir directory. If this file does not exist, Exim
21430 creates it, setting the quota from the &%quota%& option of the transport. If
21431 the maildir directory itself does not exist, it is created before any attempt
21432 to write a &_maildirsize_& file.
21433
21434 The &_maildirsize_& file is used to hold information about the sizes of
21435 messages in the maildir, thus speeding up quota calculations. The quota value
21436 in the file is just a cache; if the quota is changed in the transport, the new
21437 value overrides the cached value when the next message is delivered. The cache
21438 is maintained for the benefit of other programs that access the maildir and
21439 need to know the quota.
21440
21441 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21442 file is maintained (with a zero quota setting), but no quota is imposed.
21443
21444 A regular expression is available for controlling which directories in the
21445 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21446 See the description of the &%maildir_quota_directory_regex%& option above for
21447 details.
21448
21449
21450 .section "Mailstore delivery" "SECID137"
21451 .cindex "mailstore format" "description of"
21452 If the &%mailstore_format%& option is true, each message is written as two
21453 files in the given directory. A unique base name is constructed from the
21454 message id and the current delivery process, and the files that are written use
21455 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21456 contains the message's envelope, and the &_.msg_& file contains the message
21457 itself. The base name is placed in the variable &$mailstore_basename$&.
21458
21459 During delivery, the envelope is first written to a file with the suffix
21460 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21461 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21462 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21463 file before accessing either of them. An alternative approach is to wait for
21464 the absence of a &_.tmp_& file.
21465
21466 The envelope file starts with any text defined by the &%mailstore_prefix%&
21467 option, expanded and terminated by a newline if there isn't one. Then follows
21468 the sender address on one line, then all the recipient addresses, one per line.
21469 There can be more than one recipient only if the &%batch_max%& option is set
21470 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21471 appended to the file, followed by a newline if it does not end with one.
21472
21473 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21474 failure, it is ignored. Other expansion errors are treated as serious
21475 configuration errors, and delivery is deferred. The variable
21476 &$mailstore_basename$& is available for use during these expansions.
21477
21478
21479 .section "Non-special new file delivery" "SECID138"
21480 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21481 file is created directly in the named directory. For example, when delivering
21482 messages into files in batched SMTP format for later delivery to some host (see
21483 section &<<SECTbatchSMTP>>&), a setting such as
21484 .code
21485 directory = /var/bsmtp/$host
21486 .endd
21487 might be used. A message is written to a file with a temporary name, which is
21488 then renamed when the delivery is complete. The final name is obtained by
21489 expanding the contents of the &%directory_file%& option.
21490 .ecindex IIDapptra1
21491 .ecindex IIDapptra2
21492
21493
21494
21495
21496
21497
21498 . ////////////////////////////////////////////////////////////////////////////
21499 . ////////////////////////////////////////////////////////////////////////////
21500
21501 .chapter "The autoreply transport" "CHID8"
21502 .scindex IIDauttra1 "transports" "&(autoreply)&"
21503 .scindex IIDauttra2 "&(autoreply)& transport"
21504 The &(autoreply)& transport is not a true transport in that it does not cause
21505 the message to be transmitted. Instead, it generates a new mail message as an
21506 automatic reply to the incoming message. &'References:'& and
21507 &'Auto-Submitted:'& header lines are included. These are constructed according
21508 to the rules in RFCs 2822 and 3834, respectively.
21509
21510 If the router that passes the message to this transport does not have the
21511 &%unseen%& option set, the original message (for the current recipient) is not
21512 delivered anywhere. However, when the &%unseen%& option is set on the router
21513 that passes the message to this transport, routing of the address continues, so
21514 another router can set up a normal message delivery.
21515
21516
21517 The &(autoreply)& transport is usually run as the result of mail filtering, a
21518 &"vacation"& message being the standard example. However, it can also be run
21519 directly from a router like any other transport. To reduce the possibility of
21520 message cascades, messages created by the &(autoreply)& transport always have
21521 empty envelope sender addresses, like bounce messages.
21522
21523 The parameters of the message to be sent can be specified in the configuration
21524 by options described below. However, these are used only when the address
21525 passed to the transport does not contain its own reply information. When the
21526 transport is run as a consequence of a
21527 &%mail%&
21528 or &%vacation%& command in a filter file, the parameters of the message are
21529 supplied by the filter, and passed with the address. The transport's options
21530 that define the message are then ignored (so they are not usually set in this
21531 case). The message is specified entirely by the filter or by the transport; it
21532 is never built from a mixture of options. However, the &%file_optional%&,
21533 &%mode%&, and &%return_message%& options apply in all cases.
21534
21535 &(Autoreply)& is implemented as a local transport. When used as a result of a
21536 command in a user's filter file, &(autoreply)& normally runs under the uid and
21537 gid of the user, and with appropriate current and home directories (see chapter
21538 &<<CHAPenvironment>>&).
21539
21540 There is a subtle difference between routing a message to a &(pipe)& transport
21541 that generates some text to be returned to the sender, and routing it to an
21542 &(autoreply)& transport. This difference is noticeable only if more than one
21543 address from the same message is so handled. In the case of a pipe, the
21544 separate outputs from the different addresses are gathered up and returned to
21545 the sender in a single message, whereas if &(autoreply)& is used, a separate
21546 message is generated for each address that is passed to it.
21547
21548 Non-printing characters are not permitted in the header lines generated for the
21549 message that &(autoreply)& creates, with the exception of newlines that are
21550 immediately followed by white space. If any non-printing characters are found,
21551 the transport defers.
21552 Whether characters with the top bit set count as printing characters or not is
21553 controlled by the &%print_topbitchars%& global option.
21554
21555 If any of the generic options for manipulating headers (for example,
21556 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21557 of the original message that is included in the generated message when
21558 &%return_message%& is set. They do not apply to the generated message itself.
21559
21560 .vindex "&$sender_address$&"
21561 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21562 the message, indicating that there were no recipients, it does not treat this
21563 as an error. This means that autoreplies sent to &$sender_address$& when this
21564 is empty (because the incoming message is a bounce message) do not cause
21565 problems. They are just discarded.
21566
21567
21568
21569 .section "Private options for autoreply" "SECID139"
21570 .cindex "options" "&(autoreply)& transport"
21571
21572 .option bcc autoreply string&!! unset
21573 This specifies the addresses that are to receive &"blind carbon copies"& of the
21574 message when the message is specified by the transport.
21575
21576
21577 .option cc autoreply string&!! unset
21578 This specifies recipients of the message and the contents of the &'Cc:'& header
21579 when the message is specified by the transport.
21580
21581
21582 .option file autoreply string&!! unset
21583 The contents of the file are sent as the body of the message when the message
21584 is specified by the transport. If both &%file%& and &%text%& are set, the text
21585 string comes first.
21586
21587
21588 .option file_expand autoreply boolean false
21589 If this is set, the contents of the file named by the &%file%& option are
21590 subjected to string expansion as they are added to the message.
21591
21592
21593 .option file_optional autoreply boolean false
21594 If this option is true, no error is generated if the file named by the &%file%&
21595 option or passed with the address does not exist or cannot be read.
21596
21597
21598 .option from autoreply string&!! unset
21599 This specifies the contents of the &'From:'& header when the message is
21600 specified by the transport.
21601
21602
21603 .option headers autoreply string&!! unset
21604 This specifies additional RFC 2822 headers that are to be added to the message
21605 when the message is specified by the transport. Several can be given by using
21606 &"\n"& to separate them. There is no check on the format.
21607
21608
21609 .option log autoreply string&!! unset
21610 This option names a file in which a record of every message sent is logged when
21611 the message is specified by the transport.
21612
21613
21614 .option mode autoreply "octal integer" 0600
21615 If either the log file or the &"once"& file has to be created, this mode is
21616 used.
21617
21618
21619 .option never_mail autoreply "address list&!!" unset
21620 If any run of the transport creates a message with a recipient that matches any
21621 item in the list, that recipient is quietly discarded. If all recipients are
21622 discarded, no message is created. This applies both when the recipients are
21623 generated by a filter and when they are specified in the transport.
21624
21625
21626
21627 .option once autoreply string&!! unset
21628 This option names a file or DBM database in which a record of each &'To:'&
21629 recipient is kept when the message is specified by the transport. &*Note*&:
21630 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21631
21632 If &%once%& is unset, or is set to an empty string, the message is always sent.
21633 By default, if &%once%& is set to a non-empty file name, the message
21634 is not sent if a potential recipient is already listed in the database.
21635 However, if the &%once_repeat%& option specifies a time greater than zero, the
21636 message is sent if that much time has elapsed since a message was last sent to
21637 this recipient. A setting of zero time for &%once_repeat%& (the default)
21638 prevents a message from being sent a second time &-- in this case, zero means
21639 infinity.
21640
21641 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21642 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21643 greater than zero, it changes the way Exim implements the &%once%& option.
21644 Instead of using a DBM file to record every recipient it sends to, it uses a
21645 regular file, whose size will never get larger than the given value.
21646
21647 In the file, Exim keeps a linear list of recipient addresses and the times at
21648 which they were sent messages. If the file is full when a new address needs to
21649 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21650 means that a given recipient may receive multiple messages, but at
21651 unpredictable intervals that depend on the rate of turnover of addresses in the
21652 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21653
21654
21655 .option once_file_size autoreply integer 0
21656 See &%once%& above.
21657
21658
21659 .option once_repeat autoreply time&!! 0s
21660 See &%once%& above.
21661 After expansion, the value of this option must be a valid time value.
21662
21663
21664 .option reply_to autoreply string&!! unset
21665 This specifies the contents of the &'Reply-To:'& header when the message is
21666 specified by the transport.
21667
21668
21669 .option return_message autoreply boolean false
21670 If this is set, a copy of the original message is returned with the new
21671 message, subject to the maximum size set in the &%return_size_limit%& global
21672 configuration option.
21673
21674
21675 .option subject autoreply string&!! unset
21676 This specifies the contents of the &'Subject:'& header when the message is
21677 specified by the transport. It is tempting to quote the original subject in
21678 automatic responses. For example:
21679 .code
21680 subject = Re: $h_subject:
21681 .endd
21682 There is a danger in doing this, however. It may allow a third party to
21683 subscribe your users to an opt-in mailing list, provided that the list accepts
21684 bounce messages as subscription confirmations. Well-managed lists require a
21685 non-bounce message to confirm a subscription, so the danger is relatively
21686 small.
21687
21688
21689
21690 .option text autoreply string&!! unset
21691 This specifies a single string to be used as the body of the message when the
21692 message is specified by the transport. If both &%text%& and &%file%& are set,
21693 the text comes first.
21694
21695
21696 .option to autoreply string&!! unset
21697 This specifies recipients of the message and the contents of the &'To:'& header
21698 when the message is specified by the transport.
21699 .ecindex IIDauttra1
21700 .ecindex IIDauttra2
21701
21702
21703
21704
21705 . ////////////////////////////////////////////////////////////////////////////
21706 . ////////////////////////////////////////////////////////////////////////////
21707
21708 .chapter "The lmtp transport" "CHAPLMTP"
21709 .cindex "transports" "&(lmtp)&"
21710 .cindex "&(lmtp)& transport"
21711 .cindex "LMTP" "over a pipe"
21712 .cindex "LMTP" "over a socket"
21713 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21714 specified command
21715 or by interacting with a Unix domain socket.
21716 This transport is something of a cross between the &(pipe)& and &(smtp)&
21717 transports. Exim also has support for using LMTP over TCP/IP; this is
21718 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21719 to be of minority interest, the default build-time configure in &_src/EDITME_&
21720 has it commented out. You need to ensure that
21721 .code
21722 TRANSPORT_LMTP=yes
21723 .endd
21724 .cindex "options" "&(lmtp)& transport"
21725 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21726 included in the Exim binary. The private options of the &(lmtp)& transport are
21727 as follows:
21728
21729 .option batch_id lmtp string&!! unset
21730 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21731
21732
21733 .option batch_max lmtp integer 1
21734 This limits the number of addresses that can be handled in a single delivery.
21735 Most LMTP servers can handle several addresses at once, so it is normally a
21736 good idea to increase this value. See the description of local delivery
21737 batching in chapter &<<CHAPbatching>>&.
21738
21739
21740 .option command lmtp string&!! unset
21741 This option must be set if &%socket%& is not set. The string is a command which
21742 is run in a separate process. It is split up into a command name and list of
21743 arguments, each of which is separately expanded (so expansion cannot change the
21744 number of arguments). The command is run directly, not via a shell. The message
21745 is passed to the new process using the standard input and output to operate the
21746 LMTP protocol.
21747
21748 .option ignore_quota lmtp boolean false
21749 .cindex "LMTP" "ignoring quota errors"
21750 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21751 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21752 in its response to the LHLO command.
21753
21754 .option socket lmtp string&!! unset
21755 This option must be set if &%command%& is not set. The result of expansion must
21756 be the name of a Unix domain socket. The transport connects to the socket and
21757 delivers the message to it using the LMTP protocol.
21758
21759
21760 .option timeout lmtp time 5m
21761 The transport is aborted if the created process or Unix domain socket does not
21762 respond to LMTP commands or message input within this timeout. Delivery
21763 is deferred, and will be tried again later. Here is an example of a typical
21764 LMTP transport:
21765 .code
21766 lmtp:
21767   driver = lmtp
21768   command = /some/local/lmtp/delivery/program
21769   batch_max = 20
21770   user = exim
21771 .endd
21772 This delivers up to 20 addresses at a time, in a mixture of domains if
21773 necessary, running as the user &'exim'&.
21774
21775
21776
21777 . ////////////////////////////////////////////////////////////////////////////
21778 . ////////////////////////////////////////////////////////////////////////////
21779
21780 .chapter "The pipe transport" "CHAPpipetransport"
21781 .scindex IIDpiptra1 "transports" "&(pipe)&"
21782 .scindex IIDpiptra2 "&(pipe)& transport"
21783 The &(pipe)& transport is used to deliver messages via a pipe to a command
21784 running in another process. One example is the use of &(pipe)& as a
21785 pseudo-remote transport for passing messages to some other delivery mechanism
21786 (such as UUCP). Another is the use by individual users to automatically process
21787 their incoming messages. The &(pipe)& transport can be used in one of the
21788 following ways:
21789
21790 .ilist
21791 .vindex "&$local_part$&"
21792 A router routes one address to a transport in the normal way, and the
21793 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21794 contains the local part of the address (as usual), and the command that is run
21795 is specified by the &%command%& option on the transport.
21796 .next
21797 .vindex "&$pipe_addresses$&"
21798 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21799 transport can handle more than one address in a single run. In this case, when
21800 more than one address is routed to the transport, &$local_part$& is not set
21801 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21802 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21803 that are routed to the transport.
21804 .next
21805 .vindex "&$address_pipe$&"
21806 A router redirects an address directly to a pipe command (for example, from an
21807 alias or forward file). In this case, &$address_pipe$& contains the text of the
21808 pipe command, and the &%command%& option on the transport is ignored unless
21809 &%force_command%& is set. If only one address is being transported
21810 (&%batch_max%& is not greater than one, or only one address was redirected to
21811 this pipe command), &$local_part$& contains the local part that was redirected.
21812 .endlist
21813
21814
21815 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21816 deliver messages over pipes using the LMTP interactive protocol. This is
21817 implemented by the &(lmtp)& transport.
21818
21819 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21820 &_.forward_& file, the command runs under the uid and gid of that user. In
21821 other cases, the uid and gid have to be specified explicitly, either on the
21822 transport or on the router that handles the address. Current and &"home"&
21823 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21824 details of the local delivery environment and chapter &<<CHAPbatching>>&
21825 for a discussion of local delivery batching.
21826
21827
21828 .section "Concurrent delivery" "SECID140"
21829 If two messages arrive at almost the same time, and both are routed to a pipe
21830 delivery, the two pipe transports may be run concurrently. You must ensure that
21831 any pipe commands you set up are robust against this happening. If the commands
21832 write to a file, the &%exim_lock%& utility might be of use.
21833
21834
21835
21836
21837 .section "Returned status and data" "SECID141"
21838 .cindex "&(pipe)& transport" "returned data"
21839 If the command exits with a non-zero return code, the delivery is deemed to
21840 have failed, unless either the &%ignore_status%& option is set (in which case
21841 the return code is treated as zero), or the return code is one of those listed
21842 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21843 later"&. In this case, delivery is deferred. Details of a permanent failure are
21844 logged, but are not included in the bounce message, which merely contains
21845 &"local delivery failed"&.
21846
21847 If the command exits on a signal and the &%freeze_signal%& option is set then
21848 the message will be frozen in the queue. If that option is not set, a bounce
21849 will be sent as normal.
21850
21851 If the return code is greater than 128 and the command being run is a shell
21852 script, it normally means that the script was terminated by a signal whose
21853 value is the return code minus 128. The &%freeze_signal%& option does not
21854 apply in this case.
21855
21856 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21857 return code is set to 127. This is the value that a shell returns if it is
21858 asked to run a non-existent command. The wording for the log line suggests that
21859 a non-existent command may be the problem.
21860
21861 The &%return_output%& option can affect the result of a pipe delivery. If it is
21862 set and the command produces any output on its standard output or standard
21863 error streams, the command is considered to have failed, even if it gave a zero
21864 return code or if &%ignore_status%& is set. The output from the command is
21865 included as part of the bounce message. The &%return_fail_output%& option is
21866 similar, except that output is returned only when the command exits with a
21867 failure return code, that is, a value other than zero or a code that matches
21868 &%temp_errors%&.
21869
21870
21871
21872 .section "How the command is run" "SECThowcommandrun"
21873 .cindex "&(pipe)& transport" "path for command"
21874 The command line is (by default) broken down into a command name and arguments
21875 by the &(pipe)& transport itself. The &%allow_commands%& and
21876 &%restrict_to_path%& options can be used to restrict the commands that may be
21877 run.
21878
21879 .cindex "quoting" "in pipe command"
21880 Unquoted arguments are delimited by white space. If an argument appears in
21881 double quotes, backslash is interpreted as an escape character in the usual
21882 way. If an argument appears in single quotes, no escaping is done.
21883
21884 String expansion is applied to the command line except when it comes from a
21885 traditional &_.forward_& file (commands from a filter file are expanded). The
21886 expansion is applied to each argument in turn rather than to the whole line.
21887 For this reason, any string expansion item that contains white space must be
21888 quoted so as to be contained within a single argument. A setting such as
21889 .code
21890 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21891 .endd
21892 will not work, because the expansion item gets split between several
21893 arguments. You have to write
21894 .code
21895 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21896 .endd
21897 to ensure that it is all in one argument. The expansion is done in this way,
21898 argument by argument, so that the number of arguments cannot be changed as a
21899 result of expansion, and quotes or backslashes in inserted variables do not
21900 interact with external quoting. However, this leads to problems if you want to
21901 generate multiple arguments (or the command name plus arguments) from a single
21902 expansion. In this situation, the simplest solution is to use a shell. For
21903 example:
21904 .code
21905 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21906 .endd
21907
21908 .cindex "transport" "filter"
21909 .cindex "filter" "transport filter"
21910 .vindex "&$pipe_addresses$&"
21911 Special handling takes place when an argument consists of precisely the text
21912 &`$pipe_addresses`&. This is not a general expansion variable; the only
21913 place this string is recognized is when it appears as an argument for a pipe or
21914 transport filter command. It causes each address that is being handled to be
21915 inserted in the argument list at that point &'as a separate argument'&. This
21916 avoids any problems with spaces or shell metacharacters, and is of use when a
21917 &(pipe)& transport is handling groups of addresses in a batch.
21918
21919 .new
21920 If &%force_command%& is enabled on the transport, Special handling takes place
21921 for an argument that consists of precisely the text &`$address_pipe`&.  It
21922 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
21923 argument is inserted in the argument list at that point
21924 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
21925 the only item in the argument; in fact, if it were then &%force_command%&
21926 should behave as a no-op.  Rather, it should be used to adjust the command
21927 run while preserving the argument vector separation.
21928 .wen
21929
21930 After splitting up into arguments and expansion, the resulting command is run
21931 in a subprocess directly from the transport, &'not'& under a shell. The
21932 message that is being delivered is supplied on the standard input, and the
21933 standard output and standard error are both connected to a single pipe that is
21934 read by Exim. The &%max_output%& option controls how much output the command
21935 may produce, and the &%return_output%& and &%return_fail_output%& options
21936 control what is done with it.
21937
21938 Not running the command under a shell (by default) lessens the security risks
21939 in cases when a command from a user's filter file is built out of data that was
21940 taken from an incoming message. If a shell is required, it can of course be
21941 explicitly specified as the command to be run. However, there are circumstances
21942 where existing commands (for example, in &_.forward_& files) expect to be run
21943 under a shell and cannot easily be modified. To allow for these cases, there is
21944 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21945 works. Instead of breaking up the command line as just described, it expands it
21946 as a single string and passes the result to &_/bin/sh_&. The
21947 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21948 with &%use_shell%&, and the whole mechanism is inherently less secure.
21949
21950
21951
21952 .section "Environment variables" "SECTpipeenv"
21953 .cindex "&(pipe)& transport" "environment for command"
21954 .cindex "environment for pipe transport"
21955 The environment variables listed below are set up when the command is invoked.
21956 This list is a compromise for maximum compatibility with other MTAs. Note that
21957 the &%environment%& option can be used to add additional variables to this
21958 environment.
21959 .display
21960 &`DOMAIN            `&   the domain of the address
21961 &`HOME              `&   the home directory, if set
21962 &`HOST              `&   the host name when called from a router (see below)
21963 &`LOCAL_PART        `&   see below
21964 &`LOCAL_PART_PREFIX `&   see below
21965 &`LOCAL_PART_SUFFIX `&   see below
21966 &`LOGNAME           `&   see below
21967 &`MESSAGE_ID        `&   Exim's local ID for the message
21968 &`PATH              `&   as specified by the &%path%& option below
21969 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21970 &`RECIPIENT         `&   the complete recipient address
21971 &`SENDER            `&   the sender of the message (empty if a bounce)
21972 &`SHELL             `&   &`/bin/sh`&
21973 &`TZ                `&   the value of the &%timezone%& option, if set
21974 &`USER              `&   see below
21975 .endd
21976 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21977 router, LOCAL_PART is set to the local part of the address. When it is
21978 called as a result of a forward or alias expansion, LOCAL_PART is set to
21979 the local part of the address that was expanded. In both cases, any affixes are
21980 removed from the local part, and made available in LOCAL_PART_PREFIX and
21981 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21982 same value as LOCAL_PART for compatibility with other MTAs.
21983
21984 .cindex "HOST"
21985 HOST is set only when a &(pipe)& transport is called from a router that
21986 associates hosts with an address, typically when using &(pipe)& as a
21987 pseudo-remote transport. HOST is set to the first host name specified by
21988 the router.
21989
21990 .cindex "HOME"
21991 If the transport's generic &%home_directory%& option is set, its value is used
21992 for the HOME environment variable. Otherwise, a home directory may be set
21993 by the router's &%transport_home_directory%& option, which defaults to the
21994 user's home directory if &%check_local_user%& is set.
21995
21996
21997 .section "Private options for pipe" "SECID142"
21998 .cindex "options" "&(pipe)& transport"
21999
22000
22001
22002 .option allow_commands pipe "string list&!!" unset
22003 .cindex "&(pipe)& transport" "permitted commands"
22004 The string is expanded, and is then interpreted as a colon-separated list of
22005 permitted commands. If &%restrict_to_path%& is not set, the only commands
22006 permitted are those in the &%allow_commands%& list. They need not be absolute
22007 paths; the &%path%& option is still used for relative paths. If
22008 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22009 in the &%allow_commands%& list, or a name without any slashes that is found on
22010 the path. In other words, if neither &%allow_commands%& nor
22011 &%restrict_to_path%& is set, there is no restriction on the command, but
22012 otherwise only commands that are permitted by one or the other are allowed. For
22013 example, if
22014 .code
22015 allow_commands = /usr/bin/vacation
22016 .endd
22017 and &%restrict_to_path%& is not set, the only permitted command is
22018 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22019 &%use_shell%& is set.
22020
22021
22022 .option batch_id pipe string&!! unset
22023 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22024
22025
22026 .option batch_max pipe integer 1
22027 This limits the number of addresses that can be handled in a single delivery.
22028 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22029
22030
22031 .option check_string pipe string unset
22032 As &(pipe)& writes the message, the start of each line is tested for matching
22033 &%check_string%&, and if it does, the initial matching characters are replaced
22034 by the contents of &%escape_string%&, provided both are set. The value of
22035 &%check_string%& is a literal string, not a regular expression, and the case of
22036 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22037 of &%check_string%& and &%escape_string%& are forced to values that implement
22038 the SMTP escaping protocol. Any settings made in the configuration file are
22039 ignored.
22040
22041
22042 .option command pipe string&!! unset
22043 This option need not be set when &(pipe)& is being used to deliver to pipes
22044 obtained directly from address redirections. In other cases, the option must be
22045 set, to provide a command to be run. It need not yield an absolute path (see
22046 the &%path%& option below). The command is split up into separate arguments by
22047 Exim, and each argument is separately expanded, as described in section
22048 &<<SECThowcommandrun>>& above.
22049
22050
22051 .option environment pipe string&!! unset
22052 .cindex "&(pipe)& transport" "environment for command"
22053 .cindex "environment for &(pipe)& transport"
22054 This option is used to add additional variables to the environment in which the
22055 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22056 a string which is expanded, and then interpreted as a colon-separated list of
22057 environment settings of the form <&'name'&>=<&'value'&>.
22058
22059
22060 .option escape_string pipe string unset
22061 See &%check_string%& above.
22062
22063
22064 .option freeze_exec_fail pipe boolean false
22065 .cindex "exec failure"
22066 .cindex "failure of exec"
22067 .cindex "&(pipe)& transport" "failure of exec"
22068 Failure to exec the command in a pipe transport is by default treated like
22069 any other failure while running the command. However, if &%freeze_exec_fail%&
22070 is set, failure to exec is treated specially, and causes the message to be
22071 frozen, whatever the setting of &%ignore_status%&.
22072
22073
22074 .option freeze_signal pipe boolean false
22075 .cindex "signal exit"
22076 .cindex "&(pipe)& transport", "signal exit"
22077 Normally if the process run by a command in a pipe transport exits on a signal,
22078 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22079 frozen in Exim's queue instead.
22080
22081
22082 .new
22083 .option force_command pipe boolean false
22084 .cindex "force command"
22085 .cindex "&(pipe)& transport", "force command"
22086 Normally when a router redirects an address directly to a pipe command
22087 the &%command%& option on the transport is ignored.  If &%force_command%&
22088 is set, the &%command%& option will used. This is especially
22089 useful for forcing a wrapper or additional argument to be added to the
22090 command. For example:
22091 .code
22092 command = /usr/bin/remote_exec myhost -- $address_pipe
22093 force_command
22094 .endd
22095
22096 Note that &$address_pipe$& is handled specially in &%command%& when
22097 &%force_command%& is set, expanding out to the original argument vector as
22098 separate items, similarly to a Unix shell &`"$@"`& construct.
22099 .wen
22100
22101 .option ignore_status pipe boolean false
22102 If this option is true, the status returned by the subprocess that is set up to
22103 run the command is ignored, and Exim behaves as if zero had been returned.
22104 Otherwise, a non-zero status or termination by signal causes an error return
22105 from the transport unless the status value is one of those listed in
22106 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22107
22108 &*Note*&: This option does not apply to timeouts, which do not return a status.
22109 See the &%timeout_defer%& option for how timeouts are handled.
22110
22111 .option log_defer_output pipe boolean false
22112 .cindex "&(pipe)& transport" "logging output"
22113 If this option is set, and the status returned by the command is
22114 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22115 and any output was produced, the first line of it is written to the main log.
22116
22117
22118 .option log_fail_output pipe boolean false
22119 If this option is set, and the command returns any output, and also ends with a
22120 return code that is neither zero nor one of the return codes listed in
22121 &%temp_errors%& (that is, the delivery failed), the first line of output is
22122 written to the main log. This option and &%log_output%& are mutually exclusive.
22123 Only one of them may be set.
22124
22125
22126
22127 .option log_output pipe boolean false
22128 If this option is set and the command returns any output, the first line of
22129 output is written to the main log, whatever the return code. This option and
22130 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22131
22132
22133
22134 .option max_output pipe integer 20K
22135 This specifies the maximum amount of output that the command may produce on its
22136 standard output and standard error file combined. If the limit is exceeded, the
22137 process running the command is killed. This is intended as a safety measure to
22138 catch runaway processes. The limit is applied independently of the settings of
22139 the options that control what is done with such output (for example,
22140 &%return_output%&). Because of buffering effects, the amount of output may
22141 exceed the limit by a small amount before Exim notices.
22142
22143
22144 .option message_prefix pipe string&!! "see below"
22145 The string specified here is expanded and output at the start of every message.
22146 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22147 .code
22148 message_prefix = \
22149   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22150   ${tod_bsdinbox}\n
22151 .endd
22152 .cindex "Cyrus"
22153 .cindex "&%tmail%&"
22154 .cindex "&""From""& line"
22155 This is required by the commonly used &_/usr/bin/vacation_& program.
22156 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22157 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22158 setting
22159 .code
22160 message_prefix =
22161 .endd
22162 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22163 &`\n`& to &`\r\n`& in &%message_prefix%&.
22164
22165
22166 .option message_suffix pipe string&!! "see below"
22167 The string specified here is expanded and output at the end of every message.
22168 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22169 The suffix can be suppressed by setting
22170 .code
22171 message_suffix =
22172 .endd
22173 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22174 &`\n`& to &`\r\n`& in &%message_suffix%&.
22175
22176
22177 .option path pipe string "see below"
22178 This option specifies the string that is set up in the PATH environment
22179 variable of the subprocess. The default is:
22180 .code
22181 /bin:/usr/bin
22182 .endd
22183 If the &%command%& option does not yield an absolute path name, the command is
22184 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22185 apply to a command specified as a transport filter.
22186
22187
22188 .option permit_coredump pipe boolean false
22189 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22190 a core-dump of a pipe command, enable this command.  This enables core-dumps
22191 during delivery and affects both the Exim binary and the pipe command run.
22192 It is recommended that this option remain off unless and until you have a need
22193 for it and that this only be enabled when needed, as the risk of excessive
22194 resource consumption can be quite high.  Note also that Exim is typically
22195 installed as a setuid binary and most operating systems will inhibit coredumps
22196 of these by default, so further OS-specific action may be required.
22197
22198
22199 .option pipe_as_creator pipe boolean false
22200 .cindex "uid (user id)" "local delivery"
22201 If the generic &%user%& option is not set and this option is true, the delivery
22202 process is run under the uid that was in force when Exim was originally called
22203 to accept the message. If the group id is not otherwise set (via the generic
22204 &%group%& option), the gid that was in force when Exim was originally called to
22205 accept the message is used.
22206
22207
22208 .option restrict_to_path pipe boolean false
22209 When this option is set, any command name not listed in &%allow_commands%& must
22210 contain no slashes. The command is searched for only in the directories listed
22211 in the &%path%& option. This option is intended for use in the case when a pipe
22212 command has been generated from a user's &_.forward_& file. This is usually
22213 handled by a &(pipe)& transport called &%address_pipe%&.
22214
22215
22216 .option return_fail_output pipe boolean false
22217 If this option is true, and the command produced any output and ended with a
22218 return code other than zero or one of the codes listed in &%temp_errors%& (that
22219 is, the delivery failed), the output is returned in the bounce message.
22220 However, if the message has a null sender (that is, it is itself a bounce
22221 message), output from the command is discarded. This option and
22222 &%return_output%& are mutually exclusive. Only one of them may be set.
22223
22224
22225
22226 .option return_output pipe boolean false
22227 If this option is true, and the command produced any output, the delivery is
22228 deemed to have failed whatever the return code from the command, and the output
22229 is returned in the bounce message. Otherwise, the output is just discarded.
22230 However, if the message has a null sender (that is, it is a bounce message),
22231 output from the command is always discarded, whatever the setting of this
22232 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22233 of them may be set.
22234
22235
22236
22237 .option temp_errors pipe "string list" "see below"
22238 .cindex "&(pipe)& transport" "temporary failure"
22239 This option contains either a colon-separated list of numbers, or a single
22240 asterisk. If &%ignore_status%& is false
22241 and &%return_output%& is not set,
22242 and the command exits with a non-zero return code, the failure is treated as
22243 temporary and the delivery is deferred if the return code matches one of the
22244 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22245 codes are treated as permanent errors. The default setting contains the codes
22246 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22247 compiled on a system that does not define these macros, it assumes values of 75
22248 and 73, respectively.
22249
22250
22251 .option timeout pipe time 1h
22252 If the command fails to complete within this time, it is killed. This normally
22253 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22254 specifies no timeout. In order to ensure that any subprocesses created by the
22255 command are also killed, Exim makes the initial process a process group leader,
22256 and kills the whole process group on a timeout. However, this can be defeated
22257 if one of the processes starts a new process group.
22258
22259 .option timeout_defer pipe boolean false
22260 A timeout in a &(pipe)& transport, either in the command that the transport
22261 runs, or in a transport filter that is associated with it, is by default
22262 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22263 is set true, both kinds of timeout become temporary errors, causing the
22264 delivery to be deferred.
22265
22266 .option umask pipe "octal integer" 022
22267 This specifies the umask setting for the subprocess that runs the command.
22268
22269
22270 .option use_bsmtp pipe boolean false
22271 .cindex "envelope sender"
22272 If this option is set true, the &(pipe)& transport writes messages in &"batch
22273 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22274 commands. If you want to include a leading HELO command with such messages,
22275 you can do so by setting the &%message_prefix%& option. See section
22276 &<<SECTbatchSMTP>>& for details of batch SMTP.
22277
22278 .option use_classresources pipe boolean false
22279 .cindex "class resources (BSD)"
22280 This option is available only when Exim is running on FreeBSD, NetBSD, or
22281 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22282 resource limits when a &(pipe)& transport is run to perform a delivery. The
22283 limits for the uid under which the pipe is to run are obtained from the login
22284 class database.
22285
22286
22287 .option use_crlf pipe boolean false
22288 .cindex "carriage return"
22289 .cindex "linefeed"
22290 This option causes lines to be terminated with the two-character CRLF sequence
22291 (carriage return, linefeed) instead of just a linefeed character. In the case
22292 of batched SMTP, the byte sequence written to the pipe is then an exact image
22293 of what would be sent down a real SMTP connection.
22294
22295 The contents of the &%message_prefix%& and &%message_suffix%& options are
22296 written verbatim, so must contain their own carriage return characters if these
22297 are needed. When &%use_bsmtp%& is not set, the default values for both
22298 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22299 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22300
22301
22302 .option use_shell pipe boolean false
22303 .vindex "&$pipe_addresses$&"
22304 If this option is set, it causes the command to be passed to &_/bin/sh_&
22305 instead of being run directly from the transport, as described in section
22306 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22307 where the command is expected to be run under a shell and cannot easily be
22308 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22309 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22310 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22311 its &%-c%& option.
22312
22313
22314
22315 .section "Using an external local delivery agent" "SECID143"
22316 .cindex "local delivery" "using an external agent"
22317 .cindex "&'procmail'&"
22318 .cindex "external local delivery"
22319 .cindex "delivery" "&'procmail'&"
22320 .cindex "delivery" "by external agent"
22321 The &(pipe)& transport can be used to pass all messages that require local
22322 delivery to a separate local delivery agent such as &%procmail%&. When doing
22323 this, care must be taken to ensure that the pipe is run under an appropriate
22324 uid and gid. In some configurations one wants this to be a uid that is trusted
22325 by the delivery agent to supply the correct sender of the message. It may be
22326 necessary to recompile or reconfigure the delivery agent so that it trusts an
22327 appropriate user. The following is an example transport and router
22328 configuration for &%procmail%&:
22329 .code
22330 # transport
22331 procmail_pipe:
22332   driver = pipe
22333   command = /usr/local/bin/procmail -d $local_part
22334   return_path_add
22335   delivery_date_add
22336   envelope_to_add
22337   check_string = "From "
22338   escape_string = ">From "
22339   umask = 077
22340   user = $local_part
22341   group = mail
22342
22343 # router
22344 procmail:
22345   driver = accept
22346   check_local_user
22347   transport = procmail_pipe
22348 .endd
22349 In this example, the pipe is run as the local user, but with the group set to
22350 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22351 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22352 user to supply a correct sender address. If you do not specify either a
22353 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22354 home directory is the user's home directory by default.
22355
22356 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22357 .code
22358 IFS=" "
22359 .endd
22360 as shown in some &%procmail%& documentation, because Exim does not by default
22361 use a shell to run pipe commands.
22362
22363 .cindex "Cyrus"
22364 The next example shows a transport and a router for a system where local
22365 deliveries are handled by the Cyrus IMAP server.
22366 .code
22367 # transport
22368 local_delivery_cyrus:
22369   driver = pipe
22370   command = /usr/cyrus/bin/deliver \
22371             -m ${substr_1:$local_part_suffix} -- $local_part
22372   user = cyrus
22373   group = mail
22374   return_output
22375   log_output
22376   message_prefix =
22377   message_suffix =
22378
22379 # router
22380 local_user_cyrus:
22381   driver = accept
22382   check_local_user
22383   local_part_suffix = .*
22384   transport = local_delivery_cyrus
22385 .endd
22386 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22387 &%return_output%& to cause any text written by Cyrus to be returned to the
22388 sender.
22389 .ecindex IIDpiptra1
22390 .ecindex IIDpiptra2
22391
22392
22393 . ////////////////////////////////////////////////////////////////////////////
22394 . ////////////////////////////////////////////////////////////////////////////
22395
22396 .chapter "The smtp transport" "CHAPsmtptrans"
22397 .scindex IIDsmttra1 "transports" "&(smtp)&"
22398 .scindex IIDsmttra2 "&(smtp)& transport"
22399 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22400 or LMTP protocol. The list of hosts to try can either be taken from the address
22401 that is being processed (having been set up by the router), or specified
22402 explicitly for the transport. Timeout and retry processing (see chapter
22403 &<<CHAPretry>>&) is applied to each IP address independently.
22404
22405
22406 .section "Multiple messages on a single connection" "SECID144"
22407 The sending of multiple messages over a single TCP/IP connection can arise in
22408 two ways:
22409
22410 .ilist
22411 If a message contains more than &%max_rcpt%& (see below) addresses that are
22412 routed to the same host, more than one copy of the message has to be sent to
22413 that host. In this situation, multiple copies may be sent in a single run of
22414 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22415 does when it has too many addresses to send in one message also depends on the
22416 value of the global &%remote_max_parallel%& option. Details are given in
22417 section &<<SECToutSMTPTCP>>&.)
22418 .next
22419 .cindex "hints database" "remembering routing"
22420 When a message has been successfully delivered over a TCP/IP connection, Exim
22421 looks in its hints database to see if there are any other messages awaiting a
22422 connection to the same host. If there are, a new delivery process is started
22423 for one of them, and the current TCP/IP connection is passed on to it. The new
22424 process may in turn send multiple copies and possibly create yet another
22425 process.
22426 .endlist
22427
22428
22429 For each copy sent over the same TCP/IP connection, a sequence counter is
22430 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22431 no further messages are sent over that connection.
22432
22433
22434
22435 .section "Use of the $host and $host_address variables" "SECID145"
22436 .vindex "&$host$&"
22437 .vindex "&$host_address$&"
22438 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22439 &$host_address$& are the name and IP address of the first host on the host list
22440 passed by the router. However, when the transport is about to connect to a
22441 specific host, and while it is connected to that host, &$host$& and
22442 &$host_address$& are set to the values for that host. These are the values
22443 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22444 &%serialize_hosts%&, and the various TLS options are expanded.
22445
22446
22447 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22448 .vindex &$tls_bits$&
22449 .vindex &$tls_cipher$&
22450 .vindex &$tls_peerdn$&
22451 .vindex &$tls_sni$&
22452 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22453 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22454 are the values that were set when the message was received.
22455 These are the values that are used for options that are expanded before any
22456 SMTP connections are made. Just before each connection is made, these four
22457 variables are emptied. If TLS is subsequently started, they are set to the
22458 appropriate values for the outgoing connection, and these are the values that
22459 are in force when any authenticators are run and when the
22460 &%authenticated_sender%& option is expanded.
22461
22462 .new
22463 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22464 and will be removed in a future release.
22465 .wen
22466
22467
22468 .section "Private options for smtp" "SECID146"
22469 .cindex "options" "&(smtp)& transport"
22470 The private options of the &(smtp)& transport are as follows:
22471
22472
22473 .option address_retry_include_sender smtp boolean true
22474 .cindex "4&'xx'& responses" "retrying after"
22475 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22476 is the combination of sender and recipient that is delayed in subsequent queue
22477 runs until the retry time is reached. You can delay the recipient without
22478 reference to the sender (which is what earlier versions of Exim did), by
22479 setting &%address_retry_include_sender%& false. However, this can lead to
22480 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22481
22482 .option allow_localhost smtp boolean false
22483 .cindex "local host" "sending to"
22484 .cindex "fallback" "hosts specified on transport"
22485 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22486 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22487 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22488 the delivery anyway. This should be used only in special cases when the
22489 configuration ensures that no looping will result (for example, a differently
22490 configured Exim is listening on the port to which the message is sent).
22491
22492
22493 .option authenticated_sender smtp string&!! unset
22494 .cindex "Cyrus"
22495 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22496 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22497 overriding any existing authenticated sender value. If the string expansion is
22498 forced to fail, the option is ignored. Other expansion failures cause delivery
22499 to be deferred. If the result of expansion is an empty string, that is also
22500 ignored.
22501
22502 The expansion happens after the outgoing connection has been made and TLS
22503 started, if required. This means that the &$host$&, &$host_address$&,
22504 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22505 particular connection.
22506
22507 If the SMTP session is not authenticated, the expansion of
22508 &%authenticated_sender%& still happens (and can cause the delivery to be
22509 deferred if it fails), but no AUTH= item is added to MAIL commands
22510 unless &%authenticated_sender_force%& is true.
22511
22512 This option allows you to use the &(smtp)& transport in LMTP mode to
22513 deliver mail to Cyrus IMAP and provide the proper local part as the
22514 &"authenticated sender"&, via a setting such as:
22515 .code
22516 authenticated_sender = $local_part
22517 .endd
22518 This removes the need for IMAP subfolders to be assigned special ACLs to
22519 allow direct delivery to those subfolders.
22520
22521 Because of expected uses such as that just described for Cyrus (when no
22522 domain is involved), there is no checking on the syntax of the provided
22523 value.
22524
22525
22526 .option authenticated_sender_force smtp boolean false
22527 If this option is set true, the &%authenticated_sender%& option's value
22528 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22529 authenticated as a client.
22530
22531
22532 .option command_timeout smtp time 5m
22533 This sets a timeout for receiving a response to an SMTP command that has been
22534 sent out. It is also used when waiting for the initial banner line from the
22535 remote host. Its value must not be zero.
22536
22537
22538 .option connect_timeout smtp time 5m
22539 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22540 to a remote host. A setting of zero allows the system timeout (typically
22541 several minutes) to act. To have any effect, the value of this option must be
22542 less than the system timeout. However, it has been observed that on some
22543 systems there is no system timeout, which is why the default value for this
22544 option is 5 minutes, a value recommended by RFC 1123.
22545
22546
22547 .option connection_max_messages smtp integer 500
22548 .cindex "SMTP" "passed connection"
22549 .cindex "SMTP" "multiple deliveries"
22550 .cindex "multiple SMTP deliveries"
22551 This controls the maximum number of separate message deliveries that are sent
22552 over a single TCP/IP connection. If the value is zero, there is no limit.
22553 For testing purposes, this value can be overridden by the &%-oB%& command line
22554 option.
22555
22556
22557 .option data_timeout smtp time 5m
22558 This sets a timeout for the transmission of each block in the data portion of
22559 the message. As a result, the overall timeout for a message depends on the size
22560 of the message. Its value must not be zero. See also &%final_timeout%&.
22561
22562
22563 .option delay_after_cutoff smtp boolean true
22564 This option controls what happens when all remote IP addresses for a given
22565 domain have been inaccessible for so long that they have passed their retry
22566 cutoff times.
22567
22568 In the default state, if the next retry time has not been reached for any of
22569 them, the address is bounced without trying any deliveries. In other words,
22570 Exim delays retrying an IP address after the final cutoff time until a new
22571 retry time is reached, and can therefore bounce an address without ever trying
22572 a delivery, when machines have been down for a long time. Some people are
22573 unhappy at this prospect, so...
22574
22575 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22576 addresses are past their final cutoff time, Exim tries to deliver to those
22577 IP addresses that have not been tried since the message arrived. If there are
22578 none, of if they all fail, the address is bounced. In other words, it does not
22579 delay when a new message arrives, but immediately tries those expired IP
22580 addresses that haven't been tried since the message arrived. If there is a
22581 continuous stream of messages for the dead hosts, unsetting
22582 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22583 to them.
22584
22585
22586 .option dns_qualify_single smtp boolean true
22587 If the &%hosts%& or &%fallback_hosts%& option is being used,
22588 and the &%gethostbyname%& option is false,
22589 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22590 in chapter &<<CHAPdnslookup>>& for more details.
22591
22592
22593 .option dns_search_parents smtp boolean false
22594 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22595 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22596 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22597 details.
22598
22599
22600 .new
22601 .option dscp smtp string&!! unset
22602 .cindex "DCSP" "outbound"
22603 This option causes the DSCP value associated with a socket to be set to one
22604 of a number of fixed strings or to numeric value.
22605 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22606 Common values include &`throughput`&, &`mincost`&, and on newer systems
22607 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22608
22609 The outbound packets from Exim will be marked with this value in the header
22610 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22611 that these values will have any effect, not be stripped by networking
22612 equipment, or do much of anything without cooperation with your Network
22613 Engineer and those of all network operators between the source and destination.
22614 .wen
22615
22616
22617 .option fallback_hosts smtp "string list" unset
22618 .cindex "fallback" "hosts specified on transport"
22619 String expansion is not applied to this option. The argument must be a
22620 colon-separated list of host names or IP addresses, optionally also including
22621 port numbers, though the separator can be changed, as described in section
22622 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22623 item in a &%route_list%& setting for the &(manualroute)& router, as described
22624 in section &<<SECTformatonehostitem>>&.
22625
22626 Fallback hosts can also be specified on routers, which associate them with the
22627 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22628 &%fallback_hosts%& specified on the transport is used only if the address does
22629 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22630 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22631 However, &%hosts_randomize%& does apply to fallback host lists.
22632
22633 If Exim is unable to deliver to any of the hosts for a particular address, and
22634 the errors are not permanent rejections, the address is put on a separate
22635 transport queue with its host list replaced by the fallback hosts, unless the
22636 address was routed via MX records and the current host was in the original MX
22637 list. In that situation, the fallback host list is not used.
22638
22639 Once normal deliveries are complete, the fallback queue is delivered by
22640 re-running the same transports with the new host lists. If several failing
22641 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22642 copy of the message is sent.
22643
22644 The resolution of the host names on the fallback list is controlled by the
22645 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22646 both to cases when the host list comes with the address and when it is taken
22647 from &%hosts%&. This option provides a &"use a smart host only if delivery
22648 fails"& facility.
22649
22650
22651 .option final_timeout smtp time 10m
22652 This is the timeout that applies while waiting for the response to the final
22653 line containing just &"."& that terminates a message. Its value must not be
22654 zero.
22655
22656 .option gethostbyname smtp boolean false
22657 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22658 being used, names are looked up using &[gethostbyname()]&
22659 (or &[getipnodebyname()]& when available)
22660 instead of using the DNS. Of course, that function may in fact use the DNS, but
22661 it may also consult other sources of information such as &_/etc/hosts_&.
22662
22663 .option gnutls_compat_mode smtp boolean unset
22664 This option controls whether GnuTLS is used in compatibility mode in an Exim
22665 server. This reduces security slightly, but improves interworking with older
22666 implementations of TLS.
22667
22668 .option helo_data smtp string&!! "see below"
22669 .cindex "HELO" "argument, setting"
22670 .cindex "EHLO" "argument, setting"
22671 .cindex "LHLO argument setting"
22672 The value of this option is expanded after a connection to a another host has
22673 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22674 command that starts the outgoing SMTP or LMTP session. The default value of the
22675 option is:
22676 .code
22677 $primary_hostname
22678 .endd
22679 During the expansion, the variables &$host$& and &$host_address$& are set to
22680 the identity of the remote host, and the variables &$sending_ip_address$& and
22681 &$sending_port$& are set to the local IP address and port number that are being
22682 used. These variables can be used to generate different values for different
22683 servers or different local IP addresses. For example, if you want the string
22684 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22685 interface address, you could use this:
22686 .code
22687 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22688   {$primary_hostname}}
22689 .endd
22690 The use of &%helo_data%& applies both to sending messages and when doing
22691 callouts.
22692
22693 .option hosts smtp "string list&!!" unset
22694 Hosts are associated with an address by a router such as &(dnslookup)&, which
22695 finds the hosts by looking up the address domain in the DNS, or by
22696 &(manualroute)&, which has lists of hosts in its configuration. However,
22697 email addresses can be passed to the &(smtp)& transport by any router, and not
22698 all of them can provide an associated list of hosts.
22699
22700 The &%hosts%& option specifies a list of hosts to be used if the address being
22701 processed does not have any hosts associated with it. The hosts specified by
22702 &%hosts%& are also used, whether or not the address has its own hosts, if
22703 &%hosts_override%& is set.
22704
22705 The string is first expanded, before being interpreted as a colon-separated
22706 list of host names or IP addresses, possibly including port numbers. The
22707 separator may be changed to something other than colon, as described in section
22708 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22709 item in a &%route_list%& setting for the &(manualroute)& router, as described
22710 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22711 of the &(manualroute)& router is not available here.
22712
22713 If the expansion fails, delivery is deferred. Unless the failure was caused by
22714 the inability to complete a lookup, the error is logged to the panic log as
22715 well as the main log. Host names are looked up either by searching directly for
22716 address records in the DNS or by calling &[gethostbyname()]& (or
22717 &[getipnodebyname()]& when available), depending on the setting of the
22718 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22719 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22720 address are used.
22721
22722 During delivery, the hosts are tried in order, subject to their retry status,
22723 unless &%hosts_randomize%& is set.
22724
22725
22726 .option hosts_avoid_esmtp smtp "host list&!!" unset
22727 .cindex "ESMTP, avoiding use of"
22728 .cindex "HELO" "forcing use of"
22729 .cindex "EHLO" "avoiding use of"
22730 .cindex "PIPELINING" "avoiding the use of"
22731 This option is for use with broken hosts that announce ESMTP facilities (for
22732 example, PIPELINING) and then fail to implement them properly. When a host
22733 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22734 start of the SMTP session. This means that it cannot use any of the ESMTP
22735 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22736
22737
22738 .option hosts_avoid_pipelining smtp "host list&!!" unset
22739 .cindex "PIPELINING" "avoiding the use of"
22740 Exim will not use the SMTP PIPELINING extension when delivering to any host
22741 that matches this list, even if the server host advertises PIPELINING support.
22742
22743
22744 .option hosts_avoid_tls smtp "host list&!!" unset
22745 .cindex "TLS" "avoiding for certain hosts"
22746 Exim will not try to start a TLS session when delivering to any host that
22747 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22748
22749 .new
22750 .option hosts_verify_avoid_tls smtp "host list&!!" *
22751 .cindex "TLS" "avoiding for certain hosts"
22752 Exim will not try to start a TLS session for a verify callout,
22753 or when delivering in cutthrough mode,
22754 to any host that matches this list.
22755 Note that the default is to not use TLS.
22756 .wen
22757
22758
22759 .option hosts_max_try smtp integer 5
22760 .cindex "host" "maximum number to try"
22761 .cindex "limit" "number of hosts tried"
22762 .cindex "limit" "number of MX tried"
22763 .cindex "MX record" "maximum tried"
22764 This option limits the number of IP addresses that are tried for any one
22765 delivery in cases where there are temporary delivery errors. Section
22766 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22767
22768
22769 .option hosts_max_try_hardlimit smtp integer 50
22770 This is an additional check on the maximum number of IP addresses that Exim
22771 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22772 why it exists.
22773
22774
22775
22776 .option hosts_nopass_tls smtp "host list&!!" unset
22777 .cindex "TLS" "passing connection"
22778 .cindex "multiple SMTP deliveries"
22779 .cindex "TLS" "multiple message deliveries"
22780 For any host that matches this list, a connection on which a TLS session has
22781 been started will not be passed to a new delivery process for sending another
22782 message on the same connection. See section &<<SECTmulmessam>>& for an
22783 explanation of when this might be needed.
22784
22785
22786 .option hosts_override smtp boolean false
22787 If this option is set and the &%hosts%& option is also set, any hosts that are
22788 attached to the address are ignored, and instead the hosts specified by the
22789 &%hosts%& option are always used. This option does not apply to
22790 &%fallback_hosts%&.
22791
22792
22793 .option hosts_randomize smtp boolean false
22794 .cindex "randomized host list"
22795 .cindex "host" "list of; randomized"
22796 .cindex "fallback" "randomized hosts"
22797 If this option is set, and either the list of hosts is taken from the
22798 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22799 were not obtained from MX records (this includes fallback hosts from the
22800 router), and were not randomized by the router, the order of trying the hosts
22801 is randomized each time the transport runs. Randomizing the order of a host
22802 list can be used to do crude load sharing.
22803
22804 When &%hosts_randomize%& is true, a host list may be split into groups whose
22805 order is separately randomized. This makes it possible to set up MX-like
22806 behaviour. The boundaries between groups are indicated by an item that is just
22807 &`+`& in the host list. For example:
22808 .code
22809 hosts = host1:host2:host3:+:host4:host5
22810 .endd
22811 The order of the first three hosts and the order of the last two hosts is
22812 randomized for each use, but the first three always end up before the last two.
22813 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22814
22815 .option hosts_require_auth smtp "host list&!!" unset
22816 .cindex "authentication" "required by client"
22817 This option provides a list of servers for which authentication must succeed
22818 before Exim will try to transfer a message. If authentication fails for
22819 servers which are not in this list, Exim tries to send unauthenticated. If
22820 authentication fails for one of these servers, delivery is deferred. This
22821 temporary error is detectable in the retry rules, so it can be turned into a
22822 hard failure if required. See also &%hosts_try_auth%&, and chapter
22823 &<<CHAPSMTPAUTH>>& for details of authentication.
22824
22825
22826 .option hosts_require_tls smtp "host list&!!" unset
22827 .cindex "TLS" "requiring for certain servers"
22828 Exim will insist on using a TLS session when delivering to any host that
22829 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22830 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22831 incoming messages, use an appropriate ACL.
22832
22833 .option hosts_try_auth smtp "host list&!!" unset
22834 .cindex "authentication" "optional in client"
22835 This option provides a list of servers to which, provided they announce
22836 authentication support, Exim will attempt to authenticate as a client when it
22837 connects. If authentication fails, Exim will try to transfer the message
22838 unauthenticated. See also &%hosts_require_auth%&, and chapter
22839 &<<CHAPSMTPAUTH>>& for details of authentication.
22840
22841 .option interface smtp "string list&!!" unset
22842 .cindex "bind IP address"
22843 .cindex "IP address" "binding"
22844 .vindex "&$host$&"
22845 .vindex "&$host_address$&"
22846 This option specifies which interface to bind to when making an outgoing SMTP
22847 call. The value is an IP address, not an interface name such as
22848 &`eth0`&. Do not confuse this with the interface address that was used when a
22849 message was received, which is in &$received_ip_address$&, formerly known as
22850 &$interface_address$&. The name was changed to minimize confusion with the
22851 outgoing interface address. There is no variable that contains an outgoing
22852 interface address because, unless it is set by this option, its value is
22853 unknown.
22854
22855 During the expansion of the &%interface%& option the variables &$host$& and
22856 &$host_address$& refer to the host to which a connection is about to be made
22857 during the expansion of the string. Forced expansion failure, or an empty
22858 string result causes the option to be ignored. Otherwise, after expansion, the
22859 string must be a list of IP addresses, colon-separated by default, but the
22860 separator can be changed in the usual way. For example:
22861 .code
22862 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22863 .endd
22864 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22865 connection. If none of them are the correct type, the option is ignored. If
22866 &%interface%& is not set, or is ignored, the system's IP functions choose which
22867 interface to use if the host has more than one.
22868
22869
22870 .option keepalive smtp boolean true
22871 .cindex "keepalive" "on outgoing connection"
22872 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22873 connections. When set, it causes the kernel to probe idle connections
22874 periodically, by sending packets with &"old"& sequence numbers. The other end
22875 of the connection should send a acknowledgment if the connection is still okay
22876 or a reset if the connection has been aborted. The reason for doing this is
22877 that it has the beneficial effect of freeing up certain types of connection
22878 that can get stuck when the remote host is disconnected without tidying up the
22879 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22880 unreachable hosts.
22881
22882
22883 .option lmtp_ignore_quota smtp boolean false
22884 .cindex "LMTP" "ignoring quota errors"
22885 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22886 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22887 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22888
22889 .option max_rcpt smtp integer 100
22890 .cindex "RCPT" "maximum number of outgoing"
22891 This option limits the number of RCPT commands that are sent in a single
22892 SMTP message transaction. Each set of addresses is treated independently, and
22893 so can cause parallel connections to the same host if &%remote_max_parallel%&
22894 permits this.
22895
22896
22897 .option multi_domain smtp boolean true
22898 .vindex "&$domain$&"
22899 When this option is set, the &(smtp)& transport can handle a number of
22900 addresses containing a mixture of different domains provided they all resolve
22901 to the same list of hosts. Turning the option off restricts the transport to
22902 handling only one domain at a time. This is useful if you want to use
22903 &$domain$& in an expansion for the transport, because it is set only when there
22904 is a single domain involved in a remote delivery.
22905
22906
22907 .option port smtp string&!! "see below"
22908 .cindex "port" "sending TCP/IP"
22909 .cindex "TCP/IP" "setting outgoing port"
22910 This option specifies the TCP/IP port on the server to which Exim connects.
22911 &*Note:*& Do not confuse this with the port that was used when a message was
22912 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22913 The name was changed to minimize confusion with the outgoing port. There is no
22914 variable that contains an outgoing port.
22915
22916 If the value of this option begins with a digit it is taken as a port number;
22917 otherwise it is looked up using &[getservbyname()]&. The default value is
22918 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22919 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22920 is deferred.
22921
22922
22923
22924 .option protocol smtp string smtp
22925 .cindex "LMTP" "over TCP/IP"
22926 .cindex "ssmtp protocol" "outbound"
22927 .cindex "TLS" "SSL-on-connect outbound"
22928 .vindex "&$port$&"
22929 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22930 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22931 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22932 deliveries into closed message stores. Exim also has support for running LMTP
22933 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22934
22935 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22936 changes to &"smtps"&, and the transport initiates TLS immediately after
22937 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22938 The Internet standards bodies strongly discourage use of this mode.
22939
22940
22941 .option retry_include_ip_address smtp boolean true
22942 Exim normally includes both the host name and the IP address in the key it
22943 constructs for indexing retry data after a temporary delivery failure. This
22944 means that when one of several IP addresses for a host is failing, it gets
22945 tried periodically (controlled by the retry rules), but use of the other IP
22946 addresses is not affected.
22947
22948 However, in some dialup environments hosts are assigned a different IP address
22949 each time they connect. In this situation the use of the IP address as part of
22950 the retry key leads to undesirable behaviour. Setting this option false causes
22951 Exim to use only the host name. This should normally be done on a separate
22952 instance of the &(smtp)& transport, set up specially to handle the dialup
22953 hosts.
22954
22955
22956 .option serialize_hosts smtp "host list&!!" unset
22957 .cindex "serializing connections"
22958 .cindex "host" "serializing connections"
22959 Because Exim operates in a distributed manner, if several messages for the same
22960 host arrive at around the same time, more than one simultaneous connection to
22961 the remote host can occur. This is not usually a problem except when there is a
22962 slow link between the hosts. In that situation it may be helpful to restrict
22963 Exim to one connection at a time. This can be done by setting
22964 &%serialize_hosts%& to match the relevant hosts.
22965
22966 .cindex "hints database" "serializing deliveries to a host"
22967 Exim implements serialization by means of a hints database in which a record is
22968 written whenever a process connects to one of the restricted hosts. The record
22969 is deleted when the connection is completed. Obviously there is scope for
22970 records to get left lying around if there is a system or program crash. To
22971 guard against this, Exim ignores any records that are more than six hours old.
22972
22973 If you set up this kind of serialization, you should also arrange to delete the
22974 relevant hints database whenever your system reboots. The names of the files
22975 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22976 may be one or two files, depending on the type of DBM in use. The same files
22977 are used for ETRN serialization.
22978
22979
22980 .option size_addition smtp integer 1024
22981 .cindex "SMTP" "SIZE"
22982 .cindex "message" "size issue for transport filter"
22983 .cindex "size" "of message"
22984 .cindex "transport" "filter"
22985 .cindex "filter" "transport filter"
22986 If a remote SMTP server indicates that it supports the SIZE option of the
22987 MAIL command, Exim uses this to pass over the message size at the start of
22988 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22989 sends, to allow for headers and other text that may be added during delivery by
22990 configuration options or in a transport filter. It may be necessary to increase
22991 this if a lot of text is added to messages.
22992
22993 Alternatively, if the value of &%size_addition%& is set negative, it disables
22994 the use of the SIZE option altogether.
22995
22996
22997 .option tls_certificate smtp string&!! unset
22998 .cindex "TLS" "client certificate, location of"
22999 .cindex "certificate" "client, location of"
23000 .vindex "&$host$&"
23001 .vindex "&$host_address$&"
23002 The value of this option must be the absolute path to a file which contains the
23003 client's certificate, for possible use when sending a message over an encrypted
23004 connection. The values of &$host$& and &$host_address$& are set to the name and
23005 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23006 details of TLS.
23007
23008 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23009 certificate when sending messages as a client. The global option of the same
23010 name specifies the certificate for Exim as a server; it is not automatically
23011 assumed that the same certificate should be used when Exim is operating as a
23012 client.
23013
23014
23015 .option tls_crl smtp string&!! unset
23016 .cindex "TLS" "client certificate revocation list"
23017 .cindex "certificate" "revocation list for client"
23018 This option specifies a certificate revocation list. The expanded value must
23019 be the name of a file that contains a CRL in PEM format.
23020
23021
23022 .new
23023 .option tls_dh_min_bits smtp integer 1024
23024 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23025 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23026 key agreement is negotiated, the server will provide a large prime number
23027 for use.  This option establishes the minimum acceptable size of that number.
23028 If the parameter offered by the server is too small, then the TLS handshake
23029 will fail.
23030
23031 Only supported when using GnuTLS.
23032 .wen
23033
23034
23035 .option tls_privatekey smtp string&!! unset
23036 .cindex "TLS" "client private key, location of"
23037 .vindex "&$host$&"
23038 .vindex "&$host_address$&"
23039 The value of this option must be the absolute path to a file which contains the
23040 client's private key. This is used when sending a message over an encrypted
23041 connection using a client certificate. The values of &$host$& and
23042 &$host_address$& are set to the name and address of the server during the
23043 expansion. If this option is unset, or the expansion is forced to fail, or the
23044 result is an empty string, the private key is assumed to be in the same file as
23045 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23046
23047
23048 .option tls_require_ciphers smtp string&!! unset
23049 .cindex "TLS" "requiring specific ciphers"
23050 .cindex "cipher" "requiring specific"
23051 .vindex "&$host$&"
23052 .vindex "&$host_address$&"
23053 The value of this option must be a list of permitted cipher suites, for use
23054 when setting up an outgoing encrypted connection. (There is a global option of
23055 the same name for controlling incoming connections.) The values of &$host$& and
23056 &$host_address$& are set to the name and address of the server during the
23057 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23058 is used in different ways by OpenSSL and GnuTLS (see sections
23059 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23060 ciphers is a preference order.
23061
23062
23063
23064 .option tls_sni smtp string&!! unset
23065 .cindex "TLS" "Server Name Indication"
23066 .vindex "&$tls_sni$&"
23067 If this option is set then it sets the $tls_out_sni variable and causes any
23068 TLS session to pass this value as the Server Name Indication extension to
23069 the remote side, which can be used by the remote side to select an appropriate
23070 certificate and private key for the session.
23071
23072 See &<<SECTtlssni>>& for more information.
23073
23074 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23075 TLS extensions.
23076
23077
23078
23079
23080 .option tls_tempfail_tryclear smtp boolean true
23081 .cindex "4&'xx'& responses" "to STARTTLS"
23082 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23083 setting up a TLS session, this option determines whether or not Exim should try
23084 to deliver the message unencrypted. If it is set false, delivery to the
23085 current host is deferred; if there are other hosts, they are tried. If this
23086 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23087 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23088 TLS negotiation fails, Exim closes the current connection (because it is in an
23089 unknown state), opens a new one to the same host, and then tries the delivery
23090 in clear.
23091
23092
23093 .option tls_verify_certificates smtp string&!! unset
23094 .cindex "TLS" "server certificate verification"
23095 .cindex "certificate" "verification of server"
23096 .vindex "&$host$&"
23097 .vindex "&$host_address$&"
23098 The value of this option must be the absolute path to a file containing
23099 permitted server certificates, for use when setting up an encrypted connection.
23100 Alternatively, if you are using OpenSSL, you can set
23101 &%tls_verify_certificates%& to the name of a directory containing certificate
23102 files. This does not work with GnuTLS; the option must be set to the name of a
23103 single file if you are using GnuTLS. The values of &$host$& and
23104 &$host_address$& are set to the name and address of the server during the
23105 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23106
23107
23108
23109
23110 .section "How the limits for the number of hosts to try are used" &&&
23111          "SECTvalhosmax"
23112 .cindex "host" "maximum number to try"
23113 .cindex "limit" "hosts; maximum number tried"
23114 There are two options that are concerned with the number of hosts that are
23115 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23116 &%hosts_max_try_hardlimit%&.
23117
23118
23119 The &%hosts_max_try%& option limits the number of hosts that are tried
23120 for a single delivery. However, despite the term &"host"& in its name, the
23121 option actually applies to each IP address independently. In other words, a
23122 multihomed host is treated as several independent hosts, just as it is for
23123 retrying.
23124
23125 Many of the larger ISPs have multiple MX records which often point to
23126 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23127 created as a result of routing one of these domains.
23128
23129 Trying every single IP address on such a long list does not seem sensible; if
23130 several at the top of the list fail, it is reasonable to assume there is some
23131 problem that is likely to affect all of them. Roughly speaking, the value of
23132 &%hosts_max_try%& is the maximum number that are tried before deferring the
23133 delivery. However, the logic cannot be quite that simple.
23134
23135 Firstly, IP addresses that are skipped because their retry times have not
23136 arrived do not count, and in addition, addresses that are past their retry
23137 limits are also not counted, even when they are tried. This means that when
23138 some IP addresses are past their retry limits, more than the value of
23139 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23140 that all IP addresses are considered before timing out an email address (but
23141 see below for an exception).
23142
23143 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23144 list to see if there is a subsequent host with a different (higher valued) MX.
23145 If there is, that host is considered next, and the current IP address is used
23146 but not counted. This behaviour helps in the case of a domain with a retry rule
23147 that hardly ever delays any hosts, as is now explained:
23148
23149 Consider the case of a long list of hosts with one MX value, and a few with a
23150 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23151 hosts at the top of the list are tried at first. With the default retry rule,
23152 which specifies increasing retry times, the higher MX hosts are eventually
23153 tried when those at the top of the list are skipped because they have not
23154 reached their retry times.
23155
23156 However, it is common practice to put a fixed short retry time on domains for
23157 large ISPs, on the grounds that their servers are rarely down for very long.
23158 Unfortunately, these are exactly the domains that tend to resolve to long lists
23159 of hosts. The short retry time means that the lowest MX hosts are tried every
23160 time. The attempts may be in a different order because of random sorting, but
23161 without the special MX check, the higher MX hosts would never be tried until
23162 all the lower MX hosts had timed out (which might be several days), because
23163 there are always some lower MX hosts that have reached their retry times. With
23164 the special check, Exim considers at least one IP address from each MX value at
23165 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23166 reached.
23167
23168 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23169 particular, Exim normally eventually tries all the IP addresses before timing
23170 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23171 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23172 been set up with hundreds of IP addresses for some domains. It can
23173 take a very long time indeed for an address to time out in these cases.
23174
23175 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23176 Exim never tries more than this number of IP addresses; if it hits this limit
23177 and they are all timed out, the email address is bounced, even though not all
23178 possible IP addresses have been tried.
23179 .ecindex IIDsmttra1
23180 .ecindex IIDsmttra2
23181
23182
23183
23184
23185
23186 . ////////////////////////////////////////////////////////////////////////////
23187 . ////////////////////////////////////////////////////////////////////////////
23188
23189 .chapter "Address rewriting" "CHAPrewrite"
23190 .scindex IIDaddrew "rewriting" "addresses"
23191 There are some circumstances in which Exim automatically rewrites domains in
23192 addresses. The two most common are when an address is given without a domain
23193 (referred to as an &"unqualified address"&) or when an address contains an
23194 abbreviated domain that is expanded by DNS lookup.
23195
23196 Unqualified envelope addresses are accepted only for locally submitted
23197 messages, or for messages that are received from hosts matching
23198 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23199 appropriate. Unqualified addresses in header lines are qualified if they are in
23200 locally submitted messages, or messages from hosts that are permitted to send
23201 unqualified envelope addresses. Otherwise, unqualified addresses in header
23202 lines are neither qualified nor rewritten.
23203
23204 One situation in which Exim does &'not'& automatically rewrite a domain is
23205 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23206 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23207 do this. The new RFCs do not contain this suggestion.
23208
23209
23210 .section "Explicitly configured address rewriting" "SECID147"
23211 This chapter describes the rewriting rules that can be used in the
23212 main rewrite section of the configuration file, and also in the generic
23213 &%headers_rewrite%& option that can be set on any transport.
23214
23215 Some people believe that configured address rewriting is a Mortal Sin.
23216 Others believe that life is not possible without it. Exim provides the
23217 facility; you do not have to use it.
23218
23219 The main rewriting rules that appear in the &"rewrite"& section of the
23220 configuration file are applied to addresses in incoming messages, both envelope
23221 addresses and addresses in header lines. Each rule specifies the types of
23222 address to which it applies.
23223
23224 Whether or not addresses in header lines are rewritten depends on the origin of
23225 the headers and the type of rewriting. Global rewriting, that is, rewriting
23226 rules from the rewrite section of the configuration file, is applied only to
23227 those headers that were received with the message. Header lines that are added
23228 by ACLs or by a system filter or by individual routers or transports (which
23229 are specific to individual recipient addresses) are not rewritten by the global
23230 rules.
23231
23232 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23233 applies all headers except those added by routers and transports. That is, as
23234 well as the headers that were received with the message, it also applies to
23235 headers that were added by an ACL or a system filter.
23236
23237
23238 In general, rewriting addresses from your own system or domain has some
23239 legitimacy. Rewriting other addresses should be done only with great care and
23240 in special circumstances. The author of Exim believes that rewriting should be
23241 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23242 Although it can sometimes be used as a routing tool, this is very strongly
23243 discouraged.
23244
23245 There are two commonly encountered circumstances where rewriting is used, as
23246 illustrated by these examples:
23247
23248 .ilist
23249 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23250 exchange mail with each other behind a firewall, but there is only a single
23251 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23252 &'hitch.fict.example'& when sending mail off-site.
23253 .next
23254 A host rewrites the local parts of its own users so that, for example,
23255 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23256 .endlist
23257
23258
23259
23260 .section "When does rewriting happen?" "SECID148"
23261 .cindex "rewriting" "timing of"
23262 .cindex "&ACL;" "rewriting addresses in"
23263 Configured address rewriting can take place at several different stages of a
23264 message's processing.
23265
23266 .vindex "&$sender_address$&"
23267 At the start of an ACL for MAIL, the sender address may have been rewritten
23268 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23269 ordinary rewrite rules have yet been applied. If, however, the sender address
23270 is verified in the ACL, it is rewritten before verification, and remains
23271 rewritten thereafter. The subsequent value of &$sender_address$& is the
23272 rewritten address. This also applies if sender verification happens in a
23273 RCPT ACL. Otherwise, when the sender address is not verified, it is
23274 rewritten as soon as a message's header lines have been received.
23275
23276 .vindex "&$domain$&"
23277 .vindex "&$local_part$&"
23278 Similarly, at the start of an ACL for RCPT, the current recipient's address
23279 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23280 rewrite rules have yet been applied to it. However, the behaviour is different
23281 from the sender address when a recipient is verified. The address is rewritten
23282 for the verification, but the rewriting is not remembered at this stage. The
23283 value of &$local_part$& and &$domain$& after verification are always the same
23284 as they were before (that is, they contain the unrewritten &-- except for
23285 SMTP-time rewriting &-- address).
23286
23287 As soon as a message's header lines have been received, all the envelope
23288 recipient addresses are permanently rewritten, and rewriting is also applied to
23289 the addresses in the header lines (if configured). This happens before adding
23290 any header lines that were specified in MAIL or RCPT ACLs, and
23291 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23292 before the DATA ACL and &[local_scan()]& functions are run.
23293
23294 When an address is being routed, either for delivery or for verification,
23295 rewriting is applied immediately to child addresses that are generated by
23296 redirection, unless &%no_rewrite%& is set on the router.
23297
23298 .cindex "envelope sender" "rewriting at transport time"
23299 .cindex "rewriting" "at transport time"
23300 .cindex "header lines" "rewriting at transport time"
23301 At transport time, additional rewriting of addresses in header lines can be
23302 specified by setting the generic &%headers_rewrite%& option on a transport.
23303 This option contains rules that are identical in form to those in the rewrite
23304 section of the configuration file. They are applied to the original message
23305 header lines and any that were added by ACLs or a system filter. They are not
23306 applied to header lines that are added by routers or the transport.
23307
23308 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23309 transport option. However, it is not possible to rewrite envelope recipients at
23310 transport time.
23311
23312
23313
23314
23315 .section "Testing the rewriting rules that apply on input" "SECID149"
23316 .cindex "rewriting" "testing"
23317 .cindex "testing" "rewriting"
23318 Exim's input rewriting configuration appears in a part of the run time
23319 configuration file headed by &"begin rewrite"&. It can be tested by the
23320 &%-brw%& command line option. This takes an address (which can be a full RFC
23321 2822 address) as its argument. The output is a list of how the address would be
23322 transformed by the rewriting rules for each of the different places it might
23323 appear in an incoming message, that is, for each different header and for the
23324 envelope sender and recipient fields. For example,
23325 .code
23326 exim -brw ph10@exim.workshop.example
23327 .endd
23328 might produce the output
23329 .code
23330 sender: Philip.Hazel@exim.workshop.example
23331 from: Philip.Hazel@exim.workshop.example
23332 to: ph10@exim.workshop.example
23333 cc: ph10@exim.workshop.example
23334 bcc: ph10@exim.workshop.example
23335 reply-to: Philip.Hazel@exim.workshop.example
23336 env-from: Philip.Hazel@exim.workshop.example
23337 env-to: ph10@exim.workshop.example
23338 .endd
23339 which shows that rewriting has been set up for that address when used in any of
23340 the source fields, but not when it appears as a recipient address. At the
23341 present time, there is no equivalent way of testing rewriting rules that are
23342 set for a particular transport.
23343
23344
23345 .section "Rewriting rules" "SECID150"
23346 .cindex "rewriting" "rules"
23347 The rewrite section of the configuration file consists of lines of rewriting
23348 rules in the form
23349 .display
23350 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23351 .endd
23352 Rewriting rules that are specified for the &%headers_rewrite%& generic
23353 transport option are given as a colon-separated list. Each item in the list
23354 takes the same form as a line in the main rewriting configuration (except that
23355 any colons must be doubled, of course).
23356
23357 The formats of source patterns and replacement strings are described below.
23358 Each is terminated by white space, unless enclosed in double quotes, in which
23359 case normal quoting conventions apply inside the quotes. The flags are single
23360 characters which may appear in any order. Spaces and tabs between them are
23361 ignored.
23362
23363 For each address that could potentially be rewritten, the rules are scanned in
23364 order, and replacements for the address from earlier rules can themselves be
23365 replaced by later rules (but see the &"q"& and &"R"& flags).
23366
23367 The order in which addresses are rewritten is undefined, may change between
23368 releases, and must not be relied on, with one exception: when a message is
23369 received, the envelope sender is always rewritten first, before any header
23370 lines are rewritten. For example, the replacement string for a rewrite of an
23371 address in &'To:'& must not assume that the message's address in &'From:'& has
23372 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23373 that the envelope sender has already been rewritten.
23374
23375 .vindex "&$domain$&"
23376 .vindex "&$local_part$&"
23377 The variables &$local_part$& and &$domain$& can be used in the replacement
23378 string to refer to the address that is being rewritten. Note that lookup-driven
23379 rewriting can be done by a rule of the form
23380 .code
23381 *@*   ${lookup ...
23382 .endd
23383 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23384 refer to the address that is being rewritten.
23385
23386
23387 .section "Rewriting patterns" "SECID151"
23388 .cindex "rewriting" "patterns"
23389 .cindex "address list" "in a rewriting pattern"
23390 The source pattern in a rewriting rule is any item which may appear in an
23391 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23392 single-item address list, which means that it is expanded before being tested
23393 against the address. As always, if you use a regular expression as a pattern,
23394 you must take care to escape dollar and backslash characters, or use the &`\N`&
23395 facility to suppress string expansion within the regular expression.
23396
23397 Domains in patterns should be given in lower case. Local parts in patterns are
23398 case-sensitive. If you want to do case-insensitive matching of local parts, you
23399 can use a regular expression that starts with &`^(?i)`&.
23400
23401 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23402 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23403 depending on the type of match which occurred. These can be used in the
23404 replacement string to insert portions of the incoming address. &$0$& always
23405 refers to the complete incoming address. When a regular expression is used, the
23406 numerical variables are set from its capturing subexpressions. For other types
23407 of pattern they are set as follows:
23408
23409 .ilist
23410 If a local part or domain starts with an asterisk, the numerical variables
23411 refer to the character strings matched by asterisks, with &$1$& associated with
23412 the first asterisk, and &$2$& with the second, if present. For example, if the
23413 pattern
23414 .code
23415 *queen@*.fict.example
23416 .endd
23417 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23418 .code
23419 $0 = hearts-queen@wonderland.fict.example
23420 $1 = hearts-
23421 $2 = wonderland
23422 .endd
23423 Note that if the local part does not start with an asterisk, but the domain
23424 does, it is &$1$& that contains the wild part of the domain.
23425
23426 .next
23427 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23428 of the domain are placed in the next available numerical variables. Suppose,
23429 for example, that the address &'foo@bar.baz.example'& is processed by a
23430 rewriting rule of the form
23431 .display
23432 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23433 .endd
23434 and the key in the file that matches the domain is &`*.baz.example`&. Then
23435 .code
23436 $1 = foo
23437 $2 = bar
23438 $3 = baz.example
23439 .endd
23440 If the address &'foo@baz.example'& is looked up, this matches the same
23441 wildcard file entry, and in this case &$2$& is set to the empty string, but
23442 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23443 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23444 whole domain. For non-partial domain lookups, no numerical variables are set.
23445 .endlist
23446
23447
23448 .section "Rewriting replacements" "SECID152"
23449 .cindex "rewriting" "replacements"
23450 If the replacement string for a rule is a single asterisk, addresses that
23451 match the pattern and the flags are &'not'& rewritten, and no subsequent
23452 rewriting rules are scanned. For example,
23453 .code
23454 hatta@lookingglass.fict.example  *  f
23455 .endd
23456 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23457 &'From:'& headers.
23458
23459 .vindex "&$domain$&"
23460 .vindex "&$local_part$&"
23461 If the replacement string is not a single asterisk, it is expanded, and must
23462 yield a fully qualified address. Within the expansion, the variables
23463 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23464 Any letters they contain retain their original case &-- they are not lower
23465 cased. The numerical variables are set up according to the type of pattern that
23466 matched the address, as described above. If the expansion is forced to fail by
23467 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23468 current rule is abandoned, but subsequent rules may take effect. Any other
23469 expansion failure causes the entire rewriting operation to be abandoned, and an
23470 entry written to the panic log.
23471
23472
23473
23474 .section "Rewriting flags" "SECID153"
23475 There are three different kinds of flag that may appear on rewriting rules:
23476
23477 .ilist
23478 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23479 c, f, h, r, s, t.
23480 .next
23481 A flag that specifies rewriting at SMTP time: S.
23482 .next
23483 Flags that control the rewriting process: Q, q, R, w.
23484 .endlist
23485
23486 For rules that are part of the &%headers_rewrite%& generic transport option,
23487 E, F, T, and S are not permitted.
23488
23489
23490
23491 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23492          "SECID154"
23493 .cindex "rewriting" "flags"
23494 If none of the following flag letters, nor the &"S"& flag (see section
23495 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23496 and to both the sender and recipient fields of the envelope, whereas a
23497 transport-time rewriting rule just applies to all headers. Otherwise, the
23498 rewriting rule is skipped unless the relevant addresses are being processed.
23499 .display
23500 &`E`&       rewrite all envelope fields
23501 &`F`&       rewrite the envelope From field
23502 &`T`&       rewrite the envelope To field
23503 &`b`&       rewrite the &'Bcc:'& header
23504 &`c`&       rewrite the &'Cc:'& header
23505 &`f`&       rewrite the &'From:'& header
23506 &`h`&       rewrite all headers
23507 &`r`&       rewrite the &'Reply-To:'& header
23508 &`s`&       rewrite the &'Sender:'& header
23509 &`t`&       rewrite the &'To:'& header
23510 .endd
23511 "All headers" means all of the headers listed above that can be selected
23512 individually, plus their &'Resent-'& versions. It does not include
23513 other headers such as &'Subject:'& etc.
23514
23515 You should be particularly careful about rewriting &'Sender:'& headers, and
23516 restrict this to special known cases in your own domains.
23517
23518
23519 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23520 .cindex "SMTP" "rewriting malformed addresses"
23521 .cindex "RCPT" "rewriting argument of"
23522 .cindex "MAIL" "rewriting argument of"
23523 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23524 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23525 before any other processing; even before syntax checking. The pattern is
23526 required to be a regular expression, and it is matched against the whole of the
23527 data for the command, including any surrounding angle brackets.
23528
23529 .vindex "&$domain$&"
23530 .vindex "&$local_part$&"
23531 This form of rewrite rule allows for the handling of addresses that are not
23532 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23533 input). Because the input is not required to be a syntactically valid address,
23534 the variables &$local_part$& and &$domain$& are not available during the
23535 expansion of the replacement string. The result of rewriting replaces the
23536 original address in the MAIL or RCPT command.
23537
23538
23539 .section "Flags controlling the rewriting process" "SECID155"
23540 There are four flags which control the way the rewriting process works. These
23541 take effect only when a rule is invoked, that is, when the address is of the
23542 correct type (matches the flags) and matches the pattern:
23543
23544 .ilist
23545 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23546 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23547 absence of &"Q"& the rewritten address must always include a domain.
23548 .next
23549 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23550 even if no rewriting actually takes place because of a &"fail"& in the
23551 expansion. The &"q"& flag is not effective if the address is of the wrong type
23552 (does not match the flags) or does not match the pattern.
23553 .next
23554 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23555 address, up to ten times. It can be combined with the &"q"& flag, to stop
23556 rewriting once it fails to match (after at least one successful rewrite).
23557 .next
23558 .cindex "rewriting" "whole addresses"
23559 When an address in a header is rewritten, the rewriting normally applies only
23560 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23561 left unchanged. For example, rewriting might change
23562 .code
23563 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23564 .endd
23565 into
23566 .code
23567 From: Ford Prefect <prefectf@hitch.fict.example>
23568 .endd
23569 .cindex "RFC 2047"
23570 Sometimes there is a need to replace the whole address item, and this can be
23571 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23572 causes an address in a header line to be rewritten, the entire address is
23573 replaced, not just the working part. The replacement must be a complete RFC
23574 2822 address, including the angle brackets if necessary. If text outside angle
23575 brackets contains a character whose value is greater than 126 or less than 32
23576 (except for tab), the text is encoded according to RFC 2047. The character set
23577 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23578
23579 When the &"w"& flag is set on a rule that causes an envelope address to be
23580 rewritten, all but the working part of the replacement address is discarded.
23581 .endlist
23582
23583
23584 .section "Rewriting examples" "SECID156"
23585 Here is an example of the two common rewriting paradigms:
23586 .code
23587 *@*.hitch.fict.example  $1@hitch.fict.example
23588 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23589                      {$value}fail}@hitch.fict.example bctfrF
23590 .endd
23591 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23592 the string expansion to fail if the lookup does not succeed. In this context it
23593 has the effect of leaving the original address unchanged, but Exim goes on to
23594 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23595 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23596 explicitly, which would cause the rewritten address to be the same as before,
23597 at the cost of a small bit of processing. Not supplying either of these is an
23598 error, since the rewritten address would then contain no local part.
23599
23600 The first example above replaces the domain with a superior, more general
23601 domain. This may not be desirable for certain local parts. If the rule
23602 .code
23603 root@*.hitch.fict.example  *
23604 .endd
23605 were inserted before the first rule, rewriting would be suppressed for the
23606 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23607
23608 Rewriting can be made conditional on a number of tests, by making use of
23609 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23610 messages that originate outside the local host:
23611 .code
23612 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23613                          {$1@hitch.fict.example}fail}"
23614 .endd
23615 The replacement string is quoted in this example because it contains white
23616 space.
23617
23618 .cindex "rewriting" "bang paths"
23619 .cindex "bang paths" "rewriting"
23620 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23621 an address it treats it as an unqualified local part which it qualifies with
23622 the local qualification domain (if the source of the message is local or if the
23623 remote host is permitted to send unqualified addresses). Rewriting can
23624 sometimes be used to handle simple bang paths with a fixed number of
23625 components. For example, the rule
23626 .code
23627 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23628 .endd
23629 rewrites a two-component bang path &'host.name!user'& as the domain address
23630 &'user@host.name'&. However, there is a security implication in using this as
23631 a global rewriting rule for envelope addresses. It can provide a backdoor
23632 method for using your system as a relay, because the incoming addresses appear
23633 to be local. If the bang path addresses are received via SMTP, it is safer to
23634 use the &"S"& flag to rewrite them as they are received, so that relay checking
23635 can be done on the rewritten addresses.
23636 .ecindex IIDaddrew
23637
23638
23639
23640
23641
23642 . ////////////////////////////////////////////////////////////////////////////
23643 . ////////////////////////////////////////////////////////////////////////////
23644
23645 .chapter "Retry configuration" "CHAPretry"
23646 .scindex IIDretconf1 "retry" "configuration, description of"
23647 .scindex IIDregconf2 "configuration file" "retry section"
23648 The &"retry"& section of the runtime configuration file contains a list of
23649 retry rules that control how often Exim tries to deliver messages that cannot
23650 be delivered at the first attempt. If there are no retry rules (the section is
23651 empty or not present), there are no retries. In this situation, temporary
23652 errors are treated as permanent. The default configuration contains a single,
23653 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23654 line option can be used to test which retry rule will be used for a given
23655 address, domain and error.
23656
23657 The most common cause of retries is temporary failure to deliver to a remote
23658 host because the host is down, or inaccessible because of a network problem.
23659 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23660 address) basis, not on a per-message basis. Thus, if one message has recently
23661 been delayed, delivery of a new message to the same host is not immediately
23662 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23663 log selector is set, the message
23664 .cindex "retry" "time not reached"
23665 &"retry time not reached"& is written to the main log whenever a delivery is
23666 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23667 the handling of errors during remote deliveries.
23668
23669 Retry processing applies to routing as well as to delivering, except as covered
23670 in the next paragraph. The retry rules do not distinguish between these
23671 actions. It is not possible, for example, to specify different behaviour for
23672 failures to route the domain &'snark.fict.example'& and failures to deliver to
23673 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23674 added complication, so did not implement it. However, although they share the
23675 same retry rule, the actual retry times for routing and transporting a given
23676 domain are maintained independently.
23677
23678 When a delivery is not part of a queue run (typically an immediate delivery on
23679 receipt of a message), the routers are always run, and local deliveries are
23680 always attempted, even if retry times are set for them. This makes for better
23681 behaviour if one particular message is causing problems (for example, causing
23682 quota overflow, or provoking an error in a filter file). If such a delivery
23683 suffers a temporary failure, the retry data is updated as normal, and
23684 subsequent delivery attempts from queue runs occur only when the retry time for
23685 the local address is reached.
23686
23687 .section "Changing retry rules" "SECID157"
23688 If you change the retry rules in your configuration, you should consider
23689 whether or not to delete the retry data that is stored in Exim's spool area in
23690 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23691 always safe; that is why they are called &"hints"&.
23692
23693 The hints retry data contains suggested retry times based on the previous
23694 rules. In the case of a long-running problem with a remote host, it might
23695 record the fact that the host has timed out. If your new rules increase the
23696 timeout time for such a host, you should definitely remove the old retry data
23697 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23698 messages that it should now be retaining.
23699
23700
23701
23702 .section "Format of retry rules" "SECID158"
23703 .cindex "retry" "rules"
23704 Each retry rule occupies one line and consists of three or four parts,
23705 separated by white space: a pattern, an error name, an optional list of sender
23706 addresses, and a list of retry parameters. The pattern and sender lists must be
23707 enclosed in double quotes if they contain white space. The rules are searched
23708 in order until one is found where the pattern, error name, and sender list (if
23709 present) match the failing host or address, the error that occurred, and the
23710 message's sender, respectively.
23711
23712
23713 The pattern is any single item that may appear in an address list (see section
23714 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23715 which means that it is expanded before being tested against the address that
23716 has been delayed. A negated address list item is permitted. Address
23717 list processing treats a plain domain name as if it were preceded by &"*@"&,
23718 which makes it possible for many retry rules to start with just a domain. For
23719 example,
23720 .code
23721 lookingglass.fict.example        *  F,24h,30m;
23722 .endd
23723 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23724 whereas
23725 .code
23726 alice@lookingglass.fict.example  *  F,24h,30m;
23727 .endd
23728 applies only to temporary failures involving the local part &%alice%&.
23729 In practice, almost all rules start with a domain name pattern without a local
23730 part.
23731
23732 .cindex "regular expressions" "in retry rules"
23733 &*Warning*&: If you use a regular expression in a retry rule pattern, it
23734 must match a complete address, not just a domain, because that is how regular
23735 expressions work in address lists.
23736 .display
23737 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23738 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23739 .endd
23740
23741
23742 .section "Choosing which retry rule to use for address errors" "SECID159"
23743 When Exim is looking for a retry rule after a routing attempt has failed (for
23744 example, after a DNS timeout), each line in the retry configuration is tested
23745 against the complete address only if &%retry_use_local_part%& is set for the
23746 router. Otherwise, only the domain is used, except when matching against a
23747 regular expression, when the local part of the address is replaced with &"*"&.
23748 A domain on its own can match a domain pattern, or a pattern that starts with
23749 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23750 &%check_local_user%& is true, and false for other routers.
23751
23752 Similarly, when Exim is looking for a retry rule after a local delivery has
23753 failed (for example, after a mailbox full error), each line in the retry
23754 configuration is tested against the complete address only if
23755 &%retry_use_local_part%& is set for the transport (it defaults true for all
23756 local transports).
23757
23758 .cindex "4&'xx'& responses" "retry rules for"
23759 However, when Exim is looking for a retry rule after a remote delivery attempt
23760 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23761 whole address is always used as the key when searching the retry rules. The
23762 rule that is found is used to create a retry time for the combination of the
23763 failing address and the message's sender. It is the combination of sender and
23764 recipient that is delayed in subsequent queue runs until its retry time is
23765 reached. You can delay the recipient without regard to the sender by setting
23766 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23767 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23768 commands.
23769
23770
23771
23772 .section "Choosing which retry rule to use for host and message errors" &&&
23773          "SECID160"
23774 For a temporary error that is not related to an individual address (for
23775 example, a connection timeout), each line in the retry configuration is checked
23776 twice. First, the name of the remote host is used as a domain name (preceded by
23777 &"*@"& when matching a regular expression). If this does not match the line,
23778 the domain from the email address is tried in a similar fashion. For example,
23779 suppose the MX records for &'a.b.c.example'& are
23780 .code
23781 a.b.c.example  MX  5  x.y.z.example
23782                MX  6  p.q.r.example
23783                MX  7  m.n.o.example
23784 .endd
23785 and the retry rules are
23786 .code
23787 p.q.r.example    *      F,24h,30m;
23788 a.b.c.example    *      F,4d,45m;
23789 .endd
23790 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23791 first rule matches neither the host nor the domain, so Exim looks at the second
23792 rule. This does not match the host, but it does match the domain, so it is used
23793 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23794 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23795 first retry rule is used, because it matches the host.
23796
23797 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23798 first rule to determine retry times, but for all the other hosts for the domain
23799 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23800 routing to &'a.b.c.example'& suffers a temporary failure.
23801
23802 &*Note*&: The host name is used when matching the patterns, not its IP address.
23803 However, if a message is routed directly to an IP address without the use of a
23804 host name, for example, if a &(manualroute)& router contains a setting such as:
23805 .code
23806 route_list = *.a.example  192.168.34.23
23807 .endd
23808 then the &"host name"& that is used when searching for a retry rule is the
23809 textual form of the IP address.
23810
23811 .section "Retry rules for specific errors" "SECID161"
23812 .cindex "retry" "specific errors; specifying"
23813 The second field in a retry rule is the name of a particular error, or an
23814 asterisk, which matches any error. The errors that can be tested for are:
23815
23816 .vlist
23817 .vitem &%auth_failed%&
23818 Authentication failed when trying to send to a host in the
23819 &%hosts_require_auth%& list in an &(smtp)& transport.
23820
23821 .vitem &%data_4xx%&
23822 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23823 after the command, or after sending the message's data.
23824
23825 .vitem &%mail_4xx%&
23826 A 4&'xx'& error was received for an outgoing MAIL command.
23827
23828 .vitem &%rcpt_4xx%&
23829 A 4&'xx'& error was received for an outgoing RCPT command.
23830 .endlist
23831
23832 For the three 4&'xx'& errors, either the first or both of the x's can be given
23833 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23834 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23835 and have retries every ten minutes with a one-hour timeout, you could set up a
23836 retry rule of this form:
23837 .code
23838 the.domain.name  rcpt_452   F,1h,10m
23839 .endd
23840 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23841 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23842
23843 .vlist
23844 .vitem &%lost_connection%&
23845 A server unexpectedly closed the SMTP connection. There may, of course,
23846 legitimate reasons for this (host died, network died), but if it repeats a lot
23847 for the same host, it indicates something odd.
23848
23849 .vitem &%refused_MX%&
23850 A connection to a host obtained from an MX record was refused.
23851
23852 .vitem &%refused_A%&
23853 A connection to a host not obtained from an MX record was refused.
23854
23855 .vitem &%refused%&
23856 A connection was refused.
23857
23858 .vitem &%timeout_connect_MX%&
23859 A connection attempt to a host obtained from an MX record timed out.
23860
23861 .vitem &%timeout_connect_A%&
23862 A connection attempt to a host not obtained from an MX record timed out.
23863
23864 .vitem &%timeout_connect%&
23865 A connection attempt timed out.
23866
23867 .vitem &%timeout_MX%&
23868 There was a timeout while connecting or during an SMTP session with a host
23869 obtained from an MX record.
23870
23871 .vitem &%timeout_A%&
23872 There was a timeout while connecting or during an SMTP session with a host not
23873 obtained from an MX record.
23874
23875 .vitem &%timeout%&
23876 There was a timeout while connecting or during an SMTP session.
23877
23878 .vitem &%tls_required%&
23879 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23880 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23881 to STARTTLS, or there was a problem setting up the TLS connection.
23882
23883 .vitem &%quota%&
23884 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23885 transport.
23886
23887 .vitem &%quota_%&<&'time'&>
23888 .cindex "quota" "error testing in retry rule"
23889 .cindex "retry" "quota error testing"
23890 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23891 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23892 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23893 for four days.
23894 .endlist
23895
23896 .cindex "mailbox" "time of last read"
23897 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23898 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23899 it should be based on the last time that the user accessed the mailbox.
23900 However, it is not always possible to determine this. Exim uses the following
23901 heuristic rules:
23902
23903 .ilist
23904 If the mailbox is a single file, the time of last access (the &"atime"&) is
23905 used. As no new messages are being delivered (because the mailbox is over
23906 quota), Exim does not access the file, so this is the time of last user access.
23907 .next
23908 .cindex "maildir format" "time of last read"
23909 For a maildir delivery, the time of last modification of the &_new_&
23910 subdirectory is used. As the mailbox is over quota, no new files are created in
23911 the &_new_& subdirectory, because no new messages are being delivered. Any
23912 change to the &_new_& subdirectory is therefore assumed to be the result of an
23913 MUA moving a new message to the &_cur_& directory when it is first read. The
23914 time that is used is therefore the last time that the user read a new message.
23915 .next
23916 For other kinds of multi-file mailbox, the time of last access cannot be
23917 obtained, so a retry rule that uses this type of error field is never matched.
23918 .endlist
23919
23920 The quota errors apply both to system-enforced quotas and to Exim's own quota
23921 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23922 when a local delivery is deferred because a partition is full (the ENOSPC
23923 error).
23924
23925
23926
23927 .section "Retry rules for specified senders" "SECID162"
23928 .cindex "retry" "rules; sender-specific"
23929 You can specify retry rules that apply only when the failing message has a
23930 specific sender. In particular, this can be used to define retry rules that
23931 apply only to bounce messages. The third item in a retry rule can be of this
23932 form:
23933 .display
23934 &`senders=`&<&'address list'&>
23935 .endd
23936 The retry timings themselves are then the fourth item. For example:
23937 .code
23938 *   rcpt_4xx   senders=:   F,1h,30m
23939 .endd
23940 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23941 host. If the address list contains white space, it must be enclosed in quotes.
23942 For example:
23943 .code
23944 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23945 .endd
23946 &*Warning*&: This facility can be unhelpful if it is used for host errors
23947 (which do not depend on the recipient). The reason is that the sender is used
23948 only to match the retry rule. Once the rule has been found for a host error,
23949 its contents are used to set a retry time for the host, and this will apply to
23950 all messages, not just those with specific senders.
23951
23952 When testing retry rules using &%-brt%&, you can supply a sender using the
23953 &%-f%& command line option, like this:
23954 .code
23955 exim -f "" -brt user@dom.ain
23956 .endd
23957 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23958 list is never matched.
23959
23960
23961
23962
23963
23964 .section "Retry parameters" "SECID163"
23965 .cindex "retry" "parameters in rules"
23966 The third (or fourth, if a senders list is present) field in a retry rule is a
23967 sequence of retry parameter sets, separated by semicolons. Each set consists of
23968 .display
23969 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23970 .endd
23971 The letter identifies the algorithm for computing a new retry time; the cutoff
23972 time is the time beyond which this algorithm no longer applies, and the
23973 arguments vary the algorithm's action. The cutoff time is measured from the
23974 time that the first failure for the domain (combined with the local part if
23975 relevant) was detected, not from the time the message was received.
23976
23977 .cindex "retry" "algorithms"
23978 .cindex "retry" "fixed intervals"
23979 .cindex "retry" "increasing intervals"
23980 .cindex "retry" "random intervals"
23981 The available algorithms are:
23982
23983 .ilist
23984 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23985 the interval.
23986 .next
23987 &'G'&: retry at geometrically increasing intervals. The first argument
23988 specifies a starting value for the interval, and the second a multiplier, which
23989 is used to increase the size of the interval at each retry.
23990 .next
23991 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23992 retry, the previous interval is multiplied by the factor in order to get a
23993 maximum for the next interval. The minimum interval is the first argument of
23994 the parameter, and an actual interval is chosen randomly between them. Such a
23995 rule has been found to be helpful in cluster configurations when all the
23996 members of the cluster restart at once, and may therefore synchronize their
23997 queue processing times.
23998 .endlist
23999
24000 When computing the next retry time, the algorithm definitions are scanned in
24001 order until one whose cutoff time has not yet passed is reached. This is then
24002 used to compute a new retry time that is later than the current time. In the
24003 case of fixed interval retries, this simply means adding the interval to the
24004 current time. For geometrically increasing intervals, retry intervals are
24005 computed from the rule's parameters until one that is greater than the previous
24006 interval is found. The main configuration variable
24007 .cindex "limit" "retry interval"
24008 .cindex "retry" "interval, maximum"
24009 .oindex "&%retry_interval_max%&"
24010 &%retry_interval_max%& limits the maximum interval between retries. It
24011 cannot be set greater than &`24h`&, which is its default value.
24012
24013 A single remote domain may have a number of hosts associated with it, and each
24014 host may have more than one IP address. Retry algorithms are selected on the
24015 basis of the domain name, but are applied to each IP address independently. If,
24016 for example, a host has two IP addresses and one is unusable, Exim will
24017 generate retry times for it and will not try to use it until its next retry
24018 time comes. Thus the good IP address is likely to be tried first most of the
24019 time.
24020
24021 .cindex "hints database" "use for retrying"
24022 Retry times are hints rather than promises. Exim does not make any attempt to
24023 run deliveries exactly at the computed times. Instead, a queue runner process
24024 starts delivery processes for delayed messages periodically, and these attempt
24025 new deliveries only for those addresses that have passed their next retry time.
24026 If a new message arrives for a deferred address, an immediate delivery attempt
24027 occurs only if the address has passed its retry time. In the absence of new
24028 messages, the minimum time between retries is the interval between queue runner
24029 processes. There is not much point in setting retry times of five minutes if
24030 your queue runners happen only once an hour, unless there are a significant
24031 number of incoming messages (which might be the case on a system that is
24032 sending everything to a smart host, for example).
24033
24034 The data in the retry hints database can be inspected by using the
24035 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24036 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24037 &'exinext'& utility script can be used to find out what the next retry times
24038 are for the hosts associated with a particular mail domain, and also for local
24039 deliveries that have been deferred.
24040
24041
24042 .section "Retry rule examples" "SECID164"
24043 Here are some example retry rules:
24044 .code
24045 alice@wonderland.fict.example quota_5d  F,7d,3h
24046 wonderland.fict.example       quota_5d
24047 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24048 lookingglass.fict.example     *         F,24h,30m;
24049 *                 refused_A   F,2h,20m;
24050 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24051 .endd
24052 The first rule sets up special handling for mail to
24053 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24054 mailbox has not been read for at least 5 days. Retries continue every three
24055 hours for 7 days. The second rule handles over-quota errors for all other local
24056 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24057 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24058 fail are bounced immediately if the mailbox has not been read for at least 5
24059 days.
24060
24061 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24062 happen every 15 minutes for an hour, then with geometrically increasing
24063 intervals until two days have passed since a delivery first failed. After the
24064 first hour there is a delay of one hour, then two hours, then four hours, and
24065 so on (this is a rather extreme example).
24066
24067 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24068 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24069 all other domains, with special action for connection refusal from hosts that
24070 were not obtained from an MX record.
24071
24072 The final rule in a retry configuration should always have asterisks in the
24073 first two fields so as to provide a general catch-all for any addresses that do
24074 not have their own special handling. This example tries every 15 minutes for 2
24075 hours, then with intervals starting at one hour and increasing by a factor of
24076 1.5 up to 16 hours, then every 8 hours up to 5 days.
24077
24078
24079
24080 .section "Timeout of retry data" "SECID165"
24081 .cindex "timeout" "of retry data"
24082 .oindex "&%retry_data_expire%&"
24083 .cindex "hints database" "data expiry"
24084 .cindex "retry" "timeout of data"
24085 Exim timestamps the data that it writes to its retry hints database. When it
24086 consults the data during a delivery it ignores any that is older than the value
24087 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24088 been tried for 7 days, Exim will try to deliver to it immediately a message
24089 arrives, and if that fails, it will calculate a retry time as if it were
24090 failing for the first time.
24091
24092 This improves the behaviour for messages routed to rarely-used hosts such as MX
24093 backups. If such a host was down at one time, and happens to be down again when
24094 Exim tries a month later, using the old retry data would imply that it had been
24095 down all the time, which is not a justified assumption.
24096
24097 If a host really is permanently dead, this behaviour causes a burst of retries
24098 every now and again, but only if messages routed to it are rare. If there is a
24099 message at least once every 7 days the retry data never expires.
24100
24101
24102
24103
24104 .section "Long-term failures" "SECID166"
24105 .cindex "delivery failure, long-term"
24106 .cindex "retry" "after long-term failure"
24107 Special processing happens when an email address has been failing for so long
24108 that the cutoff time for the last algorithm is reached. For example, using the
24109 default retry rule:
24110 .code
24111 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24112 .endd
24113 the cutoff time is four days. Reaching the retry cutoff is independent of how
24114 long any specific message has been failing; it is the length of continuous
24115 failure for the recipient address that counts.
24116
24117 When the cutoff time is reached for a local delivery, or for all the IP
24118 addresses associated with a remote delivery, a subsequent delivery failure
24119 causes Exim to give up on the address, and a bounce message is generated.
24120 In order to cater for new messages that use the failing address, a next retry
24121 time is still computed from the final algorithm, and is used as follows:
24122
24123 For local deliveries, one delivery attempt is always made for any subsequent
24124 messages. If this delivery fails, the address fails immediately. The
24125 post-cutoff retry time is not used.
24126
24127 If the delivery is remote, there are two possibilities, controlled by the
24128 .oindex "&%delay_after_cutoff%&"
24129 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24130 default. Until the post-cutoff retry time for one of the IP addresses is
24131 reached, the failing email address is bounced immediately, without a delivery
24132 attempt taking place. After that time, one new delivery attempt is made to
24133 those IP addresses that are past their retry times, and if that still fails,
24134 the address is bounced and new retry times are computed.
24135
24136 In other words, when all the hosts for a given email address have been failing
24137 for a long time, Exim bounces rather then defers until one of the hosts' retry
24138 times is reached. Then it tries once, and bounces if that attempt fails. This
24139 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24140 to a broken destination, but if the host does recover, Exim will eventually
24141 notice.
24142
24143 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24144 addresses are past their final cutoff time, Exim tries to deliver to those IP
24145 addresses that have not been tried since the message arrived. If there are
24146 no suitable IP addresses, or if they all fail, the address is bounced. In other
24147 words, it does not delay when a new message arrives, but tries the expired
24148 addresses immediately, unless they have been tried since the message arrived.
24149 If there is a continuous stream of messages for the failing domains, setting
24150 &%delay_after_cutoff%& false means that there will be many more attempts to
24151 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24152 true.
24153
24154 .section "Deliveries that work intermittently" "SECID167"
24155 .cindex "retry" "intermittently working deliveries"
24156 Some additional logic is needed to cope with cases where a host is
24157 intermittently available, or when a message has some attribute that prevents
24158 its delivery when others to the same address get through. In this situation,
24159 because some messages are successfully delivered, the &"retry clock"& for the
24160 host or address keeps getting reset by the successful deliveries, and so
24161 failing messages remain on the queue for ever because the cutoff time is never
24162 reached.
24163
24164 Two exceptional actions are applied to prevent this happening. The first
24165 applies to errors that are related to a message rather than a remote host.
24166 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24167 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24168 commands, and quota failures. For this type of error, if a message's arrival
24169 time is earlier than the &"first failed"& time for the error, the earlier time
24170 is used when scanning the retry rules to decide when to try next and when to
24171 time out the address.
24172
24173 The exceptional second action applies in all cases. If a message has been on
24174 the queue for longer than the cutoff time of any applicable retry rule for a
24175 given address, a delivery is attempted for that address, even if it is not yet
24176 time, and if this delivery fails, the address is timed out. A new retry time is
24177 not computed in this case, so that other messages for the same address are
24178 considered immediately.
24179 .ecindex IIDretconf1
24180 .ecindex IIDregconf2
24181
24182
24183
24184
24185
24186
24187 . ////////////////////////////////////////////////////////////////////////////
24188 . ////////////////////////////////////////////////////////////////////////////
24189
24190 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24191 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24192 .scindex IIDauthconf2 "authentication"
24193 The &"authenticators"& section of Exim's run time configuration is concerned
24194 with SMTP authentication. This facility is an extension to the SMTP protocol,
24195 described in RFC 2554, which allows a client SMTP host to authenticate itself
24196 to a server. This is a common way for a server to recognize clients that are
24197 permitted to use it as a relay. SMTP authentication is not of relevance to the
24198 transfer of mail between servers that have no managerial connection with each
24199 other.
24200
24201 .cindex "AUTH" "description of"
24202 Very briefly, the way SMTP authentication works is as follows:
24203
24204 .ilist
24205 The server advertises a number of authentication &'mechanisms'& in response to
24206 the client's EHLO command.
24207 .next
24208 The client issues an AUTH command, naming a specific mechanism. The command
24209 may, optionally, contain some authentication data.
24210 .next
24211 The server may issue one or more &'challenges'&, to which the client must send
24212 appropriate responses. In simple authentication mechanisms, the challenges are
24213 just prompts for user names and passwords. The server does not have to issue
24214 any challenges &-- in some mechanisms the relevant data may all be transmitted
24215 with the AUTH command.
24216 .next
24217 The server either accepts or denies authentication.
24218 .next
24219 If authentication succeeds, the client may optionally make use of the AUTH
24220 option on the MAIL command to pass an authenticated sender in subsequent
24221 mail transactions. Authentication lasts for the remainder of the SMTP
24222 connection.
24223 .next
24224 If authentication fails, the client may give up, or it may try a different
24225 authentication mechanism, or it may try transferring mail over the
24226 unauthenticated connection.
24227 .endlist
24228
24229 If you are setting up a client, and want to know which authentication
24230 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24231 SMTP port) on the server, and issue an EHLO command. The response to this
24232 includes the list of supported mechanisms. For example:
24233 .display
24234 &`$ `&&*&`telnet server.example 25`&*&
24235 &`Trying 192.168.34.25...`&
24236 &`Connected to server.example.`&
24237 &`Escape character is &#x0027;^]&#x0027;.`&
24238 &`220 server.example ESMTP Exim 4.20 ...`&
24239 &*&`ehlo client.example`&*&
24240 &`250-server.example Hello client.example [10.8.4.5]`&
24241 &`250-SIZE 52428800`&
24242 &`250-PIPELINING`&
24243 &`250-AUTH PLAIN`&
24244 &`250 HELP`&
24245 .endd
24246 The second-last line of this example output shows that the server supports
24247 authentication using the PLAIN mechanism. In Exim, the different authentication
24248 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24249 routers and transports, which authenticators are included in the binary is
24250 controlled by build-time definitions. The following are currently available,
24251 included by setting
24252 .code
24253 AUTH_CRAM_MD5=yes
24254 AUTH_CYRUS_SASL=yes
24255 AUTH_DOVECOT=yes
24256 AUTH_GSASL=yes
24257 AUTH_HEIMDAL_GSSAPI=yes
24258 AUTH_PLAINTEXT=yes
24259 AUTH_SPA=yes
24260 .endd
24261 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24262 authentication mechanism (RFC 2195), and the second provides an interface to
24263 the Cyrus SASL authentication library.
24264 The third is an interface to Dovecot's authentication system, delegating the
24265 work via a socket interface.
24266 The fourth provides an interface to the GNU SASL authentication library, which
24267 provides mechanisms but typically not data sources.
24268 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24269 supporting setting a server keytab.
24270 The sixth can be configured to support
24271 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24272 not formally documented, but used by several MUAs. The seventh authenticator
24273 supports Microsoft's &'Secure Password Authentication'& mechanism.
24274
24275 The authenticators are configured using the same syntax as other drivers (see
24276 section &<<SECTfordricon>>&). If no authenticators are required, no
24277 authentication section need be present in the configuration file. Each
24278 authenticator can in principle have both server and client functions. When Exim
24279 is receiving SMTP mail, it is acting as a server; when it is sending out
24280 messages over SMTP, it is acting as a client. Authenticator configuration
24281 options are provided for use in both these circumstances.
24282
24283 To make it clear which options apply to which situation, the prefixes
24284 &%server_%& and &%client_%& are used on option names that are specific to
24285 either the server or the client function, respectively. Server and client
24286 functions are disabled if none of their options are set. If an authenticator is
24287 to be used for both server and client functions, a single definition, using
24288 both sets of options, is required. For example:
24289 .code
24290 cram:
24291   driver = cram_md5
24292   public_name = CRAM-MD5
24293   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24294   client_name = ph10
24295   client_secret = secret2
24296 .endd
24297 The &%server_%& option is used when Exim is acting as a server, and the
24298 &%client_%& options when it is acting as a client.
24299
24300 Descriptions of the individual authenticators are given in subsequent chapters.
24301 The remainder of this chapter covers the generic options for the
24302 authenticators, followed by general discussion of the way authentication works
24303 in Exim.
24304
24305 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24306 per-mechanism basis.  Please read carefully to determine which variables hold
24307 account labels such as usercodes and which hold passwords or other
24308 authenticating data.
24309
24310 Note that some mechanisms support two different identifiers for accounts: the
24311 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24312 and &'authz'& are commonly encountered.  The American spelling is standard here.
24313 Conceptually, authentication data such as passwords are tied to the identifier
24314 used to authenticate; servers may have rules to permit one user to act as a
24315 second user, so that after login the session is treated as though that second
24316 user had logged in.  That second user is the &'authorization id'&.  A robust
24317 configuration might confirm that the &'authz'& field is empty or matches the
24318 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24319 as verified data, the &'authz'& as an unverified request which the server might
24320 choose to honour.
24321
24322 A &'realm'& is a text string, typically a domain name, presented by a server
24323 to a client to help it select an account and credentials to use.  In some
24324 mechanisms, the client and server provably agree on the realm, but clients
24325 typically can not treat the realm as secure data to be blindly trusted.
24326
24327
24328
24329 .section "Generic options for authenticators" "SECID168"
24330 .cindex "authentication" "generic options"
24331 .cindex "options" "generic; for authenticators"
24332
24333 .option client_condition authenticators string&!! unset
24334 When Exim is authenticating as a client, it skips any authenticator whose
24335 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24336 used, for example, to skip plain text authenticators when the connection is not
24337 encrypted by a setting such as:
24338 .code
24339 client_condition = ${if !eq{$tls_out_cipher}{}}
24340 .endd
24341
24342
24343 .new
24344 .option client_set_id authenticators string&!! unset
24345 When client authentication succeeds, this condition is expanded; the
24346 result is used in the log lines for outbound messasges.
24347 Typically it will be the user name used for authentication.
24348 .wen
24349
24350
24351 .option driver authenticators string unset
24352 This option must always be set. It specifies which of the available
24353 authenticators is to be used.
24354
24355
24356 .option public_name authenticators string unset
24357 This option specifies the name of the authentication mechanism that the driver
24358 implements, and by which it is known to the outside world. These names should
24359 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24360 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24361 defaults to the driver's instance name.
24362
24363
24364 .option server_advertise_condition authenticators string&!! unset
24365 When a server is about to advertise an authentication mechanism, the condition
24366 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24367 mechanism is not advertised.
24368 If the expansion fails, the mechanism is not advertised. If the failure was not
24369 forced, and was not caused by a lookup defer, the incident is logged.
24370 See section &<<SECTauthexiser>>& below for further discussion.
24371
24372
24373 .option server_condition authenticators string&!! unset
24374 This option must be set for a &%plaintext%& server authenticator, where it
24375 is used directly to control authentication. See section &<<SECTplainserver>>&
24376 for details.
24377
24378 For the &(gsasl)& authenticator, this option is required for various
24379 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24380
24381 For the other authenticators, &%server_condition%& can be used as an additional
24382 authentication or authorization mechanism that is applied after the other
24383 authenticator conditions succeed. If it is set, it is expanded when the
24384 authenticator would otherwise return a success code. If the expansion is forced
24385 to fail, authentication fails. Any other expansion failure causes a temporary
24386 error code to be returned. If the result of a successful expansion is an empty
24387 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24388 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24389 other result, a temporary error code is returned, with the expanded string as
24390 the error text.
24391
24392
24393 .option server_debug_print authenticators string&!! unset
24394 If this option is set and authentication debugging is enabled (see the &%-d%&
24395 command line option), the string is expanded and included in the debugging
24396 output when the authenticator is run as a server. This can help with checking
24397 out the values of variables.
24398 If expansion of the string fails, the error message is written to the debugging
24399 output, and Exim carries on processing.
24400
24401
24402 .option server_set_id authenticators string&!! unset
24403 .vindex "&$authenticated_id$&"
24404 When an Exim server successfully authenticates a client, this string is
24405 expanded using data from the authentication, and preserved for any incoming
24406 messages in the variable &$authenticated_id$&. It is also included in the log
24407 lines for incoming messages. For example, a user/password authenticator
24408 configuration might preserve the user name that was used to authenticate, and
24409 refer to it subsequently during delivery of the message.
24410 If expansion fails, the option is ignored.
24411
24412
24413 .option server_mail_auth_condition authenticators string&!! unset
24414 This option allows a server to discard authenticated sender addresses supplied
24415 as part of MAIL commands in SMTP connections that are authenticated by the
24416 driver on which &%server_mail_auth_condition%& is set. The option is not used
24417 as part of the authentication process; instead its (unexpanded) value is
24418 remembered for later use.
24419 How it is used is described in the following section.
24420
24421
24422
24423
24424
24425 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24426 .cindex "authentication" "sender; authenticated"
24427 .cindex "AUTH" "on MAIL command"
24428 When a client supplied an AUTH= item on a MAIL command, Exim applies
24429 the following checks before accepting it as the authenticated sender of the
24430 message:
24431
24432 .ilist
24433 If the connection is not using extended SMTP (that is, HELO was used rather
24434 than EHLO), the use of AUTH= is a syntax error.
24435 .next
24436 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24437 .next
24438 .vindex "&$authenticated_sender$&"
24439 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24440 running, the value of &$authenticated_sender$& is set to the value obtained
24441 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24442 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24443 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24444 given for the MAIL command.
24445 .next
24446 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24447 is accepted and placed in &$authenticated_sender$& only if the client has
24448 authenticated.
24449 .next
24450 If the AUTH= value was accepted by either of the two previous rules, and
24451 the client has authenticated, and the authenticator has a setting for the
24452 &%server_mail_auth_condition%&, the condition is checked at this point. The
24453 valued that was saved from the authenticator is expanded. If the expansion
24454 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24455 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24456 the value of &$authenticated_sender$& is retained and passed on with the
24457 message.
24458 .endlist
24459
24460
24461 When &$authenticated_sender$& is set for a message, it is passed on to other
24462 hosts to which Exim authenticates as a client. Do not confuse this value with
24463 &$authenticated_id$&, which is a string obtained from the authentication
24464 process, and which is not usually a complete email address.
24465
24466 .vindex "&$sender_address$&"
24467 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24468 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24469 therefore make use of &$authenticated_sender$&. The converse is not true: the
24470 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24471 ACL is run.
24472
24473
24474
24475 .section "Authentication on an Exim server" "SECTauthexiser"
24476 .cindex "authentication" "on an Exim server"
24477 When Exim receives an EHLO command, it advertises the public names of those
24478 authenticators that are configured as servers, subject to the following
24479 conditions:
24480
24481 .ilist
24482 The client host must match &%auth_advertise_hosts%& (default *).
24483 .next
24484 It the &%server_advertise_condition%& option is set, its expansion must not
24485 yield the empty string, &"0"&, &"no"&, or &"false"&.
24486 .endlist
24487
24488 The order in which the authenticators are defined controls the order in which
24489 the mechanisms are advertised.
24490
24491 Some mail clients (for example, some versions of Netscape) require the user to
24492 provide a name and password for authentication whenever AUTH is advertised,
24493 even though authentication may not in fact be needed (for example, Exim may be
24494 set up to allow unconditional relaying from the client by an IP address check).
24495 You can make such clients more friendly by not advertising AUTH to them.
24496 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24497 that runs for RCPT) to relay without authentication, you should set
24498 .code
24499 auth_advertise_hosts = ! 10.9.8.0/24
24500 .endd
24501 so that no authentication mechanisms are advertised to them.
24502
24503 The &%server_advertise_condition%& controls the advertisement of individual
24504 authentication mechanisms. For example, it can be used to restrict the
24505 advertisement of a particular mechanism to encrypted connections, by a setting
24506 such as:
24507 .code
24508 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24509 .endd
24510 .vindex "&$tls_in_cipher$&"
24511 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24512 yields &"yes"&, which allows the advertisement to happen.
24513
24514 When an Exim server receives an AUTH command from a client, it rejects it
24515 immediately if AUTH was not advertised in response to an earlier EHLO
24516 command. This is the case if
24517
24518 .ilist
24519 The client host does not match &%auth_advertise_hosts%&; or
24520 .next
24521 No authenticators are configured with server options; or
24522 .next
24523 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24524 server authenticators.
24525 .endlist
24526
24527
24528 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24529 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24530 AUTH is accepted from any client host.
24531
24532 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24533 server authentication mechanism that was advertised in response to EHLO and
24534 that matches the one named in the AUTH command. If it finds one, it runs
24535 the appropriate authentication protocol, and authentication either succeeds or
24536 fails. If there is no matching advertised mechanism, the AUTH command is
24537 rejected with a 504 error.
24538
24539 .vindex "&$received_protocol$&"
24540 .vindex "&$sender_host_authenticated$&"
24541 When a message is received from an authenticated host, the value of
24542 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24543 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24544 public name) of the authenticator driver that successfully authenticated the
24545 client from which the message was received. This variable is empty if there was
24546 no successful authentication.
24547
24548
24549
24550
24551 .section "Testing server authentication" "SECID169"
24552 .cindex "authentication" "testing a server"
24553 .cindex "AUTH" "testing a server"
24554 .cindex "base64 encoding" "creating authentication test data"
24555 Exim's &%-bh%& option can be useful for testing server authentication
24556 configurations. The data for the AUTH command has to be sent using base64
24557 encoding. A quick way to produce such data for testing is the following Perl
24558 script:
24559 .code
24560 use MIME::Base64;
24561 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24562 .endd
24563 .cindex "binary zero" "in authentication data"
24564 This interprets its argument as a Perl string, and then encodes it. The
24565 interpretation as a Perl string allows binary zeros, which are required for
24566 some kinds of authentication, to be included in the data. For example, a
24567 command line to run this script on such data might be
24568 .code
24569 encode '\0user\0password'
24570 .endd
24571 Note the use of single quotes to prevent the shell interpreting the
24572 backslashes, so that they can be interpreted by Perl to specify characters
24573 whose code value is zero.
24574
24575 &*Warning 1*&: If either of the user or password strings starts with an octal
24576 digit, you must use three zeros instead of one after the leading backslash. If
24577 you do not, the octal digit that starts your string will be incorrectly
24578 interpreted as part of the code for the first character.
24579
24580 &*Warning 2*&: If there are characters in the strings that Perl interprets
24581 specially, you must use a Perl escape to prevent them being misinterpreted. For
24582 example, a command such as
24583 .code
24584 encode '\0user@domain.com\0pas$$word'
24585 .endd
24586 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24587
24588 If you have the &%mimencode%& command installed, another way to do produce
24589 base64-encoded strings is to run the command
24590 .code
24591 echo -e -n `\0user\0password' | mimencode
24592 .endd
24593 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24594 in the argument, and the &%-n%& option specifies no newline at the end of its
24595 output. However, not all versions of &%echo%& recognize these options, so you
24596 should check your version before relying on this suggestion.
24597
24598
24599
24600 .section "Authentication by an Exim client" "SECID170"
24601 .cindex "authentication" "on an Exim client"
24602 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24603 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24604 announces support for authentication, and the host matches an entry in either
24605 of these options, Exim (as a client) tries to authenticate as follows:
24606
24607 .ilist
24608 For each authenticator that is configured as a client, in the order in which
24609 they are defined in the configuration, it searches the authentication
24610 mechanisms announced by the server for one whose name matches the public name
24611 of the authenticator.
24612 .next
24613 .vindex "&$host$&"
24614 .vindex "&$host_address$&"
24615 When it finds one that matches, it runs the authenticator's client code. The
24616 variables &$host$& and &$host_address$& are available for any string expansions
24617 that the client might do. They are set to the server's name and IP address. If
24618 any expansion is forced to fail, the authentication attempt is abandoned, and
24619 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24620 delivery to be deferred.
24621 .next
24622 If the result of the authentication attempt is a temporary error or a timeout,
24623 Exim abandons trying to send the message to the host for the moment. It will
24624 try again later. If there are any backup hosts available, they are tried in the
24625 usual way.
24626 .next
24627 If the response to authentication is a permanent error (5&'xx'& code), Exim
24628 carries on searching the list of authenticators and tries another one if
24629 possible. If all authentication attempts give permanent errors, or if there are
24630 no attempts because no mechanisms match (or option expansions force failure),
24631 what happens depends on whether the host matches &%hosts_require_auth%& or
24632 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24633 delivery is deferred. The error can be detected in the retry rules, and thereby
24634 turned into a permanent error if you wish. In the second case, Exim tries to
24635 deliver the message unauthenticated.
24636 .endlist
24637
24638 .cindex "AUTH" "on MAIL command"
24639 When Exim has authenticated itself to a remote server, it adds the AUTH
24640 parameter to the MAIL commands it sends, if it has an authenticated sender for
24641 the message. If the message came from a remote host, the authenticated sender
24642 is the one that was receiving on an incoming MAIL command, provided that the
24643 incoming connection was authenticated and the &%server_mail_auth%& condition
24644 allowed the authenticated sender to be retained. If a local process calls Exim
24645 to send a message, the sender address that is built from the login name and
24646 &%qualify_domain%& is treated as authenticated. However, if the
24647 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24648 the authenticated sender that was received with the message.
24649 .ecindex IIDauthconf1
24650 .ecindex IIDauthconf2
24651
24652
24653
24654
24655
24656
24657 . ////////////////////////////////////////////////////////////////////////////
24658 . ////////////////////////////////////////////////////////////////////////////
24659
24660 .chapter "The plaintext authenticator" "CHAPplaintext"
24661 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24662 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24663 The &(plaintext)& authenticator can be configured to support the PLAIN and
24664 LOGIN authentication mechanisms, both of which transfer authentication data as
24665 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24666 security risk; you are strongly advised to insist on the use of SMTP encryption
24667 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24668 use unencrypted plain text, you should not use the same passwords for SMTP
24669 connections as you do for login accounts.
24670
24671 .section "Plaintext options" "SECID171"
24672 .cindex "options" "&(plaintext)& authenticator (server)"
24673 When configured as a server, &(plaintext)& uses the following options:
24674
24675 .option server_condition authenticators string&!! unset
24676 This is actually a global authentication option, but it must be set in order to
24677 configure the &(plaintext)& driver as a server. Its use is described below.
24678
24679 .option server_prompts plaintext string&!! unset
24680 The contents of this option, after expansion, must be a colon-separated list of
24681 prompt strings. If expansion fails, a temporary authentication rejection is
24682 given.
24683
24684 .section "Using plaintext in a server" "SECTplainserver"
24685 .cindex "AUTH" "in &(plaintext)& authenticator"
24686 .cindex "binary zero" "in &(plaintext)& authenticator"
24687 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24688         "in &(plaintext)& authenticator"
24689 .vindex "&$auth1$&, &$auth2$&, etc"
24690 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24691
24692 When running as a server, &(plaintext)& performs the authentication test by
24693 expanding a string. The data sent by the client with the AUTH command, or in
24694 response to subsequent prompts, is base64 encoded, and so may contain any byte
24695 values when decoded. If any data is supplied with the command, it is treated as
24696 a list of strings, separated by NULs (binary zeros), the first three of which
24697 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24698 (neither LOGIN nor PLAIN uses more than three strings).
24699
24700 For compatibility with previous releases of Exim, the values are also placed in
24701 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24702 variables for this purpose is now deprecated, as it can lead to confusion in
24703 string expansions that also use them for other things.
24704
24705 If there are more strings in &%server_prompts%& than the number of strings
24706 supplied with the AUTH command, the remaining prompts are used to obtain more
24707 data. Each response from the client may be a list of NUL-separated strings.
24708
24709 .vindex "&$authenticated_id$&"
24710 Once a sufficient number of data strings have been received,
24711 &%server_condition%& is expanded. If the expansion is forced to fail,
24712 authentication fails. Any other expansion failure causes a temporary error code
24713 to be returned. If the result of a successful expansion is an empty string,
24714 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24715 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24716 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24717 For any other result, a temporary error code is returned, with the expanded
24718 string as the error text
24719 .new ", and the failed id saved in &$authenticated_fail_id$&."
24720
24721 &*Warning*&: If you use a lookup in the expansion to find the user's
24722 password, be sure to make the authentication fail if the user is unknown.
24723 There are good and bad examples at the end of the next section.
24724
24725
24726
24727 .section "The PLAIN authentication mechanism" "SECID172"
24728 .cindex "PLAIN authentication mechanism"
24729 .cindex "authentication" "PLAIN mechanism"
24730 .cindex "binary zero" "in &(plaintext)& authenticator"
24731 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24732 sent as one item of data (that is, one combined string containing two NUL
24733 separators). The data is sent either as part of the AUTH command, or
24734 subsequently in response to an empty prompt from the server.
24735
24736 The second and third strings are a user name and a corresponding password.
24737 Using a single fixed user name and password as an example, this could be
24738 configured as follows:
24739 .code
24740 fixed_plain:
24741   driver = plaintext
24742   public_name = PLAIN
24743   server_prompts = :
24744   server_condition = \
24745     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24746   server_set_id = $auth2
24747 .endd
24748 Note that the default result strings from &%if%& (&"true"& or an empty string)
24749 are exactly what we want here, so they need not be specified. Obviously, if the
24750 password contains expansion-significant characters such as dollar, backslash,
24751 or closing brace, they have to be escaped.
24752
24753 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24754 the end of a string list are ignored). If all the data comes as part of the
24755 AUTH command, as is commonly the case, the prompt is not used. This
24756 authenticator is advertised in the response to EHLO as
24757 .code
24758 250-AUTH PLAIN
24759 .endd
24760 and a client host can authenticate itself by sending the command
24761 .code
24762 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24763 .endd
24764 As this contains three strings (more than the number of prompts), no further
24765 data is required from the client. Alternatively, the client may just send
24766 .code
24767 AUTH PLAIN
24768 .endd
24769 to initiate authentication, in which case the server replies with an empty
24770 prompt. The client must respond with the combined data string.
24771
24772 The data string is base64 encoded, as required by the RFC. This example,
24773 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24774 represents a zero byte. This is split up into three strings, the first of which
24775 is empty. The &%server_condition%& option in the authenticator checks that the
24776 second two are &`username`& and &`mysecret`& respectively.
24777
24778 Having just one fixed user name and password, as in this example, is not very
24779 realistic, though for a small organization with only a handful of
24780 authenticating clients it could make sense.
24781
24782 A more sophisticated instance of this authenticator could use the user name in
24783 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24784 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24785 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24786 This is an incorrect example:
24787 .code
24788 server_condition = \
24789   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24790 .endd
24791 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24792 which it then compares to the supplied password (&$auth3$&). Why is this example
24793 incorrect? It works fine for existing users, but consider what happens if a
24794 non-existent user name is given. The lookup fails, but as no success/failure
24795 strings are given for the lookup, it yields an empty string. Thus, to defeat
24796 the authentication, all a client has to do is to supply a non-existent user
24797 name and an empty password. The correct way of writing this test is:
24798 .code
24799 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24800   {${if eq{$value}{$auth3}}} {false}}
24801 .endd
24802 In this case, if the lookup succeeds, the result is checked; if the lookup
24803 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24804 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24805 always fails if its second argument is empty. However, the second way of
24806 writing the test makes the logic clearer.
24807
24808
24809 .section "The LOGIN authentication mechanism" "SECID173"
24810 .cindex "LOGIN authentication mechanism"
24811 .cindex "authentication" "LOGIN mechanism"
24812 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24813 in a number of programs. No data is sent with the AUTH command. Instead, a
24814 user name and password are supplied separately, in response to prompts. The
24815 plaintext authenticator can be configured to support this as in this example:
24816 .code
24817 fixed_login:
24818   driver = plaintext
24819   public_name = LOGIN
24820   server_prompts = User Name : Password
24821   server_condition = \
24822     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24823   server_set_id = $auth1
24824 .endd
24825 Because of the way plaintext operates, this authenticator accepts data supplied
24826 with the AUTH command (in contravention of the specification of LOGIN), but
24827 if the client does not supply it (as is the case for LOGIN clients), the prompt
24828 strings are used to obtain two data items.
24829
24830 Some clients are very particular about the precise text of the prompts. For
24831 example, Outlook Express is reported to recognize only &"Username:"& and
24832 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24833 strings. It uses the &%ldapauth%& expansion condition to check the user
24834 name and password by binding to an LDAP server:
24835 .code
24836 login:
24837   driver = plaintext
24838   public_name = LOGIN
24839   server_prompts = Username:: : Password::
24840   server_condition = ${if and{{ \
24841     !eq{}{$auth1} }{ \
24842     ldapauth{\
24843       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24844       pass=${quote:$auth2} \
24845       ldap://ldap.example.org/} }} }
24846   server_set_id = uid=$auth1,ou=people,o=example.org
24847 .endd
24848 We have to check that the username is not empty before using it, because LDAP
24849 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24850 operator to correctly quote the DN for authentication. However, the basic
24851 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24852 correct one to use for the password, because quoting is needed only to make
24853 the password conform to the Exim syntax. At the LDAP level, the password is an
24854 uninterpreted string.
24855
24856
24857 .section "Support for different kinds of authentication" "SECID174"
24858 A number of string expansion features are provided for the purpose of
24859 interfacing to different ways of user authentication. These include checking
24860 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24861 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24862 &<<SECTexpcond>>&.
24863
24864
24865
24866
24867 .section "Using plaintext in a client" "SECID175"
24868 .cindex "options" "&(plaintext)& authenticator (client)"
24869 The &(plaintext)& authenticator has two client options:
24870
24871 .option client_ignore_invalid_base64 plaintext boolean false
24872 If the client receives a server prompt that is not a valid base64 string,
24873 authentication is abandoned by default. However, if this option is set true,
24874 the error in the challenge is ignored and the client sends the response as
24875 usual.
24876
24877 .option client_send plaintext string&!! unset
24878 The string is a colon-separated list of authentication data strings. Each
24879 string is independently expanded before being sent to the server. The first
24880 string is sent with the AUTH command; any more strings are sent in response
24881 to prompts from the server. Before each string is expanded, the value of the
24882 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24883 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24884 way. Thus, the prompt that is received in response to sending the first string
24885 (with the AUTH command) can be used in the expansion of the second string, and
24886 so on. If an invalid base64 string is received when
24887 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24888 &$auth$&<&'n'&> variable.
24889
24890 &*Note*&: You cannot use expansion to create multiple strings, because
24891 splitting takes priority and happens first.
24892
24893 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24894 the data, further processing is applied to each string before it is sent. If
24895 there are any single circumflex characters in the string, they are converted to
24896 NULs. Should an actual circumflex be required as data, it must be doubled in
24897 the string.
24898
24899 This is an example of a client configuration that implements the PLAIN
24900 authentication mechanism with a fixed user name and password:
24901 .code
24902 fixed_plain:
24903   driver = plaintext
24904   public_name = PLAIN
24905   client_send = ^username^mysecret
24906 .endd
24907 The lack of colons means that the entire text is sent with the AUTH
24908 command, with the circumflex characters converted to NULs. A similar example
24909 that uses the LOGIN mechanism is:
24910 .code
24911 fixed_login:
24912   driver = plaintext
24913   public_name = LOGIN
24914   client_send = : username : mysecret
24915 .endd
24916 The initial colon means that the first string is empty, so no data is sent with
24917 the AUTH command itself. The remaining strings are sent in response to
24918 prompts.
24919 .ecindex IIDplaiauth1
24920 .ecindex IIDplaiauth2
24921
24922
24923
24924
24925 . ////////////////////////////////////////////////////////////////////////////
24926 . ////////////////////////////////////////////////////////////////////////////
24927
24928 .chapter "The cram_md5 authenticator" "CHID9"
24929 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24930 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24931 .cindex "CRAM-MD5 authentication mechanism"
24932 .cindex "authentication" "CRAM-MD5 mechanism"
24933 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24934 sends a challenge string to the client, and the response consists of a user
24935 name and the CRAM-MD5 digest of the challenge string combined with a secret
24936 string (password) which is known to both server and client. Thus, the secret
24937 is not sent over the network as plain text, which makes this authenticator more
24938 secure than &(plaintext)&. However, the downside is that the secret has to be
24939 available in plain text at either end.
24940
24941
24942 .section "Using cram_md5 as a server" "SECID176"
24943 .cindex "options" "&(cram_md5)& authenticator (server)"
24944 This authenticator has one server option, which must be set to configure the
24945 authenticator as a server:
24946
24947 .option server_secret cram_md5 string&!! unset
24948 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24949 When the server receives the client's response, the user name is placed in
24950 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24951 obtain the password for that user. The server then computes the CRAM-MD5 digest
24952 that the client should have sent, and checks that it received the correct
24953 string. If the expansion of &%server_secret%& is forced to fail, authentication
24954 fails. If the expansion fails for some other reason, a temporary error code is
24955 returned to the client.
24956
24957 For compatibility with previous releases of Exim, the user name is also placed
24958 in &$1$&. However, the use of this variables for this purpose is now
24959 deprecated, as it can lead to confusion in string expansions that also use
24960 numeric variables for other things.
24961
24962 For example, the following authenticator checks that the user name given by the
24963 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24964 user name, authentication fails.
24965 .code
24966 fixed_cram:
24967   driver = cram_md5
24968   public_name = CRAM-MD5
24969   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24970   server_set_id = $auth1
24971 .endd
24972 .vindex "&$authenticated_id$&"
24973 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24974 name in &$authenticated_id$&. A more typical configuration might look up the
24975 secret string in a file, using the user name as the key. For example:
24976 .code
24977 lookup_cram:
24978   driver = cram_md5
24979   public_name = CRAM-MD5
24980   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24981                   {$value}fail}
24982   server_set_id = $auth1
24983 .endd
24984 Note that this expansion explicitly forces failure if the lookup fails
24985 because &$auth1$& contains an unknown user name.
24986
24987 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24988 using the relevant libraries, you need to know the realm to specify in the
24989 lookup and then ask for the &"userPassword"& attribute for that user in that
24990 realm, with:
24991 .code
24992 cyrusless_crammd5:
24993   driver = cram_md5
24994   public_name = CRAM-MD5
24995   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24996                   dbmjz{/etc/sasldb2}}
24997   server_set_id = $auth1
24998 .endd
24999
25000 .section "Using cram_md5 as a client" "SECID177"
25001 .cindex "options" "&(cram_md5)& authenticator (client)"
25002 When used as a client, the &(cram_md5)& authenticator has two options:
25003
25004
25005
25006 .option client_name cram_md5 string&!! "the primary host name"
25007 This string is expanded, and the result used as the user name data when
25008 computing the response to the server's challenge.
25009
25010
25011 .option client_secret cram_md5 string&!! unset
25012 This option must be set for the authenticator to work as a client. Its value is
25013 expanded and the result used as the secret string when computing the response.
25014
25015
25016 .vindex "&$host$&"
25017 .vindex "&$host_address$&"
25018 Different user names and secrets can be used for different servers by referring
25019 to &$host$& or &$host_address$& in the options. Forced failure of either
25020 expansion string is treated as an indication that this authenticator is not
25021 prepared to handle this case. Exim moves on to the next configured client
25022 authenticator. Any other expansion failure causes Exim to give up trying to
25023 send the message to the current server.
25024
25025 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25026 strings, is:
25027 .code
25028 fixed_cram:
25029   driver = cram_md5
25030   public_name = CRAM-MD5
25031   client_name = ph10
25032   client_secret = secret
25033 .endd
25034 .ecindex IIDcramauth1
25035 .ecindex IIDcramauth2
25036
25037
25038
25039 . ////////////////////////////////////////////////////////////////////////////
25040 . ////////////////////////////////////////////////////////////////////////////
25041
25042 .chapter "The cyrus_sasl authenticator" "CHID10"
25043 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25044 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25045 .cindex "Cyrus" "SASL library"
25046 .cindex "Kerberos"
25047 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25048 Digital Ltd (&url(http://www.aldigital.co.uk)).
25049
25050 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25051 library implementation of the RFC 2222 (&"Simple Authentication and Security
25052 Layer"&). This library supports a number of authentication mechanisms,
25053 including PLAIN and LOGIN, but also several others that Exim does not support
25054 directly. In particular, there is support for Kerberos authentication.
25055
25056 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25057 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25058 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25059 name of the driver to determine which mechanism to support.
25060
25061 Where access to some kind of secret file is required, for example in GSSAPI
25062 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25063 user, and that the Cyrus SASL library has no way of escalating privileges
25064 by default. You may also find you need to set environment variables,
25065 depending on the driver you are using.
25066
25067 The application name provided by Exim is &"exim"&, so various SASL options may
25068 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25069 Kerberos, note that because of limitations in the GSSAPI interface,
25070 changing the server keytab might need to be communicated down to the Kerberos
25071 layer independently. The mechanism for doing so is dependent upon the Kerberos
25072 implementation.
25073
25074 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25075 may be set to point to an alternative keytab file. Exim will pass this
25076 variable through from its own inherited environment when started as root or the
25077 Exim user. The keytab file needs to be readable by the Exim user.
25078 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25079 environment variable.  In practice, for those releases, the Cyrus authenticator
25080 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25081 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25082
25083
25084 .section "Using cyrus_sasl as a server" "SECID178"
25085 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25086 (on a successful authentication) into &$auth1$&. For compatibility with
25087 previous releases of Exim, the username is also placed in &$1$&. However, the
25088 use of this variable for this purpose is now deprecated, as it can lead to
25089 confusion in string expansions that also use numeric variables for other
25090 things.
25091
25092
25093 .option server_hostname cyrus_sasl string&!! "see below"
25094 This option selects the hostname that is used when communicating with the
25095 library. The default value is &`$primary_hostname`&. It is up to the underlying
25096 SASL plug-in what it does with this data.
25097
25098
25099 .option server_mech cyrus_sasl string "see below"
25100 This option selects the authentication mechanism this driver should use. The
25101 default is the value of the generic &%public_name%& option. This option allows
25102 you to use a different underlying mechanism from the advertised name. For
25103 example:
25104 .code
25105 sasl:
25106   driver = cyrus_sasl
25107   public_name = X-ANYTHING
25108   server_mech = CRAM-MD5
25109   server_set_id = $auth1
25110 .endd
25111
25112 .option server_realm cyrus_sasl string&!! unset
25113 This specifies the SASL realm that the server claims to be in.
25114
25115
25116 .option server_service cyrus_sasl string &`smtp`&
25117 This is the SASL service that the server claims to implement.
25118
25119
25120 For straightforward cases, you do not need to set any of the authenticator's
25121 private options. All you need to do is to specify an appropriate mechanism as
25122 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25123 PLAIN, you could have two authenticators as follows:
25124 .code
25125 sasl_cram_md5:
25126   driver = cyrus_sasl
25127   public_name = CRAM-MD5
25128   server_set_id = $auth1
25129
25130 sasl_plain:
25131   driver = cyrus_sasl
25132   public_name = PLAIN
25133   server_set_id = $auth2
25134 .endd
25135 Cyrus SASL does implement the LOGIN authentication method, even though it is
25136 not a standard method. It is disabled by default in the source distribution,
25137 but it is present in many binary distributions.
25138 .ecindex IIDcyrauth1
25139 .ecindex IIDcyrauth2
25140
25141
25142
25143
25144 . ////////////////////////////////////////////////////////////////////////////
25145 . ////////////////////////////////////////////////////////////////////////////
25146 .chapter "The dovecot authenticator" "CHAPdovecot"
25147 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25148 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25149 This authenticator is an interface to the authentication facility of the
25150 Dovecot POP/IMAP server, which can support a number of authentication methods.
25151 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25152 to use the same mechanisms for SMTP authentication. This is a server
25153 authenticator only. There is only one option:
25154
25155 .option server_socket dovecot string unset
25156
25157 This option must specify the socket that is the interface to Dovecot
25158 authentication. The &%public_name%& option must specify an authentication
25159 mechanism that Dovecot is configured to support. You can have several
25160 authenticators for different mechanisms. For example:
25161 .code
25162 dovecot_plain:
25163   driver = dovecot
25164   public_name = PLAIN
25165   server_socket = /var/run/dovecot/auth-client
25166   server_set_id = $auth2
25167
25168 dovecot_ntlm:
25169   driver = dovecot
25170   public_name = NTLM
25171   server_socket = /var/run/dovecot/auth-client
25172   server_set_id = $auth1
25173 .endd
25174 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25175 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25176 option is passed in the Dovecot authentication command. If, for a TLS
25177 connection, a client certificate has been verified, the &"valid-client-cert"&
25178 option is passed. When authentication succeeds, the identity of the user
25179 who authenticated is placed in &$auth1$&.
25180 .ecindex IIDdcotauth1
25181 .ecindex IIDdcotauth2
25182
25183
25184 . ////////////////////////////////////////////////////////////////////////////
25185 . ////////////////////////////////////////////////////////////////////////////
25186 .chapter "The gsasl authenticator" "CHAPgsasl"
25187 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25188 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25189 .cindex "authentication" "GNU SASL"
25190 .cindex "authentication" "SASL"
25191 .cindex "authentication" "EXTERNAL"
25192 .cindex "authentication" "ANONYMOUS"
25193 .cindex "authentication" "PLAIN"
25194 .cindex "authentication" "LOGIN"
25195 .cindex "authentication" "DIGEST-MD5"
25196 .cindex "authentication" "CRAM-MD5"
25197 .cindex "authentication" "SCRAM-SHA-1"
25198 The &(gsasl)& authenticator provides server integration for the GNU SASL
25199 library and the mechanisms it provides.  This is new as of the 4.80 release
25200 and there are a few areas where the library does not let Exim smoothly
25201 scale to handle future authentication mechanisms, so no guarantee can be
25202 made that any particular new authentication mechanism will be supported
25203 without code changes in Exim.
25204
25205
25206 .option server_channelbinding gsasl boolean false
25207 Some authentication mechanisms are able to use external context at both ends
25208 of the session to bind the authentication to that context, and fail the
25209 authentication process if that context differs.  Specifically, some TLS
25210 ciphersuites can provide identifying information about the cryptographic
25211 context.
25212
25213 This means that certificate identity and verification becomes a non-issue,
25214 as a man-in-the-middle attack will cause the correct client and server to
25215 see different identifiers and authentication will fail.
25216
25217 This is currently only supported when using the GnuTLS library.  This is
25218 only usable by mechanisms which support "channel binding"; at time of
25219 writing, that's the SCRAM family.
25220
25221 This defaults off to ensure smooth upgrade across Exim releases, in case
25222 this option causes some clients to start failing.  Some future release
25223 of Exim may switch the default to be true.
25224
25225
25226 .option server_hostname gsasl string&!! "see below"
25227 This option selects the hostname that is used when communicating with the
25228 library. The default value is &`$primary_hostname`&.
25229 Some mechanisms will use this data.
25230
25231
25232 .option server_mech gsasl string "see below"
25233 This option selects the authentication mechanism this driver should use. The
25234 default is the value of the generic &%public_name%& option. This option allows
25235 you to use a different underlying mechanism from the advertised name. For
25236 example:
25237 .code
25238 sasl:
25239   driver = gsasl
25240   public_name = X-ANYTHING
25241   server_mech = CRAM-MD5
25242   server_set_id = $auth1
25243 .endd
25244
25245
25246 .option server_password gsasl string&!! unset
25247 Various mechanisms need access to the cleartext password on the server, so
25248 that proof-of-possession can be demonstrated on the wire, without sending
25249 the password itself.
25250
25251 The data available for lookup varies per mechanism.
25252 In all cases, &$auth1$& is set to the &'authentication id'&.
25253 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25254 if available, else the empty string.
25255 The &$auth3$& variable will always be the &'realm'& if available,
25256 else the empty string.
25257
25258 A forced failure will cause authentication to defer.
25259
25260 If using this option, it may make sense to set the &%server_condition%&
25261 option to be simply "true".
25262
25263
25264 .option server_realm gsasl string&!! unset
25265 This specifies the SASL realm that the server claims to be in.
25266 Some mechanisms will use this data.
25267
25268
25269 .option server_scram_iter gsasl string&!! unset
25270 This option provides data for the SCRAM family of mechanisms.
25271 &$auth1$& is not available at evaluation time.
25272 (This may change, as we receive feedback on use)
25273
25274
25275 .option server_scram_salt gsasl string&!! unset
25276 This option provides data for the SCRAM family of mechanisms.
25277 &$auth1$& is not available at evaluation time.
25278 (This may change, as we receive feedback on use)
25279
25280
25281 .option server_service gsasl string &`smtp`&
25282 This is the SASL service that the server claims to implement.
25283 Some mechanisms will use this data.
25284
25285
25286 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25287 .vindex "&$auth1$&, &$auth2$&, etc"
25288 These may be set when evaluating specific options, as detailed above.
25289 They will also be set when evaluating &%server_condition%&.
25290
25291 Unless otherwise stated below, the &(gsasl)& integration will use the following
25292 meanings for these variables:
25293
25294 .ilist
25295 .vindex "&$auth1$&"
25296 &$auth1$&: the &'authentication id'&
25297 .next
25298 .vindex "&$auth2$&"
25299 &$auth2$&: the &'authorization id'&
25300 .next
25301 .vindex "&$auth3$&"
25302 &$auth3$&: the &'realm'&
25303 .endlist
25304
25305 On a per-mechanism basis:
25306
25307 .ilist
25308 .cindex "authentication" "EXTERNAL"
25309 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25310 the &%server_condition%& option must be present.
25311 .next
25312 .cindex "authentication" "ANONYMOUS"
25313 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25314 the &%server_condition%& option must be present.
25315 .next
25316 .cindex "authentication" "GSSAPI"
25317 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25318 &$auth2$& will be set to the &'authorization id'&,
25319 the &%server_condition%& option must be present.
25320 .endlist
25321
25322 An &'anonymous token'& is something passed along as an unauthenticated
25323 identifier; this is analogous to FTP anonymous authentication passing an
25324 email address, or software-identifier@, as the "password".
25325
25326
25327 An example showing the password having the realm specified in the callback
25328 and demonstrating a Cyrus SASL to GSASL migration approach is:
25329 .code
25330 gsasl_cyrusless_crammd5:
25331   driver = gsasl
25332   public_name = CRAM-MD5
25333   server_realm = imap.example.org
25334   server_password = ${lookup{$auth1:$auth3:userPassword}\
25335                     dbmjz{/etc/sasldb2}{$value}fail}
25336   server_set_id = ${quote:$auth1}
25337   server_condition = yes
25338 .endd
25339
25340
25341 . ////////////////////////////////////////////////////////////////////////////
25342 . ////////////////////////////////////////////////////////////////////////////
25343
25344 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25345 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25346 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25347 .cindex "authentication" "GSSAPI"
25348 .cindex "authentication" "Kerberos"
25349 The &(heimdal_gssapi)& authenticator provides server integration for the
25350 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25351 reliably.
25352
25353 .option server_hostname heimdal_gssapi string&!! "see below"
25354 This option selects the hostname that is used, with &%server_service%&,
25355 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25356 identifier.  The default value is &`$primary_hostname`&.
25357
25358 .option server_keytab heimdal_gssapi string&!! unset
25359 If set, then Heimdal will not use the system default keytab (typically
25360 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25361 The value should be a pathname, with no &"file:"& prefix.
25362
25363 .option server_service heimdal_gssapi string&!! "smtp"
25364 This option specifies the service identifier used, in conjunction with
25365 &%server_hostname%&, for building the identifer for finding credentials
25366 from the keytab.
25367
25368
25369 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25370 Beware that these variables will typically include a realm, thus will appear
25371 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25372 not verified, so a malicious client can set it to anything.
25373
25374 The &$auth1$& field should be safely trustable as a value from the Key
25375 Distribution Center.  Note that these are not quite email addresses.
25376 Each identifier is for a role, and so the left-hand-side may include a
25377 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25378
25379 .vindex "&$auth1$&, &$auth2$&, etc"
25380 .ilist
25381 .vindex "&$auth1$&"
25382 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25383 .next
25384 .vindex "&$auth2$&"
25385 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25386 authentication.  If that was empty, this will also be set to the
25387 GSS Display Name.
25388 .endlist
25389
25390
25391 . ////////////////////////////////////////////////////////////////////////////
25392 . ////////////////////////////////////////////////////////////////////////////
25393
25394 .chapter "The spa authenticator" "CHAPspa"
25395 .scindex IIDspaauth1 "&(spa)& authenticator"
25396 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25397 .cindex "authentication" "Microsoft Secure Password"
25398 .cindex "authentication" "NTLM"
25399 .cindex "Microsoft Secure Password Authentication"
25400 .cindex "NTLM authentication"
25401 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25402 Password Authentication'& mechanism,
25403 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25404 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25405 taken from the Samba project (&url(http://www.samba.org)). The code for the
25406 server side was subsequently contributed by Tom Kistner. The mechanism works as
25407 follows:
25408
25409 .ilist
25410 After the AUTH command has been accepted, the client sends an SPA
25411 authentication request based on the user name and optional domain.
25412 .next
25413 The server sends back a challenge.
25414 .next
25415 The client builds a challenge response which makes use of the user's password
25416 and sends it to the server, which then accepts or rejects it.
25417 .endlist
25418
25419 Encryption is used to protect the password in transit.
25420
25421
25422
25423 .section "Using spa as a server" "SECID179"
25424 .cindex "options" "&(spa)& authenticator (server)"
25425 The &(spa)& authenticator has just one server option:
25426
25427 .option server_password spa string&!! unset
25428 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25429 This option is expanded, and the result must be the cleartext password for the
25430 authenticating user, whose name is at this point in &$auth1$&. For
25431 compatibility with previous releases of Exim, the user name is also placed in
25432 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25433 it can lead to confusion in string expansions that also use numeric variables
25434 for other things. For example:
25435 .code
25436 spa:
25437   driver = spa
25438   public_name = NTLM
25439   server_password = \
25440     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25441 .endd
25442 If the expansion is forced to fail, authentication fails. Any other expansion
25443 failure causes a temporary error code to be returned.
25444
25445
25446
25447
25448
25449 .section "Using spa as a client" "SECID180"
25450 .cindex "options" "&(spa)& authenticator (client)"
25451 The &(spa)& authenticator has the following client options:
25452
25453
25454
25455 .option client_domain spa string&!! unset
25456 This option specifies an optional domain for the authentication.
25457
25458
25459 .option client_password spa string&!! unset
25460 This option specifies the user's password, and must be set.
25461
25462
25463 .option client_username spa string&!! unset
25464 This option specifies the user name, and must be set. Here is an example of a
25465 configuration of this authenticator for use with the mail servers at
25466 &'msn.com'&:
25467 .code
25468 msn:
25469   driver = spa
25470   public_name = MSN
25471   client_username = msn/msn_username
25472   client_password = msn_plaintext_password
25473   client_domain = DOMAIN_OR_UNSET
25474 .endd
25475 .ecindex IIDspaauth1
25476 .ecindex IIDspaauth2
25477
25478
25479
25480
25481
25482 . ////////////////////////////////////////////////////////////////////////////
25483 . ////////////////////////////////////////////////////////////////////////////
25484
25485 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25486          "Encrypted SMTP connections"
25487 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25488 .scindex IIDencsmtp2 "SMTP" "encryption"
25489 .cindex "TLS" "on SMTP connection"
25490 .cindex "OpenSSL"
25491 .cindex "GnuTLS"
25492 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25493 Sockets Layer), is implemented by making use of the OpenSSL library or the
25494 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25495 cryptographic code in the Exim distribution itself for implementing TLS. In
25496 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25497 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25498 You also need to understand the basic concepts of encryption at a managerial
25499 level, and in particular, the way that public keys, private keys, and
25500 certificates are used.
25501
25502 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25503 connection is established, the client issues a STARTTLS command. If the
25504 server accepts this, the client and the server negotiate an encryption
25505 mechanism. If the negotiation succeeds, the data that subsequently passes
25506 between them is encrypted.
25507
25508 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25509 and if so, what cipher suite is in use, whether the client supplied a
25510 certificate, and whether or not that certificate was verified. This makes it
25511 possible for an Exim server to deny or accept certain commands based on the
25512 encryption state.
25513
25514 &*Warning*&: Certain types of firewall and certain anti-virus products can
25515 disrupt TLS connections. You need to turn off SMTP scanning for these products
25516 in order to get TLS to work.
25517
25518
25519
25520 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25521          "SECID284"
25522 .cindex "ssmtp protocol"
25523 .cindex "smtps protocol"
25524 .cindex "SMTP" "ssmtp protocol"
25525 .cindex "SMTP" "smtps protocol"
25526 Early implementations of encrypted SMTP used a different TCP port from normal
25527 SMTP, and expected an encryption negotiation to start immediately, instead of
25528 waiting for a STARTTLS command from the client using the standard SMTP
25529 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25530 allocated for this purpose.
25531
25532 This approach was abandoned when encrypted SMTP was standardized, but there are
25533 still some legacy clients that use it. Exim supports these clients by means of
25534 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25535 numbers; the most common use is expected to be:
25536 .code
25537 tls_on_connect_ports = 465
25538 .endd
25539 The port numbers specified by this option apply to all SMTP connections, both
25540 via the daemon and via &'inetd'&. You still need to specify all the ports that
25541 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25542 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25543 an extra port &-- rather, it specifies different behaviour on a port that is
25544 defined elsewhere.
25545
25546 There is also a &%-tls-on-connect%& command line option. This overrides
25547 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25548
25549
25550
25551
25552
25553
25554 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25555 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25556 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25557 followed later, when the first versions of GnuTLS were released. To build Exim
25558 to use GnuTLS, you need to set
25559 .code
25560 USE_GNUTLS=yes
25561 .endd
25562 in Local/Makefile, in addition to
25563 .code
25564 SUPPORT_TLS=yes
25565 .endd
25566 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25567 include files and libraries for GnuTLS can be found.
25568
25569 There are some differences in usage when using GnuTLS instead of OpenSSL:
25570
25571 .ilist
25572 The &%tls_verify_certificates%& option must contain the name of a file, not the
25573 name of a directory (for OpenSSL it can be either).
25574 .next
25575 The default value for &%tls_dhparam%& differs for historical reasons.
25576 .next
25577 .vindex "&$tls_in_peerdn$&"
25578 .vindex "&$tls_out_peerdn$&"
25579 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25580 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25581 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25582 .next
25583 OpenSSL identifies cipher suites using hyphens as separators, for example:
25584 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25585 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25586 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25587 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25588 to handle its own older variants) when processing lists of cipher suites in the
25589 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25590 option).
25591 .next
25592 The &%tls_require_ciphers%& options operate differently, as described in the
25593 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25594 .next
25595 .new
25596 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25597 When using OpenSSL, this option is ignored.
25598 (If an API is found to let OpenSSL be configured in this way,
25599 let the Exim Maintainers know and we'll likely use it).
25600 .wen
25601 .next
25602 Some other recently added features may only be available in one or the other.
25603 This should be documented with the feature.  If the documentation does not
25604 explicitly state that the feature is infeasible in the other TLS
25605 implementation, then patches are welcome.
25606 .endlist
25607
25608
25609 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25610 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25611 an explicit path; if the latter, then the text about generation still applies,
25612 but not the chosen filename.
25613 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25614 See the documentation of &%tls_dhparam%& for more information.
25615
25616 GnuTLS uses D-H parameters that may take a substantial amount of time
25617 to compute. It is unreasonable to re-compute them for every TLS session.
25618 Therefore, Exim keeps this data in a file in its spool directory, called
25619 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25620 of bits requested.
25621 The file is owned by the Exim user and is readable only by
25622 its owner. Every Exim process that start up GnuTLS reads the D-H
25623 parameters from this file. If the file does not exist, the first Exim process
25624 that needs it computes the data and writes it to a temporary file which is
25625 renamed once it is complete. It does not matter if several Exim processes do
25626 this simultaneously (apart from wasting a few resources). Once a file is in
25627 place, new Exim processes immediately start using it.
25628
25629 For maximum security, the parameters that are stored in this file should be
25630 recalculated periodically, the frequency depending on your paranoia level.
25631 If you are avoiding using the fixed D-H primes published in RFCs, then you
25632 are concerned about some advanced attacks and will wish to do this; if you do
25633 not regenerate then you might as well stick to the standard primes.
25634
25635 Arranging this is easy in principle; just delete the file when you want new
25636 values to be computed. However, there may be a problem. The calculation of new
25637 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25638 If the system is not very active, &_/dev/random_& may delay returning data
25639 until enough randomness (entropy) is available. This may cause Exim to hang for
25640 a substantial amount of time, causing timeouts on incoming connections.
25641
25642 The solution is to generate the parameters externally to Exim. They are stored
25643 in &_gnutls-params-N_& in PEM format, which means that they can be
25644 generated externally using the &(certtool)& command that is part of GnuTLS.
25645
25646 To replace the parameters with new ones, instead of deleting the file
25647 and letting Exim re-create it, you can generate new parameters using
25648 &(certtool)& and, when this has been done, replace Exim's cache file by
25649 renaming. The relevant commands are something like this:
25650 .code
25651 # ls
25652 [ look for file; assume gnutls-params-2236 is the most recent ]
25653 # rm -f new-params
25654 # touch new-params
25655 # chown exim:exim new-params
25656 # chmod 0600 new-params
25657 # certtool --generate-dh-params --bits 2236 >>new-params
25658 # openssl dhparam -noout -text -in new-params | head
25659 [ check the first line, make sure it's not more than 2236;
25660   if it is, then go back to the start ("rm") and repeat
25661   until the size generated is at most the size requested ]
25662 # chmod 0400 new-params
25663 # mv new-params gnutls-params-2236
25664 .endd
25665 If Exim never has to generate the parameters itself, the possibility of
25666 stalling is removed.
25667
25668 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25669 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25670 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25671 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25672 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25673 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25674 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25675 which applies to all D-H usage, client or server.  If the value returned by
25676 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25677 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25678 limit, which is still much higher than Exim historically used.
25679
25680 The filename and bits used will change as the GnuTLS maintainers change the
25681 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25682 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25683 2432 bits, while NSS is limited to 2236 bits.
25684
25685 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25686 increase the chance of the generated prime actually being within acceptable
25687 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25688 procedure above.  There is no sane procedure available to Exim to double-check
25689 the size of the generated prime, so it might still be too large.
25690
25691
25692 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25693 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25694 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25695 There is a function in the OpenSSL library that can be passed a list of cipher
25696 suites before the cipher negotiation takes place. This specifies which ciphers
25697 are acceptable. The list is colon separated and may contain names like
25698 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25699 directly to this function call.
25700 Many systems will install the OpenSSL manual-pages, so you may have
25701 &'ciphers(1)'& available to you.
25702 The following quotation from the OpenSSL
25703 documentation specifies what forms of item are allowed in the cipher string:
25704
25705 .ilist
25706 It can consist of a single cipher suite such as RC4-SHA.
25707 .next
25708 It can represent a list of cipher suites containing a certain algorithm,
25709 or cipher suites of a certain type. For example SHA1 represents all
25710 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25711 SSL v3 algorithms.
25712 .next
25713 Lists of cipher suites can be combined in a single cipher string using
25714 the + character. This is used as a logical and operation. For example
25715 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25716 algorithms.
25717 .endlist
25718
25719 Each cipher string can be optionally preceded by one of the characters &`!`&,
25720 &`-`& or &`+`&.
25721 .ilist
25722 If &`!`& is used, the ciphers are permanently deleted from the list. The
25723 ciphers deleted can never reappear in the list even if they are explicitly
25724 stated.
25725 .next
25726 If &`-`& is used, the ciphers are deleted from the list, but some or all
25727 of the ciphers can be added again by later options.
25728 .next
25729 If &`+`& is used, the ciphers are moved to the end of the list. This
25730 option does not add any new ciphers; it just moves matching existing ones.
25731 .endlist
25732
25733 If none of these characters is present, the string is interpreted as
25734 a list of ciphers to be appended to the current preference list. If the list
25735 includes any ciphers already present they will be ignored: that is, they will
25736 not be moved to the end of the list.
25737 .endlist
25738
25739 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25740 string:
25741 .code
25742 # note single-quotes to get ! past any shell history expansion
25743 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25744 .endd
25745
25746 This example will let the library defaults be permitted on the MX port, where
25747 there's probably no identity verification anyway, but ups the ante on the
25748 submission ports where the administrator might have some influence on the
25749 choice of clients used:
25750 .code
25751 # OpenSSL variant; see man ciphers(1)
25752 tls_require_ciphers = ${if =={$received_port}{25}\
25753                            {DEFAULT}\
25754                            {HIGH:!MD5:!SHA1}}
25755 .endd
25756
25757
25758
25759 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25760          "SECTreqciphgnu"
25761 .cindex "GnuTLS" "specifying parameters for"
25762 .cindex "TLS" "specifying ciphers (GnuTLS)"
25763 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25764 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25765 .cindex "TLS" "specifying protocols (GnuTLS)"
25766 .cindex "TLS" "specifying priority string (GnuTLS)"
25767 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25768 The GnuTLS library allows the caller to provide a "priority string", documented
25769 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25770 ciphersuite specification in OpenSSL.
25771
25772 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25773
25774 The &%tls_require_ciphers%& option is available both as an global option,
25775 controlling how Exim behaves as a server, and also as an option of the
25776 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25777 the value is string expanded.  The resulting string is not an Exim list and
25778 the string is given to the GnuTLS library, so that Exim does not need to be
25779 aware of future feature enhancements of GnuTLS.
25780
25781 Documentation of the strings accepted may be found in the GnuTLS manual, under
25782 "Priority strings".  This is online as
25783 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
25784 but beware that this relates to GnuTLS 3, which may be newer than the version
25785 installed on your system.  If you are using GnuTLS 3,
25786 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
25787 on that site can be used to test a given string.
25788
25789 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25790 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25791 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25792
25793 This example will let the library defaults be permitted on the MX port, where
25794 there's probably no identity verification anyway, and lowers security further
25795 by increasing compatibility; but this ups the ante on the submission ports
25796 where the administrator might have some influence on the choice of clients
25797 used:
25798 .code
25799 # GnuTLS variant
25800 tls_require_ciphers = ${if =={$received_port}{25}\
25801                            {NORMAL:%COMPAT}\
25802                            {SECURE128}}
25803 .endd
25804
25805
25806 .section "Configuring an Exim server to use TLS" "SECID182"
25807 .cindex "TLS" "configuring an Exim server"
25808 When Exim has been built with TLS support, it advertises the availability of
25809 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25810 but not to any others. The default value of this option is unset, which means
25811 that STARTTLS is not advertised at all. This default is chosen because you
25812 need to set some other options in order to make TLS available, and also it is
25813 sensible for systems that want to use TLS only as a client.
25814
25815 If a client issues a STARTTLS command and there is some configuration
25816 problem in the server, the command is rejected with a 454 error. If the client
25817 persists in trying to issue SMTP commands, all except QUIT are rejected
25818 with the error
25819 .code
25820 554 Security failure
25821 .endd
25822 If a STARTTLS command is issued within an existing TLS session, it is
25823 rejected with a 554 error code.
25824
25825 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25826 match some hosts. You can, of course, set it to * to match all hosts.
25827 However, this is not all you need to do. TLS sessions to a server won't work
25828 without some further configuration at the server end.
25829
25830 It is rumoured that all existing clients that support TLS/SSL use RSA
25831 encryption. To make this work you need to set, in the server,
25832 .code
25833 tls_certificate = /some/file/name
25834 tls_privatekey = /some/file/name
25835 .endd
25836 These options are, in fact, expanded strings, so you can make them depend on
25837 the identity of the client that is connected if you wish. The first file
25838 contains the server's X509 certificate, and the second contains the private key
25839 that goes with it. These files need to be readable by the Exim user, and must
25840 always be given as full path names. They can be the same file if both the
25841 certificate and the key are contained within it. If &%tls_privatekey%& is not
25842 set, or if its expansion is forced to fail or results in an empty string, this
25843 is assumed to be the case. The certificate file may also contain intermediate
25844 certificates that need to be sent to the client to enable it to authenticate
25845 the server's certificate.
25846
25847 If you do not understand about certificates and keys, please try to find a
25848 source of this background information, which is not Exim-specific. (There are a
25849 few comments below in section &<<SECTcerandall>>&.)
25850
25851 &*Note*&: These options do not apply when Exim is operating as a client &--
25852 they apply only in the case of a server. If you need to use a certificate in an
25853 Exim client, you must set the options of the same names in an &(smtp)&
25854 transport.
25855
25856 With just these options, an Exim server will be able to use TLS. It does not
25857 require the client to have a certificate (but see below for how to insist on
25858 this). There is one other option that may be needed in other situations. If
25859 .code
25860 tls_dhparam = /some/file/name
25861 .endd
25862 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25863 with the parameters contained in the file.
25864 Set this to &`none`& to disable use of DH entirely, by making no prime
25865 available:
25866 .code
25867 tls_dhparam = none
25868 .endd
25869 This may also be set to a string identifying a standard prime to be used for
25870 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25871 used is &`ike23`&.  There are a few standard primes available, see the
25872 documentation for &%tls_dhparam%& for the complete list.
25873
25874 See the command
25875 .code
25876 openssl dhparam
25877 .endd
25878 for a way of generating file data.
25879
25880 The strings supplied for these three options are expanded every time a client
25881 host connects. It is therefore possible to use different certificates and keys
25882 for different hosts, if you so wish, by making use of the client's IP address
25883 in &$sender_host_address$& to control the expansion. If a string expansion is
25884 forced to fail, Exim behaves as if the option is not set.
25885
25886 .cindex "cipher" "logging"
25887 .cindex "log" "TLS cipher"
25888 .vindex "&$tls_in_cipher$&"
25889 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25890 an incoming TLS connection. It is included in the &'Received:'& header of an
25891 incoming message (by default &-- you can, of course, change this), and it is
25892 also included in the log line that records a message's arrival, keyed by
25893 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25894 condition can be used to test for specific cipher suites in ACLs.
25895
25896 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25897 can check the name of the cipher suite and vary their actions accordingly. The
25898 cipher suite names vary, depending on which TLS library is being used. For
25899 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25900 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25901 documentation for more details.
25902
25903 .new
25904 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25905 (again depending on the &%tls_cipher%& log selector).
25906 .wen
25907
25908
25909 .section "Requesting and verifying client certificates" "SECID183"
25910 .cindex "certificate" "verification of client"
25911 .cindex "TLS" "client certificate verification"
25912 If you want an Exim server to request a certificate when negotiating a TLS
25913 session with a client, you must set either &%tls_verify_hosts%& or
25914 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25915 apply to all TLS connections. For any host that matches one of these options,
25916 Exim requests a certificate as part of the setup of the TLS session. The
25917 contents of the certificate are verified by comparing it with a list of
25918 expected certificates. These must be available in a file or,
25919 for OpenSSL only (not GnuTLS), a directory, identified by
25920 &%tls_verify_certificates%&.
25921
25922 A file can contain multiple certificates, concatenated end to end. If a
25923 directory is used
25924 (OpenSSL only),
25925 each certificate must be in a separate file, with a name (or a symbolic link)
25926 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25927 certificate. You can compute the relevant hash by running the command
25928 .code
25929 openssl x509 -hash -noout -in /cert/file
25930 .endd
25931 where &_/cert/file_& contains a single certificate.
25932
25933 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25934 what happens if the client does not supply a certificate, or if the certificate
25935 does not match any of the certificates in the collection named by
25936 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25937 attempt to set up a TLS session is aborted, and the incoming connection is
25938 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25939 session continues. ACLs that run for subsequent SMTP commands can detect the
25940 fact that no certificate was verified, and vary their actions accordingly. For
25941 example, you can insist on a certificate before accepting a message for
25942 relaying, but not when the message is destined for local delivery.
25943
25944 .vindex "&$tls_in_peerdn$&"
25945 When a client supplies a certificate (whether it verifies or not), the value of
25946 the Distinguished Name of the certificate is made available in the variable
25947 &$tls_in_peerdn$& during subsequent processing of the message.
25948
25949 .cindex "log" "distinguished name"
25950 Because it is often a long text string, it is not included in the log line or
25951 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25952 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25953 &%received_header_text%& to change the &'Received:'& header. When no
25954 certificate is supplied, &$tls_in_peerdn$& is empty.
25955
25956
25957 .section "Revoked certificates" "SECID184"
25958 .cindex "TLS" "revoked certificates"
25959 .cindex "revocation list"
25960 .cindex "certificate" "revocation list"
25961 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25962 certificates are revoked. If you have such a list, you can pass it to an Exim
25963 server using the global option called &%tls_crl%& and to an Exim client using
25964 an identically named option for the &(smtp)& transport. In each case, the value
25965 of the option is expanded and must then be the name of a file that contains a
25966 CRL in PEM format.
25967
25968
25969 .section "Configuring an Exim client to use TLS" "SECID185"
25970 .cindex "cipher" "logging"
25971 .cindex "log" "TLS cipher"
25972 .cindex "log" "distinguished name"
25973 .cindex "TLS" "configuring an Exim client"
25974 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25975 deliveries as well as to incoming, the latter one causing logging of the
25976 server certificate's DN. The remaining client configuration for TLS is all
25977 within the &(smtp)& transport.
25978
25979 It is not necessary to set any options to have TLS work in the &(smtp)&
25980 transport. If Exim is built with TLS support, and TLS is advertised by a
25981 server, the &(smtp)& transport always tries to start a TLS session. However,
25982 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25983 transport) to a list of server hosts for which TLS should not be used.
25984
25985 If you do not want Exim to attempt to send messages unencrypted when an attempt
25986 to set up an encrypted connection fails in any way, you can set
25987 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25988 those hosts, delivery is always deferred if an encrypted connection cannot be
25989 set up. If there are any other hosts for the address, they are tried in the
25990 usual way.
25991
25992 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25993 the message unencrypted. It always does this if the response to STARTTLS is
25994 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25995 session after a success response code, what happens is controlled by the
25996 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25997 delivery to this host is deferred, and other hosts (if available) are tried. If
25998 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25999 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26000 negotiation fails, Exim closes the current connection (because it is in an
26001 unknown state), opens a new one to the same host, and then tries the delivery
26002 unencrypted.
26003
26004 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26005 transport provide the client with a certificate, which is passed to the server
26006 if it requests it. If the server is Exim, it will request a certificate only if
26007 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26008
26009 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26010 must name a file or,
26011 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
26012 expected server certificates. The client verifies the server's certificate
26013 against this collection, taking into account any revoked certificates that are
26014 in the list defined by &%tls_crl%&.
26015
26016 If
26017 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26018 list of permitted cipher suites. If either of these checks fails, delivery to
26019 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26020 alternative hosts, if any.
26021
26022  &*Note*&:
26023 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26024 is operating as a client. Exim does not assume that a server certificate (set
26025 by the global options of the same name) should also be used when operating as a
26026 client.
26027
26028 .vindex "&$host$&"
26029 .vindex "&$host_address$&"
26030 All the TLS options in the &(smtp)& transport are expanded before use, with
26031 &$host$& and &$host_address$& containing the name and address of the server to
26032 which the client is connected. Forced failure of an expansion causes Exim to
26033 behave as if the relevant option were unset.
26034
26035 .vindex &$tls_out_bits$&
26036 .vindex &$tls_out_cipher$&
26037 .vindex &$tls_out_peerdn$&
26038 .vindex &$tls_out_sni$&
26039 Before an SMTP connection is established, the
26040 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26041 variables are emptied. (Until the first connection, they contain the values
26042 that were set when the message was received.) If STARTTLS is subsequently
26043 successfully obeyed, these variables are set to the relevant values for the
26044 outgoing connection.
26045
26046
26047
26048 .section "Use of TLS Server Name Indication" "SECTtlssni"
26049 .cindex "TLS" "Server Name Indication"
26050 .vindex "&$tls_in_sni$&"
26051 .oindex "&%tls_in_sni%&"
26052 With TLS1.0 or above, there is an extension mechanism by which extra
26053 information can be included at various points in the protocol.  One of these
26054 extensions, documented in RFC 6066 (and before that RFC 4366) is
26055 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26056 client in the initial handshake, so that the server can examine the servername
26057 within and possibly choose to use different certificates and keys (and more)
26058 for this session.
26059
26060 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26061 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26062 address.
26063
26064 With SMTP to MX, there are the same problems here as in choosing the identity
26065 against which to validate a certificate: you can't rely on insecure DNS to
26066 provide the identity which you then cryptographically verify.  So this will
26067 be of limited use in that environment.
26068
26069 With SMTP to Submission, there is a well-defined hostname which clients are
26070 connecting to and can validate certificates against.  Thus clients &*can*&
26071 choose to include this information in the TLS negotiation.  If this becomes
26072 wide-spread, then hosters can choose to present different certificates to
26073 different clients.  Or even negotiate different cipher suites.
26074
26075 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26076 if not empty, will be sent on a TLS session as part of the handshake.  There's
26077 nothing more to it.  Choosing a sensible value not derived insecurely is the
26078 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26079 for the lifetime of the client connection (including during authentication).
26080
26081 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26082 received from a client.
26083 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26084
26085 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26086 option (prior to expansion) then the following options will be re-expanded
26087 during TLS session handshake, to permit alternative values to be chosen:
26088
26089 .ilist
26090 .vindex "&%tls_certificate%&"
26091 &%tls_certificate%&
26092 .next
26093 .vindex "&%tls_crl%&"
26094 &%tls_crl%&
26095 .next
26096 .vindex "&%tls_privatekey%&"
26097 &%tls_privatekey%&
26098 .next
26099 .vindex "&%tls_verify_certificates%&"
26100 &%tls_verify_certificates%&
26101 .endlist
26102
26103 Great care should be taken to deal with matters of case, various injection
26104 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26105 can always be referenced; it is important to remember that &$tls_sni$& is
26106 arbitrary unverified data provided prior to authentication.
26107
26108 The Exim developers are proceeding cautiously and so far no other TLS options
26109 are re-expanded.
26110
26111 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26112 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26113 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26114 see &`-servername`& in the output, then OpenSSL has support.
26115
26116 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26117 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26118 built, then you have SNI support).
26119
26120
26121
26122 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26123          "SECTmulmessam"
26124 .cindex "multiple SMTP deliveries with TLS"
26125 .cindex "TLS" "multiple message deliveries"
26126 Exim sends multiple messages down the same TCP/IP connection by starting up
26127 an entirely new delivery process for each message, passing the socket from
26128 one process to the next. This implementation does not fit well with the use
26129 of TLS, because there is quite a lot of state information associated with a TLS
26130 connection, not just a socket identification. Passing all the state information
26131 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26132 session before passing the socket to a new process. The new process may then
26133 try to start a new TLS session, and if successful, may try to re-authenticate
26134 if AUTH is in use, before sending the next message.
26135
26136 The RFC is not clear as to whether or not an SMTP session continues in clear
26137 after TLS has been shut down, or whether TLS may be restarted again later, as
26138 just described. However, if the server is Exim, this shutdown and
26139 reinitialization works. It is not known which (if any) other servers operate
26140 successfully if the client closes a TLS session and continues with unencrypted
26141 SMTP, but there are certainly some that do not work. For such servers, Exim
26142 should not pass the socket to another process, because the failure of the
26143 subsequent attempt to use it would cause Exim to record a temporary host error,
26144 and delay other deliveries to that host.
26145
26146 To test for this case, Exim sends an EHLO command to the server after
26147 closing down the TLS session. If this fails in any way, the connection is
26148 closed instead of being passed to a new delivery process, but no retry
26149 information is recorded.
26150
26151 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26152 &(smtp)& transport to match those hosts for which Exim should not pass
26153 connections to new processes if TLS has been used.
26154
26155
26156
26157
26158 .section "Certificates and all that" "SECTcerandall"
26159 .cindex "certificate" "references to discussion"
26160 In order to understand fully how TLS works, you need to know about
26161 certificates, certificate signing, and certificate authorities. This is not the
26162 place to give a tutorial, especially as I do not know very much about it
26163 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26164 to Apache, currently at
26165 .display
26166 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26167 .endd
26168 Other parts of the &'modssl'& documentation are also helpful, and have
26169 links to further files.
26170 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26171 0-201-61598-3), contains both introductory and more in-depth descriptions.
26172 Some sample programs taken from the book are available from
26173 .display
26174 &url(http://www.rtfm.com/openssl-examples/)
26175 .endd
26176
26177
26178 .section "Certificate chains" "SECID186"
26179 The file named by &%tls_certificate%& may contain more than one
26180 certificate. This is useful in the case where the certificate that is being
26181 sent is validated by an intermediate certificate which the other end does
26182 not have. Multiple certificates must be in the correct order in the file.
26183 First the host's certificate itself, then the first intermediate
26184 certificate to validate the issuer of the host certificate, then the next
26185 intermediate certificate to validate the issuer of the first intermediate
26186 certificate, and so on, until finally (optionally) the root certificate.
26187 The root certificate must already be trusted by the recipient for
26188 validation to succeed, of course, but if it's not preinstalled, sending the
26189 root certificate along with the rest makes it available for the user to
26190 install if the receiving end is a client MUA that can interact with a user.
26191
26192
26193 .section "Self-signed certificates" "SECID187"
26194 .cindex "certificate" "self-signed"
26195 You can create a self-signed certificate using the &'req'& command provided
26196 with OpenSSL, like this:
26197 .new
26198 . ==== Do not shorten the duration here without reading and considering
26199 . ==== the text below.  Please leave it at 9999 days.
26200 .wen
26201 .code
26202 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26203             -days 9999 -nodes
26204 .endd
26205 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26206 delimited and so can be identified independently. The &%-days%& option
26207 specifies a period for which the certificate is valid. The &%-nodes%& option is
26208 important: if you do not set it, the key is encrypted with a passphrase
26209 that you are prompted for, and any use that is made of the key causes more
26210 prompting for the passphrase. This is not helpful if you are going to use
26211 this certificate and key in an MTA, where prompting is not possible.
26212
26213 .new
26214 . ==== I expect to still be working 26 years from now.  The less technical
26215 . ==== debt I create, in terms of storing up trouble for my later years, the
26216 . ==== happier I will be then.  We really have reached the point where we
26217 . ==== should start, at the very least, provoking thought and making folks
26218 . ==== pause before proceeding, instead of leaving all the fixes until two
26219 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26220 . ==== -pdp, 2012
26221 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26222 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26223 the above command might produce a date in the past.  Think carefully about
26224 the lifetime of the systems you're deploying, and either reduce the duration
26225 of the certificate or reconsider your platform deployment.  (At time of
26226 writing, reducing the duration is the most likely choice, but the inexorable
26227 progression of time takes us steadily towards an era where this will not
26228 be a sensible resolution).
26229 .wen
26230
26231 A self-signed certificate made in this way is sufficient for testing, and
26232 may be adequate for all your requirements if you are mainly interested in
26233 encrypting transfers, and not in secure identification.
26234
26235 However, many clients require that the certificate presented by the server be a
26236 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26237 certificate. In this situation, the self-signed certificate described above
26238 must be installed on the client host as a trusted root &'certification
26239 authority'& (CA), and the certificate used by Exim must be a user certificate
26240 signed with that self-signed certificate.
26241
26242 For information on creating self-signed CA certificates and using them to sign
26243 user certificates, see the &'General implementation overview'& chapter of the
26244 Open-source PKI book, available online at
26245 &url(http://ospkibook.sourceforge.net/).
26246 .ecindex IIDencsmtp1
26247 .ecindex IIDencsmtp2
26248
26249
26250
26251 . ////////////////////////////////////////////////////////////////////////////
26252 . ////////////////////////////////////////////////////////////////////////////
26253
26254 .chapter "Access control lists" "CHAPACL"
26255 .scindex IIDacl "&ACL;" "description"
26256 .cindex "control of incoming mail"
26257 .cindex "message" "controlling incoming"
26258 .cindex "policy control" "access control lists"
26259 Access Control Lists (ACLs) are defined in a separate section of the run time
26260 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26261 name, terminated by a colon. Here is a complete ACL section that contains just
26262 one very small ACL:
26263 .code
26264 begin acl
26265 small_acl:
26266   accept   hosts = one.host.only
26267 .endd
26268 You can have as many lists as you like in the ACL section, and the order in
26269 which they appear does not matter. The lists are self-terminating.
26270
26271 The majority of ACLs are used to control Exim's behaviour when it receives
26272 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26273 when a local process submits a message using SMTP by specifying the &%-bs%&
26274 option. The most common use is for controlling which recipients are accepted
26275 in incoming messages. In addition, you can define an ACL that is used to check
26276 local non-SMTP messages. The default configuration file contains an example of
26277 a realistic ACL for checking RCPT commands. This is discussed in chapter
26278 &<<CHAPdefconfil>>&.
26279
26280
26281 .section "Testing ACLs" "SECID188"
26282 The &%-bh%& command line option provides a way of testing your ACL
26283 configuration locally by running a fake SMTP session with which you interact.
26284 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26285 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26286
26287
26288
26289 .section "Specifying when ACLs are used" "SECID189"
26290 .cindex "&ACL;" "options for specifying"
26291 In order to cause an ACL to be used, you have to name it in one of the relevant
26292 options in the main part of the configuration. These options are:
26293 .cindex "AUTH" "ACL for"
26294 .cindex "DATA" "ACLs for"
26295 .cindex "ETRN" "ACL for"
26296 .cindex "EXPN" "ACL for"
26297 .cindex "HELO" "ACL for"
26298 .cindex "EHLO" "ACL for"
26299 .cindex "MAIL" "ACL for"
26300 .cindex "QUIT, ACL for"
26301 .cindex "RCPT" "ACL for"
26302 .cindex "STARTTLS, ACL for"
26303 .cindex "VRFY" "ACL for"
26304 .cindex "SMTP" "connection, ACL for"
26305 .cindex "non-SMTP messages" "ACLs for"
26306 .cindex "MIME content scanning" "ACL for"
26307
26308 .table2 140pt
26309 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26310 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26311 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26312 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26313 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26314 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26315 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26316 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26317 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26318 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26319 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26320 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26321 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26322 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26323 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26324 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26325 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26326 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26327 .endtable
26328
26329 For example, if you set
26330 .code
26331 acl_smtp_rcpt = small_acl
26332 .endd
26333 the little ACL defined above is used whenever Exim receives a RCPT command
26334 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26335 done when RCPT commands arrive. A rejection of RCPT should cause the
26336 sending MTA to give up on the recipient address contained in the RCPT
26337 command, whereas rejection at other times may cause the client MTA to keep on
26338 trying to deliver the message. It is therefore recommended that you do as much
26339 testing as possible at RCPT time.
26340
26341
26342 .section "The non-SMTP ACLs" "SECID190"
26343 .cindex "non-SMTP messages" "ACLs for"
26344 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26345 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26346 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26347 the state of the SMTP connection such as encryption and authentication) are not
26348 relevant and are forbidden in these ACLs. However, the sender and recipients
26349 are known, so the &%senders%& and &%sender_domains%& conditions and the
26350 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26351 &$authenticated_sender$& are also available. You can specify added header lines
26352 in any of these ACLs.
26353
26354 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26355 non-SMTP message, before any of the message has been read. (This is the
26356 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26357 batched SMTP input, it runs after the DATA command has been reached. The
26358 result of this ACL is ignored; it cannot be used to reject a message. If you
26359 really need to, you could set a value in an ACL variable here and reject based
26360 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26361 controls, and in particular, it can be used to set
26362 .code
26363 control = suppress_local_fixups
26364 .endd
26365 This cannot be used in the other non-SMTP ACLs because by the time they are
26366 run, it is too late.
26367
26368 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26369 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26370
26371 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26372 kind of rejection is treated as permanent, because there is no way of sending a
26373 temporary error for these kinds of message.
26374
26375
26376 .section "The SMTP connect ACL" "SECID191"
26377 .cindex "SMTP" "connection, ACL for"
26378 .oindex &%smtp_banner%&
26379 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26380 session, after the test specified by &%host_reject_connection%& (which is now
26381 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26382 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26383 the message override the banner message that is otherwise specified by the
26384 &%smtp_banner%& option.
26385
26386
26387 .section "The EHLO/HELO ACL" "SECID192"
26388 .cindex "EHLO" "ACL for"
26389 .cindex "HELO" "ACL for"
26390 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26391 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26392 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26393 Note that a client may issue more than one EHLO or HELO command in an SMTP
26394 session, and indeed is required to issue a new EHLO or HELO after successfully
26395 setting up encryption following a STARTTLS command.
26396
26397 If the command is accepted by an &%accept%& verb that has a &%message%&
26398 modifier, the message may not contain more than one line (it will be truncated
26399 at the first newline and a panic logged if it does). Such a message cannot
26400 affect the EHLO options that are listed on the second and subsequent lines of
26401 an EHLO response.
26402
26403
26404 .section "The DATA ACLs" "SECID193"
26405 .cindex "DATA" "ACLs for"
26406 Two ACLs are associated with the DATA command, because it is two-stage
26407 command, with two responses being sent to the client.
26408 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26409 is obeyed. This gives you control after all the RCPT commands, but before
26410 the message itself is received. It offers the opportunity to give a negative
26411 response to the DATA command before the data is transmitted. Header lines
26412 added by MAIL or RCPT ACLs are not visible at this time, but any that
26413 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26414
26415 You cannot test the contents of the message, for example, to verify addresses
26416 in the headers, at RCPT time or when the DATA command is received. Such
26417 tests have to appear in the ACL that is run after the message itself has been
26418 received, before the final response to the DATA command is sent. This is
26419 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26420 associated with the DATA command.
26421
26422 For both of these ACLs, it is not possible to reject individual recipients. An
26423 error response rejects the entire message. Unfortunately, it is known that some
26424 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26425 before or after the data) correctly &-- they keep the message on their queues
26426 and try again later, but that is their problem, though it does waste some of
26427 your resources.
26428
26429 .new
26430 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26431 the &%acl_smtp_mime%& ACLs.
26432 .wen
26433
26434 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26435 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26436 enabled (which is the default).
26437
26438 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26439 received, and is executed for each DKIM signature found in a message.  If not
26440 otherwise specified, the default action is to accept.
26441
26442 .new
26443 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26444
26445 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26446 .wen
26447
26448
26449 .section "The SMTP MIME ACL" "SECID194"
26450 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26451 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26452
26453 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26454
26455
26456 .section "The QUIT ACL" "SECTQUITACL"
26457 .cindex "QUIT, ACL for"
26458 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26459 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26460 does not in fact control any access. For this reason, the only verbs that are
26461 permitted are &%accept%& and &%warn%&.
26462
26463 This ACL can be used for tasks such as custom logging at the end of an SMTP
26464 session. For example, you can use ACL variables in other ACLs to count
26465 messages, recipients, etc., and log the totals at QUIT time using one or
26466 more &%logwrite%& modifiers on a &%warn%& verb.
26467
26468 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26469 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26470
26471 You do not need to have a final &%accept%&, but if you do, you can use a
26472 &%message%& modifier to specify custom text that is sent as part of the 221
26473 response to QUIT.
26474
26475 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26476 failure (for example, failure to open a log file, or when Exim is bombing out
26477 because it has detected an unrecoverable error), all SMTP commands from the
26478 client are given temporary error responses until QUIT is received or the
26479 connection is closed. In these special cases, the QUIT ACL does not run.
26480
26481
26482 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26483 .vindex &$acl_smtp_notquit$&
26484 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26485 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26486 trouble, such as being unable to write to its log files, this ACL is not run,
26487 because it might try to do things (such as write to log files) that make the
26488 situation even worse.
26489
26490 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26491 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26492 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26493 and &%warn%&.
26494
26495 .vindex &$smtp_notquit_reason$&
26496 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26497 to a string that indicates the reason for the termination of the SMTP
26498 connection. The possible values are:
26499 .table2
26500 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26501 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26502 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26503 .irow &`connection-lost`&          "The SMTP connection has been lost"
26504 .irow &`data-timeout`&             "Timeout while reading message data"
26505 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26506 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26507 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26508 .irow &`synchronization-error`&    "SMTP synchronization error"
26509 .irow &`tls-failed`&               "TLS failed to start"
26510 .endtable
26511 In most cases when an SMTP connection is closed without having received QUIT,
26512 Exim sends an SMTP response message before actually closing the connection.
26513 With the exception of the &`acl-drop`& case, the default message can be
26514 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26515 &%drop%& verb in another ACL, it is the message from the other ACL that is
26516 used.
26517
26518
26519 .section "Finding an ACL to use" "SECID195"
26520 .cindex "&ACL;" "finding which to use"
26521 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26522 you can use different ACLs in different circumstances. For example,
26523 .code
26524 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26525                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26526 .endd
26527 In the default configuration file there are some example settings for
26528 providing an RFC 4409 message submission service on port 587 and a
26529 non-standard &"smtps"& service on port 465. You can use a string
26530 expansion like this to choose an ACL for MUAs on these ports which is
26531 more appropriate for this purpose than the default ACL on port 25.
26532
26533 The expanded string does not have to be the name of an ACL in the
26534 configuration file; there are other possibilities. Having expanded the
26535 string, Exim searches for an ACL as follows:
26536
26537 .ilist
26538 If the string begins with a slash, Exim uses it as a file name, and reads its
26539 contents as an ACL. The lines are processed in the same way as lines in the
26540 Exim configuration file. In particular, continuation lines are supported, blank
26541 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26542 If the file does not exist or cannot be read, an error occurs (typically
26543 causing a temporary failure of whatever caused the ACL to be run). For example:
26544 .code
26545 acl_smtp_data = /etc/acls/\
26546   ${lookup{$sender_host_address}lsearch\
26547   {/etc/acllist}{$value}{default}}
26548 .endd
26549 This looks up an ACL file to use on the basis of the host's IP address, falling
26550 back to a default if the lookup fails. If an ACL is successfully read from a
26551 file, it is retained in memory for the duration of the Exim process, so that it
26552 can be re-used without having to re-read the file.
26553 .next
26554 If the string does not start with a slash, and does not contain any spaces,
26555 Exim searches the ACL section of the configuration for an ACL whose name
26556 matches the string.
26557 .next
26558 If no named ACL is found, or if the string contains spaces, Exim parses
26559 the string as an inline ACL. This can save typing in cases where you just
26560 want to have something like
26561 .code
26562 acl_smtp_vrfy = accept
26563 .endd
26564 in order to allow free use of the VRFY command. Such a string may contain
26565 newlines; it is processed in the same way as an ACL that is read from a file.
26566 .endlist
26567
26568
26569
26570
26571 .section "ACL return codes" "SECID196"
26572 .cindex "&ACL;" "return codes"
26573 Except for the QUIT ACL, which does not affect the SMTP return code (see
26574 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26575 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26576 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26577 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26578 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26579 This also causes a 4&'xx'& return code.
26580
26581 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26582 &"deny"&, because there is no mechanism for passing temporary errors to the
26583 submitters of non-SMTP messages.
26584
26585
26586 ACLs that are relevant to message reception may also return &"discard"&. This
26587 has the effect of &"accept"&, but causes either the entire message or an
26588 individual recipient address to be discarded. In other words, it is a
26589 blackholing facility. Use it with care.
26590
26591 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26592 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26593 RCPT ACL is to discard just the one recipient address. If there are no
26594 recipients left when the message's data is received, the DATA ACL is not
26595 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26596 remaining recipients. The &"discard"& return is not permitted for the
26597 &%acl_smtp_predata%& ACL.
26598
26599
26600 .cindex "&[local_scan()]& function" "when all recipients discarded"
26601 The &[local_scan()]& function is always run, even if there are no remaining
26602 recipients; it may create new recipients.
26603
26604
26605
26606 .section "Unset ACL options" "SECID197"
26607 .cindex "&ACL;" "unset options"
26608 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26609 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26610 not defined at all. For any defined ACL, the default action when control
26611 reaches the end of the ACL statements is &"deny"&.
26612
26613 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26614 these two are ACLs that are used only for their side effects. They cannot be
26615 used to accept or reject anything.
26616
26617 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26618 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26619 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26620 when the ACL is not defined is &"accept"&.
26621
26622 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26623 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26624 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26625 messages over an SMTP connection. For an example, see the ACL in the default
26626 configuration file.
26627
26628
26629
26630
26631 .section "Data for message ACLs" "SECID198"
26632 .cindex "&ACL;" "data for message ACL"
26633 .vindex &$domain$&
26634 .vindex &$local_part$&
26635 .vindex &$sender_address$&
26636 .vindex &$sender_host_address$&
26637 .vindex &$smtp_command$&
26638 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26639 that contain information about the host and the message's sender (for example,
26640 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26641 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26642 &$local_part$& are set from the argument address. The entire SMTP command
26643 is available in &$smtp_command$&.
26644
26645 When an ACL for the AUTH parameter of MAIL is running, the variables that
26646 contain information about the host are set, but &$sender_address$& is not yet
26647 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26648 how it is used.
26649
26650 .vindex "&$message_size$&"
26651 The &$message_size$& variable is set to the value of the SIZE parameter on
26652 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26653 that parameter is not given. The value is updated to the true message size by
26654 the time the final DATA ACL is run (after the message data has been
26655 received).
26656
26657 .vindex "&$rcpt_count$&"
26658 .vindex "&$recipients_count$&"
26659 The &$rcpt_count$& variable increases by one for each RCPT command received.
26660 The &$recipients_count$& variable increases by one each time a RCPT command is
26661 accepted, so while an ACL for RCPT is being processed, it contains the number
26662 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26663 &$rcpt_count$& contains the total number of RCPT commands, and
26664 &$recipients_count$& contains the total number of accepted recipients.
26665
26666
26667
26668
26669
26670 .section "Data for non-message ACLs" "SECTdatfornon"
26671 .cindex "&ACL;" "data for non-message ACL"
26672 .vindex &$smtp_command_argument$&
26673 .vindex &$smtp_command$&
26674 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26675 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26676 and the entire SMTP command is available in &$smtp_command$&.
26677 These variables can be tested using a &%condition%& condition. For example,
26678 here is an ACL for use with AUTH, which insists that either the session is
26679 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26680 does not permit authentication methods that use cleartext passwords on
26681 unencrypted connections.
26682 .code
26683 acl_check_auth:
26684   accept encrypted = *
26685   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26686                      {CRAM-MD5}}
26687   deny   message   = TLS encryption or CRAM-MD5 required
26688 .endd
26689 (Another way of applying this restriction is to arrange for the authenticators
26690 that use cleartext passwords not to be advertised when the connection is not
26691 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26692 option to do this.)
26693
26694
26695
26696 .section "Format of an ACL" "SECID199"
26697 .cindex "&ACL;" "format of"
26698 .cindex "&ACL;" "verbs, definition of"
26699 An individual ACL consists of a number of statements. Each statement starts
26700 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26701 Modifiers can change the way the verb operates, define error and log messages,
26702 set variables, insert delays, and vary the processing of accepted messages.
26703
26704 If all the conditions are met, the verb is obeyed. The same condition may be
26705 used (with different arguments) more than once in the same statement. This
26706 provides a means of specifying an &"and"& conjunction between conditions. For
26707 example:
26708 .code
26709 deny  dnslists = list1.example
26710 dnslists = list2.example
26711 .endd
26712 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26713 the conditions and modifiers when it reaches a condition that fails. What
26714 happens then depends on the verb (and in one case, on a special modifier). Not
26715 all the conditions make sense at every testing point. For example, you cannot
26716 test a sender address in the ACL that is run for a VRFY command.
26717
26718
26719 .section "ACL verbs" "SECID200"
26720 The ACL verbs are as follows:
26721
26722 .ilist
26723 .cindex "&%accept%& ACL verb"
26724 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26725 of the conditions are not met, what happens depends on whether &%endpass%&
26726 appears among the conditions (for syntax see below). If the failing condition
26727 is before &%endpass%&, control is passed to the next ACL statement; if it is
26728 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26729 check a RCPT command:
26730 .code
26731 accept domains = +local_domains
26732 endpass
26733 verify = recipient
26734 .endd
26735 If the recipient domain does not match the &%domains%& condition, control
26736 passes to the next statement. If it does match, the recipient is verified, and
26737 the command is accepted if verification succeeds. However, if verification
26738 fails, the ACL yields &"deny"&, because the failing condition is after
26739 &%endpass%&.
26740
26741 The &%endpass%& feature has turned out to be confusing to many people, so its
26742 use is not recommended nowadays. It is always possible to rewrite an ACL so
26743 that &%endpass%& is not needed, and it is no longer used in the default
26744 configuration.
26745
26746 .cindex "&%message%& ACL modifier" "with &%accept%&"
26747 If a &%message%& modifier appears on an &%accept%& statement, its action
26748 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26749 (when an &%accept%& verb either accepts or passes control to the next
26750 statement), &%message%& can be used to vary the message that is sent when an
26751 SMTP command is accepted. For example, in a RCPT ACL you could have:
26752 .display
26753 &`accept  `&<&'some conditions'&>
26754 &`        message = OK, I will allow you through today`&
26755 .endd
26756 You can specify an SMTP response code, optionally followed by an &"extended
26757 response code"& at the start of the message, but the first digit must be the
26758 same as would be sent by default, which is 2 for an &%accept%& verb.
26759
26760 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26761 an error message that is used when access is denied. This behaviour is retained
26762 for backward compatibility, but current &"best practice"& is to avoid the use
26763 of &%endpass%&.
26764
26765
26766 .next
26767 .cindex "&%defer%& ACL verb"
26768 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26769 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26770 &%defer%& is the same as &%deny%&, because there is no way of sending a
26771 temporary error. For a RCPT command, &%defer%& is much the same as using a
26772 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26773 be used in any ACL, and even for a recipient it might be a simpler approach.
26774
26775
26776 .next
26777 .cindex "&%deny%& ACL verb"
26778 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26779 the conditions are not met, control is passed to the next ACL statement. For
26780 example,
26781 .code
26782 deny dnslists = blackholes.mail-abuse.org
26783 .endd
26784 rejects commands from hosts that are on a DNS black list.
26785
26786
26787 .next
26788 .cindex "&%discard%& ACL verb"
26789 &%discard%&: This verb behaves like &%accept%&, except that it returns
26790 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26791 that are concerned with receiving messages. When all the conditions are true,
26792 the sending entity receives a &"success"& response. However, &%discard%& causes
26793 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26794 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26795 message's recipients are discarded. Recipients that are discarded before DATA
26796 do not appear in the log line when the &%received_recipients%& log selector is set.
26797
26798 If the &%log_message%& modifier is set when &%discard%& operates,
26799 its contents are added to the line that is automatically written to the log.
26800 The &%message%& modifier operates exactly as it does for &%accept%&.
26801
26802
26803 .next
26804 .cindex "&%drop%& ACL verb"
26805 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26806 forcibly closed after the 5&'xx'& error message has been sent. For example:
26807 .code
26808 drop   message   = I don't take more than 20 RCPTs
26809        condition = ${if > {$rcpt_count}{20}}
26810 .endd
26811 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26812 The connection is always dropped after sending a 550 response.
26813
26814 .next
26815 .cindex "&%require%& ACL verb"
26816 &%require%&: If all the conditions are met, control is passed to the next ACL
26817 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26818 example, when checking a RCPT command,
26819 .code
26820 require message = Sender did not verify
26821         verify  = sender
26822 .endd
26823 passes control to subsequent statements only if the message's sender can be
26824 verified. Otherwise, it rejects the command. Note the positioning of the
26825 &%message%& modifier, before the &%verify%& condition. The reason for this is
26826 discussed in section &<<SECTcondmodproc>>&.
26827
26828 .next
26829 .cindex "&%warn%& ACL verb"
26830 &%warn%&: If all the conditions are true, a line specified by the
26831 &%log_message%& modifier is written to Exim's main log. Control always passes
26832 to the next ACL statement. If any condition is false, the log line is not
26833 written. If an identical log line is requested several times in the same
26834 message, only one copy is actually written to the log. If you want to force
26835 duplicates to be written, use the &%logwrite%& modifier instead.
26836
26837 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26838 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26839 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26840 first failing condition. There is more about adding header lines in section
26841 &<<SECTaddheadacl>>&.
26842
26843 If any condition on a &%warn%& statement cannot be completed (that is, there is
26844 some sort of defer), the log line specified by &%log_message%& is not written.
26845 This does not include the case of a forced failure from a lookup, which
26846 is considered to be a successful completion. After a defer, no further
26847 conditions or modifiers in the &%warn%& statement are processed. The incident
26848 is logged, and the ACL continues to be processed, from the next statement
26849 onwards.
26850
26851
26852 .vindex "&$acl_verify_message$&"
26853 When one of the &%warn%& conditions is an address verification that fails, the
26854 text of the verification failure message is in &$acl_verify_message$&. If you
26855 want this logged, you must set it up explicitly. For example:
26856 .code
26857 warn   !verify = sender
26858        log_message = sender verify failed: $acl_verify_message
26859 .endd
26860 .endlist
26861
26862 At the end of each ACL there is an implicit unconditional &%deny%&.
26863
26864 As you can see from the examples above, the conditions and modifiers are
26865 written one to a line, with the first one on the same line as the verb, and
26866 subsequent ones on following lines. If you have a very long condition, you can
26867 continue it onto several physical lines by the usual backslash continuation
26868 mechanism. It is conventional to align the conditions vertically.
26869
26870
26871
26872 .section "ACL variables" "SECTaclvariables"
26873 .cindex "&ACL;" "variables"
26874 There are some special variables that can be set during ACL processing. They
26875 can be used to pass information between different ACLs, different invocations
26876 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26877 transports, and filters that are used to deliver a message. The names of these
26878 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26879 an underscore, but the remainder of the name can be any sequence of
26880 alphanumeric characters and underscores that you choose. There is no limit on
26881 the number of ACL variables. The two sets act as follows:
26882 .ilist
26883 The values of those variables whose names begin with &$acl_c$& persist
26884 throughout an SMTP connection. They are never reset. Thus, a value that is set
26885 while receiving one message is still available when receiving the next message
26886 on the same SMTP connection.
26887 .next
26888 The values of those variables whose names begin with &$acl_m$& persist only
26889 while a message is being received. They are reset afterwards. They are also
26890 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26891 .endlist
26892
26893 When a message is accepted, the current values of all the ACL variables are
26894 preserved with the message and are subsequently made available at delivery
26895 time. The ACL variables are set by a modifier called &%set%&. For example:
26896 .code
26897 accept hosts = whatever
26898        set acl_m4 = some value
26899 accept authenticated = *
26900        set acl_c_auth = yes
26901 .endd
26902 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26903 be set. If you want to set a variable without taking any action, you can use a
26904 &%warn%& verb without any other modifiers or conditions.
26905
26906 .oindex &%strict_acl_vars%&
26907 What happens if a syntactically valid but undefined ACL variable is
26908 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26909 false (the default), an empty string is substituted; if it is true, an
26910 error is generated.
26911
26912 Versions of Exim before 4.64 have a limited set of numbered variables, but
26913 their names are compatible, so there is no problem with upgrading.
26914
26915
26916 .section "Condition and modifier processing" "SECTcondmodproc"
26917 .cindex "&ACL;" "conditions; processing"
26918 .cindex "&ACL;" "modifiers; processing"
26919 An exclamation mark preceding a condition negates its result. For example:
26920 .code
26921 deny   domains = *.dom.example
26922       !verify  = recipient
26923 .endd
26924 causes the ACL to return &"deny"& if the recipient domain ends in
26925 &'dom.example'& and the recipient address cannot be verified. Sometimes
26926 negation can be used on the right-hand side of a condition. For example, these
26927 two statements are equivalent:
26928 .code
26929 deny  hosts = !192.168.3.4
26930 deny !hosts =  192.168.3.4
26931 .endd
26932 However, for many conditions (&%verify%& being a good example), only left-hand
26933 side negation of the whole condition is possible.
26934
26935 The arguments of conditions and modifiers are expanded. A forced failure
26936 of an expansion causes a condition to be ignored, that is, it behaves as if the
26937 condition is true. Consider these two statements:
26938 .code
26939 accept  senders = ${lookup{$host_name}lsearch\
26940                   {/some/file}{$value}fail}
26941 accept  senders = ${lookup{$host_name}lsearch\
26942                   {/some/file}{$value}{}}
26943 .endd
26944 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26945 the returned list is searched, but if the lookup fails the behaviour is
26946 different in the two cases. The &%fail%& in the first statement causes the
26947 condition to be ignored, leaving no further conditions. The &%accept%& verb
26948 therefore succeeds. The second statement, however, generates an empty list when
26949 the lookup fails. No sender can match an empty list, so the condition fails,
26950 and therefore the &%accept%& also fails.
26951
26952 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26953 specify actions that are taken as the conditions for a statement are checked;
26954 others specify text for messages that are used when access is denied or a
26955 warning is generated. The &%control%& modifier affects the way an incoming
26956 message is handled.
26957
26958 The positioning of the modifiers in an ACL statement is important, because the
26959 processing of a verb ceases as soon as its outcome is known. Only those
26960 modifiers that have already been encountered will take effect. For example,
26961 consider this use of the &%message%& modifier:
26962 .code
26963 require message = Can't verify sender
26964         verify  = sender
26965         message = Can't verify recipient
26966         verify  = recipient
26967         message = This message cannot be used
26968 .endd
26969 If sender verification fails, Exim knows that the result of the statement is
26970 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26971 so its text is used as the error message. If sender verification succeeds, but
26972 recipient verification fails, the second message is used. If recipient
26973 verification succeeds, the third message becomes &"current"&, but is never used
26974 because there are no more conditions to cause failure.
26975
26976 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26977 modifier that is used, because all the conditions must be true for rejection to
26978 happen. Specifying more than one &%message%& modifier does not make sense, and
26979 the message can even be specified after all the conditions. For example:
26980 .code
26981 deny   hosts = ...
26982       !senders = *@my.domain.example
26983        message = Invalid sender from client host
26984 .endd
26985 The &"deny"& result does not happen until the end of the statement is reached,
26986 by which time Exim has set up the message.
26987
26988
26989
26990 .section "ACL modifiers" "SECTACLmodi"
26991 .cindex "&ACL;" "modifiers; list of"
26992 The ACL modifiers are as follows:
26993
26994 .vlist
26995 .vitem &*add_header*&&~=&~<&'text'&>
26996 This modifier specifies one or more header lines that are to be added to an
26997 incoming message, assuming, of course, that the message is ultimately
26998 accepted. For details, see section &<<SECTaddheadacl>>&.
26999
27000 .vitem &*continue*&&~=&~<&'text'&>
27001 .cindex "&%continue%& ACL modifier"
27002 .cindex "database" "updating in ACL"
27003 This modifier does nothing of itself, and processing of the ACL always
27004 continues with the next condition or modifier. The value of &%continue%& is in
27005 the side effects of expanding its argument. Typically this could be used to
27006 update a database. It is really just a syntactic tidiness, to avoid having to
27007 write rather ugly lines like this:
27008 .display
27009 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27010 .endd
27011 Instead, all you need is
27012 .display
27013 &`continue = `&<&'some expansion'&>
27014 .endd
27015
27016 .vitem &*control*&&~=&~<&'text'&>
27017 .cindex "&%control%& ACL modifier"
27018 This modifier affects the subsequent processing of the SMTP connection or of an
27019 incoming message that is accepted. The effect of the first type of control
27020 lasts for the duration of the connection, whereas the effect of the second type
27021 lasts only until the current message has been received. The message-specific
27022 controls always apply to the whole message, not to individual recipients,
27023 even if the &%control%& modifier appears in a RCPT ACL.
27024
27025 As there are now quite a few controls that can be applied, they are described
27026 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27027 in several different ways. For example:
27028
27029 . ==== As this is a nested list, any displays it contains must be indented
27030 . ==== as otherwise they are too far to the left. That comment applies only
27031 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27032 . ==== way.
27033
27034 .ilist
27035 It can be at the end of an &%accept%& statement:
27036 .code
27037     accept  ...some conditions
27038             control = queue_only
27039 .endd
27040 In this case, the control is applied when this statement yields &"accept"&, in
27041 other words, when the conditions are all true.
27042
27043 .next
27044 It can be in the middle of an &%accept%& statement:
27045 .code
27046     accept  ...some conditions...
27047             control = queue_only
27048             ...some more conditions...
27049 .endd
27050 If the first set of conditions are true, the control is applied, even if the
27051 statement does not accept because one of the second set of conditions is false.
27052 In this case, some subsequent statement must yield &"accept"& for the control
27053 to be relevant.
27054
27055 .next
27056 It can be used with &%warn%& to apply the control, leaving the
27057 decision about accepting or denying to a subsequent verb. For
27058 example:
27059 .code
27060     warn    ...some conditions...
27061             control = freeze
27062     accept  ...
27063 .endd
27064 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27065 &%logwrite%&, so it does not add anything to the message and does not write a
27066 log entry.
27067
27068 .next
27069 If you want to apply a control unconditionally, you can use it with a
27070 &%require%& verb. For example:
27071 .code
27072     require  control = no_multiline_responses
27073 .endd
27074 .endlist
27075
27076 .vitem &*delay*&&~=&~<&'time'&>
27077 .cindex "&%delay%& ACL modifier"
27078 .oindex "&%-bh%&"
27079 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27080 the time interval before proceeding. However, when testing Exim using the
27081 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27082 output instead). The time is given in the usual Exim notation, and the delay
27083 happens as soon as the modifier is processed. In an SMTP session, pending
27084 output is flushed before the delay is imposed.
27085
27086 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27087 example:
27088 .code
27089 deny    ...some conditions...
27090         delay = 30s
27091 .endd
27092 The delay happens if all the conditions are true, before the statement returns
27093 &"deny"&. Compare this with:
27094 .code
27095 deny    delay = 30s
27096         ...some conditions...
27097 .endd
27098 which waits for 30s before processing the conditions. The &%delay%& modifier
27099 can also be used with &%warn%& and together with &%control%&:
27100 .code
27101 warn    ...some conditions...
27102         delay = 2m
27103         control = freeze
27104 accept  ...
27105 .endd
27106
27107 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27108 responses to several commands are no longer buffered and sent in one packet (as
27109 they would normally be) because all output is flushed before imposing the
27110 delay. This optimization is disabled so that a number of small delays do not
27111 appear to the client as one large aggregated delay that might provoke an
27112 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27113 using a &%control%& modifier to set &%no_delay_flush%&.
27114
27115
27116 .vitem &*endpass*&
27117 .cindex "&%endpass%& ACL modifier"
27118 This modifier, which has no argument, is recognized only in &%accept%& and
27119 &%discard%& statements. It marks the boundary between the conditions whose
27120 failure causes control to pass to the next statement, and the conditions whose
27121 failure causes the ACL to return &"deny"&. This concept has proved to be
27122 confusing to some people, so the use of &%endpass%& is no longer recommended as
27123 &"best practice"&. See the description of &%accept%& above for more details.
27124
27125
27126 .vitem &*log_message*&&~=&~<&'text'&>
27127 .cindex "&%log_message%& ACL modifier"
27128 This modifier sets up a message that is used as part of the log message if the
27129 ACL denies access or a &%warn%& statement's conditions are true. For example:
27130 .code
27131 require log_message = wrong cipher suite $tls_in_cipher
27132         encrypted   = DES-CBC3-SHA
27133 .endd
27134 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27135 example:
27136 .display
27137 &`discard `&<&'some conditions'&>
27138 &`        log_message = Discarded $local_part@$domain because...`&
27139 .endd
27140 When access is denied, &%log_message%& adds to any underlying error message
27141 that may exist because of a condition failure. For example, while verifying a
27142 recipient address, a &':fail:'& redirection might have already set up a
27143 message.
27144
27145 The message may be defined before the conditions to which it applies, because
27146 the string expansion does not happen until Exim decides that access is to be
27147 denied. This means that any variables that are set by the condition are
27148 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27149 variables are set after a DNS black list lookup succeeds. If the expansion of
27150 &%log_message%& fails, or if the result is an empty string, the modifier is
27151 ignored.
27152
27153 .vindex "&$acl_verify_message$&"
27154 If you want to use a &%warn%& statement to log the result of an address
27155 verification, you can use &$acl_verify_message$& to include the verification
27156 error message.
27157
27158 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27159 the start of the logged message. If the same warning log message is requested
27160 more than once while receiving  a single email message, only one copy is
27161 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27162 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27163 is logged for a successful &%warn%& statement.
27164
27165 If &%log_message%& is not present and there is no underlying error message (for
27166 example, from the failure of address verification), but &%message%& is present,
27167 the &%message%& text is used for logging rejections. However, if any text for
27168 logging contains newlines, only the first line is logged. In the absence of
27169 both &%log_message%& and &%message%&, a default built-in message is used for
27170 logging rejections.
27171
27172
27173 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27174 .cindex "&%log_reject_target%& ACL modifier"
27175 .cindex "logging in ACL" "specifying which log"
27176 This modifier makes it possible to specify which logs are used for messages
27177 about ACL rejections. Its argument is a colon-separated list of words that can
27178 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27179 may be empty, in which case a rejection is not logged at all. For example, this
27180 ACL fragment writes no logging information when access is denied:
27181 .display
27182 &`deny `&<&'some conditions'&>
27183 &`     log_reject_target =`&
27184 .endd
27185 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27186 permanent and temporary rejections. Its effect lasts for the rest of the
27187 current ACL.
27188
27189
27190 .vitem &*logwrite*&&~=&~<&'text'&>
27191 .cindex "&%logwrite%& ACL modifier"
27192 .cindex "logging in ACL" "immediate"
27193 This modifier writes a message to a log file as soon as it is encountered when
27194 processing an ACL. (Compare &%log_message%&, which, except in the case of
27195 &%warn%& and &%discard%&, is used only if the ACL statement denies
27196 access.) The &%logwrite%& modifier can be used to log special incidents in
27197 ACLs. For example:
27198 .display
27199 &`accept `&<&'some special conditions'&>
27200 &`       control  = freeze`&
27201 &`       logwrite = froze message because ...`&
27202 .endd
27203 By default, the message is written to the main log. However, it may begin
27204 with a colon, followed by a comma-separated list of log names, and then
27205 another colon, to specify exactly which logs are to be written. For
27206 example:
27207 .code
27208 logwrite = :main,reject: text for main and reject logs
27209 logwrite = :panic: text for panic log only
27210 .endd
27211
27212
27213 .vitem &*message*&&~=&~<&'text'&>
27214 .cindex "&%message%& ACL modifier"
27215 This modifier sets up a text string that is expanded and used as a response
27216 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27217 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27218 there is some complication if &%endpass%& is involved; see the description of
27219 &%accept%& for details.)
27220
27221 The expansion of the message happens at the time Exim decides that the ACL is
27222 to end, not at the time it processes &%message%&. If the expansion fails, or
27223 generates an empty string, the modifier is ignored. Here is an example where
27224 &%message%& must be specified first, because the ACL ends with a rejection if
27225 the &%hosts%& condition fails:
27226 .code
27227 require  message = Host not recognized
27228          hosts = 10.0.0.0/8
27229 .endd
27230 (Once a condition has failed, no further conditions or modifiers are
27231 processed.)
27232
27233 .cindex "SMTP" "error codes"
27234 .oindex "&%smtp_banner%&
27235 For ACLs that are triggered by SMTP commands, the message is returned as part
27236 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27237 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27238 is accepted. In the case of the connect ACL, accepting with a message modifier
27239 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27240 accept message may not contain more than one line (otherwise it will be
27241 truncated at the first newline and a panic logged), and it cannot affect the
27242 EHLO options.
27243
27244 When SMTP is involved, the message may begin with an overriding response code,
27245 consisting of three digits optionally followed by an &"extended response code"&
27246 of the form &'n.n.n'&, each code being followed by a space. For example:
27247 .code
27248 deny  message = 599 1.2.3 Host not welcome
27249       hosts = 192.168.34.0/24
27250 .endd
27251 The first digit of the supplied response code must be the same as would be sent
27252 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27253 access, but for the predata ACL, note that the default success code is 354, not
27254 2&'xx'&.
27255
27256 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27257 the message modifier cannot override the 221 response code.
27258
27259 The text in a &%message%& modifier is literal; any quotes are taken as
27260 literals, but because the string is expanded, backslash escapes are processed
27261 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27262 response.
27263
27264 .vindex "&$acl_verify_message$&"
27265 If &%message%& is used on a statement that verifies an address, the message
27266 specified overrides any message that is generated by the verification process.
27267 However, the original message is available in the variable
27268 &$acl_verify_message$&, so you can incorporate it into your message if you
27269 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27270 routers to be passed back as part of the SMTP response, you should either not
27271 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27272
27273 For compatibility with previous releases of Exim, a &%message%& modifier that
27274 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27275 modifier, but this usage is now deprecated. However, &%message%& acts only when
27276 all the conditions are true, wherever it appears in an ACL command, whereas
27277 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27278 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27279 effect.
27280
27281
27282 .new
27283 .vitem &*remove_header*&&~=&~<&'text'&>
27284 This modifier specifies one or more header names in a colon-separated list
27285  that are to be removed from an incoming message, assuming, of course, that
27286 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27287 .wen
27288
27289
27290 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27291 .cindex "&%set%& ACL modifier"
27292 This modifier puts a value into one of the ACL variables (see section
27293 &<<SECTaclvariables>>&).
27294
27295
27296 .new
27297 .vitem &*udpsend*&&~=&~<&'parameters'&>
27298 This modifier sends a UDP packet, for purposes such as statistics
27299 collection or behaviour monitoring. The parameters are expanded, and
27300 the result of the expansion must be a colon-separated list consisting
27301 of a destination server, port number, and the packet contents. The
27302 server can be specified as a host name or IPv4 or IPv6 address. The
27303 separator can be changed with the usual angle bracket syntax. For
27304 example, you might want to collect information on which hosts connect
27305 when:
27306 .code
27307 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27308              $tod_zulu $sender_host_address
27309 .endd
27310 .wen
27311 .endlist
27312
27313
27314
27315
27316 .section "Use of the control modifier" "SECTcontrols"
27317 .cindex "&%control%& ACL modifier"
27318 The &%control%& modifier supports the following settings:
27319
27320 .vlist
27321 .vitem &*control&~=&~allow_auth_unadvertised*&
27322 This modifier allows a client host to use the SMTP AUTH command even when it
27323 has not been advertised in response to EHLO. Furthermore, because there are
27324 apparently some really broken clients that do this, Exim will accept AUTH after
27325 HELO (rather than EHLO) when this control is set. It should be used only if you
27326 really need it, and you should limit its use to those broken clients that do
27327 not work without it. For example:
27328 .code
27329 warn hosts   = 192.168.34.25
27330      control = allow_auth_unadvertised
27331 .endd
27332 Normally, when an Exim server receives an AUTH command, it checks the name of
27333 the authentication mechanism that is given in the command to ensure that it
27334 matches an advertised mechanism. When this control is set, the check that a
27335 mechanism has been advertised is bypassed. Any configured mechanism can be used
27336 by the client. This control is permitted only in the connection and HELO ACLs.
27337
27338
27339 .vitem &*control&~=&~caseful_local_part*& &&&
27340        &*control&~=&~caselower_local_part*&
27341 .cindex "&ACL;" "case of local part in"
27342 .cindex "case of local parts"
27343 .vindex "&$local_part$&"
27344 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27345 (that is, during RCPT processing). By default, the contents of &$local_part$&
27346 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27347 any uppercase letters in the original local part are restored in &$local_part$&
27348 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27349 is encountered.
27350
27351 These controls affect only the current recipient. Moreover, they apply only to
27352 local part handling that takes place directly in the ACL (for example, as a key
27353 in lookups). If a test to verify the recipient is obeyed, the case-related
27354 handling of the local part during the verification is controlled by the router
27355 configuration (see the &%caseful_local_part%& generic router option).
27356
27357 This facility could be used, for example, to add a spam score to local parts
27358 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27359 spam score:
27360 .code
27361 warn  control = caseful_local_part
27362       set acl_m4 = ${eval:\
27363                      $acl_m4 + \
27364                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27365                     }
27366       control = caselower_local_part
27367 .endd
27368 Notice that we put back the lower cased version afterwards, assuming that
27369 is what is wanted for subsequent tests.
27370
27371
27372 .new
27373 .vitem &*control&~=&~cutthrough_delivery*&
27374 .cindex "&ACL;" "cutthrough routing"
27375 .cindex "cutthrough" "requesting"
27376 This option requests delivery be attempted while the item is being received.
27377 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27378 from one SMTP connection to another.  If a recipient-verify callout connection is
27379 requested in the same ACL it is held open and used for the data, otherwise one is made
27380 after the ACL completes.
27381 .new "Note that routers are used in verify mode."
27382
27383 Should the ultimate destination system positively accept or reject the mail,
27384 a corresponding indication is given to the source system and nothing is queued.
27385 If there is a temporary error the item is queued for later delivery in the
27386 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27387 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27388 line.
27389
27390 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27391 sender when the destination system is doing content-scan based rejection.
27392 .wen
27393
27394
27395 .new
27396 .vitem &*control&~=&~debug/*&<&'options'&>
27397 .cindex "&ACL;" "enabling debug logging"
27398 .cindex "debugging" "enabling from an ACL"
27399 This control turns on debug logging, almost as though Exim had been invoked
27400 with &`-d`&, with the output going to a new logfile, by default called
27401 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27402 may access any variables already defined.  The logging may be adjusted with
27403 the &'opts'& option, which takes the same values as the &`-d`& command-line
27404 option.  Some examples (which depend on variables that don't exist in all
27405 contexts):
27406 .code
27407       control = debug
27408       control = debug/tag=.$sender_host_address
27409       control = debug/opts=+expand+acl
27410       control = debug/tag=.$message_exim_id/opts=+expand
27411 .endd
27412 .wen
27413
27414
27415 .vitem &*control&~=&~dkim_disable_verify*&
27416 .cindex "disable DKIM verify"
27417 .cindex "DKIM" "disable verify"
27418 This control turns off DKIM verification processing entirely.  For details on
27419 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27420
27421
27422 .new
27423 .vitem &*control&~=&~dscp/*&<&'value'&>
27424 .cindex "&ACL;" "setting DSCP value"
27425 .cindex "DSCP" "inbound"
27426 This option causes the DSCP value associated with the socket for the inbound
27427 connection to be adjusted to a given value, given as one of a number of fixed
27428 strings or to numeric value.
27429 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27430 Common values include &`throughput`&, &`mincost`&, and on newer systems
27431 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27432
27433 The outbound packets from Exim will be marked with this value in the header
27434 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27435 that these values will have any effect, not be stripped by networking
27436 equipment, or do much of anything without cooperation with your Network
27437 Engineer and those of all network operators between the source and destination.
27438 .wen
27439
27440
27441 .vitem &*control&~=&~enforce_sync*& &&&
27442        &*control&~=&~no_enforce_sync*&
27443 .cindex "SMTP" "synchronization checking"
27444 .cindex "synchronization checking in SMTP"
27445 These controls make it possible to be selective about when SMTP synchronization
27446 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27447 state of the switch (it is true by default). See the description of this option
27448 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27449
27450 The effect of these two controls lasts for the remainder of the SMTP
27451 connection. They can appear in any ACL except the one for the non-SMTP
27452 messages. The most straightforward place to put them is in the ACL defined by
27453 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27454 before the first synchronization check. The expected use is to turn off the
27455 synchronization checks for badly-behaved hosts that you nevertheless need to
27456 work with.
27457
27458
27459 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27460 .cindex "fake defer"
27461 .cindex "defer, fake"
27462 This control works in exactly the same way as &%fakereject%& (described below)
27463 except that it causes an SMTP 450 response after the message data instead of a
27464 550 response. You must take care when using &%fakedefer%& because it causes the
27465 messages to be duplicated when the sender retries. Therefore, you should not
27466 use &%fakedefer%& if the message is to be delivered normally.
27467
27468 .vitem &*control&~=&~fakereject/*&<&'message'&>
27469 .cindex "fake rejection"
27470 .cindex "rejection, fake"
27471 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27472 words, only when an SMTP message is being received. If Exim accepts the
27473 message, instead the final 250 response, a 550 rejection message is sent.
27474 However, Exim proceeds to deliver the message as normal. The control applies
27475 only to the current message, not to any subsequent ones that may be received in
27476 the same SMTP connection.
27477
27478 The text for the 550 response is taken from the &%control%& modifier. If no
27479 message is supplied, the following is used:
27480 .code
27481 550-Your message has been rejected but is being
27482 550-kept for evaluation.
27483 550-If it was a legitimate message, it may still be
27484 550 delivered to the target recipient(s).
27485 .endd
27486 This facility should be used with extreme caution.
27487
27488 .vitem &*control&~=&~freeze*&
27489 .cindex "frozen messages" "forcing in ACL"
27490 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27491 other words, only when a message is being received. If the message is accepted,
27492 it is placed on Exim's queue and frozen. The control applies only to the
27493 current message, not to any subsequent ones that may be received in the same
27494 SMTP connection.
27495
27496 This modifier can optionally be followed by &`/no_tell`&. If the global option
27497 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27498 is told about the freezing), provided all the &*control=freeze*& modifiers that
27499 are obeyed for the current message have the &`/no_tell`& option.
27500
27501 .vitem &*control&~=&~no_delay_flush*&
27502 .cindex "SMTP" "output flushing, disabling for delay"
27503 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27504 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27505 use. This control, as long as it is encountered before the &%delay%& modifier,
27506 disables such output flushing.
27507
27508 .vitem &*control&~=&~no_callout_flush*&
27509 .cindex "SMTP" "output flushing, disabling for callout"
27510 Exim normally flushes SMTP output before performing a callout in an ACL, to
27511 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27512 use. This control, as long as it is encountered before the &%verify%& condition
27513 that causes the callout, disables such output flushing.
27514
27515 .vitem &*control&~=&~no_mbox_unspool*&
27516 This control is available when Exim is compiled with the content scanning
27517 extension. Content scanning may require a copy of the current message, or parts
27518 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27519 or spam scanner. Normally, such copies are deleted when they are no longer
27520 needed. If this control is set, the copies are not deleted. The control applies
27521 only to the current message, not to any subsequent ones that may be received in
27522 the same SMTP connection. It is provided for debugging purposes and is unlikely
27523 to be useful in production.
27524
27525 .vitem &*control&~=&~no_multiline_responses*&
27526 .cindex "multiline responses, suppressing"
27527 This control is permitted for any ACL except the one for non-SMTP messages.
27528 It seems that there are broken clients in use that cannot handle multiline
27529 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27530
27531 If this control is set, multiline SMTP responses from ACL rejections are
27532 suppressed. One way of doing this would have been to put out these responses as
27533 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27534 (&"use multiline responses for more"& it says &-- ha!), and some of the
27535 responses might get close to that. So this facility, which is after all only a
27536 sop to broken clients, is implemented by doing two very easy things:
27537
27538 .ilist
27539 Extra information that is normally output as part of a rejection caused by
27540 sender verification failure is omitted. Only the final line (typically &"sender
27541 verification failed"&) is sent.
27542 .next
27543 If a &%message%& modifier supplies a multiline response, only the first
27544 line is output.
27545 .endlist
27546
27547 The setting of the switch can, of course, be made conditional on the
27548 calling host. Its effect lasts until the end of the SMTP connection.
27549
27550 .vitem &*control&~=&~no_pipelining*&
27551 .cindex "PIPELINING" "suppressing advertising"
27552 This control turns off the advertising of the PIPELINING extension to SMTP in
27553 the current session. To be useful, it must be obeyed before Exim sends its
27554 response to an EHLO command. Therefore, it should normally appear in an ACL
27555 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27556 &%pipelining_advertise_hosts%&.
27557
27558 .vitem &*control&~=&~queue_only*&
27559 .oindex "&%queue_only%&"
27560 .cindex "queueing incoming messages"
27561 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27562 other words, only when a message is being received. If the message is accepted,
27563 it is placed on Exim's queue and left there for delivery by a subsequent queue
27564 runner. No immediate delivery process is started. In other words, it has the
27565 effect as the &%queue_only%& global option. However, the control applies only
27566 to the current message, not to any subsequent ones that may be received in the
27567 same SMTP connection.
27568
27569 .vitem &*control&~=&~submission/*&<&'options'&>
27570 .cindex "message" "submission"
27571 .cindex "submission mode"
27572 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27573 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27574 the current message is a submission from a local MUA. In this case, Exim
27575 operates in &"submission mode"&, and applies certain fixups to the message if
27576 necessary. For example, it adds a &'Date:'& header line if one is not present.
27577 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27578 late (the message has already been created).
27579
27580 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27581 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27582 submission mode; the available options for this control are described there.
27583 The control applies only to the current message, not to any subsequent ones
27584 that may be received in the same SMTP connection.
27585
27586 .vitem &*control&~=&~suppress_local_fixups*&
27587 .cindex "submission fixups, suppressing"
27588 This control applies to locally submitted (non TCP/IP) messages, and is the
27589 complement of &`control = submission`&. It disables the fixups that are
27590 normally applied to locally-submitted messages. Specifically:
27591
27592 .ilist
27593 Any &'Sender:'& header line is left alone (in this respect, it is a
27594 dynamic version of &%local_sender_retain%&).
27595 .next
27596 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27597 .next
27598 There is no check that &'From:'& corresponds to the actual sender.
27599 .endlist ilist
27600
27601 This control may be useful when a remotely-originated message is accepted,
27602 passed to some scanning program, and then re-submitted for delivery. It can be
27603 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27604 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27605 data is read.
27606
27607 &*Note:*& This control applies only to the current message, not to any others
27608 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27609 .endlist vlist
27610
27611
27612 .section "Summary of message fixup control" "SECTsummesfix"
27613 All four possibilities for message fixups can be specified:
27614
27615 .ilist
27616 Locally submitted, fixups applied: the default.
27617 .next
27618 Locally submitted, no fixups applied: use
27619 &`control = suppress_local_fixups`&.
27620 .next
27621 Remotely submitted, no fixups applied: the default.
27622 .next
27623 Remotely submitted, fixups applied: use &`control = submission`&.
27624 .endlist
27625
27626
27627
27628 .section "Adding header lines in ACLs" "SECTaddheadacl"
27629 .cindex "header lines" "adding in an ACL"
27630 .cindex "header lines" "position of added lines"
27631 .cindex "&%add_header%& ACL modifier"
27632 The &%add_header%& modifier can be used to add one or more extra header lines
27633 to an incoming message, as in this example:
27634 .code
27635 warn dnslists = sbl.spamhaus.org : \
27636                 dialup.mail-abuse.org
27637      add_header = X-blacklisted-at: $dnslist_domain
27638 .endd
27639 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27640 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27641 receiving a message). The message must ultimately be accepted for
27642 &%add_header%& to have any significant effect. You can use &%add_header%& with
27643 any ACL verb, including &%deny%& (though this is potentially useful only in a
27644 RCPT ACL).
27645
27646 Leading and trailing newlines are removed from
27647 the data for the &%add_header%& modifier; if it then
27648 contains one or more newlines that
27649 are not followed by a space or a tab, it is assumed to contain multiple header
27650 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27651 front of any line that is not a valid header line.
27652
27653 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27654 They are added to the message before processing the DATA and MIME ACLs.
27655 However, if an identical header line is requested more than once, only one copy
27656 is actually added to the message. Further header lines may be accumulated
27657 during the DATA and MIME ACLs, after which they are added to the message, again
27658 with duplicates suppressed. Thus, it is possible to add two identical header
27659 lines to an SMTP message, but only if one is added before DATA and one after.
27660 In the case of non-SMTP messages, new headers are accumulated during the
27661 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27662 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27663 are included in the entry that is written to the reject log.
27664
27665 .cindex "header lines" "added; visibility of"
27666 Header lines are not visible in string expansions
27667 of message headers
27668 until they are added to the
27669 message. It follows that header lines defined in the MAIL, RCPT, and predata
27670 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27671 header lines that are added by the DATA or MIME ACLs are not visible in those
27672 ACLs. Because of this restriction, you cannot use header lines as a way of
27673 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27674 this, you can use ACL variables, as described in section
27675 &<<SECTaclvariables>>&.
27676
27677 .new
27678 The list of headers yet to be added is given by the &%$headers_added%& variable.
27679 .wen
27680
27681 The &%add_header%& modifier acts immediately as it is encountered during the
27682 processing of an ACL. Notice the difference between these two cases:
27683 .display
27684 &`accept add_header = ADDED: some text`&
27685 &`       `&<&'some condition'&>
27686
27687 &`accept `&<&'some condition'&>
27688 &`       add_header = ADDED: some text`&
27689 .endd
27690 In the first case, the header line is always added, whether or not the
27691 condition is true. In the second case, the header line is added only if the
27692 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27693 ACL statement. All those that are encountered before a condition fails are
27694 honoured.
27695
27696 .cindex "&%warn%& ACL verb"
27697 For compatibility with previous versions of Exim, a &%message%& modifier for a
27698 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27699 effect only if all the conditions are true, even if it appears before some of
27700 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27701 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27702 are present on a &%warn%& verb, both are processed according to their
27703 specifications.
27704
27705 By default, new header lines are added to a message at the end of the existing
27706 header lines. However, you can specify that any particular header line should
27707 be added right at the start (before all the &'Received:'& lines), immediately
27708 after the first block of &'Received:'& lines, or immediately before any line
27709 that is not a &'Received:'& or &'Resent-something:'& header.
27710
27711 This is done by specifying &":at_start:"&, &":after_received:"&, or
27712 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27713 header line, respectively. (Header text cannot start with a colon, as there has
27714 to be a header name first.) For example:
27715 .code
27716 warn add_header = \
27717        :after_received:X-My-Header: something or other...
27718 .endd
27719 If more than one header line is supplied in a single &%add_header%& modifier,
27720 each one is treated independently and can therefore be placed differently. If
27721 you add more than one line at the start, or after the Received: block, they end
27722 up in reverse order.
27723
27724 &*Warning*&: This facility currently applies only to header lines that are
27725 added in an ACL. It does NOT work for header lines that are added in a
27726 system filter or in a router or transport.
27727
27728
27729
27730 .new
27731 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27732 .cindex "header lines" "removing in an ACL"
27733 .cindex "header lines" "position of removed lines"
27734 .cindex "&%remove_header%& ACL modifier"
27735 The &%remove_header%& modifier can be used to remove one or more header lines
27736 from an incoming message, as in this example:
27737 .code
27738 warn   message        = Remove internal headers
27739        remove_header  = x-route-mail1 : x-route-mail2
27740 .endd
27741 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27742 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27743 receiving a message). The message must ultimately be accepted for
27744 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27745 with any ACL verb, including &%deny%&, though this is really not useful for
27746 any verb that doesn't result in a delivered message.
27747
27748 More than one header can be removed at the same time by using a colon separated
27749 list of header names. The header matching is case insensitive. Wildcards are
27750 not permitted, nor is list expansion performed, so you cannot use hostlists to
27751 create a list of headers, however both connection and message variable expansion
27752 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27753 .code
27754 warn   hosts           = +internal_hosts
27755        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27756 warn   message         = Remove internal headers
27757        remove_header   = $acl_c_ihdrs
27758 .endd
27759 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27760 They are removed from the message before processing the DATA and MIME ACLs.
27761 There is no harm in attempting to remove the same header twice nor is removing
27762 a non-existent header. Further header lines to be removed may be accumulated
27763 during the DATA and MIME ACLs, after which they are removed from the message,
27764 if present. In the case of non-SMTP messages, headers to be removed are
27765 accumulated during the non-SMTP ACLs, and are removed from the message after
27766 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27767 ACL, there really is no effect because there is no logging of what headers
27768 would have been removed.
27769
27770 .cindex "header lines" "removed; visibility of"
27771 Header lines are not visible in string expansions until the DATA phase when it
27772 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27773 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27774 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27775 this restriction, you cannot use header lines as a way of controlling data
27776 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27777 you should instead use ACL variables, as described in section
27778 &<<SECTaclvariables>>&.
27779
27780 The &%remove_header%& modifier acts immediately as it is encountered during the
27781 processing of an ACL. Notice the difference between these two cases:
27782 .display
27783 &`accept remove_header = X-Internal`&
27784 &`       `&<&'some condition'&>
27785
27786 &`accept `&<&'some condition'&>
27787 &`       remove_header = X-Internal`&
27788 .endd
27789 In the first case, the header line is always removed, whether or not the
27790 condition is true. In the second case, the header line is removed only if the
27791 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27792 same ACL statement. All those that are encountered before a condition fails
27793 are honoured.
27794
27795 &*Warning*&: This facility currently applies only to header lines that are
27796 present during ACL processing. It does NOT remove header lines that are added
27797 in a system filter or in a router or transport.
27798 .wen
27799
27800
27801
27802
27803 .section "ACL conditions" "SECTaclconditions"
27804 .cindex "&ACL;" "conditions; list of"
27805 Some of the conditions listed in this section are available only when Exim is
27806 compiled with the content-scanning extension. They are included here briefly
27807 for completeness. More detailed descriptions can be found in the discussion on
27808 content scanning in chapter &<<CHAPexiscan>>&.
27809
27810 Not all conditions are relevant in all circumstances. For example, testing
27811 senders and recipients does not make sense in an ACL that is being run as the
27812 result of the arrival of an ETRN command, and checks on message headers can be
27813 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27814 can use the same condition (with different parameters) more than once in the
27815 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27816 The conditions are as follows:
27817
27818
27819 .vlist
27820 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27821 .cindex "&ACL;" "nested"
27822 .cindex "&ACL;" "indirect"
27823 .cindex "&ACL;" "arguments"
27824 .cindex "&%acl%& ACL condition"
27825 The possible values of the argument are the same as for the
27826 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27827 &"accept"& the condition is true; if it returns &"deny"& the condition is
27828 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27829 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27830 condition false. This means that further processing of the &%warn%& verb
27831 ceases, but processing of the ACL continues.
27832
27833 .new
27834 If the argument is a named ACL, up to nine space-separated optional values
27835 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27836 and $acl_narg is set to the count of values.
27837 Previous values of these variables are restored after the call returns.
27838 The name and values are expanded separately.
27839 .wen
27840
27841 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27842 the connection is dropped. If it returns &"discard"&, the verb must be
27843 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27844 conditions are tested.
27845
27846 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27847 loops. This condition allows you to use different ACLs in different
27848 circumstances. For example, different ACLs can be used to handle RCPT commands
27849 for different local users or different local domains.
27850
27851 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27852 .cindex "&%authenticated%& ACL condition"
27853 .cindex "authentication" "ACL checking"
27854 .cindex "&ACL;" "testing for authentication"
27855 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27856 the name of the authenticator is tested against the list. To test for
27857 authentication by any authenticator, you can set
27858 .code
27859 authenticated = *
27860 .endd
27861
27862 .vitem &*condition&~=&~*&<&'string'&>
27863 .cindex "&%condition%& ACL condition"
27864 .cindex "customizing" "ACL condition"
27865 .cindex "&ACL;" "customized test"
27866 .cindex "&ACL;" "testing, customized"
27867 This feature allows you to make up custom conditions. If the result of
27868 expanding the string is an empty string, the number zero, or one of the strings
27869 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27870 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27871 any other value, some error is assumed to have occurred, and the ACL returns
27872 &"defer"&. However, if the expansion is forced to fail, the condition is
27873 ignored. The effect is to treat it as true, whether it is positive or
27874 negative.
27875
27876 .vitem &*decode&~=&~*&<&'location'&>
27877 .cindex "&%decode%& ACL condition"
27878 This condition is available only when Exim is compiled with the
27879 content-scanning extension, and it is allowed only in the ACL defined by
27880 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27881 If all goes well, the condition is true. It is false only if there are
27882 problems such as a syntax error or a memory shortage. For more details, see
27883 chapter &<<CHAPexiscan>>&.
27884
27885 .vitem &*demime&~=&~*&<&'extension&~list'&>
27886 .cindex "&%demime%& ACL condition"
27887 This condition is available only when Exim is compiled with the
27888 content-scanning extension. Its use is described in section
27889 &<<SECTdemimecond>>&.
27890
27891 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27892 .cindex "&%dnslists%& ACL condition"
27893 .cindex "DNS list" "in ACL"
27894 .cindex "black list (DNS)"
27895 .cindex "&ACL;" "testing a DNS list"
27896 This condition checks for entries in DNS black lists. These are also known as
27897 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27898 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27899 different variants of this condition to describe briefly here. See sections
27900 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27901
27902 .vitem &*domains&~=&~*&<&'domain&~list'&>
27903 .cindex "&%domains%& ACL condition"
27904 .cindex "domain" "ACL checking"
27905 .cindex "&ACL;" "testing a recipient domain"
27906 .vindex "&$domain_data$&"
27907 This condition is relevant only after a RCPT command. It checks that the domain
27908 of the recipient address is in the domain list. If percent-hack processing is
27909 enabled, it is done before this test is done. If the check succeeds with a
27910 lookup, the result of the lookup is placed in &$domain_data$& until the next
27911 &%domains%& test.
27912
27913 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27914 use &%domains%& in a DATA ACL.
27915
27916
27917 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27918 .cindex "&%encrypted%& ACL condition"
27919 .cindex "encryption" "checking in an ACL"
27920 .cindex "&ACL;" "testing for encryption"
27921 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27922 name of the cipher suite in use is tested against the list. To test for
27923 encryption without testing for any specific cipher suite(s), set
27924 .code
27925 encrypted = *
27926 .endd
27927
27928
27929 .vitem &*hosts&~=&~*&<&'host&~list'&>
27930 .cindex "&%hosts%& ACL condition"
27931 .cindex "host" "ACL checking"
27932 .cindex "&ACL;" "testing the client host"
27933 This condition tests that the calling host matches the host list. If you have
27934 name lookups or wildcarded host names and IP addresses in the same host list,
27935 you should normally put the IP addresses first. For example, you could have:
27936 .code
27937 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27938 .endd
27939 The lookup in this example uses the host name for its key. This is implied by
27940 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27941 and it wouldn't matter which way round you had these two items.)
27942
27943 The reason for the problem with host names lies in the left-to-right way that
27944 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27945 but when it reaches an item that requires a host name, it fails if it cannot
27946 find a host name to compare with the pattern. If the above list is given in the
27947 opposite order, the &%accept%& statement fails for a host whose name cannot be
27948 found, even if its IP address is 10.9.8.7.
27949
27950 If you really do want to do the name check first, and still recognize the IP
27951 address even if the name lookup fails, you can rewrite the ACL like this:
27952 .code
27953 accept hosts = dbm;/etc/friendly/hosts
27954 accept hosts = 10.9.8.7
27955 .endd
27956 The default action on failing to find the host name is to assume that the host
27957 is not in the list, so the first &%accept%& statement fails. The second
27958 statement can then check the IP address.
27959
27960 .vindex "&$host_data$&"
27961 If a &%hosts%& condition is satisfied by means of a lookup, the result
27962 of the lookup is made available in the &$host_data$& variable. This
27963 allows you, for example, to set up a statement like this:
27964 .code
27965 deny  hosts = net-lsearch;/some/file
27966 message = $host_data
27967 .endd
27968 which gives a custom error message for each denied host.
27969
27970 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27971 .cindex "&%local_parts%& ACL condition"
27972 .cindex "local part" "ACL checking"
27973 .cindex "&ACL;" "testing a local part"
27974 .vindex "&$local_part_data$&"
27975 This condition is relevant only after a RCPT command. It checks that the local
27976 part of the recipient address is in the list. If percent-hack processing is
27977 enabled, it is done before this test. If the check succeeds with a lookup, the
27978 result of the lookup is placed in &$local_part_data$&, which remains set until
27979 the next &%local_parts%& test.
27980
27981 .vitem &*malware&~=&~*&<&'option'&>
27982 .cindex "&%malware%& ACL condition"
27983 .cindex "&ACL;" "virus scanning"
27984 .cindex "&ACL;" "scanning for viruses"
27985 This condition is available only when Exim is compiled with the
27986 content-scanning extension. It causes the incoming message to be scanned for
27987 viruses. For details, see chapter &<<CHAPexiscan>>&.
27988
27989 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27990 .cindex "&%mime_regex%& ACL condition"
27991 .cindex "&ACL;" "testing by regex matching"
27992 This condition is available only when Exim is compiled with the
27993 content-scanning extension, and it is allowed only in the ACL defined by
27994 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27995 with any of the regular expressions. For details, see chapter
27996 &<<CHAPexiscan>>&.
27997
27998 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27999 .cindex "rate limiting"
28000 This condition can be used to limit the rate at which a user or host submits
28001 messages. Details are given in section &<<SECTratelimiting>>&.
28002
28003 .vitem &*recipients&~=&~*&<&'address&~list'&>
28004 .cindex "&%recipients%& ACL condition"
28005 .cindex "recipient" "ACL checking"
28006 .cindex "&ACL;" "testing a recipient"
28007 This condition is relevant only after a RCPT command. It checks the entire
28008 recipient address against a list of recipients.
28009
28010 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28011 .cindex "&%regex%& ACL condition"
28012 .cindex "&ACL;" "testing by regex matching"
28013 This condition is available only when Exim is compiled with the
28014 content-scanning extension, and is available only in the DATA, MIME, and
28015 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28016 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28017
28018 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28019 .cindex "&%sender_domains%& ACL condition"
28020 .cindex "sender" "ACL checking"
28021 .cindex "&ACL;" "testing a sender domain"
28022 .vindex "&$domain$&"
28023 .vindex "&$sender_address_domain$&"
28024 This condition tests the domain of the sender of the message against the given
28025 domain list. &*Note*&: The domain of the sender address is in
28026 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28027 of this condition. This is an exception to the general rule for testing domain
28028 lists. It is done this way so that, if this condition is used in an ACL for a
28029 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28030 influence the sender checking.
28031
28032 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28033 relaying, because sender addresses are easily, and commonly, forged.
28034
28035 .vitem &*senders&~=&~*&<&'address&~list'&>
28036 .cindex "&%senders%& ACL condition"
28037 .cindex "sender" "ACL checking"
28038 .cindex "&ACL;" "testing a sender"
28039 This condition tests the sender of the message against the given list. To test
28040 for a bounce message, which has an empty sender, set
28041 .code
28042 senders = :
28043 .endd
28044 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28045 relaying, because sender addresses are easily, and commonly, forged.
28046
28047 .vitem &*spam&~=&~*&<&'username'&>
28048 .cindex "&%spam%& ACL condition"
28049 .cindex "&ACL;" "scanning for spam"
28050 This condition is available only when Exim is compiled with the
28051 content-scanning extension. It causes the incoming message to be scanned by
28052 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28053
28054 .vitem &*verify&~=&~certificate*&
28055 .cindex "&%verify%& ACL condition"
28056 .cindex "TLS" "client certificate verification"
28057 .cindex "certificate" "verification of client"
28058 .cindex "&ACL;" "certificate verification"
28059 .cindex "&ACL;" "testing a TLS certificate"
28060 This condition is true in an SMTP session if the session is encrypted, and a
28061 certificate was received from the client, and the certificate was verified. The
28062 server requests a certificate only if the client matches &%tls_verify_hosts%&
28063 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28064
28065 .vitem &*verify&~=&~csa*&
28066 .cindex "CSA verification"
28067 This condition checks whether the sending host (the client) is authorized to
28068 send email. Details of how this works are given in section
28069 &<<SECTverifyCSA>>&.
28070
28071 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28072 .cindex "&%verify%& ACL condition"
28073 .cindex "&ACL;" "verifying sender in the header"
28074 .cindex "header lines" "verifying the sender in"
28075 .cindex "sender" "verifying in header"
28076 .cindex "verifying" "sender in header"
28077 This condition is relevant only in an ACL that is run after a message has been
28078 received, that is, in an ACL specified by &%acl_smtp_data%& or
28079 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28080 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28081 is loosely thought of as a &"sender"& address (hence the name of the test).
28082 However, an address that appears in one of these headers need not be an address
28083 that accepts bounce messages; only sender addresses in envelopes are required
28084 to accept bounces. Therefore, if you use the callout option on this check, you
28085 might want to arrange for a non-empty address in the MAIL command.
28086
28087 Details of address verification and the options are given later, starting at
28088 section &<<SECTaddressverification>>& (callouts are described in section
28089 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28090 condition to restrict it to bounce messages only:
28091 .code
28092 deny    senders = :
28093         message = A valid sender header is required for bounces
28094        !verify  = header_sender
28095 .endd
28096
28097 .vitem &*verify&~=&~header_syntax*&
28098 .cindex "&%verify%& ACL condition"
28099 .cindex "&ACL;" "verifying header syntax"
28100 .cindex "header lines" "verifying syntax"
28101 .cindex "verifying" "header syntax"
28102 This condition is relevant only in an ACL that is run after a message has been
28103 received, that is, in an ACL specified by &%acl_smtp_data%& or
28104 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28105 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28106 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28107 permitted only in locally generated messages and from hosts that match
28108 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28109 appropriate.
28110
28111 Note that this condition is a syntax check only. However, a common spamming
28112 ploy used to be to send syntactically invalid headers such as
28113 .code
28114 To: @
28115 .endd
28116 and this condition can be used to reject such messages, though they are not as
28117 common as they used to be.
28118
28119 .vitem &*verify&~=&~helo*&
28120 .cindex "&%verify%& ACL condition"
28121 .cindex "&ACL;" "verifying HELO/EHLO"
28122 .cindex "HELO" "verifying"
28123 .cindex "EHLO" "verifying"
28124 .cindex "verifying" "EHLO"
28125 .cindex "verifying" "HELO"
28126 This condition is true if a HELO or EHLO command has been received from the
28127 client host, and its contents have been verified. If there has been no previous
28128 attempt to verify the HELO/EHLO contents, it is carried out when this
28129 condition is encountered. See the description of the &%helo_verify_hosts%& and
28130 &%helo_try_verify_hosts%& options for details of how to request verification
28131 independently of this condition.
28132
28133 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28134 option), this condition is always true.
28135
28136
28137 .vitem &*verify&~=&~not_blind*&
28138 .cindex "verifying" "not blind"
28139 .cindex "bcc recipients, verifying none"
28140 This condition checks that there are no blind (bcc) recipients in the message.
28141 Every envelope recipient must appear either in a &'To:'& header line or in a
28142 &'Cc:'& header line for this condition to be true. Local parts are checked
28143 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28144 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28145 used only in a DATA or non-SMTP ACL.
28146
28147 There are, of course, many legitimate messages that make use of blind (bcc)
28148 recipients. This check should not be used on its own for blocking messages.
28149
28150
28151 .vitem &*verify&~=&~recipient/*&<&'options'&>
28152 .cindex "&%verify%& ACL condition"
28153 .cindex "&ACL;" "verifying recipient"
28154 .cindex "recipient" "verifying"
28155 .cindex "verifying" "recipient"
28156 .vindex "&$address_data$&"
28157 This condition is relevant only after a RCPT command. It verifies the current
28158 recipient. Details of address verification are given later, starting at section
28159 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28160 of &$address_data$& is the last value that was set while routing the address.
28161 This applies even if the verification fails. When an address that is being
28162 verified is redirected to a single address, verification continues with the new
28163 address, and in that case, the subsequent value of &$address_data$& is the
28164 value for the child address.
28165
28166 .vitem &*verify&~=&~reverse_host_lookup*&
28167 .cindex "&%verify%& ACL condition"
28168 .cindex "&ACL;" "verifying host reverse lookup"
28169 .cindex "host" "verifying reverse lookup"
28170 This condition ensures that a verified host name has been looked up from the IP
28171 address of the client host. (This may have happened already if the host name
28172 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28173 Verification ensures that the host name obtained from a reverse DNS lookup, or
28174 one of its aliases, does, when it is itself looked up in the DNS, yield the
28175 original IP address.
28176
28177 If this condition is used for a locally generated message (that is, when there
28178 is no client host involved), it always succeeds.
28179
28180 .vitem &*verify&~=&~sender/*&<&'options'&>
28181 .cindex "&%verify%& ACL condition"
28182 .cindex "&ACL;" "verifying sender"
28183 .cindex "sender" "verifying"
28184 .cindex "verifying" "sender"
28185 This condition is relevant only after a MAIL or RCPT command, or after a
28186 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28187 the message's sender is empty (that is, this is a bounce message), the
28188 condition is true. Otherwise, the sender address is verified.
28189
28190 .vindex "&$address_data$&"
28191 .vindex "&$sender_address_data$&"
28192 If there is data in the &$address_data$& variable at the end of routing, its
28193 value is placed in &$sender_address_data$& at the end of verification. This
28194 value can be used in subsequent conditions and modifiers in the same ACL
28195 statement. It does not persist after the end of the current statement. If you
28196 want to preserve the value for longer, you can save it in an ACL variable.
28197
28198 Details of verification are given later, starting at section
28199 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28200 to avoid doing it more than once per message.
28201
28202 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28203 .cindex "&%verify%& ACL condition"
28204 This is a variation of the previous option, in which a modified address is
28205 verified as a sender.
28206 .endlist
28207
28208
28209
28210 .section "Using DNS lists" "SECTmorednslists"
28211 .cindex "DNS list" "in ACL"
28212 .cindex "black list (DNS)"
28213 .cindex "&ACL;" "testing a DNS list"
28214 In its simplest form, the &%dnslists%& condition tests whether the calling host
28215 is on at least one of a number of DNS lists by looking up the inverted IP
28216 address in one or more DNS domains. (Note that DNS list domains are not mail
28217 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28218 special options instead.) For example, if the calling host's IP
28219 address is 192.168.62.43, and the ACL statement is
28220 .code
28221 deny dnslists = blackholes.mail-abuse.org : \
28222                 dialups.mail-abuse.org
28223 .endd
28224 the following records are looked up:
28225 .code
28226 43.62.168.192.blackholes.mail-abuse.org
28227 43.62.168.192.dialups.mail-abuse.org
28228 .endd
28229 As soon as Exim finds an existing DNS record, processing of the list stops.
28230 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28231 to test that a host is on more than one list (an &"and"& conjunction), you can
28232 use two separate conditions:
28233 .code
28234 deny dnslists = blackholes.mail-abuse.org
28235      dnslists = dialups.mail-abuse.org
28236 .endd
28237 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28238 behaves as if the host does not match the list item, that is, as if the DNS
28239 record does not exist. If there are further items in the DNS list, they are
28240 processed.
28241
28242 This is usually the required action when &%dnslists%& is used with &%deny%&
28243 (which is the most common usage), because it prevents a DNS failure from
28244 blocking mail. However, you can change this behaviour by putting one of the
28245 following special items in the list:
28246 .display
28247 &`+include_unknown `&   behave as if the item is on the list
28248 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28249 &`+defer_unknown   `&   give a temporary error
28250 .endd
28251 .cindex "&`+include_unknown`&"
28252 .cindex "&`+exclude_unknown`&"
28253 .cindex "&`+defer_unknown`&"
28254 Each of these applies to any subsequent items on the list. For example:
28255 .code
28256 deny dnslists = +defer_unknown : foo.bar.example
28257 .endd
28258 Testing the list of domains stops as soon as a match is found. If you want to
28259 warn for one list and block for another, you can use two different statements:
28260 .code
28261 deny  dnslists = blackholes.mail-abuse.org
28262 warn  message  = X-Warn: sending host is on dialups list
28263       dnslists = dialups.mail-abuse.org
28264 .endd
28265 DNS list lookups are cached by Exim for the duration of the SMTP session,
28266 so a lookup based on the IP address is done at most once for any incoming
28267 connection. Exim does not share information between multiple incoming
28268 connections (but your local name server cache should be active).
28269
28270
28271
28272 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28273 .cindex "DNS list" "keyed by explicit IP address"
28274 By default, the IP address that is used in a DNS list lookup is the IP address
28275 of the calling host. However, you can specify another IP address by listing it
28276 after the domain name, introduced by a slash. For example:
28277 .code
28278 deny dnslists = black.list.tld/192.168.1.2
28279 .endd
28280 This feature is not very helpful with explicit IP addresses; it is intended for
28281 use with IP addresses that are looked up, for example, the IP addresses of the
28282 MX hosts or nameservers of an email sender address. For an example, see section
28283 &<<SECTmulkeyfor>>& below.
28284
28285
28286
28287
28288 .section "DNS lists keyed on domain names" "SECID202"
28289 .cindex "DNS list" "keyed by domain name"
28290 There are some lists that are keyed on domain names rather than inverted IP
28291 addresses (see for example the &'domain based zones'& link at
28292 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28293 with these lists. You can change the name that is looked up in a DNS list by
28294 listing it after the domain name, introduced by a slash. For example,
28295 .code
28296 deny  message  = Sender's domain is listed at $dnslist_domain
28297       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28298 .endd
28299 This particular example is useful only in ACLs that are obeyed after the
28300 RCPT or DATA commands, when a sender address is available. If (for
28301 example) the message's sender is &'user@tld.example'& the name that is looked
28302 up by this example is
28303 .code
28304 tld.example.dsn.rfc-ignorant.org
28305 .endd
28306 A single &%dnslists%& condition can contain entries for both names and IP
28307 addresses. For example:
28308 .code
28309 deny dnslists = sbl.spamhaus.org : \
28310                 dsn.rfc-ignorant.org/$sender_address_domain
28311 .endd
28312 The first item checks the sending host's IP address; the second checks a domain
28313 name. The whole condition is true if either of the DNS lookups succeeds.
28314
28315
28316
28317
28318 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28319 .cindex "DNS list" "multiple keys for"
28320 The syntax described above for looking up explicitly-defined values (either
28321 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28322 name for the DNS list, what follows the slash can in fact be a list of items.
28323 As with all lists in Exim, the default separator is a colon. However, because
28324 this is a sublist within the list of DNS blacklist domains, it is necessary
28325 either to double the separators like this:
28326 .code
28327 dnslists = black.list.tld/name.1::name.2
28328 .endd
28329 or to change the separator character, like this:
28330 .code
28331 dnslists = black.list.tld/<;name.1;name.2
28332 .endd
28333 If an item in the list is an IP address, it is inverted before the DNS
28334 blacklist domain is appended. If it is not an IP address, no inversion
28335 occurs. Consider this condition:
28336 .code
28337 dnslists = black.list.tld/<;192.168.1.2;a.domain
28338 .endd
28339 The DNS lookups that occur are:
28340 .code
28341 2.1.168.192.black.list.tld
28342 a.domain.black.list.tld
28343 .endd
28344 Once a DNS record has been found (that matches a specific IP return
28345 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28346 are done. If there is a temporary DNS error, the rest of the sublist of domains
28347 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28348 only if no other DNS lookup in this sublist succeeds. In other words, a
28349 successful lookup for any of the items in the sublist overrides a temporary
28350 error for a previous item.
28351
28352 The ability to supply a list of items after the slash is in some sense just a
28353 syntactic convenience. These two examples have the same effect:
28354 .code
28355 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28356 dnslists = black.list.tld/a.domain::b.domain
28357 .endd
28358 However, when the data for the list is obtained from a lookup, the second form
28359 is usually much more convenient. Consider this example:
28360 .code
28361 deny message  = The mail servers for the domain \
28362                 $sender_address_domain \
28363                 are listed at $dnslist_domain ($dnslist_value); \
28364                 see $dnslist_text.
28365      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28366                                    ${lookup dnsdb {>|mxh=\
28367                                    $sender_address_domain} }} }
28368 .endd
28369 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28370 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28371 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28372 of expanding the condition might be something like this:
28373 .code
28374 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28375 .endd
28376 Thus, this example checks whether or not the IP addresses of the sender
28377 domain's mail servers are on the Spamhaus black list.
28378
28379 The key that was used for a successful DNS list lookup is put into the variable
28380 &$dnslist_matched$& (see section &<<SECID204>>&).
28381
28382
28383
28384
28385 .section "Data returned by DNS lists" "SECID203"
28386 .cindex "DNS list" "data returned from"
28387 DNS lists are constructed using address records in the DNS. The original RBL
28388 just used the address 127.0.0.1 on the right hand side of each record, but the
28389 RBL+ list and some other lists use a number of values with different meanings.
28390 The values used on the RBL+ list are:
28391 .display
28392 127.1.0.1  RBL
28393 127.1.0.2  DUL
28394 127.1.0.3  DUL and RBL
28395 127.1.0.4  RSS
28396 127.1.0.5  RSS and RBL
28397 127.1.0.6  RSS and DUL
28398 127.1.0.7  RSS and DUL and RBL
28399 .endd
28400 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28401 different values. Some DNS lists may return more than one address record;
28402 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28403
28404
28405 .section "Variables set from DNS lists" "SECID204"
28406 .cindex "expansion" "variables, set from DNS list"
28407 .cindex "DNS list" "variables set from"
28408 .vindex "&$dnslist_domain$&"
28409 .vindex "&$dnslist_matched$&"
28410 .vindex "&$dnslist_text$&"
28411 .vindex "&$dnslist_value$&"
28412 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28413 the name of the overall domain that matched (for example,
28414 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28415 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28416 the DNS record. When the key is an IP address, it is not reversed in
28417 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28418 cases, for example:
28419 .code
28420 deny dnslists = spamhaus.example
28421 .endd
28422 the key is also available in another variable (in this case,
28423 &$sender_host_address$&). In more complicated cases, however, this is not true.
28424 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28425 might generate a dnslists lookup like this:
28426 .code
28427 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28428 .endd
28429 If this condition succeeds, the value in &$dnslist_matched$& might be
28430 &`192.168.6.7`& (for example).
28431
28432 If more than one address record is returned by the DNS lookup, all the IP
28433 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28434 The variable &$dnslist_text$& contains the contents of any associated TXT
28435 record. For lists such as RBL+ the TXT record for a merged entry is often not
28436 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28437 information.
28438
28439 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28440 &-- although these appear before the condition in the ACL, they are not
28441 expanded until after it has failed. For example:
28442 .code
28443 deny    hosts = !+local_networks
28444         message = $sender_host_address is listed \
28445                   at $dnslist_domain
28446         dnslists = rbl-plus.mail-abuse.example
28447 .endd
28448
28449
28450
28451 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28452 .cindex "DNS list" "matching specific returned data"
28453 You can add an equals sign and an IP address after a &%dnslists%& domain name
28454 in order to restrict its action to DNS records with a matching right hand side.
28455 For example,
28456 .code
28457 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28458 .endd
28459 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28460 any address record is considered to be a match. For the moment, we assume
28461 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28462 describes how multiple records are handled.
28463
28464 More than one IP address may be given for checking, using a comma as a
28465 separator. These are alternatives &-- if any one of them matches, the
28466 &%dnslists%& condition is true. For example:
28467 .code
28468 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28469 .endd
28470 If you want to specify a constraining address list and also specify names or IP
28471 addresses to be looked up, the constraining address list must be specified
28472 first. For example:
28473 .code
28474 deny dnslists = dsn.rfc-ignorant.org\
28475                 =127.0.0.2/$sender_address_domain
28476 .endd
28477
28478 If the character &`&&`& is used instead of &`=`&, the comparison for each
28479 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28480 In other words, the listed addresses are used as bit masks. The comparison is
28481 true if all the bits in the mask are present in the address that is being
28482 tested. For example:
28483 .code
28484 dnslists = a.b.c&0.0.0.3
28485 .endd
28486 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28487 want to test whether one bit or another bit is present (as opposed to both
28488 being present), you must use multiple values. For example:
28489 .code
28490 dnslists = a.b.c&0.0.0.1,0.0.0.2
28491 .endd
28492 matches if the final component of the address is an odd number or two times
28493 an odd number.
28494
28495
28496
28497 .section "Negated DNS matching conditions" "SECID205"
28498 You can supply a negative list of IP addresses as part of a &%dnslists%&
28499 condition. Whereas
28500 .code
28501 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28502 .endd
28503 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28504 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28505 .code
28506 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28507 .endd
28508 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28509 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28510 words, the result of the test is inverted if an exclamation mark appears before
28511 the &`=`& (or the &`&&`&) sign.
28512
28513 &*Note*&: This kind of negation is not the same as negation in a domain,
28514 host, or address list (which is why the syntax is different).
28515
28516 If you are using just one list, the negation syntax does not gain you much. The
28517 previous example is precisely equivalent to
28518 .code
28519 deny  dnslists = a.b.c
28520      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28521 .endd
28522 However, if you are using multiple lists, the negation syntax is clearer.
28523 Consider this example:
28524 .code
28525 deny  dnslists = sbl.spamhaus.org : \
28526                  list.dsbl.org : \
28527                  dnsbl.njabl.org!=127.0.0.3 : \
28528                  relays.ordb.org
28529 .endd
28530 Using only positive lists, this would have to be:
28531 .code
28532 deny  dnslists = sbl.spamhaus.org : \
28533                  list.dsbl.org
28534 deny  dnslists = dnsbl.njabl.org
28535      !dnslists = dnsbl.njabl.org=127.0.0.3
28536 deny  dnslists = relays.ordb.org
28537 .endd
28538 which is less clear, and harder to maintain.
28539
28540
28541
28542
28543 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28544 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28545 thereby providing more than one IP address. When an item in a &%dnslists%& list
28546 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28547 the match to specific results from the DNS lookup, there are two ways in which
28548 the checking can be handled. For example, consider the condition:
28549 .code
28550 dnslists = a.b.c=127.0.0.1
28551 .endd
28552 What happens if the DNS lookup for the incoming IP address yields both
28553 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28554 condition true because at least one given value was found, or is it false
28555 because at least one of the found values was not listed? And how does this
28556 affect negated conditions? Both possibilities are provided for with the help of
28557 additional separators &`==`& and &`=&&`&.
28558
28559 .ilist
28560 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28561 IP addresses matches one of the listed addresses. For the example above, the
28562 condition is true because 127.0.0.1 matches.
28563 .next
28564 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28565 looked up IP addresses matches one of the listed addresses. If the condition is
28566 changed to:
28567 .code
28568 dnslists = a.b.c==127.0.0.1
28569 .endd
28570 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28571 false because 127.0.0.2 is not listed. You would need to have:
28572 .code
28573 dnslists = a.b.c==127.0.0.1,127.0.0.2
28574 .endd
28575 for the condition to be true.
28576 .endlist
28577
28578 When &`!`& is used to negate IP address matching, it inverts the result, giving
28579 the precise opposite of the behaviour above. Thus:
28580 .ilist
28581 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28582 addresses matches one of the listed addresses. Consider:
28583 .code
28584 dnslists = a.b.c!&0.0.0.1
28585 .endd
28586 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28587 false because 127.0.0.1 matches.
28588 .next
28589 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28590 looked up IP address that does not match. Consider:
28591 .code
28592 dnslists = a.b.c!=&0.0.0.1
28593 .endd
28594 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28595 true, because 127.0.0.2 does not match. You would need to have:
28596 .code
28597 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28598 .endd
28599 for the condition to be false.
28600 .endlist
28601 When the DNS lookup yields only a single IP address, there is no difference
28602 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28603
28604
28605
28606
28607 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28608 .cindex "DNS list" "information from merged"
28609 When the facility for restricting the matching IP values in a DNS list is used,
28610 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28611 the true reason for rejection. This happens when lists are merged and the IP
28612 address in the A record is used to distinguish them; unfortunately there is
28613 only one TXT record. One way round this is not to use merged lists, but that
28614 can be inefficient because it requires multiple DNS lookups where one would do
28615 in the vast majority of cases when the host of interest is not on any of the
28616 lists.
28617
28618 A less inefficient way of solving this problem is available. If
28619 two domain names, comma-separated, are given, the second is used first to
28620 do an initial check, making use of any IP value restrictions that are set.
28621 If there is a match, the first domain is used, without any IP value
28622 restrictions, to get the TXT record. As a byproduct of this, there is also
28623 a check that the IP being tested is indeed on the first list. The first
28624 domain is the one that is put in &$dnslist_domain$&. For example:
28625 .code
28626 reject message  = \
28627          rejected because $sender_host_address is blacklisted \
28628          at $dnslist_domain\n$dnslist_text
28629        dnslists = \
28630          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28631          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28632 .endd
28633 For the first blacklist item, this starts by doing a lookup in
28634 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28635 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28636 value, and as long as something is found, it looks for the corresponding TXT
28637 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28638 The second blacklist item is processed similarly.
28639
28640 If you are interested in more than one merged list, the same list must be
28641 given several times, but because the results of the DNS lookups are cached,
28642 the DNS calls themselves are not repeated. For example:
28643 .code
28644 reject dnslists = \
28645          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28646          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28647          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28648          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28649 .endd
28650 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28651 values matches (or if no record is found), this is the only lookup that is
28652 done. Only if there is a match is one of the more specific lists consulted.
28653
28654
28655
28656 .section "DNS lists and IPv6" "SECTmorednslistslast"
28657 .cindex "IPv6" "DNS black lists"
28658 .cindex "DNS list" "IPv6 usage"
28659 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28660 nibble by nibble. For example, if the calling host's IP address is
28661 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28662 .code
28663 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28664   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28665 .endd
28666 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28667 lists contain wildcard records, intended for IPv4, that interact badly with
28668 IPv6. For example, the DNS entry
28669 .code
28670 *.3.some.list.example.    A    127.0.0.1
28671 .endd
28672 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28673 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28674
28675 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28676 &%condition%& condition, as in this example:
28677 .code
28678 deny   condition = ${if isip4{$sender_host_address}}
28679        dnslists  = some.list.example
28680 .endd
28681
28682 .section "Rate limiting incoming messages" "SECTratelimiting"
28683 .cindex "rate limiting" "client sending"
28684 .cindex "limiting client sending rates"
28685 .oindex "&%smtp_ratelimit_*%&"
28686 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28687 which clients can send email. This is more powerful than the
28688 &%smtp_ratelimit_*%& options, because those options control the rate of
28689 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28690 works across all connections (concurrent and sequential) from the same client
28691 host. The syntax of the &%ratelimit%& condition is:
28692 .display
28693 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28694 .endd
28695 If the average client sending rate is less than &'m'& messages per time
28696 period &'p'& then the condition is false; otherwise it is true.
28697
28698 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28699 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28700 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28701 of &'p'&.
28702
28703 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28704 time interval, for example, &`8h`& for eight hours. A larger time constant
28705 means that it takes Exim longer to forget a client's past behaviour. The
28706 parameter &'m'& is the maximum number of messages that a client is permitted to
28707 send in each time interval. It also specifies the number of messages permitted
28708 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28709 constant, you can allow a client to send more messages in a burst without
28710 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28711 both small, messages must be sent at an even rate.
28712
28713 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28714 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28715 when deploying the &%ratelimit%& ACL condition. The script prints usage
28716 instructions when it is run with no arguments.
28717
28718 The key is used to look up the data for calculating the client's average
28719 sending rate. This data is stored in Exim's spool directory, alongside the
28720 retry and other hints databases. The default key is &$sender_host_address$&,
28721 which means Exim computes the sending rate of each client host IP address.
28722 By changing the key you can change how Exim identifies clients for the purpose
28723 of ratelimiting. For example, to limit the sending rate of each authenticated
28724 user, independent of the computer they are sending from, set the key to
28725 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28726 example, &$authenticated_id$& is only meaningful if the client has
28727 authenticated (which you can check with the &%authenticated%& ACL condition).
28728
28729 The lookup key does not have to identify clients: If you want to limit the
28730 rate at which a recipient receives messages, you can use the key
28731 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28732 ACL.
28733
28734 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28735 specifies what Exim measures the rate of, for example messages or recipients
28736 or bytes. You can adjust the measurement using the &%unique=%& and/or
28737 &%count=%& options. You can also control when Exim updates the recorded rate
28738 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28739 separated by a slash, like the other parameters. They may appear in any order.
28740
28741 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28742 any options that alter the meaning of the stored data. The limit &'m'& is not
28743 stored, so you can alter the configured maximum rate and Exim will still
28744 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28745 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28746 behaviour. The lookup key is not affected by changes to the update mode and
28747 the &%count=%& option.
28748
28749
28750 .section "Ratelimit options for what is being measured" "ratoptmea"
28751 .cindex "rate limiting" "per_* options"
28752 The &%per_conn%& option limits the client's connection rate. It is not
28753 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28754 &%acl_not_smtp_start%& ACLs.
28755
28756 The &%per_mail%& option limits the client's rate of sending messages. This is
28757 the default if none of the &%per_*%& options is specified. It can be used in
28758 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28759 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28760
28761 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28762 the same ACLs as the &%per_mail%& option, though it is best to use this option
28763 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28764 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28765 in its MAIL command, which may be inaccurate or completely missing. You can
28766 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28767 in kilobytes, megabytes, or gigabytes, respectively.
28768
28769 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28770 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28771 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28772 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28773 ACLs the rate is updated with the total recipient count in one go. Note that
28774 in either case the rate limiting engine will see a message with many
28775 recipients as a large high-speed burst.
28776
28777 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28778 number of different recipients that the client has sent messages to in the
28779 last time period. That is, if the client repeatedly sends messages to the same
28780 recipient, its measured rate is not increased. This option can only be used in
28781 &%acl_smtp_rcpt%&.
28782
28783 The &%per_cmd%& option causes Exim to recompute the rate every time the
28784 condition is processed. This can be used to limit the rate of any SMTP
28785 command. If it is used in multiple ACLs it can limit the aggregate rate of
28786 multiple different commands.
28787
28788 The &%count=%& option can be used to alter how much Exim adds to the client's
28789 measured rate. For example, the &%per_byte%& option is equivalent to
28790 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28791 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28792 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28793
28794 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28795
28796
28797 .section "Ratelimit update modes" "ratoptupd"
28798 .cindex "rate limiting" "reading data without updating"
28799 You can specify one of three options with the &%ratelimit%& condition to
28800 control when its database is updated. This section describes the &%readonly%&
28801 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28802
28803 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28804 previously-computed rate to check against the limit.
28805
28806 For example, you can test the client's sending rate and deny it access (when
28807 it is too fast) in the connect ACL. If the client passes this check then it
28808 can go on to send a message, in which case its recorded rate will be updated
28809 in the MAIL ACL. Subsequent connections from the same client will check this
28810 new rate.
28811 .code
28812 acl_check_connect:
28813  deny ratelimit = 100 / 5m / readonly
28814     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28815                   (max $sender_rate_limit)
28816 # ...
28817 acl_check_mail:
28818  warn ratelimit = 100 / 5m / strict
28819     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28820                   (max $sender_rate_limit)
28821 .endd
28822
28823 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28824 processing a message then it may increase the client's measured rate more than
28825 it should. For example, this will happen if you check the &%per_rcpt%& option
28826 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28827 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28828 multiple update problems by using the &%readonly%& option on later ratelimit
28829 checks.
28830
28831 The &%per_*%& options described above do not make sense in some ACLs. If you
28832 use a &%per_*%& option in an ACL where it is not normally permitted then the
28833 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28834 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28835 next section) so you must specify the &%readonly%& option explicitly.
28836
28837
28838 .section "Ratelimit options for handling fast clients" "ratoptfast"
28839 .cindex "rate limiting" "strict and leaky modes"
28840 If a client's average rate is greater than the maximum, the rate limiting
28841 engine can react in two possible ways, depending on the presence of the
28842 &%strict%& or &%leaky%& update modes. This is independent of the other
28843 counter-measures (such as rejecting the message) that may be specified by the
28844 rest of the ACL.
28845
28846 The &%leaky%& (default) option means that the client's recorded rate is not
28847 updated if it is above the limit. The effect of this is that Exim measures the
28848 client's average rate of successfully sent email, which cannot be greater than
28849 the maximum allowed. If the client is over the limit it may suffer some
28850 counter-measures (as specified in the ACL), but it will still be able to send
28851 email at the configured maximum rate, whatever the rate of its attempts. This
28852 is generally the better choice if you have clients that retry automatically.
28853 For example, it does not prevent a sender with an over-aggressive retry rate
28854 from getting any email through.
28855
28856 The &%strict%& option means that the client's recorded rate is always
28857 updated. The effect of this is that Exim measures the client's average rate
28858 of attempts to send email, which can be much higher than the maximum it is
28859 actually allowed. If the client is over the limit it may be subjected to
28860 counter-measures by the ACL. It must slow down and allow sufficient time to
28861 pass that its computed rate falls below the maximum before it can send email
28862 again. The time (the number of smoothing periods) it must wait and not
28863 attempt to send mail can be calculated with this formula:
28864 .code
28865         ln(peakrate/maxrate)
28866 .endd
28867
28868
28869 .section "Limiting the rate of different events" "ratoptuniq"
28870 .cindex "rate limiting" "counting unique events"
28871 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28872 rate of different events. For example, the &%per_addr%& option uses this
28873 mechanism to count the number of different recipients that the client has
28874 sent messages to in the last time period; it is equivalent to
28875 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28876 measure the rate that a client uses different sender addresses with the
28877 options &`per_mail/unique=$sender_address`&.
28878
28879 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28880 has seen for that key. The whole set is thrown away when it is older than the
28881 rate smoothing period &'p'&, so each different event is counted at most once
28882 per period. In the &%leaky%& update mode, an event that causes the client to
28883 go over the limit is not added to the set, in the same way that the client's
28884 recorded rate is not updated in the same situation.
28885
28886 When you combine the &%unique=%& and &%readonly%& options, the specific
28887 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28888 rate.
28889
28890 The &%unique=%& mechanism needs more space in the ratelimit database than the
28891 other &%ratelimit%& options in order to store the event set. The number of
28892 unique values is potentially as large as the rate limit, so the extra space
28893 required increases with larger limits.
28894
28895 The uniqueification is not perfect: there is a small probability that Exim
28896 will think a new event has happened before. If the sender's rate is less than
28897 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28898 the measured rate can go above the limit, in which case Exim may under-count
28899 events by a significant margin. Fortunately, if the rate is high enough (2.7
28900 times the limit) that the false positive rate goes above 9%, then Exim will
28901 throw away the over-full event set before the measured rate falls below the
28902 limit. Therefore the only harm should be that exceptionally high sending rates
28903 are logged incorrectly; any countermeasures you configure will be as effective
28904 as intended.
28905
28906
28907 .section "Using rate limiting" "useratlim"
28908 Exim's other ACL facilities are used to define what counter-measures are taken
28909 when the rate limit is exceeded. This might be anything from logging a warning
28910 (for example, while measuring existing sending rates in order to define
28911 policy), through time delays to slow down fast senders, up to rejecting the
28912 message. For example:
28913 .code
28914 # Log all senders' rates
28915 warn ratelimit = 0 / 1h / strict
28916      log_message = Sender rate $sender_rate / $sender_rate_period
28917
28918 # Slow down fast senders; note the need to truncate $sender_rate
28919 # at the decimal point.
28920 warn ratelimit = 100 / 1h / per_rcpt / strict
28921      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28922                    $sender_rate_limit }s
28923
28924 # Keep authenticated users under control
28925 deny authenticated = *
28926      ratelimit = 100 / 1d / strict / $authenticated_id
28927
28928 # System-wide rate limit
28929 defer message = Sorry, too busy. Try again later.
28930      ratelimit = 10 / 1s / $primary_hostname
28931
28932 # Restrict incoming rate from each host, with a default
28933 # set using a macro and special cases looked up in a table.
28934 defer message = Sender rate exceeds $sender_rate_limit \
28935                messages per $sender_rate_period
28936      ratelimit = ${lookup {$sender_host_address} \
28937                    cdb {DB/ratelimits.cdb} \
28938                    {$value} {RATELIMIT} }
28939 .endd
28940 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28941 especially with the &%per_rcpt%& option, you may suffer from a performance
28942 bottleneck caused by locking on the ratelimit hints database. Apart from
28943 making your ACLs less complicated, you can reduce the problem by using a
28944 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28945 this means that Exim will lose its hints data after a reboot (including retry
28946 hints, the callout cache, and ratelimit data).
28947
28948
28949
28950 .section "Address verification" "SECTaddressverification"
28951 .cindex "verifying address" "options for"
28952 .cindex "policy control" "address verification"
28953 Several of the &%verify%& conditions described in section
28954 &<<SECTaclconditions>>& cause addresses to be verified. Section
28955 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28956 The verification conditions can be followed by options that modify the
28957 verification process. The options are separated from the keyword and from each
28958 other by slashes, and some of them contain parameters. For example:
28959 .code
28960 verify = sender/callout
28961 verify = recipient/defer_ok/callout=10s,defer_ok
28962 .endd
28963 The first stage of address verification, which always happens, is to run the
28964 address through the routers, in &"verify mode"&. Routers can detect the
28965 difference between verification and routing for delivery, and their actions can
28966 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28967 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28968 The available options are as follows:
28969
28970 .ilist
28971 If the &%callout%& option is specified, successful routing to one or more
28972 remote hosts is followed by a &"callout"& to those hosts as an additional
28973 check. Callouts and their sub-options are discussed in the next section.
28974 .next
28975 If there is a defer error while doing verification routing, the ACL
28976 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28977 options, the condition is forced to be true instead. Note that this is a main
28978 verification option as well as a suboption for callouts.
28979 .next
28980 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28981 discusses the reporting of sender address verification failures.
28982 .next
28983 The &%success_on_redirect%& option causes verification always to succeed
28984 immediately after a successful redirection. By default, if a redirection
28985 generates just one address, that address is also verified. See further
28986 discussion in section &<<SECTredirwhilveri>>&.
28987 .endlist
28988
28989 .cindex "verifying address" "differentiating failures"
28990 .vindex "&$recipient_verify_failure$&"
28991 .vindex "&$sender_verify_failure$&"
28992 .vindex "&$acl_verify_message$&"
28993 After an address verification failure, &$acl_verify_message$& contains the
28994 error message that is associated with the failure. It can be preserved by
28995 coding like this:
28996 .code
28997 warn  !verify = sender
28998        set acl_m0 = $acl_verify_message
28999 .endd
29000 If you are writing your own custom rejection message or log message when
29001 denying access, you can use this variable to include information about the
29002 verification failure.
29003
29004 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29005 appropriate) contains one of the following words:
29006
29007 .ilist
29008 &%qualify%&: The address was unqualified (no domain), and the message
29009 was neither local nor came from an exempted host.
29010 .next
29011 &%route%&: Routing failed.
29012 .next
29013 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29014 occurred at or before the MAIL command (that is, on initial
29015 connection, HELO, or MAIL).
29016 .next
29017 &%recipient%&: The RCPT command in a callout was rejected.
29018 .next
29019 &%postmaster%&: The postmaster check in a callout was rejected.
29020 .endlist
29021
29022 The main use of these variables is expected to be to distinguish between
29023 rejections of MAIL and rejections of RCPT in callouts.
29024
29025
29026
29027
29028 .section "Callout verification" "SECTcallver"
29029 .cindex "verifying address" "by callout"
29030 .cindex "callout" "verification"
29031 .cindex "SMTP" "callout verification"
29032 For non-local addresses, routing verifies the domain, but is unable to do any
29033 checking of the local part. There are situations where some means of verifying
29034 the local part is desirable. One way this can be done is to make an SMTP
29035 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29036 a subsequent host for a recipient address, to see if the host accepts the
29037 address. We use the term &'callout'& to cover both cases. Note that for a
29038 sender address, the callback is not to the client host that is trying to
29039 deliver the message, but to one of the hosts that accepts incoming mail for the
29040 sender's domain.
29041
29042 Exim does not do callouts by default. If you want them to happen, you must
29043 request them by setting appropriate options on the &%verify%& condition, as
29044 described below. This facility should be used with care, because it can add a
29045 lot of resource usage to the cost of verifying an address. However, Exim does
29046 cache the results of callouts, which helps to reduce the cost. Details of
29047 caching are in section &<<SECTcallvercache>>&.
29048
29049 Recipient callouts are usually used only between hosts that are controlled by
29050 the same administration. For example, a corporate gateway host could use
29051 callouts to check for valid recipients on an internal mailserver. A successful
29052 callout does not guarantee that a real delivery to the address would succeed;
29053 on the other hand, a failing callout does guarantee that a delivery would fail.
29054
29055 If the &%callout%& option is present on a condition that verifies an address, a
29056 second stage of verification occurs if the address is successfully routed to
29057 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29058 &(manualroute)& router, where the router specifies the hosts. However, if a
29059 router that does not set up hosts routes to an &(smtp)& transport with a
29060 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29061 &%hosts_override%& set, its hosts are always used, whether or not the router
29062 supplies a host list.
29063
29064 The port that is used is taken from the transport, if it is specified and is a
29065 remote transport. (For routers that do verification only, no transport need be
29066 specified.) Otherwise, the default SMTP port is used. If a remote transport
29067 specifies an outgoing interface, this is used; otherwise the interface is not
29068 specified. Likewise, the text that is used for the HELO command is taken from
29069 the transport's &%helo_data%& option; if there is no transport, the value of
29070 &$smtp_active_hostname$& is used.
29071
29072 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29073 test whether a bounce message could be delivered to the sender address. The
29074 following SMTP commands are sent:
29075 .display
29076 &`HELO `&<&'local host name'&>
29077 &`MAIL FROM:<>`&
29078 &`RCPT TO:`&<&'the address to be tested'&>
29079 &`QUIT`&
29080 .endd
29081 LHLO is used instead of HELO if the transport's &%protocol%& option is
29082 set to &"lmtp"&.
29083
29084 .new
29085 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29086 settings.
29087 .wen
29088
29089 A recipient callout check is similar. By default, it also uses an empty address
29090 for the sender. This default is chosen because most hosts do not make use of
29091 the sender address when verifying a recipient. Using the same address means
29092 that a single cache entry can be used for each recipient. Some sites, however,
29093 do make use of the sender address when verifying. These are catered for by the
29094 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29095
29096 If the response to the RCPT command is a 2&'xx'& code, the verification
29097 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29098 Exim tries the next host, if any. If there is a problem with all the remote
29099 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29100 &%callout%& option is given, in which case the condition is forced to succeed.
29101
29102 .cindex "SMTP" "output flushing, disabling for callout"
29103 A callout may take a little time. For this reason, Exim normally flushes SMTP
29104 output before performing a callout in an ACL, to avoid unexpected timeouts in
29105 clients when the SMTP PIPELINING extension is in use. The flushing can be
29106 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29107
29108
29109
29110
29111 .section "Additional parameters for callouts" "CALLaddparcall"
29112 .cindex "callout" "additional parameters for"
29113 The &%callout%& option can be followed by an equals sign and a number of
29114 optional parameters, separated by commas. For example:
29115 .code
29116 verify = recipient/callout=10s,defer_ok
29117 .endd
29118 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29119 separate verify options, is retained for backwards compatibility, but is now
29120 deprecated. The additional parameters for &%callout%& are as follows:
29121
29122
29123 .vlist
29124 .vitem <&'a&~time&~interval'&>
29125 .cindex "callout" "timeout, specifying"
29126 This specifies the timeout that applies for the callout attempt to each host.
29127 For example:
29128 .code
29129 verify = sender/callout=5s
29130 .endd
29131 The default is 30 seconds. The timeout is used for each response from the
29132 remote host. It is also used for the initial connection, unless overridden by
29133 the &%connect%& parameter.
29134
29135
29136 .vitem &*connect&~=&~*&<&'time&~interval'&>
29137 .cindex "callout" "connection timeout, specifying"
29138 This parameter makes it possible to set a different (usually smaller) timeout
29139 for making the SMTP connection. For example:
29140 .code
29141 verify = sender/callout=5s,connect=1s
29142 .endd
29143 If not specified, this timeout defaults to the general timeout value.
29144
29145 .vitem &*defer_ok*&
29146 .cindex "callout" "defer, action on"
29147 When this parameter is present, failure to contact any host, or any other kind
29148 of temporary error, is treated as success by the ACL. However, the cache is not
29149 updated in this circumstance.
29150
29151 .vitem &*fullpostmaster*&
29152 .cindex "callout" "full postmaster check"
29153 This operates like the &%postmaster%& option (see below), but if the check for
29154 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29155 accordance with the specification in RFC 2821. The RFC states that the
29156 unqualified address &'postmaster'& should be accepted.
29157
29158
29159 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29160 .cindex "callout" "sender when verifying header"
29161 When verifying addresses in header lines using the &%header_sender%&
29162 verification option, Exim behaves by default as if the addresses are envelope
29163 sender addresses from a message. Callout verification therefore tests to see
29164 whether a bounce message could be delivered, by using an empty address in the
29165 MAIL command. However, it is arguable that these addresses might never be used
29166 as envelope senders, and could therefore justifiably reject bounce messages
29167 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29168 address to use in the MAIL command. For example:
29169 .code
29170 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29171 .endd
29172 This parameter is available only for the &%header_sender%& verification option.
29173
29174
29175 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29176 .cindex "callout" "overall timeout, specifying"
29177 This parameter sets an overall timeout for performing a callout verification.
29178 For example:
29179 .code
29180 verify = sender/callout=5s,maxwait=30s
29181 .endd
29182 This timeout defaults to four times the callout timeout for individual SMTP
29183 commands. The overall timeout applies when there is more than one host that can
29184 be tried. The timeout is checked before trying the next host. This prevents
29185 very long delays if there are a large number of hosts and all are timing out
29186 (for example, when network connections are timing out).
29187
29188
29189 .vitem &*no_cache*&
29190 .cindex "callout" "cache, suppressing"
29191 .cindex "caching callout, suppressing"
29192 When this parameter is given, the callout cache is neither read nor updated.
29193
29194 .vitem &*postmaster*&
29195 .cindex "callout" "postmaster; checking"
29196 When this parameter is set, a successful callout check is followed by a similar
29197 check for the local part &'postmaster'& at the same domain. If this address is
29198 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29199 the postmaster check is recorded in a cache record; if it is a failure, this is
29200 used to fail subsequent callouts for the domain without a connection being
29201 made, until the cache record expires.
29202
29203 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29204 The postmaster check uses an empty sender in the MAIL command by default.
29205 You can use this parameter to do a postmaster check using a different address.
29206 For example:
29207 .code
29208 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29209 .endd
29210 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29211 one overrides. The &%postmaster%& parameter is equivalent to this example:
29212 .code
29213 require  verify = sender/callout=postmaster_mailfrom=
29214 .endd
29215 &*Warning*&: The caching arrangements for postmaster checking do not take
29216 account of the sender address. It is assumed that either the empty address or
29217 a fixed non-empty address will be used. All that Exim remembers is that the
29218 postmaster check for the domain succeeded or failed.
29219
29220
29221 .vitem &*random*&
29222 .cindex "callout" "&""random""& check"
29223 When this parameter is set, before doing the normal callout check, Exim does a
29224 check for a &"random"& local part at the same domain. The local part is not
29225 really random &-- it is defined by the expansion of the option
29226 &%callout_random_local_part%&, which defaults to
29227 .code
29228 $primary_hostname-$tod_epoch-testing
29229 .endd
29230 The idea here is to try to determine whether the remote host accepts all local
29231 parts without checking. If it does, there is no point in doing callouts for
29232 specific local parts. If the &"random"& check succeeds, the result is saved in
29233 a cache record, and used to force the current and subsequent callout checks to
29234 succeed without a connection being made, until the cache record expires.
29235
29236 .vitem &*use_postmaster*&
29237 .cindex "callout" "sender for recipient check"
29238 This parameter applies to recipient callouts only. For example:
29239 .code
29240 deny  !verify = recipient/callout=use_postmaster
29241 .endd
29242 .vindex "&$qualify_domain$&"
29243 It causes a non-empty postmaster address to be used in the MAIL command when
29244 performing the callout for the recipient, and also for a &"random"& check if
29245 that is configured. The local part of the address is &`postmaster`& and the
29246 domain is the contents of &$qualify_domain$&.
29247
29248 .vitem &*use_sender*&
29249 This option applies to recipient callouts only. For example:
29250 .code
29251 require  verify = recipient/callout=use_sender
29252 .endd
29253 It causes the message's actual sender address to be used in the MAIL
29254 command when performing the callout, instead of an empty address. There is no
29255 need to use this option unless you know that the called hosts make use of the
29256 sender when checking recipients. If used indiscriminately, it reduces the
29257 usefulness of callout caching.
29258 .endlist
29259
29260 If you use any of the parameters that set a non-empty sender for the MAIL
29261 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29262 &%use_sender%&), you should think about possible loops. Recipient checking is
29263 usually done between two hosts that are under the same management, and the host
29264 that receives the callouts is not normally configured to do callouts itself.
29265 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29266 these circumstances.
29267
29268 However, if you use a non-empty sender address for a callout to an arbitrary
29269 host, there is the likelihood that the remote host will itself initiate a
29270 callout check back to your host. As it is checking what appears to be a message
29271 sender, it is likely to use an empty address in MAIL, thus avoiding a
29272 callout loop. However, to be on the safe side it would be best to set up your
29273 own ACLs so that they do not do sender verification checks when the recipient
29274 is the address you use for header sender or postmaster callout checking.
29275
29276 Another issue to think about when using non-empty senders for callouts is
29277 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29278 by the sender/recipient combination; thus, for any given recipient, many more
29279 actual callouts are performed than when an empty sender or postmaster is used.
29280
29281
29282
29283
29284 .section "Callout caching" "SECTcallvercache"
29285 .cindex "hints database" "callout cache"
29286 .cindex "callout" "cache, description of"
29287 .cindex "caching" "callout"
29288 Exim caches the results of callouts in order to reduce the amount of resources
29289 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29290 option. A hints database called &"callout"& is used for the cache. Two
29291 different record types are used: one records the result of a callout check for
29292 a specific address, and the other records information that applies to the
29293 entire domain (for example, that it accepts the local part &'postmaster'&).
29294
29295 When an original callout fails, a detailed SMTP error message is given about
29296 the failure. However, for subsequent failures use the cache data, this message
29297 is not available.
29298
29299 The expiry times for negative and positive address cache records are
29300 independent, and can be set by the global options &%callout_negative_expire%&
29301 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29302
29303 If a host gives a negative response to an SMTP connection, or rejects any
29304 commands up to and including
29305 .code
29306 MAIL FROM:<>
29307 .endd
29308 (but not including the MAIL command with a non-empty address),
29309 any callout attempt is bound to fail. Exim remembers such failures in a
29310 domain cache record, which it uses to fail callouts for the domain without
29311 making new connections, until the domain record times out. There are two
29312 separate expiry times for domain cache records:
29313 &%callout_domain_negative_expire%& (default 3h) and
29314 &%callout_domain_positive_expire%& (default 7d).
29315
29316 Domain records expire when the negative expiry time is reached if callouts
29317 cannot be made for the domain, or if the postmaster check failed.
29318 Otherwise, they expire when the positive expiry time is reached. This
29319 ensures that, for example, a host that stops accepting &"random"& local parts
29320 will eventually be noticed.
29321
29322 The callout caching mechanism is based on the domain of the address that is
29323 being tested. If the domain routes to several hosts, it is assumed that their
29324 behaviour will be the same.
29325
29326
29327
29328 .section "Sender address verification reporting" "SECTsenaddver"
29329 .cindex "verifying" "suppressing error details"
29330 See section &<<SECTaddressverification>>& for a general discussion of
29331 verification. When sender verification fails in an ACL, the details of the
29332 failure are given as additional output lines before the 550 response to the
29333 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29334 you might see:
29335 .code
29336 MAIL FROM:<xyz@abc.example>
29337 250 OK
29338 RCPT TO:<pqr@def.example>
29339 550-Verification failed for <xyz@abc.example>
29340 550-Called:   192.168.34.43
29341 550-Sent:     RCPT TO:<xyz@abc.example>
29342 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29343 550 Sender verification failed
29344 .endd
29345 If more than one RCPT command fails in the same way, the details are given
29346 only for the first of them. However, some administrators do not want to send
29347 out this much information. You can suppress the details by adding
29348 &`/no_details`& to the ACL statement that requests sender verification. For
29349 example:
29350 .code
29351 verify = sender/no_details
29352 .endd
29353
29354 .section "Redirection while verifying" "SECTredirwhilveri"
29355 .cindex "verifying" "redirection while"
29356 .cindex "address redirection" "while verifying"
29357 A dilemma arises when a local address is redirected by aliasing or forwarding
29358 during verification: should the generated addresses themselves be verified,
29359 or should the successful expansion of the original address be enough to verify
29360 it? By default, Exim takes the following pragmatic approach:
29361
29362 .ilist
29363 When an incoming address is redirected to just one child address, verification
29364 continues with the child address, and if that fails to verify, the original
29365 verification also fails.
29366 .next
29367 When an incoming address is redirected to more than one child address,
29368 verification does not continue. A success result is returned.
29369 .endlist
29370
29371 This seems the most reasonable behaviour for the common use of aliasing as a
29372 way of redirecting different local parts to the same mailbox. It means, for
29373 example, that a pair of alias entries of the form
29374 .code
29375 A.Wol:   aw123
29376 aw123:   :fail: Gone away, no forwarding address
29377 .endd
29378 work as expected, with both local parts causing verification failure. When a
29379 redirection generates more than one address, the behaviour is more like a
29380 mailing list, where the existence of the alias itself is sufficient for
29381 verification to succeed.
29382
29383 It is possible, however, to change the default behaviour so that all successful
29384 redirections count as successful verifications, however many new addresses are
29385 generated. This is specified by the &%success_on_redirect%& verification
29386 option. For example:
29387 .code
29388 require verify = recipient/success_on_redirect/callout=10s
29389 .endd
29390 In this example, verification succeeds if a router generates a new address, and
29391 the callout does not occur, because no address was routed to a remote host.
29392
29393 When verification is being tested via the &%-bv%& option, the treatment of
29394 redirections is as just described, unless the &%-v%& or any debugging option is
29395 also specified. In that case, full verification is done for every generated
29396 address and a report is output for each of them.
29397
29398
29399
29400 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29401 .cindex "CSA" "verifying"
29402 Client SMTP Authorization is a system that allows a site to advertise
29403 which machines are and are not permitted to send email. This is done by placing
29404 special SRV records in the DNS; these are looked up using the client's HELO
29405 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29406 Authorization checks in Exim are performed by the ACL condition:
29407 .code
29408 verify = csa
29409 .endd
29410 This fails if the client is not authorized. If there is a DNS problem, or if no
29411 valid CSA SRV record is found, or if the client is authorized, the condition
29412 succeeds. These three cases can be distinguished using the expansion variable
29413 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29414 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29415 be likely to cause problems for legitimate email.
29416
29417 The error messages produced by the CSA code include slightly more
29418 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29419 looking up the CSA SRV record, or problems looking up the CSA target
29420 address record. There are four reasons for &$csa_status$& being &"fail"&:
29421
29422 .ilist
29423 The client's host name is explicitly not authorized.
29424 .next
29425 The client's IP address does not match any of the CSA target IP addresses.
29426 .next
29427 The client's host name is authorized but it has no valid target IP addresses
29428 (for example, the target's addresses are IPv6 and the client is using IPv4).
29429 .next
29430 The client's host name has no CSA SRV record but a parent domain has asserted
29431 that all subdomains must be explicitly authorized.
29432 .endlist
29433
29434 The &%csa%& verification condition can take an argument which is the domain to
29435 use for the DNS query. The default is:
29436 .code
29437 verify = csa/$sender_helo_name
29438 .endd
29439 This implementation includes an extension to CSA. If the query domain
29440 is an address literal such as [192.0.2.95], or if it is a bare IP
29441 address, Exim searches for CSA SRV records in the reverse DNS as if
29442 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29443 meaningful to say:
29444 .code
29445 verify = csa/$sender_host_address
29446 .endd
29447 In fact, this is the check that Exim performs if the client does not say HELO.
29448 This extension can be turned off by setting the main configuration option
29449 &%dns_csa_use_reverse%& to be false.
29450
29451 If a CSA SRV record is not found for the domain itself, a search
29452 is performed through its parent domains for a record which might be
29453 making assertions about subdomains. The maximum depth of this search is limited
29454 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29455 default. Exim does not look for CSA SRV records in a top level domain, so the
29456 default settings handle HELO domains as long as seven
29457 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29458 of legitimate HELO domains.
29459
29460 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29461 direct SRV lookups, this is not sufficient because of the extra parent domain
29462 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29463 addresses into lookups in the reverse DNS space. The result of a successful
29464 lookup such as:
29465 .code
29466 ${lookup dnsdb {csa=$sender_helo_name}}
29467 .endd
29468 has two space-separated fields: an authorization code and a target host name.
29469 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29470 authorization required but absent, or &"?"& for unknown.
29471
29472
29473
29474
29475 .section "Bounce address tag validation" "SECTverifyPRVS"
29476 .cindex "BATV, verifying"
29477 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29478 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29479 Genuine incoming bounce messages should therefore always be addressed to
29480 recipients that have a valid tag. This scheme is a way of detecting unwanted
29481 bounce messages caused by sender address forgeries (often called &"collateral
29482 spam"&), because the recipients of such messages do not include valid tags.
29483
29484 There are two expansion items to help with the implementation of the BATV
29485 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29486 the original envelope sender address by using a simple key to add a hash of the
29487 address and some time-based randomizing information. The &%prvs%& expansion
29488 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29489 The syntax of these expansion items is described in section
29490 &<<SECTexpansionitems>>&.
29491
29492 As an example, suppose the secret per-address keys are stored in an MySQL
29493 database. A query to look up the key for an address could be defined as a macro
29494 like this:
29495 .code
29496 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29497                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29498                 }{$value}}
29499 .endd
29500 Suppose also that the senders who make use of BATV are defined by an address
29501 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29502 use this:
29503 .code
29504 # Bounces: drop unsigned addresses for BATV senders
29505 deny message = This address does not send an unsigned reverse path
29506      senders = :
29507      recipients = +batv_senders
29508
29509 # Bounces: In case of prvs-signed address, check signature.
29510 deny message = Invalid reverse path signature.
29511      senders = :
29512      condition  = ${prvscheck {$local_part@$domain}\
29513                   {PRVSCHECK_SQL}{1}}
29514      !condition = $prvscheck_result
29515 .endd
29516 The first statement rejects recipients for bounce messages that are addressed
29517 to plain BATV sender addresses, because it is known that BATV senders do not
29518 send out messages with plain sender addresses. The second statement rejects
29519 recipients that are prvs-signed, but with invalid signatures (either because
29520 the key is wrong, or the signature has timed out).
29521
29522 A non-prvs-signed address is not rejected by the second statement, because the
29523 &%prvscheck%& expansion yields an empty string if its first argument is not a
29524 prvs-signed address, thus causing the &%condition%& condition to be false. If
29525 the first argument is a syntactically valid prvs-signed address, the yield is
29526 the third string (in this case &"1"&), whether or not the cryptographic and
29527 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29528 of the checks (empty for failure, &"1"& for success).
29529
29530 There is one more issue you must consider when implementing prvs-signing:
29531 you have to ensure that the routers accept prvs-signed addresses and
29532 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29533 router to remove the signature with a configuration along these lines:
29534 .code
29535 batv_redirect:
29536   driver = redirect
29537   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29538 .endd
29539 This works because, if the third argument of &%prvscheck%& is empty, the result
29540 of the expansion of a prvs-signed address is the decoded value of the original
29541 address. This router should probably be the first of your routers that handles
29542 local addresses.
29543
29544 To create BATV-signed addresses in the first place, a transport of this form
29545 can be used:
29546 .code
29547 external_smtp_batv:
29548   driver = smtp
29549   return_path = ${prvs {$return_path} \
29550                        {${lookup mysql{SELECT \
29551                        secret FROM batv_prvs WHERE \
29552                        sender='${quote_mysql:$sender_address}'} \
29553                        {$value}fail}}}
29554 .endd
29555 If no key can be found for the existing return path, no signing takes place.
29556
29557
29558
29559 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29560 .cindex "&ACL;" "relay control"
29561 .cindex "relaying" "control by ACL"
29562 .cindex "policy control" "relay control"
29563 An MTA is said to &'relay'& a message if it receives it from some host and
29564 delivers it directly to another host as a result of a remote address contained
29565 within it. Redirecting a local address via an alias or forward file and then
29566 passing the message on to another host is not relaying,
29567 .cindex "&""percent hack""&"
29568 but a redirection as a result of the &"percent hack"& is.
29569
29570 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29571 A host which is acting as a gateway or an MX backup is concerned with incoming
29572 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29573 a host which is acting as a smart host for a number of clients is concerned
29574 with outgoing relaying from those clients to the Internet at large. Often the
29575 same host is fulfilling both functions,
29576 . ///
29577 . as illustrated in the diagram below,
29578 . ///
29579 but in principle these two kinds of relaying are entirely independent. What is
29580 not wanted is the transmission of mail from arbitrary remote hosts through your
29581 system to arbitrary domains.
29582
29583
29584 You can implement relay control by means of suitable statements in the ACL that
29585 runs for each RCPT command. For convenience, it is often easiest to use
29586 Exim's named list facility to define the domains and hosts involved. For
29587 example, suppose you want to do the following:
29588
29589 .ilist
29590 Deliver a number of domains to mailboxes on the local host (or process them
29591 locally in some other way). Let's say these are &'my.dom1.example'& and
29592 &'my.dom2.example'&.
29593 .next
29594 Relay mail for a number of other domains for which you are the secondary MX.
29595 These might be &'friend1.example'& and &'friend2.example'&.
29596 .next
29597 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29598 Suppose your LAN is 192.168.45.0/24.
29599 .endlist
29600
29601
29602 In the main part of the configuration, you put the following definitions:
29603 .code
29604 domainlist local_domains    = my.dom1.example : my.dom2.example
29605 domainlist relay_to_domains = friend1.example : friend2.example
29606 hostlist   relay_from_hosts = 192.168.45.0/24
29607 .endd
29608 Now you can use these definitions in the ACL that is run for every RCPT
29609 command:
29610 .code
29611 acl_check_rcpt:
29612   accept domains = +local_domains : +relay_to_domains
29613   accept hosts   = +relay_from_hosts
29614 .endd
29615 The first statement accepts any RCPT command that contains an address in
29616 the local or relay domains. For any other domain, control passes to the second
29617 statement, which accepts the command only if it comes from one of the relay
29618 hosts. In practice, you will probably want to make your ACL more sophisticated
29619 than this, for example, by including sender and recipient verification. The
29620 default configuration includes a more comprehensive example, which is described
29621 in chapter &<<CHAPdefconfil>>&.
29622
29623
29624
29625 .section "Checking a relay configuration" "SECTcheralcon"
29626 .cindex "relaying" "checking control of"
29627 You can check the relay characteristics of your configuration in the same way
29628 that you can test any ACL behaviour for an incoming SMTP connection, by using
29629 the &%-bh%& option to run a fake SMTP session with which you interact.
29630
29631 For specifically testing for unwanted relaying, the host
29632 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29633 host from the host on which Exim is running, using the normal telnet port, you
29634 will see a normal telnet connection message and then quite a long delay. Be
29635 patient. The remote host is making an SMTP connection back to your host, and
29636 trying a number of common probes to test for open relay vulnerability. The
29637 results of the tests will eventually appear on your terminal.
29638 .ecindex IIDacl
29639
29640
29641
29642 . ////////////////////////////////////////////////////////////////////////////
29643 . ////////////////////////////////////////////////////////////////////////////
29644
29645 .chapter "Content scanning at ACL time" "CHAPexiscan"
29646 .scindex IIDcosca "content scanning" "at ACL time"
29647 The extension of Exim to include content scanning at ACL time, formerly known
29648 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29649 was integrated into the main source for Exim release 4.50, and Tom continues to
29650 maintain it. Most of the wording of this chapter is taken from Tom's
29651 specification.
29652
29653 It is also possible to scan the content of messages at other times. The
29654 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29655 scanning after all the ACLs have run. A transport filter can be used to scan
29656 messages at delivery time (see the &%transport_filter%& option, described in
29657 chapter &<<CHAPtransportgeneric>>&).
29658
29659 If you want to include the ACL-time content-scanning features when you compile
29660 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29661 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29662
29663 .ilist
29664 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29665 for all MIME parts for SMTP and non-SMTP messages, respectively.
29666 .next
29667 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29668 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29669 run at the end of message reception (the &%acl_smtp_data%& ACL).
29670 .next
29671 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29672 of messages, or parts of messages, for debugging purposes.
29673 .next
29674 Additional expansion variables that are set in the new ACL and by the new
29675 conditions.
29676 .next
29677 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29678 .endlist
29679
29680 There is another content-scanning configuration option for &_Local/Makefile_&,
29681 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29682 condition is compiled, in addition to all the other content-scanning features.
29683
29684 Content-scanning is continually evolving, and new features are still being
29685 added. While such features are still unstable and liable to incompatible
29686 changes, they are made available in Exim by setting options whose names begin
29687 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29688 this manual. You can find out about them by reading the file called
29689 &_doc/experimental.txt_&.
29690
29691 All the content-scanning facilities work on a MBOX copy of the message that is
29692 temporarily created in a file called:
29693 .display
29694 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29695 .endd
29696 The &_.eml_& extension is a friendly hint to virus scanners that they can
29697 expect an MBOX-like structure inside that file. The file is created when the
29698 first content scanning facility is called. Subsequent calls to content
29699 scanning conditions open the same file again. The directory is recursively
29700 removed when the &%acl_smtp_data%& ACL has finished running, unless
29701 .code
29702 control = no_mbox_unspool
29703 .endd
29704 has been encountered. When the MIME ACL decodes files, they are put into the
29705 same directory by default.
29706
29707
29708
29709 .section "Scanning for viruses" "SECTscanvirus"
29710 .cindex "virus scanning"
29711 .cindex "content scanning" "for viruses"
29712 .cindex "content scanning" "the &%malware%& condition"
29713 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29714 It supports a &"generic"& interface to scanners called via the shell, and
29715 specialized interfaces for &"daemon"& type virus scanners, which are resident
29716 in memory and thus are much faster.
29717
29718
29719 .oindex "&%av_scanner%&"
29720 You can set the &%av_scanner%& option in first part of the Exim configuration
29721 file to specify which scanner to use, together with any additional options that
29722 are needed. The basic syntax is as follows:
29723 .display
29724 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29725 .endd
29726 If you do not set &%av_scanner%&, it defaults to
29727 .code
29728 av_scanner = sophie:/var/run/sophie
29729 .endd
29730 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29731 before use.
29732 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
29733 The following scanner types are supported in this release:
29734
29735 .vlist
29736 .vitem &%aveserver%&
29737 .cindex "virus scanners" "Kaspersky"
29738 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29739 at &url(http://www.kaspersky.com). This scanner type takes one option,
29740 which is the path to the daemon's UNIX socket. The default is shown in this
29741 example:
29742 .code
29743 av_scanner = aveserver:/var/run/aveserver
29744 .endd
29745
29746
29747 .vitem &%clamd%&
29748 .cindex "virus scanners" "clamd"
29749 This daemon-type scanner is GPL and free. You can get it at
29750 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29751 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29752 in the MIME ACL. This no longer believed to be necessary. One option is
29753 required: either the path and name of a UNIX socket file, or a hostname or IP
29754 number, and a port, separated by space, as in the second of these examples:
29755 .code
29756 av_scanner = clamd:/opt/clamd/socket
29757 av_scanner = clamd:192.0.2.3 1234
29758 av_scanner = clamd:192.0.2.3 1234:local
29759 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
29760 .endd
29761 If the value of av_scanner points to a UNIX socket file or contains the local
29762 keyword, then the ClamAV interface will pass a filename containing the data
29763 to be scanned, which will should normally result in less I/O happening and be
29764 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29765 Exim does not assume that there is a common filesystem with the remote host.
29766 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29767 you be running a version of ClamAV prior to 0.95.
29768
29769 .new
29770 The final example shows that multiple TCP targets can be specified.  Exim will
29771 randomly use one for each incoming email (i.e. it load balances them).  Note
29772 that only TCP targets may be used if specifying a list of scanners; a UNIX
29773 socket cannot be mixed in with TCP targets.  If one of the servers becomes
29774 unavailable, Exim will try the remaining one(s) until it finds one that works.
29775 When a clamd server becomes unreachable, Exim will log a message.  Exim does
29776 not keep track of scanner state between multiple messages, and the scanner
29777 selection is random, so the message will get logged in the mainlog for each
29778 email that the down scanner gets chosen first (message wrapped to be readable):
29779 .code
29780 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
29781    clamd: connection to localhost, port 3310 failed
29782    (Connection refused)
29783 .endd
29784 .wen
29785
29786 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29787 contributing the code for this scanner.
29788
29789 .vitem &%cmdline%&
29790 .cindex "virus scanners" "command line interface"
29791 This is the keyword for the generic command line scanner interface. It can be
29792 used to attach virus scanners that are invoked from the shell. This scanner
29793 type takes 3 mandatory options:
29794
29795 .olist
29796 The full path and name of the scanner binary, with all command line options,
29797 and a placeholder (&`%s`&) for the directory to scan.
29798
29799 .next
29800 A regular expression to match against the STDOUT and STDERR output of the
29801 virus scanner. If the expression matches, a virus was found. You must make
29802 absolutely sure that this expression matches on &"virus found"&. This is called
29803 the &"trigger"& expression.
29804
29805 .next
29806 Another regular expression, containing exactly one pair of parentheses, to
29807 match the name of the virus found in the scanners output. This is called the
29808 &"name"& expression.
29809 .endlist olist
29810
29811 For example, Sophos Sweep reports a virus on a line like this:
29812 .code
29813 Virus 'W32/Magistr-B' found in file ./those.bat
29814 .endd
29815 For the trigger expression, we can match the phrase &"found in file"&. For the
29816 name expression, we want to extract the W32/Magistr-B string, so we can match
29817 for the single quotes left and right of it. Altogether, this makes the
29818 configuration setting:
29819 .code
29820 av_scanner = cmdline:\
29821              /path/to/sweep -ss -all -rec -archive %s:\
29822              found in file:'(.+)'
29823 .endd
29824 .vitem &%drweb%&
29825 .cindex "virus scanners" "DrWeb"
29826 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29827 argument, either a full path to a UNIX socket, or an IP address and port
29828 separated by white space, as in these examples:
29829 .code
29830 av_scanner = drweb:/var/run/drwebd.sock
29831 av_scanner = drweb:192.168.2.20 31337
29832 .endd
29833 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29834 is used. Thanks to Alex Miller for contributing the code for this scanner.
29835
29836 .vitem &%fsecure%&
29837 .cindex "virus scanners" "F-Secure"
29838 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29839 argument which is the path to a UNIX socket. For example:
29840 .code
29841 av_scanner = fsecure:/path/to/.fsav
29842 .endd
29843 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29844 Thelmen for contributing the code for this scanner.
29845
29846 .vitem &%kavdaemon%&
29847 .cindex "virus scanners" "Kaspersky"
29848 This is the scanner daemon of Kaspersky Version 4. This version of the
29849 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29850 scanner type takes one option, which is the path to the daemon's UNIX socket.
29851 For example:
29852 .code
29853 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29854 .endd
29855 The default path is &_/var/run/AvpCtl_&.
29856
29857 .vitem &%mksd%&
29858 .cindex "virus scanners" "mksd"
29859 This is a daemon type scanner that is aimed mainly at Polish users, though some
29860 parts of documentation are now available in English. You can get it at
29861 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29862 the maximum number of processes used simultaneously to scan the attachments,
29863 provided that the demime facility is employed and also provided that mksd has
29864 been run with at least the same number of child processes. For example:
29865 .code
29866 av_scanner = mksd:2
29867 .endd
29868 You can safely omit this option (the default value is 1).
29869
29870 .vitem &%sophie%&
29871 .cindex "virus scanners" "Sophos and Sophie"
29872 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29873 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29874 for this scanner type is the path to the UNIX socket that Sophie uses for
29875 client communication. For example:
29876 .code
29877 av_scanner = sophie:/tmp/sophie
29878 .endd
29879 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29880 the option.
29881 .endlist
29882
29883 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29884 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29885 ACL.
29886
29887 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29888 makes it possible to use different scanners. See further below for an example.
29889 The &%malware%& condition caches its results, so when you use it multiple times
29890 for the same message, the actual scanning process is only carried out once.
29891 However, using expandable items in &%av_scanner%& disables this caching, in
29892 which case each use of the &%malware%& condition causes a new scan of the
29893 message.
29894
29895 The &%malware%& condition takes a right-hand argument that is expanded before
29896 use. It can then be one of
29897
29898 .ilist
29899 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29900 The condition succeeds if a virus was found, and fail otherwise. This is the
29901 recommended usage.
29902 .next
29903 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29904 the condition fails immediately.
29905 .next
29906 A regular expression, in which case the message is scanned for viruses. The
29907 condition succeeds if a virus is found and its name matches the regular
29908 expression. This allows you to take special actions on certain types of virus.
29909 .endlist
29910
29911 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29912 even if there is a problem with the virus scanner. Otherwise, such a problem
29913 causes the ACL to defer.
29914
29915 .vindex "&$malware_name$&"
29916 When a virus is found, the condition sets up an expansion variable called
29917 &$malware_name$& that contains the name of the virus. You can use it in a
29918 &%message%& modifier that specifies the error returned to the sender, and/or in
29919 logging data.
29920
29921 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29922 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29923 &%malware%& condition.
29924
29925 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29926 imposed by your anti-virus scanner.
29927
29928 Here is a very simple scanning example:
29929 .code
29930 deny message = This message contains malware ($malware_name)
29931      demime = *
29932      malware = *
29933 .endd
29934 The next example accepts messages when there is a problem with the scanner:
29935 .code
29936 deny message = This message contains malware ($malware_name)
29937      demime = *
29938      malware = */defer_ok
29939 .endd
29940 The next example shows how to use an ACL variable to scan with both sophie and
29941 aveserver. It assumes you have set:
29942 .code
29943 av_scanner = $acl_m0
29944 .endd
29945 in the main Exim configuration.
29946 .code
29947 deny message = This message contains malware ($malware_name)
29948      set acl_m0 = sophie
29949      malware = *
29950
29951 deny message = This message contains malware ($malware_name)
29952      set acl_m0 = aveserver
29953      malware = *
29954 .endd
29955
29956
29957 .section "Scanning with SpamAssassin" "SECTscanspamass"
29958 .cindex "content scanning" "for spam"
29959 .cindex "spam scanning"
29960 .cindex "SpamAssassin"
29961 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29962 score and a report for the message. You can get SpamAssassin at
29963 &url(http://www.spamassassin.org), or, if you have a working Perl
29964 installation, you can use CPAN by running:
29965 .code
29966 perl -MCPAN -e 'install Mail::SpamAssassin'
29967 .endd
29968 SpamAssassin has its own set of configuration files. Please review its
29969 documentation to see how you can tweak it. The default installation should work
29970 nicely, however.
29971
29972 .oindex "&%spamd_address%&"
29973 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29974 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29975 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29976 part of the Exim configuration as follows (example):
29977 .code
29978 spamd_address = 192.168.99.45 387
29979 .endd
29980 You do not need to set this option if you use the default. As of version 2.60,
29981 &%spamd%& also supports communication over UNIX sockets. If you want to use
29982 these, supply &%spamd_address%& with an absolute file name instead of a
29983 address/port pair:
29984 .code
29985 spamd_address = /var/run/spamd_socket
29986 .endd
29987 You can have multiple &%spamd%& servers to improve scalability. These can
29988 reside on other hardware reachable over the network. To specify multiple
29989 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29990 option, separated with colons:
29991 .code
29992 spamd_address = 192.168.2.10 783 : \
29993                 192.168.2.11 783 : \
29994                 192.168.2.12 783
29995 .endd
29996 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29997 fashion. When a server fails to respond to the connection attempt, all other
29998 servers are tried until one succeeds. If no server responds, the &%spam%&
29999 condition defers.
30000
30001 &*Warning*&: It is not possible to use the UNIX socket connection method with
30002 multiple &%spamd%& servers.
30003
30004 The &%spamd_address%& variable is expanded before use if it starts with
30005 a dollar sign. In this case, the expansion may return a string that is
30006 used as the list so that multiple spamd servers can be the result of an
30007 expansion.
30008
30009 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30010 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30011 .code
30012 deny message = This message was classified as SPAM
30013      spam = joe
30014 .endd
30015 The right-hand side of the &%spam%& condition specifies a name. This is
30016 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30017 to scan using a specific profile, but rather use the SpamAssassin system-wide
30018 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30019 However, you must put something on the right-hand side.
30020
30021 The name allows you to use per-domain or per-user antispam profiles in
30022 principle, but this is not straightforward in practice, because a message may
30023 have multiple recipients, not necessarily all in the same domain. Because the
30024 &%spam%& condition has to be called from a DATA ACL in order to be able to
30025 read the contents of the message, the variables &$local_part$& and &$domain$&
30026 are not set.
30027
30028 The right-hand side of the &%spam%& condition is expanded before being used, so
30029 you can put lookups or conditions there. When the right-hand side evaluates to
30030 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30031
30032
30033 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30034 large ones may cause significant performance degradation. As most spam messages
30035 are quite small, it is recommended that you do not scan the big ones. For
30036 example:
30037 .code
30038 deny message = This message was classified as SPAM
30039      condition = ${if < {$message_size}{10K}}
30040      spam = nobody
30041 .endd
30042
30043 The &%spam%& condition returns true if the threshold specified in the user's
30044 SpamAssassin profile has been matched or exceeded. If you want to use the
30045 &%spam%& condition for its side effects (see the variables below), you can make
30046 it always return &"true"& by appending &`:true`& to the username.
30047
30048 .cindex "spam scanning" "returned variables"
30049 When the &%spam%& condition is run, it sets up a number of expansion
30050 variables. These variables are saved with the received message, thus they are
30051 available for use at delivery time.
30052
30053 .vlist
30054 .vitem &$spam_score$&
30055 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30056 for inclusion in log or reject messages.
30057
30058 .vitem &$spam_score_int$&
30059 The spam score of the message, multiplied by ten, as an integer value. For
30060 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30061 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30062 The integer value is useful for numeric comparisons in conditions.
30063
30064 .vitem &$spam_bar$&
30065 A string consisting of a number of &"+"& or &"-"& characters, representing the
30066 integer part of the spam score value. A spam score of 4.4 would have a
30067 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30068 headers, since MUAs can match on such strings.
30069
30070 .vitem &$spam_report$&
30071 A multiline text table, containing the full SpamAssassin report for the
30072 message. Useful for inclusion in headers or reject messages.
30073 .endlist
30074
30075 The &%spam%& condition caches its results unless expansion in
30076 spamd_address was used. If you call it again with the same user name, it
30077 does not scan again, but rather returns the same values as before.
30078
30079 The &%spam%& condition returns DEFER if there is any error while running
30080 the message through SpamAssassin or if the expansion of spamd_address
30081 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30082 statement block), append &`/defer_ok`& to the right-hand side of the
30083 spam condition, like this:
30084 .code
30085 deny message = This message was classified as SPAM
30086      spam    = joe/defer_ok
30087 .endd
30088 This causes messages to be accepted even if there is a problem with &%spamd%&.
30089
30090 Here is a longer, commented example of the use of the &%spam%&
30091 condition:
30092 .code
30093 # put headers in all messages (no matter if spam or not)
30094 warn  spam = nobody:true
30095       add_header = X-Spam-Score: $spam_score ($spam_bar)
30096       add_header = X-Spam-Report: $spam_report
30097
30098 # add second subject line with *SPAM* marker when message
30099 # is over threshold
30100 warn  spam = nobody
30101       add_header = Subject: *SPAM* $h_Subject:
30102
30103 # reject spam at high scores (> 12)
30104 deny  message = This message scored $spam_score spam points.
30105       spam = nobody:true
30106       condition = ${if >{$spam_score_int}{120}{1}{0}}
30107 .endd
30108
30109
30110
30111 .section "Scanning MIME parts" "SECTscanmimepart"
30112 .cindex "content scanning" "MIME parts"
30113 .cindex "MIME content scanning"
30114 .oindex "&%acl_smtp_mime%&"
30115 .oindex "&%acl_not_smtp_mime%&"
30116 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30117 each MIME part of an SMTP message, including multipart types, in the sequence
30118 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30119 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30120 options may both refer to the same ACL if you want the same processing in both
30121 cases.
30122
30123 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30124 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30125 the case of a non-SMTP message. However, a MIME ACL is called only if the
30126 message contains a &'Content-Type:'& header line. When a call to a MIME
30127 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30128 result code is sent to the client. In the case of an SMTP message, the
30129 &%acl_smtp_data%& ACL is not called when this happens.
30130
30131 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30132 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30133 condition to match against the raw MIME part. You can also use the
30134 &%mime_regex%& condition to match against the decoded MIME part (see section
30135 &<<SECTscanregex>>&).
30136
30137 At the start of a MIME ACL, a number of variables are set from the header
30138 information for the relevant MIME part. These are described below. The contents
30139 of the MIME part are not by default decoded into a disk file except for MIME
30140 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30141 part into a disk file, you can use the &%decode%& condition. The general
30142 syntax is:
30143 .display
30144 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30145 .endd
30146 The right hand side is expanded before use. After expansion,
30147 the value can be:
30148
30149 .olist
30150 &"0"& or &"false"&, in which case no decoding is done.
30151 .next
30152 The string &"default"&. In that case, the file is put in the temporary
30153 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30154 a sequential file name consisting of the message id and a sequence number. The
30155 full path and name is available in &$mime_decoded_filename$& after decoding.
30156 .next
30157 A full path name starting with a slash. If the full name is an existing
30158 directory, it is used as a replacement for the default directory. The filename
30159 is then sequentially assigned. If the path does not exist, it is used as
30160 the full path and file name.
30161 .next
30162 If the string does not start with a slash, it is used as the
30163 filename, and the default path is then used.
30164 .endlist
30165 The &%decode%& condition normally succeeds. It is only false for syntax
30166 errors or unusual circumstances such as memory shortages. You can easily decode
30167 a file with its original, proposed filename using
30168 .code
30169 decode = $mime_filename
30170 .endd
30171 However, you should keep in mind that &$mime_filename$& might contain
30172 anything. If you place files outside of the default path, they are not
30173 automatically unlinked.
30174
30175 For RFC822 attachments (these are messages attached to messages, with a
30176 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30177 as for the primary message, only that the &$mime_is_rfc822$& expansion
30178 variable is set (see below). Attached messages are always decoded to disk
30179 before being checked, and the files are unlinked once the check is done.
30180
30181 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30182 used to match regular expressions against raw and decoded MIME parts,
30183 respectively. They are described in section &<<SECTscanregex>>&.
30184
30185 .cindex "MIME content scanning" "returned variables"
30186 The following list describes all expansion variables that are
30187 available in the MIME ACL:
30188
30189 .vlist
30190 .vitem &$mime_boundary$&
30191 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30192 have a boundary string, which is stored in this variable. If the current part
30193 has no boundary parameter in the &'Content-Type:'& header, this variable
30194 contains the empty string.
30195
30196 .vitem &$mime_charset$&
30197 This variable contains the character set identifier, if one was found in the
30198 &'Content-Type:'& header. Examples for charset identifiers are:
30199 .code
30200 us-ascii
30201 gb2312 (Chinese)
30202 iso-8859-1
30203 .endd
30204 Please note that this value is not normalized, so you should do matches
30205 case-insensitively.
30206
30207 .vitem &$mime_content_description$&
30208 This variable contains the normalized content of the &'Content-Description:'&
30209 header. It can contain a human-readable description of the parts content. Some
30210 implementations repeat the filename for attachments here, but they are usually
30211 only used for display purposes.
30212
30213 .vitem &$mime_content_disposition$&
30214 This variable contains the normalized content of the &'Content-Disposition:'&
30215 header. You can expect strings like &"attachment"& or &"inline"& here.
30216
30217 .vitem &$mime_content_id$&
30218 This variable contains the normalized content of the &'Content-ID:'& header.
30219 This is a unique ID that can be used to reference a part from another part.
30220
30221 .vitem &$mime_content_size$&
30222 This variable is set only after the &%decode%& modifier (see above) has been
30223 successfully run. It contains the size of the decoded part in kilobytes. The
30224 size is always rounded up to full kilobytes, so only a completely empty part
30225 has a &$mime_content_size$& of zero.
30226
30227 .vitem &$mime_content_transfer_encoding$&
30228 This variable contains the normalized content of the
30229 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30230 type. Typical values are &"base64"& and &"quoted-printable"&.
30231
30232 .vitem &$mime_content_type$&
30233 If the MIME part has a &'Content-Type:'& header, this variable contains its
30234 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30235 are some examples of popular MIME types, as they may appear in this variable:
30236 .code
30237 text/plain
30238 text/html
30239 application/octet-stream
30240 image/jpeg
30241 audio/midi
30242 .endd
30243 If the MIME part has no &'Content-Type:'& header, this variable contains the
30244 empty string.
30245
30246 .vitem &$mime_decoded_filename$&
30247 This variable is set only after the &%decode%& modifier (see above) has been
30248 successfully run. It contains the full path and file name of the file
30249 containing the decoded data.
30250 .endlist
30251
30252 .cindex "RFC 2047"
30253 .vlist
30254 .vitem &$mime_filename$&
30255 This is perhaps the most important of the MIME variables. It contains a
30256 proposed filename for an attachment, if one was found in either the
30257 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30258 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30259 found, this variable contains the empty string.
30260
30261 .vitem &$mime_is_coverletter$&
30262 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30263 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30264 content in the cover letter, while not restricting attachments at all.
30265
30266 The variable contains 1 (true) for a MIME part believed to be part of the
30267 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30268 follows:
30269
30270 .olist
30271 The outermost MIME part of a message is always a cover letter.
30272
30273 .next
30274 If a multipart/alternative or multipart/related MIME part is a cover letter,
30275 so are all MIME subparts within that multipart.
30276
30277 .next
30278 If any other multipart is a cover letter, the first subpart is a cover letter,
30279 and the rest are attachments.
30280
30281 .next
30282 All parts contained within an attachment multipart are attachments.
30283 .endlist olist
30284
30285 As an example, the following will ban &"HTML mail"& (including that sent with
30286 alternative plain text), while allowing HTML files to be attached. HTML
30287 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30288 .code
30289 deny message = HTML mail is not accepted here
30290 !condition = $mime_is_rfc822
30291 condition = $mime_is_coverletter
30292 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30293 .endd
30294 .vitem &$mime_is_multipart$&
30295 This variable has the value 1 (true) when the current part has the main type
30296 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30297 Since multipart entities only serve as containers for other parts, you may not
30298 want to carry out specific actions on them.
30299
30300 .vitem &$mime_is_rfc822$&
30301 This variable has the value 1 (true) if the current part is not a part of the
30302 checked message itself, but part of an attached message. Attached message
30303 decoding is fully recursive.
30304
30305 .vitem &$mime_part_count$&
30306 This variable is a counter that is raised for each processed MIME part. It
30307 starts at zero for the very first part (which is usually a multipart). The
30308 counter is per-message, so it is reset when processing RFC822 attachments (see
30309 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30310 complete, so you can use it in the DATA ACL to determine the number of MIME
30311 parts of a message. For non-MIME messages, this variable contains the value -1.
30312 .endlist
30313
30314
30315
30316 .section "Scanning with regular expressions" "SECTscanregex"
30317 .cindex "content scanning" "with regular expressions"
30318 .cindex "regular expressions" "content scanning with"
30319 You can specify your own custom regular expression matches on the full body of
30320 the message, or on individual MIME parts.
30321
30322 The &%regex%& condition takes one or more regular expressions as arguments and
30323 matches them against the full message (when called in the DATA ACL) or a raw
30324 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30325 linewise, with a maximum line length of 32K characters. That means you cannot
30326 have multiline matches with the &%regex%& condition.
30327
30328 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30329 to 32K of decoded content (the whole content at once, not linewise). If the
30330 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30331 is decoded automatically when &%mime_regex%& is executed (using default path
30332 and filename values). If the decoded data is larger than  32K, only the first
30333 32K characters are checked.
30334
30335 The regular expressions are passed as a colon-separated list. To include a
30336 literal colon, you must double it. Since the whole right-hand side string is
30337 expanded before being used, you must also escape dollar signs and backslashes
30338 with more backslashes, or use the &`\N`& facility to disable expansion.
30339 Here is a simple example that contains two regular expressions:
30340 .code
30341 deny message = contains blacklisted regex ($regex_match_string)
30342      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30343 .endd
30344 The conditions returns true if any one of the regular expressions matches. The
30345 &$regex_match_string$& expansion variable is then set up and contains the
30346 matching regular expression.
30347
30348 &*Warning*&: With large messages, these conditions can be fairly
30349 CPU-intensive.
30350
30351
30352
30353
30354 .section "The demime condition" "SECTdemimecond"
30355 .cindex "content scanning" "MIME checking"
30356 .cindex "MIME content scanning"
30357 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30358 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30359 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30360 ACL functionality, but provides no additional facilities. Please note that this
30361 condition is deprecated and kept only for backward compatibility. You must set
30362 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30363 use the &%demime%& condition.
30364
30365 The &%demime%& condition unpacks MIME containers in the message. It detects
30366 errors in MIME containers and can match file extensions found in the message
30367 against a list. Using this facility produces files containing the unpacked MIME
30368 parts of the message in the temporary scan directory. If you do antivirus
30369 scanning, it is recommended that you use the &%demime%& condition before the
30370 antivirus (&%malware%&) condition.
30371
30372 On the right-hand side of the &%demime%& condition you can pass a
30373 colon-separated list of file extensions that it should match against. For
30374 example:
30375 .code
30376 deny message = Found blacklisted file attachment
30377      demime  = vbs:com:bat:pif:prf:lnk
30378 .endd
30379 If one of the file extensions is found, the condition is true, otherwise it is
30380 false. If there is a temporary error while demimeing (for example, &"disk
30381 full"&), the condition defers, and the message is temporarily rejected (unless
30382 the condition is on a &%warn%& verb).
30383
30384 The right-hand side is expanded before being treated as a list, so you can have
30385 conditions and lookups there. If it expands to an empty string, &"false"&, or
30386 zero (&"0"&), no demimeing is done and the condition is false.
30387
30388 The &%demime%& condition set the following variables:
30389
30390 .vlist
30391 .vitem &$demime_errorlevel$&
30392 .vindex "&$demime_errorlevel$&"
30393 When an error is detected in a MIME container, this variable contains the
30394 severity of the error, as an integer number. The higher the value, the more
30395 severe the error (the current maximum value is 3). If this variable is unset or
30396 zero, no error occurred.
30397
30398 .vitem &$demime_reason$&
30399 .vindex "&$demime_reason$&"
30400 When &$demime_errorlevel$& is greater than zero, this variable contains a
30401 human-readable text string describing the MIME error that occurred.
30402 .endlist
30403
30404 .vlist
30405 .vitem &$found_extension$&
30406 .vindex "&$found_extension$&"
30407 When the &%demime%& condition is true, this variable contains the file
30408 extension it found.
30409 .endlist
30410
30411 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30412 the &%demime%& condition, and are not changed on subsequent calls.
30413
30414 If you do not want to check for file extensions, but rather use the &%demime%&
30415 condition for unpacking or error checking purposes, pass &"*"& as the
30416 right-hand side value. Here is a more elaborate example of how to use this
30417 facility:
30418 .code
30419 # Reject messages with serious MIME container errors
30420 deny  message = Found MIME error ($demime_reason).
30421       demime = *
30422       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30423
30424 # Reject known virus spreading file extensions.
30425 # Accepting these is pretty much braindead.
30426 deny  message = contains $found_extension file (blacklisted).
30427       demime  = com:vbs:bat:pif:scr
30428
30429 # Freeze .exe and .doc files. Postmaster can
30430 # examine them and eventually thaw them.
30431 deny  log_message = Another $found_extension file.
30432       demime = exe:doc
30433       control = freeze
30434 .endd
30435 .ecindex IIDcosca
30436
30437
30438
30439
30440 . ////////////////////////////////////////////////////////////////////////////
30441 . ////////////////////////////////////////////////////////////////////////////
30442
30443 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30444          "Local scan function"
30445 .scindex IIDlosca "&[local_scan()]& function" "description of"
30446 .cindex "customizing" "input scan using C function"
30447 .cindex "policy control" "by local scan function"
30448 In these days of email worms, viruses, and ever-increasing spam, some sites
30449 want to apply a lot of checking to messages before accepting them.
30450
30451 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30452 passing messages to external virus and spam scanning software. You can also do
30453 a certain amount in Exim itself through string expansions and the &%condition%&
30454 condition in the ACL that runs after the SMTP DATA command or the ACL for
30455 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30456
30457 To allow for further customization to a site's own requirements, there is the
30458 possibility of linking Exim with a private message scanning function, written
30459 in C. If you want to run code that is written in something other than C, you
30460 can of course use a little C stub to call it.
30461
30462 The local scan function is run once for every incoming message, at the point
30463 when Exim is just about to accept the message.
30464 It can therefore be used to control non-SMTP messages from local processes as
30465 well as messages arriving via SMTP.
30466
30467 Exim applies a timeout to calls of the local scan function, and there is an
30468 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30469 Zero means &"no timeout"&.
30470 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30471 before calling the local scan function, so that the most common types of crash
30472 are caught. If the timeout is exceeded or one of those signals is caught, the
30473 incoming message is rejected with a temporary error if it is an SMTP message.
30474 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30475 code. The incident is logged on the main and reject logs.
30476
30477
30478
30479 .section "Building Exim to use a local scan function" "SECID207"
30480 .cindex "&[local_scan()]& function" "building Exim to use"
30481 To make use of the local scan function feature, you must tell Exim where your
30482 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30483 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30484 directory, so you might set
30485 .code
30486 LOCAL_SCAN_SOURCE=Local/local_scan.c
30487 .endd
30488 for example. The function must be called &[local_scan()]&. It is called by
30489 Exim after it has received a message, when the success return code is about to
30490 be sent. This is after all the ACLs have been run. The return code from your
30491 function controls whether the message is actually accepted or not. There is a
30492 commented template function (that just accepts the message) in the file
30493 _src/local_scan.c_.
30494
30495 If you want to make use of Exim's run time configuration file to set options
30496 for your &[local_scan()]& function, you must also set
30497 .code
30498 LOCAL_SCAN_HAS_OPTIONS=yes
30499 .endd
30500 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30501
30502
30503
30504
30505 .section "API for local_scan()" "SECTapiforloc"
30506 .cindex "&[local_scan()]& function" "API description"
30507 You must include this line near the start of your code:
30508 .code
30509 #include "local_scan.h"
30510 .endd
30511 This header file defines a number of variables and other values, and the
30512 prototype for the function itself. Exim is coded to use unsigned char values
30513 almost exclusively, and one of the things this header defines is a shorthand
30514 for &`unsigned char`& called &`uschar`&.
30515 It also contains the following macro definitions, to simplify casting character
30516 strings and pointers to character strings:
30517 .code
30518 #define CS   (char *)
30519 #define CCS  (const char *)
30520 #define CSS  (char **)
30521 #define US   (unsigned char *)
30522 #define CUS  (const unsigned char *)
30523 #define USS  (unsigned char **)
30524 .endd
30525 The function prototype for &[local_scan()]& is:
30526 .code
30527 extern int local_scan(int fd, uschar **return_text);
30528 .endd
30529 The arguments are as follows:
30530
30531 .ilist
30532 &%fd%& is a file descriptor for the file that contains the body of the message
30533 (the -D file). The file is open for reading and writing, but updating it is not
30534 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30535
30536 The descriptor is positioned at character 19 of the file, which is the first
30537 character of the body itself, because the first 19 characters are the message
30538 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30539 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30540 case this changes in some future version.
30541 .next
30542 &%return_text%& is an address which you can use to return a pointer to a text
30543 string at the end of the function. The value it points to on entry is NULL.
30544 .endlist
30545
30546 The function must return an &%int%& value which is one of the following macros:
30547
30548 .vlist
30549 .vitem &`LOCAL_SCAN_ACCEPT`&
30550 .vindex "&$local_scan_data$&"
30551 The message is accepted. If you pass back a string of text, it is saved with
30552 the message, and made available in the variable &$local_scan_data$&. No
30553 newlines are permitted (if there are any, they are turned into spaces) and the
30554 maximum length of text is 1000 characters.
30555
30556 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30557 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30558 queued without immediate delivery, and is frozen.
30559
30560 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30561 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30562 queued without immediate delivery.
30563
30564 .vitem &`LOCAL_SCAN_REJECT`&
30565 The message is rejected; the returned text is used as an error message which is
30566 passed back to the sender and which is also logged. Newlines are permitted &--
30567 they cause a multiline response for SMTP rejections, but are converted to
30568 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30569 used.
30570
30571 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30572 The message is temporarily rejected; the returned text is used as an error
30573 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30574 problem"& is used.
30575
30576 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30577 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30578 message is not written to the reject log. It has the effect of unsetting the
30579 &%rejected_header%& log selector for just this rejection. If
30580 &%rejected_header%& is already unset (see the discussion of the
30581 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30582 same as LOCAL_SCAN_REJECT.
30583
30584 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30585 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30586 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30587 .endlist
30588
30589 If the message is not being received by interactive SMTP, rejections are
30590 reported by writing to &%stderr%& or by sending an email, as configured by the
30591 &%-oe%& command line options.
30592
30593
30594
30595 .section "Configuration options for local_scan()" "SECTconoptloc"
30596 .cindex "&[local_scan()]& function" "configuration options"
30597 It is possible to have option settings in the main configuration file
30598 that set values in static variables in the &[local_scan()]& module. If you
30599 want to do this, you must have the line
30600 .code
30601 LOCAL_SCAN_HAS_OPTIONS=yes
30602 .endd
30603 in your &_Local/Makefile_& when you build Exim. (This line is in
30604 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30605 file, you must define static variables to hold the option values, and a table
30606 to define them.
30607
30608 The table must be a vector called &%local_scan_options%&, of type
30609 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30610 and a pointer to the variable that holds the value. The entries must appear in
30611 alphabetical order. Following &%local_scan_options%& you must also define a
30612 variable called &%local_scan_options_count%& that contains the number of
30613 entries in the table. Here is a short example, showing two kinds of option:
30614 .code
30615 static int my_integer_option = 42;
30616 static uschar *my_string_option = US"a default string";
30617
30618 optionlist local_scan_options[] = {
30619   { "my_integer", opt_int,       &my_integer_option },
30620   { "my_string",  opt_stringptr, &my_string_option }
30621 };
30622
30623 int local_scan_options_count =
30624   sizeof(local_scan_options)/sizeof(optionlist);
30625 .endd
30626 The values of the variables can now be changed from Exim's runtime
30627 configuration file by including a local scan section as in this example:
30628 .code
30629 begin local_scan
30630 my_integer = 99
30631 my_string = some string of text...
30632 .endd
30633 The available types of option data are as follows:
30634
30635 .vlist
30636 .vitem &*opt_bool*&
30637 This specifies a boolean (true/false) option. The address should point to a
30638 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30639 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30640 whether such a variable has been set at all, you can initialize it to
30641 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30642 values.)
30643
30644 .vitem &*opt_fixed*&
30645 This specifies a fixed point number, such as is used for load averages.
30646 The address should point to a variable of type &`int`&. The value is stored
30647 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30648
30649 .vitem &*opt_int*&
30650 This specifies an integer; the address should point to a variable of type
30651 &`int`&. The value may be specified in any of the integer formats accepted by
30652 Exim.
30653
30654 .vitem &*opt_mkint*&
30655 This is the same as &%opt_int%&, except that when such a value is output in a
30656 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30657 printed with the suffix K or M.
30658
30659 .vitem &*opt_octint*&
30660 This also specifies an integer, but the value is always interpreted as an
30661 octal integer, whether or not it starts with the digit zero, and it is
30662 always output in octal.
30663
30664 .vitem &*opt_stringptr*&
30665 This specifies a string value; the address must be a pointer to a
30666 variable that points to a string (for example, of type &`uschar *`&).
30667
30668 .vitem &*opt_time*&
30669 This specifies a time interval value. The address must point to a variable of
30670 type &`int`&. The value that is placed there is a number of seconds.
30671 .endlist
30672
30673 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30674 out the values of all the &[local_scan()]& options.
30675
30676
30677
30678 .section "Available Exim variables" "SECID208"
30679 .cindex "&[local_scan()]& function" "available Exim variables"
30680 The header &_local_scan.h_& gives you access to a number of C variables. These
30681 are the only ones that are guaranteed to be maintained from release to release.
30682 Note, however, that you can obtain the value of any Exim expansion variable,
30683 including &$recipients$&, by calling &'expand_string()'&. The exported
30684 C variables are as follows:
30685
30686 .vlist
30687 .vitem &*int&~body_linecount*&
30688 This variable contains the number of lines in the message's body.
30689
30690 .vitem &*int&~body_zerocount*&
30691 This variable contains the number of binary zero bytes in the message's body.
30692
30693 .vitem &*unsigned&~int&~debug_selector*&
30694 This variable is set to zero when no debugging is taking place. Otherwise, it
30695 is a bitmap of debugging selectors. Two bits are identified for use in
30696 &[local_scan()]&; they are defined as macros:
30697
30698 .ilist
30699 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30700 testing option that is not privileged &-- any caller may set it. All the
30701 other selector bits can be set only by admin users.
30702
30703 .next
30704 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30705 by the &`+local_scan`& debug selector. It is not included in the default set
30706 of debugging bits.
30707 .endlist ilist
30708
30709 Thus, to write to the debugging output only when &`+local_scan`& has been
30710 selected, you should use code like this:
30711 .code
30712 if ((debug_selector & D_local_scan) != 0)
30713   debug_printf("xxx", ...);
30714 .endd
30715 .vitem &*uschar&~*expand_string_message*&
30716 After a failing call to &'expand_string()'& (returned value NULL), the
30717 variable &%expand_string_message%& contains the error message, zero-terminated.
30718
30719 .vitem &*header_line&~*header_list*&
30720 A pointer to a chain of header lines. The &%header_line%& structure is
30721 discussed below.
30722
30723 .vitem &*header_line&~*header_last*&
30724 A pointer to the last of the header lines.
30725
30726 .vitem &*uschar&~*headers_charset*&
30727 The value of the &%headers_charset%& configuration option.
30728
30729 .vitem &*BOOL&~host_checking*&
30730 This variable is TRUE during a host checking session that is initiated by the
30731 &%-bh%& command line option.
30732
30733 .vitem &*uschar&~*interface_address*&
30734 The IP address of the interface that received the message, as a string. This
30735 is NULL for locally submitted messages.
30736
30737 .vitem &*int&~interface_port*&
30738 The port on which this message was received. When testing with the &%-bh%&
30739 command line option, the value of this variable is -1 unless a port has been
30740 specified via the &%-oMi%& option.
30741
30742 .vitem &*uschar&~*message_id*&
30743 This variable contains Exim's message id for the incoming message (the value of
30744 &$message_exim_id$&) as a zero-terminated string.
30745
30746 .vitem &*uschar&~*received_protocol*&
30747 The name of the protocol by which the message was received.
30748
30749 .vitem &*int&~recipients_count*&
30750 The number of accepted recipients.
30751
30752 .vitem &*recipient_item&~*recipients_list*&
30753 .cindex "recipient" "adding in local scan"
30754 .cindex "recipient" "removing in local scan"
30755 The list of accepted recipients, held in a vector of length
30756 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30757 can add additional recipients by calling &'receive_add_recipient()'& (see
30758 below). You can delete recipients by removing them from the vector and
30759 adjusting the value in &%recipients_count%&. In particular, by setting
30760 &%recipients_count%& to zero you remove all recipients. If you then return the
30761 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30762 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30763 and then call &'receive_add_recipient()'& as often as needed.
30764
30765 .vitem &*uschar&~*sender_address*&
30766 The envelope sender address. For bounce messages this is the empty string.
30767
30768 .vitem &*uschar&~*sender_host_address*&
30769 The IP address of the sending host, as a string. This is NULL for
30770 locally-submitted messages.
30771
30772 .vitem &*uschar&~*sender_host_authenticated*&
30773 The name of the authentication mechanism that was used, or NULL if the message
30774 was not received over an authenticated SMTP connection.
30775
30776 .vitem &*uschar&~*sender_host_name*&
30777 The name of the sending host, if known.
30778
30779 .vitem &*int&~sender_host_port*&
30780 The port on the sending host.
30781
30782 .vitem &*BOOL&~smtp_input*&
30783 This variable is TRUE for all SMTP input, including BSMTP.
30784
30785 .vitem &*BOOL&~smtp_batched_input*&
30786 This variable is TRUE for BSMTP input.
30787
30788 .vitem &*int&~store_pool*&
30789 The contents of this variable control which pool of memory is used for new
30790 requests. See section &<<SECTmemhanloc>>& for details.
30791 .endlist
30792
30793
30794 .section "Structure of header lines" "SECID209"
30795 The &%header_line%& structure contains the members listed below.
30796 You can add additional header lines by calling the &'header_add()'& function
30797 (see below). You can cause header lines to be ignored (deleted) by setting
30798 their type to *.
30799
30800
30801 .vlist
30802 .vitem &*struct&~header_line&~*next*&
30803 A pointer to the next header line, or NULL for the last line.
30804
30805 .vitem &*int&~type*&
30806 A code identifying certain headers that Exim recognizes. The codes are printing
30807 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30808 Notice in particular that any header line whose type is * is not transmitted
30809 with the message. This flagging is used for header lines that have been
30810 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30811 lines.) Effectively, * means &"deleted"&.
30812
30813 .vitem &*int&~slen*&
30814 The number of characters in the header line, including the terminating and any
30815 internal newlines.
30816
30817 .vitem &*uschar&~*text*&
30818 A pointer to the text of the header. It always ends with a newline, followed by
30819 a zero byte. Internal newlines are preserved.
30820 .endlist
30821
30822
30823
30824 .section "Structure of recipient items" "SECID210"
30825 The &%recipient_item%& structure contains these members:
30826
30827 .vlist
30828 .vitem &*uschar&~*address*&
30829 This is a pointer to the recipient address as it was received.
30830
30831 .vitem &*int&~pno*&
30832 This is used in later Exim processing when top level addresses are created by
30833 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30834 and must always contain -1 at this stage.
30835
30836 .vitem &*uschar&~*errors_to*&
30837 If this value is not NULL, bounce messages caused by failing to deliver to the
30838 recipient are sent to the address it contains. In other words, it overrides the
30839 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30840 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30841 an unqualified address, Exim qualifies it using the domain from
30842 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30843 is NULL for all recipients.
30844 .endlist
30845
30846
30847
30848 .section "Available Exim functions" "SECID211"
30849 .cindex "&[local_scan()]& function" "available Exim functions"
30850 The header &_local_scan.h_& gives you access to a number of Exim functions.
30851 These are the only ones that are guaranteed to be maintained from release to
30852 release:
30853
30854 .vlist
30855 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30856        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30857
30858 This function creates a child process that runs the command specified by
30859 &%argv%&. The environment for the process is specified by &%envp%&, which can
30860 be NULL if no environment variables are to be passed. A new umask is supplied
30861 for the process in &%newumask%&.
30862
30863 Pipes to the standard input and output of the new process are set up
30864 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30865 standard error is cloned to the standard output. If there are any file
30866 descriptors &"in the way"& in the new process, they are closed. If the final
30867 argument is TRUE, the new process is made into a process group leader.
30868
30869 The function returns the pid of the new process, or -1 if things go wrong.
30870
30871 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30872 This function waits for a child process to terminate, or for a timeout (in
30873 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30874 return value is as follows:
30875
30876 .ilist
30877 >= 0
30878
30879 The process terminated by a normal exit and the value is the process
30880 ending status.
30881
30882 .next
30883 < 0 and > &--256
30884
30885 The process was terminated by a signal and the value is the negation of the
30886 signal number.
30887
30888 .next
30889 &--256
30890
30891 The process timed out.
30892 .next
30893 &--257
30894
30895 The was some other error in wait(); &%errno%& is still set.
30896 .endlist
30897
30898 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30899 This function provide you with a means of submitting a new message to
30900 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30901 want, but this packages it all up for you.) The function creates a pipe,
30902 forks a subprocess that is running
30903 .code
30904 exim -t -oem -oi -f <>
30905 .endd
30906 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30907 that is connected to the standard input. The yield of the function is the PID
30908 of the subprocess. You can then write a message to the file descriptor, with
30909 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30910
30911 When you have finished, call &'child_close()'& to wait for the process to
30912 finish and to collect its ending status. A timeout value of zero is usually
30913 fine in this circumstance. Unless you have made a mistake with the recipient
30914 addresses, you should get a return code of zero.
30915
30916
30917 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30918        *sender_authentication)*&
30919 This function is a more sophisticated version of &'child_open()'&. The command
30920 that it runs is:
30921 .display
30922 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30923 .endd
30924 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30925
30926
30927 .vitem &*void&~debug_printf(char&~*,&~...)*&
30928 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30929 output is written to the standard error stream. If no debugging is selected,
30930 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30931 conditional on the &`local_scan`& debug selector by coding like this:
30932 .code
30933 if ((debug_selector & D_local_scan) != 0)
30934   debug_printf("xxx", ...);
30935 .endd
30936
30937 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30938 This is an interface to Exim's string expansion code. The return value is the
30939 expanded string, or NULL if there was an expansion failure.
30940 The C variable &%expand_string_message%& contains an error message after an
30941 expansion failure. If expansion does not change the string, the return value is
30942 the pointer to the input string. Otherwise, the return value points to a new
30943 block of memory that was obtained by a call to &'store_get()'&. See section
30944 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30945
30946 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30947 This function allows you to an add additional header line at the end of the
30948 existing ones. The first argument is the type, and should normally be a space
30949 character. The second argument is a format string and any number of
30950 substitution arguments as for &[sprintf()]&. You may include internal newlines
30951 if you want, and you must ensure that the string ends with a newline.
30952
30953 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30954         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30955 This function adds a new header line at a specified point in the header
30956 chain. The header itself is specified as for &'header_add()'&.
30957
30958 If &%name%& is NULL, the new header is added at the end of the chain if
30959 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30960 NULL, the header lines are searched for the first non-deleted header that
30961 matches the name. If one is found, the new header is added before it if
30962 &%after%& is false. If &%after%& is true, the new header is added after the
30963 found header and any adjacent subsequent ones with the same name (even if
30964 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30965 option controls where the header is added. If it is true, addition is at the
30966 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30967 headers, or at the top if there are no &'Received:'& headers, you could use
30968 .code
30969 header_add_at_position(TRUE, US"Received", TRUE,
30970   ' ', "X-xxx: ...");
30971 .endd
30972 Normally, there is always at least one non-deleted &'Received:'& header, but
30973 there may not be if &%received_header_text%& expands to an empty string.
30974
30975
30976 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30977 This function removes header lines. If &%occurrence%& is zero or negative, all
30978 occurrences of the header are removed. If occurrence is greater than zero, that
30979 particular instance of the header is removed. If no header(s) can be found that
30980 match the specification, the function does nothing.
30981
30982
30983 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30984         int&~length,&~BOOL&~notdel)*&"
30985 This function tests whether the given header has the given name. It is not just
30986 a string comparison, because white space is permitted between the name and the
30987 colon. If the &%notdel%& argument is true, a false return is forced for all
30988 &"deleted"& headers; otherwise they are not treated specially. For example:
30989 .code
30990 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30991 .endd
30992 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30993 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30994 This function base64-encodes a string, which is passed by address and length.
30995 The text may contain bytes of any value, including zero. The result is passed
30996 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30997 zero-terminated.
30998
30999 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31000 This function decodes a base64-encoded string. Its arguments are a
31001 zero-terminated base64-encoded string and the address of a variable that is set
31002 to point to the result, which is in dynamic memory. The length of the decoded
31003 string is the yield of the function. If the input is invalid base64 data, the
31004 yield is -1. A zero byte is added to the end of the output string to make it
31005 easy to interpret as a C string (assuming it contains no zeros of its own). The
31006 added zero byte is not included in the returned count.
31007
31008 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31009 This function checks for a match in a domain list. Domains are always
31010 matched caselessly. The return value is one of the following:
31011 .display
31012 &`OK     `& match succeeded
31013 &`FAIL   `& match failed
31014 &`DEFER  `& match deferred
31015 .endd
31016 DEFER is usually caused by some kind of lookup defer, such as the
31017 inability to contact a database.
31018
31019 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31020         BOOL&~caseless)*&"
31021 This function checks for a match in a local part list. The third argument
31022 controls case-sensitivity. The return values are as for
31023 &'lss_match_domain()'&.
31024
31025 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31026         BOOL&~caseless)*&"
31027 This function checks for a match in an address list. The third argument
31028 controls the case-sensitivity of the local part match. The domain is always
31029 matched caselessly. The return values are as for &'lss_match_domain()'&.
31030
31031 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31032         uschar&~*list)*&"
31033 This function checks for a match in a host list. The most common usage is
31034 expected to be
31035 .code
31036 lss_match_host(sender_host_name, sender_host_address, ...)
31037 .endd
31038 .vindex "&$sender_host_address$&"
31039 An empty address field matches an empty item in the host list. If the host name
31040 is NULL, the name corresponding to &$sender_host_address$& is automatically
31041 looked up if a host name is required to match an item in the list. The return
31042 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31043 returns ERROR in the case when it had to look up a host name, but the lookup
31044 failed.
31045
31046 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31047         *format,&~...)*&"
31048 This function writes to Exim's log files. The first argument should be zero (it
31049 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31050 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31051 them. It specifies to which log or logs the message is written. The remaining
31052 arguments are a format and relevant insertion arguments. The string should not
31053 contain any newlines, not even at the end.
31054
31055
31056 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31057 This function adds an additional recipient to the message. The first argument
31058 is the recipient address. If it is unqualified (has no domain), it is qualified
31059 with the &%qualify_recipient%& domain. The second argument must always be -1.
31060
31061 This function does not allow you to specify a private &%errors_to%& address (as
31062 described with the structure of &%recipient_item%& above), because it pre-dates
31063 the addition of that field to the structure. However, it is easy to add such a
31064 value afterwards. For example:
31065 .code
31066  receive_add_recipient(US"monitor@mydom.example", -1);
31067  recipients_list[recipients_count-1].errors_to =
31068    US"postmaster@mydom.example";
31069 .endd
31070
31071 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31072 This is a convenience function to remove a named recipient from the list of
31073 recipients. It returns true if a recipient was removed, and false if no
31074 matching recipient could be found. The argument must be a complete email
31075 address.
31076 .endlist
31077
31078
31079 .cindex "RFC 2047"
31080 .vlist
31081 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31082   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31083 This function decodes strings that are encoded according to RFC 2047. Typically
31084 these are the contents of header lines. First, each &"encoded word"& is decoded
31085 from the Q or B encoding into a byte-string. Then, if provided with the name of
31086 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31087 made  to translate the result to the named character set. If this fails, the
31088 binary string is returned with an error message.
31089
31090 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31091 maximum MIME word length is enforced. The third argument is the target
31092 encoding, or NULL if no translation is wanted.
31093
31094 .cindex "binary zero" "in RFC 2047 decoding"
31095 .cindex "RFC 2047" "binary zero in"
31096 If a binary zero is encountered in the decoded string, it is replaced by the
31097 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31098 not be 0 because header lines are handled as zero-terminated strings.
31099
31100 The function returns the result of processing the string, zero-terminated; if
31101 &%lenptr%& is not NULL, the length of the result is set in the variable to
31102 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31103
31104 If an error is encountered, the function returns NULL and uses the &%error%&
31105 argument to return an error message. The variable pointed to by &%error%& is
31106 set to NULL if there is no error; it may be set non-NULL even when the function
31107 returns a non-NULL value if decoding was successful, but there was a problem
31108 with translation.
31109
31110
31111 .vitem &*int&~smtp_fflush(void)*&
31112 This function is used in conjunction with &'smtp_printf()'&, as described
31113 below.
31114
31115 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31116 The arguments of this function are like &[printf()]&; it writes to the SMTP
31117 output stream. You should use this function only when there is an SMTP output
31118 stream, that is, when the incoming message is being received via interactive
31119 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31120 is FALSE. If you want to test for an incoming message from another host (as
31121 opposed to a local process that used the &%-bs%& command line option), you can
31122 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31123 is involved.
31124
31125 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31126 output function, so it can be used for all forms of SMTP connection.
31127
31128 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31129 must start with an appropriate response code: 550 if you are going to return
31130 LOCAL_SCAN_REJECT, 451 if you are going to return
31131 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31132 initial lines of a multi-line response, the code must be followed by a hyphen
31133 to indicate that the line is not the final response line. You must also ensure
31134 that the lines you write terminate with CRLF. For example:
31135 .code
31136 smtp_printf("550-this is some extra info\r\n");
31137 return LOCAL_SCAN_REJECT;
31138 .endd
31139 Note that you can also create multi-line responses by including newlines in
31140 the data returned via the &%return_text%& argument. The added value of using
31141 &'smtp_printf()'& is that, for instance, you could introduce delays between
31142 multiple output lines.
31143
31144 The &'smtp_printf()'& function does not return any error indication, because it
31145 does not automatically flush pending output, and therefore does not test
31146 the state of the stream. (In the main code of Exim, flushing and error
31147 detection is done when Exim is ready for the next SMTP input command.) If
31148 you want to flush the output and check for an error (for example, the
31149 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31150 arguments. It flushes the output stream, and returns a non-zero value if there
31151 is an error.
31152
31153 .vitem &*void&~*store_get(int)*&
31154 This function accesses Exim's internal store (memory) manager. It gets a new
31155 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31156 runs out of memory. See the next section for a discussion of memory handling.
31157
31158 .vitem &*void&~*store_get_perm(int)*&
31159 This function is like &'store_get()'&, but it always gets memory from the
31160 permanent pool. See the next section for a discussion of memory handling.
31161
31162 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31163 See below.
31164
31165 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31166 See below.
31167
31168 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31169 These three functions create strings using Exim's dynamic memory facilities.
31170 The first makes a copy of an entire string. The second copies up to a maximum
31171 number of characters, indicated by the second argument. The third uses a format
31172 and insertion arguments to create a new string. In each case, the result is a
31173 pointer to a new string in the current memory pool. See the next section for
31174 more discussion.
31175 .endlist
31176
31177
31178
31179 .section "More about Exim's memory handling" "SECTmemhanloc"
31180 .cindex "&[local_scan()]& function" "memory handling"
31181 No function is provided for freeing memory, because that is never needed.
31182 The dynamic memory that Exim uses when receiving a message is automatically
31183 recycled if another message is received by the same process (this applies only
31184 to incoming SMTP connections &-- other input methods can supply only one
31185 message at a time). After receiving the last message, a reception process
31186 terminates.
31187
31188 Because it is recycled, the normal dynamic memory cannot be used for holding
31189 data that must be preserved over a number of incoming messages on the same SMTP
31190 connection. However, Exim in fact uses two pools of dynamic memory; the second
31191 one is not recycled, and can be used for this purpose.
31192
31193 If you want to allocate memory that remains available for subsequent messages
31194 in the same SMTP connection, you should set
31195 .code
31196 store_pool = POOL_PERM
31197 .endd
31198 before calling the function that does the allocation. There is no need to
31199 restore the value if you do not need to; however, if you do want to revert to
31200 the normal pool, you can either restore the previous value of &%store_pool%& or
31201 set it explicitly to POOL_MAIN.
31202
31203 The pool setting applies to all functions that get dynamic memory, including
31204 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31205 There is also a convenience function called &'store_get_perm()'& that gets a
31206 block of memory from the permanent pool while preserving the value of
31207 &%store_pool%&.
31208 .ecindex IIDlosca
31209
31210
31211
31212
31213 . ////////////////////////////////////////////////////////////////////////////
31214 . ////////////////////////////////////////////////////////////////////////////
31215
31216 .chapter "System-wide message filtering" "CHAPsystemfilter"
31217 .scindex IIDsysfil1 "filter" "system filter"
31218 .scindex IIDsysfil2 "filtering all mail"
31219 .scindex IIDsysfil3 "system filter"
31220 The previous chapters (on ACLs and the local scan function) describe checks
31221 that can be applied to messages before they are accepted by a host. There is
31222 also a mechanism for checking messages once they have been received, but before
31223 they are delivered. This is called the &'system filter'&.
31224
31225 The system filter operates in a similar manner to users' filter files, but it
31226 is run just once per message (however many recipients the message has).
31227 It should not normally be used as a substitute for routing, because &%deliver%&
31228 commands in a system router provide new envelope recipient addresses.
31229 The system filter must be an Exim filter. It cannot be a Sieve filter.
31230
31231 The system filter is run at the start of a delivery attempt, before any routing
31232 is done. If a message fails to be completely delivered at the first attempt,
31233 the system filter is run again at the start of every retry.
31234 If you want your filter to do something only once per message, you can make use
31235 of the &%first_delivery%& condition in an &%if%& command in the filter to
31236 prevent it happening on retries.
31237
31238 .vindex "&$domain$&"
31239 .vindex "&$local_part$&"
31240 &*Warning*&: Because the system filter runs just once, variables that are
31241 specific to individual recipient addresses, such as &$local_part$& and
31242 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31243 you want to run a centrally-specified filter for each recipient address
31244 independently, you can do so by setting up a suitable &(redirect)& router, as
31245 described in section &<<SECTperaddfil>>& below.
31246
31247
31248 .section "Specifying a system filter" "SECID212"
31249 .cindex "uid (user id)" "system filter"
31250 .cindex "gid (group id)" "system filter"
31251 The name of the file that contains the system filter must be specified by
31252 setting &%system_filter%&. If you want the filter to run under a uid and gid
31253 other than root, you must also set &%system_filter_user%& and
31254 &%system_filter_group%& as appropriate. For example:
31255 .code
31256 system_filter = /etc/mail/exim.filter
31257 system_filter_user = exim
31258 .endd
31259 If a system filter generates any deliveries directly to files or pipes (via the
31260 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31261 specified by setting &%system_filter_file_transport%& and
31262 &%system_filter_pipe_transport%&, respectively. Similarly,
31263 &%system_filter_reply_transport%& must be set to handle any messages generated
31264 by the &%reply%& command.
31265
31266
31267 .section "Testing a system filter" "SECID213"
31268 You can run simple tests of a system filter in the same way as for a user
31269 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31270 are permitted only in system filters are recognized.
31271
31272 If you want to test the combined effect of a system filter and a user filter,
31273 you can use both &%-bF%& and &%-bf%& on the same command line.
31274
31275
31276
31277 .section "Contents of a system filter" "SECID214"
31278 The language used to specify system filters is the same as for users' filter
31279 files. It is described in the separate end-user document &'Exim's interface to
31280 mail filtering'&. However, there are some additional features that are
31281 available only in system filters; these are described in subsequent sections.
31282 If they are encountered in a user's filter file or when testing with &%-bf%&,
31283 they cause errors.
31284
31285 .cindex "frozen messages" "manual thaw; testing in filter"
31286 There are two special conditions which, though available in users' filter
31287 files, are designed for use in system filters. The condition &%first_delivery%&
31288 is true only for the first attempt at delivering a message, and
31289 &%manually_thawed%& is true only if the message has been frozen, and
31290 subsequently thawed by an admin user. An explicit forced delivery counts as a
31291 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31292
31293 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31294 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31295 succeed, it will not be tried again.
31296 If you want Exim to retry an unseen delivery until it succeeds, you should
31297 arrange to set it up every time the filter runs.
31298
31299 When a system filter finishes running, the values of the variables &$n0$& &--
31300 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31301 users' filter files. Thus a system filter can, for example, set up &"scores"&
31302 to which users' filter files can refer.
31303
31304
31305
31306 .section "Additional variable for system filters" "SECID215"
31307 .vindex "&$recipients$&"
31308 The expansion variable &$recipients$&, containing a list of all the recipients
31309 of the message (separated by commas and white space), is available in system
31310 filters. It is not available in users' filters for privacy reasons.
31311
31312
31313
31314 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31315 .cindex "freezing messages"
31316 .cindex "message" "freezing"
31317 .cindex "message" "forced failure"
31318 .cindex "&%fail%&" "in system filter"
31319 .cindex "&%freeze%& in system filter"
31320 .cindex "&%defer%& in system filter"
31321 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31322 always available in system filters, but are not normally enabled in users'
31323 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31324 for the &(redirect)& router.) These commands can optionally be followed by the
31325 word &%text%& and a string containing an error message, for example:
31326 .code
31327 fail text "this message looks like spam to me"
31328 .endd
31329 The keyword &%text%& is optional if the next character is a double quote.
31330
31331 The &%defer%& command defers delivery of the original recipients of the
31332 message. The &%fail%& command causes all the original recipients to be failed,
31333 and a bounce message to be created. The &%freeze%& command suspends all
31334 delivery attempts for the original recipients. In all cases, any new deliveries
31335 that are specified by the filter are attempted as normal after the filter has
31336 run.
31337
31338 The &%freeze%& command is ignored if the message has been manually unfrozen and
31339 not manually frozen since. This means that automatic freezing by a system
31340 filter can be used as a way of checking out suspicious messages. If a message
31341 is found to be all right, manually unfreezing it allows it to be delivered.
31342
31343 .cindex "log" "&%fail%& command log line"
31344 .cindex "&%fail%&" "log line; reducing"
31345 The text given with a fail command is used as part of the bounce message as
31346 well as being written to the log. If the message is quite long, this can fill
31347 up a lot of log space when such failures are common. To reduce the size of the
31348 log message, Exim interprets the text in a special way if it starts with the
31349 two characters &`<<`& and contains &`>>`& later. The text between these two
31350 strings is written to the log, and the rest of the text is used in the bounce
31351 message. For example:
31352 .code
31353 fail "<<filter test 1>>Your message is rejected \
31354      because it contains attachments that we are \
31355      not prepared to receive."
31356 .endd
31357
31358 .cindex "loop" "caused by &%fail%&"
31359 Take great care with the &%fail%& command when basing the decision to fail on
31360 the contents of the message, because the bounce message will of course include
31361 the contents of the original message and will therefore trigger the &%fail%&
31362 command again (causing a mail loop) unless steps are taken to prevent this.
31363 Testing the &%error_message%& condition is one way to prevent this. You could
31364 use, for example
31365 .code
31366 if $message_body contains "this is spam" and not error_message
31367 then fail text "spam is not wanted here" endif
31368 .endd
31369 though of course that might let through unwanted bounce messages. The
31370 alternative is clever checking of the body and/or headers to detect bounces
31371 generated by the filter.
31372
31373 The interpretation of a system filter file ceases after a
31374 &%defer%&,
31375 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31376 set up earlier in the filter file are honoured, so you can use a sequence such
31377 as
31378 .code
31379 mail ...
31380 freeze
31381 .endd
31382 to send a specified message when the system filter is freezing (or deferring or
31383 failing) a message. The normal deliveries for the message do not, of course,
31384 take place.
31385
31386
31387
31388 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31389 .cindex "header lines" "adding; in system filter"
31390 .cindex "header lines" "removing; in system filter"
31391 .cindex "filter" "header lines; adding/removing"
31392 Two filter commands that are available only in system filters are:
31393 .code
31394 headers add <string>
31395 headers remove <string>
31396 .endd
31397 The argument for the &%headers add%& is a string that is expanded and then
31398 added to the end of the message's headers. It is the responsibility of the
31399 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31400 space is ignored, and if the string is otherwise empty, or if the expansion is
31401 forced to fail, the command has no effect.
31402
31403 You can use &"\n"& within the string, followed by white space, to specify
31404 continued header lines. More than one header may be added in one command by
31405 including &"\n"& within the string without any following white space. For
31406 example:
31407 .code
31408 headers add "X-header-1: ....\n  \
31409              continuation of X-header-1 ...\n\
31410              X-header-2: ...."
31411 .endd
31412 Note that the header line continuation white space after the first newline must
31413 be placed before the backslash that continues the input string, because white
31414 space after input continuations is ignored.
31415
31416 The argument for &%headers remove%& is a colon-separated list of header names.
31417 This command applies only to those headers that are stored with the message;
31418 those that are added at delivery time (such as &'Envelope-To:'& and
31419 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31420 header with the same name, they are all removed.
31421
31422 The &%headers%& command in a system filter makes an immediate change to the set
31423 of header lines that was received with the message (with possible additions
31424 from ACL processing). Subsequent commands in the system filter operate on the
31425 modified set, which also forms the basis for subsequent message delivery.
31426 Unless further modified during routing or transporting, this set of headers is
31427 used for all recipients of the message.
31428
31429 During routing and transporting, the variables that refer to the contents of
31430 header lines refer only to those lines that are in this set. Thus, header lines
31431 that are added by a system filter are visible to users' filter files and to all
31432 routers and transports. This contrasts with the manipulation of header lines by
31433 routers and transports, which is not immediate, but which instead is saved up
31434 until the message is actually being written (see section
31435 &<<SECTheadersaddrem>>&).
31436
31437 If the message is not delivered at the first attempt, header lines that were
31438 added by the system filter are stored with the message, and so are still
31439 present at the next delivery attempt. Header lines that were removed are still
31440 present, but marked &"deleted"& so that they are not transported with the
31441 message. For this reason, it is usual to make the &%headers%& command
31442 conditional on &%first_delivery%& so that the set of header lines is not
31443 modified more than once.
31444
31445 Because header modification in a system filter acts immediately, you have to
31446 use an indirect approach if you want to modify the contents of a header line.
31447 For example:
31448 .code
31449 headers add "Old-Subject: $h_subject:"
31450 headers remove "Subject"
31451 headers add "Subject: new subject (was: $h_old-subject:)"
31452 headers remove "Old-Subject"
31453 .endd
31454
31455
31456
31457 .section "Setting an errors address in a system filter" "SECID217"
31458 .cindex "envelope sender"
31459 In a system filter, if a &%deliver%& command is followed by
31460 .code
31461 errors_to <some address>
31462 .endd
31463 in order to change the envelope sender (and hence the error reporting) for that
31464 delivery, any address may be specified. (In a user filter, only the current
31465 user's address can be set.) For example, if some mail is being monitored, you
31466 might use
31467 .code
31468 unseen deliver monitor@spying.example errors_to root@local.example
31469 .endd
31470 to take a copy which would not be sent back to the normal error reporting
31471 address if its delivery failed.
31472
31473
31474
31475 .section "Per-address filtering" "SECTperaddfil"
31476 .vindex "&$domain$&"
31477 .vindex "&$local_part$&"
31478 In contrast to the system filter, which is run just once per message for each
31479 delivery attempt, it is also possible to set up a system-wide filtering
31480 operation that runs once for each recipient address. In this case, variables
31481 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31482 filter file could be made dependent on them. This is an example of a router
31483 which implements such a filter:
31484 .code
31485 central_filter:
31486   check_local_user
31487   driver = redirect
31488   domains = +local_domains
31489   file = /central/filters/$local_part
31490   no_verify
31491   allow_filter
31492   allow_freeze
31493 .endd
31494 The filter is run in a separate process under its own uid. Therefore, either
31495 &%check_local_user%& must be set (as above), in which case the filter is run as
31496 the local user, or the &%user%& option must be used to specify which user to
31497 use. If both are set, &%user%& overrides.
31498
31499 Care should be taken to ensure that none of the commands in the filter file
31500 specify a significant delivery if the message is to go on to be delivered to
31501 its intended recipient. The router will not then claim to have dealt with the
31502 address, so it will be passed on to subsequent routers to be delivered in the
31503 normal way.
31504 .ecindex IIDsysfil1
31505 .ecindex IIDsysfil2
31506 .ecindex IIDsysfil3
31507
31508
31509
31510
31511
31512
31513 . ////////////////////////////////////////////////////////////////////////////
31514 . ////////////////////////////////////////////////////////////////////////////
31515
31516 .chapter "Message processing" "CHAPmsgproc"
31517 .scindex IIDmesproc "message" "general processing"
31518 Exim performs various transformations on the sender and recipient addresses of
31519 all messages that it handles, and also on the messages' header lines. Some of
31520 these are optional and configurable, while others always take place. All of
31521 this processing, except rewriting as a result of routing, and the addition or
31522 removal of header lines while delivering, happens when a message is received,
31523 before it is placed on Exim's queue.
31524
31525 Some of the automatic processing takes place by default only for
31526 &"locally-originated"& messages. This adjective is used to describe messages
31527 that are not received over TCP/IP, but instead are passed to an Exim process on
31528 its standard input. This includes the interactive &"local SMTP"& case that is
31529 set up by the &%-bs%& command line option.
31530
31531 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31532 or ::1) are not considered to be locally-originated. Exim does not treat the
31533 loopback interface specially in any way.
31534
31535 If you want the loopback interface to be treated specially, you must ensure
31536 that there are appropriate entries in your ACLs.
31537
31538
31539
31540
31541 .section "Submission mode for non-local messages" "SECTsubmodnon"
31542 .cindex "message" "submission"
31543 .cindex "submission mode"
31544 Processing that happens automatically for locally-originated messages (unless
31545 &%suppress_local_fixups%& is set) can also be requested for messages that are
31546 received over TCP/IP. The term &"submission mode"& is used to describe this
31547 state. Submission mode is set by the modifier
31548 .code
31549 control = submission
31550 .endd
31551 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31552 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31553 a local submission, and is normally used when the source of the message is
31554 known to be an MUA running on a client host (as opposed to an MTA). For
31555 example, to set submission mode for messages originating on the IPv4 loopback
31556 interface, you could include the following in the MAIL ACL:
31557 .code
31558 warn  hosts = 127.0.0.1
31559       control = submission
31560 .endd
31561 .cindex "&%sender_retain%& submission option"
31562 There are some options that can be used when setting submission mode. A slash
31563 is used to separate options. For example:
31564 .code
31565 control = submission/sender_retain
31566 .endd
31567 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31568 true and &%local_from_check%& false for the current incoming message. The first
31569 of these allows an existing &'Sender:'& header in the message to remain, and
31570 the second suppresses the check to ensure that &'From:'& matches the
31571 authenticated sender. With this setting, Exim still fixes up messages by adding
31572 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31573 attempt to check sender authenticity in header lines.
31574
31575 When &%sender_retain%& is not set, a submission mode setting may specify a
31576 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31577 example:
31578 .code
31579 control = submission/domain=some.domain
31580 .endd
31581 The domain may be empty. How this value is used is described in sections
31582 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31583 that allows you to specify the user's full name for inclusion in a created
31584 &'Sender:'& or &'From:'& header line. For example:
31585 .code
31586 accept authenticated = *
31587        control = submission/domain=wonderland.example/\
31588                             name=${lookup {$authenticated_id} \
31589                                    lsearch {/etc/exim/namelist}}
31590 .endd
31591 Because the name may contain any characters, including slashes, the &%name%&
31592 option must be given last. The remainder of the string is used as the name. For
31593 the example above, if &_/etc/exim/namelist_& contains:
31594 .code
31595 bigegg:  Humpty Dumpty
31596 .endd
31597 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31598 line would be:
31599 .code
31600 Sender: Humpty Dumpty <bigegg@wonderland.example>
31601 .endd
31602 .cindex "return path" "in submission mode"
31603 By default, submission mode forces the return path to the same address as is
31604 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31605 specified, the return path is also left unchanged.
31606
31607 &*Note*&: The changes caused by submission mode take effect after the predata
31608 ACL. This means that any sender checks performed before the fix-ups use the
31609 untrusted sender address specified by the user, not the trusted sender address
31610 specified by submission mode. Although this might be slightly unexpected, it
31611 does mean that you can configure ACL checks to spot that a user is trying to
31612 spoof another's address.
31613
31614 .section "Line endings" "SECTlineendings"
31615 .cindex "line endings"
31616 .cindex "carriage return"
31617 .cindex "linefeed"
31618 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31619 linefeed) is the line ending for messages transmitted over the Internet using
31620 SMTP over TCP/IP. However, within individual operating systems, different
31621 conventions are used. For example, Unix-like systems use just LF, but others
31622 use CRLF or just CR.
31623
31624 Exim was designed for Unix-like systems, and internally, it stores messages
31625 using the system's convention of a single LF as a line terminator. When
31626 receiving a message, all line endings are translated to this standard format.
31627 Originally, it was thought that programs that passed messages directly to an
31628 MTA within an operating system would use that system's convention. Experience
31629 has shown that this is not the case; for example, there are Unix applications
31630 that use CRLF in this circumstance. For this reason, and for compatibility with
31631 other MTAs, the way Exim handles line endings for all messages is now as
31632 follows:
31633
31634 .ilist
31635 LF not preceded by CR is treated as a line ending.
31636 .next
31637 CR is treated as a line ending; if it is immediately followed by LF, the LF
31638 is ignored.
31639 .next
31640 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31641 nor a local message in the state where a line containing only a dot is a
31642 terminator.
31643 .next
31644 If a bare CR is encountered within a header line, an extra space is added after
31645 the line terminator so as not to end the header line. The reasoning behind this
31646 is that bare CRs in header lines are most likely either to be mistakes, or
31647 people trying to play silly games.
31648 .next
31649 If the first header line received in a message ends with CRLF, a subsequent
31650 bare LF in a header line is treated in the same way as a bare CR in a header
31651 line.
31652 .endlist
31653
31654
31655
31656
31657
31658 .section "Unqualified addresses" "SECID218"
31659 .cindex "unqualified addresses"
31660 .cindex "address" "qualification"
31661 By default, Exim expects every envelope address it receives from an external
31662 host to be fully qualified. Unqualified addresses cause negative responses to
31663 SMTP commands. However, because SMTP is used as a means of transporting
31664 messages from MUAs running on personal workstations, there is sometimes a
31665 requirement to accept unqualified addresses from specific hosts or IP networks.
31666
31667 Exim has two options that separately control which hosts may send unqualified
31668 sender or recipient addresses in SMTP commands, namely
31669 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31670 cases, if an unqualified address is accepted, it is qualified by adding the
31671 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31672
31673 .oindex "&%qualify_domain%&"
31674 .oindex "&%qualify_recipient%&"
31675 Unqualified addresses in header lines are automatically qualified for messages
31676 that are locally originated, unless the &%-bnq%& option is given on the command
31677 line. For messages received over SMTP, unqualified addresses in header lines
31678 are qualified only if unqualified addresses are permitted in SMTP commands. In
31679 other words, such qualification is also controlled by
31680 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31681
31682
31683
31684
31685 .section "The UUCP From line" "SECID219"
31686 .cindex "&""From""& line"
31687 .cindex "UUCP" "&""From""& line"
31688 .cindex "sender" "address"
31689 .oindex "&%uucp_from_pattern%&"
31690 .oindex "&%uucp_from_sender%&"
31691 .cindex "envelope sender"
31692 .cindex "Sendmail compatibility" "&""From""& line"
31693 Messages that have come from UUCP (and some other applications) often begin
31694 with a line containing the envelope sender and a timestamp, following the word
31695 &"From"&. Examples of two common formats are:
31696 .code
31697 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31698 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31699 .endd
31700 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31701 Exim recognizes such lines at the start of messages that are submitted to it
31702 via the command line (that is, on the standard input). It does not recognize
31703 such lines in incoming SMTP messages, unless the sending host matches
31704 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31705 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31706 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31707 default value matches the two common cases shown above and puts the address
31708 that follows &"From"& into &$1$&.
31709
31710 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31711 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31712 a trusted user, the message's sender address is constructed by expanding the
31713 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31714 then parsed as an RFC 2822 address. If there is no domain, the local part is
31715 qualified with &%qualify_domain%& unless it is the empty string. However, if
31716 the command line &%-f%& option is used, it overrides the &"From"& line.
31717
31718 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31719 sender address is not changed. This is also the case for incoming SMTP messages
31720 that are permitted to contain &"From"& lines.
31721
31722 Only one &"From"& line is recognized. If there is more than one, the second is
31723 treated as a data line that starts the body of the message, as it is not valid
31724 as a header line. This also happens if a &"From"& line is present in an
31725 incoming SMTP message from a source that is not permitted to send them.
31726
31727
31728
31729 .section "Resent- header lines" "SECID220"
31730 .cindex "&%Resent-%& header lines"
31731 RFC 2822 makes provision for sets of header lines starting with the string
31732 &`Resent-`& to be added to a message when it is resent by the original
31733 recipient to somebody else. These headers are &'Resent-Date:'&,
31734 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31735 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31736
31737 .blockquote
31738 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31739 processing of replies or other such automatic actions on messages.'&
31740 .endblockquote
31741
31742 This leaves things a bit vague as far as other processing actions such as
31743 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31744 follows:
31745
31746 .ilist
31747 A &'Resent-From:'& line that just contains the login id of the submitting user
31748 is automatically rewritten in the same way as &'From:'& (see below).
31749 .next
31750 If there's a rewriting rule for a particular header line, it is also applied to
31751 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31752 &'From:'& also rewrites &'Resent-From:'&.
31753 .next
31754 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31755 also removed.
31756 .next
31757 For a locally-submitted message,
31758 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31759 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31760 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31761 included in log lines in this case.
31762 .next
31763 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31764 &%Resent-%& header lines are present.
31765 .endlist
31766
31767
31768
31769
31770 .section "The Auto-Submitted: header line" "SECID221"
31771 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31772 includes the header line:
31773 .code
31774 Auto-Submitted: auto-replied
31775 .endd
31776
31777 .section "The Bcc: header line" "SECID222"
31778 .cindex "&'Bcc:'& header line"
31779 If Exim is called with the &%-t%& option, to take recipient addresses from a
31780 message's header, it removes any &'Bcc:'& header line that may exist (after
31781 extracting its addresses). If &%-t%& is not present on the command line, any
31782 existing &'Bcc:'& is not removed.
31783
31784
31785 .section "The Date: header line" "SECID223"
31786 .cindex "&'Date:'& header line"
31787 If a locally-generated or submission-mode message has no &'Date:'& header line,
31788 Exim adds one, using the current date and time, unless the
31789 &%suppress_local_fixups%& control has been specified.
31790
31791 .section "The Delivery-date: header line" "SECID224"
31792 .cindex "&'Delivery-date:'& header line"
31793 .oindex "&%delivery_date_remove%&"
31794 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31795 set. Exim can be configured to add them to the final delivery of messages. (See
31796 the generic &%delivery_date_add%& transport option.) They should not be present
31797 in messages in transit. If the &%delivery_date_remove%& configuration option is
31798 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31799 messages.
31800
31801
31802 .section "The Envelope-to: header line" "SECID225"
31803 .cindex "&'Envelope-to:'& header line"
31804 .oindex "&%envelope_to_remove%&"
31805 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31806 Exim can be configured to add them to the final delivery of messages. (See the
31807 generic &%envelope_to_add%& transport option.) They should not be present in
31808 messages in transit. If the &%envelope_to_remove%& configuration option is set
31809 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31810 messages.
31811
31812
31813 .section "The From: header line" "SECTthefrohea"
31814 .cindex "&'From:'& header line"
31815 .cindex "Sendmail compatibility" "&""From""& line"
31816 .cindex "message" "submission"
31817 .cindex "submission mode"
31818 If a submission-mode message does not contain a &'From:'& header line, Exim
31819 adds one if either of the following conditions is true:
31820
31821 .ilist
31822 The envelope sender address is not empty (that is, this is not a bounce
31823 message). The added header line copies the envelope sender address.
31824 .next
31825 .vindex "&$authenticated_id$&"
31826 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31827 .olist
31828 .vindex "&$qualify_domain$&"
31829 If no domain is specified by the submission control, the local part is
31830 &$authenticated_id$& and the domain is &$qualify_domain$&.
31831 .next
31832 If a non-empty domain is specified by the submission control, the local
31833 part is &$authenticated_id$&, and the domain is the specified domain.
31834 .next
31835 If an empty domain is specified by the submission control,
31836 &$authenticated_id$& is assumed to be the complete address.
31837 .endlist
31838 .endlist
31839
31840 A non-empty envelope sender takes precedence.
31841
31842 If a locally-generated incoming message does not contain a &'From:'& header
31843 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31844 containing the sender's address. The calling user's login name and full name
31845 are used to construct the address, as described in section &<<SECTconstr>>&.
31846 They are obtained from the password data by calling &[getpwuid()]& (but see the
31847 &%unknown_login%& configuration option). The address is qualified with
31848 &%qualify_domain%&.
31849
31850 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31851 &'From:'& header line containing just the unqualified login name of the calling
31852 user, this is replaced by an address containing the user's login name and full
31853 name as described in section &<<SECTconstr>>&.
31854
31855
31856 .section "The Message-ID: header line" "SECID226"
31857 .cindex "&'Message-ID:'& header line"
31858 .cindex "message" "submission"
31859 .oindex "&%message_id_header_text%&"
31860 If a locally-generated or submission-mode incoming message does not contain a
31861 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31862 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31863 to the message. If there are any &'Resent-:'& headers in the message, it
31864 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31865 message id, preceded by the letter E to ensure it starts with a letter, and
31866 followed by @ and the primary host name. Additional information can be included
31867 in this header line by setting the &%message_id_header_text%& and/or
31868 &%message_id_header_domain%& options.
31869
31870
31871 .section "The Received: header line" "SECID227"
31872 .cindex "&'Received:'& header line"
31873 A &'Received:'& header line is added at the start of every message. The
31874 contents are defined by the &%received_header_text%& configuration option, and
31875 Exim automatically adds a semicolon and a timestamp to the configured string.
31876
31877 The &'Received:'& header is generated as soon as the message's header lines
31878 have been received. At this stage, the timestamp in the &'Received:'& header
31879 line is the time that the message started to be received. This is the value
31880 that is seen by the DATA ACL and by the &[local_scan()]& function.
31881
31882 Once a message is accepted, the timestamp in the &'Received:'& header line is
31883 changed to the time of acceptance, which is (apart from a small delay while the
31884 -H spool file is written) the earliest time at which delivery could start.
31885
31886
31887 .section "The References: header line" "SECID228"
31888 .cindex "&'References:'& header line"
31889 Messages created by the &(autoreply)& transport include a &'References:'&
31890 header line. This is constructed according to the rules that are described in
31891 section 3.64 of RFC 2822 (which states that replies should contain such a
31892 header line), and section 3.14 of RFC 3834 (which states that automatic
31893 responses are not different in this respect). However, because some mail
31894 processing software does not cope well with very long header lines, no more
31895 than 12 message IDs are copied from the &'References:'& header line in the
31896 incoming message. If there are more than 12, the first one and then the final
31897 11 are copied, before adding the message ID of the incoming message.
31898
31899
31900
31901 .section "The Return-path: header line" "SECID229"
31902 .cindex "&'Return-path:'& header line"
31903 .oindex "&%return_path_remove%&"
31904 &'Return-path:'& header lines are defined as something an MTA may insert when
31905 it does the final delivery of messages. (See the generic &%return_path_add%&
31906 transport option.) Therefore, they should not be present in messages in
31907 transit. If the &%return_path_remove%& configuration option is set (the
31908 default), Exim removes &'Return-path:'& header lines from incoming messages.
31909
31910
31911
31912 .section "The Sender: header line" "SECTthesenhea"
31913 .cindex "&'Sender:'& header line"
31914 .cindex "message" "submission"
31915 For a locally-originated message from an untrusted user, Exim may remove an
31916 existing &'Sender:'& header line, and it may add a new one. You can modify
31917 these actions by setting the &%local_sender_retain%& option true, the
31918 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31919 control setting.
31920
31921 When a local message is received from an untrusted user and
31922 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31923 control has not been set, a check is made to see if the address given in the
31924 &'From:'& header line is the correct (local) sender of the message. The address
31925 that is expected has the login name as the local part and the value of
31926 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31927 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31928 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31929 line is added to the message.
31930
31931 If you set &%local_from_check%& false, this checking does not occur. However,
31932 the removal of an existing &'Sender:'& line still happens, unless you also set
31933 &%local_sender_retain%& to be true. It is not possible to set both of these
31934 options true at the same time.
31935
31936 .cindex "submission mode"
31937 By default, no processing of &'Sender:'& header lines is done for messages
31938 received over TCP/IP or for messages submitted by trusted users. However, when
31939 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31940 not specified on the submission control, the following processing takes place:
31941
31942 .vindex "&$authenticated_id$&"
31943 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31944 authenticated, and &$authenticated_id$& is not empty, a sender address is
31945 created as follows:
31946
31947 .ilist
31948 .vindex "&$qualify_domain$&"
31949 If no domain is specified by the submission control, the local part is
31950 &$authenticated_id$& and the domain is &$qualify_domain$&.
31951 .next
31952 If a non-empty domain is specified by the submission control, the local part
31953 is &$authenticated_id$&, and the domain is the specified domain.
31954 .next
31955 If an empty domain is specified by the submission control,
31956 &$authenticated_id$& is assumed to be the complete address.
31957 .endlist
31958
31959 This address is compared with the address in the &'From:'& header line. If they
31960 are different, a &'Sender:'& header line containing the created address is
31961 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31962 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31963
31964 .cindex "return path" "created from &'Sender:'&"
31965 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31966 the message (the envelope sender address) is changed to be the same address,
31967 except in the case of submission mode when &%sender_retain%& is specified.
31968
31969
31970
31971 .section "Adding and removing header lines in routers and transports" &&&
31972          "SECTheadersaddrem"
31973 .cindex "header lines" "adding; in router or transport"
31974 .cindex "header lines" "removing; in router or transport"
31975 When a message is delivered, the addition and removal of header lines can be
31976 specified in a system filter, or on any of the routers and transports that
31977 process the message. Section &<<SECTaddremheasys>>& contains details about
31978 modifying headers in a system filter. Header lines can also be added in an ACL
31979 as a message is received (see section &<<SECTaddheadacl>>&).
31980
31981 In contrast to what happens in a system filter, header modifications that are
31982 specified on routers and transports apply only to the particular recipient
31983 addresses that are being processed by those routers and transports. These
31984 changes do not actually take place until a copy of the message is being
31985 transported. Therefore, they do not affect the basic set of header lines, and
31986 they do not affect the values of the variables that refer to header lines.
31987
31988 &*Note*&: In particular, this means that any expansions in the configuration of
31989 the transport cannot refer to the modified header lines, because such
31990 expansions all occur before the message is actually transported.
31991
31992 For both routers and transports, the result of expanding a &%headers_add%&
31993 option must be in the form of one or more RFC 2822 header lines, separated by
31994 newlines (coded as &"\n"&). For example:
31995 .code
31996 headers_add = X-added-header: added by $primary_hostname\n\
31997               X-added-second: another added header line
31998 .endd
31999 Exim does not check the syntax of these added header lines.
32000
32001 .new
32002 Multiple &%headers_add%& options for a single router or transport can be
32003 specified; the values will be concatenated (with a separating newline
32004 added) before expansion.
32005 .wen
32006
32007 The result of expanding &%headers_remove%& must consist of a colon-separated
32008 list of header names. This is confusing, because header names themselves are
32009 often terminated by colons. In this case, the colons are the list separators,
32010 not part of the names. For example:
32011 .code
32012 headers_remove = return-receipt-to:acknowledge-to
32013 .endd
32014
32015 Multiple &%headers_remove%& options for a single router or transport can be
32016 specified; the values will be concatenated (with a separating colon
32017 added) before expansion.
32018
32019 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
32020 is expanded at routing time, and then associated with all addresses that are
32021 accepted by that router, and also with any new addresses that it generates. If
32022 an address passes through several routers as a result of aliasing or
32023 forwarding, the changes are cumulative.
32024
32025 .oindex "&%unseen%&"
32026 However, this does not apply to multiple routers that result from the use of
32027 the &%unseen%& option. Any header modifications that were specified by the
32028 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32029
32030 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32031 settings cannot be delivered together in a batch, so a transport is always
32032 dealing with a set of addresses that have the same header-processing
32033 requirements.
32034
32035 The transport starts by writing the original set of header lines that arrived
32036 with the message, possibly modified by the system filter. As it writes out
32037 these lines, it consults the list of header names that were attached to the
32038 recipient address(es) by &%headers_remove%& options in routers, and it also
32039 consults the transport's own &%headers_remove%& option. Header lines whose
32040 names are on either of these lists are not written out. If there are multiple
32041 instances of any listed header, they are all skipped.
32042
32043 After the remaining original header lines have been written, new header
32044 lines that were specified by routers' &%headers_add%& options are written, in
32045 the order in which they were attached to the address. These are followed by any
32046 header lines specified by the transport's &%headers_add%& option.
32047
32048 This way of handling header line modifications in routers and transports has
32049 the following consequences:
32050
32051 .ilist
32052 The original set of header lines, possibly modified by the system filter,
32053 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32054 to it, at all times.
32055 .next
32056 Header lines that are added by a router's
32057 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32058 expansion syntax in subsequent routers or the transport.
32059 .next
32060 Conversely, header lines that are specified for removal by &%headers_remove%&
32061 in a router remain visible to subsequent routers and the transport.
32062 .next
32063 Headers added to an address by &%headers_add%& in a router cannot be removed by
32064 a later router or by a transport.
32065 .next
32066 An added header can refer to the contents of an original header that is to be
32067 removed, even it has the same name as the added header. For example:
32068 .code
32069 headers_remove = subject
32070 headers_add = Subject: new subject (was: $h_subject:)
32071 .endd
32072 .endlist
32073
32074 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32075 for a &(redirect)& router that has the &%one_time%& option set.
32076
32077
32078
32079
32080
32081 .section "Constructed addresses" "SECTconstr"
32082 .cindex "address" "constructed"
32083 .cindex "constructed address"
32084 When Exim constructs a sender address for a locally-generated message, it uses
32085 the form
32086 .display
32087 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32088 .endd
32089 For example:
32090 .code
32091 Zaphod Beeblebrox <zaphod@end.univ.example>
32092 .endd
32093 The user name is obtained from the &%-F%& command line option if set, or
32094 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32095 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32096 ampersand character, this is replaced by the login name with the first letter
32097 upper cased, as is conventional in a number of operating systems. See the
32098 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32099 The &%unknown_username%& option can be used to specify user names in cases when
32100 there is no password file entry.
32101
32102 .cindex "RFC 2047"
32103 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32104 parts of it if necessary. In addition, if it contains any non-printing
32105 characters, it is encoded as described in RFC 2047, which defines a way of
32106 including non-ASCII characters in header lines. The value of the
32107 &%headers_charset%& option specifies the name of the encoding that is used (the
32108 characters are assumed to be in this encoding). The setting of
32109 &%print_topbitchars%& controls whether characters with the top bit set (that
32110 is, with codes greater than 127) count as printing characters or not.
32111
32112
32113
32114 .section "Case of local parts" "SECID230"
32115 .cindex "case of local parts"
32116 .cindex "local part" "case of"
32117 RFC 2822 states that the case of letters in the local parts of addresses cannot
32118 be assumed to be non-significant. Exim preserves the case of local parts of
32119 addresses, but by default it uses a lower-cased form when it is routing,
32120 because on most Unix systems, usernames are in lower case and case-insensitive
32121 routing is required. However, any particular router can be made to use the
32122 original case for local parts by setting the &%caseful_local_part%& generic
32123 router option.
32124
32125 .cindex "mixed-case login names"
32126 If you must have mixed-case user names on your system, the best way to proceed,
32127 assuming you want case-independent handling of incoming email, is to set up
32128 your first router to convert incoming local parts in your domains to the
32129 correct case by means of a file lookup. For example:
32130 .code
32131 correct_case:
32132   driver = redirect
32133   domains = +local_domains
32134   data = ${lookup{$local_part}cdb\
32135               {/etc/usercased.cdb}{$value}fail}\
32136               @$domain
32137 .endd
32138 For this router, the local part is forced to lower case by the default action
32139 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32140 up a new local part in the correct case. If you then set &%caseful_local_part%&
32141 on any subsequent routers which process your domains, they will operate on
32142 local parts with the correct case in a case-sensitive manner.
32143
32144
32145
32146 .section "Dots in local parts" "SECID231"
32147 .cindex "dot" "in local part"
32148 .cindex "local part" "dots in"
32149 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32150 part may not begin or end with a dot, nor have two consecutive dots in the
32151 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32152 empty components for compatibility.
32153
32154
32155
32156 .section "Rewriting addresses" "SECID232"
32157 .cindex "rewriting" "addresses"
32158 Rewriting of sender and recipient addresses, and addresses in headers, can
32159 happen automatically, or as the result of configuration options, as described
32160 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32161 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32162
32163 Automatic rewriting includes qualification, as mentioned above. The other case
32164 in which it can happen is when an incomplete non-local domain is given. The
32165 routing process may cause this to be expanded into the full domain name. For
32166 example, a header such as
32167 .code
32168 To: hare@teaparty
32169 .endd
32170 might get rewritten as
32171 .code
32172 To: hare@teaparty.wonderland.fict.example
32173 .endd
32174 Rewriting as a result of routing is the one kind of message processing that
32175 does not happen at input time, as it cannot be done until the address has
32176 been routed.
32177
32178 Strictly, one should not do &'any'& deliveries of a message until all its
32179 addresses have been routed, in case any of the headers get changed as a
32180 result of routing. However, doing this in practice would hold up many
32181 deliveries for unreasonable amounts of time, just because one address could not
32182 immediately be routed. Exim therefore does not delay other deliveries when
32183 routing of one or more addresses is deferred.
32184 .ecindex IIDmesproc
32185
32186
32187
32188 . ////////////////////////////////////////////////////////////////////////////
32189 . ////////////////////////////////////////////////////////////////////////////
32190
32191 .chapter "SMTP processing" "CHAPSMTP"
32192 .scindex IIDsmtpproc1 "SMTP" "processing details"
32193 .scindex IIDsmtpproc2 "LMTP" "processing details"
32194 Exim supports a number of different ways of using the SMTP protocol, and its
32195 LMTP variant, which is an interactive protocol for transferring messages into a
32196 closed mail store application. This chapter contains details of how SMTP is
32197 processed. For incoming mail, the following are available:
32198
32199 .ilist
32200 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32201 .next
32202 SMTP over the standard input and output (the &%-bs%& option);
32203 .next
32204 Batched SMTP on the standard input (the &%-bS%& option).
32205 .endlist
32206
32207 For mail delivery, the following are available:
32208
32209 .ilist
32210 SMTP over TCP/IP (the &(smtp)& transport);
32211 .next
32212 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32213 &"lmtp"&);
32214 .next
32215 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32216 transport);
32217 .next
32218 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32219 the &%use_bsmtp%& option set).
32220 .endlist
32221
32222 &'Batched SMTP'& is the name for a process in which batches of messages are
32223 stored in or read from files (or pipes), in a format in which SMTP commands are
32224 used to contain the envelope information.
32225
32226
32227
32228 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32229 .cindex "SMTP" "outgoing over TCP/IP"
32230 .cindex "outgoing SMTP over TCP/IP"
32231 .cindex "LMTP" "over TCP/IP"
32232 .cindex "outgoing LMTP over TCP/IP"
32233 .cindex "EHLO"
32234 .cindex "HELO"
32235 .cindex "SIZE option on MAIL command"
32236 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32237 The &%protocol%& option selects which protocol is to be used, but the actual
32238 processing is the same in both cases.
32239
32240 If, in response to its EHLO command, Exim is told that the SIZE
32241 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32242 command. The value of <&'n'&> is the message size plus the value of the
32243 &%size_addition%& option (default 1024) to allow for additions to the message
32244 such as per-transport header lines, or changes made in a
32245 .cindex "transport" "filter"
32246 .cindex "filter" "transport filter"
32247 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32248 suppressed.
32249
32250 If the remote server advertises support for PIPELINING, Exim uses the
32251 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32252 required for the transaction.
32253
32254 If the remote server advertises support for the STARTTLS command, and Exim
32255 was built to support TLS encryption, it tries to start a TLS session unless the
32256 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32257 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32258 is called for verification.
32259
32260 If the remote server advertises support for the AUTH command, Exim scans
32261 the authenticators configuration for any suitable client settings, as described
32262 in chapter &<<CHAPSMTPAUTH>>&.
32263
32264 .cindex "carriage return"
32265 .cindex "linefeed"
32266 Responses from the remote host are supposed to be terminated by CR followed by
32267 LF. However, there are known to be hosts that do not send CR characters, so in
32268 order to be able to interwork with such hosts, Exim treats LF on its own as a
32269 line terminator.
32270
32271 If a message contains a number of different addresses, all those with the same
32272 characteristics (for example, the same envelope sender) that resolve to the
32273 same set of hosts, in the same order, are sent in a single SMTP transaction,
32274 even if they are for different domains, unless there are more than the setting
32275 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32276 they are split into groups containing no more than &%max_rcpt%&s addresses
32277 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32278 in parallel sessions. The order of hosts with identical MX values is not
32279 significant when checking whether addresses can be batched in this way.
32280
32281 When the &(smtp)& transport suffers a temporary failure that is not
32282 message-related, Exim updates its transport-specific database, which contains
32283 records indexed by host name that remember which messages are waiting for each
32284 particular host. It also updates the retry database with new retry times.
32285
32286 .cindex "hints database" "retry keys"
32287 Exim's retry hints are based on host name plus IP address, so if one address of
32288 a multi-homed host is broken, it will soon be skipped most of the time.
32289 See the next section for more detail about error handling.
32290
32291 .cindex "SMTP" "passed connection"
32292 .cindex "SMTP" "batching over TCP/IP"
32293 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32294 looks in the hints database for the transport to see if there are any queued
32295 messages waiting for the host to which it is connected. If it finds one, it
32296 creates a new Exim process using the &%-MC%& option (which can only be used by
32297 a process running as root or the Exim user) and passes the TCP/IP socket to it
32298 so that it can deliver another message using the same socket. The new process
32299 does only those deliveries that are routed to the connected host, and may in
32300 turn pass the socket on to a third process, and so on.
32301
32302 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32303 limit the number of messages sent down a single TCP/IP connection.
32304
32305 .cindex "asterisk" "after IP address"
32306 The second and subsequent messages delivered down an existing connection are
32307 identified in the main log by the addition of an asterisk after the closing
32308 square bracket of the IP address.
32309
32310
32311
32312
32313 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32314 .cindex "error" "in outgoing SMTP"
32315 .cindex "SMTP" "errors in outgoing"
32316 .cindex "host" "error"
32317 Three different kinds of error are recognized for outgoing SMTP: host errors,
32318 message errors, and recipient errors.
32319
32320 .vlist
32321 .vitem "&*Host errors*&"
32322 A host error is not associated with a particular message or with a
32323 particular recipient of a message. The host errors are:
32324
32325 .ilist
32326 Connection refused or timed out,
32327 .next
32328 Any error response code on connection,
32329 .next
32330 Any error response code to EHLO or HELO,
32331 .next
32332 Loss of connection at any time, except after &"."&,
32333 .next
32334 I/O errors at any time,
32335 .next
32336 Timeouts during the session, other than in response to MAIL, RCPT or
32337 the &"."& at the end of the data.
32338 .endlist ilist
32339
32340 For a host error, a permanent error response on connection, or in response to
32341 EHLO, causes all addresses routed to the host to be failed. Any other host
32342 error causes all addresses to be deferred, and retry data to be created for the
32343 host. It is not tried again, for any message, until its retry time arrives. If
32344 the current set of addresses are not all delivered in this run (to some
32345 alternative host), the message is added to the list of those waiting for this
32346 host, so if it is still undelivered when a subsequent successful delivery is
32347 made to the host, it will be sent down the same SMTP connection.
32348
32349 .vitem "&*Message errors*&"
32350 .cindex "message" "error"
32351 A message error is associated with a particular message when sent to a
32352 particular host, but not with a particular recipient of the message. The
32353 message errors are:
32354
32355 .ilist
32356 Any error response code to MAIL, DATA, or the &"."& that terminates
32357 the data,
32358 .next
32359 Timeout after MAIL,
32360 .next
32361 Timeout or loss of connection after the &"."& that terminates the data. A
32362 timeout after the DATA command itself is treated as a host error, as is loss of
32363 connection at any other time.
32364 .endlist ilist
32365
32366 For a message error, a permanent error response (5&'xx'&) causes all addresses
32367 to be failed, and a delivery error report to be returned to the sender. A
32368 temporary error response (4&'xx'&), or one of the timeouts, causes all
32369 addresses to be deferred. Retry data is not created for the host, but instead,
32370 a retry record for the combination of host plus message id is created. The
32371 message is not added to the list of those waiting for this host. This ensures
32372 that the failing message will not be sent to this host again until the retry
32373 time arrives. However, other messages that are routed to the host are not
32374 affected, so if it is some property of the message that is causing the error,
32375 it will not stop the delivery of other mail.
32376
32377 If the remote host specified support for the SIZE parameter in its response
32378 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32379 over-large message will cause a message error because the error arrives as a
32380 response to MAIL.
32381
32382 .vitem "&*Recipient errors*&"
32383 .cindex "recipient" "error"
32384 A recipient error is associated with a particular recipient of a message. The
32385 recipient errors are:
32386
32387 .ilist
32388 Any error response to RCPT,
32389 .next
32390 Timeout after RCPT.
32391 .endlist
32392
32393 For a recipient error, a permanent error response (5&'xx'&) causes the
32394 recipient address to be failed, and a bounce message to be returned to the
32395 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32396 address to be deferred, and routing retry data to be created for it. This is
32397 used to delay processing of the address in subsequent queue runs, until its
32398 routing retry time arrives. This applies to all messages, but because it
32399 operates only in queue runs, one attempt will be made to deliver a new message
32400 to the failing address before the delay starts to operate. This ensures that,
32401 if the failure is really related to the message rather than the recipient
32402 (&"message too big for this recipient"& is a possible example), other messages
32403 have a chance of getting delivered. If a delivery to the address does succeed,
32404 the retry information gets cleared, so all stuck messages get tried again, and
32405 the retry clock is reset.
32406
32407 The message is not added to the list of those waiting for this host. Use of the
32408 host for other messages is unaffected, and except in the case of a timeout,
32409 other recipients are processed independently, and may be successfully delivered
32410 in the current SMTP session. After a timeout it is of course impossible to
32411 proceed with the session, so all addresses get deferred. However, those other
32412 than the one that failed do not suffer any subsequent retry delays. Therefore,
32413 if one recipient is causing trouble, the others have a chance of getting
32414 through when a subsequent delivery attempt occurs before the failing
32415 recipient's retry time.
32416 .endlist
32417
32418 In all cases, if there are other hosts (or IP addresses) available for the
32419 current set of addresses (for example, from multiple MX records), they are
32420 tried in this run for any undelivered addresses, subject of course to their
32421 own retry data. In other words, recipient error retry data does not take effect
32422 until the next delivery attempt.
32423
32424 Some hosts have been observed to give temporary error responses to every
32425 MAIL command at certain times (&"insufficient space"& has been seen). It
32426 would be nice if such circumstances could be recognized, and defer data for the
32427 host itself created, but this is not possible within the current Exim design.
32428 What actually happens is that retry data for every (host, message) combination
32429 is created.
32430
32431 The reason that timeouts after MAIL and RCPT are treated specially is that
32432 these can sometimes arise as a result of the remote host's verification
32433 procedures. Exim makes this assumption, and treats them as if a temporary error
32434 response had been received. A timeout after &"."& is treated specially because
32435 it is known that some broken implementations fail to recognize the end of the
32436 message if the last character of the last line is a binary zero. Thus, it is
32437 helpful to treat this case as a message error.
32438
32439 Timeouts at other times are treated as host errors, assuming a problem with the
32440 host, or the connection to it. If a timeout after MAIL, RCPT,
32441 or &"."& is really a connection problem, the assumption is that at the next try
32442 the timeout is likely to occur at some other point in the dialogue, causing it
32443 then to be treated as a host error.
32444
32445 There is experimental evidence that some MTAs drop the connection after the
32446 terminating &"."& if they do not like the contents of the message for some
32447 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32448 should be given. That is why Exim treats this case as a message rather than a
32449 host error, in order not to delay other messages to the same host.
32450
32451
32452
32453
32454 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32455 .cindex "SMTP" "incoming over TCP/IP"
32456 .cindex "incoming SMTP over TCP/IP"
32457 .cindex "inetd"
32458 .cindex "daemon"
32459 Incoming SMTP messages can be accepted in one of two ways: by running a
32460 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32461 &_/etc/inetd.conf_& should be like this:
32462 .code
32463 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32464 .endd
32465 Exim distinguishes between this case and the case of a locally running user
32466 agent using the &%-bs%& option by checking whether or not the standard input is
32467 a socket. When it is, either the port must be privileged (less than 1024), or
32468 the caller must be root or the Exim user. If any other user passes a socket
32469 with an unprivileged port number, Exim prints a message on the standard error
32470 stream and exits with an error code.
32471
32472 By default, Exim does not make a log entry when a remote host connects or
32473 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32474 unexpected. It can be made to write such log entries by setting the
32475 &%smtp_connection%& log selector.
32476
32477 .cindex "carriage return"
32478 .cindex "linefeed"
32479 Commands from the remote host are supposed to be terminated by CR followed by
32480 LF. However, there are known to be hosts that do not send CR characters. In
32481 order to be able to interwork with such hosts, Exim treats LF on its own as a
32482 line terminator.
32483 Furthermore, because common code is used for receiving messages from all
32484 sources, a CR on its own is also interpreted as a line terminator. However, the
32485 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32486
32487 .cindex "EHLO" "invalid data"
32488 .cindex "HELO" "invalid data"
32489 One area that sometimes gives rise to problems concerns the EHLO or
32490 HELO commands. Some clients send syntactically invalid versions of these
32491 commands, which Exim rejects by default. (This is nothing to do with verifying
32492 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32493 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32494 match the broken hosts that send invalid commands.
32495
32496 .cindex "SIZE option on MAIL command"
32497 .cindex "MAIL" "SIZE option"
32498 The amount of disk space available is checked whenever SIZE is received on
32499 a MAIL command, independently of whether &%message_size_limit%& or
32500 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32501 false. A temporary error is given if there is not enough space. If
32502 &%check_spool_space%& is set, the check is for that amount of space plus the
32503 value given with SIZE, that is, it checks that the addition of the incoming
32504 message will not reduce the space below the threshold.
32505
32506 When a message is successfully received, Exim includes the local message id in
32507 its response to the final &"."& that terminates the data. If the remote host
32508 logs this text it can help with tracing what has happened to a message.
32509
32510 The Exim daemon can limit the number of simultaneous incoming connections it is
32511 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32512 number of simultaneous incoming connections from a single remote host (see the
32513 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32514 rejected using the SMTP temporary error code 421.
32515
32516 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32517 subprocess has finished, as this can get lost at busy times. Instead, it looks
32518 for completed subprocesses every time it wakes up. Provided there are other
32519 things happening (new incoming calls, starts of queue runs), completed
32520 processes will be noticed and tidied away. On very quiet systems you may
32521 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32522 it will be noticed when the daemon next wakes up.
32523
32524 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32525 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32526 high system load &-- for details see the &%smtp_accept_reserve%&,
32527 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32528 applies in both the daemon and &'inetd'& cases.
32529
32530 Exim normally starts a delivery process for each message received, though this
32531 can be varied by means of the &%-odq%& command line option and the
32532 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32533 number of simultaneously running delivery processes started in this way from
32534 SMTP input can be limited by the &%smtp_accept_queue%& and
32535 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32536 subsequently received messages are just put on the input queue without starting
32537 a delivery process.
32538
32539 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32540 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32541 started up from the &'inetd'& daemon, because in that case each connection is
32542 handled by an entirely independent Exim process. Control by load average is,
32543 however, available with &'inetd'&.
32544
32545 Exim can be configured to verify addresses in incoming SMTP commands as they
32546 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32547 to rewrite addresses at this time &-- before any syntax checking is done. See
32548 section &<<SECTrewriteS>>&.
32549
32550 Exim can also be configured to limit the rate at which a client host submits
32551 MAIL and RCPT commands in a single SMTP session. See the
32552 &%smtp_ratelimit_hosts%& option.
32553
32554
32555
32556 .section "Unrecognized SMTP commands" "SECID234"
32557 .cindex "SMTP" "unrecognized commands"
32558 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32559 commands during a single SMTP connection, it drops the connection after sending
32560 the error response to the last command. The default value for
32561 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32562 abuse that subvert web servers into making connections to SMTP ports; in these
32563 circumstances, a number of non-SMTP lines are sent first.
32564
32565
32566 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32567 .cindex "SMTP" "syntax errors"
32568 .cindex "SMTP" "protocol errors"
32569 A syntax error is detected if an SMTP command is recognized, but there is
32570 something syntactically wrong with its data, for example, a malformed email
32571 address in a RCPT command. Protocol errors include invalid command
32572 sequencing such as RCPT before MAIL. If Exim receives more than
32573 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32574 drops the connection after sending the error response to the last command. The
32575 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32576 broken clients that loop sending bad commands (yes, it has been seen).
32577
32578
32579
32580 .section "Use of non-mail SMTP commands" "SECID236"
32581 .cindex "SMTP" "non-mail commands"
32582 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32583 DATA. Exim counts such commands, and drops the connection if there are too
32584 many of them in a single SMTP session. This action catches some
32585 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32586 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32587 defines what &"too many"& means. Its default value is 10.
32588
32589 When a new message is expected, one occurrence of RSET is not counted. This
32590 allows a client to send one RSET between messages (this is not necessary,
32591 but some clients do it). Exim also allows one uncounted occurrence of HELO
32592 or EHLO, and one occurrence of STARTTLS between messages. After
32593 starting up a TLS session, another EHLO is expected, and so it too is not
32594 counted.
32595
32596 The first occurrence of AUTH in a connection, or immediately following
32597 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32598 RCPT, DATA, and QUIT are counted.
32599
32600 You can control which hosts are subject to the limit set by
32601 &%smtp_accept_max_nonmail%& by setting
32602 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32603 the limit apply to all hosts. This option means that you can exclude any
32604 specific badly-behaved hosts that you have to live with.
32605
32606
32607
32608
32609 .section "The VRFY and EXPN commands" "SECID237"
32610 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32611 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32612 appropriate) in order to decide whether the command should be accepted or not.
32613 If no ACL is defined, the command is rejected.
32614
32615 .cindex "VRFY" "processing"
32616 When VRFY is accepted, it runs exactly the same code as when Exim is
32617 called with the &%-bv%& option.
32618
32619 .cindex "EXPN" "processing"
32620 When EXPN is accepted, a single-level expansion of the address is done.
32621 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32622 than a verification (the &%-bv%& option). If an unqualified local part is given
32623 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32624 of VRFY and EXPN commands are logged on the main and reject logs, and
32625 VRFY verification failures are logged on the main log for consistency with
32626 RCPT failures.
32627
32628
32629
32630 .section "The ETRN command" "SECTETRN"
32631 .cindex "ETRN" "processing"
32632 RFC 1985 describes an SMTP command called ETRN that is designed to
32633 overcome the security problems of the TURN command (which has fallen into
32634 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32635 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32636 should be accepted or not. If no ACL is defined, the command is rejected.
32637
32638 The ETRN command is concerned with &"releasing"& messages that are awaiting
32639 delivery to certain hosts. As Exim does not organize its message queue by host,
32640 the only form of ETRN that is supported by default is the one where the
32641 text starts with the &"#"& prefix, in which case the remainder of the text is
32642 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32643 the &%-R%& option to happen, with the remainder of the ETRN text as its
32644 argument. For example,
32645 .code
32646 ETRN #brigadoon
32647 .endd
32648 runs the command
32649 .code
32650 exim -R brigadoon
32651 .endd
32652 which causes a delivery attempt on all messages with undelivered addresses
32653 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32654 default), Exim prevents the simultaneous execution of more than one queue run
32655 for the same argument string as a result of an ETRN command. This stops
32656 a misbehaving client from starting more than one queue runner at once.
32657
32658 .cindex "hints database" "ETRN serialization"
32659 Exim implements the serialization by means of a hints database in which a
32660 record is written whenever a process is started by ETRN, and deleted when
32661 the process completes. However, Exim does not keep the SMTP session waiting for
32662 the ETRN process to complete. Once ETRN is accepted, the client is sent
32663 a &"success"& return code. Obviously there is scope for hints records to get
32664 left lying around if there is a system or program crash. To guard against this,
32665 Exim ignores any records that are more than six hours old.
32666
32667 .oindex "&%smtp_etrn_command%&"
32668 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32669 used. This specifies a command that is run whenever ETRN is received,
32670 whatever the form of its argument. For
32671 example:
32672 .code
32673 smtp_etrn_command = /etc/etrn_command $domain \
32674                     $sender_host_address
32675 .endd
32676 .vindex "&$domain$&"
32677 The string is split up into arguments which are independently expanded. The
32678 expansion variable &$domain$& is set to the argument of the ETRN command,
32679 and no syntax checking is done on the contents of this argument. Exim does not
32680 wait for the command to complete, so its status code is not checked. Exim runs
32681 under its own uid and gid when receiving incoming SMTP, so it is not possible
32682 for it to change them before running the command.
32683
32684
32685
32686 .section "Incoming local SMTP" "SECID238"
32687 .cindex "SMTP" "local incoming"
32688 Some user agents use SMTP to pass messages to their local MTA using the
32689 standard input and output, as opposed to passing the envelope on the command
32690 line and writing the message to the standard input. This is supported by the
32691 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32692 messages over TCP/IP (including the use of ACLs), except that the envelope
32693 sender given in a MAIL command is ignored unless the caller is trusted. In
32694 an ACL you can detect this form of SMTP input by testing for an empty host
32695 identification. It is common to have this as the first line in the ACL that
32696 runs for RCPT commands:
32697 .code
32698 accept hosts = :
32699 .endd
32700 This accepts SMTP messages from local processes without doing any other tests.
32701
32702
32703
32704 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32705 .cindex "SMTP" "batched outgoing"
32706 .cindex "batched SMTP output"
32707 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32708 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32709 be output in BSMTP format. No SMTP responses are possible for this form of
32710 delivery. All it is doing is using SMTP commands as a way of transmitting the
32711 envelope along with the message.
32712
32713 The message is written to the file or pipe preceded by the SMTP commands
32714 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32715 the message that start with a dot have an extra dot added. The SMTP command
32716 HELO is not normally used. If it is required, the &%message_prefix%& option
32717 can be used to specify it.
32718
32719 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32720 one recipient address at a time by default. However, you can arrange for them
32721 to handle several addresses at once by setting the &%batch_max%& option. When
32722 this is done for BSMTP, messages may contain multiple RCPT commands. See
32723 chapter &<<CHAPbatching>>& for more details.
32724
32725 .vindex "&$host$&"
32726 When one or more addresses are routed to a BSMTP transport by a router that
32727 sets up a host list, the name of the first host on the list is available to the
32728 transport in the variable &$host$&. Here is an example of such a transport and
32729 router:
32730 .code
32731 begin routers
32732 route_append:
32733   driver = manualroute
32734   transport = smtp_appendfile
32735   route_list = domain.example  batch.host.example
32736
32737 begin transports
32738 smtp_appendfile:
32739   driver = appendfile
32740   directory = /var/bsmtp/$host
32741   batch_max = 1000
32742   use_bsmtp
32743   user = exim
32744 .endd
32745 This causes messages addressed to &'domain.example'& to be written in BSMTP
32746 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32747 message (unless there are more than 1000 recipients).
32748
32749
32750
32751 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32752 .cindex "SMTP" "batched incoming"
32753 .cindex "batched SMTP input"
32754 The &%-bS%& command line option causes Exim to accept one or more messages by
32755 reading SMTP on the standard input, but to generate no responses. If the caller
32756 is trusted, the senders in the MAIL commands are believed; otherwise the
32757 sender is always the caller of Exim. Unqualified senders and receivers are not
32758 rejected (there seems little point) but instead just get qualified. HELO
32759 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32760 as NOOP; QUIT quits.
32761
32762 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32763 ACL is run in the same way as for non-SMTP local input.
32764
32765 If an error is detected while reading a message, including a missing &"."& at
32766 the end, Exim gives up immediately. It writes details of the error to the
32767 standard output in a stylized way that the calling program should be able to
32768 make some use of automatically, for example:
32769 .code
32770 554 Unexpected end of file
32771 Transaction started in line 10
32772 Error detected in line 14
32773 .endd
32774 It writes a more verbose version, for human consumption, to the standard error
32775 file, for example:
32776 .code
32777 An error was detected while processing a file of BSMTP input.
32778 The error message was:
32779
32780 501 '>' missing at end of address
32781
32782 The SMTP transaction started in line 10.
32783 The error was detected in line 12.
32784 The SMTP command at fault was:
32785
32786 rcpt to:<malformed@in.com.plete
32787
32788 1 previous message was successfully processed.
32789 The rest of the batch was abandoned.
32790 .endd
32791 The return code from Exim is zero only if there were no errors. It is 1 if some
32792 messages were accepted before an error was detected, and 2 if no messages were
32793 accepted.
32794 .ecindex IIDsmtpproc1
32795 .ecindex IIDsmtpproc2
32796
32797
32798
32799 . ////////////////////////////////////////////////////////////////////////////
32800 . ////////////////////////////////////////////////////////////////////////////
32801
32802 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32803          "Customizing messages"
32804 When a message fails to be delivered, or remains on the queue for more than a
32805 configured amount of time, Exim sends a message to the original sender, or
32806 to an alternative configured address. The text of these messages is built into
32807 the code of Exim, but it is possible to change it, either by adding a single
32808 string, or by replacing each of the paragraphs by text supplied in a file.
32809
32810 The &'From:'& and &'To:'& header lines are automatically generated; you can
32811 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32812 option. Exim also adds the line
32813 .code
32814 Auto-Submitted: auto-generated
32815 .endd
32816 to all warning and bounce messages,
32817
32818
32819 .section "Customizing bounce messages" "SECID239"
32820 .cindex "customizing" "bounce message"
32821 .cindex "bounce message" "customizing"
32822 If &%bounce_message_text%& is set, its contents are included in the default
32823 message immediately after &"This message was created automatically by mail
32824 delivery software."& The string is not expanded. It is not used if
32825 &%bounce_message_file%& is set.
32826
32827 When &%bounce_message_file%& is set, it must point to a template file for
32828 constructing error messages. The file consists of a series of text items,
32829 separated by lines consisting of exactly four asterisks. If the file cannot be
32830 opened, default text is used and a message is written to the main and panic
32831 logs. If any text item in the file is empty, default text is used for that
32832 item.
32833
32834 .vindex "&$bounce_recipient$&"
32835 .vindex "&$bounce_return_size_limit$&"
32836 Each item of text that is read from the file is expanded, and there are two
32837 expansion variables which can be of use here: &$bounce_recipient$& is set to
32838 the recipient of an error message while it is being created, and
32839 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32840 option, rounded to a whole number.
32841
32842 The items must appear in the file in the following order:
32843
32844 .ilist
32845 The first item is included in the headers, and should include at least a
32846 &'Subject:'& header. Exim does not check the syntax of these headers.
32847 .next
32848 The second item forms the start of the error message. After it, Exim lists the
32849 failing addresses with their error messages.
32850 .next
32851 The third item is used to introduce any text from pipe transports that is to be
32852 returned to the sender. It is omitted if there is no such text.
32853 .next
32854 The fourth item is used to introduce the copy of the message that is returned
32855 as part of the error report.
32856 .next
32857 The fifth item is added after the fourth one if the returned message is
32858 truncated because it is bigger than &%return_size_limit%&.
32859 .next
32860 The sixth item is added after the copy of the original message.
32861 .endlist
32862
32863 The default state (&%bounce_message_file%& unset) is equivalent to the
32864 following file, in which the sixth item is empty. The &'Subject:'& and some
32865 other lines have been split in order to fit them on the page:
32866 .code
32867 Subject: Mail delivery failed
32868   ${if eq{$sender_address}{$bounce_recipient}
32869   {: returning message to sender}}
32870 ****
32871 This message was created automatically by mail delivery software.
32872
32873 A message ${if eq{$sender_address}{$bounce_recipient}
32874   {that you sent }{sent by
32875
32876 <$sender_address>
32877
32878 }}could not be delivered to all of its recipients.
32879 This is a permanent error. The following address(es) failed:
32880 ****
32881 The following text was generated during the delivery attempt(s):
32882 ****
32883 ------ This is a copy of the message, including all the headers.
32884   ------
32885 ****
32886 ------ The body of the message is $message_size characters long;
32887   only the first
32888 ------ $bounce_return_size_limit or so are included here.
32889 ****
32890 .endd
32891 .section "Customizing warning messages" "SECTcustwarn"
32892 .cindex "customizing" "warning message"
32893 .cindex "warning of delay" "customizing the message"
32894 The option &%warn_message_file%& can be pointed at a template file for use when
32895 warnings about message delays are created. In this case there are only three
32896 text sections:
32897
32898 .ilist
32899 The first item is included in the headers, and should include at least a
32900 &'Subject:'& header. Exim does not check the syntax of these headers.
32901 .next
32902 The second item forms the start of the warning message. After it, Exim lists
32903 the delayed addresses.
32904 .next
32905 The third item then ends the message.
32906 .endlist
32907
32908 The default state is equivalent to the following file, except that some lines
32909 have been split here, in order to fit them on the page:
32910 .code
32911 Subject: Warning: message $message_exim_id delayed
32912   $warn_message_delay
32913 ****
32914 This message was created automatically by mail delivery software.
32915
32916 A message ${if eq{$sender_address}{$warn_message_recipients}
32917 {that you sent }{sent by
32918
32919 <$sender_address>
32920
32921 }}has not been delivered to all of its recipients after
32922 more than $warn_message_delay on the queue on $primary_hostname.
32923
32924 The message identifier is:     $message_exim_id
32925 The subject of the message is: $h_subject
32926 The date of the message is:    $h_date
32927
32928 The following address(es) have not yet been delivered:
32929 ****
32930 No action is required on your part. Delivery attempts will
32931 continue for some time, and this warning may be repeated at
32932 intervals if the message remains undelivered. Eventually the
32933 mail delivery software will give up, and when that happens,
32934 the message will be returned to you.
32935 .endd
32936 .vindex "&$warn_message_delay$&"
32937 .vindex "&$warn_message_recipients$&"
32938 However, in the default state the subject and date lines are omitted if no
32939 appropriate headers exist. During the expansion of this file,
32940 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32941 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32942 of recipients for the warning message. There may be more than one if there are
32943 multiple addresses with different &%errors_to%& settings on the routers that
32944 handled them.
32945
32946
32947
32948
32949 . ////////////////////////////////////////////////////////////////////////////
32950 . ////////////////////////////////////////////////////////////////////////////
32951
32952 .chapter "Some common configuration settings" "CHAPcomconreq"
32953 This chapter discusses some configuration settings that seem to be fairly
32954 common. More examples and discussion can be found in the Exim book.
32955
32956
32957
32958 .section "Sending mail to a smart host" "SECID240"
32959 .cindex "smart host" "example router"
32960 If you want to send all mail for non-local domains to a &"smart host"&, you
32961 should replace the default &(dnslookup)& router with a router which does the
32962 routing explicitly:
32963 .code
32964 send_to_smart_host:
32965   driver = manualroute
32966   route_list = !+local_domains smart.host.name
32967   transport = remote_smtp
32968 .endd
32969 You can use the smart host's IP address instead of the name if you wish.
32970 If you are using Exim only to submit messages to a smart host, and not for
32971 receiving incoming messages, you can arrange for it to do the submission
32972 synchronously by setting the &%mua_wrapper%& option (see chapter
32973 &<<CHAPnonqueueing>>&).
32974
32975
32976
32977
32978 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32979 .cindex "mailing lists"
32980 Exim can be used to run simple mailing lists, but for large and/or complicated
32981 requirements, the use of additional specialized mailing list software such as
32982 Majordomo or Mailman is recommended.
32983
32984 The &(redirect)& router can be used to handle mailing lists where each list
32985 is maintained in a separate file, which can therefore be managed by an
32986 independent manager. The &%domains%& router option can be used to run these
32987 lists in a separate domain from normal mail. For example:
32988 .code
32989 lists:
32990   driver = redirect
32991   domains = lists.example
32992   file = /usr/lists/$local_part
32993   forbid_pipe
32994   forbid_file
32995   errors_to = $local_part-request@lists.example
32996   no_more
32997 .endd
32998 This router is skipped for domains other than &'lists.example'&. For addresses
32999 in that domain, it looks for a file that matches the local part. If there is no
33000 such file, the router declines, but because &%no_more%& is set, no subsequent
33001 routers are tried, and so the whole delivery fails.
33002
33003 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33004 expanded into a file name or a pipe delivery, which is usually inappropriate in
33005 a mailing list.
33006
33007 .oindex "&%errors_to%&"
33008 The &%errors_to%& option specifies that any delivery errors caused by addresses
33009 taken from a mailing list are to be sent to the given address rather than the
33010 original sender of the message. However, before acting on this, Exim verifies
33011 the error address, and ignores it if verification fails.
33012
33013 For example, using the configuration above, mail sent to
33014 &'dicts@lists.example'& is passed on to those addresses contained in
33015 &_/usr/lists/dicts_&, with error reports directed to
33016 &'dicts-request@lists.example'&, provided that this address can be verified.
33017 There could be a file called &_/usr/lists/dicts-request_& containing
33018 the address(es) of this particular list's manager(s), but other approaches,
33019 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33020 or &%local_part_suffix%& options) to handle addresses of the form
33021 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33022
33023
33024
33025 .section "Syntax errors in mailing lists" "SECID241"
33026 .cindex "mailing lists" "syntax errors in"
33027 If an entry in redirection data contains a syntax error, Exim normally defers
33028 delivery of the original address. That means that a syntax error in a mailing
33029 list holds up all deliveries to the list. This may not be appropriate when a
33030 list is being maintained automatically from data supplied by users, and the
33031 addresses are not rigorously checked.
33032
33033 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33034 entries that fail to parse, noting the incident in the log. If in addition
33035 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33036 whenever a broken address is skipped. It is usually appropriate to set
33037 &%syntax_errors_to%& to the same address as &%errors_to%&.
33038
33039
33040
33041 .section "Re-expansion of mailing lists" "SECID242"
33042 .cindex "mailing lists" "re-expansion of"
33043 Exim remembers every individual address to which a message has been delivered,
33044 in order to avoid duplication, but it normally stores only the original
33045 recipient addresses with a message. If all the deliveries to a mailing list
33046 cannot be done at the first attempt, the mailing list is re-expanded when the
33047 delivery is next tried. This means that alterations to the list are taken into
33048 account at each delivery attempt, so addresses that have been added to
33049 the list since the message arrived will therefore receive a copy of the
33050 message, even though it pre-dates their subscription.
33051
33052 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33053 on the &(redirect)& router. If this is done, any addresses generated by the
33054 router that fail to deliver at the first attempt are added to the message as
33055 &"top level"& addresses, and the parent address that generated them is marked
33056 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33057 subsequent delivery attempts. The disadvantage of this is that if any of the
33058 failing addresses are incorrect, correcting them in the file has no effect on
33059 pre-existing messages.
33060
33061 The original top-level address is remembered with each of the generated
33062 addresses, and is output in any log messages. However, any intermediate parent
33063 addresses are not recorded. This makes a difference to the log only if the
33064 &%all_parents%& selector is set, but for mailing lists there is normally only
33065 one level of expansion anyway.
33066
33067
33068
33069 .section "Closed mailing lists" "SECID243"
33070 .cindex "mailing lists" "closed"
33071 The examples so far have assumed open mailing lists, to which anybody may
33072 send mail. It is also possible to set up closed lists, where mail is accepted
33073 from specified senders only. This is done by making use of the generic
33074 &%senders%& option to restrict the router that handles the list.
33075
33076 The following example uses the same file as a list of recipients and as a list
33077 of permitted senders. It requires three routers:
33078 .code
33079 lists_request:
33080   driver = redirect
33081   domains = lists.example
33082   local_part_suffix = -request
33083   file = /usr/lists/$local_part$local_part_suffix
33084   no_more
33085
33086 lists_post:
33087   driver = redirect
33088   domains = lists.example
33089   senders = ${if exists {/usr/lists/$local_part}\
33090              {lsearch;/usr/lists/$local_part}{*}}
33091   file = /usr/lists/$local_part
33092   forbid_pipe
33093   forbid_file
33094   errors_to = $local_part-request@lists.example
33095   no_more
33096
33097 lists_closed:
33098   driver = redirect
33099   domains = lists.example
33100   allow_fail
33101   data = :fail: $local_part@lists.example is a closed mailing list
33102 .endd
33103 All three routers have the same &%domains%& setting, so for any other domains,
33104 they are all skipped. The first router runs only if the local part ends in
33105 &%-request%&. It handles messages to the list manager(s) by means of an open
33106 mailing list.
33107
33108 The second router runs only if the &%senders%& precondition is satisfied. It
33109 checks for the existence of a list that corresponds to the local part, and then
33110 checks that the sender is on the list by means of a linear search. It is
33111 necessary to check for the existence of the file before trying to search it,
33112 because otherwise Exim thinks there is a configuration error. If the file does
33113 not exist, the expansion of &%senders%& is *, which matches all senders. This
33114 means that the router runs, but because there is no list, declines, and
33115 &%no_more%& ensures that no further routers are run. The address fails with an
33116 &"unrouteable address"& error.
33117
33118 The third router runs only if the second router is skipped, which happens when
33119 a mailing list exists, but the sender is not on it. This router forcibly fails
33120 the address, giving a suitable error message.
33121
33122
33123
33124
33125 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33126 .cindex "VERP"
33127 .cindex "Variable Envelope Return Paths"
33128 .cindex "envelope sender"
33129 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33130 are a way of helping mailing list administrators discover which subscription
33131 address is the cause of a particular delivery failure. The idea is to encode
33132 the original recipient address in the outgoing envelope sender address, so that
33133 if the message is forwarded by another host and then subsequently bounces, the
33134 original recipient can be extracted from the recipient address of the bounce.
33135
33136 .oindex &%errors_to%&
33137 .oindex &%return_path%&
33138 Envelope sender addresses can be modified by Exim using two different
33139 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33140 list examples), or the &%return_path%& option on a transport. The second of
33141 these is effective only if the message is successfully delivered to another
33142 host; it is not used for errors detected on the local host (see the description
33143 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33144 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33145 .code
33146 verp_smtp:
33147   driver = smtp
33148   max_rcpt = 1
33149   return_path = \
33150     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33151       {$1-request+$local_part=$domain@your.dom.example}fail}
33152 .endd
33153 This has the effect of rewriting the return path (envelope sender) on outgoing
33154 SMTP messages, if the local part of the original return path ends in
33155 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33156 local part and domain of the recipient into the return path. Suppose, for
33157 example, that a message whose return path has been set to
33158 &'somelist-request@your.dom.example'& is sent to
33159 &'subscriber@other.dom.example'&. In the transport, the return path is
33160 rewritten as
33161 .code
33162 somelist-request+subscriber=other.dom.example@your.dom.example
33163 .endd
33164 .vindex "&$local_part$&"
33165 For this to work, you must tell Exim to send multiple copies of messages that
33166 have more than one recipient, so that each copy has just one recipient. This is
33167 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33168 might be sent to several different recipients in the same domain, in which case
33169 &$local_part$& is not available in the transport, because it is not unique.
33170
33171 Unless your host is doing nothing but mailing list deliveries, you should
33172 probably use a separate transport for the VERP deliveries, so as not to use
33173 extra resources in making one-per-recipient copies for other deliveries. This
33174 can easily be done by expanding the &%transport%& option in the router:
33175 .code
33176 dnslookup:
33177   driver = dnslookup
33178   domains = ! +local_domains
33179   transport = \
33180     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33181       {verp_smtp}{remote_smtp}}
33182   no_more
33183 .endd
33184 If you want to change the return path using &%errors_to%& in a router instead
33185 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33186 routers that handle mailing list addresses. This will ensure that all delivery
33187 errors, including those detected on the local host, are sent to the VERP
33188 address.
33189
33190 On a host that does no local deliveries and has no manual routing, only the
33191 &(dnslookup)& router needs to be changed. A special transport is not needed for
33192 SMTP deliveries. Every mailing list recipient has its own return path value,
33193 and so Exim must hand them to the transport one at a time. Here is an example
33194 of a &(dnslookup)& router that implements VERP:
33195 .code
33196 verp_dnslookup:
33197   driver = dnslookup
33198   domains = ! +local_domains
33199   transport = remote_smtp
33200   errors_to = \
33201     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33202      {$1-request+$local_part=$domain@your.dom.example}fail}
33203   no_more
33204 .endd
33205 Before you start sending out messages with VERPed return paths, you must also
33206 configure Exim to accept the bounce messages that come back to those paths.
33207 Typically this is done by setting a &%local_part_suffix%& option for a
33208 router, and using this to route the messages to wherever you want to handle
33209 them.
33210
33211 The overhead incurred in using VERP depends very much on the size of the
33212 message, the number of recipient addresses that resolve to the same remote
33213 host, and the speed of the connection over which the message is being sent. If
33214 a lot of addresses resolve to the same host and the connection is slow, sending
33215 a separate copy of the message for each address may take substantially longer
33216 than sending a single copy with many recipients (for which VERP cannot be
33217 used).
33218
33219
33220
33221
33222
33223
33224 .section "Virtual domains" "SECTvirtualdomains"
33225 .cindex "virtual domains"
33226 .cindex "domain" "virtual"
33227 The phrase &'virtual domain'& is unfortunately used with two rather different
33228 meanings:
33229
33230 .ilist
33231 A domain for which there are no real mailboxes; all valid local parts are
33232 aliases for other email addresses. Common examples are organizational
33233 top-level domains and &"vanity"& domains.
33234 .next
33235 One of a number of independent domains that are all handled by the same host,
33236 with mailboxes on that host, but where the mailbox owners do not necessarily
33237 have login accounts on that host.
33238 .endlist
33239
33240 The first usage is probably more common, and does seem more &"virtual"& than
33241 the second. This kind of domain can be handled in Exim with a straightforward
33242 aliasing router. One approach is to create a separate alias file for each
33243 virtual domain. Exim can test for the existence of the alias file to determine
33244 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33245 to a router of this form:
33246 .code
33247 virtual:
33248   driver = redirect
33249   domains = dsearch;/etc/mail/virtual
33250   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33251   no_more
33252 .endd
33253 The &%domains%& option specifies that the router is to be skipped, unless there
33254 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33255 domain that is being processed. When the router runs, it looks up the local
33256 part in the file to find a new address (or list of addresses). The &%no_more%&
33257 setting ensures that if the lookup fails (leading to &%data%& being an empty
33258 string), Exim gives up on the address without trying any subsequent routers.
33259
33260 This one router can handle all the virtual domains because the alias file names
33261 follow a fixed pattern. Permissions can be arranged so that appropriate people
33262 can edit the different alias files. A successful aliasing operation results in
33263 a new envelope recipient address, which is then routed from scratch.
33264
33265 The other kind of &"virtual"& domain can also be handled in a straightforward
33266 way. One approach is to create a file for each domain containing a list of
33267 valid local parts, and use it in a router like this:
33268 .code
33269 my_domains:
33270   driver = accept
33271   domains = dsearch;/etc/mail/domains
33272   local_parts = lsearch;/etc/mail/domains/$domain
33273   transport = my_mailboxes
33274 .endd
33275 The address is accepted if there is a file for the domain, and the local part
33276 can be found in the file. The &%domains%& option is used to check for the
33277 file's existence because &%domains%& is tested before the &%local_parts%&
33278 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33279 because that option is tested after &%local_parts%&. The transport is as
33280 follows:
33281 .code
33282 my_mailboxes:
33283   driver = appendfile
33284   file = /var/mail/$domain/$local_part
33285   user = mail
33286 .endd
33287 This uses a directory of mailboxes for each domain. The &%user%& setting is
33288 required, to specify which uid is to be used for writing to the mailboxes.
33289
33290 The configuration shown here is just one example of how you might support this
33291 requirement. There are many other ways this kind of configuration can be set
33292 up, for example, by using a database instead of separate files to hold all the
33293 information about the domains.
33294
33295
33296
33297 .section "Multiple user mailboxes" "SECTmulbox"
33298 .cindex "multiple mailboxes"
33299 .cindex "mailbox" "multiple"
33300 .cindex "local part" "prefix"
33301 .cindex "local part" "suffix"
33302 Heavy email users often want to operate with multiple mailboxes, into which
33303 incoming mail is automatically sorted. A popular way of handling this is to
33304 allow users to use multiple sender addresses, so that replies can easily be
33305 identified. Users are permitted to add prefixes or suffixes to their local
33306 parts for this purpose. The wildcard facility of the generic router options
33307 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33308 example, consider this router:
33309 .code
33310 userforward:
33311   driver = redirect
33312   check_local_user
33313   file = $home/.forward
33314   local_part_suffix = -*
33315   local_part_suffix_optional
33316   allow_filter
33317 .endd
33318 .vindex "&$local_part_suffix$&"
33319 It runs a user's &_.forward_& file for all local parts of the form
33320 &'username-*'&. Within the filter file the user can distinguish different
33321 cases by testing the variable &$local_part_suffix$&. For example:
33322 .code
33323 if $local_part_suffix contains -special then
33324 save /home/$local_part/Mail/special
33325 endif
33326 .endd
33327 If the filter file does not exist, or does not deal with such addresses, they
33328 fall through to subsequent routers, and, assuming no subsequent use of the
33329 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33330 control over which suffixes are valid.
33331
33332 Alternatively, a suffix can be used to trigger the use of a different
33333 &_.forward_& file &-- which is the way a similar facility is implemented in
33334 another MTA:
33335 .code
33336 userforward:
33337   driver = redirect
33338   check_local_user
33339   file = $home/.forward$local_part_suffix
33340   local_part_suffix = -*
33341   local_part_suffix_optional
33342   allow_filter
33343 .endd
33344 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33345 example, &_.forward-special_& is used. Once again, if the appropriate file
33346 does not exist, or does not deal with the address, it is passed on to
33347 subsequent routers, which could, if required, look for an unqualified
33348 &_.forward_& file to use as a default.
33349
33350
33351
33352 .section "Simplified vacation processing" "SECID244"
33353 .cindex "vacation processing"
33354 The traditional way of running the &'vacation'& program is for a user to set up
33355 a pipe command in a &_.forward_& file
33356 (see section &<<SECTspecitredli>>& for syntax details).
33357 This is prone to error by inexperienced users. There are two features of Exim
33358 that can be used to make this process simpler for users:
33359
33360 .ilist
33361 A local part prefix such as &"vacation-"& can be specified on a router which
33362 can cause the message to be delivered directly to the &'vacation'& program, or
33363 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33364 &_.forward_& file are then much simpler. For example:
33365 .code
33366 spqr, vacation-spqr
33367 .endd
33368 .next
33369 The &%require_files%& generic router option can be used to trigger a
33370 vacation delivery by checking for the existence of a certain file in the
33371 user's home directory. The &%unseen%& generic option should also be used, to
33372 ensure that the original delivery also proceeds. In this case, all the user has
33373 to do is to create a file called, say, &_.vacation_&, containing a vacation
33374 message.
33375 .endlist
33376
33377 Another advantage of both these methods is that they both work even when the
33378 use of arbitrary pipes by users is locked out.
33379
33380
33381
33382 .section "Taking copies of mail" "SECID245"
33383 .cindex "message" "copying every"
33384 Some installations have policies that require archive copies of all messages to
33385 be made. A single copy of each message can easily be taken by an appropriate
33386 command in a system filter, which could, for example, use a different file for
33387 each day's messages.
33388
33389 There is also a shadow transport mechanism that can be used to take copies of
33390 messages that are successfully delivered by local transports, one copy per
33391 delivery. This could be used, &'inter alia'&, to implement automatic
33392 notification of delivery by sites that insist on doing such things.
33393
33394
33395
33396 .section "Intermittently connected hosts" "SECID246"
33397 .cindex "intermittently connected hosts"
33398 It has become quite common (because it is cheaper) for hosts to connect to the
33399 Internet periodically rather than remain connected all the time. The normal
33400 arrangement is that mail for such hosts accumulates on a system that is
33401 permanently connected.
33402
33403 Exim was designed for use on permanently connected hosts, and so it is not
33404 particularly well-suited to use in an intermittently connected environment.
33405 Nevertheless there are some features that can be used.
33406
33407
33408 .section "Exim on the upstream server host" "SECID247"
33409 It is tempting to arrange for incoming mail for the intermittently connected
33410 host to remain on Exim's queue until the client connects. However, this
33411 approach does not scale very well. Two different kinds of waiting message are
33412 being mixed up in the same queue &-- those that cannot be delivered because of
33413 some temporary problem, and those that are waiting for their destination host
33414 to connect. This makes it hard to manage the queue, as well as wasting
33415 resources, because each queue runner scans the entire queue.
33416
33417 A better approach is to separate off those messages that are waiting for an
33418 intermittently connected host. This can be done by delivering these messages
33419 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33420 format, from where they are transmitted by other software when their
33421 destination connects. This makes it easy to collect all the mail for one host
33422 in a single directory, and to apply local timeout rules on a per-message basis
33423 if required.
33424
33425 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33426 you are doing this, you should configure Exim with a long retry period for the
33427 intermittent host. For example:
33428 .code
33429 cheshire.wonderland.fict.example    *   F,5d,24h
33430 .endd
33431 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33432 which messages it has queued up for that host. Once the intermittent host comes
33433 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33434 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33435 causes all the queued up messages to be delivered, often down a single SMTP
33436 connection. While the host remains connected, any new messages get delivered
33437 immediately.
33438
33439 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33440 issued with a different IP address each time it connects, Exim's retry
33441 mechanisms on the holding host get confused, because the IP address is normally
33442 used as part of the key string for holding retry information. This can be
33443 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33444 Since this has disadvantages for permanently connected hosts, it is best to
33445 arrange a separate transport for the intermittently connected ones.
33446
33447
33448
33449 .section "Exim on the intermittently connected client host" "SECID248"
33450 The value of &%smtp_accept_queue_per_connection%& should probably be
33451 increased, or even set to zero (that is, disabled) on the intermittently
33452 connected host, so that all incoming messages down a single connection get
33453 delivered immediately.
33454
33455 .cindex "SMTP" "passed connection"
33456 .cindex "SMTP" "multiple deliveries"
33457 .cindex "multiple SMTP deliveries"
33458 Mail waiting to be sent from an intermittently connected host will probably
33459 not have been routed, because without a connection DNS lookups are not
33460 possible. This means that if a normal queue run is done at connection time,
33461 each message is likely to be sent in a separate SMTP session. This can be
33462 avoided by starting the queue run with a command line option beginning with
33463 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33464 first pass, routing is done but no deliveries take place. The second pass is a
33465 normal queue run; since all the messages have been previously routed, those
33466 destined for the same host are likely to get sent as multiple deliveries in a
33467 single SMTP connection.
33468
33469
33470
33471 . ////////////////////////////////////////////////////////////////////////////
33472 . ////////////////////////////////////////////////////////////////////////////
33473
33474 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33475          "Exim as a non-queueing client"
33476 .cindex "client, non-queueing"
33477 .cindex "smart host" "suppressing queueing"
33478 On a personal computer, it is a common requirement for all
33479 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33480 configured to operate that way, for all the popular operating systems.
33481 However, there are some MUAs for Unix-like systems that cannot be so
33482 configured: they submit messages using the command line interface of
33483 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33484 messages this way.
33485
33486 If the personal computer runs continuously, there is no problem, because it can
33487 run a conventional MTA that handles delivery to the smart host, and deal with
33488 any delays via its queueing mechanism. However, if the computer does not run
33489 continuously or runs different operating systems at different times, queueing
33490 email is not desirable.
33491
33492 There is therefore a requirement for something that can provide the
33493 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33494 any queueing or retrying facilities. Furthermore, the delivery to the smart
33495 host should be synchronous, so that if it fails, the sending MUA is immediately
33496 informed. In other words, we want something that extends an MUA that submits
33497 to a local MTA via the command line so that it behaves like one that submits
33498 to a remote smart host using TCP/SMTP.
33499
33500 There are a number of applications (for example, there is one called &'ssmtp'&)
33501 that do this job. However, people have found them to be lacking in various
33502 ways. For instance, you might want to allow aliasing and forwarding to be done
33503 before sending a message to the smart host.
33504
33505 Exim already had the necessary infrastructure for doing this job. Just a few
33506 tweaks were needed to make it behave as required, though it is somewhat of an
33507 overkill to use a fully-featured MTA for this purpose.
33508
33509 .oindex "&%mua_wrapper%&"
33510 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33511 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33512 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33513 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33514 compatible router and transport configuration. Typically there will be just one
33515 router and one transport, sending everything to a smart host.
33516
33517 When run in MUA wrapping mode, the behaviour of Exim changes in the
33518 following ways:
33519
33520 .ilist
33521 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33522 In other words, the only way to submit messages is via the command line.
33523 .next
33524 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33525 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33526 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33527 does not finish until the delivery attempt is complete. If the delivery is
33528 successful, a zero return code is given.
33529 .next
33530 Address redirection is permitted, but the final routing for all addresses must
33531 be to the same remote transport, and to the same list of hosts. Furthermore,
33532 the return address (envelope sender) must be the same for all recipients, as
33533 must any added or deleted header lines. In other words, it must be possible to
33534 deliver the message in a single SMTP transaction, however many recipients there
33535 are.
33536 .next
33537 If these conditions are not met, or if routing any address results in a
33538 failure or defer status, or if Exim is unable to deliver all the recipients
33539 successfully to one of the smart hosts, delivery of the entire message fails.
33540 .next
33541 Because no queueing is allowed, all failures are treated as permanent; there
33542 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33543 smart host. Furthermore, because only a single yes/no response can be given to
33544 the caller, it is not possible to deliver to some recipients and not others. If
33545 there is an error (temporary or permanent) for any recipient, all are failed.
33546 .next
33547 If more than one smart host is listed, Exim will try another host after a
33548 connection failure or a timeout, in the normal way. However, if this kind of
33549 failure happens for all the hosts, the delivery fails.
33550 .next
33551 When delivery fails, an error message is written to the standard error stream
33552 (as well as to Exim's log), and Exim exits to the caller with a return code
33553 value 1. The message is expunged from Exim's spool files. No bounce messages
33554 are ever generated.
33555 .next
33556 No retry data is maintained, and any retry rules are ignored.
33557 .next
33558 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33559 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33560 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33561 .endlist
33562
33563 The overall effect is that Exim makes a single synchronous attempt to deliver
33564 the message, failing if there is any kind of problem. Because no local
33565 deliveries are done and no daemon can be run, Exim does not need root
33566 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33567 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33568 the advantages and disadvantages of running without root privilege.
33569
33570
33571
33572
33573 . ////////////////////////////////////////////////////////////////////////////
33574 . ////////////////////////////////////////////////////////////////////////////
33575
33576 .chapter "Log files" "CHAPlog"
33577 .scindex IIDloggen "log" "general description"
33578 .cindex "log" "types of"
33579 Exim writes three different logs, referred to as the main log, the reject log,
33580 and the panic log:
33581
33582 .ilist
33583 .cindex "main log"
33584 The main log records the arrival of each message and each delivery in a single
33585 line in each case. The format is as compact as possible, in an attempt to keep
33586 down the size of log files. Two-character flag sequences make it easy to pick
33587 out these lines. A number of other events are recorded in the main log. Some of
33588 them are optional, in which case the &%log_selector%& option controls whether
33589 they are included or not. A Perl script called &'eximstats'&, which does simple
33590 analysis of main log files, is provided in the Exim distribution (see section
33591 &<<SECTmailstat>>&).
33592 .next
33593 .cindex "reject log"
33594 The reject log records information from messages that are rejected as a result
33595 of a configuration option (that is, for policy reasons).
33596 The first line of each rejection is a copy of the line that is also written to
33597 the main log. Then, if the message's header has been read at the time the log
33598 is written, its contents are written to this log. Only the original header
33599 lines are available; header lines added by ACLs are not logged. You can use the
33600 reject log to check that your policy controls are working correctly; on a busy
33601 host this may be easier than scanning the main log for rejection messages. You
33602 can suppress the writing of the reject log by setting &%write_rejectlog%&
33603 false.
33604 .next
33605 .cindex "panic log"
33606 .cindex "system log"
33607 When certain serious errors occur, Exim writes entries to its panic log. If the
33608 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33609 are usually written to the main log as well, but can get lost amid the mass of
33610 other entries. The panic log should be empty under normal circumstances. It is
33611 therefore a good idea to check it (or to have a &'cron'& script check it)
33612 regularly, in order to become aware of any problems. When Exim cannot open its
33613 panic log, it tries as a last resort to write to the system log (syslog). This
33614 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33615 message itself is written at priority LOG_CRIT.
33616 .endlist
33617
33618 Every log line starts with a timestamp, in the format shown in the following
33619 example. Note that many of the examples shown in this chapter are line-wrapped.
33620 In the log file, this would be all on one line:
33621 .code
33622 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33623   by QUIT
33624 .endd
33625 By default, the timestamps are in the local timezone. There are two
33626 ways of changing this:
33627
33628 .ilist
33629 You can set the &%timezone%& option to a different time zone; in particular, if
33630 you set
33631 .code
33632 timezone = UTC
33633 .endd
33634 the timestamps will be in UTC (aka GMT).
33635 .next
33636 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33637 example:
33638 .code
33639 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33640 .endd
33641 .endlist
33642
33643 .cindex "log" "process ids in"
33644 .cindex "pid (process id)" "in log lines"
33645 Exim does not include its process id in log lines by default, but you can
33646 request that it does so by specifying the &`pid`& log selector (see section
33647 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33648 brackets, immediately after the time and date.
33649
33650
33651
33652
33653 .section "Where the logs are written" "SECTwhelogwri"
33654 .cindex "log" "destination"
33655 .cindex "log" "to file"
33656 .cindex "log" "to syslog"
33657 .cindex "syslog"
33658 The logs may be written to local files, or to syslog, or both. However, it
33659 should be noted that many syslog implementations use UDP as a transport, and
33660 are therefore unreliable in the sense that messages are not guaranteed to
33661 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33662 It has also been reported that on large log files (tens of megabytes) you may
33663 need to tweak syslog to prevent it syncing the file with each write &-- on
33664 Linux this has been seen to make syslog take 90% plus of CPU time.
33665
33666 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33667 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33668 configuration. This latter string is expanded, so it can contain, for example,
33669 references to the host name:
33670 .code
33671 log_file_path = /var/log/$primary_hostname/exim_%slog
33672 .endd
33673 It is generally advisable, however, to set the string in &_Local/Makefile_&
33674 rather than at run time, because then the setting is available right from the
33675 start of Exim's execution. Otherwise, if there's something it wants to log
33676 before it has read the configuration file (for example, an error in the
33677 configuration file) it will not use the path you want, and may not be able to
33678 log at all.
33679
33680 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33681 list, currently limited to at most two items. This is one option where the
33682 facility for changing a list separator may not be used. The list must always be
33683 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33684 otherwise the item must either be an absolute path, containing &`%s`& at the
33685 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33686 implying the use of a default path.
33687
33688 When Exim encounters an empty item in the list, it searches the list defined by
33689 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33690 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33691 mean &"use the path specified at build time"&. It no such item exists, log
33692 files are written in the &_log_& subdirectory of the spool directory. This is
33693 equivalent to the setting:
33694 .code
33695 log_file_path = $spool_directory/log/%slog
33696 .endd
33697 If you do not specify anything at build time or run time, that is where the
33698 logs are written.
33699
33700 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33701 are in use &-- see section &<<SECTdatlogfil>>& below.
33702
33703 Here are some examples of possible settings:
33704 .display
33705 &`LOG_FILE_PATH=syslog                    `& syslog only
33706 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33707 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33708 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33709 .endd
33710 If there are more than two paths in the list, the first is used and a panic
33711 error is logged.
33712
33713
33714
33715 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33716 .cindex "log" "cycling local files"
33717 .cindex "cycling logs"
33718 .cindex "&'exicyclog'&"
33719 .cindex "log" "local files; writing to"
33720 Some operating systems provide centralized and standardized methods for cycling
33721 log files. For those that do not, a utility script called &'exicyclog'& is
33722 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33723 main and reject logs each time it is called. The maximum number of old logs to
33724 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33725
33726 An Exim delivery process opens the main log when it first needs to write to it,
33727 and it keeps the file open in case subsequent entries are required &-- for
33728 example, if a number of different deliveries are being done for the same
33729 message. However, remote SMTP deliveries can take a long time, and this means
33730 that the file may be kept open long after it is renamed if &'exicyclog'& or
33731 something similar is being used to rename log files on a regular basis. To
33732 ensure that a switch of log files is noticed as soon as possible, Exim calls
33733 &[stat()]& on the main log's name before reusing an open file, and if the file
33734 does not exist, or its inode has changed, the old file is closed and Exim
33735 tries to open the main log from scratch. Thus, an old log file may remain open
33736 for quite some time, but no Exim processes should write to it once it has been
33737 renamed.
33738
33739
33740
33741 .section "Datestamped log files" "SECTdatlogfil"
33742 .cindex "log" "datestamped files"
33743 Instead of cycling the main and reject log files by renaming them
33744 periodically, some sites like to use files whose names contain a datestamp,
33745 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33746 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33747 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33748 point where the datestamp is required. For example:
33749 .code
33750 log_file_path = /var/spool/exim/log/%slog-%D
33751 log_file_path = /var/log/exim-%s-%D.log
33752 log_file_path = /var/spool/exim/log/%D-%slog
33753 log_file_path = /var/log/exim/%s.%M
33754 .endd
33755 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33756 examples of names generated by the above examples:
33757 .code
33758 /var/spool/exim/log/mainlog-20021225
33759 /var/log/exim-reject-20021225.log
33760 /var/spool/exim/log/20021225-mainlog
33761 /var/log/exim/main.200212
33762 .endd
33763 When this form of log file is specified, Exim automatically switches to new
33764 files at midnight. It does not make any attempt to compress old logs; you
33765 will need to write your own script if you require this. You should not
33766 run &'exicyclog'& with this form of logging.
33767
33768 The location of the panic log is also determined by &%log_file_path%&, but it
33769 is not datestamped, because rotation of the panic log does not make sense.
33770 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33771 the string. In addition, if it immediately follows a slash, a following
33772 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33773 character is removed. Thus, the four examples above would give these panic
33774 log names:
33775 .code
33776 /var/spool/exim/log/paniclog
33777 /var/log/exim-panic.log
33778 /var/spool/exim/log/paniclog
33779 /var/log/exim/panic
33780 .endd
33781
33782
33783 .section "Logging to syslog" "SECID249"
33784 .cindex "log" "syslog; writing to"
33785 The use of syslog does not change what Exim logs or the format of its messages,
33786 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33787 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33788 that, the same strings are written to syslog as to log files. The syslog
33789 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33790 by default, but you can change these by setting the &%syslog_facility%& and
33791 &%syslog_processname%& options, respectively. If Exim was compiled with
33792 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33793 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33794 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33795 the time and host name to each line.
33796 The three log streams are mapped onto syslog priorities as follows:
33797
33798 .ilist
33799 &'mainlog'& is mapped to LOG_INFO
33800 .next
33801 &'rejectlog'& is mapped to LOG_NOTICE
33802 .next
33803 &'paniclog'& is mapped to LOG_ALERT
33804 .endlist
33805
33806 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33807 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33808 these are routed by syslog to the same place. You can suppress this duplication
33809 by setting &%syslog_duplication%& false.
33810
33811 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33812 entries contain multiple lines when headers are included. To cope with both
33813 these cases, entries written to syslog are split into separate &[syslog()]&
33814 calls at each internal newline, and also after a maximum of
33815 870 data characters. (This allows for a total syslog line length of 1024, when
33816 additions such as timestamps are added.) If you are running a syslog
33817 replacement that can handle lines longer than the 1024 characters allowed by
33818 RFC 3164, you should set
33819 .code
33820 SYSLOG_LONG_LINES=yes
33821 .endd
33822 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33823 lines, but it still splits at internal newlines in &'reject'& log entries.
33824
33825 To make it easy to re-assemble split lines later, each component of a split
33826 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33827 where <&'n'&> is the component number and <&'m'&> is the total number of
33828 components in the entry. The / delimiter is used when the line was split
33829 because it was too long; if it was split because of an internal newline, the \
33830 delimiter is used. For example, supposing the length limit to be 50 instead of
33831 870, the following would be the result of a typical rejection message to
33832 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33833 name, and pid as added by syslog:
33834 .code
33835 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33836 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33837 [3/5]  when scanning for sender: missing or malformed lo
33838 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33839 [5/5] mple>)
33840 .endd
33841 The same error might cause the following lines to be written to &"rejectlog"&
33842 (LOG_NOTICE):
33843 .code
33844 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33845 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33846 [3/18] er when scanning for sender: missing or malformed
33847 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33848 [5\18] .example>)
33849 [6\18] Recipients: ph10@some.domain.cam.example
33850 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33851 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33852 [9\18]        id 16RdAL-0006pc-00
33853 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33854 [11\18] 09:43 +0100
33855 [12\18] F From: <>
33856 [13\18]   Subject: this is a test header
33857 [18\18]   X-something: this is another header
33858 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33859 [16\18] le>
33860 [17\18] B Bcc:
33861 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33862 .endd
33863 Log lines that are neither too long nor contain newlines are written to syslog
33864 without modification.
33865
33866 If only syslog is being used, the Exim monitor is unable to provide a log tail
33867 display, unless syslog is routing &'mainlog'& to a file on the local host and
33868 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33869 where it is.
33870
33871
33872
33873 .section "Log line flags" "SECID250"
33874 One line is written to the main log for each message received, and for each
33875 successful, unsuccessful, and delayed delivery. These lines can readily be
33876 picked out by the distinctive two-character flags that immediately follow the
33877 timestamp. The flags are:
33878 .display
33879 &`<=`&     message arrival
33880 &`=>`&     normal message delivery
33881 &`->`&     additional address in same delivery
33882 .new
33883 &`>>`&     cutthrough message delivery
33884 .wen
33885 &`*>`&     delivery suppressed by &%-N%&
33886 &`**`&     delivery failed; address bounced
33887 &`==`&     delivery deferred; temporary problem
33888 .endd
33889
33890
33891 .section "Logging message reception" "SECID251"
33892 .cindex "log" "reception line"
33893 The format of the single-line entry in the main log that is written for every
33894 message received is shown in the basic example below, which is split over
33895 several lines in order to fit it on the page:
33896 .code
33897 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33898   H=mailer.fict.example [192.168.123.123] U=exim
33899   P=smtp S=5678 id=<incoming message id>
33900 .endd
33901 The address immediately following &"<="& is the envelope sender address. A
33902 bounce message is shown with the sender address &"<>"&, and if it is locally
33903 generated, this is followed by an item of the form
33904 .code
33905 R=<message id>
33906 .endd
33907 which is a reference to the message that caused the bounce to be sent.
33908
33909 .cindex "HELO"
33910 .cindex "EHLO"
33911 For messages from other hosts, the H and U fields identify the remote host and
33912 record the RFC 1413 identity of the user that sent the message, if one was
33913 received. The number given in square brackets is the IP address of the sending
33914 host. If there is a single, unparenthesized  host name in the H field, as
33915 above, it has been verified to correspond to the IP address (see the
33916 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33917 by the remote host in the SMTP HELO or EHLO command, and has not been
33918 verified. If verification yields a different name to that given for HELO or
33919 EHLO, the verified name appears first, followed by the HELO or EHLO
33920 name in parentheses.
33921
33922 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33923 without brackets, in the HELO or EHLO command, leading to entries in
33924 the log containing text like these examples:
33925 .code
33926 H=(10.21.32.43) [192.168.8.34]
33927 H=([10.21.32.43]) [192.168.8.34]
33928 .endd
33929 This can be confusing. Only the final address in square brackets can be relied
33930 on.
33931
33932 For locally generated messages (that is, messages not received over TCP/IP),
33933 the H field is omitted, and the U field contains the login name of the caller
33934 of Exim.
33935
33936 .cindex "authentication" "logging"
33937 .cindex "AUTH" "logging"
33938 For all messages, the P field specifies the protocol used to receive the
33939 message. This is the value that is stored in &$received_protocol$&. In the case
33940 of incoming SMTP messages, the value indicates whether or not any SMTP
33941 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33942 session was encrypted, there is an additional X field that records the cipher
33943 suite that was used.
33944
33945 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33946 hosts that have authenticated themselves using the SMTP AUTH command. The first
33947 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33948 there is an additional item A= followed by the name of the authenticator that
33949 was used. If an authenticated identification was set up by the authenticator's
33950 &%server_set_id%& option, this is logged too, separated by a colon from the
33951 authenticator name.
33952
33953 .cindex "size" "of message"
33954 The id field records the existing message id, if present. The size of the
33955 received message is given by the S field. When the message is delivered,
33956 headers may be removed or added, so that the size of delivered copies of the
33957 message may not correspond with this value (and indeed may be different to each
33958 other).
33959
33960 The &%log_selector%& option can be used to request the logging of additional
33961 data when a message is received. See section &<<SECTlogselector>>& below.
33962
33963
33964
33965 .section "Logging deliveries" "SECID252"
33966 .cindex "log" "delivery line"
33967 The format of the single-line entry in the main log that is written for every
33968 delivery is shown in one of the examples below, for local and remote
33969 deliveries, respectively. Each example has been split into two lines in order
33970 to fit it on the page:
33971 .code
33972 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33973   <marv@hitch.fict.example> R=localuser T=local_delivery
33974 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33975   monk@holistic.fict.example R=dnslookup T=remote_smtp
33976   H=holistic.fict.example [192.168.234.234]
33977 .endd
33978 For ordinary local deliveries, the original address is given in angle brackets
33979 after the final delivery address, which might be a pipe or a file. If
33980 intermediate address(es) exist between the original and the final address, the
33981 last of these is given in parentheses after the final address. The R and T
33982 fields record the router and transport that were used to process the address.
33983
33984 .new
33985 If SMTP AUTH was used for the delivery there is an additional item A=
33986 followed by the name of the authenticator that was used.
33987 If an authenticated identification was set up by the authenticator's &%client_set_id%&
33988 option, this is logged too, separated by a colon from the authenticator name.
33989 .wen
33990
33991 If a shadow transport was run after a successful local delivery, the log line
33992 for the successful delivery has an item added on the end, of the form
33993 .display
33994 &`ST=<`&&'shadow transport name'&&`>`&
33995 .endd
33996 If the shadow transport did not succeed, the error message is put in
33997 parentheses afterwards.
33998
33999 .cindex "asterisk" "after IP address"
34000 When more than one address is included in a single delivery (for example, two
34001 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34002 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34003 down a single SMTP connection, an asterisk follows the IP address in the log
34004 lines for the second and subsequent messages.
34005
34006 .new
34007 .cindex "delivery" "cutthrough; logging"
34008 .cindex "cutthrough" "logging"
34009 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34010 line precedes the reception line, since cutthrough waits for a possible
34011 rejection from the destination in case it can reject the sourced item.
34012 .wen
34013
34014 The generation of a reply message by a filter file gets logged as a
34015 &"delivery"& to the addressee, preceded by &">"&.
34016
34017 The &%log_selector%& option can be used to request the logging of additional
34018 data when a message is delivered. See section &<<SECTlogselector>>& below.
34019
34020
34021 .section "Discarded deliveries" "SECID253"
34022 .cindex "discarded messages"
34023 .cindex "message" "discarded"
34024 .cindex "delivery" "discarded; logging"
34025 When a message is discarded as a result of the command &"seen finish"& being
34026 obeyed in a filter file which generates no deliveries, a log entry of the form
34027 .code
34028 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34029   <low.club@bridge.example> R=userforward
34030 .endd
34031 is written, to record why no deliveries are logged. When a message is discarded
34032 because it is aliased to &":blackhole:"& the log line is like this:
34033 .code
34034 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34035   <hole@nowhere.example> R=blackhole_router
34036 .endd
34037
34038
34039 .section "Deferred deliveries" "SECID254"
34040 When a delivery is deferred, a line of the following form is logged:
34041 .code
34042 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34043   R=dnslookup T=smtp defer (146): Connection refused
34044 .endd
34045 In the case of remote deliveries, the error is the one that was given for the
34046 last IP address that was tried. Details of individual SMTP failures are also
34047 written to the log, so the above line would be preceded by something like
34048 .code
34049 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34050   mail1.endrest.example [192.168.239.239]: Connection refused
34051 .endd
34052 When a deferred address is skipped because its retry time has not been reached,
34053 a message is written to the log, but this can be suppressed by setting an
34054 appropriate value in &%log_selector%&.
34055
34056
34057
34058 .section "Delivery failures" "SECID255"
34059 .cindex "delivery" "failure; logging"
34060 If a delivery fails because an address cannot be routed, a line of the
34061 following form is logged:
34062 .code
34063 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34064   <jim@trek99.example>: unknown mail domain
34065 .endd
34066 If a delivery fails at transport time, the router and transport are shown, and
34067 the response from the remote host is included, as in this example:
34068 .code
34069 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34070   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34071   after pipelined RCPT TO:<ace400@pb.example>: host
34072   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34073   <ace400@pb.example>...Addressee unknown
34074 .endd
34075 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34076 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34077 disabling PIPELINING. The log lines for all forms of delivery failure are
34078 flagged with &`**`&.
34079
34080
34081
34082 .section "Fake deliveries" "SECID256"
34083 .cindex "delivery" "fake; logging"
34084 If a delivery does not actually take place because the &%-N%& option has been
34085 used to suppress it, a normal delivery line is written to the log, except that
34086 &"=>"& is replaced by &"*>"&.
34087
34088
34089
34090 .section "Completion" "SECID257"
34091 A line of the form
34092 .code
34093 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34094 .endd
34095 is written to the main log when a message is about to be removed from the spool
34096 at the end of its processing.
34097
34098
34099
34100
34101 .section "Summary of Fields in Log Lines" "SECID258"
34102 .cindex "log" "summary of fields"
34103 A summary of the field identifiers that are used in log lines is shown in
34104 the following table:
34105 .display
34106 &`A   `&        authenticator name (and optional id and sender)
34107 &`C   `&        SMTP confirmation on delivery
34108 &`    `&        command list for &"no mail in SMTP session"&
34109 &`CV  `&        certificate verification status
34110 &`D   `&        duration of &"no mail in SMTP session"&
34111 &`DN  `&        distinguished name from peer certificate
34112 &`DT  `&        on &`=>`& lines: time taken for a delivery
34113 &`F   `&        sender address (on delivery lines)
34114 &`H   `&        host name and IP address
34115 &`I   `&        local interface used
34116 &`id  `&        message id for incoming message
34117 &`P   `&        on &`<=`& lines: protocol used
34118 &`    `&        on &`=>`& and &`**`& lines: return path
34119 &`QT  `&        on &`=>`& lines: time spent on queue so far
34120 &`    `&        on &"Completed"& lines: time spent on queue
34121 &`R   `&        on &`<=`& lines: reference for local bounce
34122 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34123 &`S   `&        size of message
34124 &`ST  `&        shadow transport name
34125 &`T   `&        on &`<=`& lines: message subject (topic)
34126 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34127 &`U   `&        local user or RFC 1413 identity
34128 &`X   `&        TLS cipher suite
34129 .endd
34130
34131
34132 .section "Other log entries" "SECID259"
34133 Various other types of log entry are written from time to time. Most should be
34134 self-explanatory. Among the more common are:
34135
34136 .ilist
34137 .cindex "retry" "time not reached"
34138 &'retry time not reached'&&~&~An address previously suffered a temporary error
34139 during routing or local delivery, and the time to retry has not yet arrived.
34140 This message is not written to an individual message log file unless it happens
34141 during the first delivery attempt.
34142 .next
34143 &'retry time not reached for any host'&&~&~An address previously suffered
34144 temporary errors during remote delivery, and the retry time has not yet arrived
34145 for any of the hosts to which it is routed.
34146 .next
34147 .cindex "spool directory" "file locked"
34148 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34149 some other Exim process is already working on the message. This can be quite
34150 common if queue running processes are started at frequent intervals. The
34151 &'exiwhat'& utility script can be used to find out what Exim processes are
34152 doing.
34153 .next
34154 .cindex "error" "ignored"
34155 &'error ignored'&&~&~There are several circumstances that give rise to this
34156 message:
34157 .olist
34158 Exim failed to deliver a bounce message whose age was greater than
34159 &%ignore_bounce_errors_after%&. The bounce was discarded.
34160 .next
34161 A filter file set up a delivery using the &"noerror"& option, and the delivery
34162 failed. The delivery was discarded.
34163 .next
34164 A delivery set up by a router configured with
34165 . ==== As this is a nested list, any displays it contains must be indented
34166 . ==== as otherwise they are too far to the left.
34167 .code
34168     errors_to = <>
34169 .endd
34170 failed. The delivery was discarded.
34171 .endlist olist
34172 .endlist ilist
34173
34174
34175
34176
34177
34178 .section "Reducing or increasing what is logged" "SECTlogselector"
34179 .cindex "log" "selectors"
34180 By setting the &%log_selector%& global option, you can disable some of Exim's
34181 default logging, or you can request additional logging. The value of
34182 &%log_selector%& is made up of names preceded by plus or minus characters. For
34183 example:
34184 .code
34185 log_selector = +arguments -retry_defer
34186 .endd
34187 The list of optional log items is in the following table, with the default
34188 selection marked by asterisks:
34189 .display
34190 .new
34191 &` 8bitmime                   `&  received 8BITMIME status
34192 .wen
34193 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34194 &` address_rewrite            `&  address rewriting
34195 &` all_parents                `&  all parents in => lines
34196 &` arguments                  `&  command line arguments
34197 &`*connection_reject          `&  connection rejections
34198 &`*delay_delivery             `&  immediate delivery delayed
34199 &` deliver_time               `&  time taken to perform delivery
34200 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34201 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34202 &`*etrn                       `&  ETRN commands
34203 &`*host_lookup_failed         `&  as it says
34204 &` ident_timeout              `&  timeout for ident connection
34205 &` incoming_interface         `&  incoming interface on <= lines
34206 &` incoming_port              `&  incoming port on <= lines
34207 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34208 &` outgoing_port              `&  add remote port to => lines
34209 &`*queue_run                  `&  start and end queue runs
34210 &` queue_time                 `&  time on queue for one recipient
34211 &` queue_time_overall         `&  time on queue for whole message
34212 &` pid                        `&  Exim process id
34213 &` received_recipients        `&  recipients on <= lines
34214 &` received_sender            `&  sender on <= lines
34215 &`*rejected_header            `&  header contents on reject log
34216 &`*retry_defer                `&  &"retry time not reached"&
34217 &` return_path_on_delivery    `&  put return path on => and ** lines
34218 &` sender_on_delivery         `&  add sender to => lines
34219 &`*sender_verify_fail         `&  sender verification failures
34220 &`*size_reject                `&  rejection because too big
34221 &`*skip_delivery              `&  delivery skipped in a queue run
34222 .new
34223 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34224 .wen
34225 &` smtp_connection            `&  SMTP connections
34226 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34227 .new
34228 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34229 .wen
34230 &` smtp_no_mail               `&  session with no MAIL commands
34231 &` smtp_protocol_error        `&  SMTP protocol errors
34232 &` smtp_syntax_error          `&  SMTP syntax errors
34233 &` subject                    `&  contents of &'Subject:'& on <= lines
34234 &` tls_certificate_verified   `&  certificate verification status
34235 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34236 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34237 &` tls_sni                    `&  TLS SNI on <= lines
34238 &` unknown_in_list            `&  DNS lookup failed in list match
34239
34240 &` all                        `&  all of the above
34241 .endd
34242 More details on each of these items follows:
34243
34244 .ilist
34245 .new
34246 .cindex "8BITMIME"
34247 .cindex "log" "8BITMIME"
34248 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34249 which may help in tracking down interoperability issues with ancient MTAs
34250 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34251 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34252 &`7BIT`& and &`8BITMIME`& respectively.
34253 .wen
34254 .next
34255 .cindex "&%warn%& ACL verb" "log when skipping"
34256 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34257 its conditions cannot be evaluated, a log line to this effect is written if
34258 this log selector is set.
34259 .next
34260 .cindex "log" "rewriting"
34261 .cindex "rewriting" "logging"
34262 &%address_rewrite%&: This applies both to global rewrites and per-transport
34263 rewrites, but not to rewrites in filters run as an unprivileged user (because
34264 such users cannot access the log).
34265 .next
34266 .cindex "log" "full parentage"
34267 &%all_parents%&: Normally only the original and final addresses are logged on
34268 delivery lines; with this selector, intermediate parents are given in
34269 parentheses between them.
34270 .next
34271 .cindex "log" "Exim arguments"
34272 .cindex "Exim arguments, logging"
34273 &%arguments%&: This causes Exim to write the arguments with which it was called
34274 to the main log, preceded by the current working directory. This is a debugging
34275 feature, added to make it easier to find out how certain MUAs call
34276 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34277 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34278 that are empty or that contain white space are quoted. Non-printing characters
34279 are shown as escape sequences. This facility cannot log unrecognized arguments,
34280 because the arguments are checked before the configuration file is read. The
34281 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34282 between the caller and Exim.
34283 .next
34284 .cindex "log" "connection rejections"
34285 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34286 connection is rejected, for whatever reason.
34287 .next
34288 .cindex "log" "delayed delivery"
34289 .cindex "delayed delivery, logging"
34290 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34291 started for an incoming message because the load is too high or too many
34292 messages were received on one connection. Logging does not occur if no delivery
34293 process is started because &%queue_only%& is set or &%-odq%& was used.
34294 .next
34295 .cindex "log" "delivery duration"
34296 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34297 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34298 .next
34299 .cindex "log" "message size on delivery"
34300 .cindex "size" "of message"
34301 &%delivery_size%&: For each delivery, the size of message delivered is added to
34302 the &"=>"& line, tagged with S=.
34303 .next
34304 .cindex "log" "dnslist defer"
34305 .cindex "DNS list" "logging defer"
34306 .cindex "black list (DNS)"
34307 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34308 DNS black list suffers a temporary error.
34309 .next
34310 .cindex "log" "ETRN commands"
34311 .cindex "ETRN" "logging"
34312 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34313 is run to determine whether or not it is actually accepted. An invalid ETRN
34314 command, or one received within a message transaction is not logged by this
34315 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34316 .next
34317 .cindex "log" "host lookup failure"
34318 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34319 any addresses, or when a lookup of an IP address fails to find a host name, a
34320 log line is written. This logging does not apply to direct DNS lookups when
34321 routing email addresses, but it does apply to &"byname"& lookups.
34322 .next
34323 .cindex "log" "ident timeout"
34324 .cindex "RFC 1413" "logging timeout"
34325 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34326 client's ident port times out.
34327 .next
34328 .cindex "log" "incoming interface"
34329 .cindex "interface" "logging"
34330 &%incoming_interface%&: The interface on which a message was received is added
34331 to the &"<="& line as an IP address in square brackets, tagged by I= and
34332 followed by a colon and the port number. The local interface and port are also
34333 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34334 rejection lines.
34335 .next
34336 .cindex "log" "incoming remote port"
34337 .cindex "port" "logging remote"
34338 .cindex "TCP/IP" "logging incoming remote port"
34339 .vindex "&$sender_fullhost$&"
34340 .vindex "&$sender_rcvhost$&"
34341 &%incoming_port%&: The remote port number from which a message was received is
34342 added to log entries and &'Received:'& header lines, following the IP address
34343 in square brackets, and separated from it by a colon. This is implemented by
34344 changing the value that is put in the &$sender_fullhost$& and
34345 &$sender_rcvhost$& variables. Recording the remote port number has become more
34346 important with the widening use of NAT (see RFC 2505).
34347 .next
34348 .cindex "log" "dropped connection"
34349 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34350 connection is unexpectedly dropped.
34351 .next
34352 .cindex "log" "outgoing remote port"
34353 .cindex "port" "logging outgoint remote"
34354 .cindex "TCP/IP" "logging ougtoing remote port"
34355 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34356 containing => tags) following the IP address. This option is not included in
34357 the default setting, because for most ordinary configurations, the remote port
34358 number is always 25 (the SMTP port).
34359 .next
34360 .cindex "log" "process ids in"
34361 .cindex "pid (process id)" "in log lines"
34362 &%pid%&: The current process id is added to every log line, in square brackets,
34363 immediately after the time and date.
34364 .next
34365 .cindex "log" "queue run"
34366 .cindex "queue runner" "logging"
34367 &%queue_run%&: The start and end of every queue run are logged.
34368 .next
34369 .cindex "log" "queue time"
34370 &%queue_time%&: The amount of time the message has been in the queue on the
34371 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34372 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34373 includes reception time as well as the delivery time for the current address.
34374 This means that it may be longer than the difference between the arrival and
34375 delivery log line times, because the arrival log line is not written until the
34376 message has been successfully received.
34377 .next
34378 &%queue_time_overall%&: The amount of time the message has been in the queue on
34379 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34380 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34381 message, so it includes reception time as well as the total delivery time.
34382 .next
34383 .cindex "log" "recipients"
34384 &%received_recipients%&: The recipients of a message are listed in the main log
34385 as soon as the message is received. The list appears at the end of the log line
34386 that is written when a message is received, preceded by the word &"for"&. The
34387 addresses are listed after they have been qualified, but before any rewriting
34388 has taken place.
34389 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34390 in the list.
34391 .next
34392 .cindex "log" "sender reception"
34393 &%received_sender%&: The unrewritten original sender of a message is added to
34394 the end of the log line that records the message's arrival, after the word
34395 &"from"& (before the recipients if &%received_recipients%& is also set).
34396 .next
34397 .cindex "log" "header lines for rejection"
34398 &%rejected_header%&: If a message's header has been received at the time a
34399 rejection is written to the reject log, the complete header is added to the
34400 log. Header logging can be turned off individually for messages that are
34401 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34402 .next
34403 .cindex "log" "retry defer"
34404 &%retry_defer%&: A log line is written if a delivery is deferred because a
34405 retry time has not yet been reached. However, this &"retry time not reached"&
34406 message is always omitted from individual message logs after the first delivery
34407 attempt.
34408 .next
34409 .cindex "log" "return path"
34410 &%return_path_on_delivery%&: The return path that is being transmitted with
34411 the message is included in delivery and bounce lines, using the tag P=.
34412 This is omitted if no delivery actually happens, for example, if routing fails,
34413 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34414 .next
34415 .cindex "log" "sender on delivery"
34416 &%sender_on_delivery%&: The message's sender address is added to every delivery
34417 and bounce line, tagged by F= (for &"from"&).
34418 This is the original sender that was received with the message; it is not
34419 necessarily the same as the outgoing return path.
34420 .next
34421 .cindex "log" "sender verify failure"
34422 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34423 gives details of a sender verification failure is not written. Log lines for
34424 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34425 detail is lost.
34426 .next
34427 .cindex "log" "size rejection"
34428 &%size_reject%&: A log line is written whenever a message is rejected because
34429 it is too big.
34430 .next
34431 .cindex "log" "frozen messages; skipped"
34432 .cindex "frozen messages" "logging skipping"
34433 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34434 queue run because it is frozen or because another process is already delivering
34435 it.
34436 .cindex "&""spool file is locked""&"
34437 The message that is written is &"spool file is locked"&.
34438 .next
34439 .cindex "log" "smtp confirmation"
34440 .cindex "SMTP" "logging confirmation"
34441 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34442 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34443 A number of MTAs (including Exim) return an identifying string in this
34444 response.
34445 .next
34446 .cindex "log" "SMTP connections"
34447 .cindex "SMTP" "logging connections"
34448 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34449 established or closed, unless the connection is from a host that matches
34450 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34451 only when the closure is unexpected.) This applies to connections from local
34452 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34453 dropped in the middle of a message, a log line is always written, whether or
34454 not this selector is set, but otherwise nothing is written at the start and end
34455 of connections unless this selector is enabled.
34456
34457 For TCP/IP connections to an Exim daemon, the current number of connections is
34458 included in the log message for each new connection, but note that the count is
34459 reset if the daemon is restarted.
34460 Also, because connections are closed (and the closure is logged) in
34461 subprocesses, the count may not include connections that have been closed but
34462 whose termination the daemon has not yet noticed. Thus, while it is possible to
34463 match up the opening and closing of connections in the log, the value of the
34464 logged counts may not be entirely accurate.
34465 .next
34466 .cindex "log" "SMTP transaction; incomplete"
34467 .cindex "SMTP" "logging incomplete transactions"
34468 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34469 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34470 and the message sender plus any accepted recipients are included in the log
34471 line. This can provide evidence of dictionary attacks.
34472 .next
34473 .cindex "log" "non-MAIL SMTP sessions"
34474 .cindex "MAIL" "logging session without"
34475 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34476 connection terminates without having issued a MAIL command. This includes both
34477 the case when the connection is dropped, and the case when QUIT is used. It
34478 does not include cases where the connection is rejected right at the start (by
34479 an ACL, or because there are too many connections, or whatever). These cases
34480 already have their own log lines.
34481
34482 The log line that is written contains the identity of the client in the usual
34483 way, followed by D= and a time, which records the duration of the connection.
34484 If the connection was authenticated, this fact is logged exactly as it is for
34485 an incoming message, with an A= item. If the connection was encrypted, CV=,
34486 DN=, and X= items may appear as they do for an incoming message, controlled by
34487 the same logging options.
34488
34489 Finally, if any SMTP commands were issued during the connection, a C= item
34490 is added to the line, listing the commands that were used. For example,
34491 .code
34492 C=EHLO,QUIT
34493 .endd
34494 shows that the client issued QUIT straight after EHLO. If there were fewer
34495 than 20 commands, they are all listed. If there were more than 20 commands,
34496 the last 20 are listed, preceded by &"..."&. However, with the default
34497 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34498 have been aborted before 20 non-mail commands are processed.
34499 .next
34500 .new
34501 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34502 colon-separated, is appended to the A= item for a message arrival or delivery
34503 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34504 was accepted or used.
34505 .wen
34506 .next
34507 .cindex "log" "SMTP protocol error"
34508 .cindex "SMTP" "logging protocol error"
34509 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34510 encountered. Exim does not have perfect detection of all protocol errors
34511 because of transmission delays and the use of pipelining. If PIPELINING has
34512 been advertised to a client, an Exim server assumes that the client will use
34513 it, and therefore it does not count &"expected"& errors (for example, RCPT
34514 received after rejecting MAIL) as protocol errors.
34515 .next
34516 .cindex "SMTP" "logging syntax errors"
34517 .cindex "SMTP" "syntax errors; logging"
34518 .cindex "SMTP" "unknown command; logging"
34519 .cindex "log" "unknown SMTP command"
34520 .cindex "log" "SMTP syntax error"
34521 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34522 encountered. An unrecognized command is treated as a syntax error. For an
34523 external connection, the host identity is given; for an internal connection
34524 using &%-bs%& the sender identification (normally the calling user) is given.
34525 .next
34526 .cindex "log" "subject"
34527 .cindex "subject, logging"
34528 &%subject%&: The subject of the message is added to the arrival log line,
34529 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34530 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34531 specifies whether characters with values greater than 127 should be logged
34532 unchanged, or whether they should be rendered as escape sequences.
34533 .next
34534 .cindex "log" "certificate verification"
34535 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34536 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34537 verified, and &`CV=no`& if not.
34538 .next
34539 .cindex "log" "TLS cipher"
34540 .cindex "TLS" "logging cipher"
34541 &%tls_cipher%&: When a message is sent or received over an encrypted
34542 connection, the cipher suite used is added to the log line, preceded by X=.
34543 .next
34544 .cindex "log" "TLS peer DN"
34545 .cindex "TLS" "logging peer DN"
34546 &%tls_peerdn%&: When a message is sent or received over an encrypted
34547 connection, and a certificate is supplied by the remote host, the peer DN is
34548 added to the log line, preceded by DN=.
34549 .next
34550 .cindex "log" "TLS SNI"
34551 .cindex "TLS" "logging SNI"
34552 &%tls_sni%&: When a message is received over an encrypted connection, and
34553 the remote host provided the Server Name Indication extension, the SNI is
34554 added to the log line, preceded by SNI=.
34555 .next
34556 .cindex "log" "DNS failure in list"
34557 &%unknown_in_list%&: This setting causes a log entry to be written when the
34558 result of a list match is failure because a DNS lookup failed.
34559 .endlist
34560
34561
34562 .section "Message log" "SECID260"
34563 .cindex "message" "log file for"
34564 .cindex "log" "message log; description of"
34565 .cindex "&_msglog_& directory"
34566 .oindex "&%preserve_message_logs%&"
34567 In addition to the general log files, Exim writes a log file for each message
34568 that it handles. The names of these per-message logs are the message ids, and
34569 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34570 message log contains copies of the log lines that apply to the message. This
34571 makes it easier to inspect the status of an individual message without having
34572 to search the main log. A message log is deleted when processing of the message
34573 is complete, unless &%preserve_message_logs%& is set, but this should be used
34574 only with great care because they can fill up your disk very quickly.
34575
34576 On a heavily loaded system, it may be desirable to disable the use of
34577 per-message logs, in order to reduce disk I/O. This can be done by setting the
34578 &%message_logs%& option false.
34579 .ecindex IIDloggen
34580
34581
34582
34583
34584 . ////////////////////////////////////////////////////////////////////////////
34585 . ////////////////////////////////////////////////////////////////////////////
34586
34587 .chapter "Exim utilities" "CHAPutils"
34588 .scindex IIDutils "utilities"
34589 A number of utility scripts and programs are supplied with Exim and are
34590 described in this chapter. There is also the Exim Monitor, which is covered in
34591 the next chapter. The utilities described here are:
34592
34593 .itable none 0 0 3  7* left  15* left  40* left
34594 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34595   "list what Exim processes are doing"
34596 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34597 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34598 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34599 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34600                                                 various criteria"
34601 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34602 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34603   "extract statistics from the log"
34604 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34605   "check address acceptance from given IP"
34606 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34607 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34608 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34609 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34610 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34611 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34612 .endtable
34613
34614 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34615 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34616 &url(http://duncanthrax.net/exilog/) for details.
34617
34618
34619
34620
34621 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34622 .cindex "&'exiwhat'&"
34623 .cindex "process, querying"
34624 .cindex "SIGUSR1"
34625 On operating systems that can restart a system call after receiving a signal
34626 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34627 a line describing what it is doing to the file &_exim-process.info_& in the
34628 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34629 processes it can find, having first emptied the file. It then waits for one
34630 second to allow the Exim processes to react before displaying the results. In
34631 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34632 send the signal to the Exim processes, so it is normally run as root.
34633
34634 &*Warning*&: This is not an efficient process. It is intended for occasional
34635 use by system administrators. It is not sensible, for example, to set up a
34636 script that sends SIGUSR1 signals to Exim processes at short intervals.
34637
34638
34639 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34640 varies in different operating systems. Not only are different options used,
34641 but the format of the output is different. For this reason, there are some
34642 system configuration options that configure exactly how &'exiwhat'& works. If
34643 it doesn't seem to be working for you, check the following compile-time
34644 options:
34645 .display
34646 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34647 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34648 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34649 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34650 .endd
34651 An example of typical output from &'exiwhat'& is
34652 .code
34653 164 daemon: -q1h, listening on port 25
34654 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34655 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34656   [10.19.42.42] (editor@ref.example)
34657 10592 handling incoming call from [192.168.243.242]
34658 10628 accepting a local non-SMTP message
34659 .endd
34660 The first number in the output line is the process number. The third line has
34661 been split here, in order to fit it on the page.
34662
34663
34664
34665 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34666 .cindex "&'exiqgrep'&"
34667 .cindex "queue" "grepping"
34668 This utility is a Perl script contributed by Matt Hubbard. It runs
34669 .code
34670 exim -bpu
34671 .endd
34672 to obtain a queue listing with undelivered recipients only, and then greps the
34673 output to select messages that match given criteria. The following selection
34674 options are available:
34675
34676 .vlist
34677 .vitem &*-f*&&~<&'regex'&>
34678 Match the sender address using a case-insensitive search. The field that is
34679 tested is enclosed in angle brackets, so you can test for bounce messages with
34680 .code
34681 exiqgrep -f '^<>$'
34682 .endd
34683 .vitem &*-r*&&~<&'regex'&>
34684 Match a recipient address using a case-insensitve search. The field that is
34685 tested is not enclosed in angle brackets.
34686
34687 .vitem &*-s*&&~<&'regex'&>
34688 Match against the size field.
34689
34690 .vitem &*-y*&&~<&'seconds'&>
34691 Match messages that are younger than the given time.
34692
34693 .vitem &*-o*&&~<&'seconds'&>
34694 Match messages that are older than the given time.
34695
34696 .vitem &*-z*&
34697 Match only frozen messages.
34698
34699 .vitem &*-x*&
34700 Match only non-frozen messages.
34701 .endlist
34702
34703 The following options control the format of the output:
34704
34705 .vlist
34706 .vitem &*-c*&
34707 Display only the count of matching messages.
34708
34709 .vitem &*-l*&
34710 Long format &-- display the full message information as output by Exim. This is
34711 the default.
34712
34713 .vitem &*-i*&
34714 Display message ids only.
34715
34716 .vitem &*-b*&
34717 Brief format &-- one line per message.
34718
34719 .vitem &*-R*&
34720 Display messages in reverse order.
34721 .endlist
34722
34723 There is one more option, &%-h%&, which outputs a list of options.
34724
34725
34726
34727 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34728 .cindex "&'exiqsumm'&"
34729 .cindex "queue" "summary"
34730 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34731 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34732 running a command such as
34733 .code
34734 exim -bp | exiqsumm
34735 .endd
34736 The output consists of one line for each domain that has messages waiting for
34737 it, as in the following example:
34738 .code
34739 3   2322   74m   66m  msn.com.example
34740 .endd
34741 Each line lists the number of pending deliveries for a domain, their total
34742 volume, and the length of time that the oldest and the newest messages have
34743 been waiting. Note that the number of pending deliveries is greater than the
34744 number of messages when messages have more than one recipient.
34745
34746 A summary line is output at the end. By default the output is sorted on the
34747 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34748 the output to be sorted by oldest message and by count of messages,
34749 respectively. There are also three options that split the messages for each
34750 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34751 separates frozen messages, and &%-s%& separates messages according to their
34752 sender.
34753
34754 The output of &'exim -bp'& contains the original addresses in the message, so
34755 this also applies to the output from &'exiqsumm'&. No domains from addresses
34756 generated by aliasing or forwarding are included (unless the &%one_time%&
34757 option of the &(redirect)& router has been used to convert them into &"top
34758 level"& addresses).
34759
34760
34761
34762
34763 .section "Extracting specific information from the log (exigrep)" &&&
34764          "SECTextspeinf"
34765 .cindex "&'exigrep'&"
34766 .cindex "log" "extracts; grepping for"
34767 The &'exigrep'& utility is a Perl script that searches one or more main log
34768 files for entries that match a given pattern. When it finds a match, it
34769 extracts all the log entries for the relevant message, not just those that
34770 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34771 given message, or all mail for a given user, or for a given host, for example.
34772 The input files can be in Exim log format or syslog format.
34773 If a matching log line is not associated with a specific message, it is
34774 included in &'exigrep'&'s output without any additional lines. The usage is:
34775 .display
34776 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34777 .endd
34778 If no log file names are given on the command line, the standard input is read.
34779
34780 The &%-t%& argument specifies a number of seconds. It adds an additional
34781 condition for message selection. Messages that are complete are shown only if
34782 they spent more than <&'n'&> seconds on the queue.
34783
34784 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34785 makes it case-sensitive. This may give a performance improvement when searching
34786 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34787 option; with &%-I%& they do not. In both cases it is possible to change the
34788 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34789
34790 The &%-l%& option means &"literal"&, that is, treat all characters in the
34791 pattern as standing for themselves. Otherwise the pattern must be a Perl
34792 regular expression.
34793
34794 The &%-v%& option inverts the matching condition. That is, a line is selected
34795 if it does &'not'& match the pattern.
34796
34797 If the location of a &'zcat'& command is known from the definition of
34798 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34799 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34800
34801
34802 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34803 .cindex "&'exipick'&"
34804 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34805 lists messages from the queue according to a variety of criteria. For details
34806 of &'exipick'&'s facilities, visit the web page at
34807 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34808 the &%--help%& option.
34809
34810
34811 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34812 .cindex "log" "cycling local files"
34813 .cindex "cycling logs"
34814 .cindex "&'exicyclog'&"
34815 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34816 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34817 you are using log files with datestamps in their names (see section
34818 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34819 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34820 There are two command line options for &'exicyclog'&:
34821 .ilist
34822 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34823 default that is set when Exim is built. The default default is 10.
34824 .next
34825 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34826 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34827 overriding the script's default, which is to find the setting from Exim's
34828 configuration.
34829 .endlist
34830
34831 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34832 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34833 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34834 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34835 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34836 logs are handled similarly.
34837
34838 If the limit is greater than 99, the script uses 3-digit numbers such as
34839 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34840 to one that is greater, or &'vice versa'&, you will have to fix the names of
34841 any existing log files.
34842
34843 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34844 the end are deleted. All files with numbers greater than 01 are compressed,
34845 using a compression command which is configured by the COMPRESS_COMMAND
34846 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34847 root &%crontab%& entry of the form
34848 .code
34849 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34850 .endd
34851 assuming you have used the name &"exim"& for the Exim user. You can run
34852 &'exicyclog'& as root if you wish, but there is no need.
34853
34854
34855
34856 .section "Mail statistics (eximstats)" "SECTmailstat"
34857 .cindex "statistics"
34858 .cindex "&'eximstats'&"
34859 A Perl script called &'eximstats'& is provided for extracting statistical
34860 information from log files. The output is either plain text, or HTML.
34861 Exim log files are also supported by the &'Lire'& system produced by the
34862 LogReport Foundation &url(http://www.logreport.org).
34863
34864 The &'eximstats'& script has been hacked about quite a bit over time. The
34865 latest version is the result of some extensive revision by Steve Campbell. A
34866 lot of information is given by default, but there are options for suppressing
34867 various parts of it. Following any options, the arguments to the script are a
34868 list of files, which should be main log files. For example:
34869 .code
34870 eximstats -nr /var/spool/exim/log/mainlog.01
34871 .endd
34872 By default, &'eximstats'& extracts information about the number and volume of
34873 messages received from or delivered to various hosts. The information is sorted
34874 both by message count and by volume, and the top fifty hosts in each category
34875 are listed on the standard output. Similar information, based on email
34876 addresses or domains instead of hosts can be requested by means of various
34877 options. For messages delivered and received locally, similar statistics are
34878 also produced per user.
34879
34880 The output also includes total counts and statistics about delivery errors, and
34881 histograms showing the number of messages received and deliveries made in each
34882 hour of the day. A delivery with more than one address in its envelope (for
34883 example, an SMTP transaction with more than one RCPT command) is counted
34884 as a single delivery by &'eximstats'&.
34885
34886 Though normally more deliveries than receipts are reported (as messages may
34887 have multiple recipients), it is possible for &'eximstats'& to report more
34888 messages received than delivered, even though the queue is empty at the start
34889 and end of the period in question. If an incoming message contains no valid
34890 recipients, no deliveries are recorded for it. A bounce message is handled as
34891 an entirely separate message.
34892
34893 &'eximstats'& always outputs a grand total summary giving the volume and number
34894 of messages received and deliveries made, and the number of hosts involved in
34895 each case. It also outputs the number of messages that were delayed (that is,
34896 not completely delivered at the first attempt), and the number that had at
34897 least one address that failed.
34898
34899 The remainder of the output is in sections that can be independently disabled
34900 or modified by various options. It consists of a summary of deliveries by
34901 transport, histograms of messages received and delivered per time interval
34902 (default per hour), information about the time messages spent on the queue,
34903 a list of relayed messages, lists of the top fifty sending hosts, local
34904 senders, destination hosts, and destination local users by count and by volume,
34905 and a list of delivery errors that occurred.
34906
34907 The relay information lists messages that were actually relayed, that is, they
34908 came from a remote host and were directly delivered to some other remote host,
34909 without being processed (for example, for aliasing or forwarding) locally.
34910
34911 There are quite a few options for &'eximstats'& to control exactly what it
34912 outputs. These are documented in the Perl script itself, and can be extracted
34913 by running the command &(perldoc)& on the script. For example:
34914 .code
34915 perldoc /usr/exim/bin/eximstats
34916 .endd
34917
34918 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34919 .cindex "&'exim_checkaccess'&"
34920 .cindex "policy control" "checking access"
34921 .cindex "checking access"
34922 The &%-bh%& command line argument allows you to run a fake SMTP session with
34923 debugging output, in order to check what Exim is doing when it is applying
34924 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34925 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34926 sometimes you just want to answer the question &"Does this address have
34927 access?"& without bothering with any further details.
34928
34929 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34930 two arguments, an IP address and an email address:
34931 .code
34932 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34933 .endd
34934 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34935 given email address would be accepted in a RCPT command in a TCP/IP
34936 connection from the host with the given IP address. The output of the utility
34937 is either the word &"accepted"&, or the SMTP error response, for example:
34938 .code
34939 Rejected:
34940 550 Relay not permitted
34941 .endd
34942 When running this test, the utility uses &`<>`& as the envelope sender address
34943 for the MAIL command, but you can change this by providing additional
34944 options. These are passed directly to the Exim command. For example, to specify
34945 that the test is to be run with the sender address &'himself@there.example'&
34946 you can use:
34947 .code
34948 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34949                  -f himself@there.example
34950 .endd
34951 Note that these additional Exim command line items must be given after the two
34952 mandatory arguments.
34953
34954 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34955 while running its checks. You can run checks that include callouts by using
34956 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34957
34958
34959
34960 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34961 .cindex "DBM" "building dbm files"
34962 .cindex "building DBM files"
34963 .cindex "&'exim_dbmbuild'&"
34964 .cindex "lower casing"
34965 .cindex "binary zero" "in lookup key"
34966 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34967 the format used by the &(lsearch)& lookup (see section
34968 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34969 names as keys and the remainder of the information as data. The lower-casing
34970 can be prevented by calling the program with the &%-nolc%& option.
34971
34972 A terminating zero is included as part of the key string. This is expected by
34973 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34974 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34975 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34976 files.
34977
34978 The program requires two arguments: the name of the input file (which can be a
34979 single hyphen to indicate the standard input), and the name of the output file.
34980 It creates the output under a temporary name, and then renames it if all went
34981 well.
34982
34983 .cindex "USE_DB"
34984 If the native DB interface is in use (USE_DB is set in a compile-time
34985 configuration file &-- this is common in free versions of Unix) the two file
34986 names must be different, because in this mode the Berkeley DB functions create
34987 a single output file using exactly the name given. For example,
34988 .code
34989 exim_dbmbuild /etc/aliases /etc/aliases.db
34990 .endd
34991 reads the system alias file and creates a DBM version of it in
34992 &_/etc/aliases.db_&.
34993
34994 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34995 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34996 environment, the suffixes are added to the second argument of
34997 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34998 when the Berkeley functions are used in compatibility mode (though this is not
34999 recommended), because in that case it adds a &_.db_& suffix to the file name.
35000
35001 If a duplicate key is encountered, the program outputs a warning, and when it
35002 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35003 option is used. By default, only the first of a set of duplicates is used &--
35004 this makes it compatible with &(lsearch)& lookups. There is an option
35005 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35006 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35007 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35008 return code is 2.
35009
35010
35011
35012
35013 .section "Finding individual retry times (exinext)" "SECTfinindret"
35014 .cindex "retry" "times"
35015 .cindex "&'exinext'&"
35016 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35017 fish specific information out of the retry database. Given a mail domain (or a
35018 complete address), it looks up the hosts for that domain, and outputs any retry
35019 information for the hosts or for the domain. At present, the retry information
35020 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35021 output. For example:
35022 .code
35023 $ exinext piglet@milne.fict.example
35024 kanga.milne.example:192.168.8.1 error 146: Connection refused
35025   first failed: 21-Feb-1996 14:57:34
35026   last tried:   21-Feb-1996 14:57:34
35027   next try at:  21-Feb-1996 15:02:34
35028 roo.milne.example:192.168.8.3 error 146: Connection refused
35029   first failed: 20-Jan-1996 13:12:08
35030   last tried:   21-Feb-1996 11:42:03
35031   next try at:  21-Feb-1996 19:42:03
35032   past final cutoff time
35033 .endd
35034 You can also give &'exinext'& a local part, without a domain, and it
35035 will give any retry information for that local part in your default domain.
35036 A message id can be used to obtain retry information pertaining to a specific
35037 message. This exists only when an attempt to deliver a message to a remote host
35038 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35039 &'exinext'& is not particularly efficient, but then it is not expected to be
35040 run very often.
35041
35042 The &'exinext'& utility calls Exim to find out information such as the location
35043 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35044 passed on to the &'exim'& commands. The first specifies an alternate Exim
35045 configuration file, and the second sets macros for use within the configuration
35046 file. These features are mainly to help in testing, but might also be useful in
35047 environments where more than one configuration file is in use.
35048
35049
35050
35051 .section "Hints database maintenance" "SECThindatmai"
35052 .cindex "hints database" "maintenance"
35053 .cindex "maintaining Exim's hints database"
35054 Three utility programs are provided for maintaining the DBM files that Exim
35055 uses to contain its delivery hint information. Each program requires two
35056 arguments. The first specifies the name of Exim's spool directory, and the
35057 second is the name of the database it is to operate on. These are as follows:
35058
35059 .ilist
35060 &'retry'&: the database of retry information
35061 .next
35062 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35063 for remote hosts
35064 .next
35065 &'callout'&: the callout cache
35066 .next
35067 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35068 .next
35069 &'misc'&: other hints data
35070 .endlist
35071
35072 The &'misc'& database is used for
35073
35074 .ilist
35075 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35076 .next
35077 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35078 &(smtp)& transport)
35079 .endlist
35080
35081
35082
35083 .section "exim_dumpdb" "SECID261"
35084 .cindex "&'exim_dumpdb'&"
35085 The entire contents of a database are written to the standard output by the
35086 &'exim_dumpdb'& program, which has no options or arguments other than the
35087 spool and database names. For example, to dump the retry database:
35088 .code
35089 exim_dumpdb /var/spool/exim retry
35090 .endd
35091 Two lines of output are produced for each entry:
35092 .code
35093 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35094 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35095 .endd
35096 The first item on the first line is the key of the record. It starts with one
35097 of the letters R, or T, depending on whether it refers to a routing or
35098 transport retry. For a local delivery, the next part is the local address; for
35099 a remote delivery it is the name of the remote host, followed by its failing IP
35100 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35101 transport). If the remote port is not the standard one (port 25), it is added
35102 to the IP address. Then there follows an error code, an additional error code,
35103 and a textual description of the error.
35104
35105 The three times on the second line are the time of first failure, the time of
35106 the last delivery attempt, and the computed time for the next attempt. The line
35107 ends with an asterisk if the cutoff time for the last retry rule has been
35108 exceeded.
35109
35110 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35111 consists of a host name followed by a list of ids for messages that are or were
35112 waiting to be delivered to that host. If there are a very large number for any
35113 one host, continuation records, with a sequence number added to the host name,
35114 may be seen. The data in these records is often out of date, because a message
35115 may be routed to several alternative hosts, and Exim makes no effort to keep
35116 cross-references.
35117
35118
35119
35120 .section "exim_tidydb" "SECID262"
35121 .cindex "&'exim_tidydb'&"
35122 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35123 database. If run with no options, it removes all records that are more than 30
35124 days old. The age is calculated from the date and time that the record was last
35125 updated. Note that, in the case of the retry database, it is &'not'& the time
35126 since the first delivery failure. Information about a host that has been down
35127 for more than 30 days will remain in the database, provided that the record is
35128 updated sufficiently often.
35129
35130 The cutoff date can be altered by means of the &%-t%& option, which must be
35131 followed by a time. For example, to remove all records older than a week from
35132 the retry database:
35133 .code
35134 exim_tidydb -t 7d /var/spool/exim retry
35135 .endd
35136 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35137 message ids. In the former these appear as data in records keyed by host &--
35138 they were messages that were waiting for that host &-- and in the latter they
35139 are the keys for retry information for messages that have suffered certain
35140 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35141 message ids in database records are those of messages that are still on the
35142 queue. Message ids for messages that no longer exist are removed from
35143 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35144 For the &'retry'& database, records whose keys are non-existent message ids are
35145 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35146 whenever it removes information from the database.
35147
35148 Certain records are automatically removed by Exim when they are no longer
35149 needed, but others are not. For example, if all the MX hosts for a domain are
35150 down, a retry record is created for each one. If the primary MX host comes back
35151 first, its record is removed when Exim successfully delivers to it, but the
35152 records for the others remain because Exim has not tried to use those hosts.
35153
35154 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35155 hints databases. You should do this at a quiet time of day, because it requires
35156 a database to be locked (and therefore inaccessible to Exim) while it does its
35157 work. Removing records from a DBM file does not normally make the file smaller,
35158 but all the common DBM libraries are able to re-use the space that is released.
35159 After an initial phase of increasing in size, the databases normally reach a
35160 point at which they no longer get any bigger, as long as they are regularly
35161 tidied.
35162
35163 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35164 databases is likely to keep on increasing.
35165
35166
35167
35168
35169 .section "exim_fixdb" "SECID263"
35170 .cindex "&'exim_fixdb'&"
35171 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35172 Its main use is for testing Exim, but it might also be occasionally useful for
35173 getting round problems in a live system. It has no options, and its interface
35174 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35175 key of a database record can then be entered, and the data for that record is
35176 displayed.
35177
35178 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35179 except the &'retry'& database, that is the only operation that can be carried
35180 out. For the &'retry'& database, each field is output preceded by a number, and
35181 data for individual fields can be changed by typing the field number followed
35182 by new data, for example:
35183 .code
35184 > 4 951102:1000
35185 .endd
35186 resets the time of the next delivery attempt. Time values are given as a
35187 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35188 used as optional separators.
35189
35190
35191
35192
35193 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35194 .cindex "mailbox" "maintenance"
35195 .cindex "&'exim_lock'&"
35196 .cindex "locking mailboxes"
35197 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35198 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35199 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35200 a user agent while investigating a problem. The utility requires the name of
35201 the file as its first argument. If the locking is successful, the second
35202 argument is run as a command (using C's &[system()]& function); if there is no
35203 second argument, the value of the SHELL environment variable is used; if this
35204 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35205 is unlocked and the utility ends. The following options are available:
35206
35207 .vlist
35208 .vitem &%-fcntl%&
35209 Use &[fcntl()]& locking on the open mailbox.
35210
35211 .vitem &%-flock%&
35212 Use &[flock()]& locking on the open mailbox, provided the operating system
35213 supports it.
35214
35215 .vitem &%-interval%&
35216 This must be followed by a number, which is a number of seconds; it sets the
35217 interval to sleep between retries (default 3).
35218
35219 .vitem &%-lockfile%&
35220 Create a lock file before opening the mailbox.
35221
35222 .vitem &%-mbx%&
35223 Lock the mailbox using MBX rules.
35224
35225 .vitem &%-q%&
35226 Suppress verification output.
35227
35228 .vitem &%-retries%&
35229 This must be followed by a number; it sets the number of times to try to get
35230 the lock (default 10).
35231
35232 .vitem &%-restore_time%&
35233 This option causes &%exim_lock%& to restore the modified and read times to the
35234 locked file before exiting. This allows you to access a locked mailbox (for
35235 example, to take a backup copy) without disturbing the times that the user
35236 subsequently sees.
35237
35238 .vitem &%-timeout%&
35239 This must be followed by a number, which is a number of seconds; it sets a
35240 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35241 default), a non-blocking call is used.
35242
35243 .vitem &%-v%&
35244 Generate verbose output.
35245 .endlist
35246
35247 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35248 default is to create a lock file and also to use &[fcntl()]& locking on the
35249 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35250 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35251 requires that the directory containing the file be writeable. Locking by lock
35252 file does not last for ever; Exim assumes that a lock file is expired if it is
35253 more than 30 minutes old.
35254
35255 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35256 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35257 to be taken out on the open mailbox, and an exclusive lock on the file
35258 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35259 number of the mailbox file. When the locking is released, if an exclusive lock
35260 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35261
35262 The default output contains verification of the locking that takes place. The
35263 &%-v%& option causes some additional information to be given. The &%-q%& option
35264 suppresses all output except error messages.
35265
35266 A command such as
35267 .code
35268 exim_lock /var/spool/mail/spqr
35269 .endd
35270 runs an interactive shell while the file is locked, whereas
35271 .display
35272 &`exim_lock -q /var/spool/mail/spqr <<End`&
35273 <&'some commands'&>
35274 &`End`&
35275 .endd
35276 runs a specific non-interactive sequence of commands while the file is locked,
35277 suppressing all verification output. A single command can be run by a command
35278 such as
35279 .code
35280 exim_lock -q /var/spool/mail/spqr \
35281   "cp /var/spool/mail/spqr /some/where"
35282 .endd
35283 Note that if a command is supplied, it must be entirely contained within the
35284 second argument &-- hence the quotes.
35285 .ecindex IIDutils
35286
35287
35288 . ////////////////////////////////////////////////////////////////////////////
35289 . ////////////////////////////////////////////////////////////////////////////
35290
35291 .chapter "The Exim monitor" "CHAPeximon"
35292 .scindex IIDeximon "Exim monitor" "description"
35293 .cindex "X-windows"
35294 .cindex "&'eximon'&"
35295 .cindex "Local/eximon.conf"
35296 .cindex "&_exim_monitor/EDITME_&"
35297 The Exim monitor is an application which displays in an X window information
35298 about the state of Exim's queue and what Exim is doing. An admin user can
35299 perform certain operations on messages from this GUI interface; however all
35300 such facilities are also available from the command line, and indeed, the
35301 monitor itself makes use of the command line to perform any actions requested.
35302
35303
35304
35305 .section "Running the monitor" "SECID264"
35306 The monitor is started by running the script called &'eximon'&. This is a shell
35307 script that sets up a number of environment variables, and then runs the
35308 binary called &_eximon.bin_&. The default appearance of the monitor window can
35309 be changed by editing the &_Local/eximon.conf_& file created by editing
35310 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35311 parameters are for.
35312
35313 The parameters that get built into the &'eximon'& script can be overridden for
35314 a particular invocation by setting up environment variables of the same names,
35315 preceded by &`EXIMON_`&. For example, a shell command such as
35316 .code
35317 EXIMON_LOG_DEPTH=400 eximon
35318 .endd
35319 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35320 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35321 overrides the Exim log file configuration. This makes it possible to have
35322 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35323 syslog messages are routed to a file on the local host.
35324
35325 X resources can be used to change the appearance of the window in the normal
35326 way. For example, a resource setting of the form
35327 .code
35328 Eximon*background: gray94
35329 .endd
35330 changes the colour of the background to light grey rather than white. The
35331 stripcharts are drawn with both the data lines and the reference lines in
35332 black. This means that the reference lines are not visible when on top of the
35333 data. However, their colour can be changed by setting a resource called
35334 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35335 For example, if your X server is running Unix, you could set up lighter
35336 reference lines in the stripcharts by obeying
35337 .code
35338 xrdb -merge <<End
35339 Eximon*highlight: gray
35340 End
35341 .endd
35342 .cindex "admin user"
35343 In order to see the contents of messages on the queue, and to operate on them,
35344 &'eximon'& must either be run as root or by an admin user.
35345
35346 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35347 contain X11 resource parameters interpreted by the X11 library.  In addition,
35348 if the first parameter starts with the string "gdb" then it is removed and the
35349 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35350 versioned variants of gdb can be invoked).
35351
35352 The monitor's window is divided into three parts. The first contains one or
35353 more stripcharts and two action buttons, the second contains a &"tail"& of the
35354 main log file, and the third is a display of the queue of messages awaiting
35355 delivery, with two more action buttons. The following sections describe these
35356 different parts of the display.
35357
35358
35359
35360
35361 .section "The stripcharts" "SECID265"
35362 .cindex "stripchart"
35363 The first stripchart is always a count of messages on the queue. Its name can
35364 be configured by setting QUEUE_STRIPCHART_NAME in the
35365 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35366 configuration script by regular expression matches on log file entries, making
35367 it possible to display, for example, counts of messages delivered to certain
35368 hosts or using certain transports. The supplied defaults display counts of
35369 received and delivered messages, and of local and SMTP deliveries. The default
35370 period between stripchart updates is one minute; this can be adjusted by a
35371 parameter in the &_Local/eximon.conf_& file.
35372
35373 The stripchart displays rescale themselves automatically as the value they are
35374 displaying changes. There are always 10 horizontal lines in each chart; the
35375 title string indicates the value of each division when it is greater than one.
35376 For example, &"x2"& means that each division represents a value of 2.
35377
35378 It is also possible to have a stripchart which shows the percentage fullness of
35379 a particular disk partition, which is useful when local deliveries are confined
35380 to a single partition.
35381
35382 .cindex "&%statvfs%& function"
35383 This relies on the availability of the &[statvfs()]& function or equivalent in
35384 the operating system. Most, but not all versions of Unix that support Exim have
35385 this. For this particular stripchart, the top of the chart always represents
35386 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35387 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35388 &_Local/eximon.conf_& file.
35389
35390
35391
35392
35393 .section "Main action buttons" "SECID266"
35394 .cindex "size" "of monitor window"
35395 .cindex "Exim monitor" "window size"
35396 .cindex "window size"
35397 Below the stripcharts there is an action button for quitting the monitor. Next
35398 to this is another button marked &"Size"&. They are placed here so that
35399 shrinking the window to its default minimum size leaves just the queue count
35400 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35401 the window to expand to its maximum size, unless it is already at the maximum,
35402 in which case it is reduced to its minimum.
35403
35404 When expanding to the maximum, if the window cannot be fully seen where it
35405 currently is, it is moved back to where it was the last time it was at full
35406 size. When it is expanding from its minimum size, the old position is
35407 remembered, and next time it is reduced to the minimum it is moved back there.
35408
35409 The idea is that you can keep a reduced window just showing one or two
35410 stripcharts at a convenient place on your screen, easily expand it to show
35411 the full window when required, and just as easily put it back to what it was.
35412 The idea is copied from what the &'twm'& window manager does for its
35413 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35414 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35415
35416 Normally, the monitor starts up with the window at its full size, but it can be
35417 built so that it starts up with the window at its smallest size, by setting
35418 START_SMALL=yes in &_Local/eximon.conf_&.
35419
35420
35421
35422 .section "The log display" "SECID267"
35423 .cindex "log" "tail of; in monitor"
35424 The second section of the window is an area in which a display of the tail of
35425 the main log is maintained.
35426 To save space on the screen, the timestamp on each log line is shortened by
35427 removing the date and, if &%log_timezone%& is set, the timezone.
35428 The log tail is not available when the only destination for logging data is
35429 syslog, unless the syslog lines are routed to a local file whose name is passed
35430 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35431
35432 The log sub-window has a scroll bar at its lefthand side which can be used to
35433 move back to look at earlier text, and the up and down arrow keys also have a
35434 scrolling effect. The amount of log that is kept depends on the setting of
35435 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35436 to use. When this is full, the earlier 50% of data is discarded &-- this is
35437 much more efficient than throwing it away line by line. The sub-window also has
35438 a horizontal scroll bar for accessing the ends of long log lines. This is the
35439 only means of horizontal scrolling; the right and left arrow keys are not
35440 available. Text can be cut from this part of the window using the mouse in the
35441 normal way. The size of this subwindow is controlled by parameters in the
35442 configuration file &_Local/eximon.conf_&.
35443
35444 Searches of the text in the log window can be carried out by means of the ^R
35445 and ^S keystrokes, which default to a reverse and a forward search,
35446 respectively. The search covers only the text that is displayed in the window.
35447 It cannot go further back up the log.
35448
35449 The point from which the search starts is indicated by a caret marker. This is
35450 normally at the end of the text in the window, but can be positioned explicitly
35451 by pointing and clicking with the left mouse button, and is moved automatically
35452 by a successful search. If new text arrives in the window when it is scrolled
35453 back, the caret remains where it is, but if the window is not scrolled back,
35454 the caret is moved to the end of the new text.
35455
35456 Pressing ^R or ^S pops up a window into which the search text can be typed.
35457 There are buttons for selecting forward or reverse searching, for carrying out
35458 the search, and for cancelling. If the &"Search"& button is pressed, the search
35459 happens and the window remains so that further searches can be done. If the
35460 &"Return"& key is pressed, a single search is done and the window is closed. If
35461 ^C is typed the search is cancelled.
35462
35463 The searching facility is implemented using the facilities of the Athena text
35464 widget. By default this pops up a window containing both &"search"& and
35465 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35466 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35467 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35468 provided version of &%TextPop%& when the remaining parts of the text widget
35469 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35470 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35471 on these systems, at the expense of having unwanted items in the search popup
35472 window.
35473
35474
35475
35476 .section "The queue display" "SECID268"
35477 .cindex "queue" "display in monitor"
35478 The bottom section of the monitor window contains a list of all messages that
35479 are on the queue, which includes those currently being received or delivered,
35480 as well as those awaiting delivery. The size of this subwindow is controlled by
35481 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35482 at which it is updated is controlled by another parameter in the same file &--
35483 the default is 5 minutes, since queue scans can be quite expensive. However,
35484 there is an &"Update"& action button just above the display which can be used
35485 to force an update of the queue display at any time.
35486
35487 When a host is down for some time, a lot of pending mail can build up for it,
35488 and this can make it hard to deal with other messages on the queue. To help
35489 with this situation there is a button next to &"Update"& called &"Hide"&. If
35490 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35491 type anything in here and press &"Return"&, the text is added to a chain of
35492 such texts, and if every undelivered address in a message matches at least one
35493 of the texts, the message is not displayed.
35494
35495 If there is an address that does not match any of the texts, all the addresses
35496 are displayed as normal. The matching happens on the ends of addresses so, for
35497 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35498 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35499 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35500 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35501 a hide request is automatically cancelled after one hour.
35502
35503 While the dialogue box is displayed, you can't press any buttons or do anything
35504 else to the monitor window. For this reason, if you want to cut text from the
35505 queue display to use in the dialogue box, you have to do the cutting before
35506 pressing the &"Hide"& button.
35507
35508 The queue display contains, for each unhidden queued message, the length of
35509 time it has been on the queue, the size of the message, the message id, the
35510 message sender, and the first undelivered recipient, all on one line. If it is
35511 a bounce message, the sender is shown as &"<>"&. If there is more than one
35512 recipient to which the message has not yet been delivered, subsequent ones are
35513 listed on additional lines, up to a maximum configured number, following which
35514 an ellipsis is displayed. Recipients that have already received the message are
35515 not shown.
35516
35517 .cindex "frozen messages" "display"
35518 If a message is frozen, an asterisk is displayed at the left-hand side.
35519
35520 The queue display has a vertical scroll bar, and can also be scrolled by means
35521 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35522 The text searching facilities, as described above for the log window, are also
35523 available, but the caret is always moved to the end of the text when the queue
35524 display is updated.
35525
35526
35527
35528 .section "The queue menu" "SECID269"
35529 .cindex "queue" "menu in monitor"
35530 If the &%shift%& key is held down and the left button is clicked when the mouse
35531 pointer is over the text for any message, an action menu pops up, and the first
35532 line of the queue display for the message is highlighted. This does not affect
35533 any selected text.
35534
35535 If you want to use some other event for popping up the menu, you can set the
35536 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35537 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35538 value set in this parameter is a standard X event description. For example, to
35539 run eximon using &%ctrl%& rather than &%shift%& you could use
35540 .code
35541 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35542 .endd
35543 The title of the menu is the message id, and it contains entries which act as
35544 follows:
35545
35546 .ilist
35547 &'message log'&: The contents of the message log for the message are displayed
35548 in a new text window.
35549 .next
35550 &'headers'&: Information from the spool file that contains the envelope
35551 information and headers is displayed in a new text window. See chapter
35552 &<<CHAPspool>>& for a description of the format of spool files.
35553 .next
35554 &'body'&: The contents of the spool file containing the body of the message are
35555 displayed in a new text window. There is a default limit of 20,000 bytes to the
35556 amount of data displayed. This can be changed by setting the BODY_MAX
35557 option at compile time, or the EXIMON_BODY_MAX option at run time.
35558 .next
35559 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35560 delivery of the message. This causes an automatic thaw if the message is
35561 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35562 a new text window. The delivery is run in a separate process, to avoid holding
35563 up the monitor while the delivery proceeds.
35564 .next
35565 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35566 that the message be frozen.
35567 .next
35568 .cindex "thawing messages"
35569 .cindex "unfreezing messages"
35570 .cindex "frozen messages" "thawing"
35571 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35572 that the message be thawed.
35573 .next
35574 .cindex "delivery" "forcing failure"
35575 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35576 that Exim gives up trying to deliver the message. A bounce message is generated
35577 for any remaining undelivered addresses.
35578 .next
35579 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35580 that the message be deleted from the system without generating a bounce
35581 message.
35582 .next
35583 &'add recipient'&: A dialog box is displayed into which a recipient address can
35584 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35585 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35586 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35587 causes a call to Exim to be made using the &%-Mar%& option to request that an
35588 additional recipient be added to the message, unless the entry box is empty, in
35589 which case no action is taken.
35590 .next
35591 &'mark delivered'&: A dialog box is displayed into which a recipient address
35592 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35593 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35594 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35595 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35596 recipient address as already delivered, unless the entry box is empty, in which
35597 case no action is taken.
35598 .next
35599 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35600 mark all recipient addresses as already delivered.
35601 .next
35602 &'edit sender'&: A dialog box is displayed initialized with the current
35603 sender's address. Pressing RETURN causes a call to Exim to be made using the
35604 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35605 in which case no action is taken. If you want to set an empty sender (as in
35606 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35607 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35608 the address is qualified with that domain.
35609 .endlist
35610
35611 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35612 other cases when a call to Exim is made, if there is any output from Exim (in
35613 particular, if the command fails) a window containing the command and the
35614 output is displayed. Otherwise, the results of the action are normally apparent
35615 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35616 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35617 if no output is generated.
35618
35619 The queue display is automatically updated for actions such as freezing and
35620 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35621 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35622 force an update of the display after one of these actions.
35623
35624 In any text window that is displayed as result of a menu action, the normal
35625 cut-and-paste facility is available, and searching can be carried out using ^R
35626 and ^S, as described above for the log tail window.
35627 .ecindex IIDeximon
35628
35629
35630
35631
35632
35633 . ////////////////////////////////////////////////////////////////////////////
35634 . ////////////////////////////////////////////////////////////////////////////
35635
35636 .chapter "Security considerations" "CHAPsecurity"
35637 .scindex IIDsecurcon "security" "discussion of"
35638 This chapter discusses a number of issues concerned with security, some of
35639 which are also covered in other parts of this manual.
35640
35641 For reasons that this author does not understand, some people have promoted
35642 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35643 existence of this chapter in the documentation. However, the intent of the
35644 chapter is simply to describe the way Exim works in relation to certain
35645 security concerns, not to make any specific claims about the effectiveness of
35646 its security as compared with other MTAs.
35647
35648 What follows is a description of the way Exim is supposed to be. Best efforts
35649 have been made to try to ensure that the code agrees with the theory, but an
35650 absence of bugs can never be guaranteed. Any that are reported will get fixed
35651 as soon as possible.
35652
35653
35654 .section "Building a more &""hardened""& Exim" "SECID286"
35655 .cindex "security" "build-time features"
35656 There are a number of build-time options that can be set in &_Local/Makefile_&
35657 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35658 Exim administrator who does not have the root password, or by someone who has
35659 penetrated the Exim (but not the root) account. These options are as follows:
35660
35661 .ilist
35662 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35663 start of any file names used with the &%-C%& option. When it is set, these file
35664 names are also not allowed to contain the sequence &"/../"&. (However, if the
35665 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35666 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35667 default setting for &%ALT_CONFIG_PREFIX%&.
35668
35669 If the permitted configuration files are confined to a directory to
35670 which only root has access, this guards against someone who has broken
35671 into the Exim account from running a privileged Exim with an arbitrary
35672 configuration file, and using it to break into other accounts.
35673 .next
35674
35675 If a non-trusted configuration file (i.e. not the default configuration file
35676 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35677 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35678 the next item), then root privilege is retained only if the caller of Exim is
35679 root. This locks out the possibility of testing a configuration using &%-C%&
35680 right through message reception and delivery, even if the caller is root. The
35681 reception works, but by that time, Exim is running as the Exim user, so when
35682 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35683 privilege to be lost. However, root can test reception and delivery using two
35684 separate commands.
35685
35686 .next
35687 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35688 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35689 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35690 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35691 the restrictive side.  Requiring build-time selection of safe macros is onerous
35692 but this option is intended solely as a transition mechanism to permit
35693 previously-working configurations to continue to work after release 4.73.
35694 .next
35695 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35696 is disabled.
35697 .next
35698 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35699 never to be used for any deliveries. This is like the &%never_users%& runtime
35700 option, but it cannot be overridden; the runtime option adds additional users
35701 to the list. The default setting is &"root"&; this prevents a non-root user who
35702 is permitted to modify the runtime file from using Exim as a way to get root.
35703 .endlist
35704
35705
35706
35707 .section "Root privilege" "SECID270"
35708 .cindex "setuid"
35709 .cindex "root privilege"
35710 The Exim binary is normally setuid to root, which means that it gains root
35711 privilege (runs as root) when it starts execution. In some special cases (for
35712 example, when the daemon is not in use and there are no local deliveries), it
35713 may be possible to run Exim setuid to some user other than root. This is
35714 discussed in the next section. However, in most installations, root privilege
35715 is required for two things:
35716
35717 .ilist
35718 To set up a socket connected to the standard SMTP port (25) when initialising
35719 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35720 not required.
35721 .next
35722 To be able to change uid and gid in order to read users' &_.forward_& files and
35723 perform local deliveries as the receiving user or as specified in the
35724 configuration.
35725 .endlist
35726
35727 It is not necessary to be root to do any of the other things Exim does, such as
35728 receiving messages and delivering them externally over SMTP, and it is
35729 obviously more secure if Exim does not run as root except when necessary.
35730 For this reason, a user and group for Exim to use must be defined in
35731 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35732 group"&. Their values can be changed by the run time configuration, though this
35733 is not recommended. Often a user called &'exim'& is used, but some sites use
35734 &'mail'& or another user name altogether.
35735
35736 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35737 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35738 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35739
35740 After a new Exim process has interpreted its command line options, it changes
35741 uid and gid in the following cases:
35742
35743 .ilist
35744 .oindex "&%-C%&"
35745 .oindex "&%-D%&"
35746 If the &%-C%& option is used to specify an alternate configuration file, or if
35747 the &%-D%& option is used to define macro values for the configuration, and the
35748 calling process is not running as root, the uid and gid are changed to those of
35749 the calling process.
35750 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35751 option may not be used at all.
35752 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35753 can be supplied if the calling process is running as root, the Exim run-time
35754 user or CONFIGURE_OWNER, if defined.
35755 .next
35756 .oindex "&%-be%&"
35757 .oindex "&%-bf%&"
35758 .oindex "&%-bF%&"
35759 If the expansion test option (&%-be%&) or one of the filter testing options
35760 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35761 calling process.
35762 .next
35763 If the process is not a daemon process or a queue runner process or a delivery
35764 process or a process for testing address routing (started with &%-bt%&), the
35765 uid and gid are changed to the Exim user and group. This means that Exim always
35766 runs under its own uid and gid when receiving messages. This also applies when
35767 testing address verification
35768 .oindex "&%-bv%&"
35769 .oindex "&%-bh%&"
35770 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35771 option).
35772 .next
35773 For a daemon, queue runner, delivery, or address testing process, the uid
35774 remains as root at this stage, but the gid is changed to the Exim group.
35775 .endlist
35776
35777 The processes that initially retain root privilege behave as follows:
35778
35779 .ilist
35780 A daemon process changes the gid to the Exim group and the uid to the Exim
35781 user after setting up one or more listening sockets. The &[initgroups()]&
35782 function is called, so that if the Exim user is in any additional groups, they
35783 will be used during message reception.
35784 .next
35785 A queue runner process retains root privilege throughout its execution. Its
35786 job is to fork a controlled sequence of delivery processes.
35787 .next
35788 A delivery process retains root privilege throughout most of its execution,
35789 but any actual deliveries (that is, the transports themselves) are run in
35790 subprocesses which always change to a non-root uid and gid. For local
35791 deliveries this is typically the uid and gid of the owner of the mailbox; for
35792 remote deliveries, the Exim uid and gid are used. Once all the delivery
35793 subprocesses have been run, a delivery process changes to the Exim uid and gid
35794 while doing post-delivery tidying up such as updating the retry database and
35795 generating bounce and warning messages.
35796
35797 While the recipient addresses in a message are being routed, the delivery
35798 process runs as root. However, if a user's filter file has to be processed,
35799 this is done in a subprocess that runs under the individual user's uid and
35800 gid. A system filter is run as root unless &%system_filter_user%& is set.
35801 .next
35802 A process that is testing addresses (the &%-bt%& option) runs as root so that
35803 the routing is done in the same environment as a message delivery.
35804 .endlist
35805
35806
35807
35808
35809 .section "Running Exim without privilege" "SECTrunexiwitpri"
35810 .cindex "privilege, running without"
35811 .cindex "unprivileged running"
35812 .cindex "root privilege" "running without"
35813 Some installations like to run Exim in an unprivileged state for more of its
35814 operation, for added security. Support for this mode of operation is provided
35815 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35816 gid are changed to the Exim user and group at the start of a delivery process
35817 (and also queue runner and address testing processes). This means that address
35818 routing is no longer run as root, and the deliveries themselves cannot change
35819 to any other uid.
35820
35821 .cindex SIGHUP
35822 .cindex "daemon" "restarting"
35823 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35824 that the daemon can still be started in the usual way, and it can respond
35825 correctly to SIGHUP because the re-invocation regains root privilege.
35826
35827 An alternative approach is to make Exim setuid to the Exim user and also setgid
35828 to the Exim group. If you do this, the daemon must be started from a root
35829 process. (Calling Exim from a root process makes it behave in the way it does
35830 when it is setuid root.) However, the daemon cannot restart itself after a
35831 SIGHUP signal because it cannot regain privilege.
35832
35833 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35834 stops Exim from trying to re-invoke itself to do a delivery after a message has
35835 been received. Such a re-invocation is a waste of resources because it has no
35836 effect.
35837
35838 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35839 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35840 to the Exim user seems a clean approach, but there is one complication:
35841
35842 In this style of operation, Exim is running with the real uid and gid set to
35843 those of the calling process, and the effective uid/gid set to Exim's values.
35844 Ideally, any association with the calling process' uid/gid should be dropped,
35845 that is, the real uid/gid should be reset to the effective values so as to
35846 discard any privileges that the caller may have. While some operating systems
35847 have a function that permits this action for a non-root effective uid, quite a
35848 number of them do not. Because of this lack of standardization, Exim does not
35849 address this problem at this time.
35850
35851 For this reason, the recommended approach for &"mostly unprivileged"& running
35852 is to keep the Exim binary setuid to root, and to set
35853 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35854 be used in the most straightforward way.
35855
35856 If you configure Exim not to run delivery processes as root, there are a
35857 number of restrictions on what you can do:
35858
35859 .ilist
35860 You can deliver only as the Exim user/group. You should  explicitly use the
35861 &%user%& and &%group%& options to override routers or local transports that
35862 normally deliver as the recipient. This makes sure that configurations that
35863 work in this mode function the same way in normal mode. Any implicit or
35864 explicit specification of another user causes an error.
35865 .next
35866 Use of &_.forward_& files is severely restricted, such that it is usually
35867 not worthwhile to include them in the configuration.
35868 .next
35869 Users who wish to use &_.forward_& would have to make their home directory and
35870 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35871 and their equivalents in Exim filters, cannot be used. While they could be
35872 enabled in the Exim user's name, that would be insecure and not very useful.
35873 .next
35874 Unless the local user mailboxes are all owned by the Exim user (possible in
35875 some POP3 or IMAP-only environments):
35876
35877 .olist
35878 They must be owned by the Exim group and be writeable by that group. This
35879 implies you must set &%mode%& in the appendfile configuration, as well as the
35880 mode of the mailbox files themselves.
35881 .next
35882 You must set &%no_check_owner%&, since most or all of the files will not be
35883 owned by the Exim user.
35884 .next
35885 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35886 on a newly created mailbox when unprivileged. This also implies that new
35887 mailboxes need to be created manually.
35888 .endlist olist
35889 .endlist ilist
35890
35891
35892 These restrictions severely restrict what can be done in local deliveries.
35893 However, there are no restrictions on remote deliveries. If you are running a
35894 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35895 gives more security at essentially no cost.
35896
35897 If you are using the &%mua_wrapper%& facility (see chapter
35898 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35899
35900
35901
35902
35903 .section "Delivering to local files" "SECID271"
35904 Full details of the checks applied by &(appendfile)& before it writes to a file
35905 are given in chapter &<<CHAPappendfile>>&.
35906
35907
35908
35909 .new
35910 .section "Running local commands" "SECTsecconslocalcmds"
35911 .cindex "security" "local commands"
35912 .cindex "security" "command injection attacks"
35913 There are a number of ways in which an administrator can configure Exim to run
35914 commands based upon received, untrustworthy, data. Further, in some
35915 configurations a user who can control a &_.forward_& file can also arrange to
35916 run commands. Configuration to check includes, but is not limited to:
35917
35918 .ilist
35919 Use of &%use_shell%& in the pipe transport: various forms of shell command
35920 injection may be possible with this option present. It is dangerous and should
35921 be used only with considerable caution. Consider constraints which whitelist
35922 allowed characters in a variable which is to be used in a pipe transport that
35923 has &%use_shell%& enabled.
35924 .next
35925 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
35926 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
35927 &_.forward_& files in a redirect router. If Exim is running on a central mail
35928 hub to which ordinary users do not have shell access, but home directories are
35929 NFS mounted (for instance) then administrators should review the list of these
35930 forbid options available, and should bear in mind that the options that may
35931 need forbidding can change as new features are added between releases.
35932 .next
35933 The &%${run...}%& expansion item does not use a shell by default, but
35934 administrators can configure use of &_/bin/sh_& as part of the command.
35935 Such invocations should be viewed with prejudicial suspicion.
35936 .next
35937 Administrators who use embedded Perl are advised to explore how Perl's
35938 taint checking might apply to their usage.
35939 .next
35940 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
35941 administrators are well advised to view its use with suspicion, in case (for
35942 instance) it allows a local-part to contain embedded Exim directives.
35943 .next
35944 Use of &%${match_local_part...}%& and friends becomes more dangerous if
35945 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
35946 each can reference arbitrary lists and files, rather than just being a list
35947 of opaque strings.
35948 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
35949 real-world security vulnerabilities caused by its use with untrustworthy data
35950 injected in, for SQL injection attacks.
35951 Consider the use of the &%inlisti%& expansion condition instead.
35952 .endlist
35953 .wen
35954
35955
35956
35957
35958 .new
35959 .section "Trust in configuration data" "SECTsecconfdata"
35960 .cindex "security" "data sources"
35961 .cindex "security" "regular expressions"
35962 .cindex "regular expressions" "security"
35963 .cindex "PCRE" "security"
35964 If configuration data for Exim can come from untrustworthy sources, there
35965 are some issues to be aware of:
35966
35967 .ilist
35968 Use of &%${expand...}%& may provide a path for shell injection attacks.
35969 .next
35970 Letting untrusted data provide a regular expression is unwise.
35971 .next
35972 Using &%${match...}%& to apply a fixed regular expression against untrusted
35973 data may result in pathological behaviour within PCRE.  Be aware of what
35974 "backtracking" means and consider options for being more strict with a regular
35975 expression. Avenues to explore include limiting what can match (avoiding &`.`&
35976 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
35977 possessive quantifiers or just not using regular expressions against untrusted
35978 data.
35979 .next
35980 It can be important to correctly use &%${quote:...}%&,
35981 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
35982 items to ensure that data is correctly constructed.
35983 .next
35984 Some lookups might return multiple results, even though normal usage is only
35985 expected to yield one result.
35986 .endlist
35987 .wen
35988
35989
35990
35991
35992 .section "IPv4 source routing" "SECID272"
35993 .cindex "source routing" "in IP packets"
35994 .cindex "IP source routing"
35995 Many operating systems suppress IP source-routed packets in the kernel, but
35996 some cannot be made to do this, so Exim does its own check. It logs incoming
35997 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35998 IPv6. No special checking is currently done.
35999
36000
36001
36002 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36003 Support for these SMTP commands is disabled by default. If required, they can
36004 be enabled by defining suitable ACLs.
36005
36006
36007
36008
36009 .section "Privileged users" "SECID274"
36010 .cindex "trusted users"
36011 .cindex "admin user"
36012 .cindex "privileged user"
36013 .cindex "user" "trusted"
36014 .cindex "user" "admin"
36015 Exim recognizes two sets of users with special privileges. Trusted users are
36016 able to submit new messages to Exim locally, but supply their own sender
36017 addresses and information about a sending host. For other users submitting
36018 local messages, Exim sets up the sender address from the uid, and doesn't
36019 permit a remote host to be specified.
36020
36021 .oindex "&%-f%&"
36022 However, an untrusted user is permitted to use the &%-f%& command line option
36023 in the special form &%-f <>%& to indicate that a delivery failure for the
36024 message should not cause an error report. This affects the message's envelope,
36025 but it does not affect the &'Sender:'& header. Untrusted users may also be
36026 permitted to use specific forms of address with the &%-f%& option by setting
36027 the &%untrusted_set_sender%& option.
36028
36029 Trusted users are used to run processes that receive mail messages from some
36030 other mail domain and pass them on to Exim for delivery either locally, or over
36031 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36032 as any user listed in the &%trusted_users%& configuration option, or under any
36033 group listed in the &%trusted_groups%& option.
36034
36035 Admin users are permitted to do things to the messages on Exim's queue. They
36036 can freeze or thaw messages, cause them to be returned to their senders, remove
36037 them entirely, or modify them in various ways. In addition, admin users can run
36038 the Exim monitor and see all the information it is capable of providing, which
36039 includes the contents of files on the spool.
36040
36041 .oindex "&%-M%&"
36042 .oindex "&%-q%&"
36043 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36044 delivery of messages on its queue is restricted to admin users. This
36045 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36046 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36047 queue is also restricted to admin users. This restriction can be relaxed by
36048 setting &%no_queue_list_requires_admin%&.
36049
36050 Exim recognizes an admin user if the calling process is running as root or as
36051 the Exim user or if any of the groups associated with the calling process is
36052 the Exim group. It is not necessary actually to be running under the Exim
36053 group. However, if admin users who are not root or the Exim user are to access
36054 the contents of files on the spool via the Exim monitor (which runs
36055 unprivileged), Exim must be built to allow group read access to its spool
36056 files.
36057
36058
36059
36060 .section "Spool files" "SECID275"
36061 .cindex "spool directory" "files"
36062 Exim's spool directory and everything it contains is owned by the Exim user and
36063 set to the Exim group. The mode for spool files is defined in the
36064 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36065 any user who is a member of the Exim group can access these files.
36066
36067
36068
36069 .section "Use of argv[0]" "SECID276"
36070 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36071 of specific strings, Exim assumes certain options. For example, calling Exim
36072 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36073 to calling it with the option &%-bS%&. There are no security implications in
36074 this.
36075
36076
36077
36078 .section "Use of %f formatting" "SECID277"
36079 The only use made of &"%f"& by Exim is in formatting load average values. These
36080 are actually stored in integer variables as 1000 times the load average.
36081 Consequently, their range is limited and so therefore is the length of the
36082 converted output.
36083
36084
36085
36086 .section "Embedded Exim path" "SECID278"
36087 Exim uses its own path name, which is embedded in the code, only when it needs
36088 to re-exec in order to regain root privilege. Therefore, it is not root when it
36089 does so. If some bug allowed the path to get overwritten, it would lead to an
36090 arbitrary program's being run as exim, not as root.
36091
36092
36093
36094 .section "Dynamic module directory" "SECTdynmoddir"
36095 Any dynamically loadable modules must be installed into the directory
36096 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36097 loading it.
36098
36099
36100 .section "Use of sprintf()" "SECID279"
36101 .cindex "&[sprintf()]&"
36102 A large number of occurrences of &"sprintf"& in the code are actually calls to
36103 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36104 The intermediate formatting is done into a large fixed buffer by a function
36105 that runs through the format string itself, and checks the length of each
36106 conversion before performing it, thus preventing buffer overruns.
36107
36108 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36109 the output buffer is known to be sufficiently long to contain the converted
36110 string.
36111
36112
36113
36114 .section "Use of debug_printf() and log_write()" "SECID280"
36115 Arbitrary strings are passed to both these functions, but they do their
36116 formatting by calling the function &'string_vformat()'&, which runs through
36117 the format string itself, and checks the length of each conversion.
36118
36119
36120
36121 .section "Use of strcat() and strcpy()" "SECID281"
36122 These are used only in cases where the output buffer is known to be large
36123 enough to hold the result.
36124 .ecindex IIDsecurcon
36125
36126
36127
36128
36129 . ////////////////////////////////////////////////////////////////////////////
36130 . ////////////////////////////////////////////////////////////////////////////
36131
36132 .chapter "Format of spool files" "CHAPspool"
36133 .scindex IIDforspo1 "format" "spool files"
36134 .scindex IIDforspo2 "spool directory" "format of files"
36135 .scindex IIDforspo3 "spool files" "format of"
36136 .cindex "spool files" "editing"
36137 A message on Exim's queue consists of two files, whose names are the message id
36138 followed by -D and -H, respectively. The data portion of the message is kept in
36139 the -D file on its own. The message's envelope, status, and headers are all
36140 kept in the -H file, whose format is described in this chapter. Each of these
36141 two files contains the final component of its own name as its first line. This
36142 is insurance against disk crashes where the directory is lost but the files
36143 themselves are recoverable.
36144
36145 Some people are tempted into editing -D files in order to modify messages. You
36146 need to be extremely careful if you do this; it is not recommended and you are
36147 on your own if you do it. Here are some of the pitfalls:
36148
36149 .ilist
36150 You must ensure that Exim does not try to deliver the message while you are
36151 fiddling with it. The safest way is to take out a write lock on the -D file,
36152 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36153 place, the lock will be retained. If you write a new file and rename it, the
36154 lock will be lost at the instant of rename.
36155 .next
36156 .vindex "&$body_linecount$&"
36157 If you change the number of lines in the file, the value of
36158 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36159 present, this value is not used by Exim, but there is no guarantee that this
36160 will always be the case.
36161 .next
36162 If the message is in MIME format, you must take care not to break it.
36163 .next
36164 If the message is cryptographically signed, any change will invalidate the
36165 signature.
36166 .endlist
36167 All in all, modifying -D files is fraught with danger.
36168
36169 Files whose names end with -J may also be seen in the &_input_& directory (or
36170 its subdirectories when &%split_spool_directory%& is set). These are journal
36171 files, used to record addresses to which the message has been delivered during
36172 the course of a delivery attempt. If there are still undelivered recipients at
36173 the end, the -H file is updated, and the -J file is deleted. If, however, there
36174 is some kind of crash (for example, a power outage) before this happens, the -J
36175 file remains in existence. When Exim next processes the message, it notices the
36176 -J file and uses it to update the -H file before starting the next delivery
36177 attempt.
36178
36179 .section "Format of the -H file" "SECID282"
36180 .cindex "uid (user id)" "in spool file"
36181 .cindex "gid (group id)" "in spool file"
36182 The second line of the -H file contains the login name for the uid of the
36183 process that called Exim to read the message, followed by the numerical uid and
36184 gid. For a locally generated message, this is normally the user who sent the
36185 message. For a message received over TCP/IP via the daemon, it is
36186 normally the Exim user.
36187
36188 The third line of the file contains the address of the message's sender as
36189 transmitted in the envelope, contained in angle brackets. The sender address is
36190 empty for bounce messages. For incoming SMTP mail, the sender address is given
36191 in the MAIL command. For locally generated mail, the sender address is
36192 created by Exim from the login name of the current user and the configured
36193 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36194 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36195 &"<>"& or an address that matches &%untrusted_set_senders%&.
36196
36197 The fourth line contains two numbers. The first is the time that the message
36198 was received, in the conventional Unix form &-- the number of seconds since the
36199 start of the epoch. The second number is a count of the number of messages
36200 warning of delayed delivery that have been sent to the sender.
36201
36202 There follow a number of lines starting with a hyphen. These can appear in any
36203 order, and are omitted when not relevant:
36204
36205 .vlist
36206 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36207 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36208 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36209 recognized, to provide backward compatibility. In the old format, a line of
36210 this form is present for every ACL variable that is not empty. The number
36211 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36212 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36213 the data string for the variable. The string itself starts at the beginning of
36214 the next line, and is followed by a newline character. It may contain internal
36215 newlines.
36216
36217 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36218 A line of this form is present for every ACL connection variable that is
36219 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36220 The length is the length of the data string for the variable. The string itself
36221 starts at the beginning of the next line, and is followed by a newline
36222 character. It may contain internal newlines.
36223
36224 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36225 A line of this form is present for every ACL message variable that is defined.
36226 Note that there is a space between &%-aclm%& and the rest of the name. The
36227 length is the length of the data string for the variable. The string itself
36228 starts at the beginning of the next line, and is followed by a newline
36229 character. It may contain internal newlines.
36230
36231 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36232 This is present if, when the message was received over SMTP, the value of
36233 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36234
36235 .vitem &%-allow_unqualified_recipient%&
36236 This is present if unqualified recipient addresses are permitted in header
36237 lines (to stop such addresses from being qualified if rewriting occurs at
36238 transport time). Local messages that were input using &%-bnq%& and remote
36239 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36240
36241 .vitem &%-allow_unqualified_sender%&
36242 This is present if unqualified sender addresses are permitted in header lines
36243 (to stop such addresses from being qualified if rewriting occurs at transport
36244 time). Local messages that were input using &%-bnq%& and remote messages from
36245 hosts that match &%sender_unqualified_hosts%& set this flag.
36246
36247 .vitem "&%-auth_id%&&~<&'text'&>"
36248 The id information for a message received on an authenticated SMTP connection
36249 &-- the value of the &$authenticated_id$& variable.
36250
36251 .vitem "&%-auth_sender%&&~<&'address'&>"
36252 The address of an authenticated sender &-- the value of the
36253 &$authenticated_sender$& variable.
36254
36255 .vitem "&%-body_linecount%&&~<&'number'&>"
36256 This records the number of lines in the body of the message, and is always
36257 present.
36258
36259 .vitem "&%-body_zerocount%&&~<&'number'&>"
36260 This records the number of binary zero bytes in the body of the message, and is
36261 present if the number is greater than zero.
36262
36263 .vitem &%-deliver_firsttime%&
36264 This is written when a new message is first added to the spool. When the spool
36265 file is updated after a deferral, it is omitted.
36266
36267 .vitem "&%-frozen%&&~<&'time'&>"
36268 .cindex "frozen messages" "spool data"
36269 The message is frozen, and the freezing happened at <&'time'&>.
36270
36271 .vitem "&%-helo_name%&&~<&'text'&>"
36272 This records the host name as specified by a remote host in a HELO or EHLO
36273 command.
36274
36275 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36276 This records the IP address of the host from which the message was received and
36277 the remote port number that was used. It is omitted for locally generated
36278 messages.
36279
36280 .vitem "&%-host_auth%&&~<&'text'&>"
36281 If the message was received on an authenticated SMTP connection, this records
36282 the name of the authenticator &-- the value of the
36283 &$sender_host_authenticated$& variable.
36284
36285 .vitem &%-host_lookup_failed%&
36286 This is present if an attempt to look up the sending host's name from its IP
36287 address failed. It corresponds to the &$host_lookup_failed$& variable.
36288
36289 .vitem "&%-host_name%&&~<&'text'&>"
36290 .cindex "reverse DNS lookup"
36291 .cindex "DNS" "reverse lookup"
36292 This records the name of the remote host from which the message was received,
36293 if the host name was looked up from the IP address when the message was being
36294 received. It is not present if no reverse lookup was done.
36295
36296 .vitem "&%-ident%&&~<&'text'&>"
36297 For locally submitted messages, this records the login of the originating user,
36298 unless it was a trusted user and the &%-oMt%& option was used to specify an
36299 ident value. For messages received over TCP/IP, this records the ident string
36300 supplied by the remote host, if any.
36301
36302 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36303 This records the IP address of the local interface and the port number through
36304 which a message was received from a remote host. It is omitted for locally
36305 generated messages.
36306
36307 .vitem &%-local%&
36308 The message is from a local sender.
36309
36310 .vitem &%-localerror%&
36311 The message is a locally-generated bounce message.
36312
36313 .vitem "&%-local_scan%&&~<&'string'&>"
36314 This records the data string that was returned by the &[local_scan()]& function
36315 when the message was received &-- the value of the &$local_scan_data$&
36316 variable. It is omitted if no data was returned.
36317
36318 .vitem &%-manual_thaw%&
36319 The message was frozen but has been thawed manually, that is, by an explicit
36320 Exim command rather than via the auto-thaw process.
36321
36322 .vitem &%-N%&
36323 A testing delivery process was started using the &%-N%& option to suppress any
36324 actual deliveries, but delivery was deferred. At any further delivery attempts,
36325 &%-N%& is assumed.
36326
36327 .vitem &%-received_protocol%&
36328 This records the value of the &$received_protocol$& variable, which contains
36329 the name of the protocol by which the message was received.
36330
36331 .vitem &%-sender_set_untrusted%&
36332 The envelope sender of this message was set by an untrusted local caller (used
36333 to ensure that the caller is displayed in queue listings).
36334
36335 .vitem "&%-spam_score_int%&&~<&'number'&>"
36336 If a message was scanned by SpamAssassin, this is present. It records the value
36337 of &$spam_score_int$&.
36338
36339 .vitem &%-tls_certificate_verified%&
36340 A TLS certificate was received from the client that sent this message, and the
36341 certificate was verified by the server.
36342
36343 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36344 When the message was received over an encrypted connection, this records the
36345 name of the cipher suite that was used.
36346
36347 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36348 When the message was received over an encrypted connection, and a certificate
36349 was received from the client, this records the Distinguished Name from that
36350 certificate.
36351 .endlist
36352
36353 Following the options there is a list of those addresses to which the message
36354 is not to be delivered. This set of addresses is initialized from the command
36355 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36356 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36357 the address is added to this set. The addresses are kept internally as a
36358 balanced binary tree, and it is a representation of that tree which is written
36359 to the spool file. If an address is expanded via an alias or forward file, the
36360 original address is added to the tree when deliveries to all its child
36361 addresses are complete.
36362
36363 If the tree is empty, there is a single line in the spool file containing just
36364 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36365 Y or N, followed by an address. The address is the value for the node of the
36366 tree, and the letters indicate whether the node has a left branch and/or a
36367 right branch attached to it, respectively. If branches exist, they immediately
36368 follow. Here is an example of a three-node tree:
36369 .code
36370 YY darcy@austen.fict.example
36371 NN alice@wonderland.fict.example
36372 NN editor@thesaurus.ref.example
36373 .endd
36374 After the non-recipients tree, there is a list of the message's recipients.
36375 This is a simple list, preceded by a count. It includes all the original
36376 recipients of the message, including those to whom the message has already been
36377 delivered. In the simplest case, the list contains one address per line. For
36378 example:
36379 .code
36380 4
36381 editor@thesaurus.ref.example
36382 darcy@austen.fict.example
36383 rdo@foundation
36384 alice@wonderland.fict.example
36385 .endd
36386 However, when a child address has been added to the top-level addresses as a
36387 result of the use of the &%one_time%& option on a &(redirect)& router, each
36388 line is of the following form:
36389 .display
36390 <&'top-level address'&> <&'errors_to address'&> &&&
36391   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36392 .endd
36393 The 01 flag bit indicates the presence of the three other fields that follow
36394 the top-level address. Other bits may be used in future to support additional
36395 fields. The <&'parent number'&> is the offset in the recipients list of the
36396 original parent of the &"one time"& address. The first two fields are the
36397 envelope sender that is associated with this address and its length. If the
36398 length is zero, there is no special envelope sender (there are then two space
36399 characters in the line). A non-empty field can arise from a &(redirect)& router
36400 that has an &%errors_to%& setting.
36401
36402
36403 A blank line separates the envelope and status information from the headers
36404 which follow. A header may occupy several lines of the file, and to save effort
36405 when reading it in, each header is preceded by a number and an identifying
36406 character. The number is the number of characters in the header, including any
36407 embedded newlines and the terminating newline. The character is one of the
36408 following:
36409
36410 .table2 50pt
36411 .row <&'blank'&>         "header in which Exim has no special interest"
36412 .row &`B`&               "&'Bcc:'& header"
36413 .row &`C`&               "&'Cc:'& header"
36414 .row &`F`&               "&'From:'& header"
36415 .row &`I`&               "&'Message-id:'& header"
36416 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36417 .row &`R`&               "&'Reply-To:'& header"
36418 .row &`S`&               "&'Sender:'& header"
36419 .row &`T`&               "&'To:'& header"
36420 .row &`*`&               "replaced or deleted header"
36421 .endtable
36422
36423 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36424 purposes. They are not transmitted when the message is delivered. Here is a
36425 typical set of headers:
36426 .code
36427 111P Received: by hobbit.fict.example with local (Exim 4.00)
36428 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36429 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36430 038* X-rewrote-sender: bb@hobbit.fict.example
36431 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36432 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36433 099* To: alice@wonderland.fict.example, rdo@foundation,
36434 darcy@austen.fict.example, editor@thesaurus.ref.example
36435 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36436 darcy@austen.fict.example, editor@thesaurus.ref.example
36437 038  Date: Fri, 11 May 2001 10:28:59 +0100
36438 .endd
36439 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36440 &'To:'& header have been rewritten, the last one because routing expanded the
36441 unqualified domain &'foundation'&.
36442 .ecindex IIDforspo1
36443 .ecindex IIDforspo2
36444 .ecindex IIDforspo3
36445
36446 . ////////////////////////////////////////////////////////////////////////////
36447 . ////////////////////////////////////////////////////////////////////////////
36448
36449 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36450          "DKIM Support"
36451 .cindex "DKIM"
36452
36453 DKIM is a mechanism by which messages sent by some entity can be provably
36454 linked to a domain which that entity controls.  It permits reputation to
36455 be tracked on a per-domain basis, rather than merely upon source IP address.
36456 DKIM is documented in RFC 4871.
36457
36458 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36459 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36460
36461 Exim's DKIM implementation allows to
36462 .olist
36463 Sign outgoing messages: This function is implemented in the SMTP transport.
36464 It can co-exist with all other Exim features, including transport filters.
36465 .next
36466 Verify signatures in incoming messages: This is implemented by an additional
36467 ACL (acl_smtp_dkim), which can be called several times per message, with
36468 different signature contexts.
36469 .endlist
36470
36471 In typical Exim style, the verification implementation does not include any
36472 default "policy". Instead it enables you to build your own policy using
36473 Exim's standard controls.
36474
36475 Please note that verification of DKIM signatures in incoming mail is turned
36476 on by default for logging purposes. For each signature in incoming email,
36477 exim will log a line displaying the most important signature details, and the
36478 signature status. Here is an example (with line-breaks added for clarity):
36479 .code
36480 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36481     d=facebookmail.com s=q1-2009b
36482     c=relaxed/relaxed a=rsa-sha1
36483     i=@facebookmail.com t=1252484542 [verification succeeded]
36484 .endd
36485 You might want to turn off DKIM verification processing entirely for internal
36486 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36487 control modifier. This should typically be done in the RCPT ACL, at points
36488 where you accept mail from relay sources (internal hosts or authenticated
36489 senders).
36490
36491
36492 .section "Signing outgoing messages" "SECID513"
36493 .cindex "DKIM" "signing"
36494
36495 Signing is implemented by setting private options on the SMTP transport.
36496 These options take (expandable) strings as arguments.
36497
36498 .option dkim_domain smtp string&!! unset
36499 MANDATORY:
36500 The domain you want to sign with. The result of this expanded
36501 option is put into the &%$dkim_domain%& expansion variable.
36502
36503 .option dkim_selector smtp string&!! unset
36504 MANDATORY:
36505 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36506 variable to look up a matching selector. The result is put in the expansion
36507 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36508 option along with &%$dkim_domain%&.
36509
36510 .option dkim_private_key smtp string&!! unset
36511 MANDATORY:
36512 This sets the private key to use. You can use the &%$dkim_domain%& and
36513 &%$dkim_selector%& expansion variables to determine the private key to use.
36514 The result can either
36515 .ilist
36516 be a valid RSA private key in ASCII armor, including line breaks.
36517 .next
36518 start with a slash, in which case it is treated as a file that contains
36519 the private key.
36520 .next
36521 be "0", "false" or the empty string, in which case the message will not
36522 be signed. This case will not result in an error, even if &%dkim_strict%&
36523 is set.
36524 .endlist
36525
36526 .option dkim_canon smtp string&!! unset
36527 OPTIONAL:
36528 This option sets the canonicalization method used when signing a message.
36529 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36530 The option defaults to "relaxed" when unset. Note: the current implementation
36531 only supports using the same canonicalization method for both headers and body.
36532
36533 .option dkim_strict smtp string&!! unset
36534 OPTIONAL:
36535 This  option  defines  how  Exim  behaves  when  signing a message that
36536 should be signed fails for some reason.  When the expansion evaluates to
36537 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36538 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36539 variables here.
36540
36541 .option dkim_sign_headers smtp string&!! unset
36542 OPTIONAL:
36543 When set, this option must expand to (or be specified as) a colon-separated
36544 list of header names. Headers with these names will be included in the message
36545 signature. When unspecified, the header names recommended in RFC4871 will be
36546 used.
36547
36548
36549 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36550 .cindex "DKIM" "verification"
36551
36552 Verification of DKIM signatures in incoming email is implemented via the
36553 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36554 syntactically(!) correct signature in the incoming message.
36555
36556 To evaluate the signature in the ACL a large number of expansion variables
36557 containing the signature status and its details are set up during the
36558 runtime of the ACL.
36559
36560 Calling the ACL only for existing signatures is not sufficient to build
36561 more advanced policies. For that reason, the global option
36562 &%dkim_verify_signers%&, and a global expansion variable
36563 &%$dkim_signers%& exist.
36564
36565 The global option &%dkim_verify_signers%& can be set to a colon-separated
36566 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36567 called. It is expanded when the message has been received. At this point,
36568 the expansion variable &%$dkim_signers%& already contains a colon-separated
36569 list of signer domains and identities for the message. When
36570 &%dkim_verify_signers%& is not specified in the main configuration,
36571 it defaults as:
36572 .code
36573 dkim_verify_signers = $dkim_signers
36574 .endd
36575 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36576 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36577 call the ACL for known domains or identities. This would be achieved as follows:
36578 .code
36579 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36580 .endd
36581 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36582 and "ebay.com", plus all domains and identities that have signatures in the message.
36583 You can also be more creative in constructing your policy. For example:
36584 .code
36585 dkim_verify_signers = $sender_address_domain:$dkim_signers
36586 .endd
36587
36588 If a domain or identity is listed several times in the (expanded) value of
36589 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36590
36591
36592 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36593 available (from most to least important):
36594
36595
36596 .vlist
36597 .vitem &%$dkim_cur_signer%&
36598 The signer that is being evaluated in this ACL run. This can be a domain or
36599 an identity. This is one of the list items from the expanded main option
36600 &%dkim_verify_signers%& (see above).
36601 .vitem &%$dkim_verify_status%&
36602 A string describing the general status of the signature. One of
36603 .ilist
36604 &%none%&: There is no signature in the message for the current domain or
36605 identity (as reflected by &%$dkim_cur_signer%&).
36606 .next
36607 &%invalid%&: The signature could not be verified due to a processing error.
36608 More detail is available in &%$dkim_verify_reason%&.
36609 .next
36610 &%fail%&: Verification of the signature failed.  More detail is
36611 available in &%$dkim_verify_reason%&.
36612 .next
36613 &%pass%&: The signature passed verification. It is valid.
36614 .endlist
36615 .vitem &%$dkim_verify_reason%&
36616 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36617 "fail" or "invalid". One of
36618 .ilist
36619 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36620 key for the domain could not be retrieved. This may be a temporary problem.
36621 .next
36622 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36623 record for the domain is syntactically invalid.
36624 .next
36625 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36626 body hash does not match the one specified in the signature header. This
36627 means that the message body was modified in transit.
36628 .next
36629 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36630 could not be verified. This may mean that headers were modified,
36631 re-written or otherwise changed in a way which is incompatible with
36632 DKIM verification. It may of course also mean that the signature is forged.
36633 .endlist
36634 .vitem &%$dkim_domain%&
36635 The signing domain. IMPORTANT: This variable is only populated if there is
36636 an actual signature in the message for the current domain or identity (as
36637 reflected by &%$dkim_cur_signer%&).
36638 .vitem &%$dkim_identity%&
36639 The signing identity, if present. IMPORTANT: This variable is only populated
36640 if there is an actual signature in the message for the current domain or
36641 identity (as reflected by &%$dkim_cur_signer%&).
36642 .vitem &%$dkim_selector%&
36643 The key record selector string.
36644 .vitem &%$dkim_algo%&
36645 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36646 .vitem &%$dkim_canon_body%&
36647 The body canonicalization method. One of 'relaxed' or 'simple'.
36648 .vitem &%dkim_canon_headers%&
36649 The header canonicalization method. One of 'relaxed' or 'simple'.
36650 .vitem &%$dkim_copiedheaders%&
36651 A transcript of headers and their values which are included in the signature
36652 (copied from the 'z=' tag of the signature).
36653 .vitem &%$dkim_bodylength%&
36654 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36655 limit was set by the signer, "9999999999999" is returned. This makes sure
36656 that this variable always expands to an integer value.
36657 .vitem &%$dkim_created%&
36658 UNIX timestamp reflecting the date and time when the signature was created.
36659 When this was not specified by the signer, "0" is returned.
36660 .vitem &%$dkim_expires%&
36661 UNIX timestamp reflecting the date and time when the signer wants the
36662 signature to be treated as "expired". When this was not specified by the
36663 signer, "9999999999999" is returned. This makes it possible to do useful
36664 integer size comparisons against this value.
36665 .vitem &%$dkim_headernames%&
36666 A colon-separated list of names of headers included in the signature.
36667 .vitem &%$dkim_key_testing%&
36668 "1" if the key record has the "testing" flag set, "0" if not.
36669 .vitem &%$dkim_key_nosubdomains%&
36670 "1" if the key record forbids subdomaining, "0" otherwise.
36671 .vitem &%$dkim_key_srvtype%&
36672 Service type (tag s=) from the key record. Defaults to "*" if not specified
36673 in the key record.
36674 .vitem &%$dkim_key_granularity%&
36675 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36676 in the key record.
36677 .vitem &%$dkim_key_notes%&
36678 Notes from the key record (tag n=).
36679 .endlist
36680
36681 In addition, two ACL conditions are provided:
36682
36683 .vlist
36684 .vitem &%dkim_signers%&
36685 ACL condition that checks a colon-separated list of domains or identities
36686 for a match against the domain or identity that the ACL is currently verifying
36687 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36688 verb to a group of domains or identities. For example:
36689
36690 .code
36691 # Warn when Mail purportedly from GMail has no signature at all
36692 warn log_message = GMail sender without DKIM signature
36693      sender_domains = gmail.com
36694      dkim_signers = gmail.com
36695      dkim_status = none
36696 .endd
36697
36698 .vitem &%dkim_status%&
36699 ACL condition that checks a colon-separated list of possible DKIM verification
36700 results against the actual result of verification. This is typically used
36701 to restrict an ACL verb to a list of verification outcomes, for example:
36702
36703 .code
36704 deny message = Mail from Paypal with invalid/missing signature
36705      sender_domains = paypal.com:paypal.de
36706      dkim_signers = paypal.com:paypal.de
36707      dkim_status = none:invalid:fail
36708 .endd
36709
36710 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36711 see the documentation of the &%$dkim_verify_status%& expansion variable above
36712 for more information of what they mean.
36713 .endlist
36714
36715 . ////////////////////////////////////////////////////////////////////////////
36716 . ////////////////////////////////////////////////////////////////////////////
36717
36718 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36719          "Adding drivers or lookups"
36720 .cindex "adding drivers"
36721 .cindex "new drivers, adding"
36722 .cindex "drivers" "adding new"
36723 The following actions have to be taken in order to add a new router, transport,
36724 authenticator, or lookup type to Exim:
36725
36726 .olist
36727 Choose a name for the driver or lookup type that does not conflict with any
36728 existing name; I will use &"newdriver"& in what follows.
36729 .next
36730 Add to &_src/EDITME_& the line:
36731 .display
36732 <&'type'&>&`_NEWDRIVER=yes`&
36733 .endd
36734 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36735 code is not to be included in the binary by default, comment this line out. You
36736 should also add any relevant comments about the driver or lookup type.
36737 .next
36738 Add to &_src/config.h.defaults_& the line:
36739 .code
36740 #define <type>_NEWDRIVER
36741 .endd
36742 .next
36743 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36744 and create a table entry as is done for all the other drivers and lookup types.
36745 .next
36746 .new
36747 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
36748 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
36749 Add your &`NEWDRIVER`& to that list.
36750 As long as the dynamic module would be named &_newdriver.so_&, you can use the
36751 simple form that most lookups have.
36752 .wen
36753 .next
36754 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36755 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36756 driver or lookup type and add it to the definition of OBJ.
36757 .next
36758 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36759 &_src_&.
36760 .next
36761 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36762 as for other drivers and lookups.
36763 .endlist
36764
36765 Then all you need to do is write the code! A good way to start is to make a
36766 proforma by copying an existing module of the same type, globally changing all
36767 occurrences of the name, and cutting out most of the code. Note that any
36768 options you create must be listed in alphabetical order, because the tables are
36769 searched using a binary chop procedure.
36770
36771 There is a &_README_& file in each of the sub-directories of &_src_& describing
36772 the interface that is expected.
36773
36774
36775
36776
36777 . ////////////////////////////////////////////////////////////////////////////
36778 . ////////////////////////////////////////////////////////////////////////////
36779
36780 . /////////////////////////////////////////////////////////////////////////////
36781 . These lines are processing instructions for the Simple DocBook Processor that
36782 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36783 . PDFs than using xmlto and fop. They will be ignored by all other XML
36784 . processors.
36785 . /////////////////////////////////////////////////////////////////////////////
36786
36787 .literal xml
36788 <?sdop
36789   format="newpage"
36790   foot_right_recto="&chaptertitle;"
36791   foot_right_verso="&chaptertitle;"
36792 ?>
36793 .literal off
36794
36795 .makeindex "Options index"   "option"
36796 .makeindex "Variables index" "variable"
36797 .makeindex "Concept index"   "concept"
36798
36799
36800 . /////////////////////////////////////////////////////////////////////////////
36801 . /////////////////////////////////////////////////////////////////////////////